home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / share / sgml-data / sgml-catalog-check.pl
Encoding:
Perl Script  |  2004-01-11  |  4.2 KB  |  168 lines
  1. #!/usr/bin/perl
  2. # sgml-catalog-check.pl -- check sgml catalog file
  3. #
  4. #Author: apharris@onshore.com (A. P. Harris)
  5. #$Date: 2004/01/11 05:53:25 $
  6. #$Revision: 1.20 $
  7. #
  8. #Todo:
  9. #    cross check the links/dtds and make sure they all appear in the
  10. #      SGML catalog
  11. #    convert to use perl sgml stuff instead of hand-rolling?
  12. #    make a nice lintian script from this
  13. #    deal with declation and notation files
  14.  
  15. use Getopt::Std;
  16.  
  17. $Verbose = 1;            # verboseness, 1 == chatty, 2 == loud
  18. $SGMLdir = "debian/tmp/usr/share/sgml"; # default dir for link making etc
  19. $Catalog = "sgml.catalog";    # default SGML catalog file
  20. $ChopEN = 1;            # whether to chop off //EN[//.*] language specifiers
  21.  
  22. $Usage = "Usage: $0 [-d <SGML dir>] [-v #] [-e] [<SGML catalog file>]
  23. Check SGML catalog file, create the links as documented in the SGML
  24. sub-policy, and also ensure that the files referenced from the catalog
  25. file actually exists.
  26.    -d <SGML dir>        base dir, default is $SGMLdir
  27.    -v <number>        verbosity amount, 0=silent, 1=default, 2=debug
  28.    -e                   don't omit the trailing EN language specifier (//EN)
  29.    -l                   legacy argument, ignored
  30.    <SGML catalog file>  default is $Catalog
  31. ";
  32.  
  33. $warnings = $errors = 0;    # error and warning count
  34.  
  35. &getopts('ehlv:d:') || die $Usage;
  36.  
  37. if ( $opt_h ) 
  38. {
  39.     print $Usage;
  40.     $opt_h && exit;        # shut up -w
  41. }
  42. elsif ( $opt_d == 1 ) {
  43.     die "option '-d' must have an argument\n$Usage";
  44. } 
  45. elsif ( $opt_d ) {
  46.     $SGMLdir = $opt_d;
  47. }
  48.  
  49. if ( defined($opt_v) ) {
  50.     $Verbose = $opt_v;
  51. }
  52.  
  53. if ( $opt_l ) {
  54.     $opt_l = $opt_l;            # shut up, -w
  55.     warn("symlinks under /usr/share/sgml no longer desired or created, ignoring -l\n");
  56. }
  57.  
  58. if ( $opt_e ) {
  59.     $opt_e = $opt_e;            # shut up, -w
  60.     $ChopEN = 0;
  61. }
  62.  
  63. if ( $#ARGV > 0 ) {
  64.     die "too many arguments\n$Usage";
  65. } elsif ( $#ARGV == 0 ) {
  66.     $Catalog = $ARGV[0];
  67. }
  68.  
  69. ( -f $Catalog ) or
  70.     die "catalog file $Catalog does not exist\n$Usage";
  71. ( -d $SGMLdir ) or
  72.     die "SGML directory $SGMLdir does not exist\n$Usage";
  73.  
  74. open(CAT, "<$Catalog") or
  75.     die "cannot read $Catalog: $!\n";
  76.  
  77. ## when checking for system ids, we need to check relative to the
  78. ## catalog file location, so figure out the relative dir of the
  79. ## catalog file, possibly removing a prepended SGMLdir
  80.  
  81. $CatDir = `dirname $Catalog`;
  82. chomp($CatDir);
  83. $CatDir =~ s/^$SGMLdir\/?//;
  84.  
  85. while (<CAT>) {
  86.     chomp;
  87.     # FIXME: add another line if next line starts with whitespace
  88.     # D: skipped catalog line:
  89.     #  PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
  90.     # D: skipped catalog line:
  91.     #    "docbook.dtd"
  92.  
  93.     if ( m/^PUBLIC\s+\"([^\"]+)\"\s+\"?([^\s\"]+)\"?/ ) {
  94.     ( $id, $file ) = ( $1, $2 );
  95.     debug("found public identifier \"$id\"");
  96.     debug("system identifier is $file");
  97.     if ( -f "$SGMLdir/$CatDir/$file" ) {
  98.             $file = "$CatDir/$file";
  99.         } elsif ( ! -f "$SGMLdir/$file" ) {
  100.         error("referenced-file-does-not-exist $SGMLdir/$CatDir/$file of $SGMLdir/$file");
  101.         next;
  102.     }
  103.     
  104.     if ( $id =~ m!^(.+)//(?:([^/]+)//)?(ELEMENTS|DOCUMENT|ENTITIES|DTD)\s+([^/]+)//(.+)$! ) {
  105.         ( $reg, $vendor, $type, $name, $misc ) = ( $1, $2, $3, $4, $5 );
  106.  
  107.         if ( $type eq "ENTITIES" ) {
  108.                                 # AOK, no checking for location
  109.         } 
  110.         elsif ( $type eq "DTD" || $type eq "ELEMENTS" ) {
  111.                                 # AOK, no checking for location
  112.         }
  113.         elsif ( $type eq "DOCUMENT" ) {
  114.         ( $file =~ m!^dtd/! || $file =~ m!^entities! ) &&
  115.             error("DOCUMENT-in-dtd-or-entities-dir $file");
  116.         }
  117.         else {
  118.         error("identifier-type-not-recognized $type on FPI $id");
  119.         }
  120.         
  121.         # would be nice to check that the DTD file is reasonable
  122.         # oh well...
  123.  
  124.             # quieten warnings
  125.             $name = $name;
  126.             $misc = $misc;
  127.             $reg = $reg;
  128.             $vendor = $vendor;
  129.     }
  130.     else {
  131.         error("SGML-identifier-not-in-recognized-form $id");
  132.         next;
  133.     }
  134.     }
  135.     else {
  136.     debug("skipped catalog line:\n   $_");
  137.     next;
  138.     }
  139. }
  140.  
  141. if ( $errors ) {
  142.     exit(1);
  143. }
  144. exit(0);
  145.  
  146. sub debug {
  147.     local($msg) = @_;
  148.     ( $Verbose > 1 ) && warn("D: $msg\n");
  149. }
  150.  
  151. sub inform {
  152.     local($msg) = @_;
  153.     ( $Verbose ) && warn("N: $msg\n");
  154. }
  155.  
  156. sub warning {
  157.     local($msg) = @_;
  158.     $warnings++;
  159.     warn("W: $msg\n");
  160. }
  161.  
  162. sub error {
  163.     local($msg) = @_;
  164.     $errors++;
  165.     warn("E: $msg\n");
  166. }
  167.  
  168.