helm/http_getter/http_getter.pl.in

   1 #!@PERL_BINARY@
   2
   3 # Copyright (C) 2000, HELM Team.
   4 #
   5 # This file is part of HELM, an Hypertextual, Electronic
   6 # Library of Mathematics, developed at the Computer Science
   7 # Department, University of Bologna, Italy.
   8 #
   9 # HELM is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License
  11 # as published by the Free Software Foundation; either version 2
  12 # of the License, or (at your option) any later version.
  13 #
  14 # HELM is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with HELM; if not, write to the Free Software
  21 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22 #
  23 # For details, see the HELM World-Wide-Web page,
  24 # http://cs.unibo.it/helm/.
  25
  26 #use strict;
  27
  28 my $VERSION = "@VERSION@";
  29
  30 # various variables
  31 my ($HELM_LIB_PATH);
  32 my $cgi_dir = "@HELM_CGI_DIR@";
  33 my (%map, %rdf_map);
  34
  35 # First of all, let's load HELM configuration
  36 use Env;
  37 my $HELM_LIB_DIR = $ENV{"HELM_LIB_DIR"};
  38 # this should be the only fixed constant
  39 my $DEFAULT_HELM_LIB_DIR = "@HELM_LIB_DIR@";
  40 if (defined ($HELM_LIB_DIR)) {
  41    $HELM_LIB_PATH = $HELM_LIB_DIR."/configuration.pl";
  42 } else {
  43    $HELM_LIB_PATH = $DEFAULT_HELM_LIB_DIR."/configuration.pl";
  44 }
  45
  46 # next require defines: $helm_dir, $html_link, $dtd_dir, $uris_dbm, $indexname
  47 require $HELM_LIB_PATH;
  48
  49 # TEMP: TODO put these vars in configuration file configuration.xml
  50 # <move_to_conf_file>
  51 my $cachemode = $ENV{'HTTP_GETTER_CACHE_MODE'} ||
  52     'gzipped';
  53 if (($cachemode ne 'gzipped') and ($cachemode ne 'normal')) {
  54  die "Invalid HTTP_GETTER_CACHE_MODE environment variable, must be".
  55  "'normal' or 'gzipped'\n";
  56 }
  57 my $helm_rdf_dir = $ENV{'HTTP_GETTER_RDF_DIR'} ||
  58     "/usr/local/helm/rdf_library";
  59 my $rdf_dbm = $ENV{'HTTP_GETTER_RDF_DBM'} ||
  60     "/usr/local/helm/rdf_urls_of_uris";
  61 my $rdf_indexname = $ENV{'HTTP_GETTER_RDF_INDEXNAME'} ||
  62     "rdf_index.txt";
  63 # </move_to_conf_file>
  64
  65 # Let's override the configuration file
  66 $style_dir = $ENV{"HELM_STYLE_DIR"} if (defined ($ENV{"HELM_STYLE_DIR"}));
  67 $dtd_dir = $ENV{"HELM_DTD_DIR"} if (defined ($ENV{"HELM_DTD_DIR"}));
  68
  69 use HTTP::Daemon;
  70 use HTTP::Status;
  71 use HTTP::Request;
  72 use LWP::UserAgent;
  73 use DB_File;
  74 use Compress::Zlib;
  75 use CGI;
  76 use URI::Escape;
  77
  78 #CSC: mancano i controlli sulle condizioni di errore di molte funzioni
  79 #CSC: ==> non e' robusto
  80 #CSC: altra roba da sistemare segnata con CSC
  81
  82 my $d = new HTTP::Daemon LocalPort => 8081;
  83 my $myownurl = $d->url;
  84
  85 # Let's patch the returned URL
  86 $myownurl =~ s/\/$//; # chop the final slash
  87 my $myownport = $myownurl;
  88 $myownport =~ s/http:\/\/(.*):(.*)/$2/;
  89 $myownurl  =~ s/http:\/\/(.*):(.*)/$1/;
  90 ($myownurl) = gethostbyname($myownurl);
  91 $myownurl = "http://".$myownurl.":".$myownport;
  92
  93 tie(%map, 'DB_File', $uris_dbm.".db", O_RDWR, 0664); # open dbs
  94 tie(%rdf_map, 'DB_File', $rdf_dbm.".db", O_RDWR, 0664);
  95
  96 print "\n";
  97 print "HTTP Getter $VERSION\n"; # print hello information
  98 print "Please contact me at: <URL:", $myownurl."/", ">\n";
  99 print "\n";
 100 print "helm_dir: $helm_dir\n";
 101 print "helm_rdf_dir: $helm_rdf_dir\n";
 102 print "style_dir: $style_dir\n";
 103 print "dtd_dir: $dtd_dir\n";
 104 print "urls_of_uris db: $uris_dbm.db\n";
 105 print "rdf db: $rdf_dbm.db\n";
 106 print "cache mode: $cachemode\n";
 107 print "indexname: $indexname\n";
 108 print "rdf_indexname: $rdf_indexname\n";
 109 print "\n";
 110
 111 $SIG{CHLD} = "IGNORE"; # do not accumulate defunct processes
 112 $SIG{USR1} = \&update; # sent by the child to make the parent update
 113
 114 while (my $c = $d->accept) {
 115  if (fork() == 0) {
 116     while (my $r = $c->get_request) {
 117         #CSC: mancano i controlli di sicurezza
 118
 119         my $http_method = $r->method;
 120         my $http_path = $r->url->path;
 121         my $http_query = uri_unescape($r->url->query);
 122         my $cgi = new CGI("$http_query");
 123         my $inputuri = $cgi->param('uri');
 124         print "\nRequest: ".$r->url."\n\n";
 125
 126         print "\nUnescaped query: ".$http_query."\n";
 127
 128          # "getxml" works with rdf uris
 129         if ($http_method eq 'GET' and $http_path eq "/getxml") {
 130             # finds the uri, url and filename
 131
 132             my $answerformat = $cgi->param('format');
 133             my $patch_dtd = $cgi->param('patch_dtd');
 134             $answerformat = "" if (not defined($answerformat));
 135             $patch_dtd = "yes" if (not defined($patch_dtd));
 136             if (($answerformat ne "gz") and ($answerformat ne "normal")
 137                and ($answerformat ne "")) {
 138              die "Wrong output format: $answerformat, must be 'normal' ".
 139                  "or 'gz'\n";
 140             }
 141             if (($patch_dtd ne "yes") and ($patch_dtd ne "no")
 142                and ($patch_dtd ne "")) {
 143              die "Wrong param, patch_dtd must be 'yes' or 'no'\n";
 144             }
 145
 146             my $filename = $inputuri;
 147             my $prefix;
 148             if (not isRdfUri($inputuri)) { # standad cic: or theory: uri
 149              $filename =~ s/^cic:(.*)/$1/;
 150              $filename =~ s/^theory:(.*)/$1/;
 151             } else { # rdf uri
 152              # The "helm:rdf/<<...>>//cic:" prefix is kept, but quoted
 153              # (so that a "helm:rdf/<<...>>//cic:" dir is created
 154              $prefix = $filename;
 155              $filename =~ s/^(.*)\/\/cic:(.*)/$2/;
 156              $filename =~ s/^(.*)\/\/theory:(.*)/$2/;
 157              $prefix =~ s/\Q$filename\E//;
 158              $prefix =~ s/_/__/g;
 159              $prefix =~ s/\//_/g;
 160              $filename = $prefix.$filename;
 161             }
 162
 163             my $url = resolve ($inputuri); # resolve uri in url
 164             if (not defined($url)) { # uri not found in uri2url map
 165              die "NOT FOUND: uri \"$inputuri\" can't be resolved\n";
 166              $c->send_error(RC_NOT_FOUND)
 167             } else { # uri found and mapped to url
 168               my $extension; # file extension
 169               if ($url =~ /\.xml$/) { # non gzipped file
 170                 $extension = ".xml";
 171               } elsif ($url =~ /\.xml\.gz$/) { # gzipped file
 172                 $extension = ".xml.gz";
 173               } else { # error: unknown extension
 174                die "unexpected extension in url: $url, might be '.xml'".
 175                 "or '.xml.gz'";
 176               }
 177
 178               if (not isRdfUri ($inputuri)) { # save in uri std cache dir
 179                $filename = $helm_dir.$filename.$extension;
 180               } else { # save in rdf metadata cache dir
 181                $filename = $helm_rdf_dir."/".$filename.$extension;
 182               }
 183
 184               print_request($inputuri,$url,$filename);
 185
 186               # Retrieves the file
 187               my $ciccontent = download($patch_dtd,$url,$filename,$answerformat);
 188
 189               if ($answerformat eq "normal") { # answer the client in text/xml
 190                answer($c,$ciccontent,"text/xml","");
 191               } else { # answer the client in text/xml, gzip encoding
 192                answer($c,$ciccontent,"text/xml","x-gzip");
 193               }
 194             }
 195
 196                            # "/register" does not work with rdf uris
 197         } elsif ($http_method eq 'GET' and $http_path eq "/register") {
 198           my $inputurl = $cgi->param('url');
 199           print "Register requested...\n";
 200           $map{$inputuri}=$inputurl;
 201
 202           # Now let's clean the cache
 203           my $cicfilename = $inputuri;
 204           $cicfilename =~ s/cic:(.*)/$1/;
 205           $cicfilename =~ s/theory:(.*)/$1/;
 206
 207           print "Unlinking ".$helm_dir.$cicfilename.".xml[.gz]\n";
 208           unlink ($helm_dir.$cicfilename.".xml");
 209           unlink ($helm_dir.$cicfilename.".xml.gz");
 210
 211           kill(USR1,getppid()); # signal changes to parent
 212           untie %map;
 213           print "done.\n";
 214           html_nice_answer($c,"Register done");
 215
 216                                   # "/resolve" works with rdf uri
 217         } elsif ($http_method eq 'GET' and $http_path eq "/resolve") {
 218           #my $outputurl = $map{$inputuri};
 219           my $outputurl = resolve($inputuri);
 220           $outputurl = "" if (not defined($outputurl));
 221           $cont = "<?xml version=\"1.0\" ?>\n\n";
 222           if ($outputurl eq "") {
 223            $cont .= "<unresolved />\n";
 224           } else {
 225            $cont .= "<url value=\"$outputurl\" />\n";
 226           }
 227           answer($c,$cont,"text/xml","");
 228
 229         } elsif ($http_method eq 'GET' and $http_path eq "/getdtd") {
 230             my $filename = $inputuri;
 231             $filename = $dtd_dir."/".$filename;
 232             print "DTD: $inputuri ==> ($filename)\n";
 233             if (stat($filename)) {
 234                print "Using local copy\n";
 235                open(FD, $filename) or die "Cannot open $filename\n";
 236                $cont = "";
 237                while(<FD>) {
 238                 # Vary bad heuristic for substituion of absolute URLs
 239                 # for relative ones
 240                 s/ENTITY (.*) SYSTEM\s+"/ENTITY $1 SYSTEM "$myownurl\/getdtd?uri=/g;
 241                 $cont .= $_;
 242                }
 243                close(FD);
 244                answer($c,$cont,"text/xml","");
 245             } else {
 246                die "Could not find DTD!";
 247             }
 248
 249         } elsif ($http_method eq 'GET' and $http_path eq "/getstyleconf") {
 250             my $filename = $inputuri;
 251             $filename = $style_dir."/config/".$filename;
 252             if (stat($filename)) {
 253                open(FD, $filename) or die "Cannot open $filename\n";
 254                $cont = "";
 255                while(<FD>) {
 256                 s/DOCTYPE (.*) SYSTEM\s+"/DOCTYPE $1 SYSTEM "$myownurl\/getstyleconf?uri=/g;
 257                 $cont .= $_;
 258                }
 259                close(FD);
 260                answer($c,$cont,"text/plain","");
 261             } else {
 262                die "Could not find Style Configuration File!";
 263             }
 264
 265         } elsif ($http_method eq 'GET' and $http_path eq "/getxslt") {
 266             my $filename = $inputuri;
 267             $filename = $style_dir."/".$filename;
 268             print "XSLT: $inputuri ==> ($filename)\n";
 269             if (stat($filename)) {
 270                print "Using local copy\n";
 271                open(FD, $filename) or die "Cannot open $filename\n";
 272                $cont = "";
 273                while(<FD>) {
 274                 # Vary bad heuristic for substituion of absolute URLs
 275                 # for relative ones
 276                 s/xsl:import\s+href="/xsl:import href="$myownurl\/getxslt?uri=/g ;
 277                 s/xsl:include\s+href="/xsl:include href="$myownurl\/getxslt?uri=/g ;
 278                 $cont .= $_;
 279                }
 280                close(FD);
 281                answer($c,$cont,"text/xml","");
 282             } else {
 283                die "Could not find XSLT!";
 284             }
 285
 286                                     # "/update" works with rdf uri
 287         } elsif ($http_method eq 'GET' and $http_path eq "/update") {
 288             # rebuild urls_of_uris db and rdf uris db
 289            print "Update requested...\n";
 290            update_dbs();
 291            kill(USR1,getppid()); # signal changes to parent
 292            print " done\n";
 293            html_nice_answer($c,"Update done");
 294
 295                                  # "/ls" does not work with rdf uris
 296         } elsif ($http_method eq 'GET' and $http_path eq "/ls") {
 297             # send back keys that begin with a given uri
 298            my ($uritype,$uripattern,$uriprefix);
 299            my $baseuri = $cgi->param('baseuri');
 300            chop $baseuri if ($baseuri =~ /.*\/$/); # remove trailing "/"
 301                          # output type, might be 'txt' or 'xml':
 302            my $outype = $cgi->param('format');
 303            $uripattern = $baseuri;
 304            $uripattern =~ s/^.*:(.*)/$1/;
 305            if ($baseuri =~ /^cic:/) {
 306             $uritype = "cic";
 307            } elsif ($baseuri =~ /^theory:/) {
 308             $uritype = "theory";
 309            } else {
 310             $uritype = "invalid";
 311            }
 312            if ($uritype ne "invalid") { # uri is valid
 313             if (($outype ne 'txt') and ($outype ne 'xml')) { # invalid out type
 314              print "Invalid output type specified: $outype\n";
 315              html_nice_answer($c,"Invalid output type, must be ".
 316               "'txt' or 'xml'");
 317             } else { # valid output
 318              print "BASEURI $baseuri, FORMAT $outype\n";
 319              $cont = finduris($uritype,$uripattern,$outype);
 320              if ($outype eq 'txt') {
 321               answer($c,$cont,"text/plain","");
 322              } elsif ($outype eq 'xml') {
 323               answer($c,$cont,"text/xml","");
 324              } else {
 325               die "Internal error, exiting!";
 326              }
 327             }
 328            } else { # invalid uri
 329             print "Invalid uri: $baseuri, may begin with 'cic:', ".
 330              "'theory:' or '*:'\n";
 331             html_nice_answer($c,"Invalid uri , must begin with ".
 332              "'cic:' or 'theory:'");
 333            }
 334
 335         } elsif ($http_method eq 'GET' and $http_path eq "/help") {
 336           # help request
 337            print "Help requested!\n";
 338            html_nice_answer($c,"HTTP Getter Version: $VERSION");
 339
 340         } elsif ($http_method eq 'GET' and $http_path =~ /\.cgi$/) {
 341           # cgi handling
 342            print "CGI requested!\n";
 343            if ($http_path !~ /^\/[^\/]*\.cgi$/) {
 344             html_nice_answer($c,"Invalid CGI name: $http_path, ".
 345             "you can't request CGI that contain a slash in the name\n");
 346            } elsif (stat "$cgi_dir"."$http_path") {
 347             if (not -x "$cgi_dir/$http_path") {
 348              html_nice_answer($c,"CGI $http_path found but not ".
 349               "executable\n");
 350             } else { # exec CGI and anser back its output
 351              my %old_ENV = %ENV;
 352              %ENV = ();
 353              $ENV{'QUERY_STRING'} = $http_query;
 354              my $cgi_output = `$cgi_dir/$http_path`;
 355              answer($c,$cgi_output,"","");
 356              %ENV = %old_ENV;
 357             }
 358            } else {
 359             html_nice_answer($c,"CGI '$http_path' not found ".
 360              "in CGI dir '$cgi_dir'");
 361            }
 362
 363         } else { # unsupported request
 364             print "\n";
 365             print "INVALID REQUEST!!!!!\n";
 366             print "(PATH: ",$http_path,", ";
 367             print "QUERY: ",$http_query,")\n";
 368             $c->send_error(RC_FORBIDDEN)
 369         }
 370
 371         print "\nRequest solved: ".$r->url."\n\n";
 372     }
 373
 374     $c->close;
 375     undef($c);
 376     print "\nCONNECTION CLOSED\n\n";
 377     exit;
 378   } # fork
 379 }
 380
 381 #================================
 382
 383 sub isRdfUri { # return true if the uri is an rdf uri, false otherwise
 384 # typycal rdf uri:
 385 # helm:rdf/cic:www.cs.unibo.it/helm/rdf/foo_schema//cic:\
 386 #  /Coq/Init/Logic/True_rec.con.types
 387 #
 388 # the format is "helm:rdf/<metadata_tree>:<metadata_scheme>//<xml_file_uri>"
 389 #
 390  my ($uri) = @_;
 391  if ($uri =~ /^helm:rdf(.*):(.*)\/\/(.*)/) {
 392   return 1;
 393  } else {
 394   return 0;
 395  }
 396 }
 397
 398 sub resolve { # resolve an uri in a url, work both with standard cic: or theory:
 399               # uris and rdf uris
 400  print "RESOLVE subroutine\n";
 401  my ($uri) = @_;
 402  print "GIVEN URI: \"$uri\"\n";
 403  if (isRdfUri ($uri)) { # rdf uri, resolve using rdf db
 404   print "IS A RDF URI\n";
 405   print "I WILL RETURN '$rdf_map{$uri}'\n";
 406   return ($rdf_map{$uri});
 407  } else { # standard cic: or theory: uri, resolve using std uri db
 408   print "IS NOT A RDF URI\n";
 409   print "I WILL RETURN '$map{$uri}'\n";
 410   return ($map{$uri});
 411  }
 412 }
 413
 414 sub finduris { # find uris for cic and theory trees generation
 415  my ($uritype,$uripattern,$format) = @_;
 416  my $content = "";
 417  my ($uri,$localpart,$basepart,$dirname,$suffix,$flags,$key);
 418  my (@itemz,@already_pushed_dir);
 419  my (%objects,%dirs); # map uris to suffixes' flags
 420  my $debug=1; # for debug
 421
 422  print "FINDURIS, uritype: $uritype, uripattern: $uripattern, ".
 423   "format: $format\n\n" if defined($debug);
 424
 425  if (($uritype eq "cic") or ($uritype eq "theory")) {
 426    # get info only of one type: cic or theory
 427   foreach (keys(%map)) { # select matching uris
 428    $uri = $_;
 429    if ($uri =~ /^$uritype:$uripattern(\/|$|\.)/) {
 430     if ($uri =~ /^$uritype:$uripattern\//) { # directory match
 431      $localpart = $uri;
 432      $localpart =~ s/^$uritype:$uripattern\/(.*)/$1/;
 433     } elsif ($uri =~ /^$uritype:$uripattern($|\.)/) { # file match
 434      $localpart = $uri;
 435      $localpart =~ s/^.*\/([^\/]*)/$1/;
 436     } else {
 437      die "Internal error, seems that requested match is none of ".
 438       "directory match or file match";
 439     }
 440     print "LOCALPART: $localpart\n" if defined($debug);
 441
 442     if ($localpart =~ /^[^\/]*$/) { # no slash, an OBJECT
 443      $basepart = $localpart;
 444      $basepart =~ s/^([^.]*\.[^.]*)(\.types)?(\.ann)?/$1/;
 445                                               # remove exts .types or
 446                                               # .types.ann
 447      $flags = $objects{$basepart}; # get old flags
 448      if ($localpart =~ /\.ann$/) {
 449       $flags = add_flag("ann","YES",$flags);
 450      } else {
 451       $flags = add_flag("ann","NO",$flags);
 452      }
 453      if ($localpart =~ /\.types$/) {
 454       $flags = add_flag("types","YES",$flags);
 455      } elsif ($localpart =~ /\.types\.ann$/) {
 456       $flags = add_flag("types","ANN",$flags);
 457      } else {
 458       $flags = add_flag("types","NO",$flags);
 459      }
 460      $objects{$basepart} = $flags; # save new flags
 461     } else { # exists at least one slash, a DIR
 462      ($dirname) = split (/\//, $localpart);
 463      $dirs{$dirname} = ""; # no flags requirement for dir
 464     }
 465    }
 466   }
 467  } else {
 468   die "getter internal error: unsupported uritype: \"$uritype\"";
 469  }
 470                             # now generate OUTPUT:
 471                             # output will be saved in $content
 472  if ($format eq "txt") { # TXT output
 473   foreach $key (sort(keys %dirs)) {
 474    $content .= "dir, " . $key . "\n";
 475   }
 476   foreach $key (sort(keys %objects)) {
 477    $content .= "object, $key, " . $objects{$key} . "\n";
 478   }
 479  } elsif ($format eq "xml") { # XML output
 480   $content .= '<?xml version="1.0" encoding="ISO-8859-1"?>' . "\n";
 481   $content .= "<!DOCTYPE ls SYSTEM ";
 482   $content .= "\"$myownurl/getdtd?uri=ls.dtd\">" . "\n\n";
 483   $content .= "<ls>\n";
 484   foreach $key (sort(keys %dirs)) {
 485    $content .= "\t<section>$key</section>\n";
 486   }
 487   foreach $key (sort(keys %objects)) {
 488    $content .= "\t<object name=\"$key\">\n";
 489    $flags = $objects{$key};
 490    $flags =~ s/^<(.*)>$/$1/;
 491    my ($annflag,$typesflag) = split /,/,$flags;
 492    $content .= "\t\t<ann value=\"$annflag\" />\n";
 493    $content .= "\t\t<types value=\"$typesflag\" />\n";
 494    $content .= "\t</object>\n";
 495   }
 496   $content .= "</ls>\n";
 497  } else { # may not enter this branch
 498   die "Getter internal error: invalid format received by finduris sub";
 499  }
 500  return $content;
 501 }
 502
 503 sub add_flag {
 504 # manage string like: "<ann_flag,type_flag>"
 505 # "ann_flag" may be one of "ann_YES", "ann_NO"
 506 # "type_flag" may be one of "types_NO", "types_YES", "types_ANN"
 507 # when adding a flag the max between the current flag and the new flag
 508 # is taken, the orders are ann_NO < ann_YES and types_NO < types_YES <
 509 # types_ANN
 510  my ($flagtype,$newflag,$str) = @_;
 511  $str = "<,>" if ($str eq "");
 512  ($str =~ s/^<(.*,.*)>$/$1/) or die "Internal error: ".
 513    "wrong string format for flag adding in $str";
 514  my ($annflag,$typeflag) = split /,/,$str;
 515  if ($flagtype eq "ann") { # ANN flag handling
 516   if ($newflag eq "YES") {
 517    $annflag = "YES";
 518   } elsif ($newflag eq "NO") {
 519    $annflag = "NO" unless ($annflag eq "YES");
 520   } else {
 521    die "Internal error: annflag must be \"YES\" or \"NO\"";
 522   }
 523  } elsif ($flagtype eq "types") { # TYPES flag handling
 524   if ($newflag eq "ANN") {
 525    $typeflag = "ANN";
 526   } elsif ($newflag eq "YES") {
 527    $typeflag = "YES" unless ($typeflag eq "ANN");
 528   } elsif ($newflag eq "NO") {
 529    $typeflag = "NO"
 530      unless (($typeflag eq "ANN") or ($typeflag eq "YES"));
 531   } else {
 532    die "Internal error: typeflag must be \"YES\", \"NO\" or \"ANN\"";
 533   }
 534  } else {
 535   die "Internal error: unsupported flagtype \"$flagtype\"";
 536  }
 537  $str = "<$annflag,$typeflag>";
 538 }
 539
 540 #CSC: Too much powerful: creates even /home, /home/users/, ...
 541 #CSC: Does not raise errors if could not create dirs/files
 542 sub mkdirs
 543 {
 544  my ($pathname) = @_;
 545  my @dirs = split /\//,$pathname;
 546  my $tmp;
 547  foreach $dir (@dirs) {
 548   $tmp = ((defined($tmp)) ?  $tmp."\/".$dir : "");
 549   mkdir($tmp,0777);
 550  }
 551  rmdir($tmp);
 552 }
 553
 554 sub print_request
 555 {
 556  my ($uri,$url,$filename) = @_;
 557  print "<download_request>\n";
 558  print "uri: $uri\n";
 559  print "url: $url\n";
 560  print "filename: $filename\n\n";
 561  print "</download_request>\n";
 562 }
 563
 564 sub callback
 565 {
 566  my ($data) = @_;
 567  $cont .= $data;
 568 }
 569
 570 sub gunzip { # gunzip a file and return the deflated content
 571         my ($filename) = @_;
 572
 573         my ($gz, $buffer, $cont);
 574
 575         print "deflating $filename ...\n";
 576         $gz = gzopen($filename, "r")
 577                 or die "Cannot open gzip'ed file $filename: $gzerrno";
 578         $cont = "";
 579         while ( $gz->gzread($buffer) > 0 ) {
 580                 $cont .= $buffer;
 581         }
 582         die "Error while reading : $gzerrno\n" if $gzerrno != Z_STREAM_END ;
 583         $gz->gzclose();
 584
 585         return $cont;
 586 }
 587
 588 sub gzip {      # gzip the content argument and save it to filename argument
 589         my ($cont, $filename) = @_;
 590  #my $debug=1; # debug only
 591
 592  print "gzopening $filename ...\n" if (defined($debug));
 593         my $gz = gzopen($filename, "w")
 594                 or die "Cannot gzopen for writing file $filename: $gzerrno";
 595  print "gzwriting ...\n" if (defined($debug));
 596         $gz->gzwrite($cont) or die "error writing: $gzerrno, exiting!\n";
 597  print "gzclosing ...\n" if (defined($debug));
 598         $gz->gzclose();
 599 }
 600
 601 sub download {
 602  my ($patch_dtd,$url,$filename,$format) = @_;
 603  my ($gz, $buffer);
 604
 605 # print "DOWNLOAD subs receives url: \"$url\"\n";
 606 # print "DOWNLOAD subs receives filename: \"$filename\"\n";
 607
 608  my $resourcetype;      # retrieve mode: "normal" (.xml) or "gzipped" (.xml.gz)
 609  if ($filename =~ /\.xml$/) {   # set retrieve mode
 610          $resourcetype = "normal";
 611  } elsif ($filename =~ /\.xml\.gz$/) {
 612          $resourcetype = "gzipped";
 613  } else {
 614          die "Unsupported download extension, might be '.gz' or '.xml'\n";
 615  }
 616  my $basefname = $filename;
 617  $basefname =~ s/\.gz$//;       # get base resource name removing trailing .gz
 618  $cont = ""; # modified by side-effect by the callback function
 619
 620  my $localfname="";
 621  if (stat($basefname)) {
 622         $localfname=$basefname;
 623  } elsif (stat($basefname.".gz")) {
 624         $localfname=$basefname.".gz";
 625  }
 626  if ($localfname ne "") { # we already have local copy of requested file
 627       # check both possible cache entry: gzipped or normal
 628   print "Using local copy.\n";
 629   if ($localfname =~ /\.xml\.gz$/) { # deflating cached file and return it
 630    $cont = gunzip($localfname);
 631   } elsif ($localfname =~ /\.xml$/) { # just return cached file
 632    open(FD, $localfname) or die "Cannot open $localfname";
 633    while(<FD>) { $cont .= $_; }
 634    close(FD);
 635   } else { # error
 636    die "Internal error: unexpected file name $localfname,"
 637    ."must end with '.gz' or '.xml.gz'\n";
 638   }
 639  } else { # download file from net
 640    print "Downloading file ...\n"; # download file
 641    my $ua = LWP::UserAgent->new;
 642    my $request = HTTP::Request->new(GET => "$url");
 643    my $response = $ua->request($request, \&callback);
 644
 645    # cache retrieved file to disk
 646    # <ZACK/> TODO: inefficent, I haven't yet undestood how to deflate
 647    #    in memory gzipped file, without call "gzopen"
 648    print "Storing file ...\n";
 649 #   print "Making dirs ...\n";
 650    mkdirs($filename);
 651 #   print "Opening tmp file for writing ...\n";
 652    open(FD, ">".$filename.".tmp") or die "Cannot open $filename.tmp\n";
 653 #   print "Writing on tmp file ...\n";
 654    print FD $cont;
 655 #   print "Closing tmp file ...\n";
 656    close(FD);
 657
 658    # handle cache conversion normal->gzipped or gzipped->normal as user choice
 659    print "cachemode:$cachemode, resourcetype:$resourcetype\n"
 660     if (defined($debug));
 661    if (($cachemode eq 'normal') and ($resourcetype eq 'normal')) {
 662      # cache the file as is
 663     rename "$filename.tmp", $filename;
 664    } elsif (($cachemode eq 'gzipped') and ($resourcetype eq 'gzipped')) {
 665      # cache the file as is
 666      # and update the $cont variabile with deflated content
 667     rename "$filename.tmp", $filename;
 668     $cont = gunzip($filename);
 669    } elsif (($cachemode eq 'normal') and ($resourcetype eq 'gzipped')) {
 670      # deflate cache entry
 671      # and update $cont
 672     open(FD, "> $basefname") or die "cannot open $basefname\n";
 673     $cont = gunzip($filename.".tmp");
 674     print FD $cont;
 675     close(FD);
 676     unlink "$filename.tmp"; # delete old gzipped file
 677    } elsif (($cachemode eq 'gzipped') and ($resourcetype eq 'normal')) {
 678      # compress cache entry
 679     print "gzipping ...\n" if (defined($debug));
 680     gzip($cont, $basefname.".gz");
 681     unlink "$filename.tmp"; # delete old uncompressed file
 682    } else {
 683     die "Internal error, unsopported cachemode, resourcetype couple\n";
 684    }
 685    # $cont now contained uncompressed data
 686  }
 687  if ($patch_dtd eq "yes") {
 688     $cont =~ s/DOCTYPE (.*) SYSTEM\s+"http:\/\/www.cs.unibo.it\/helm\/dtd\//DOCTYPE $1 SYSTEM "$myownurl\/getdtd?uri=/g;
 689  }
 690  if ($format eq "gz") {
 691   gzip($cont,"$basefname.tmp");
 692   open (TMP, "< $basefname.tmp")
 693    or die "Can't open tempfile: $filename.tmp, exiting!\n";
 694   $cont = "";
 695   while(<TMP>) {
 696    $cont .= $_;
 697   }
 698   close TMP;
 699   unlink ($basefname . ".tmp") or
 700    die "cannot unlink temporary file: $basefname.tmp\n";
 701  }
 702
 703  return $cont;
 704 }
 705
 706 sub answer {
 707 # answer the client setting content, Content-Type and Content-Enconding
 708 # of the answer
 709  my ($c,$cont,$contype,$contenc) = @_;
 710  my $res = new HTTP::Response;
 711  $res->content($cont);
 712  $res->push_header("Content-Type" => $contype)
 713    unless ($contype eq "");
 714  $res->push_header("Content-Encoding" => $contenc)
 715    unless ($contenc eq "");
 716  $res->push_header("Cache-Control" => "no-cache");
 717  $res->push_header("Pragma" => "no-cache");
 718  $res->push_header("Expires" => "0");
 719  $c->send_response($res);
 720 }
 721
 722 sub html_nice_answer {
 723 # answer the client whith a nice html document
 724  my ($c,$content) = @_;
 725  $content = "<html><body><h1>$content</h1></body></html>";
 726  answer($c,$content,"text/html","");
 727 }
 728
 729 sub helm_wget {
 730 #retrieve a file from an url and write it to a temp dir
 731 #used for retrieve resource index from servers
 732  $cont = "";
 733  my ($prefix, $URL) = @_;
 734  my $ua = LWP::UserAgent->new;
 735  my $request = HTTP::Request->new(GET => "$URL");
 736  my $response = $ua->request($request, \&callback);
 737  my ($filename) = reverse (split "/", $URL); # get filename part of the URL
 738  open (TEMP, "> $prefix/$filename")
 739   || die "Cannot open temporary file: $prefix/$filename\n";
 740  print TEMP $cont;
 741  close TEMP;
 742 }
 743
 744 sub update {
 745 # retie dbs
 746  untie %map;
 747  tie(%map, 'DB_File', $uris_dbm.".db", O_RDWR, 0664);
 748  untie %rdf_map;
 749  tie(%rdf_map, 'DB_File', $rdf_dbm.".db", O_RDWR, 0664);
 750 }
 751
 752 sub update_dbs {
 753 # rebuild dbs fetching resource indexes from servers.
 754 # Rebuild urls_of_uris db (1) and rdf db (2)
 755  my (
 756   $server, $idxfile, $rdf_idxfile, $uri, $url, $comp, $line,
 757   @servers,
 758   %urls_of_uris, %rdf # local proxy of $map and $rdf_map
 759  );
 760
 761  untie %map;
 762  untie %rdf_map;
 763  foreach my $file ($uris_dbm, $rdf_dbm) { # remove old db file
 764   if (stat $file.".db") { # remove if exists
 765    unlink ($file.".db") or die "can't unlink old db file: $file.db\n";
 766   }
 767  }
 768  tie(%urls_of_uris, 'DB_File', $uris_dbm.".db", O_RDWR|O_CREAT, 0664);
 769  tie(%rdf, 'DB_File', $rdf_dbm.".db", O_RDWR|O_CREAT, 0664);
 770
 771  open (SRVS, "< $servers_file") or
 772   die "cannot open servers file: $servers_file\n";
 773  @servers = <SRVS>; # read all servers
 774  close (SRVS);
 775
 776  while ($server = pop @servers) { # cicle on servers in _reverse_ order
 777   print "processing server: $server ...\n";
 778   chomp $server;
 779   helm_wget($tmp_dir, $server."/".$indexname); # get index
 780   helm_wget($tmp_dir, $server."/".$rdf_indexname); # get rdf index
 781   $idxfile = $tmp_dir."/".$indexname;
 782   $rdf_idxfile = $tmp_dir."/".$rdf_indexname;
 783
 784   open (INDEX, "< $idxfile") or # (1) REBUILD URLS_OF_URIS DB
 785    die "cannot open temporary index file: $idxfile\n";
 786   while ($line = <INDEX>) {  # parse index and add entry to urls_of_uris db
 787    chomp $line;
 788    ($uri,$comp) = split /[ \t]+/, $line;
 789              # build url:
 790    if ($comp =~ /gz/) {
 791     $url = $uri . ".xml" . ".gz";
 792    } else {
 793     $url = $uri . ".xml";
 794    }
 795    $url =~ s/cic:/$server/;
 796    $url =~ s/theory:/$server/;
 797    $urls_of_uris{$uri} = $url;
 798   }
 799
 800   open (RDF_INDEX, "< $rdf_idxfile") or # (2) REBUILD RDF DB
 801    die "cannot open temporary rdf index file: $rdf_idxfile\n";
 802   while ($line = <RDF_INDEX>) {  # parse index and add entry to rdf db
 803    chomp $line;
 804    ($uri,$comp) = split /[ \t]+/, $line; # comp is "gz" or nothing
 805              # build url:
 806    if ($comp =~ /gz/) {
 807     $url = $uri . ".xml" . ".gz";
 808    } else {
 809     $url = $uri . ".xml";
 810    }
 811    $url =~ s/^helm:rdf(.*)\/\/cic:/$server/;
 812    $url =~ s/^helm:rdf(.*)\/\/theory:/$server/;
 813    $rdf{$uri} = $url;
 814   }
 815
 816   close INDEX;  # close indexes
 817   close RDF_INDEX;
 818   die "cannot unlink temporary file: $idxfile\n"  # remove temp files
 819    if (unlink $idxfile) != 1;
 820   die "cannot unlink temporary file: $rdf_idxfile\n"
 821    if (unlink $rdf_idxfile) != 1;
 822
 823  }
 824
 825  untie(%urls_of_uris); # untie local proxies
 826  untie(%rdf);
 827  tie(%map, 'DB_File', $uris_dbm.".db", O_RDWR, 0664); # retie global ones
 828  tie(%rdf_map, 'DB_File', $rdf_dbm.".db", O_RDWR, 0664);
 829 } # update_dbs
 830
 831 # vim modline: do not remove!
 832 # vim: set ft=perl:
 833