--- loncom/interface/lonclonecourse.pm	2006/08/11 22:00:08	1.1
+++ loncom/interface/lonclonecourse.pm	2022/03/25 06:42:17	1.18
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # routines for clone a course
 #
-# $Id: lonclonecourse.pm,v 1.1 2006/08/11 22:00:08 albertel Exp $
+# $Id: lonclonecourse.pm,v 1.18 2022/03/25 06:42:17 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -30,6 +30,9 @@
 package Apache::lonclonecourse;
 use LONCAPA;
 use Apache::lonnet;
+use Apache::lonlocal;
+use DateTime();
+use DateTime::TimeZone;
 
 # ================================================ Get course directory listing
 
@@ -47,21 +50,24 @@ sub innercrsdirlist {
     unless ($which) { $which=''; } else { $which.='/'; }
     unless ($path)  { $path=''; } else { $path.='/'; }
     my %crsdata=&Apache::lonnet::coursedescription($courseid);
-    my @listing=&Apache::lonnet::dirlist
-	($which,$crsdata{'domain'},$crsdata{'num'},
-	 &propath($crsdata{'domain'},$crsdata{'num'}));
-    foreach (@listing) {
-	unless ($_=~/^\./) {
-	    my @unpackline = split (/\&/,$_);
-	    if ($unpackline[3]&$dirptr) {
+    my $getpropath = 1;
+    my ($dirlistref,$listerror) = 
+        &Apache::lonnet::dirlist($which,$crsdata{'domain'},
+                                 $crsdata{'num'},$getpropath);
+    if (ref($dirlistref) eq 'ARRAY') {
+        foreach (@{$dirlistref}) {
+	    unless ($_=~/^\./) {
+	        my @unpackline = split (/\&/,$_);
+	        if ($unpackline[3]&$dirptr) {
 # is a directory, recurse
-		&innercrsdirlist($courseid,$which.$unpackline[0],
-				            $path.$unpackline[0]);
-	    } else { 
+		    &innercrsdirlist($courseid,$which.$unpackline[0],
+				     $path.$unpackline[0]);
+	        } else { 
 # is a file, put into output
-		push (@output,$path.$unpackline[0]);
+		    push (@output,$path.$unpackline[0]);
+	        }
 	    }
-	}
+        }
     }
     return @output;
 }
@@ -84,7 +90,6 @@ sub writefile {
     my $data = &Apache::lonnet::finishuserfileupload(
 					  $crsdata{'num'},$crsdata{'domain'},
 					  'output',$which);
-    &Apache::lonnet::logthis("gor $data $crsdata{'num'} $crsdata{'domain'}");
     return $data;
 }
 
@@ -92,11 +97,9 @@ sub writefile {
 
 sub rewritefile {
     my ($contents,%rewritehash)=@_;
-    foreach (keys %rewritehash) {
-	my $pattern=$_;
-	$pattern=~s/(\W)/\\$1/gs;
-	my $new=$rewritehash{$_};
-	$contents=~s/$pattern/$new/gs;
+    foreach my $pattern (keys(%rewritehash)) {
+	my $new=$rewritehash{$pattern};
+	$contents=~s/\Q$pattern\E/$new/gs;
     }
     return $contents;
 }
@@ -105,7 +108,7 @@ sub rewritefile {
 
 sub copyfile {
     my ($origcrsid,$newcrsid,$which)=@_;
-    unless ($which=~/\.sequence$/) {
+    unless ($which=~/\.(page|sequence)$/) {
 	return &writefile($newcrsid,$which,
 		      &readfile($origcrsid,$which));
     } else {
@@ -118,7 +121,9 @@ sub copyfile {
        '/uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'
     => '/uploaded/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/',
        '/public/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'
-    => '/public/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/'
+    => '/public/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/',
+       '/adm/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'
+    => '/adm/'.$newcrsdata{'domain'}.'/'.$newcrsdata{'num'}.'/',
             )));
     }
 }
@@ -126,25 +131,142 @@ sub copyfile {
 # =============================================================== Copy a dbfile
 
 sub copydb {
-    my ($origcrsid,$newcrsid,$which)=@_;
+    my ($origcrsid,$newcrsid,$which,$newinstcode,$newowner,$tinyurls)=@_;
     $which=~s/\.db$//;
     my %origcrsdata=&Apache::lonnet::coursedescription($origcrsid);
     my %newcrsdata= &Apache::lonnet::coursedescription($newcrsid);
+    if (($which eq 'tiny') && ($tinyurls eq 'delete')) {
+        return ();
+    }
+    my @info;
     my %data=&Apache::lonnet::dump
 	($which,$origcrsdata{'domain'},$origcrsdata{'num'});
     foreach my $key (keys(%data)) {
 	if ($key=~/^internal./) { delete($data{$key}); }
     }
-    return &Apache::lonnet::put
-	($which,\%data,$newcrsdata{'domain'},$newcrsdata{'num'});
+    if ($which =~ /^exttool_\d+$/) {
+        if ($origcrsdata{'description'} ne $newcrsdata{'description'}) {
+            $data{'crstitle'} =~s/\Q$origcrsdata{'description'}\E/$newcrsdata{'description'}/;
+        }
+        if ($origcrsdata{'internal.coursecode'} ne $newinstcode) {
+            $data{'crslabel'} =~ s/\Q$origcrsdata{'internal.coursecode'}\E/$newinstcode/;
+        }
+    } elsif ($which eq 'tiny') {
+        my $oldprefix = 'uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/';
+        my $newprefix = 'uploaded/'.$newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/';
+        my (%domtiny,%tocreate,@todelete,$numnew,$errors);
+        if (($tinyurls eq 'transfer') && (keys(%data))) {
+            unless (($origcrsdata{'internal.courseowner'} eq $newowner) &&
+                    ($origcrsdata{'domain'} eq $newcrsdata{'domain'})) {
+                $tinyurls = 'create';
+                push(@info,{
+                             mt => "Action for URL shortcut(s) changed from 'transfer' to 'create' ".
+                                   "because requirements of same owner and some course domain ".
+                                   "for new course and original course not met.",
+                             args => [],
+                           });
+            }
+        }
+        foreach my $key (keys(%data)) {
+            my $code = $data{$key};
+            my $newkey = $key;
+            $newkey =~ s{\Q$oldprefix\E}{$newprefix}g;
+            if ($tinyurls eq 'transfer') {
+                $data{$newkey} = $code;
+                $domtiny{$code} = $newcrsdata{'num'}.'&'.$newkey;
+                push(@todelete,$key);
+            } else {
+                $tocreate{$newcrsdata{'num'}.'&'.$newkey} = 1;
+            }
+            delete($data{$key});
+        }
+        if (keys(%tocreate)) {
+            ($numnew,$errors) = &Apache::loncommon::make_short_symbs($newcrsdata{'domain'},
+                                                                     $newcrsdata{'num'},
+                                                                     \%tocreate,$newowner);
+            if ((ref($errors) eq 'ARRAY') && (@{$errors} > 0)) {
+                push(@info,{
+                            mt => 'Error(s) when creating URL shortcut(s) in new course for equivalent '.
+                                  'resource(s)/folder(s) in original course: [_1]',
+                            args => [join(', ',@{$errors})],
+                           });
+            }
+            if ($numnew) {
+                push(@info,{
+                            mt => 'New URL shortcut(s) in new course for [quant,_1,item] to replicate '.
+                                  'shortcut(s) for equivalent(s) in original course.',
+                            args => [$numnew],
+                           });
+            }
+            return @info;
+        } elsif (keys(%domtiny)) {
+            my $configuname = &Apache::lonnet::get_domainconfiguser($newcrsdata{'domain'});
+            my $putdomres = &Apache::lonnet::put('tiny',\%domtiny,$newcrsdata{'domain'},$configuname);
+            if ($putdomres eq 'ok') {
+                my $delres = &Apache::lonnet::del('tiny',\@todelete,
+                                                 $origcrsdata{'domain'},
+                                                 $origcrsdata{'num'});
+
+                if ($delres eq 'ok') {
+                    push(@info,{
+                                 mt => 'URL shortcut(s) for [quant,_1,item] transferred, and '.
+                                       'now point to resource(s)/folder(s) in new course instead of '.
+                                       'equivalent(s) in original course.',
+                                 args => [scalar(keys(%domtiny))],
+                               });
+                } else {
+                    push(@info,{
+                                 mt => 'Failed to delete URL shortcut(s) in original course '.
+                                       'when attempting to transfer to new course.',
+                                 args => [],
+                               });
+                }
+            } else {
+                push(@info,{
+                              mt => 'Failed to store update of target course for URL shortcut(s) in '.
+                                    'domain records.',
+                              args => [],
+                           });
+                return @info;
+            }
+        }
+    } elsif ($which eq 'lti') {
+        foreach my $key (keys(%data)) {
+            if (ref($data{$key}) eq 'HASH') {
+                if (exists($data{$key}{'usable'})) {
+                    delete($data{$key}{'usable'});
+                }
+            }
+        }
+    }
+    my $putres = &Apache::lonnet::put
+                     ($which,\%data,$newcrsdata{'domain'},$newcrsdata{'num'});
+    return @info;
 }
 
 # ========================================================== Copy resourcesdata
 
 sub copyresourcedb {
-    my ($origcrsid,$newcrsid)=@_;
+    my ($origcrsid,$newcrsid,$date_mode,$date_shift)=@_;
+    my $delta=$date_shift*60*60*24;
     my %origcrsdata=&Apache::lonnet::coursedescription($origcrsid);
     my %newcrsdata= &Apache::lonnet::coursedescription($newcrsid);
+    my $origtz;
+    if (($date_mode) && ($date_mode ne 'preserve') && ($date_shift) && 
+        (int($date_shift) == $date_shift)) {
+        $origtz = $origcrsdata{'timezone'};
+        if ($origtz eq '') {
+            my %domdefaults = &Apache::lonnet::get_domain_defaults($origcrsdata{'domain'});
+            if ($domdefaults{'timezone_def'} ne '') {
+                $origtz = $domdefaults{'timezone_def'};
+            }
+        }
+        if ($origtz eq '') {
+            $origtz = 'local';
+        } elsif (!DateTime::TimeZone->is_valid_name($origtz)) {
+            $origtz = 'local';
+        }
+    }
     my %data=&Apache::lonnet::dump
 	('resourcedata',$origcrsdata{'domain'},$origcrsdata{'num'});
     $origcrsid=~s/^\///;
@@ -162,48 +284,60 @@ sub copyresourcedb {
 
 	$startdate = $start{'default_enrollment_start_date'};
     }
-    my $today=time;
-    my $delta=0;
-    if ($startdate) {
-	my $oneday=60*60*24;
-	$delta=$today-$startdate;
-	$delta=int($delta/$oneday)*$oneday;
-    }
 # ugly retro fix for broken version of types
-    foreach (keys %data) {
-	if ($_=~/\wtype$/) {
-	    my $newkey=$_;
+    foreach my $key (keys(%data)) {
+	if ($key=~/\wtype$/) {
+	    my $newkey=$key;
 	    $newkey=~s/type$/\.type/;
-	    $data{$newkey}=$data{$_};
-	    delete $data{$_};
+	    $data{$newkey}=$data{$key};
+	    delete $data{$key};
 	}
     }
 # adjust symbs
     my $pattern='uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/';
-    $pattern=~s/(\W)/\\$1/gs;
     my $new=    'uploaded/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/';
-    foreach (keys %data) {
-	if ($_=~/$pattern/) {
-	    my $newkey=$_;
-	    $newkey=~s/$pattern/$new/;
-	    $data{$newkey}=$data{$_};
-	    delete $data{$_};
+    foreach my $key (keys(%data)) {
+	if ($key=~/\Q$pattern\E/) {
+	    my $newkey=$key;
+	    $newkey=~s/\Q$pattern\E/$new/;
+	    $data{$newkey}=$data{$key};
+	    delete $data{$key};
 	}
     }
-# adjust dates
-    foreach (keys %data) {
-	my $thiskey=$_;
+#  transfer hash
+    foreach my $key (keys(%data)) {
+	my $thiskey=$key;
 	$thiskey=~s/^$origcrsid/$newcrsid/;
-	$newdata{$thiskey}=$data{$_};
-	if ($data{$_.'.type'}=~/^date_(start|end)$/) {
-	    if ($delta > 0) {
-		$newdata{$thiskey}=$newdata{$thiskey}+$delta;
-	    } else {
-		# no delta, it's unlikely we want the old dates and times
-		delete($newdata{$thiskey});
-		delete($newdata{$thiskey.'.type'});
-	    }
-	}
+	$newdata{$thiskey}=$data{$key};
+# date_mode empty or "preserve": transfer dates one-to-one
+# date_mode "shift": shift dates by date_shift days
+# date_mode other: do not transfer dates
+        if (($date_mode) && ($date_mode ne 'preserve')) {
+	    if ($data{$key.'.type'}=~/^date_(start|end)$/) {
+	        if ($date_mode eq 'shift') {
+                    if (($date_shift) && ($date_shift == int($date_shift))) { 
+                        my $dt = DateTime->from_epoch(epoch => $newdata{$thiskey})
+                                                      ->set_time_zone($origtz);
+                        if (($origtz eq 'local') && (!$ENV{TZ})) {
+                            $ENV{TZ} = $dt->time_zone()->name();
+                        }
+                        eval {
+                            $dt->add(days => int($date_shift));
+                        };
+                        if ($@) {
+                            $newdata{$thiskey} = $newdata{$thiskey}+$delta+(60*60);
+                        } else {
+                            $newdata{$thiskey} = $dt->epoch();
+                        }
+                    } else {
+                        $newdata{$thiskey} = $newdata{$thiskey}+$delta;
+                    }
+                } else {
+                    delete($newdata{$thiskey});
+                    delete($newdata{$thiskey.'.type'});
+                }
+            }
+        }
     }
     return &Apache::lonnet::put
 	('resourcedata',\%newdata,$newcrsdata{'domain'},$newcrsdata{'num'});
@@ -218,31 +352,41 @@ sub copyuserfiles {
 	    &copyfile($origcrsid,$newcrsid,$_);
 	}
     }
+    return;
 }
 # ========================================================== Copy all userfiles
 
 sub copydbfiles {
-    my ($origcrsid,$newcrsid)=@_;
+    my ($origcrsid,$newcrsid,$newinstcode,$newowner,$tinyurls)=@_;
+    my @copyinfo;
 
     my ($origcrs_discussion) = ($origcrsid=~m|^/(.*)|);
     $origcrs_discussion=~s|/|_|g;
     foreach (&crsdirlist($origcrsid)) {
-	if ($_=~/\.db$/) {
-	    unless 
-             ($_=~/^(nohist\_|discussiontimes|classlist|versionupdate|resourcedata|\Q$origcrs_discussion\E|slots|slot_reservations|gradingqueue|reviewqueue|CODEs|groupmembership)/) {
-		 &copydb($origcrsid,$newcrsid,$_);
-	     }
-	}
+        if ($_=~/\.db$/) {
+            unless ($_=~/^(nohist\_|disclikes|discussiontimes|classlist|versionupdate
+                   |resourcedata|\Q$origcrs_discussion\E|slots|slot_reservations
+                   |gradingqueue|reviewqueue|CODEs|groupmembership|comm_block)/) {
+                my @info = &copydb($origcrsid,$newcrsid,$_,$newinstcode,$newowner,
+                                   $tinyurls);
+                if (@info) {
+                    push(@copyinfo,@info);
+                }
+            }
+        }
     }
+    return @copyinfo;
 }
 
 # ======================================================= Copy all course files
 
 sub copycoursefiles {
-    my ($origcrsid,$newcrsid)=@_;
+    my ($origcrsid,$newcrsid,$date_mode,$date_shift,$newinstcode,$newowner,
+        $tinyurls)=@_;
     &copyuserfiles($origcrsid,$newcrsid);
-    &copydbfiles($origcrsid,$newcrsid);
-    &copyresourcedb($origcrsid,$newcrsid);
+    my @info = &copydbfiles($origcrsid,$newcrsid,$newinstcode,$newowner,$tinyurls);
+    &copyresourcedb($origcrsid,$newcrsid,$date_mode,$date_shift);
+    return @info;
 }
 
 1;