Changeset 37034

Timestamp:

2022-12-17T11:57:05+13:00 (6 months ago)

Author:

davidb

Message:

Introduction of new (internal) general purpose recursive file/dir copy. In a later phase, the existing public subroutines will be changed over to using it

File:

• main/trunk/greenstone2/perllib/FileUtils.pm (modified) (1 diff)

main/trunk/greenstone2/perllib/FileUtils.pm

@@ -167 +167 @@
 
 
+## @function readdirFullpath()
+#
+# For the given input directory, return full-path versions of the
+# files and directories it contains
+#
+# returned data is in the form of the tuple (status, fullpath-listing)
+#
+
+sub readdirFullpath
+{
+    my ($src_dir_fullpath,$options) = @_;
+
+    my $ret_val = 1; # assume things will work out!
+    my $fullpath_files_and_dirs = [];
+
+    my $exclude_filter_re = undef;
+    my $include_filter_re = undef;
+    if (defined $options) {
+    $exclude_filter_re = $options->{'exclude_filter_re'};
+    $include_filter_re = $options->{'include_filter_re'};
+    }
+    
+    # get the contents of this directory
+    if (!opendir(INDIR, $src_dir_fullpath))
+    {
+    print STDERR "FileUtils::readdirFullpath() could not open directory $src_dir_fullpath\n";
+    $ret_val = 0;   
+    }
+    else
+    {
+    my @next_files_and_dirs = readdir(INDIR);
+    closedir (INDIR);
+
+    foreach my $f_or_d (@next_files_and_dirs)
+    {
+        next if $f_or_d =~ /^\.\.?$/;
+        next if (defined $exclude_filter_re && ($f_or_d =~ m/$exclude_filter_re/));
+        
+        if ((!defined $include_filter_re) || ($f_or_d =~ m/$include_filter_re/)) {
+        my $ff_or_dd = &filenameConcatenate($src_dir_fullpath, $f_or_d);
+        push(@$fullpath_files_and_dirs,$ff_or_dd);
+        }
+    }
+
+    }
+
+    return ($ret_val,$fullpath_files_and_dirs);
+}
+
+
+            
+## @function _copyFilesRecursiveGeneral()
+#
+# internal support routine for recursively copying or hard-linking files
+#
+sub _copyFilesRecursiveGeneral
+{
+    my ($srcfiles_ref,$dest,$depth,$options) = @_;
+
+    # a few sanity checks
+    my $num_src_files = scalar (@$srcfiles_ref);
+    
+    if ($num_src_files == 0)
+    {
+    print STDERR "FileUtils::copyFilesRecursive() no destination directory given\n";
+    return 0;
+    }
+    elsif (-f $dest)
+    {
+    print STDERR "FileUtils::copyFilesRecursive() destination must be a directory\n";
+    return 0;
+    }
+
+    if ($depth == 0) {
+    # Test for the special (top-level) case where:
+    #   there is only one src file
+    #   it is a directory
+    #   and dest as a directory does not exits
+    #
+    # => This is a case similar to something like cp -r abc/ def/
+    #    where we *don't* want abc ending up inside def
+    
+    
+    if ($num_src_files == 1) {
+        
+        my $src_first_fullpath = $srcfiles_ref->[0];
+
+        if (-d $src_first_fullpath) {
+        my $src_dir_fullpath = $src_first_fullpath;
+
+        if (! -e $dest) {
+            # Do slight of hand, and replace the supplied single src_dir_fullpath with the contents of
+            # that directory
+
+            my ($readdir_status, $fullpath_subfiles_and_subdirs) = &readdirFullpath($src_dir_fullpath,$options);
+            
+            if (!$readdir_status) {
+            return 0;
+            }
+            else
+            {
+            $srcfiles_ref = $fullpath_subfiles_and_subdirs;    
+            }
+        }
+        }
+    }
+    }
+
+
+    # create destination directory if it doesn't exist already
+    if (! -d $dest)
+    {
+    my $store_umask = umask(0002);
+    my $mkdir_status = mkdir($dest, 0777);
+    
+    if (!$mkdir_status) {
+        print STDERR "$!\n";
+        print STDERR "FileUtils::_copyFilesRecursiveGeneral() failed to create directory $dest\n";
+        umask($store_umask);
+        
+        return 0;
+    }
+    umask($store_umask);
+    }
+
+    
+    # copy the files
+    foreach my $file (@$srcfiles_ref)
+    {
+    if (! -e $file)
+    {
+        print STDERR "FileUtils::_copyFilesRecursiveGeneral() $file does not exist\n";
+        # wrap up in strict option check
+        return 0;
+    }
+    elsif (-d $file)
+    {
+        my $src_dir_fullpath = $file; # know by this point that $file is actually a sub-directory
+
+        # make the new directory
+        my ($src_dirname_tail) = $src_dir_fullpath =~ /([^\\\/]*)$/;
+
+        my $next_dest = &filenameConcatenate($dest, $src_dirname_tail);
+        my $store_umask = umask(0002);
+        mkdir ($next_dest, 0777);
+        umask($store_umask);
+
+        my ($readdir_status, $fullpath_src_subfiles_and_subdirs) = &readdirFullpath($src_dir_fullpath,$options);
+
+        if (!$readdir_status) {
+        return 0;
+        }
+        else {
+
+        foreach my $fullpath_subf_or_subd (@$fullpath_src_subfiles_and_subdirs)
+        {
+            # Recursively copy all the files/dirs in this directory:
+            #   In the general version need the source argument to be a reference to an array
+            my $ret_val = &_copyFilesRecursiveGeneral([$fullpath_subf_or_subd],$next_dest, $depth+1, $options);
+
+            if ($ret_val == 0) {
+            # Error condition encountered
+            return 0;
+            }
+        }
+        }
+        
+#       # get the contents of this directory
+#       if (!opendir(INDIR, $src_dir_fullpath))
+#       {
+#       print STDERR "FileUtils::_copyFilesRecursiveGeneral() could not open directory $src_dir_fullpath\n";
+#       }
+#       else
+#       {
+#       my @next_files_and_dirs = readdir(INDIR);
+#       closedir (INDIR);
+#       foreach my $f_or_d (@next_files_and_dirs)
+#       {
+#           next if $f_or_d =~ /^\.\.?$/;
+#           # recursively copy all the files/dirs in this directory
+#           my $ff_or_dd = &filenameConcatenate($src_dir_fullpath, $f_or_d);
+#           # In the general version need the source argument to be a reference to an array
+#           my $ret_val = &_copyFilesRecursiveGeneral($next_dest, [ $ff_or_dd ], $options);
+#
+#           if ($ret_val == 0) {
+#           # Error condition encountered
+#           return 0;
+#           }
+#       }
+#       }
+        
+    }
+    else
+    {
+        &copyFiles($file, $dest);
+    }
+    }
+
+    return 1;
+}
+## _copyFilesRecursiveGeneral()
+
+
+
 ## @function copyFilesRecursive()
 #