installcheck: DBI gibt bei ->VERSION ein version Objekt zurück.
[kivitendo-erp.git] / scripts / installation_check.pl
1 #!/usr/bin/perl -w
2
3 use strict;
4 use Getopt::Long;
5 use Pod::Usage;
6 use Term::ANSIColor;
7 our $master_templates;
8 BEGIN {
9   unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
10   push    @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
11
12   # this is a default dir. may be wrong in your installation, change it then
13   $master_templates = './templates/print/';
14 }
15
16 use SL::InstallationCheck;
17
18 my %check;
19 Getopt::Long::Configure ("bundling");
20 GetOptions(
21   "v|verbose"   => \ my $v,
22   "a|all"       => \ $check{a},
23   "o|optional!" => \ $check{o},
24   "d|devel!"    => \ $check{d},
25   "l|latex!"    => \ $check{l},
26   "r|required!" => \ $check{r},
27   "h|help"      => sub { pod2usage(-verbose => 2) },
28   "c|color!"    => \ ( my $c = 1 ),
29 );
30
31 # if nothing is requested check "required"
32 $check{r} = 1 unless defined $check{a} ||
33                      defined $check{l} ||
34                      defined $check{o} ||
35                      defined $check{d};
36 my $default_run ='1' if $check{r};  # no parameter, therefore print a note after default run
37 if ($check{a}) {
38   foreach my $check (keys %check) {
39     $check{$check} = 1 unless defined $check{$check};
40   }
41 }
42
43
44 $| = 1;
45
46 if ($check{r}) {
47   print_header('Checking Required Modules');
48   check_module($_, required => 1) for @SL::InstallationCheck::required_modules;
49   print_header('Standard check for required modules done. See additional parameters for more checks (-- help)') if $default_run;
50 }
51 if ($check{o}) {
52   print_header('Checking Optional Modules');
53   check_module($_, optional => 1) for @SL::InstallationCheck::optional_modules;
54 }
55 if ($check{d}) {
56   print_header('Checking Developer Modules');
57   check_module($_, devel => 1) for @SL::InstallationCheck::developer_modules;
58 }
59 if ($check{l}) {
60   check_latex();
61 }
62
63 sub check_latex {
64   my ($res) = check_kpsewhich();
65   print_result("Looking for LaTeX kpsewhich", $res);
66   if ($res) {
67     check_template_dir($_) for SL::InstallationCheck::template_dirs($master_templates);
68   }
69 }
70
71 sub check_template_dir {
72   my ($dir) = @_;
73   my $path  = $master_templates . $dir;
74
75   print_header("Checking LaTeX Dependencies for Master Templates '$dir'");
76   kpsewhich($path, 'cls', $_) for SL::InstallationCheck::classes_from_latex($path, '\documentclass');
77   kpsewhich($path, 'sty', $_) for SL::InstallationCheck::classes_from_latex($path, '\usepackage');
78 }
79
80 our $mastertemplate_path = './templates/print/';
81
82 sub check_kpsewhich {
83   return 1 if SL::InstallationCheck::check_kpsewhich();
84
85   print STDERR <<EOL if $v;
86 +------------------------------------------------------------------------------+
87   Can't find kpsewhich, is there a proper installed LaTeX?
88   On Debian you may run "aptitude install texlive-base-bin"
89 +------------------------------------------------------------------------------+
90 EOL
91   return 0;
92 }
93
94 sub kpsewhich {
95   my ($dw, $type, $package) = @_;
96   $package =~ s/[^-_0-9A-Za-z]//g;
97   my $type_desc = $type eq 'cls' ? 'document class' : 'package';
98
99   eval { use String::ShellQuote; 1 } or warn "can't load String::ShellQuote" && return;
100      $dw         = shell_quote $dw;
101   my $e_package  = shell_quote $package;
102   my $e_type     = shell_quote $type;
103
104   my $exit = system(qq|TEXINPUTS=".:$dw:" kpsewhich $e_package.$e_type > /dev/null|);
105   my $res  = $exit > 0 ? 0 : 1;
106
107   print_result("Looking for LaTeX $type_desc $package", $res);
108   if (!$res) {
109     print STDERR <<EOL if $v;
110 +------------------------------------------------------------------------------+
111   LaTeX $type_desc $package could not be loaded.
112
113   On Debian you may find the needed *.deb package with:
114     apt-file search $package.$type
115
116   Maybe you need to install apt-file first by:
117     aptitude install apt-file && apt-file update
118 +------------------------------------------------------------------------------+
119 EOL
120   }
121 }
122
123 sub check_module {
124   my ($module, %role) = @_;
125
126   my $line = "Looking for $module->{fullname}";
127   my ($res, $ver) = SL::InstallationCheck::module_available($module->{"name"}, $module->{version});
128   if ($res) {
129     my $ver_string = ref $ver && $ver->can('numify') ? $ver->numify : $ver ? $ver : 'no version';
130     print_line($line, $ver_string, 'green');
131   } else {
132     print_result($line, $res);
133   }
134
135
136   return if $res;
137
138   my $needed_text =
139       $role{optional} ? 'It is OPTIONAL for Lx-Office but RECOMMENDED for improved functionality.'
140     : $role{required} ? 'It is NEEDED by Lx-Office and must be installed.'
141     : $role{devel}    ? 'It is OPTIONAL for Lx-Office and only useful for developers.'
142     :                   'It is not listed as a dependancy yet. Please tell this the developers.';
143
144   my @source_texts = module_source_texts($module);
145   local $" = $/;
146   print STDERR <<EOL if $v;
147 +------------------------------------------------------------------------------+
148   $module->{fullname} could not be loaded.
149
150   This module is either too old or not available on your system.
151   $needed_text
152
153   Here are some ideas how to get it:
154
155 @source_texts
156 +------------------------------------------------------------------------------+
157 EOL
158 }
159
160 sub module_source_texts {
161   my ($module) = @_;
162   my @texts;
163   push @texts, <<EOL;
164   - You can get it from CPAN:
165       perl -MCPAN -e "install $module->{name}"
166 EOL
167   push @texts, <<EOL if $module->{url};
168   - You can download it from this URL and install it manually:
169       $module->{url}
170 EOL
171   push @texts, <<EOL if $module->{debian};
172   - On Debian, Ubuntu and other distros you can install it with apt-get:
173       sudo apt-get install $module->{debian}
174     Note: These may be out of date as well if your system is old.
175 EOL
176  # TODO: SuSE and Fedora packaging. Windows packaging.
177
178   return @texts;
179 }
180
181 sub mycolor {
182   return $_[0] unless $c;
183   return colored(@_);
184 }
185
186 sub print_result {
187   my ($test, $exit) = @_;
188   if ($exit) {
189     print_line($test, 'ok', 'green');
190   } else {
191     print_line($test, 'NOT ok', 'red');
192   }
193 }
194
195 sub print_line {
196   my ($text, $res, $color) = @_;
197   print $text, " ", ('.' x (78 - length($text) - length($res)));
198   print mycolor($res, $color);
199   print "\n";
200   return;
201 }
202
203 sub print_header {
204   print $/;
205   print "$_[0]:", $/;
206 }
207
208 1;
209
210 __END__
211
212 =encoding UTF-8
213
214 =head1 NAME
215
216 scripts/installation_check.pl - check Lx-Office dependancies
217
218 =head1 SYNOPSIS
219
220   scripts/installation_check.pl [OPTION]
221
222 =head1 DESCRIPTION
223
224 Check dependencys. List all perl modules needed by Lx-Office, probes for them,
225 and warns if one is not available.  List all LaTeX document classes and
226 packages needed by Lx-Office master templates, probes for them, and warns if
227 one is not available.
228
229
230 =head1 OPTIONS
231
232 =over 4
233
234 =item C<-a, --all>
235
236 Probe for all perl modules and all LaTeX master templates.
237
238 =item C<-c, --color>
239
240 Color output. Default on.
241
242 =item C<--no-color>
243
244 No color output. Helpful to avoid terminal escape problems.
245
246 =item C<-d, --devel>
247
248 Probe for perl developer dependancies. (Used for console  and tags file)
249
250 =item C<--no-devel>
251
252 Don't probe for perl developer dependancies. (Useful in combination with --all)
253
254 =item C<-h, --help>
255
256 Display this help.
257
258 =item C<-o, --optional>
259
260 Probe for optional modules.
261
262 =item C<--no-optional>
263
264 Don't probe for optional perl modules. (Useful in combination with --all)
265
266 =item C<-r, --required>
267
268 Probe for required perl modules (default).
269
270 =item C<--no-required>
271
272 Don't probe for required perl modules. (Useful in combination with --all)
273
274 =item C<-l. --latex>
275
276 Probe for LaTeX documentclasses and packages in master templates.
277
278 =item C<--no-latex>
279
280 Don't probe for LaTeX document classes and packages in master templates. (Useful in combination with --all)
281
282 =item C<-v. --verbose>
283
284 Print additional info for missing dependancies
285
286 =back
287
288 =head1 BUGS, CAVEATS and TODO
289
290 =over 4
291
292 =item *
293
294 Fedora packages not listed yet.
295
296 =item *
297
298 Not possible yet to generate a combined cpan/apt-get string to install all needed.
299
300 =item *
301
302 Not able to handle devel cpan modules yet.
303
304 =item *
305
306 Version requirements not fully tested yet.
307
308 =back
309
310 =head1 AUTHOR
311
312   Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
313   Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
314   Wulf Coulmann E<lt>wulf@coulmann.deE<gt>
315
316 =cut