Kleinigkeiten in Dokumentation angepasst

[mfinanz.git] / scripts / installation_check.pl

diff --git a/scripts/installation_check.pl b/scripts/installation_check.pl
index 2bec003cd76f4b05acad1c2250bf8520eeccdce8..6a65ec5e64be7894e0b57afe2839a9a5c0b96a1e 100755 (executable)
--- a/scripts/installation_check.pl
+++ b/scripts/installation_check.pl
@@ -4,6 +4,7 @@ use strict;
 use Getopt::Long;
 use Pod::Usage;
 use Term::ANSIColor;
 use Getopt::Long;
 use Pod::Usage;
 use Term::ANSIColor;

+use Text::Wrap;

 our $master_templates;
 BEGIN {
   unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
 our $master_templates;
 BEGIN {
   unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).


@@ -21,9 +22,10 @@ unless (eval { require Config::Std; 1 }){
   Debian: you may install the needed *.deb package with:
     apt-get install libconfig-std-perl
 
   Debian: you may install the needed *.deb package with:
     apt-get install libconfig-std-perl
 

-  RPM: There is a rpm package "perl-Config-Std"
+  Red Hat/Fedora/CentOS: you may install the needed *.rpm package with:
+    yum install perl-Config-Std

 
 

-  Suse: you may install the needed *.rpm package with:
+  SUSE: you may install the needed *.rpm package with:

     zypper install perl-Config-Std
 
 +------------------------------------------------------------------------------+
     zypper install perl-Config-Std
 
 +------------------------------------------------------------------------------+


@@ -35,7 +37,7 @@ EOL
 use SL::InstallationCheck;
 use SL::LxOfficeConf;
 
 use SL::InstallationCheck;
 use SL::LxOfficeConf;
 

-
+my @missing_modules;

 my %check;
 Getopt::Long::Configure ("bundling");
 GetOptions(
 my %check;
 Getopt::Long::Configure ("bundling");
 GetOptions(


@@ -47,6 +49,14 @@ GetOptions(
   "r|required!" => \ $check{r},
   "h|help"      => sub { pod2usage(-verbose => 2) },
   "c|color!"    => \ ( my $c = 1 ),
   "r|required!" => \ $check{r},
   "h|help"      => sub { pod2usage(-verbose => 2) },
   "c|color!"    => \ ( my $c = 1 ),

+  "i|install-command!"  => \ my $apt,
+);
+
+my %install_methods = (
+  apt    => { key => 'debian', install => 'sudo apt-get 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"
 );
 
 # if nothing is requested check "required"


@@ -77,7 +87,6 @@ if (!SL::LxOfficeConf->read(undef, 'may fail')) {
 if ($check{r}) {
   print_header('Checking Required Modules');
   check_module($_, required => 1) for @SL::InstallationCheck::required_modules;
 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;

 }
 if ($check{o}) {
   print_header('Checking Optional Modules');
 }
 if ($check{o}) {
   print_header('Checking Optional Modules');


@@ -91,6 +100,42 @@ if ($check{l}) {
   check_latex();
 }
 
   check_latex();
 }
 

+my $fail = @missing_modules;
+print_header('Result');
+print_line('All', $fail ? 'NOT ok' : 'OK', $fail ? 'red' : 'green');
+
+if ($default_run) {
+  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 dependancies, as well as LaTeX packages you might need.
+EOL
+  }
+}
+
+if (@missing_modules && $apt) {
+  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 $/;
+    }
+  }
+}
+

 sub check_latex {
   my ($res) = check_kpsewhich();
   print_result("Looking for LaTeX kpsewhich", $res);
 sub check_latex {
   my ($res) = check_kpsewhich();
   print_result("Looking for LaTeX kpsewhich", $res);


@@ -155,6 +200,7 @@ sub check_module {
   my ($module, %role) = @_;
 
   my $line = "Looking for $module->{fullname}";
   my ($module, %role) = @_;
 
   my $line = "Looking for $module->{fullname}";

+  $line   .= " (from $module->{dist_name})" if $module->{dist_name};

   my ($res, $ver) = SL::InstallationCheck::module_available($module->{"name"}, $module->{version});
   if ($res) {
     my $ver_string = ref $ver && $ver->can('numify') ? $ver->numify : $ver ? $ver : 'no version';
   my ($res, $ver) = SL::InstallationCheck::module_available($module->{"name"}, $module->{version});
   if ($res) {
     my $ver_string = ref $ver && $ver->can('numify') ? $ver->numify : $ver ? $ver : 'no version';


@@ -166,10 +212,12 @@ sub check_module {
 
   return if $res;
 
 
   return if $res;
 

+  push @missing_modules, $module;
+

   my $needed_text =
   my $needed_text =

-      $role{optional} ? 'It is OPTIONAL for Lx-Office but RECOMMENDED for improved functionality.'
-    : $role{required} ? 'It is NEEDED by Lx-Office and must be installed.'
-    : $role{devel}    ? 'It is OPTIONAL for Lx-Office and only useful for developers.'
+      $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.';
 
   my @source_texts = module_source_texts($module);
     :                   'It is not listed as a dependancy yet. Please tell this the developers.';
 
   my @source_texts = module_source_texts($module);


@@ -191,20 +239,17 @@ EOL
 sub module_source_texts {
   my ($module) = @_;
   my @texts;
 sub module_source_texts {
   my ($module) = @_;
   my @texts;

-  push @texts, <<EOL;
-  - You can get it from CPAN:
-      perl -MCPAN -e "install $module->{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
 EOL

+  }

   push @texts, <<EOL if $module->{url};
   - You can download it from this URL and install it manually:
       $module->{url}
 EOL
   push @texts, <<EOL if $module->{url};
   - You can download it from this URL and install it manually:
       $module->{url}
 EOL

-  push @texts, <<EOL if $module->{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;
 }
 
   return @texts;
 }


@@ -241,7 +286,7 @@ __END__
 
 =head1 NAME
 
 
 =head1 NAME
 

-scripts/installation_check.pl - check Lx-Office dependancies
+scripts/installation_check.pl - check kivitendo dependancies

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -249,9 +294,9 @@ scripts/installation_check.pl - check Lx-Office dependancies
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-Check dependencys. List all perl modules needed by Lx-Office, probes for them,
+Check dependencys. List all perl modules needed by kivitendo, probes for them,

 and warns if one is not available.  List all LaTeX document classes and
 and warns if one is not available.  List all LaTeX document classes and

-packages needed by Lx-Office master templates, probes for them, and warns if
+packages needed by kivitendo master templates, probes for them, and warns if

 one is not available.
 
 
 one is not available.
 
 


@@ -311,6 +356,12 @@ Don't probe for LaTeX document classes and packages in master templates. (Useful
 
 Print additional info for missing dependancies
 
 
 Print additional info for missing dependancies
 

+=item C<-i, --install-command>
+
+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
 
 =head1 BUGS, CAVEATS and TODO
 =back
 
 =head1 BUGS, CAVEATS and TODO