source: gsdl/trunk/cgi-bin/gsdlCGI.pm@ 16971

Last change on this file since 16971 was 16971, checked in by ak19, 13 years ago

Made specifying httpprefix in gsdlsite.cfg optional, which it should be.

  • Property svn:keywords set to Author Date Id Revision
File size: 15.3 KB
Line 
1package gsdlCGI;
2
3# This file merges Michael Dewsnip's gsdlCGI.pm for GS2 and Quan Qiu's gsdlCGI4gs3.pm (GS3)
4
5use strict;
6no strict 'subs';
7no strict 'refs'; # allow filehandles to be variables and viceversa
8
9use CGI;
10use Cwd;
11
12@gsdlCGI::ISA = ( 'CGI' );
13
14sub new {
15 my $class = shift @_;
16
17 my $self;
18
19 # We'll determine the correct config file in this constructor itself
20 # and use it to determine the Greenstone server's version.
21 # Perhaps later, another test can be used for finding out what version
22 # of the Greenstone server we are working with.
23 my $version;
24 if (-e "gsdl3site.cfg") {
25 $version = 3;
26 } else {
27 $version = 2;
28 }
29
30 if ((defined $ENV{'REQUEST_METHOD'}) && ($ENV{'REQUEST_METHOD'} eq "POST")) {
31
32 # Check if we're dealing with the upload-coll-file cmd. Because it will be a
33 # multipart POST message and must be dealt with by the default CGI() constructor
34 if((defined $ENV{'QUERY_STRING'}) && ($ENV{'QUERY_STRING'} =~ m/upload-collection-file/)) {
35 $self = new CGI();
36 }
37
38 else { # all other POST commands processed using CGI($line)
39 my $line = <STDIN>;
40 if ((defined $line) && ($line ne "")) {
41 $self = new CGI($line);
42 }
43 }
44
45 }
46
47 # If one of the conditions above did not hold, then self=new CGI()
48 if (!defined $self) {
49 $self = new CGI();
50 }
51
52 if ($version == 2) {
53 $self->{'site_filename'} = "gsdlsite.cfg";
54 $self->{'greenstone_version'} = 2;
55 }
56 elsif ($version == 3) {
57 $self->{'site_filename'} = "gsdl3site.cfg";
58 $self->{'greenstone_version'} = 3;
59 }
60
61 return bless $self, $class;
62}
63
64
65sub parse_cgi_args
66{
67 my $self = shift @_;
68 my $xml = (defined $self->param("xml")) ? 1 : 0;
69
70 $self->{'xml'} = $xml;
71
72 my @var_names = $self->param;
73 my @arg_list = ();
74 foreach my $n ( @var_names ) {
75 my $arg = "$n=";
76 my $val = $self->param($n);
77 $arg .= $val if (defined $val);
78 push(@arg_list,$arg);
79 }
80
81 $self->{'args'} = join("&",@arg_list);
82}
83
84
85sub clean_param
86{
87 my $self = shift @_;
88 my ($param) = @_;
89
90 my $val = $self->SUPER::param($param);
91 $val =~ s/[\r\n]+$// if (defined $val);
92
93 return $val;
94}
95
96sub safe_val
97{
98 my $self = shift @_;
99 my ($val) = @_;
100
101 # ensure only alpha-numeric plus a few other special chars remain
102
103 $val =~ s/[^[:alnum:]@\.\/\- :_]//g if (defined $val);
104
105 return $val;
106}
107
108sub generate_message
109{
110 my $self = shift @_;
111 my ($message) = @_;
112
113 #if($self->{'greenstone_version'} == 2) { # plain text, for IIS 6
114 print STDOUT "Content-type:text/plain\n\n$message";
115 #} else {
116 #print "Content-type:text/html\n\n";
117 #print "<pre>";
118 #print STDOUT $message;
119 #print "</pre>";
120 #}
121}
122
123sub generate_error
124{
125 my $self = shift @_;
126 my ($mess) = @_;
127
128 my $xml = $self->{'xml'};
129
130 my $full_mess;
131 my $args = $self->{'args'};
132
133 if ($xml) {
134 # Make $args XML safe
135 my $args_xml_safe = $args;
136 $args_xml_safe =~ s/&/&amp;/g;
137
138 $full_mess = "<Error>\n";
139 $full_mess .= " $mess\n";
140 $full_mess .= " CGI args were: $args_xml_safe\n";
141 $full_mess .= "</Error>\n";
142 }
143 else {
144 $full_mess = "ERROR: $mess\n ($args)\n";
145 }
146
147 $self->generate_message($full_mess);
148
149 die $full_mess;
150}
151
152sub generate_warning
153{
154 my $self = shift @_;
155 my ($mess) = @_;
156
157 my $xml = $self->{'xml'};
158
159 my $full_mess;
160 my $args = $self->{'args'};
161
162 if ($xml) {
163 # Make $args XML safe
164 my $args_xml_safe = $args;
165 $args_xml_safe =~ s/&/&amp;/g;
166
167 $full_mess = "<Warning>\n";
168 $full_mess .= " $mess\n";
169 $full_mess .= " CGI args were: $args_xml_safe\n";
170 $full_mess .= "</Warning>\n";
171 }
172 else {
173 $full_mess = "Warning: $mess ($args)\n";
174 }
175
176 $self->generate_message($full_mess);
177
178 print STDERR $full_mess;
179}
180
181
182sub generate_ok_message
183{
184 my $self = shift @_;
185 my ($mess) = @_;
186
187 my $xml = $self->{'xml'};
188
189 my $full_mess;
190
191 if ($xml) {
192 $full_mess = "<Accepted>\n";
193 $full_mess .= " $mess\n";
194 $full_mess .= "</Accepted>\n";
195 }
196 else {
197 $full_mess = "$mess\n";
198 }
199
200 $self->generate_message($full_mess);
201}
202
203
204
205sub get_config_info {
206 my $self = shift @_;
207 my ($infotype, $optional) = @_;
208
209 my $site_filename = $self->{'site_filename'};
210 open (FILEIN, "<$site_filename")
211 || $self->generate_error("Could not open $site_filename");
212
213 my $config_content = "";
214 while(defined (my $line = <FILEIN>)) {
215 $config_content .= $line;
216 }
217 close(FILEIN);
218
219 my ($loc) = ($config_content =~ m/^$infotype\s+((\".+\")|(\S+))\s*\n/m);
220 $loc =~ s/\"//g if defined $loc;
221
222 if ((!defined $loc) || ($loc =~ m/^\s*$/)) {
223 if((!defined $optional) || (!$optional)) {
224 $self->generate_error("$infotype is not set in $site_filename");
225 }
226 }
227
228 return $loc;
229}
230
231sub get_gsdl3_src_home{
232 my $self = shift @_;
233 if (defined $self->{'gsdl3srchome'}) {
234 return $self->{'gsdl3srchome'};
235 }
236
237 my $gsdl3srchome = $self->get_config_info("gsdl3srchome");
238
239 if(defined $gsdl3srchome) {
240 $gsdl3srchome =~ s/(\/|\\)$//; # remove trailing slash
241 }
242 $self->{'gsdl3srchome'} = $gsdl3srchome;
243
244 return $gsdl3srchome;
245}
246
247
248sub get_gsdl_home {
249 my $self = shift @_;
250
251 if (defined $self->{'gsdlhome'}) {
252 return $self->{'gsdlhome'};
253 }
254
255 my $gsdlhome = $self->get_config_info("gsdlhome");
256
257 $gsdlhome =~ s/(\/|\\)$//; # remove trailing slash
258
259 $self->{'gsdlhome'} = $gsdlhome;
260
261 return $gsdlhome;
262}
263
264sub get_gsdl3_home {
265 my $self = shift @_;
266 my ($optional) = @_;
267
268 if (defined $self->{'gsdl3home'}) {
269 return $self->{'gsdl3home'};
270 }
271
272 my $gsdl3home = $self->get_config_info("gsdl3home", $optional);
273
274 if(defined $gsdl3home) {
275 $gsdl3home =~ s/(\/|\\)$//; # remove trailing slash
276 $self->{'gsdl3home'} = $gsdl3home;
277 }
278 return $gsdl3home;
279}
280
281sub get_java_home {
282 my $self = shift @_;
283 my ($optional) = @_;
284
285 if (defined $self->{'javahome'}) {
286 return $self->{'javahome'};
287 }
288
289 my $javahome = $self->get_config_info("javahome", $optional);
290 if(defined $javahome) {
291 $javahome =~ s/(\/|\\)$//; # remove trailing slash
292 $self->{'javahome'} = $javahome;
293 }
294 return $javahome;
295}
296
297sub get_perl_path {
298 my $self = shift @_;
299 my ($optional) = @_;
300
301 if (defined $self->{'perlpath'}) {
302 return $self->{'perlpath'};
303 }
304
305 my $perlpath = $self->get_config_info("perlpath", $optional);
306
307 if(defined $perlpath) {
308 $perlpath =~ s/(\/|\\)$//; # remove trailing slash
309 $self->{'perlpath'} = $perlpath;
310 }
311 return $perlpath;
312}
313
314sub get_gsdl_os {
315 my $self = shift @_;
316
317 my $os = $^O;
318
319 if ($os =~ m/linux/i) {
320 return "linux";
321 }
322 elsif ($os =~ m/mswin/i) {
323 return "windows";
324 }
325 elsif ($os =~ m/macos/i) {
326 return "darwin";
327 }
328 else {
329 # return as is.
330 return $os;
331 }
332}
333
334sub get_library_url_suffix {
335 my $self = shift @_;
336
337 if (defined $self->{'library_url_suffix'}) {
338 return $self->{'library_url_suffix'};
339 }
340
341 my $optional = 1; # ignore absence of gwcgi if not found
342 my $library_url = $self->get_config_info("gwcgi", $optional);
343 if(defined $library_url) {
344 $library_url =~ s/(\/|\\)$//; # remove trailing slash
345 }
346 else {
347
348 if($self->{'greenstone_version'} == 2) {
349 $library_url = $self->get_config_info("httpprefix", $optional);
350 $library_url = "/gsdl" unless defined $library_url;
351 $library_url = "$library_url/cgi-bin/library";
352
353 my $gsdlos = (defined $ENV{'GSDLOS'}) ? $ENV{'GSDLOS'} : $self->get_gsdl_os();
354 if($gsdlos =~ m/windows/) { # remote GS2 server on Windows uses "library.exe"
355 $library_url .= ".exe";
356 }
357 }
358 else { # greenstone 3 or later and gwcgi not defined
359 $library_url = "/greenstone3"; #"/greenstone3/library";
360 }
361 }
362
363 $self->{'library_url_suffix'} = $library_url;
364 return $library_url;
365}
366
367sub setup_fedora_homes {
368 my $self = shift @_;
369 my ($optional) = @_;
370
371 # The following will still allow the FEDORA_HOME and FEDORA_VERSION environment
372 # variables to have been set outside the gsdlsite.cfg file. Existing env vars
373 # are only overwritten if they've *also* been defined in gsdlsite.cfg.
374
375 if (!defined $self->{'fedora_home'}) # Don't need to go through it all again if we'd already done this before
376 {
377 # First look in the gsdlsite.cfg file for the fedora properties to be defined
378 # and set $ENV{FEDORA_HOME} and $ENV{FEDORA_VERSION} if values were provided
379 $self->{'fedora_home'} = $self->get_config_info("fedorahome", $optional);
380
381 if (defined $self->{'fedora_home'}) {
382 $ENV{'FEDORA_HOME'} = $self->{'fedora_home'};
383 }
384 elsif (defined $ENV{'FEDORA_HOME'}) { # check environment variable
385 $self->{'fedora_home'} = $ENV{'FEDORA_HOME'};
386 }
387
388 # if FEDORA_HOME is now defined, we can look for the fedora version that is being used
389 if (defined $ENV{'FEDORA_HOME'})
390 {
391 # first look in the file
392 $self->{'fedora_version'} = $self->get_config_info("fedoraversion", $optional);
393
394 if (defined $self->{'fedora_version'}) {
395 $ENV{'FEDORA_VERSION'} = $self->{'fedora_version'};
396 }
397 elsif (defined $ENV{'FEDORA_VERSION'}) { # then check environment variable
398 $self->{'fedora_version'} = $ENV{'FEDORA_VERSION'};
399 }
400 else { # finally, default to version 3 and warn the user
401 $ENV{'FEDORA_VERSION'} = "3";
402 $self->{'fedora_version'} = $ENV{'FEDORA_VERSION'};
403 #$self->generate_ok_message("FEDORA_HOME is set, but not FEDORA_VERSION, defaulted to: 3.");
404 }
405 }
406 }
407}
408
409sub setup_gsdl {
410 my $self = shift @_;
411 my $optional = 1; # ignore absence of specified properties in gsdl(3)site.cfg if not found
412
413 my $gsdlhome = $self->get_gsdl_home();
414 my $gsdlos = $self->get_gsdl_os();
415 $ENV{'GSDLHOME'} = $gsdlhome;
416 $ENV{'GSDLOS'} = $gsdlos;
417
418 my $library_url = $self->get_library_url_suffix(); # best to have GSDLOS set beforehand
419 $self->{'library_url_suffix'} = $library_url;
420
421 require "$gsdlhome/perllib/util.pm";
422
423 if($self->{'greenstone_version'} == 3) {
424 my $gsdl3srchome = $self->get_gsdl3_src_home();
425 $ENV{'GSDL3SRCHOME'} = $gsdl3srchome;
426
427 my $gsdl3home = $self->get_gsdl3_home($optional);
428 # if a specific location for GS3's web folder is not provided,
429 # assume the GS3 web folder is in the default location
430 if(!defined $gsdl3home) {
431 $gsdl3home = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web");
432 $self->{'gsdl3home'} = $gsdl3home;
433 }
434 $ENV{'GSDL3HOME'} = $gsdl3home;
435 }
436
437
438 my $gsdl_bin_script = &util::filename_cat($gsdlhome,"bin","script");
439 &util::envvar_append("PATH",$gsdl_bin_script);
440
441 my $gsdl_bin_os = &util::filename_cat($gsdlhome,"bin",$gsdlos);
442 &util::envvar_append("PATH",$gsdl_bin_os);
443
444 # If the "perlpath" property is set in the gsdl(3)site.cfg config file, it is
445 # prepended to PATH only if the same perl bin dir path is not already on PATH env
446 my $perl_bin_dir = $self->get_perl_path($optional);
447 if(defined $perl_bin_dir)
448 {
449 &util::envvar_prepend("PATH", $perl_bin_dir);
450 }
451 elsif ($gsdlos eq "windows")
452 {
453 # Perl comes installed with the GS Windows Release Kit. However, note that if GS
454 # is from SVN, the user must have their own Perl and put it on the PATH or set
455 # perlpath in the gsdl site config file.
456 $perl_bin_dir = &util::filename_cat($gsdlhome, "bin", "windows", "perl", "bin");
457 if(-e $perl_bin_dir) {
458 &util::envvar_append("PATH", $perl_bin_dir);
459 }
460 }
461
462 # If javahome is explicitly set in the gsdl site config file then it will override
463 # any env variable JAVA_HOME. A GS2 server does not set JAVA_HOME, though java is on
464 # the path. Therefore, if Fedora is being used for FLI with GS2, then javahome must
465 # be set in gsdlsite.cfg or the JAVA_HOME env var must be explicitly set by the user.
466 my $java_home = $self->get_java_home($optional);
467 if(defined $java_home) {
468 $ENV{'JAVA_HOME'} = $java_home;
469 }
470
471 # FEDORA_HOME and FEDORA_VERSION are needed (by scripts g2f-import and g2f-buildcol).
472 $self->setup_fedora_homes($optional);
473}
474
475sub greenstone_version {
476 my $self = shift @_;
477 return $self->{'greenstone_version'};
478}
479
480sub library_url_suffix {
481 my $self = shift @_;
482 return $self->{'library_url_suffix'};
483}
484
485# Only useful to call this after calling setup_gsdl, as it uses some environment variables
486# Returns the Greenstone collect directory, or a specific collection directory inside collect
487sub get_collection_dir {
488 my $self = shift @_;
489 my ($site, $collection) = @_; # both may be undefined
490
491 require "$ENV{'GSDLHOME'}/perllib/util.pm";
492 my $collection_directory;
493 if($self->{'greenstone_version'} == 2 && defined $ENV{'GSDLHOME'}) {
494 if(defined $collection) {
495 $collection_directory = &util::filename_cat($ENV{'GSDLHOME'}, "collect", $collection);
496 } else {
497 $collection_directory = &util::filename_cat($ENV{'GSDLHOME'}, "collect");
498 }
499 }
500 elsif($self->{'greenstone_version'} == 3 && defined $ENV{'GSDL3SRCHOME'}) {
501 if(defined $collection) {
502 $collection_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "sites", $site, "collect", $collection);
503 } else {
504 $collection_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "sites", $site, "collect");
505 }
506 }
507}
508
509sub local_rm_r
510{
511 my $self = shift @_;
512 my ($local_dir) = @_;
513
514 my $prefix_dir = getcwd();
515 my $full_path = &util::filename_cat($prefix_dir,$local_dir);
516
517 if ($prefix_dir !~ m/collect/) {
518 $self->generate_error("Trying to delete outside of Greenstone collect: $full_path");
519 }
520
521 # Delete recursively
522 if (!-e $full_path) {
523 $self->generate_error("File/Directory does not exist: $full_path");
524 }
525
526 &util::rm_r($full_path);
527}
528
529
530sub get_java_path()
531{
532 # Check the JAVA_HOME environment variable first
533 if (defined $ENV{'JAVA_HOME'}) {
534 my $java_home = $ENV{'JAVA_HOME'};
535 $java_home =~ s/\/$//; # Remove trailing slash if present (Unix specific)
536 return &util::filename_cat($java_home, "bin", "java");
537 }
538
539 # Hope that Java is on the PATH
540 return "java";
541}
542
543
544sub check_java_home()
545{
546 # Return a warning unless the JAVA_HOME environment variable is set
547 if (!defined $ENV{'JAVA_HOME'}) {
548 return "JAVA_HOME environment variable not set. Might not be able to find Java unless in PATH (" . $ENV{'PATH'} . ")";
549 }
550
551 return "";
552}
553
554
555sub checked_chdir
556{
557 my $self = shift @_;
558 my ($dir) = @_;
559
560 if (!-e $dir) {
561 $self->generate_error("Directory '$dir' does not exist");
562 }
563
564 chdir $dir
565 || $self->generate_error("Unable to change to directory: $dir");
566}
567
568sub rot13()
569{
570 my $self = shift @_;
571 my ($password)=@_;
572 my @password_arr=split(//,$password);
573
574 my @encrypt_password;
575 foreach my $str (@password_arr){
576 my $char=unpack("c",$str);
577 if ($char>=97 && $char<=109){
578 $char+=13;
579 }elsif ($char>=110 && $char<=122){
580 $char-=13;
581 }elsif ($char>=65 && $char<=77){
582 $char+=13;
583 }elsif ($char>=78 && $char<=90){
584 $char-=13;
585 }
586 $char=pack("c",$char);
587 push(@encrypt_password,$char);
588 }
589 return join("",@encrypt_password);
590}
591
592sub encrypt_password
593{
594 my $self = shift @_;
595
596 if (defined $self->param("pw")) { ##
597 if ($self->{'greenstone_version'} == 3) { # GS3 is in Java, so needs different encryption
598 $self->param('-name' => "pw", '-value' => $self->rot13($self->clean_param("pw")));
599 }
600 else { # GS2 (and versions of GS other than 3?)
601 #require "$self->{'gsdlhome'}/perllib/util.pm"; # This is OK on Windows
602 require "$self->{'gsdlhome'}/perllib/cpan/Crypt/UnixCrypt.pm"; # This is OK on Windows
603 $self->param('-name' => "pw", '-value' => &Crypt::UnixCrypt::crypt($self->clean_param("pw"), "Tp"));
604 }
605 }
606}
607
6081;
609
Note: See TracBrowser for help on using the repository browser.