toolbox/check-perl-modules.pl

   1 #!/usr/bin/env perl
   2
   3 # check-perl-modules.pl -- check for modules used by Girocco
   4 # Copyright (c) 2013,2019,2020,2021 Kyle J. McKay.  All rights reserved.
   5 # License GPLv2+: GNU GPL version 2 or later.
   6 # www.gnu.org/licenses/gpl-2.0.html
   7 # This is free software: you are free to change and redistribute it.
   8 # There is NO WARRANTY, to the extent permitted by law.
   9
  10 # Attempt to require all the modules used by Perl anywhere in Girocco and
  11 # report the failures.  There is special handling for the SHA-1 functions
  12 # and some other optional modules.
  13
  14 # These ones are not errors
  15
  16 eval {require Proc::ProcessTable; 1} or
  17 print "Note: missing Perl module Proc::ProcessTable, deprecated ".
  18         "toolbox/kill-stale-daemons.pl will not function\n";
  19
  20 eval {require HTML::Entities; 1} or
  21 print "Warning: missing Perl module HTML::Entities, gitweb ".
  22         "email obfuscation will be partially disabled\n";
  23
  24 eval {require HTML::TagCloud; 1} or
  25 print "Warning: missing Perl module HTML::TagCloud, optional gitweb tag cloud ".
  26         "display will be all one size\n";
  27
  28 eval {require HTTP::Date; 1} ||
  29 eval {require Time::ParseDate; 1} or
  30 print "Warning: missing Perl module HTTP::Date and Time::ParseDate, gitweb ".
  31         "will always return true to if-modified-since feed requests\n";
  32
  33 # These ones are required
  34
  35 my $errors = 0;
  36
  37 # For SHA1, any of Digest::SHA, Digest::SHA1 or Digest::SHA::PurePerl will do
  38
  39 eval {require Digest::SHA; 1} ||
  40 eval {require Digest::SHA1; 1} ||
  41 eval {require Digest::SHA::PurePerl; 1} or
  42 ++$errors,
  43 print STDERR "One of the Perl modules Digest::SHA or Digest::SHA1 or "
  44 . "Digest::SHA::PurePerl must be available\n";
  45
  46 # For XML, either of XML::Simple or XML::Parser will do
  47
  48 eval {require XML::Simple; 1} ||
  49 eval {require XML::Parser; 1} or
  50 ++$errors,
  51 print STDERR "One of the Perl modules XML::Simple or "
  52 . "XML::Parser must be available\n";
  53
  54 my @modules = qw(
  55         CGI
  56         CGI::Carp
  57         CGI::Util
  58         Compress::Zlib
  59         Digest::MD5
  60         Encode
  61         Errno
  62         Fcntl
  63         File::Basename
  64         File::Find
  65         File::Spec
  66         File::stat
  67         Getopt::Long
  68         IO::Handle
  69         IO::Socket
  70         IO::Socket::UNIX
  71         IPC::Open2
  72         JSON
  73         LWP::UserAgent
  74         MIME::Base64
  75         Pod::Usage
  76         POSIX
  77         RPC::XML
  78         RPC::XML::Client
  79         Socket
  80         Storable
  81         Time::HiRes
  82         Time::Local
  83 );
  84
  85 my %imports = (
  86         Time::HiRes => [qw(gettimeofday tv_interval)],
  87 );
  88
  89 foreach my $module (@modules) {
  90         my $imports = '';
  91         $imports = " qw(".join(' ', @{$imports{$module}}).")"
  92                 if $imports{$module};
  93         eval "use $module$imports; 1" or
  94         ++$errors, print STDERR "Missing required Perl module $module$imports\n";
  95 }
  96
  97 eval {require JSON; 1} &&
  98 eval {require LWP::UserAgent; 1} &&
  99 eval {require RPC::XML; 1} &&
 100 eval {require RPC::XML::Client; 1} or
 101 print STDERR "Note: Perl modules JSON, LWP::UserAgent, RPC::XML and RPC::".
 102         "XML::Client are required by the ref-change notification mechanism\n";
 103
 104 my $fcgi_ok = 1;
 105 eval {require FCGI; 1} or $fcgi_ok = 0,
 106 print STDERR "Note: missing Perl module FCGI used for efficient ".
 107         "gitweb.cgi FastCGI implementation\n";
 108 my $cgifast_ok = 1;
 109 eval {require CGI::Fast; 1} or $cgifast_ok = 0,
 110 print STDERR "Note: missing Perl module CGI::Fast used for efficient ".
 111         "gitweb.cgi FastCGI implementation\n";
 112 my $mods = "";
 113 $mods .= "FCGI" unless $fcgi_ok;
 114 $mods .= ($mods?" and ":"")."CGI::Fast" unless $cgifast_ok;
 115 my $pl = "";
 116 $pl = "s" unless $fcgi_ok || $cgifast_ok;
 117 $mods eq "" or
 118 print STDERR "Warning: gitweb.cgi running in FastCGI mode will use a pure Perl ".
 119         "implementation of FastCGI\n".
 120         "Warning: install Perl module$pl $mods for a more efficient gitweb.cgi ".
 121         "FastCGI implementation\n";
 122 eval {require FCGI::ProcManager; 1} or
 123 print STDERR "Note: gitweb.cgi running in FastCGI mode requires ".
 124         "missing FCGI::ProcManager to support the --nproc option\n";
 125
 126 !$errors or print STDERR "\nFatal: required perl modules are missing!\n\n";
 127
 128 exit($errors ? 1 : 0);