source: main/trunk/greenstone2/perllib/util.pm@ 31518

Last change on this file since 31518 was 31518, checked in by ak19, 7 years ago

Found servercontrol::get_library_url() largely duplicated in util.pm as get_fullgreenstone_url_prefix(). Merging the two functions. Tested that solr-jdbm-demo collection still rebuilds (with and without tomcat running, and with and without port change between sessions).
  • Property svn:keywords set to Author Date Id Revision
File size: 61.7 KB
Line 
1###########################################################################
2#
3# util.pm -- various useful utilities
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26package util;
27
28use strict;
29use FileUtils;
30
31use Encode;
32use Unicode::Normalize 'normalize';
33
34use File::Copy;
35use File::Basename;
36# Config for getting the perlpath in the recommended way, though it uses paths that are
37# hard-coded into the Config file that's generated upon configuring and compiling perl.
38# $^X works better in some cases to return the path to perl used to launch the script,
39# but if launched with plain "perl" (no full-path), that will be just what it returns.
40use Config;
41# New module for file related utility functions - intended as a
42# placeholder for an extension that allows a variety of different
43# filesystems (FTP, HTTP, SAMBA, WEBDav, HDFS etc)
44use FileUtils;
45
46if ($ENV{'GSDLOS'} =~ /^windows$/i) {
47 require Win32; # for working out Windows Long Filenames from Win 8.3 short filenames
48}
49
50# removes files (but not directories)
51sub rm {
52 warnings::warnif("deprecated", "util::rm() is deprecated, using FileUtils::removeFiles() instead");
53 return &FileUtils::removeFiles(@_);
54}
55
56# recursive removal
57sub filtered_rm_r {
58 warnings::warnif("deprecated", "util::filtered_rm_r() is deprecated, using FileUtils::removeFilesFiltered() instead");
59 return &FileUtils::removeFilesFiltered(@_);
60}
61
62# recursive removal
63sub rm_r {
64 warnings::warnif("deprecated", "util::rm_r() is deprecated, using FileUtils::removeFilesRecursive() instead");
65 return &FileUtils::removeFilesRecursive(@_);
66}
67
68# moves a file or a group of files
69sub mv {
70 warnings::warnif("deprecated", "util::mv() is deprecated, using FileUtils::moveFiles() instead");
71 return &FileUtils::moveFiles(@_);
72}
73
74# Move the contents of source directory into target directory
75# (as opposed to merely replacing target dir with the src dir)
76# This can overwrite any files with duplicate names in the target
77# but other files and folders in the target will continue to exist
78sub mv_dir_contents {
79 warnings::warnif("deprecated", "util::mv_dir_contents() is deprecated, using FileUtils::moveDirectoryContents() instead");
80 return &FileUtils::moveDirectoryContents(@_);
81}
82
83# copies a file or a group of files
84sub cp {
85 warnings::warnif("deprecated", "util::cp() is deprecated, using FileUtils::copyFiles() instead");
86 return &FileUtils::copyFiles(@_);
87}
88
89# recursively copies a file or group of files
90# syntax: cp_r (sourcefiles, destination directory)
91# destination must be a directory - to copy one file to
92# another use cp instead
93sub cp_r {
94 warnings::warnif("deprecated", "util::cp_r() is deprecated, using FileUtils::copyFilesrecursive() instead");
95 return &FileUtils::copyFilesRecursive(@_);
96}
97
98# recursively copies a file or group of files
99# syntax: cp_r (sourcefiles, destination directory)
100# destination must be a directory - to copy one file to
101# another use cp instead
102sub cp_r_nosvn {
103 warnings::warnif("deprecated", "util::cp_r_nosvn() is deprecated, using FileUtils::copyFilesRecursiveNoSVN() instead");
104 return &FileUtils::copyFilesRecursiveNoSVN(@_);
105}
106
107# copies a directory and its contents, excluding subdirectories, into a new directory
108sub cp_r_toplevel {
109 warnings::warnif("deprecated", "util::cp_r_toplevel() is deprecated, using FileUtils::recursiveCopyTopLevel() instead");
110 return &FileUtils::recursiveCopyTopLevel(@_);
111}
112
113sub mk_dir {
114 warnings::warnif("deprecated", "util::mk_dir() is deprecated, using FileUtils::makeDirectory() instead");
115 return &FileUtils::makeDirectory(@_);
116}
117
118# in case anyone cares - I did some testing (using perls Benchmark module)
119# on this subroutine against File::Path::mkpath (). mk_all_dir() is apparently
120# slightly faster (surprisingly) - Stefan.
121sub mk_all_dir {
122 warnings::warnif("deprecated", "util::mk_all_dir() is deprecated, using FileUtils::makeAllDirectories() instead");
123 return &FileUtils::makeAllDirectories(@_);
124}
125
126# make hard link to file if supported by OS, otherwise copy the file
127sub hard_link {
128 warnings::warnif("deprecated", "util::hard_link() is deprecated, using FileUtils::hardLink() instead");
129 return &FileUtils::hardLink(@_);
130}
131
132# make soft link to file if supported by OS, otherwise copy file
133sub soft_link {
134 warnings::warnif("deprecated", "util::soft_link() is deprecated, using FileUtils::softLink() instead");
135 return &FileUtils::softLink(@_);
136}
137
138# Primarily for filenames generated by processing
139# content of HTML files (which are mapped to UTF-8 internally)
140#
141# To turn this into an octet string that really exists on the file
142# system:
143# 1. don't need to do anything special for Unix-based systems
144# (as underlying file system is byte-code)
145# 2. need to map to short DOS filenames for Windows
146
147sub utf8_to_real_filename
148{
149 my ($utf8_filename) = @_;
150
151 my $real_filename;
152
153 if (($ENV{'GSDLOS'} =~ m/^windows$/i) && ($^O ne "cygwin")) {
154 require Win32;
155
156 my $unicode_filename = decode("utf8",$utf8_filename);
157 $real_filename = Win32::GetShortPathName($unicode_filename);
158 }
159 else {
160 $real_filename = $utf8_filename;
161 }
162
163 return $real_filename;
164}
165
166sub raw_filename_to_unicode
167{
168 my ($directory, $raw_file, $filename_encoding ) = @_;
169
170 my $unicode_filename = $raw_file;
171 if (($ENV{'GSDLOS'} =~ m/^windows$/i) && ($^O ne "cygwin")) {
172 # Try turning a short version to the long version
173 # If there are "funny" characters in the file name, that can't be represented in the ANSI code, then we will have a short weird version, eg E74~1.txt
174 $unicode_filename = &util::get_dirsep_tail(&util::upgrade_if_dos_filename(&FileUtils::filenameConcatenate($directory, $raw_file), 0));
175
176
177 if ($unicode_filename eq $raw_file) {
178 # This means the original filename *was* able to be encoded in the local ANSI file encoding (eg windows_1252), so now we turn it back to perl's unicode
179
180 $unicode_filename = &Encode::decode(locale_fs => $unicode_filename);
181 }
182 # else This means we did have one of the funny filenames. the getLongPathName (used in upgrade_if_dos_filename) will return unicode, so we don't need to do anything more.
183
184
185 } else {
186 # we had a utf-8 string, turn it into perl internal unicode
187 $unicode_filename = &Encode::decode("utf-8", $unicode_filename);
188
189
190 }
191 #Does the filename have url encoded chars in it?
192 if (&unicode::is_url_encoded($unicode_filename)) {
193 $unicode_filename = &unicode::url_decode($unicode_filename);
194 }
195
196 # Normalise the filename to canonical composition - on mac, filenames use decopmposed form for accented chars
197 if ($ENV{'GSDLOS'} =~ m/^darwin$/i) {
198 $unicode_filename = normalize('C', $unicode_filename); # Composed form 'C'
199 }
200 return $unicode_filename;
201
202}
203sub fd_exists {
204 warnings::warnif("deprecated", "util::fd_exists() is deprecated, using FileUtils::fileTest() instead");
205 return &FileUtils::fileTest(@_);
206}
207
208sub file_exists {
209 warnings::warnif("deprecated", "util::file_exists() is deprecated, using FileUtils::fileExists() instead");
210 return &FileUtils::fileExists(@_);
211}
212
213sub dir_exists {
214 warnings::warnif("deprecated", "util::dir_exists() is deprecated, using FileUtils::directoryExists() instead");
215 return &FileUtils::directoryExists(@_);
216}
217
218# updates a copy of a directory in some other part of the filesystem
219# verbosity settings are: 0=low, 1=normal, 2=high
220# both $fromdir and $todir should be absolute paths
221sub cachedir {
222 warnings::warnif("deprecated", "util::cachedir() is deprecated, using FileUtils::synchronizeDirectories() instead");
223 return &FileUtils::synchronizeDirectories(@_);
224}
225
226# this function returns -1 if either file is not found
227# assumes that $file1 and $file2 are absolute file names or
228# in the current directory
229# $file2 is allowed to be newer than $file1
230sub differentfiles {
231 warnings::warnif("deprecated", "util::differentfiles() is deprecated, using FileUtils::differentFiles() instead");
232 return &FileUtils::differentFiles(@_);
233}
234
235
236# works out the temporary directory, including in the case where Greenstone is not writable
237# In that case, gs3-setup.bat would already have set the GS_TMP_OUTPUT_DIR temp variable
238sub determine_tmp_dir
239{
240 my $try_collect_dir = shift(@_) || 0;
241
242 my $tmp_dirname;
243 if(defined $ENV{'GS_TMP_OUTPUT_DIR'}) {
244 $tmp_dirname = $ENV{'GS_TMP_OUTPUT_DIR'};
245 } elsif($try_collect_dir && defined $ENV{'GSDLCOLLECTDIR'}) {
246 $tmp_dirname = $ENV{'GSDLCOLLECTDIR'};
247 } elsif(defined $ENV{'GSDLHOME'}) {
248 $tmp_dirname = $ENV{'GSDLHOME'};
249 } else {
250 return undef;
251 }
252
253 if(!defined $ENV{'GS_TMP_OUTPUT_DIR'}) {
254 # test the tmp_dirname folder is writable, by trying to write out a file
255 # Unfortunately, cound not get if(-w $dirname) to work on directories on Windows
256 ## http://alvinalexander.com/blog/post/perl/perl-file-test-operators-reference-cheat-sheet (test file/dir writable)
257 ## http://www.makelinux.net/alp/083 (real and effective user IDs)
258
259 my $tmp_test_file = &FileUtils::filenameConcatenate($tmp_dirname, "writability_test.tmp");
260 if (open (FOUT, ">$tmp_test_file")) {
261 close(FOUT);
262 &FileUtils::removeFiles($tmp_test_file);
263 } else { # location not writable, use TMP location
264 $tmp_dirname = &FileUtils::filenameConcatenate($ENV{'TMP'}, "greenstone");
265 $ENV{'GS_TMP_OUTPUT_DIR'} = $tmp_dirname; # store for next time
266 }
267 }
268
269 $tmp_dirname = &FileUtils::filenameConcatenate($tmp_dirname, "tmp");
270 &FileUtils::makeAllDirectories ($tmp_dirname) unless -e $tmp_dirname;
271
272 return $tmp_dirname;
273}
274
275sub get_tmp_filename
276{
277 my $file_ext = shift(@_) || undef;
278
279 my $opt_dot_file_ext = "";
280 if (defined $file_ext) {
281 if ($file_ext !~ m/\./) {
282 # no dot, so needs one added in at start
283 $opt_dot_file_ext = ".$file_ext"
284 }
285 else {
286 # allow for "extensions" such as _metadata.txt to be handled
287 # gracefully
288 $opt_dot_file_ext = $file_ext;
289 }
290 }
291
292 my $tmpdir = &util::determine_tmp_dir(0);
293
294 my $count = 1000;
295 my $rand = int(rand $count);
296 my $full_tmp_filename = &FileUtils::filenameConcatenate($tmpdir, "F$rand$opt_dot_file_ext");
297
298 while (-e $full_tmp_filename) {
299 $rand = int(rand $count);
300 $full_tmp_filename = &FileUtils::filenameConcatenate($tmpdir, "F$rand$opt_dot_file_ext");
301 $count++;
302 }
303
304 return $full_tmp_filename;
305}
306
307# These 2 are "static" variables used by the get_timestamped_tmp_folder() subroutine below and
308# belong with that function. They help ensure the timestamped tmp folders generated are unique.
309my $previous_timestamp = undef;
310my $previous_timestamp_f = 0; # frequency
311
312sub get_timestamped_tmp_folder
313{
314 my $tmp_dirname = &util::determine_tmp_dir(1);
315
316 # add the timestamp into the path otherwise we can run into problems
317 # if documents have the same name
318 my $timestamp = time;
319
320 if (!defined $previous_timestamp || ($timestamp > $previous_timestamp)) {
321 $previous_timestamp_f = 0;
322 $previous_timestamp = $timestamp;
323 } else {
324 $previous_timestamp_f++;
325 }
326
327 my $time_tmp_dirname = &FileUtils::filenameConcatenate($tmp_dirname, $timestamp);
328 $tmp_dirname = $time_tmp_dirname;
329 my $i = $previous_timestamp_f;
330
331 if($previous_timestamp_f > 0) {
332 $tmp_dirname = $time_tmp_dirname."_".$i;
333 $i++;
334 }
335 while (-e $tmp_dirname) {
336 $tmp_dirname = $time_tmp_dirname."_".$i;
337 $i++;
338 }
339 &FileUtils::makeDirectory($tmp_dirname);
340
341 return $tmp_dirname;
342}
343
344sub get_timestamped_tmp_filename_in_collection
345{
346
347 my ($input_filename, $output_ext) = @_;
348 # derive tmp filename from input filename
349 my ($tailname, $dirname, $suffix)
350 = &File::Basename::fileparse($input_filename, "\\.[^\\.]+\$");
351
352 # softlink to collection tmp dir
353 my $tmp_dirname = &util::get_timestamped_tmp_folder();
354 $tmp_dirname = $dirname unless defined $tmp_dirname;
355
356 # following two steps copied from ConvertBinaryFile
357 # do we need them?? can't use them as is, as they use plugin methods.
358
359 #$tailname = $self->SUPER::filepath_to_utf8($tailname) unless &unicode::check_is_utf8($tailname);
360
361 # URLEncode this since htmls with images where the html filename is utf8 don't seem
362 # to work on Windows (IE or Firefox), as browsers are looking for filesystem-encoded
363 # files on the filesystem.
364 #$tailname = &util::rename_file($tailname, $self->{'file_rename_method'}, "without_suffix");
365 if (defined $output_ext) {
366 $output_ext = ".$output_ext"; # add the dot
367 } else {
368 $output_ext = $suffix;
369 }
370 $output_ext= lc($output_ext);
371 my $tmp_filename = &FileUtils::filenameConcatenate($tmp_dirname, "$tailname$output_ext");
372
373 return $tmp_filename;
374}
375
376sub get_toplevel_tmp_dir
377{
378 return &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "tmp");
379}
380
381
382sub get_collectlevel_tmp_dir
383{
384 my $tmp_dirname = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, "tmp");
385 &FileUtils::makeDirectory($tmp_dirname) if (!-e $tmp_dirname);
386
387 return $tmp_dirname;
388}
389
390sub get_parent_folder
391{
392 my ($path) = @_;
393 my ($tailname, $dirname, $suffix)
394 = &File::Basename::fileparse($path, "\\.[^\\.]+\$");
395
396 return &FileUtils::sanitizePath($dirname);
397}
398
399sub filename_to_regex {
400 my $filename = shift (@_);
401
402 # need to make single backslashes double so that regex works
403 $filename =~ s/\\/\\\\/g; # if ($ENV{'GSDLOS'} =~ /^windows$/i);
404
405 # note that the first part of a substitution is a regex, so RE chars need to be escaped,
406 # the second part of a substitution is not a regex, so for e.g. full-stop can be specified literally
407 $filename =~ s/\./\\./g; # in case there are extensions/other full stops, escape them
408 $filename =~ s@\(@\\(@g; # escape brackets
409 $filename =~ s@\)@\\)@g; # escape brackets
410 $filename =~ s@\[@\\[@g; # escape brackets
411 $filename =~ s@\]@\\]@g; # escape brackets
412
413 return $filename;
414}
415
416sub unregex_filename {
417 my $filename = shift (@_);
418
419 # need to put doubled backslashes for regex back to single
420 $filename =~ s/\\\./\./g; # remove RE syntax for .
421 $filename =~ s@\\\(@(@g; # remove RE syntax for ( => "\(" turns into "("
422 $filename =~ s@\\\)@)@g; # remove RE syntax for ) => "\)" turns into ")"
423 $filename =~ s@\\\[@[@g; # remove RE syntax for [ => "\[" turns into "["
424 $filename =~ s@\\\]@]@g; # remove RE syntax for ] => "\]" turns into "]"
425
426 # \\ goes to \
427 # This is the last step in reverse mirroring the order of steps in filename_to_regex()
428 $filename =~ s/\\\\/\\/g; # remove RE syntax for \
429 return $filename;
430}
431
432sub filename_cat {
433 # I've disabled this warning for now, as every Greenstone perl
434 # script seems to make use of this function and so you drown in a
435 # sea of deprecated warnings [jmt12]
436# warnings::warnif("deprecated", "util::filename_cat() is deprecated, using FileUtils::filenameConcatenate() instead");
437 return &FileUtils::filenameConcatenate(@_);
438}
439
440
441sub _pathname_cat {
442 my $join_char = shift(@_);
443 my $first_path = shift(@_);
444 my (@pathnames) = @_;
445
446 # If first_path is not null or empty, then add it back into the list
447 if (defined $first_path && $first_path =~ /\S/) {
448 unshift(@pathnames, $first_path);
449 }
450
451 my $pathname = join($join_char, @pathnames);
452
453 # remove duplicate slashes
454 if ($join_char eq ";") {
455 $pathname =~ s/[\\\/]+/\\/g;
456 if ($^O eq "cygwin") {
457 # Once we've collapsed muliple (potentialy > 2) slashes
458 # For cygwin, actually want things double-backslahed
459 $pathname =~ s/\\/\\\\/g;
460 }
461
462 } else {
463 $pathname =~ s/[\/]+/\//g;
464 # DB: want a pathname abc\de.html to remain like this
465 }
466
467 return $pathname;
468}
469
470
471sub pathname_cat {
472 my (@pathnames) = @_;
473
474 my $join_char;
475 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
476 $join_char = ";";
477 } else {
478 $join_char = ":";
479 }
480 return _pathname_cat($join_char,@pathnames);
481}
482
483
484sub javapathname_cat {
485 my (@pathnames) = @_;
486
487 my $join_char;
488
489 # Unlike pathname_cat() above, not interested if running in a Cygwin environment
490 # This is because the java we run is actually a native Windows executable
491
492 if (($ENV{'GSDLOS'} =~ /^windows$/i)) {
493 $join_char = ";";
494 } else {
495 $join_char = ":";
496 }
497 return _pathname_cat($join_char,@pathnames);
498}
499
500
501sub makeFilenameJavaCygwinCompatible
502{
503 my ($java_filename) = @_;
504
505 if ($^O eq "cygwin") {
506 # To be used with a Java program, but under Cygwin
507 # Because the java binary that is native to Windows, need to
508 # convert the Cygwin paths (i.e. Unix style) to be Windows
509 # compatible
510
511 $java_filename = `cygpath -wp "$java_filename"`;
512 chomp($java_filename);
513 $java_filename =~ s%\\%\\\\%g;
514 }
515
516 return $java_filename;
517}
518
519sub tidy_up_oid {
520 my ($OID) = @_;
521 if ($OID =~ /[\.\/\\]/) {
522 print STDERR "Warning, identifier $OID contains periods or slashes(.\\\/), replacing them with _\n";
523 $OID =~ s/[\.\\\/]/_/g; #remove any periods
524 }
525 if ($OID =~ /^\s.*\s$/) {
526 print STDERR "Warning, identifier $OID starts or ends with whitespace. Removing it\n";
527 # remove starting and trailing whitespace
528 $OID =~ s/^\s+//;
529 $OID =~ s/\s+$//;
530 }
531 if ($OID =~ /^[\d]*$/) {
532 print STDERR "Warning, identifier $OID contains only digits. Prepending 'D'.\n";
533 $OID = "D" . $OID;
534 }
535
536 return $OID;
537}
538
539sub envvar_prepend {
540 my ($var,$val) = @_;
541
542 # 64 bit linux can't handle ";" as path separator, so make sure to set this to the right one for the OS
543## my $pathsep = (defined $ENV{'GSDLOS'} && $ENV{'GSDLOS'} !~ m/windows/) ? ":" : ";";
544
545 # Rewritten above to make ":" the default (Windows is the special
546 # case, anything else 'unusual' such as Solaris etc is Unix)
547 my $pathsep = (defined $ENV{'GSDLOS'} && (($ENV{'GSDLOS'} =~ m/windows/) && ($^O ne "cygwin"))) ? ";" : ":";
548
549 # do not prepend any value/path that's already in the environment variable
550
551 my $escaped_val = &filename_to_regex($val); # escape any backslashes and brackets for upcoming regex
552 if (!defined($ENV{$var})) {
553 $ENV{$var} = "$val";
554 }
555 elsif($ENV{$var} !~ m/$escaped_val/) {
556 $ENV{$var} = "$val".$pathsep.$ENV{$var};
557 }
558}
559
560sub envvar_append {
561 my ($var,$val) = @_;
562
563 # 64 bit linux can't handle ";" as path separator, so make sure to set this to the right one for the OS
564 my $pathsep = (defined $ENV{'GSDLOS'} && $ENV{'GSDLOS'} !~ m/windows/) ? ":" : ";";
565
566 # do not append any value/path that's already in the environment variable
567
568 my $escaped_val = &filename_to_regex($val); # escape any backslashes and brackets for upcoming regex
569 if (!defined($ENV{$var})) {
570 $ENV{$var} = "$val";
571 }
572 elsif($ENV{$var} !~ m/$escaped_val/) {
573 $ENV{$var} = $ENV{$var}.$pathsep."$val";
574 }
575}
576
577
578
579# splits a filename into a prefix and a tail extension using the tail_re, or
580# if that fails, splits on the file_extension . (dot)
581sub get_prefix_and_tail_by_regex {
582
583 my ($filename,$tail_re) = @_;
584
585 my ($file_prefix,$file_ext) = ($filename =~ m/^(.*?)($tail_re)$/);
586 if ((!defined $file_prefix) || (!defined $file_ext)) {
587 ($file_prefix,$file_ext) = ($filename =~ m/^(.*)(\..*?)$/);
588 }
589
590 return ($file_prefix,$file_ext);
591}
592
593# get full path and file only path from a base_dir (which may be empty) and
594# file (which may contain directories)
595sub get_full_filenames {
596 my ($base_dir, $file) = @_;
597
598# my ($cpackage,$cfilename,$cline,$csubr,$chas_args,$cwantarray) = caller(0);
599# my ($lcfilename) = ($cfilename =~ m/([^\\\/]*)$/);
600# print STDERR "** Calling method: $lcfilename:$cline $cpackage->$csubr\n";
601
602
603 my $filename_full_path = $file;
604 # add on directory if present
605 $filename_full_path = &FileUtils::filenameConcatenate($base_dir, $file) if $base_dir =~ /\S/;
606
607 my $filename_no_path = $file;
608
609 # remove directory if present
610 $filename_no_path =~ s/^.*[\/\\]//;
611 return ($filename_full_path, $filename_no_path);
612}
613
614# returns the path of a file without the filename -- ie. the directory the file is in
615sub filename_head {
616 my $filename = shift(@_);
617
618 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
619 $filename =~ s/[^\\\\]*$//;
620 }
621 else {
622 $filename =~ s/[^\\\/]*$//;
623 }
624
625 return $filename;
626}
627
628
629
630# returns 1 if filename1 and filename2 point to the same
631# file or directory
632sub filenames_equal {
633 my ($filename1, $filename2) = @_;
634
635 # use filename_cat to clean up trailing slashes and
636 # multiple slashes
637 $filename1 = &FileUtils::filenameConcatenate($filename1);
638 $filename2 = &FileUtils::filenameConcatenate($filename2);
639
640 # filenames not case sensitive on windows
641 if ($ENV{'GSDLOS'} =~ /^windows$/i) {
642 $filename1 =~ tr/[A-Z]/[a-z]/;
643 $filename2 =~ tr/[A-Z]/[a-z]/;
644 }
645 return 1 if $filename1 eq $filename2;
646 return 0;
647}
648
649# If filename is relative to within_dir, returns the relative path of filename to that directory
650# with slashes in the filename returned as they were in the original (absolute) filename.
651sub filename_within_directory
652{
653 my ($filename,$within_dir) = @_;
654
655 if ($within_dir !~ m/[\/\\]$/) {
656 my $dirsep = &util::get_dirsep();
657 $within_dir .= $dirsep;
658 }
659
660 $within_dir = &filename_to_regex($within_dir); # escape DOS style file separator and brackets
661 if ($filename =~ m/^$within_dir(.*)$/) {
662 $filename = $1;
663 }
664
665 return $filename;
666}
667
668# If filename is relative to within_dir, returns the relative path of filename to that directory in URL format.
669# Filename and within_dir can be any type of slashes, but will be compared as URLs (i.e. unix-style slashes).
670# The subpath returned will also be a URL type filename.
671sub filename_within_directory_url_format
672{
673 my ($filename,$within_dir) = @_;
674
675 # convert parameters only to / slashes if Windows
676
677 my $filename_urlformat = &filepath_to_url_format($filename);
678 my $within_dir_urlformat = &filepath_to_url_format($within_dir);
679
680 #if ($within_dir_urlformat !~ m/\/$/) {
681 # make sure directory ends with a slash
682 #$within_dir_urlformat .= "/";
683 #}
684
685 my $within_dir_urlformat_re = &filename_to_regex($within_dir_urlformat); # escape any special RE characters, such as brackets
686
687 #print STDERR "@@@@@ $filename_urlformat =~ $within_dir_urlformat_re\n";
688
689 # dir prefix may or may not end with a slash (this is discarded when extracting the sub-filepath)
690 if ($filename_urlformat =~ m/^$within_dir_urlformat_re(?:\/)*(.*)$/) {
691 $filename_urlformat = $1;
692 }
693
694 return $filename_urlformat;
695}
696
697# Convert parameter to use / slashes if Windows (if on Linux leave any \ as is,
698# since on Linux it doesn't represent a file separator but an escape char).
699sub filepath_to_url_format
700{
701 my ($filepath) = @_;
702 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
703 # Only need to worry about Windows, as Unix style directories already in url-format
704 # Convert Windows style \ => /
705 $filepath =~ s@\\@/@g;
706 }
707 return $filepath;
708}
709
710# regex filepaths on windows may include \\ as path separator. Convert \\ to /
711sub filepath_regex_to_url_format
712{
713 my ($filepath) = @_;
714 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
715 # Only need to worry about Windows, as Unix style directories already in url-format
716 # Convert Windows style \\ => /
717 $filepath =~ s@\\\\@/@g;
718 }
719 return $filepath;
720
721}
722
723# Like File::Basename::fileparse, but expects filepath in url format (ie only / slash for dirsep)
724# and ignores trailing /
725# returns (file, dirs) dirs will be empty if no subdirs
726sub url_fileparse
727{
728 my ($filepath) = @_;
729 # remove trailing /
730 $filepath =~ s@/$@@;
731 if ($filepath !~ m@/@) {
732 return ($filepath, "");
733 }
734 my ($dirs, $file) = $filepath =~ m@(.+/)([^/]+)@;
735 return ($file, $dirs);
736
737}
738
739
740sub filename_within_collection
741{
742 my ($filename) = @_;
743
744 my $collect_dir = $ENV{'GSDLCOLLECTDIR'};
745
746 if (defined $collect_dir) {
747
748 # if from within GSDLCOLLECTDIR, then remove directory prefix
749 # so source_filename is realative to it. This is done to aid
750 # portability, i.e. the collection can be moved to somewhere
751 # else on the file system and the archives directory will still
752 # work. This is needed, for example in the applet version of
753 # GLI where GSDLHOME/collect on the server will be different to
754 # the collect directory of the remove user. Of course,
755 # GSDLCOLLECTDIR subsequently needs to be put back on to turn
756 # it back into a full pathname.
757
758 $filename = filename_within_directory($filename,$collect_dir);
759 }
760
761 return $filename;
762}
763
764sub prettyprint_file
765{
766 my ($base_dir,$file,$gli) = @_;
767
768 my $filename_full_path = &FileUtils::filenameConcatenate($base_dir,$file);
769
770 if (($ENV{'GSDLOS'} =~ m/^windows$/i) && ($^O ne "cygwin")) {
771 require Win32;
772
773 # For some reason base_dir in the form c:/a/b/c
774 # This leads to confusion later on, so turn it back into
775 # the more usual Windows form
776 $base_dir =~ s/\//\\/g;
777 my $long_base_dir = Win32::GetLongPathName($base_dir);
778 my $long_full_path = Win32::GetLongPathName($filename_full_path);
779
780 $file = filename_within_directory($long_full_path,$long_base_dir);
781 $file = encode("utf8",$file) if ($gli);
782 }
783
784 return $file;
785}
786
787
788sub upgrade_if_dos_filename
789{
790 my ($filename_full_path,$and_encode) = @_;
791
792 if (($ENV{'GSDLOS'} =~ m/^windows$/i) && ($^O ne "cygwin")) {
793 # Ensure any DOS-like filename, such as test~1.txt, has been upgraded
794 # to its long (Windows) version
795 my $long_filename = Win32::GetLongPathName($filename_full_path);
796 if (defined $long_filename) {
797
798 $filename_full_path = $long_filename;
799 }
800 # Make sure initial drive letter is lower-case (to fit in with rest of Greenstone)
801 $filename_full_path =~ s/^(.):/\u$1:/;
802
803 if ((defined $and_encode) && ($and_encode)) {
804 $filename_full_path = encode("utf8",$filename_full_path);
805 }
806 }
807
808 return $filename_full_path;
809}
810
811
812sub downgrade_if_dos_filename
813{
814 my ($filename_full_path) = @_;
815
816 if (($ENV{'GSDLOS'} =~ m/^windows$/i) && ($^O ne "cygwin")) {
817 require Win32;
818
819 # Ensure the given long Windows filename is in a form that can
820 # be opened by Perl => convert it to a short DOS-like filename
821
822 my $short_filename = Win32::GetShortPathName($filename_full_path);
823 if (defined $short_filename) {
824 $filename_full_path = $short_filename;
825 }
826 # Make sure initial drive letter is lower-case (to fit in
827 # with rest of Greenstone)
828 $filename_full_path =~ s/^(.):/\u$1:/;
829 }
830
831 return $filename_full_path;
832}
833
834
835sub filename_is_absolute
836{
837 warnings::warnif("deprecated", "util::filename_is_absolute() is deprecated, using FileUtils::isFilenameAbsolute() instead");
838 return &FileUtils::isFilenameAbsolute(@_);
839}
840
841
842## @method make_absolute()
843#
844# Ensure the given file path is absolute in respect to the given base path.
845#
846# @param $base_dir A string denoting the base path the given dir must be
847# absolute to.
848# @param $dir The directory to be made absolute as a string. Note that the
849# dir may already be absolute, in which case it will remain
850# unchanged.
851# @return The now absolute form of the directory as a string.
852#
853# @author John Thompson, DL Consulting Ltd.
854# @copy 2006 DL Consulting Ltd.
855#
856#used in buildcol.pl, doesn't work for all cases --kjdon
857sub make_absolute {
858
859 my ($base_dir, $dir) = @_;
860### print STDERR "dir = $dir\n";
861 $dir =~ s/[\\\/]+/\//g;
862 $dir = $base_dir . "/$dir" unless ($dir =~ m|^(\w:)?/|);
863 $dir =~ s|^/tmp_mnt||;
864 1 while($dir =~ s|/[^/]*/\.\./|/|g);
865 $dir =~ s|/[.][.]?/|/|g;
866 $dir =~ tr|/|/|s;
867### print STDERR "dir = $dir\n";
868
869 return $dir;
870}
871## make_absolute() ##
872
873sub get_dirsep {
874
875 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
876 return "\\";
877 } else {
878 return "\/";
879 }
880}
881
882sub get_os_dirsep {
883
884 if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin")) {
885 return "\\\\";
886 } else {
887 return "\\\/";
888 }
889}
890
891sub get_re_dirsep {
892
893 return "\\\\|\\\/";
894}
895
896
897sub get_dirsep_tail {
898 my ($filename) = @_;
899
900 # returns last part of directory or filename
901 # On unix e.g. a/b.d => b.d
902 # a/b/c => c
903
904 my $dirsep = get_re_dirsep();
905 my @dirs = split (/$dirsep/, $filename);
906 my $tail = pop @dirs;
907
908 # - caused problems under windows
909 #my ($tail) = ($filename =~ m/^(?:.*?$dirsep)?(.*?)$/);
910
911 return $tail;
912}
913
914
915# if this is running on windows we want binaries to end in
916# .exe, otherwise they don't have to end in any extension
917sub get_os_exe {
918 return ".exe" if (($ENV{'GSDLOS'} =~ /^windows$/i) && ($^O ne "cygwin"));
919 return "";
920}
921
922
923# test to see whether this is a big or little endian machine
924sub is_little_endian
925{
926 # To determine the name of the operating system, the variable $^O is a cheap alternative to pulling it out of the Config module;
927 # If it is a Macintosh machine (i.e. the Darwin operating system), regardless if it's running on the IBM power-pc cpu or the x86 Intel-based chip with a power-pc emulator running on top of it, it's big-endian
928 # Otherwise, it's little endian
929
930 #return 0 if $^O =~ /^darwin$/i;
931 #return 0 if $ENV{'GSDLOS'} =~ /^darwin$/i;
932
933 # Going back to stating exactly whether the machine is little endian
934 # or big endian, without any special case for Macs. Since for rata it comes
935 # back with little endian and for shuttle with bigendian.
936 return (ord(substr(pack("s",1), 0, 1)) == 1);
937}
938
939
940# will return the collection name if successful, "" otherwise
941sub use_collection {
942 my ($collection, $collectdir) = @_;
943
944 if (!defined $collectdir || $collectdir eq "") {
945 $collectdir = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "collect");
946 }
947
948 if (!defined $ENV{'GREENSTONEHOME'}) { # for GS3, would have been defined in use_site_collection, to GSDL3HOME
949 $ENV{'GREENSTONEHOME'} = $ENV{'GSDLHOME'};
950 }
951
952 # get and check the collection
953 if (!defined($collection) || $collection eq "") {
954 if (defined $ENV{'GSDLCOLLECTION'}) {
955 $collection = $ENV{'GSDLCOLLECTION'};
956 } else {
957 print STDOUT "No collection specified\n";
958 return "";
959 }
960 }
961
962 if ($collection eq "modelcol") {
963 print STDOUT "You can't use modelcol.\n";
964 return "";
965 }
966
967 # make sure the environment variables GSDLCOLLECTION and GSDLCOLLECTDIR
968 # are defined
969 $ENV{'GSDLCOLLECTION'} = $collection;
970 $ENV{'GSDLCOLLECTHOME'} = $collectdir;
971 $ENV{'GSDLCOLLECTDIR'} = &FileUtils::filenameConcatenate($collectdir, $collection);
972
973 # make sure this collection exists
974 if (!-e $ENV{'GSDLCOLLECTDIR'}) {
975 print STDOUT "Invalid collection ($collection).\n";
976 return "";
977 }
978
979 # everything is ready to go
980 return $collection;
981}
982
983sub get_current_collection_name {
984 return $ENV{'GSDLCOLLECTION'};
985}
986
987
988# will return the collection name if successful, "" otherwise.
989# Like use_collection (above) but for greenstone 3 (taking account of site level)
990
991sub use_site_collection {
992 my ($site, $collection, $collectdir) = @_;
993
994 if (!defined $collectdir || $collectdir eq "") {
995 die "GSDL3HOME not set.\n" unless defined $ENV{'GSDL3HOME'};
996 $collectdir = &FileUtils::filenameConcatenate($ENV{'GSDL3HOME'}, "sites", $site, "collect");
997 }
998
999 if (defined $ENV{'GSDL3HOME'}) {
1000 $ENV{'GREENSTONEHOME'} = $ENV{'GSDL3HOME'};
1001 $ENV{'SITEHOME'} = &FileUtils::filenameConcatenate($ENV{'GREENSTONEHOME'}, "sites", $site);
1002 } elsif (defined $ENV{'GSDL3SRCHOME'}) {
1003 $ENV{'GREENSTONEHOME'} = &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'}, "web");
1004 $ENV{'SITEHOME'} = &FileUtils::filenameConcatenate($ENV{'GREENSTONEHOME'}, "sites", $site);
1005 } else {
1006 print STDERR "*** util::use_site_collection(). Warning: Neither GSDL3HOME nor GSDL3SRCHOME set.\n";
1007 }
1008
1009 # collectdir explicitly set by this point (using $site variable if required).
1010 # Can call "old" gsdl2 use_collection now.
1011
1012 return use_collection($collection,$collectdir);
1013}
1014
1015
1016
1017sub locate_config_file
1018{
1019 my ($file) = @_;
1020
1021 my $locations = locate_config_files($file);
1022
1023 return shift @$locations; # returns undef if 'locations' is empty
1024}
1025
1026
1027sub locate_config_files
1028{
1029 my ($file) = @_;
1030
1031 my @locations = ();
1032
1033 if (-e $file) {
1034 # Clearly specified (most likely full filename)
1035 # No need to hunt in 'etc' directories, return value unchanged
1036 push(@locations,$file);
1037 }
1038 else {
1039 # Check for collection specific one before looking in global GSDL 'etc'
1040 if (defined $ENV{'GSDLCOLLECTDIR'} && $ENV{'GSDLCOLLECTDIR'} ne "") {
1041 my $test_collect_etc_filename
1042 = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},"etc", $file);
1043
1044 if (-e $test_collect_etc_filename) {
1045 push(@locations,$test_collect_etc_filename);
1046 }
1047 }
1048 my $test_main_etc_filename
1049 = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"etc", $file);
1050 if (-e $test_main_etc_filename) {
1051 push(@locations,$test_main_etc_filename);
1052 }
1053 }
1054
1055 return \@locations;
1056}
1057
1058
1059sub hyperlink_text
1060{
1061 my ($text) = @_;
1062
1063 $text =~ s/(http:\/\/[^\s]+)/<a href=\"$1\">$1<\/a>/mg;
1064 $text =~ s/(^|\s+)(www\.(\w|\.)+)/<a href=\"http:\/\/$2\">$2<\/a>/mg;
1065
1066 return $text;
1067}
1068
1069
1070# A method to check if a directory is empty (note that an empty directory still has non-zero size!!!)
1071# Code is from http://episteme.arstechnica.com/eve/forums/a/tpc/f/6330927813/m/436007700831
1072sub is_dir_empty {
1073 warnings::warnif("deprecated", "util::is_dir_empty() is deprecated, using FileUtils::isDirectoryEmpty() instead");
1074 return &FileUtils::isDirectoryEmpty(@_);
1075}
1076
1077# Returns the given filename converted using either URL encoding or base64
1078# encoding, as specified by $rename_method. If the given filename has no suffix
1079# (if it is just the tailname), then $no_suffix should be some defined value.
1080# rename_method can be url, none, base64
1081sub rename_file {
1082 my ($filename, $rename_method, $no_suffix) = @_;
1083
1084 if(!$filename) { # undefined or empty string
1085 return $filename;
1086 }
1087
1088 if (!$rename_method) {
1089 print STDERR "WARNING: no file renaming method specified. Defaulting to using URL encoding...\n";
1090 # Debugging information
1091 # my ($cpackage,$cfilename,$cline,$csubr,$chas_args,$cwantarray) = caller(1);
1092 # print STDERR "Called from method: $cfilename:$cline $cpackage->$csubr\n";
1093 $rename_method = "url";
1094 } elsif($rename_method eq "none") {
1095 return $filename; # would have already been renamed
1096 }
1097
1098 # No longer replace spaces with underscores, since underscores mess with incremental rebuild
1099 ### Replace spaces with underscore. Do this first else it can go wrong below when getting tailname
1100 ###$filename =~ s/ /_/g;
1101
1102 my ($tailname,$dirname,$suffix);
1103 if($no_suffix) { # given a tailname, no suffix
1104 ($tailname,$dirname) = File::Basename::fileparse($filename);
1105 }
1106 else {
1107 ($tailname,$dirname,$suffix) = File::Basename::fileparse($filename, "\\.(?:[^\\.]+?)\$");
1108 }
1109 if (!$suffix) {
1110 $suffix = "";
1111 }
1112 # This breaks GLI matching extracted metadata to files in Enrich panel, as
1113 # original is eg .JPG while gsdlsourcefilename ends up .jpg
1114 # Not sure why it was done in first place...
1115 #else {
1116 #$suffix = lc($suffix);
1117 #}
1118
1119 if ($rename_method eq "url") {
1120 $tailname = &unicode::url_encode($tailname);
1121 }
1122 elsif ($rename_method eq "base64") {
1123 $tailname = &unicode::base64_encode($tailname);
1124 $tailname =~ s/\s*//sg; # for some reason it adds spaces not just at end but also in middle
1125 }
1126
1127 $filename = "$tailname$suffix";
1128 $filename = "$dirname$filename" if ($dirname ne "./" && $dirname ne ".\\");
1129
1130 return $filename;
1131}
1132
1133
1134# BACKWARDS COMPATIBILITY: Just in case there are old .ldb/.bdb files
1135sub rename_ldb_or_bdb_file {
1136 my ($filename_no_ext) = @_;
1137
1138 my $new_filename = "$filename_no_ext.gdb";
1139 return if (-f $new_filename); # if the file has the right extension, don't need to do anything
1140 # try ldb
1141 my $old_filename = "$filename_no_ext.ldb";
1142
1143 if (-f $old_filename) {
1144 print STDERR "Renaming $old_filename to $new_filename\n";
1145 rename ($old_filename, $new_filename)
1146 || print STDERR "Rename failed: $!\n";
1147 return;
1148 }
1149 # try bdb
1150 $old_filename = "$filename_no_ext.bdb";
1151 if (-f $old_filename) {
1152 print STDERR "Renaming $old_filename to $new_filename\n";
1153 rename ($old_filename, $new_filename)
1154 || print STDERR "Rename failed: $!\n";
1155 return;
1156 }
1157}
1158
1159sub os_dir() {
1160
1161 my $gsdlarch = "";
1162 if(defined $ENV{'GSDLARCH'}) {
1163 $gsdlarch = $ENV{'GSDLARCH'};
1164 }
1165 return $ENV{'GSDLOS'}.$gsdlarch;
1166}
1167
1168# returns 1 if this (GS server) is a GS3 installation, returns 0 if it's GS2.
1169sub is_gs3() {
1170 if($ENV{'GSDL3SRCHOME'}) {
1171 return 1;
1172 } else {
1173 return 0;
1174 }
1175}
1176
1177# Returns the greenstone URL prefix extracted from the appropriate GS2/GS3 config file.
1178# By default, /greenstone3 for GS3 or /greenstone for GS2.
1179sub get_greenstone_url_prefix() {
1180 # if already set on a previous occasion, just return that
1181 # (Don't want to keep repeating this: cost of re-opening and scanning files.)
1182 return $ENV{'GREENSTONE_URL_PREFIX'} if($ENV{'GREENSTONE_URL_PREFIX'});
1183
1184 my ($configfile, $urlprefix, $defaultUrlprefix);
1185 my @propertynames = ();
1186
1187 if($ENV{'GSDL3SRCHOME'}) {
1188 $defaultUrlprefix = "/greenstone3";
1189 $configfile = &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'}, "packages", "tomcat", "conf", "Catalina", "localhost", "greenstone3.xml");
1190 push(@propertynames, qw/path\s*\=/);
1191 } else {
1192 $defaultUrlprefix = "/greenstone";
1193 $configfile = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "cgi-bin", &os_dir(), "gsdlsite.cfg");
1194 push(@propertynames, (qw/\nhttpprefix/, qw/\ngwcgi/)); # inspect one property then the other
1195 }
1196
1197 $urlprefix = &extract_propvalue_from_file($configfile, \@propertynames);
1198
1199 if(!$urlprefix) { # no values found for URL prefix, use default values
1200 $urlprefix = $defaultUrlprefix;
1201 } else {
1202 #gwcgi can contain more than the wanted prefix, we split on / to get the first "directory" level
1203 $urlprefix =~ s/^\///; # remove the starting slash
1204 my @dirs = split(/(\\|\/)/, $urlprefix);
1205 $urlprefix = shift(@dirs);
1206
1207 if($urlprefix !~ m/^\//) { # in all cases: ensure the required forward slash is at the front
1208 $urlprefix = "/$urlprefix";
1209 }
1210 }
1211
1212 # set for the future
1213 $ENV{'GREENSTONE_URL_PREFIX'} = $urlprefix;
1214# print STDERR "*** in get_greenstone_url_prefix(): $urlprefix\n\n";
1215 return $urlprefix;
1216}
1217
1218
1219
1220#
1221# The following comes from activate.pl
1222#
1223# Designed to work with a server included with GS.
1224# - For GS3, we ask ant for the library URL.
1225# - For GS2, we derive the URL from the llssite.cfg file.
1226
1227sub get_full_greenstone_url_prefix
1228{
1229 my ($gs_mode, $lib_name) = @_;
1230
1231 # if already set on a previous occasion, just return that
1232 # (Don't want to keep repeating this: cost of re-opening and scanning files.)
1233 return $ENV{'FULL_GREENSTONE_URL_PREFIX'} if($ENV{'FULL_GREENSTONE_URL_PREFIX'});
1234
1235 # set gs_mode if it was not passed in (servercontrol.pm would pass it in, any other callers won't)
1236 $gs_mode = ($ENV{'GSDL3SRCHOME'}) ? "gs3" : "gs2" unless defined $gs_mode;
1237
1238 my $url = undef;
1239
1240 if($gs_mode eq "gs2") {
1241 my $llssite_cfg = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "llssite.cfg");
1242
1243 if(-f $llssite_cfg) {
1244 # check llssite.cfg for line with url property
1245 # for server.exe also need to use portnumber and enterlib properties
1246
1247 # Read in the entire contents of the file in one hit
1248 if (!open (FIN, $llssite_cfg)) {
1249 print STDERR "util::get_full_greenstone_url_prefix() failed to open $llssite_cfg ($!)\n";
1250 return undef;
1251 }
1252
1253 my $contents;
1254 sysread(FIN, $contents, -s FIN);
1255 close(FIN);
1256
1257 my @lines = split(/[\n\r]+/, $contents); # split on carriage-returns and/or linefeeds
1258 my $enterlib = "";
1259 my $portnumber = "8282"; # will remain empty (implicit port 80) unless it's specifically been assigned
1260
1261 foreach my $line (@lines) {
1262 if($line =~ m/^url=(.*)$/) {
1263 $url = $1;
1264 } elsif($line =~ m/^enterlib=(.*)$/) {
1265 $enterlib = $1;
1266 } elsif($line =~ m/^portnumber=(.*)$/) {
1267 $portnumber = $1;
1268 }
1269 }
1270
1271 if(!$url) {
1272 return undef;
1273 }
1274 elsif($url eq "URL_pending") { # library is not running
1275 # do not process url=URL_pending in the file, since for server.exe
1276 # this just means the Enter Library button hasn't been pressed yet
1277 $url = undef;
1278 }
1279 else {
1280 # In the case of server.exe, need to do extra work to get the proper URL
1281 # But first, need to know whether we're indeed dealing with server.exe:
1282
1283 # compare the URL's domain to the full URL
1284 # E.g. for http://localhost:8383/greenstone3/cgi-bin, the domain is localhost:8383
1285 my $uri = URI->new( $url );
1286 my $host = $uri->host;
1287 #print STDERR "@@@@@ host: $host\n";
1288 if($url =~ m/https?:\/\/$host(\/)?$/) {
1289 #if($url !~ m/https?:\/\/$host:$portnumber(\/)?/ || $url =~ m/https?:\/\/$host(\/)?$/) {
1290 # (if the URL does not contain the portnumber, OR if the port is implicitly 80 and)
1291 # If the domain with http:// prefix is completely the same as the URL, assume server.exe
1292 # then the actual URL is the result of suffixing the port and enterlib properties in llssite.cfg
1293 $url = $url.":".$portnumber.$enterlib;
1294 } # else, apache web server
1295
1296 }
1297 }
1298 } elsif($gs_mode eq "gs3") {
1299 # Either check build.properties for tomcat.server, tomcat.port and app.name (and default servlet name).
1300 # app.name is stored in app.path by build.xml. Need to move app.name in build.properties from build.xml
1301
1302 # Or, run the new target get-default-servlet-url
1303 # the output can look like:
1304 #
1305 # Buildfile: build.xml
1306 # [echo] os.name: Windows Vista
1307 #
1308 # get-default-servlet-url:
1309 # [echo] http://localhost:8383/greenstone3/library
1310 # BUILD SUCCESSFUL
1311 # Total time: 0 seconds
1312
1313 #my $output = qx/ant get-default-servlet-url/; # backtick operator, to get STDOUT (else 2>&1)
1314 # - see http://stackoverflow.com/questions/799968/whats-the-difference-between-perls-backticks-system-and-exec
1315
1316 # The get-default-servlet-url ant target can be run from anywhere by specifying the
1317 # location of GS3's ant build.xml buildfile. Activate.pl can be run from anywhere for GS3
1318 # GSDL3SRCHOME will be set for GS3 by gs3-setup.sh, a step that would have been necessary
1319 # to run the activate.pl script in the first place
1320
1321 my $full_build_xml = &FileUtils::javaFilenameConcatenate($ENV{'GSDL3SRCHOME'},"build.xml");
1322
1323 my $perl_command = "ant -buildfile \"$full_build_xml\" get-default-servlet-url";
1324
1325 if (open(PIN, "$perl_command |")) {
1326 while (defined (my $perl_output_line = <PIN>)) {
1327
1328 if($perl_output_line =~ m@(https?):\/\/(\S*)@) { # grab all the non-whitespace chars
1329 $url="$1://".$2; # preserve the http protocol #$url="http://".$1;
1330 }
1331 }
1332 close(PIN);
1333
1334 if (defined $lib_name) { # url won't be undef now
1335 # replace the servlet_name portion of the url found, with the given library_name
1336 $url =~ s@/[^/]*$@/$lib_name@;
1337 }
1338 } else {
1339 print STDERR "util::get_full_greenstone_url_prefix() failed to run $perl_command to work out library URL for $gs_mode\n";
1340 }
1341 }
1342
1343 # either the url is still undef or it is now set
1344 #print STDERR "\n@@@@@ final URL:|$url|\n" if $url;
1345 #print STDERR "\n@@@@@ URL still undef\n" if !$url;
1346
1347 $ENV{'FULL_GREENSTONE_URL_PREFIX'} = $url;
1348
1349 return $url;
1350}
1351
1352
1353# Given a config file (xml or java properties file) and a list/array of regular expressions
1354# that represent property names to match on, this function will return the value for the 1st
1355# matching property name. If the return value is undefined, no matching property was found.
1356sub extract_propvalue_from_file() {
1357 my ($configfile, $propertynames) = @_;
1358
1359 my $value;
1360 unless(open(FIN, "<$configfile")) {
1361 print STDERR "extract_propvalue_from_file(): Unable to open $configfile. $!\n";
1362 return $value; # not initialised
1363 }
1364
1365 # Read the entire file at once, as one single line, then close it
1366 my $filecontents;
1367 {
1368 local $/ = undef;
1369 $filecontents = <FIN>;
1370 }
1371 close(FIN);
1372
1373 foreach my $regex (@$propertynames) {
1374 ($value) = $filecontents=~ m/$regex\s*(\S*)/s; # read value of the property given by regex up to the 1st space
1375 if($value) {
1376 $value =~ s/^\"//; # remove any startquotes
1377 $value =~ s/\".*$//; # remove the 1st endquotes (if any) followed by any xml
1378 last; # found value for a matching property, break from loop
1379 }
1380 }
1381
1382 return $value;
1383}
1384
1385# Subroutine that sources setup.bash, given GSDLHOME and GSDLOS and
1386# given that perllib is in @INC in order to invoke this subroutine.
1387# Call as follows -- after setting up INC to include perllib and
1388# after setting up GSDLHOME and GSDLOS:
1389#
1390# require util;
1391# &util::setup_greenstone_env($ENV{'GSDLHOME'}, $ENV{'GSDLOS'});
1392#
1393sub setup_greenstone_env() {
1394 my ($GSDLHOME, $GSDLOS) = @_;
1395
1396 #my %env_map = ();
1397 # Get the localised ENV settings of running a localised source setup.bash
1398 # and put it into the ENV here. Need to clear GSDLHOME before running setup
1399 #my $perl_command = "(cd $GSDLHOME; export GSDLHOME=; . ./setup.bash > /dev/null; env)";
1400 my $perl_command = "(cd $GSDLHOME; /bin/bash -c \"export GSDLHOME=; source setup.bash > /dev/null; env\")";
1401 if (($GSDLOS =~ m/windows/i) && ($^O ne "cygwin")) {
1402 #$perl_command = "cmd /C \"cd $GSDLHOME&& set GSDLHOME=&& setup.bat > nul&& set\"";
1403 $perl_command = "(cd $GSDLHOME&& set GSDLHOME=&& setup.bat > nul&& set)";
1404 }
1405 if (!open(PIN, "$perl_command |")) {
1406 print STDERR ("Unable to execute command: $perl_command. $!\n");
1407 }
1408
1409 my $lastkey;
1410 while (defined (my $perl_output_line = <PIN>)) {
1411 my($key,$value) = ($perl_output_line =~ m/^([^=]*)[=](.*)$/);
1412 if(defined $key) {
1413 #$env_map{$key}=$value;
1414 $ENV{$key}=$value;
1415 $lastkey = $key;
1416 } elsif($lastkey && $perl_output_line !~ m/^\s*$/) {
1417 # there was no equals sign in $perl_output_line, so this
1418 # $perl_output_line may be a spillover from the previous
1419 $ENV{$lastkey} = $ENV{$lastkey}."\n".$perl_output_line;
1420 }
1421 }
1422 close (PIN);
1423
1424 # If any keys in $ENV don't occur in Greenstone's localised env
1425 # (stored in $env_map), delete those entries from $ENV
1426 #foreach $key (keys %ENV) {
1427 # if(!defined $env_map{$key}) {
1428 # print STDOUT "**** DELETING ENV KEY: $key\tVALUE: $ENV{$key}\n";
1429 # delete $ENV{$key}; # del $ENV(key, value) pair
1430 # }
1431 #}
1432 #undef %env_map;
1433}
1434
1435sub get_perl_exec() {
1436 my $perl_exec = $^X; # may return just "perl"
1437
1438 if($ENV{'PERLPATH'}) {
1439 # OR: # $perl_exec = &FileUtils::filenameConcatenate($ENV{'PERLPATH'},"perl");
1440 if (($ENV{'GSDLOS'} =~ m/windows/) && ($^O ne "cygwin")) {
1441 $perl_exec = "$ENV{'PERLPATH'}\\Perl.exe";
1442 } else {
1443 $perl_exec = "$ENV{'PERLPATH'}/perl";
1444 }
1445 } else { # no PERLPATH, use Config{perlpath} else $^X: special variables
1446 # containing the full path to the current perl executable we're using
1447 $perl_exec = $Config{perlpath}; # configured path for perl
1448 if (!-e $perl_exec) { # may not point to location on this machine
1449 $perl_exec = $^X; # may return just "perl"
1450 if($perl_exec =~ m/^perl/i) { # warn if just perl or Perl.exe
1451 print STDERR "**** WARNING: Perl exec found contains no path: $perl_exec";
1452 }
1453 }
1454 }
1455
1456 return $perl_exec;
1457}
1458
1459# returns the path to the java command in the JRE included with GS (if any),
1460# quoted to safeguard any spaces in this path, otherwise a simple java
1461# command is returned which assumes and will try for a system java.
1462sub get_java_command {
1463 my $java = "java";
1464 if(defined $ENV{'GSDLHOME'}) { # should be, as this script would be launched from the cmd line
1465 # after running setup.bat or from GLI which also runs setup.bat
1466 my $java_bin = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"packages","jre","bin");
1467 if(-d $java_bin) {
1468 $java = &FileUtils::filenameConcatenate($java_bin,"java");
1469 $java = "\"".$java."\""; # quoted to preserve spaces in path
1470 }
1471 }
1472 return $java;
1473}
1474
1475
1476# Given the qualified collection name (colgroup/collection),
1477# returns the collection and colgroup parts
1478sub get_collection_parts {
1479 # http://perldoc.perl.org/File/Basename.html
1480 # my($filename, $directories, $suffix) = fileparse($path);
1481 # "$directories contains everything up to and including the last directory separator in the $path
1482 # including the volume (if applicable). The remainder of the $path is the $filename."
1483 #my ($collection, $colgroup) = &File::Basename::fileparse($qualified_collection);
1484
1485 my $qualified_collection = shift(@_);
1486
1487 # Since activate.pl can be launched from the command-line, including by a user,
1488 # best not to assume colgroup uses URL-style slashes as would be the case with GLI
1489 # Also allow for the accidental inclusion of multiple slashes
1490 my ($colgroup, $collection) = split(/[\/\\]+/, $qualified_collection); #split('/', $qualified_collection);
1491
1492 if(!defined $collection) {
1493 $collection = $colgroup;
1494 $colgroup = "";
1495 }
1496 return ($collection, $colgroup);
1497}
1498
1499# work out the "collectdir/collection" location
1500sub resolve_collection_dir {
1501 my ($collect_dir, $qualified_collection, $site) = @_; #, $gs_mode
1502
1503 if (defined $ENV{'GSDLCOLLECTDIR'}) { # a predefined collection dir exists
1504 return $ENV{'GSDLCOLLECTDIR'};
1505 }
1506
1507 my ($colgroup, $collection) = &util::get_collection_parts($qualified_collection);
1508
1509 if (!defined $collect_dir || !$collect_dir) { # if undefined or empty string
1510 $collect_dir = &util::get_working_collect_dir($site);
1511 }
1512
1513 return &FileUtils::filenameConcatenate($collect_dir,$colgroup,$collection);
1514}
1515
1516# work out the full path to "collect" of this greenstone 2/3 installation
1517sub get_working_collect_dir {
1518 my ($site) = @_;
1519
1520 if (defined $ENV{'GSDLCOLLECTHOME'}) { # a predefined collect dir exists
1521 return $ENV{'GSDLCOLLECTHOME'};
1522 }
1523
1524 if (defined $site && $site) { # site non-empty, so get default collect dir for GS3
1525
1526 if (defined $ENV{'GSDL3HOME'}) {
1527 return &FileUtils::filenameConcatenate($ENV{'GSDL3HOME'},"sites",$site,"collect"); # web folder
1528 }
1529 elsif (defined $ENV{'GSDL3SRCHOME'}) {
1530 return &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'},"web","sites",$site,"collect");
1531 }
1532 }
1533
1534 elsif (defined $ENV{'SITEHOME'}) {
1535 return &FileUtils::filenameConcatenate($ENV{'SITEHOME'},"collect");
1536 }
1537
1538 else { # get default collect dir for GS2
1539 return &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"collect");
1540 }
1541}
1542
1543sub is_abs_path_any_os {
1544 my ($path) = @_;
1545
1546 # We can have filenames in our DBs that were produced on other OS, so this method exists
1547 # to help identify absolute paths in such cases.
1548
1549 return 1 if($path =~ m@^/@); # full paths begin with forward slash on linux/mac
1550 return 1 if($path =~ m@^([a-zA-Z]\:|\\)@); # full paths begin with drive letter colon for Win or \ for volume, http://stackoverflow.com/questions/13011013/get-only-volume-name-from-filepath
1551
1552 return 0;
1553}
1554
1555
1556# This subroutine is for improving portability of Greenstone collections from one OS to another,
1557# to be used to convert absolute paths going into db files into paths with placeholders instead.
1558# This sub works with util::get_common_gs_paths and takes a path to a greenstone file and, if it's
1559# an absolute path, then it will replace the longest matching greenstone-path prefix of the given
1560# path with a placeholder to match.
1561# The Greenstone-path prefixes that can be matched are the following common Greenstone paths:
1562# the path to the current (specific) collection, the path to the general GS collect directory,
1563# the path to the site directory if GS3, else the path to the GSDLHOME/GSDL3HOME folder.
1564# The longest matching prefix will be replaced with the equivalent placeholder:
1565# @THISCOLLECTPATH@, else @COLLECTHOME@, else @SITEHOME@, else @GSDLHOME@.
1566sub abspath_to_placeholders {
1567 my $path = shift(@_); # path to convert from absolute to one with placeholders
1568 my $opt_long_or_short_winfilenames = shift(@_) || "short"; # whether we want to force use of long file names even on windows, default uses short
1569
1570 return $path unless is_abs_path_any_os($path); # path is relative
1571
1572 if ($opt_long_or_short_winfilenames eq "long") {
1573 $path = &util::upgrade_if_dos_filename($path); # will only do something on windows
1574 }
1575
1576 # now we know we're dealing with absolute paths and have to replace gs prefixes with placeholders
1577 my @gs_paths = ($ENV{'GSDLCOLLECTDIR'}, $ENV{'GSDLCOLLECTHOME'}, $ENV{'SITEHOME'}, $ENV{'GREENSTONEHOME'}); # list in this order: from longest to shortest path
1578
1579 my %placeholder_map = ($ENV{'GREENSTONEHOME'} => '@GSDLHOME@', # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
1580 $ENV{'GSDLCOLLECTHOME'} => '@COLLECTHOME@',
1581 $ENV{'GSDLCOLLECTDIR'} => '@THISCOLLECTPATH@'
1582 );
1583 $placeholder_map{$ENV{'SITEHOME'}} = '@SITEHOME@' if defined $ENV{'SITEHOME'};
1584
1585 $path = &util::_abspath_to_placeholders($path, \@gs_paths, \%placeholder_map);
1586
1587 if ($ENV{'GSDLOS'} =~ /^windows$/i && $opt_long_or_short_winfilenames eq "short") {
1588 # for windows need to look for matches on short file names too
1589 # matched paths are again to be replaced with the usual placeholders
1590
1591 my $gsdlcollectdir = &util::downgrade_if_dos_filename($ENV{'GSDLCOLLECTDIR'});
1592 my $gsdlcollecthome = &util::downgrade_if_dos_filename($ENV{'GSDLCOLLECTHOME'});
1593 my $sitehome = (defined $ENV{'SITEHOME'}) ? &util::downgrade_if_dos_filename($ENV{'SITEHOME'}) : undef;
1594 my $greenstonehome = &util::downgrade_if_dos_filename($ENV{'GREENSTONEHOME'});
1595
1596 @gs_paths = ($gsdlcollectdir, $gsdlcollecthome, $sitehome, $greenstonehome); # order matters
1597
1598 %placeholder_map = ($greenstonehome => '@GSDLHOME@', # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
1599 $gsdlcollecthome => '@COLLECTHOME@',
1600 $gsdlcollectdir => '@THISCOLLECTPATH@'
1601 );
1602 $placeholder_map{$sitehome} = '@SITEHOME@' if defined $sitehome;
1603
1604 $path = &util::_abspath_to_placeholders($path, \@gs_paths, \%placeholder_map);
1605 }
1606
1607 return $path;
1608}
1609
1610sub _abspath_to_placeholders {
1611 my ($path, $gs_paths_ref, $placeholder_map_ref) = @_;
1612
1613 # The sequence of elements in @gs_paths matters
1614 # Need to loop starting from the *longest* matching path (the path to the specific collection)
1615 # to the shortest matching path (the path to gsdlhome/gsdl3home folder):
1616
1617 foreach my $gs_path (@$gs_paths_ref) {
1618 next if(!defined $gs_path); # site undefined for GS2
1619
1620 my $re_path = &util::filename_to_regex($gs_path); # escape for regex
1621
1622 if($path =~ m/^$re_path/i) { # case sensitive or not for OS?
1623
1624 my $placeholder = $placeholder_map_ref->{$gs_path}; # get the placeholder to replace the matched path with
1625
1626 $path =~ s/^$re_path/$placeholder/; #case sensitive or not?
1627 #$path =~ s/^[\\\/]//; # remove gs_path's trailing separator left behind at the start of the path
1628 # lowercase file extension, This is needed when shortfilenames are used, as case affects alphetical ordering, which affects diffcol
1629 $path =~ s/\.([A-Z]+)$/".".lc($1)/e;
1630 last; # done
1631 }
1632 }
1633
1634 return $path;
1635}
1636
1637# Function that does the reverse of the util::abspath_to_placeholders subroutine
1638# Once again, call this with the values returned from util::get_common_gs_paths
1639sub placeholders_to_abspath {
1640 my $path = shift(@_); # path that can contain placeholders to convert to resolved absolute path
1641 my $opt_long_or_short_winfilenames = shift(@_) || "short"; # whether we want to force use of long file names even on windows, default uses short
1642
1643 return $path if($path !~ m/@/); # path contains no placeholders
1644
1645 # replace placeholders with gs prefixes
1646 my @placeholders = ('@THISCOLLECTPATH@', '@COLLECTHOME@', '@SITEHOME@', '@GSDLHOME@'); # order of paths not crucial in this case,
1647 # but listed here from longest to shortest once placeholders are have been resolved
1648
1649 # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
1650 my %placeholder_to_gspath_map;
1651 if ($ENV{'GSDLOS'} =~ /^windows$/i && $opt_long_or_short_winfilenames eq "short") {
1652 # always replace placeholders with short file names of the absolute paths on windows?
1653 %placeholder_to_gspath_map = ('@GSDLHOME@' => &util::downgrade_if_dos_filename($ENV{'GREENSTONEHOME'}),
1654 '@COLLECTHOME@' => &util::downgrade_if_dos_filename($ENV{'GSDLCOLLECTHOME'}),
1655 '@THISCOLLECTPATH@' => &util::downgrade_if_dos_filename($ENV{'GSDLCOLLECTDIR'})
1656 );
1657 $placeholder_to_gspath_map{'@SITEHOME@'} = &util::downgrade_if_dos_filename($ENV{'SITEHOME'}) if defined $ENV{'SITEHOME'};
1658 } else {
1659 %placeholder_to_gspath_map = ('@GSDLHOME@' => $ENV{'GREENSTONEHOME'},
1660 '@SITEHOME@' => $ENV{'SITEHOME'}, # can be undef
1661 '@COLLECTHOME@' => $ENV{'GSDLCOLLECTHOME'},
1662 '@THISCOLLECTPATH@' => $ENV{'GSDLCOLLECTDIR'}
1663 ); # $placeholder_to_gspath_map{'@SITEHOME@'} = $ENV{'SITEHOME'} if defined $ENV{'SITEHOME'};
1664 }
1665
1666 foreach my $placeholder (@placeholders) {
1667 my $gs_path = $placeholder_to_gspath_map{$placeholder};
1668
1669 next if(!defined $gs_path); # sitehome for GS2 is undefined
1670
1671 if($path =~ m/^$placeholder/) {
1672 $path =~ s/^$placeholder/$gs_path/;
1673 last; # done
1674 }
1675 }
1676
1677 return $path;
1678}
1679
1680# Used by pdfpstoimg.pl and PDFBoxConverter to create a .item file from
1681# a directory containing sequentially numbered images.
1682sub create_itemfile
1683{
1684 my ($output_dir, $convert_basename, $convert_to) = @_;
1685 my $page_num = "";
1686
1687 opendir(DIR, $output_dir) || die "can't opendir $output_dir: $!";
1688 my @dir_files = grep {-f "$output_dir/$_"} readdir(DIR);
1689 closedir DIR;
1690
1691 # Sort files in the directory by page_num
1692 sub page_number {
1693 my ($dir) = @_;
1694 my ($pagenum) =($dir =~ m/^.*?[-\.]?(\d+)(\.(jpg|gif|png))?$/i);
1695# my ($pagenum) =($dir =~ m/(\d+)(\.(jpg|gif|png))?$/i); # this works but is not as safe/strict about input filepatterns as the above
1696
1697 $pagenum = 1 unless defined $pagenum;
1698 return $pagenum;
1699 }
1700
1701 # sort the files in the directory in the order of page_num rather than lexically.
1702 @dir_files = sort { page_number($a) <=> page_number($b) } @dir_files;
1703
1704 # work out if the numbering of the now sorted image files starts at 0 or not
1705 # by checking the number of the first _image_ file (skipping item files)
1706 my $starts_at_0 = 0;
1707 my $firstfile = ($dir_files[0] !~ /\.item$/i) ? $dir_files[0] : $dir_files[1];
1708 if(page_number($firstfile) == 0) { # 00 will evaluate to 0 too in this condition
1709 $starts_at_0 = 1;
1710 }
1711
1712 my $item_file = &FileUtils::filenameConcatenate($output_dir, $convert_basename.".item");
1713 my $item_fh;
1714 &FileUtils::openFileHandle($item_file, 'w', \$item_fh);
1715 print $item_fh "<PagedDocument>\n";
1716
1717 foreach my $file (@dir_files){
1718 if ($file !~ /\.item/i){
1719 $page_num = page_number($file);
1720 $page_num++ if $starts_at_0; # image numbers start at 0, so add 1
1721 print $item_fh " <Page pagenum=\"$page_num\" imgfile=\"$file\" txtfile=\"\"/>\n";
1722 }
1723 }
1724
1725 print $item_fh "</PagedDocument>\n";
1726 &FileUtils::closeFileHandle($item_file, \$item_fh);
1727 return $item_file;
1728}
1729
1730# Sets the gnomelib_env. Based on the logic in wvware.pl which can perhaps be replaced with a call to this function in future
1731sub set_gnomelib_env
1732{
1733 ## SET THE ENVIRONMENT AS DONE IN SETUP.BASH/BAT OF GNOME-LIB
1734 # Though this is only needed for darwin Lion at this point (and android, though that is untested)
1735
1736 my $libext = "so";
1737 if ($ENV{'GSDLOS'} =~ m/^windows$/i) {
1738 return;
1739 } elsif ($ENV{'GSDLOS'} =~ m/^darwin$/i) {
1740 $libext = "dylib";
1741 }
1742
1743 if (!defined $ENV{'GEXTGNOME'}) {
1744 ##print STDERR "@@@ Setting GEXTGNOME env\n";
1745
1746 my $gnome_dir = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"ext","gnome-lib-minimal");
1747
1748 if(! -d $gnome_dir) {
1749 $gnome_dir = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'},"ext","gnome-lib");
1750
1751 if(! -d $gnome_dir) {
1752 $gnome_dir = "";
1753 }
1754 }
1755
1756 # now set other the related env vars,
1757 # IF we've found the gnome-lib dir installed in the ext folder
1758
1759 if ($gnome_dir ne "" && -f &FileUtils::filenameConcatenate($gnome_dir, $ENV{'GSDLOS'}, "lib", "libiconv.$libext")) {
1760 $ENV{'GEXTGNOME'} = $gnome_dir;
1761 $ENV{'GEXTGNOME_INSTALLED'}=&FileUtils::filenameConcatenate($ENV{'GEXTGNOME'}, $ENV{'GSDLOS'});
1762
1763 my $gnomelib_bin = &FileUtils::filenameConcatenate($ENV{'GEXTGNOME_INSTALLED'}, "bin");
1764 if(-d $gnomelib_bin) { # no bin subfolder in GS binary's cutdown gnome-lib-minimal folder
1765 &util::envvar_prepend("PATH", $gnomelib_bin);
1766 }
1767
1768 # util's prepend will create LD/DYLD_LIB_PATH if it doesn't exist yet
1769 my $gextlib = &FileUtils::filenameConcatenate($ENV{'GEXTGNOME_INSTALLED'}, "lib");
1770
1771 if($ENV{'GSDLOS'} eq "linux") {
1772 &util::envvar_prepend("LD_LIBRARY_PATH", $gextlib);
1773 }
1774 elsif ($ENV{'GSDLOS'} eq "darwin") {
1775 #&util::envvar_prepend("DYLD_LIBRARY_PATH", $gextlib);
1776 &util::envvar_prepend("DYLD_FALLBACK_LIBRARY_PATH", $gextlib);
1777 }
1778 }
1779
1780 # Above largely mimics the setup.bash of the gnome-lib-minimal.
1781 # Not doing the devel-srcpack that gnome-lib-minimal's setup.bash used to set
1782 # Not exporting GSDLEXTS variable either
1783 }
1784
1785# print STDERR "@@@@@ GEXTGNOME: ".$ENV{'GEXTGNOME'}."\n\tINSTALL".$ENV{'GEXTGNOME_INSTALLED'}."\n";
1786# print STDERR "\tPATH".$ENV{'PATH'}."\n";
1787# print STDERR "\tLD_LIB_PATH".$ENV{'LD_LIBRARY_PATH'}."\n" if $ENV{'LD_LIBRARY_PATH};
1788# print STDERR "\tDYLD_FALLBACK_LIB_PATH".$ENV{'DYLD_FALLBACK_LIBRARY_PATH'}."\n" if $ENV{'DYLD_FALLBACK_LIBRARY_PATH};
1789
1790 # if no GEXTGNOME, maybe users didn't need gnome-lib to run gnomelib/libiconv dependent binaries like hashfile, suffix, wget
1791 # (wvware is launched in a gnomelib env from its own script, but could possibly go through this script in future)
1792}
1793
1794
1795
1796## @function augmentINC()
1797#
1798# Prepend a path (if it exists) onto INC but only if it isn't already in INC
1799# @param $new_path The path to add
1800# @author jmt12
1801#
1802sub augmentINC
1803{
1804 my ($new_path) = @_;
1805 my $did_add_path = 0;
1806 # might need to be replaced with FileUtils::directoryExists() call eventually
1807 if (-d $new_path)
1808 {
1809 my $did_find_path = 0;
1810 foreach my $existing_path (@INC)
1811 {
1812 if ($existing_path eq $new_path)
1813 {
1814 $did_find_path = 1;
1815 last;
1816 }
1817 }
1818 if (!$did_find_path)
1819 {
1820 unshift(@INC, $new_path);
1821 $did_add_path = 1;
1822 }
1823 }
1824 return $did_add_path;
1825}
1826## augmentINC()
1827
1828
18291;
Note: See TracBrowser for help on using the repository browser.