3 # Copyright (C) 2000, HELM Team.
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.
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.
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.
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.
23 # For details, see the HELM World-Wide-Web page,
24 # http://cs.unibo.it/helm/.
26 my $VERSION = "@VERSION@";
28 # First of all, let's load HELM configuration
30 my $HELM_LIB_DIR = $ENV{"HELM_LIB_DIR"};
31 # this should be the only fixed constant
32 my $DEFAULT_HELM_LIB_DIR = "@HELM_LIB_DIR@";
33 if (defined ($HELM_LIB_DIR)) {
34 $HELM_LIB_PATH = $HELM_LIB_DIR."/configuration.pl";
36 $HELM_LIB_PATH = $DEFAULT_HELM_LIB_DIR."/configuration.pl";
39 # <ZACK>: TODO temporary, move this setting to configuration file
40 # set the cache mode, may be "gzipped" or "normal"
41 my $cachemode = $ENV{'HTTP_GETTER_CACHE_MODE'} || 'gzipped';
42 if (($cachemode ne 'gzipped') and ($cachemode ne 'normal')) {
43 die "Invalid HTTP_GETTER_CACHE_MODE environment variable, must be".
44 "'normal' or 'gzipped'\n";
48 # next require defines: $helm_dir, $html_link, $dtd_dir, $uris_dbm
49 require $HELM_LIB_PATH;
51 # Let's override the configuration file
52 $style_dir = $ENV{"HELM_STYLE_DIR"} if (defined ($ENV{"HELM_STYLE_DIR"}));
53 $dtd_dir = $ENV{"HELM_DTD_DIR"} if (defined ($ENV{"HELM_DTD_DIR"}));
64 #CSC: mancano i controlli sulle condizioni di errore di molte funzioni
65 #CSC: ==> non e' robusto
66 #CSC: altra roba da sistemare segnata con CSC
68 my $d = new HTTP::Daemon LocalPort => 8081;
69 my $myownurl = $d->url;
71 # Let's patch the returned URL
72 $myownurl =~ s/\/$//; # chop the final slash
73 my $myownport = $myownurl;
74 $myownport =~ s/http:\/\/(.*):(.*)/$2/;
75 $myownurl =~ s/http:\/\/(.*):(.*)/$1/;
76 ($myownurl) = gethostbyname($myownurl);
77 $myownurl = "http://".$myownurl.":".$myownport;
79 tie(%map, 'DB_File', $uris_dbm.".db", O_RDONLY, 0664);
80 print "Please contact me at: <URL:", $myownurl."/", ">\n";
81 print "helm_dir: $helm_dir\n";
82 print "style_dir: $style_dir\n";
83 print "dtd_dir: $dtd_dir\n";
84 print "urls_of_uris.db: $uris_dbm.db\n";
85 print "cache mode: $cachemode\n";
87 $SIG{CHLD} = "IGNORE"; # do not accumulate defunct processes
88 $SIG{USR1} = \&update; # sent by the child to make the parent update
89 while (my $c = $d->accept) {
91 while (my $r = $c->get_request) {
92 #CSC: mancano i controlli di sicurezza
94 my $inputuri = uri_unescape($r->url);
95 $inputuri =~ s/^[^?]*\?uri=(.*)/$1/;
96 print "\nRequest: ".$r->url."\n\n";
97 my $http_method = $r->method;
98 my $http_path = $r->url->path;
99 my $http_query = uri_unescape($r->url->query);
100 my $cgi = new CGI("$http_query");
102 print "\nUnescaped query: ".$http_query."\n";
104 if ($http_method eq 'GET' and $http_path eq "/getciconly") {
105 # finds the uri, url and filename
106 my $cicuri = $inputuri;
108 my $cicfilename = $cicuri;
109 $cicfilename =~ s/cic:(.*)/$1/;
110 $cicfilename =~ s/theory:(.*)/$1/;
112 my $cicurl = $map{$cicuri};
114 if ($cicurl =~ /\.xml$/) { # non gzipped file
116 } elsif ($cicurl =~ /\.xml\.gz$/) { # gzipped file
117 $extension = ".xml.gz";
118 } else { # error: unknown extension
119 die "unexpected extension in url: $cicurl, might be '.xml'".
122 $cicfilename = $helm_dir.$cicfilename.$extension;
124 if (!defined($cicurl)) {
125 print "\nNOT FOUND!!!!!\n";
126 $c->send_error(RC_NOT_FOUND)
128 print_request("cic",$cicuri,$cicurl,$cicfilename);
131 my $ciccontent = download(0,"cic",$cicurl,$cicfilename);
133 # Answering the client
134 answer($c,$ciccontent);
136 } elsif ($http_method eq 'GET' and $http_path eq "/get") {
137 # finds the uris, urls and filenames
138 my $cicuri = $inputuri,
139 $typesuri = $inputuri,
142 if ($inputuri =~ /\.types$/) {
143 $cicuri =~ s/(.*)\.types$/$1/;
145 } elsif ($inputuri =~ /\.types\.ann$/) {
146 $cicuri =~ s/(.*)\.types\.ann$/$1/;
147 $typesuri =~ s/(.*)\.ann$/$1/;
148 $annsuffix = ".types.ann";
149 } elsif ($inputuri =~ /\.ann$/) {
150 $cicuri =~ s/(.*)\.ann$/$1/;
158 my $cicfilename = $cicuri;
159 $cicfilename =~ s/cic:(.*)/$1/;
160 $cicfilename =~ s/theory:(.*)/$1/;
161 $cicfilename = $helm_dir.$cicfilename;
163 my $cicurl = $map{$cicuri};
164 my $typesurl = $map{$typesuri} if (defined($typesuri));
165 my $annurl = $map{$annuri} if (defined($annuri));
166 my ($cicext, $typesext, $annext);
167 if ($cicurl =~ /\.xml$/) { # normal file
169 } elsif ($cicurl =~ /\.xml\.gz$/) { # gzipped file
172 die "unexpected extension in url: $cicurl;".
173 "might be '.xml' or '.xml.gz'";
175 if (defined($typesuri)) { # extension selection for types file
176 if ($typesurl =~ /\.xml$/) { # normal file
177 $typesext = ".types.xml";
178 } elsif ($typesurl =~ /\.xml\.gz$/) { # gzipped file
179 $typesext = ".types.xml.gz";
181 die "unexpected extension in url: $typesurl;".
182 "might be '.xml' or '.xml.gz'";
185 if (defined($annuri)) { # extension selection for annotation file
186 if ($annurl =~ /\.xml$/) { # normal file
188 } elsif ($annurl =~ /\.xml\.gz$/) { # gzipped file
191 die "unexpected extension in url: $annurl".
192 "might be '.xml' or '.xml.gz'";
195 my $typesfilename = $cicfilename.$typesext if $typesuri;
196 my $annfilename = $cicfilename.$annsuffix.$annext if $annuri;
197 $cicfilename .= $cicext;
199 if (!defined($cicurl) ||
200 (!defined($typesurl) && $typesuri) ||
201 (!defined($annuri) && $annuri))
203 print "\nNOT FOUND!!!!!\n";
204 $c->send_error(RC_NOT_FOUND)
206 print_request("cic",$cicuri,$cicurl,$cicfilename);
207 print_request("types",$typesuri,$typesurl,$typesfilename)
209 print_request("ann",$annuri,$annurl,$annfilename)
212 # Retrieves the files
214 my $ciccontent = download(1,"cic",$cicurl,$cicfilename);
216 download(1,"types",$typesurl,$typesfilename) if ($typesuri);
218 download(1,"ann",$annurl,$annfilename) if ($annuri);
220 # Merging the files together
223 <?xml version="1.0" encoding="UTF-8"?>
224 <cicxml uri="$cicuri">
231 # Answering the client
234 } elsif ($http_method eq 'GET' and $http_path eq "/getdtd") {
235 my $filename = $inputuri;
236 $filename = $dtd_dir."/".$filename;
237 print "DTD: $inputuri ==> ($filename)\n";
238 if (stat($filename)) {
239 print "Using local copy\n";
240 open(FD, $filename) or die "Cannot open $filename\n";
243 # Vary bad heuristic for substituion of absolute URLs
245 s/ENTITY (.*) SYSTEM\s+"/ENTITY $1 SYSTEM "$myownurl\/getdtd?uri=/g;
251 die "Could not find DTD!";
253 } elsif ($http_method eq 'GET' and $http_path eq "/getstyleconf") {
254 my $filename = $inputuri;
255 $filename = $style_dir."/config/".$filename;
256 if (stat($filename)) {
257 open(FD, $filename) or die "Cannot open $filename\n";
260 s/DOCTYPE (.*) SYSTEM\s+"/DOCTYPE $1 SYSTEM "$myownurl\/getstyleconf?uri=/g;
266 die "Could not find Style Configuration File!";
268 } elsif ($http_method eq 'GET' and $http_path eq "/getxslt") {
269 my $filename = $inputuri;
270 $filename = $style_dir."/".$filename;
271 print "XSLT: $inputuri ==> ($filename)\n";
272 if (stat($filename)) {
273 print "Using local copy\n";
274 open(FD, $filename) or die "Cannot open $filename\n";
277 # Vary bad heuristic for substituion of absolute URLs
279 s/xsl:import\s+href="/xsl:import href="$myownurl\/getxslt?uri=/g ;
280 s/xsl:include\s+href="/xsl:include href="$myownurl\/getxslt?uri=/g ;
286 die "Could not find XSLT!";
288 } elsif ($http_method eq 'GET' and $http_path eq "/conf") {
289 my $quoted_html_link = $html_link;
290 $quoted_html_link =~ s/&/&/g;
291 $quoted_html_link =~ s/</</g;
292 $quoted_html_link =~ s/>/>/g;
293 $quoted_html_link =~ s/'/'/g;
294 $quoted_html_link =~ s/"/"/g;
295 print "\nConfiguration requested, returned #$quoted_html_link#\n";
296 $cont = "<?xml version=\"1.0\"?><html_link>$quoted_html_link</html_link>";
298 } elsif ($http_method eq 'GET' and $http_path eq "/update") {
299 # rebuild urls_of_uris.db
300 print "Update requested...\n";
302 kill(USR1,getppid()); # signal changes to parent
304 answer($c,"<html><body><h1>Update done</h1></body></html>");
305 } elsif ($http_method eq 'GET' and $http_path eq "/ls") {
306 # send back keys that begin with a given uri
307 my ($uritype,$uripattern,$uriprefix);
308 my $baseuri = $cgi->param('baseuri');
309 chop $baseuri if ($baseuri =~ /.*\/$/); # remove trailing "/"
310 my $outype = $cgi->param('format'); # output type, might be 'txt' or 'xml'
311 $uripattern = $baseuri;
312 $uripattern =~ s/^.*:(.*)/$1/;
313 if ($baseuri =~ /^cic:/) {
315 } elsif ($baseuri =~ /^theory:/) {
318 $uritype = "invalid";
320 if ($uritype ne "invalid") { # uri is valid
321 if (($outype ne 'txt') and ($outype ne 'xml')) { # invalid out type
322 print "Invalid output type specified: $outype\n";
323 answer($c,"<html><body><h1>Invalid output type, may be ".
324 "\"txt\" or \"xml\"</h1></body></html>");
325 } else { # valid output
326 print "BASEURI $baseuri, FORMAT $outype\n";
327 $cont = finduris($uritype,$uripattern,$outype);
330 } else { # invalid uri
331 print "Invalid uri: $baseuri, may begin with 'cic:', ".
332 "'theory:' or '*:'\n";
333 answer($c,"<html><body><h1>Invalid uri , may begin with ".
334 "\"cic:\", \"theory:\" or \"*:\"</h1></body></html>");
336 } elsif ($http_method eq 'GET' and $http_path eq "/help") {
337 print "Help requested!";
338 answer($c,"<html><body><h1>HTTP Getter Version ".
339 $VERSION."</h1></body></html>");
342 print "INVALID REQUEST!!!!!\n";
343 print "(PATH: ",$http_path,", ";
344 print "QUERY: ",$http_query,")\n";
345 $c->send_error(RC_FORBIDDEN)
347 print "\nRequest solved: ".$r->url."\n\n";
351 print "\nCONNECTION CLOSED\n\n";
356 #================================
358 sub finduris { # find uris for cic and theory trees generation
359 my ($uritype,$uripattern,$format) = @_;
361 my ($uri,$localpart,$basepart,$dirname,$suffix,$flags,$key);
362 my (@itemz,@already_pushed_dir);
363 my (%objects,%dirs); # map uris to suffixes' flags
365 print "FINDURIS, uritype: $uritype, uripattern: $uripattern, ".
366 "format: $format\n\n";
368 if (($uritype eq "cic") or ($uritype eq "theory")) {
369 # get info only of one type: cic or theory
370 foreach (keys(%map)) { # select matching uris
372 if ($uri =~ /^$uritype:$uripattern\//) {
374 $localpart =~ s/^$uritype:$uripattern\/(.*)/$1/;
376 if ($localpart =~ /^[^\/]*$/) { # no slash, an OBJECT
377 $basepart = $localpart;
378 $basepart =~ s/^(.*)\.types(\.ann)?/$1/; # remove exts .types or
380 $flags = $objects{$basepart}; # get old flags
381 if ($localpart =~ /\.ann$/) {
382 $flags = add_flag("ann","YES",$flags);
384 $flags = add_flag("ann","NO",$flags);
386 if ($localpart =~ /\.types$/) {
387 $flags = add_flag("types","YES",$flags);
388 } elsif ($localpart =~ /\.types\.ann$/) {
389 $flags = add_flag("types","ANN",$flags);
391 $flags = add_flag("types","NO",$flags);
393 $objects{$basepart} = $flags; # save new flags
394 } else { # exists at least one slash, a DIR
395 ($dirname) = split (/\//, $localpart);
396 $dirs{$dirname} = ""; # no flags requirement for dir
401 die "getter internal error: unsupported uritype: \"$uritype\"";
403 # now generate OUTPUT:
404 # output will be saved in $content
405 if ($format eq "txt") { # TXT output
406 foreach $key (sort(keys %dirs)) {
407 $content .= "dir, " . $key . "\n";
409 foreach $key (sort(keys %objects)) {
410 $content .= "object, $key, " . $objects{$key} . "\n";
412 } elsif ($format eq "xml") { # XML output
413 $content .= '<?xml version="1.0" encoding="ISO-8859-1"?>' . "\n";
414 $content .= '<!DOCTYPE ls SYSTEM ';
415 $content .= '"http://localhost:8081/getdtd?uri=ls.dtd">' . "\n\n";
416 $content .= "<ls>\n";
417 foreach $key (sort(keys %dirs)) {
418 $content .= "\t<section>$key</section>\n";
420 foreach $key (sort(keys %objects)) {
421 $content .= "\t<object name=\"$key\">\n";
422 $flags = $objects{$key};
423 $flags =~ s/^<(.*)>$/$1/;
424 my ($annflag,$typesflag) = split /,/,$flags;
425 $content .= "\t\t<ann value=\"$annflag\" />\n";
426 $content .= "\t\t<types value=\"$typesflag\" />\n";
427 $content .= "\t</object>\n";
429 $content .= "</ls>\n";
430 } else { # may not enter this branch
431 die "Getter internal error: invalid format received by finduris sub";
437 # manage string like: "<ann_flag,type_flag>"
438 # "ann_flag" may be one of "ann_YES", "ann_NO"
439 # "type_flag" may be one of "types_NO", "types_YES", "types_ANN"
440 # when adding a flag the max between the current flag and the new flag
441 # is taken, the orders are ann_NO < ann_YES and types_NO < types_YES <
443 my ($flagtype,$newflag,$str) = @_;
444 $str = "<,>" if ($str eq "");
445 ($str =~ s/^<(.*,.*)>$/$1/) or die "Internal error: ".
446 "wrong string format for flag adding in $str";
447 my ($annflag,$typeflag) = split /,/,$str;
448 if ($flagtype eq "ann") { # ANN flag handling
449 if ($newflag eq "YES") {
451 } elsif ($newflag eq "NO") {
452 $annflag = "NO" unless ($annflag eq "YES");
454 die "Internal error: annflag must be \"YES\" or \"NO\"";
456 } elsif ($flagtype eq "types") { # TYPES flag handling
457 if ($newflag eq "ANN") {
459 } elsif ($newflag eq "YES") {
460 $typeflag = "YES" unless ($typeflag eq "ANN");
461 } elsif ($newflag eq "NO") {
463 unless (($typeflag eq "ANN") or ($typeflag eq "YES"));
465 die "Internal error: typeflag must be \"YES\", \"NO\" or \"ANN\"";
468 die "Internal error: unsupported flagtype \"$flagtype\"";
470 $str = "<$annflag,$typeflag>";
473 #CSC: Too much powerful: creates even /home, /home/users/, ...
474 #CSC: Does not raise errors if could not create dirs/files
478 my @dirs = split /\//,$pathname;
480 foreach $dir (@dirs) {
481 $tmp = ((defined($tmp)) ? $tmp."\/".$dir : "");
489 my ($str,$uri,$url,$filename) = @_;
490 print $str."uri: $uri\n";
491 print $str."url: $url\n";
492 print $str."filename: $filename\n\n";
501 sub gunzip { # gunzip a file and return the deflated content
504 my ($gz, $buffer, $cont);
506 print "deflating $filename ...\n";
507 $gz = gzopen($filename, "r")
508 or die "Cannot open gzip'ed file $filename: $gzerrno";
510 while ( $gz->gzread($buffer) > 0 ) {
513 die "Error while reading : $gzerrno\n" if $gzerrno != Z_STREAM_END ;
519 sub gzip { # gzip the content argument and save it to filename argument
520 my ($cont, $filename) = @_;
524 $gz = gzopen($filename, "w")
525 or die "Cannot gzopen for writing file $filename: $gzerrno";
526 $gz->gzwrite($cont) or die "error writing: $gzerrno\n" ;
532 my ($remove_headers,$str,$url,$filename) = @_;
535 my $resourcetype; # retrieve mode: "normal" (.xml) or "gzipped" (.xml.gz)
536 if ($filename =~ /\.xml$/) { # set retrieve mode
537 $resourcetype = "normal";
538 } elsif ($filename =~ /\.xml\.gz$/) {
539 $resourcetype = "gzipped";
541 die "Unsupported download extension, might be '.gz' or '.xml'\n";
543 my $basefname = $filename;
544 $basefname =~ s/\.gz$//; # get base resource name removing trailing .gz
545 $cont = ""; # modified by side-effect by the callback function
548 if (stat($basefname)) {
549 $localfname=$basefname;
550 } elsif (stat($basefname.".gz")) {
551 $localfname=$basefname.".gz";
553 if ($localfname ne "") { # we already have local copy of requested file
554 # check both possible cache entry: gzipped or normal
555 print "Using local copy for the $str file\n";
556 if ($localfname =~ /\.xml\.gz$/) { # deflating cached file and return it
557 $cont = gunzip($localfname);
558 } elsif ($localfname =~ /\.xml$/) { # just return cached file
559 open(FD, $localfname) or die "Cannot open $localfname";
560 while(<FD>) { $cont .= $_; }
563 die "Internal error: unexpected file name $localfname,"
564 ."must end with '.gz' or '.xml.gz'\n";
566 } else { # download file from net
567 print "Downloading the $str file\n"; # download file
568 my $ua = LWP::UserAgent->new;
569 my $request = HTTP::Request->new(GET => "$url");
570 my $response = $ua->request($request, \&callback);
572 # cache retrieved file to disk
573 # <ZACK/> TODO: inefficent, I haven't yet undestood how to deflate
574 # in memory gzipped file, without call "gzopen"
575 print "Storing the $str file\n";
577 open(FD, ">".$filename.".tmp") or die "Cannot open $filename.tmp\n";
581 # handle cache conversion normal->gzipped or gzipped->normal as user choice
582 if (($cachemode eq 'normal') and ($resourcetype eq 'normal')) {
583 # cache the file as is
584 rename "$filename.tmp", $filename;
585 } elsif (($cachemode eq 'gzipped') and ($resourcetype eq 'gzipped')) {
586 # cache the file as is
587 # and update the $cont variabile with deflated content
588 rename "$filename.tmp", $filename;
589 $cont = gunzip($filename);
590 } elsif (($cachemode eq 'normal') and ($resourcetype eq 'gzipped')) {
591 # deflate cache entry
593 open(FD, "> $basefname") or die "cannot open $basefname\n";
594 $cont = gunzip($filename.".tmp");
597 unlink "$filename.tmp"; # delete old gzipped file
598 } elsif (($cachemode eq 'gzipped') and ($resourcetype eq 'normal')) {
599 # compress cache entry
600 gzip($cont, $basefname.".gz");
601 unlink "$filename.tmp"; # delete old uncompressed file
603 die "Internal error, unsopported cachemode, resourcetype couple\n";
605 # $cont now contained uncompressed data
608 if ($remove_headers) {
609 $cont =~ s/<\?xml [^?]*\?>//sg;
610 $cont =~ s/<!DOCTYPE [^>]*>//sg;
612 $cont =~ s/DOCTYPE (.*) SYSTEM\s+"http:\/\/www.cs.unibo.it\/helm\/dtd\//DOCTYPE $1 SYSTEM "$myownurl\/getdtd?uri=/g;
620 my $res = new HTTP::Response;
621 $res->content($cont);
622 $c->send_response($res);
626 #retrieve a file from an url and write it to a temp dir
627 #used for retrieve resource index from servers
629 my ($prefix, $URL) = @_;
630 my $ua = LWP::UserAgent->new;
631 my $request = HTTP::Request->new(GET => "$URL");
632 my $response = $ua->request($request, \&callback);
633 my ($filename) = reverse (split "/", $URL); # get filename part of the URL
634 open (TEMP, "> $prefix/$filename")
635 || die "Cannot open temporary file: $prefix/$filename\n";
642 tie(%map, 'DB_File', $uris_dbm.".db", O_RDONLY, 0664);
645 sub mk_urls_of_uris {
646 #rebuild $uris_dbm.db fetching resource indexes from servers
648 $server, $idxfile, $uri, $url, $comp, $line,
654 if (stat $uris_dbm.".db") { # remove old db file
655 unlink($uris_dbm.".db") or
656 die "cannot unlink old db file: $uris_dbm.db\n";
658 tie(%urls_of_uris, 'DB_File', $uris_dbm.".db", O_RDWR|O_CREAT, 0664);
660 open (SRVS, "< $servers_file") or
661 die "cannot open servers file: $servers_file\n";
664 while ($server = pop @servers) { #cicle on servers in reverse order
665 print "processing server: $server ...\n";
667 helm_wget($tmp_dir, $server."/".$indexname); #get index
668 $idxfile = $tmp_dir."/".$indexname;
669 open (INDEX, "< $idxfile") or
670 die "cannot open temporary index file: $idxfile\n";
671 while ($line = <INDEX>) { #parse index and add entry to urls_of_uris
673 ($uri,$comp) = split /[ \t]+/, $line;
676 $url = $uri . ".xml" . ".gz";
678 $url = $uri . ".xml";
680 $url =~ s/cic:/$server/;
681 $url =~ s/theory:/$server/;
682 $urls_of_uris{$uri} = $url;
685 die "cannot unlink temporary file: $idxfile\n"
686 if (unlink $idxfile) != 1;
689 untie(%urls_of_uris);
690 tie(%map, 'DB_File', $uris_dbm.".db", O_RDONLY, 0664);