debian/debbugsconfig

   1 #!/usr/bin/perl
   2 # debbugsconfig: copies debbugs configuration files from templates, and
   3 #                creates documentation in HTML and text
   4
   5 use POSIX qw(strftime);
   6
   7 if (@ARGV) {
   8   print STDOUT <<EOF;
   9 Usage: $0
  10
  11 debbugsconfig will copy basic debbugs configuration files from templates
  12 if they don't exist.
  13
  14 It will also create BTS user documentation in HTML and text.
  15
  16 EOF
  17   exit(0);
  18 }
  19
  20 $gConfigDir = "/etc/debbugs" if (!defined($gConfigDir));
  21 &template("config");
  22 require "$gConfigDir/config";
  23 unshift @INC, $gConfigDir;
  24
  25 &template("text");
  26 require "text";
  27
  28 &template("Maintainers");
  29 &template("pseudo-packages.description");
  30 &template("nextnumber");
  31
  32 # stuff used when testing (comment out the above)
  33 #unshift @INC, "../";
  34 #require "../scripts/config.in";
  35 #require "../scripts/text.in";
  36 #$gWebDir = "gWebDir";
  37 #$gDocDir = "gWebDir";
  38
  39 my $dtime = strftime "%a, %e %b %Y %T UTC", localtime;
  40 $gHTMLTail =~ s/SUBSTITUTE_DTIME/$dtime/;
  41
  42 print "Creating files in $gWebDir:\n";
  43 require('html/index.html.in');
  44 &writefiles ('index', '', $gIndexHtml );
  45 require('html/Access.html.in');
  46 &writefiles ('Access', 'bug-log-access', $gAccessHtml );
  47 require('html/Developer.html.in');
  48 &writefiles ('Developer', 'bug-maint-info', $gDeveloperHtml );
  49 require('html/Reporting.html.in');
  50 &writefiles ('Reporting', 'bug-reporting', $gReportingHtml );
  51 require('html/server-control.html.in');
  52 &writefiles ('server-control', 'bug-maint-mailcontrol', $gControlHtml );
  53 require('html/server-refcard.html.in');
  54 &writefiles ('server-refcard', 'bug-mailserver-refcard', $gRefcardHtml );
  55 require('html/server-request.html.in');
  56 &writefiles ('server-request', 'bug-log-mailserver', $gRequestHtml );
  57 print "\n";
  58
  59 exit(0);
  60
  61 # -------------------------------------------------------------------------- #
  62
  63 sub template {
  64   my ($name) = @_;
  65   if (! -f "$gConfigDir/$name") {
  66   system("cp /usr/share/doc/debbugs/examples/$name $gConfigDir/$name") == 0 ||
  67         die "$!";
  68   print "created $gConfigDir/$name from template.";
  69   }
  70 }
  71
  72 sub writefiles {
  73   local ($html, $text, $name) = @_;
  74 # first HTML
  75   unlink("$gWebDir/$html.html");
  76   open(DEST, ">$gWebDir/$html.html") || die "\n$gWebDir/$html.html: $!";
  77   print DEST $name;
  78   close(DEST);
  79   print "$html.html ";
  80 # now text
  81   return if ($text eq ""); # for index.html
  82 # This should be done with pipes instead of a temporary files, but lynx
  83 # doesn't read HTML from stdin :/
  84   open(DEST, ">$gDocDir/$text.html") || die "\n$gDocDir/$text.html: $!";
  85   $name =~ s,\nOther pages:\n.*?<hr>,,si;
  86   print DEST $name;
  87   close(DEST);
  88   unlink("$gDocDir/$text.txt");
  89   $ENV{'HOME'} = "/tmp";
  90   $ENV{'TERM'} = "linux";
  91   if (-x "/usr/bin/links") {
  92     system ("rm -rf /tmp/.links/") == 0 || die;
  93     system ("links -dump $gDocDir/$text.html > $gDocDir/$text.txt") == 0 ||
  94       die "\nunable to write $gDocDir/$text.txt\n";
  95     system ("rm -rf /tmp/.links/");
  96   } elsif (-x "/usr/bin/lynx") {
  97     system ("lynx -nolist -dump -cfg=$gConfigDir/html/lynx-cfg $gDocDir/$text.html > $gDocDir/$text.txt") == 0 ||
  98       die "\nunable to write $gDocDir/$text.txt\n";
  99   } else {
 100     print "unable to write text versions of the HTMLs!";
 101     print "if you need them, install links or lynx and run debbugsconfig again";
 102     return;
 103   }
 104   unlink("$gDocDir/$text.html") || die "\ncan't remove temporary file $gDocDir/$text.html: $!";
 105   print "$text.txt ";
 106 }