X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Finstallation_check.pl;h=33fd7ca73da5c510f2cdda1800515c166cb018cd;hb=30b4a78c4100ebdcd6e6917fbcbf1d12f4f7b4d6;hp=3a69630ba04771747e0f32a87a5817d1279fcc7b;hpb=1f8989f79f9bfe310ca98b6047d15079ad225773;p=kivitendo-erp.git diff --git a/scripts/installation_check.pl b/scripts/installation_check.pl index 3a69630ba..33fd7ca73 100755 --- a/scripts/installation_check.pl +++ b/scripts/installation_check.pl @@ -1,18 +1,23 @@ #!/usr/bin/perl -w -use strict; -use Getopt::Long; -use Pod::Usage; -use Term::ANSIColor; our $master_templates; BEGIN { - unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML). - push @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version. + 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. # this is a default dir. may be wrong in your installation, change it then - $master_templates = './templates/print/'; + $master_templates = $FindBin::Bin . '/../templates/print/'; } +use strict; +use Getopt::Long; +use List::MoreUtils qw(uniq); +use Pod::Usage; +use Term::ANSIColor; +use Text::Wrap; + unless (eval { require Config::Std; 1 }){ print STDERR < \ my $v, - "V|no-verbose" => \ my $nv, "a|all" => \ $check{a}, "o|optional!" => \ $check{o}, "d|devel!" => \ $check{d}, @@ -48,16 +53,16 @@ GetOptions( "r|required!" => \ $check{r}, "h|help" => sub { pod2usage(-verbose => 2) }, "c|color!" => \ ( my $c = 1 ), + "i|install-command!" => \ my $apt, + "s|silent" => \ $check{s}, ); -# verbos is default -if ( $v && $nv ){ - $v = 1; -}elsif ($nv){ - undef $v; -}else{ - $v = 1; -} +my %install_methods = ( + apt => { key => 'debian', install => 'sudo apt install', system => "Debian, Ubuntu" }, + yum => { key => 'fedora', install => 'sudo yum install', system => "RHEL, Fedora, CentOS" }, + zypper => { key => 'suse', install => 'sudo zypper install', system => "SLES, openSUSE" }, + cpan => { key => 'name', install => "sudo cpan", system => "CPAN" }, +); # if nothing is requested check "required" my $default_run; @@ -70,16 +75,14 @@ if (!defined $check{a} } if ($check{a}) { - foreach my $check (keys %check) { - $check{$check} = 1 unless defined $check{$check}; - } + $check{$_} //= 1 for qw(o d l r); } $| = 1; if (!SL::LxOfficeConf->read(undef, 'may fail')) { - print_header('Could not load the config file. If you have dependancies from any features enabled in the configuration these will still show up as optional because of this. Please rerun this script after installing the dependancies needed to load the cofiguration.') + print_header('Could not load the config file. If you have dependencies from any features enabled in the configuration these will still show up as optional because of this. Please rerun this script after installing the dependencies needed to load the configuration.') } else { SL::InstallationCheck::check_for_conditional_dependencies(); } @@ -87,7 +90,7 @@ if (!SL::LxOfficeConf->read(undef, 'may fail')) { if ($check{r}) { print_header('Checking Required Modules'); check_module($_, required => 1) for @SL::InstallationCheck::required_modules; - print_header('Standard check for required modules done. See additional parameters for more checks (--help)') if $default_run; + check_pdfinfo(); } if ($check{o}) { print_header('Checking Optional Modules'); @@ -101,12 +104,69 @@ if ($check{l}) { check_latex(); } +my $fail = @missing_modules; +print_header('Result'); +print_line('All', $fail ? 'NOT ok' : 'OK', $fail ? 'red' : 'green'); + +if ($default_run && !$check{s}) { + if (@missing_modules) { + $apt = 1; + print <<"EOL"; + +HEY! It seems there are modules MISSING! Look for the red lines with "NOT ok" +above. You'll want to fix those, I've enabled --install-command for you... +EOL + } else { + print <<"EOL"; + +Standard check done, everything is OK and up to date. Have a look at the --help +section of this script to see some more advanced checks for developer and +optional dependencies, as well as LaTeX packages you might need. +EOL + } +} + +if (@missing_modules && $apt && !$check{s}) { + print "\nHere are some sample installation lines, choose one appropriate for your system:\n\n"; + local $Text::Wrap::separator = " \\\n"; + + for (keys %install_methods) { + my $method = $install_methods{$_}; + if (my @install_candidates = grep $_, map { $_->{$method->{key}} } @missing_modules) { + print "$method->{system}:\n"; + print wrap(" ", " ", $method->{install}, @install_candidates); + print $/; + } + } +} + +exit !!@missing_modules; + sub check_latex { my ($res) = check_kpsewhich(); print_result("Looking for LaTeX kpsewhich", $res); + + # no pdfx -> no zugferd possible + my $ret = kpsewhich('template/print/', 'sty', 'pdfx'); + die "Cannot use pdfx. Please install this package first (debian: apt install texlive-latex-extra)" if $ret; + # check version 2018 + my $latex = $::lx_office_conf{applications}->{latex} || 'pdflatex'; + my $pdfx = (system ${latex} . ' --interaction=batchmode "\documentclass{minimal} \RequirePackage{pdfx} \csname @ifpackagelater\endcsname{pdfx}{2018/12/22}{}{\show\relax} \begin{document} \end{document}"'); + + print_result ("Looking for pdfx version 2018 or higher", !$pdfx); + push @missing_modules, \(name => 'pdfx') if $pdfx; + if ($res) { check_template_dir($_) for SL::InstallationCheck::template_dirs($master_templates); } + print STDERR < /dev/null|); my $res = $exit > 0 ? 0 : 1; print_result("Looking for LaTeX $type_desc $package", $res); if (!$res) { - print STDERR <&1 | grep version 2> /dev/null`; + my ($label,$vers,$ver_string) = split / /,$shell_out; + if ( $label && $label eq 'pdfinfo' ) { + chop $ver_string; + print_line($line, $ver_string, 'green'); + } else { + print_line($line, 'not installed','red'); + my %modinfo = ( debian => 'poppler-utils' ); + push @missing_modules, \%modinfo; + + } +} + sub check_module { my ($module, %role) = @_; @@ -177,15 +257,17 @@ sub check_module { return if $res; + push @missing_modules, $module; + my $needed_text = $role{optional} ? 'It is OPTIONAL for kivitendo but RECOMMENDED for improved functionality.' : $role{required} ? 'It is NEEDED by kivitendo and must be installed.' : $role{devel} ? 'It is OPTIONAL for kivitendo and only useful for developers.' - : 'It is not listed as a dependancy yet. Please tell this the developers.'; + : 'It is not listed as a dependency yet. Please tell this the developers.'; my @source_texts = module_source_texts($module); local $" = $/; - print STDERR <{fullname} could not be loaded. @@ -202,20 +284,17 @@ EOL sub module_source_texts { my ($module) = @_; my @texts; - push @texts, <{name}" + for my $key (keys %install_methods) { + my $method = $install_methods{$key}; + push @texts, <<"EOL" if $module->{$method->{key}}; + - Using $method->{system} you can install it with $key: + $method->{install} $module->{$method->{key}} EOL + } push @texts, <{url}; - You can download it from this URL and install it manually: $module->{url} EOL - push @texts, <{debian}; - - On Debian, Ubuntu and other distros you can install it with apt-get: - sudo apt-get install $module->{debian} - Note: These may be out of date as well if your system is old. -EOL - # TODO: SuSE and Fedora packaging. Windows packaging. return @texts; } @@ -236,10 +315,12 @@ sub print_result { sub print_line { my ($text, $res, $color) = @_; + return if $check{s}; print $text, " ", ('.' x (78 - length($text) - length($res))), " ", mycolor($res, $color), $/; } sub print_header { + return if $check{s}; print $/; print "$_[0]:", $/; } @@ -252,7 +333,7 @@ __END__ =head1 NAME -scripts/installation_check.pl - check kivitendo dependancies +scripts/installation_check.pl - check kivitendo dependencies =head1 SYNOPSIS @@ -284,11 +365,11 @@ No color output. Helpful to avoid terminal escape problems. =item C<-d, --devel> -Probe for perl developer dependancies. (Used for console and tags file) +Probe for perl developer dependencies. (Used for console and tags file) =item C<--no-devel> -Don't probe for perl developer dependancies. (Useful in combination with --all) +Don't probe for perl developer dependencies. (Useful in combination with --all) =item C<-h, --help> @@ -318,13 +399,15 @@ Probe for LaTeX documentclasses and packages in master templates. Don't probe for LaTeX document classes and packages in master templates. (Useful in combination with --all) -=item C<-v, --verbose> +=item C<-v. --verbose> -Print additional info for missing dependancies (enabled by default) +Print additional info for missing dependencies -=item C<-V, --no-verbose> +=item C<-i, --install-command> -Disable verbosity +Tries to generate installation commands for the most common package managers. +Note that these lists can be slightly off, but it should still save you a lot +of typing. =back