X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Ffind-use.pl;h=b2a3c0dafeb2447ab1617cac9bb5bcc6b7146111;hb=a27846ef2756ed0f59c29d256a5d43d6caaf0b58;hp=97f5ad2d08ef6f2e495e3fa658d8f701766308e3;hpb=829739e443b212f6edc08e93f20f9c259c1cee79;p=kivitendo-erp.git diff --git a/scripts/find-use.pl b/scripts/find-use.pl old mode 100644 new mode 100755 index 97f5ad2d0..b2a3c0daf --- a/scripts/find-use.pl +++ b/scripts/find-use.pl @@ -1,16 +1,84 @@ #!/usr/bin/perl -l + +BEGIN { + use FindBin; + + unshift(@INC, $FindBin::Bin . '/../modules/override'); # Use our own versions of various modules (e.g. YAML). + push (@INC, $FindBin::Bin . '/..'); # '.' will be removed from @INC soon. +} + use strict; #use warnings; # corelist and find throw tons of warnings -use Module::CoreList; use File::Find; +use Module::CoreList; use SL::InstallationCheck; +use Term::ANSIColor; +use Getopt::Long; + +my (%uselines, %modules, %supplied, %requires); + +# since the information which classes belong to a cpan distribution is not +# easily obtained, I'll just hard code the bigger ones we use here. the same +# hash will be filled later with information gathered from the source files. +%requires = ( + 'DateTime' => { + 'DateTime::Duration' => 1, + 'DateTime::Infinite' => 1, + }, + 'Rose::DB::Object' => { + 'Rose::DB::Object::ConventionManager' => 1, + 'Rose::DB::Object::Manager' => 1, + 'Rose::DB::Object::Metadata' => 1, + 'Rose::DB::Object::Helpers' => 1, + 'Rose::DB::Object::Util' => 1, + 'Rose::DB::Object::Constants' => 1, + }, + 'Rose::Object' => { + 'Rose::Object::MakeMethods::Generic' => 1, + }, + 'Template' => { + 'Template::Constants' => 1, + 'Template::Exception' => 1, + 'Template::Iterator' => 1, + 'Template::Plugin' => 1, + 'Template::Plugin::Filter' => 1, + 'Template::Plugin::HTML' => 1, + 'Template::Stash' => 1, + }, + 'Devel::REPL' => { + 'namespace::clean' => 1, + }, + 'Email::MIME' => { + 'Email::MIME::Creator' => 1, + }, + 'Test::Harness' => { + 'TAP::Parser' => 1, + 'TAP::Parser::Aggregator' => 1, + }, + 'Archive::Zip' => { + 'Archive::Zip::Member' => 1, + }, + 'HTML::Parser' => { + 'HTML::Entities' => 1, + }, + 'URI' => { + 'URI::Escape' => 1, + }, + 'File::MimeInfo' => { + 'File::MimeInfo::Magic' => 1, + }, +); -my (%uselines, %modules, %supplied); +GetOptions( + 'files-with-match|l' => \ my $l, +); + +chmod($FindBin::Bin . '/..'); find(sub { return unless /(\.p[lm]|console)$/; - # remember modules shipped with Lx-Office + # remember modules shipped with kivitendo $supplied{modulize($File::Find::name)}++ if $File::Find::dir =~ m#modules/#; @@ -21,20 +89,22 @@ find(sub { next if /SL::/; next if /Support::Files/; # our own test support module next if /use (warnings|strict|vars|lib|constant|utf8)/; + next if /^use (with|the)/; my ($useline) = m/^use\s+(.*?)$/; - next if $useline =~ /^[\d.]+;/; # skip version requirements + next if $useline =~ /^[\d._]+;/; # skip version requirements next if !$useline; - $uselines{$useline}++; + $uselines{$useline} ||= []; + push @{ $uselines{$useline} }, $File::Find::name; } }, '.'); for my $useline (keys %uselines) { $useline =~ s/#.*//; # kill comments - # modules can be loaded implicit with use base qw(Module) or use parent + # modules can be loaded implicitly with use base qw(Module) or use parent # 'Module'. catch these: my ($module, $args) = $useline =~ / (?: @@ -52,32 +122,98 @@ for my $useline (keys %uselines) { next if $useline =~ /^most and offer that in a small/; # YAML my $version = Module::CoreList->first_release($module); - $modules{$module} = $supplied{$module} ? 'included' - : $version ? sprintf '%2.6f', $version - : is_documented($module) ? 'required' - : '!missing'; + $modules{$module} = { status => $supplied{$module} ? 'included' + : $version ? sprintf '%2.6f', $version + : is_required($module) ? 'required' + : is_optional($module) ? 'optional' + : is_developer($module) ? 'developer' + : '!missing', + files => $uselines{$useline}, + }; + + # build requirement tree + for my $file (@{ $uselines{$useline} }) { + next if $file =~ /\.pl$/; + my $orig_module = modulize($file); + $requires{$orig_module} ||= {}; + $requires{$orig_module}{$module}++; + } +} + +# have all documented modules mentioned here +$modules{$_->{name}} ||= { status => 'required' } for @SL::InstallationCheck::required_modules; +$modules{$_->{name}} ||= { status => 'optional' } for @SL::InstallationCheck::optional_modules; +$modules{$_->{name}} ||= { status => 'developer' } for @SL::InstallationCheck::developer_modules; + +# build transitive closure for documented dependencies +my $changed = 1; +while ($changed) { + $changed = 0; + for my $src_module (keys %requires) { + for my $dst_module (keys %{ $requires{$src_module} }) { + if ( $modules{$src_module} + && $modules{$dst_module} + && $modules{$src_module}->{status} =~ /^(required|devel|optional)/ + && $modules{$dst_module}->{status} eq '!missing') { + $modules{$dst_module}->{status} = "required"; # . ", via $src_module"; + $changed = 1; + } + } + } } -print sprintf "%8s : %s", $modules{$_}, $_ - for sort { - $modules{$a} cmp $modules{$b} - || $a cmp $b +do { + print sprintf "%8s : %s", color_text($modules{$_}->{status}), $_; + if ($l) { + print " $_" for @{ $modules{$_}->{files} || [] }; + } +} for sort { + $modules{$a}->{status} cmp $modules{$b}->{status} + || $a cmp $b } keys %modules; sub modulize { for (my ($name) = @_) { s#^./modules/\w+/##; + s#^./##; s#.pm$##; s#/#::#g; return $_; } } -sub is_documented { +sub is_required { + my ($module) = @_; + grep { $_->{name} eq $module } @SL::InstallationCheck::required_modules; +} + +sub is_optional { + my ($module) = @_; + grep { $_->{name} eq $module } @SL::InstallationCheck::optional_modules; +} + +sub is_developer { my ($module) = @_; - return grep { $_->{name} eq $module } @SL::InstallationCheck::required_modules; + grep { $_->{name} eq $module } @SL::InstallationCheck::developer_modules; +} + +sub color_text { + my ($text) = @_; + return color(get_color($text)) . $text . color('reset'); +} + +sub get_color { + for (@_) { + return 'yellow' if /^5./ && $_ > 5.008; + return 'green' if /^5./; + return 'green' if /^included/; + return 'red' if /^!missing/; + return 'yellow'; + } } +1; + __END__ =head1 NAME @@ -87,18 +223,40 @@ find-use =head1 EXAMPLE # perl scipts/find-use.pl - missing : Perl::Tags - missing : Template::Constants - missing : DBI + !missing : Template::Constants + !missing : DBI =head1 EXPLANATION This util is useful for package builders to identify all the CPAN dependencies -we've made. It requires Module::CoreList (which is core, but is not in most -stable releases of perl) to determine if a module is distributed with perl or -not. The output reports which version of perl the module is in. If it reports -0.000000, then the module is not in core perl, and needs to be installed before -Lx-Office will operate. +we have. It requires Module::CoreList (which is core since 5.9) to determine if +a module is distributed with perl or not. The output will be one of the +following: + +=over 4 + +=item VERSION + +If a version string is displayed, the module is core since this version. +Everything up to 5.8 is alright. 5.10 (aka 5.010) is acceptable, but should be +documented. Please do not use 5.12 core modules without adding an explicit +requirement. + +=item included + +This module is included in C. Don't worry about it. + +=item required + +This module is documented in C to be necessary, or is a +dependency of one of these. Everything alright. + +=item !missing + +These modules are neither core, nor included, nor required. This is ok for +developer tools, but should never occur for modules the actual program uses. + +=back =head1 AUTHOR @@ -110,5 +268,3 @@ Sven Schöling Es.schoeling@linet-services.deE Distributed under the terms of the GNU General Public License v2. =cut - -