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

Last change on this file since 30021 was 30021, checked in by ak19, 9 years ago

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