--- loncom/automation/batchcreatecourse.pm	2013/03/01 04:49:15	1.38
+++ loncom/automation/batchcreatecourse.pm	2020/07/01 20:09:03	1.45
@@ -1,5 +1,5 @@
 #
-# $Id: batchcreatecourse.pm,v 1.38 2013/03/01 04:49:15 raeburn Exp $
+# $Id: batchcreatecourse.pm,v 1.45 2020/07/01 20:09:03 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -75,18 +75,22 @@ use strict;
 # <topmap></topmap>
 # <firstres>nav</firstres>
 # <crsquota>20</crsquota>
+# <uniquecode>1</uniquecode>
 # <clonecrs>466011437c34194msul1</clonecrs>
 # <clonedom>msu</clonedom>
 # <datemode>shift</datemode>
 # <dateshift>365</dateshift>
+# <tinyurls>create</tinyurls>
 # <showphotos></showphotos>
 # <setpolicy>1</setpolicy>
 # <setcontent>1</setcontent>
+# <setcomment>1</setcomment>
 # <setkeys>0</setkeys>
 # <keyauth>keyadmin:msu</keyauth>
 # <disresdis>1</disresdis>
 # <disablechat>1</disablechat>
 # <openall></openall>
+# <openallfrom></openallfrom>
 # <notify_dc>1</notify_dc>
 # <notify_owner>1</notify_owner>
 # <owner>
@@ -151,7 +155,8 @@ use strict;
 #
 # Many of these are binary options (corresponding to either checkboxes or
 # radio buttons in the interactive CCRS page).  Examples include:
-# setpolicy, setcontent, setkeys, disableresdis, disablechat, openall
+# setpolicy, setcontent, setcomment, setkeys, disableresdis, disablechat, openall,
+# uniquecode
 #
 # A value of 1 between opening and closing tags is equivalent to a 
 # checked checkbox or 'Yes' response in the original CCRS web page.
@@ -161,7 +166,7 @@ use strict;
 # firstres can be nav, syl, or blank for "Navigate Contents", Syllabus, or
 # no entry respectively.
 # 
-# crstype can be Course or Community
+# crstype can be Course, Community or Placement
 #
 # crsquota is the total disk space permitted for course group portfolio files
 # in all course groups.
@@ -178,16 +183,23 @@ use strict;
 #                    /home/httpd/perl/tmp/addcourse/$dom/auto/pending if $context = auto
 #                    /home/httpd/perl/tmp/addcourse/$dom/web/$uname_$udom/pending if $context = web
 #                    
-# inputs (five)  -  requests - ref to array of filename(s) containing course requests 
+# inputs (six)   -  requests - ref to array of filename(s) containing course requests 
 #                   courseids - ref to hash to store LON-CAPA course ids of new courses 
 #                   context - auto if called from command line, web if called from browser
 #                   dom - domain for which the course is being created
 #                   uname - username of DC who is requesting course creation
 #                   udom - domain of DC who is requesting course creation
 #  
-# outputs (three)  -  output - text recording user roles added etc.
-#                     logmsg - text to be logged
-#                     keysmsg - text containing link(s) to manage keys page(s) 
+# outputs (six)  -  output - text recording user roles added etc.
+#                   logmsg - text to be logged
+#                   cloneinfo - text output from cloning
+#                   keysmsg - text containing link(s) to manage keys page(s) 
+#                   codehash - reference to hash containing courseID => unique code
+#                              where unique code is a 6 character code, to distribute
+#                              to students as a shortcut to the course.
+#                   instcodes - references to hash of an array, where keys are
+#                               institutional codes and values are an array of
+#                               courseIDs of courses with that code.
 #############################################################
 
 sub create_courses {
@@ -205,10 +217,12 @@ sub create_courses {
             $longroles{'Community'}{$1} = $3;
         }
     }
-    my ($logmsg,$keysmsg,$newusermsg,$addresult);
+    my ($logmsg,$cloneinfo,$keysmsg,$newusermsg,$addresult,$user_lh,
+        %codehash,%instcodes);
     my %enrollcount = ();
     my $newcoursedir = LONCAPA::tempdir().'/addcourse/'.$dom.'/'.$context;
     if ($context eq 'auto') {
+        $user_lh = &Apache::loncommon::user_lang($uname,$udom);
         $newcoursedir .= '/pending';
     } else {
         if ($uname && $udom) {
@@ -220,19 +234,52 @@ sub create_courses {
     if (@{$requests} > 0) {
         foreach my $request (@{$requests}) {
             my %details = ();
+            my $clonemsg = [];
             if (-e $newcoursedir.'/'.$request) {
                 &parse_coursereqs($newcoursedir.'/'.$request, \%details);
                 foreach my $num (sort(keys(%details))) {
                     my $reqdetails = $details{$num};
-                    my $courseid = &build_course($dom,$num,$context,$reqdetails,\%longroles,\$logmsg,\$newusermsg,\$addresult,\%enrollcount,\$output,\$keysmsg);
+                    my $code;
+                    my $courseid =
+                        &build_course($dom,$num,$context,$reqdetails,\%longroles,\$logmsg,
+                                      $clonemsg,\$newusermsg,\$addresult,\%enrollcount,
+                                      \$output,\$keysmsg,undef,undef,undef,undef,\$code);
                     if ($courseid =~m{^/$match_domain/$match_courseid}) {
                         $$courseids{$courseid} = $details{$num}{'class'};
+                        if ($code) {
+                            $codehash{$courseid} = $code;
+                        }
+                        if ($details{$num}{'coursecode'} ne '') {
+                            push(@{$instcodes{$details{$num}{'coursecode'}}},$courseid);
+                        }
+                    }
+                    if (@{$clonemsg}) {
+                        if ($context eq 'web') {
+                            $cloneinfo .= '<p class="LC_info">';
+                        }
+                        foreach my $item (@{$clonemsg}) {
+                            if (ref($item) eq 'HASH') {
+                                if ($context eq 'auto') {
+                                    $cloneinfo .= &mt_user($user_lh,$item->{mt},
+                                                           @{$item->{args}});
+                                } else {
+                                    $cloneinfo .= &mt($item->{mt},@{$item->{args}});
+                                }
+                            }
+                            if ($context eq 'web') {
+                                $cloneinfo .= '<br />';
+                            }
+                            $cloneinfo .= "\n";
+                        }
+                        if ($context eq 'web') {
+                            $cloneinfo .= '</p>';
+                        }
                     }
                 }
             }
         }
     }
-    return ($output,$logmsg,$keysmsg);
+    return ($output,$logmsg,$cloneinfo,$keysmsg,\%codehash,\%instcodes);
 }
 
 #############################################################
@@ -255,9 +302,9 @@ sub parse_coursereqs {
     my $xlist = 0;
     my $userkey = '';
     my $role = '';
-    my @items = ('title','optional_id','coursecode','defaultcredits','coursehome','reshome','nonstandard','adds','drops','topmap','firstres','clonecrs','clonedom','datemode','dateshift','showphotos','setpolicy','setcontent','setkeys','keyauth','disresdis','disablechat','openall','notify_owner','notify_dc','crstype','crsquota');
+    my @items = ('title','optional_id','coursecode','defaultcredits','coursehome','reshome','nonstandard','adds','drops','topmap','firstres','clonecrs','clonedom','datemode','dateshift','tinyurls','showphotos','setpolicy','setcontent','setcomment','setkeys','keyauth','disresdis','disablechat','openall','notify_owner','notify_dc','crstype','crsquota','uniquecode');
     my @possroles = qw(st ad ep ta in cc co);
-    my @dateitems = ('enrollstart','enrollend','accessstart','accessend');
+    my @dateitems = ('enrollstart','enrollend','accessstart','accessend','openallfrom');
     my @useritems = ('autharg','authtype','firstname','generation','lastname','middlename','studentID');
     my $p = HTML::Parser->new
     (
@@ -381,16 +428,20 @@ sub parse_coursereqs {
 #   ref to hash of course creation information
 #   ref to hash of role descriptions
 #   ref to scalar used to accumulate log messages
+#   ref to array used to accumulate messages about cloning
 #   ref to scalar used to accumulate messages sent to new users
 #   ref to scalar used to accumulate results of new user additions
 #   ref to hash of enrollment counts for different roles
 #   ref to scalar used to accumulate information about added roles
-#   ref to scalar used to accumulate
 #   ref to scalar used to accumulate information about access keys
 #   domain of DC creating course
 #   username of DC creating course   
 #   optional course number, if unique course number already obtained (e.g., for
-#       course requests submitted via course request form. 
+#       course requests submitted via course request form.
+#   optional category
+#   optional ref to scalar for six character unique identifier
+#   caller context (e.g., auto)
+#   user language handle, if caller context is 'auto'
 #
 # outputs
 #   LON-CAPA courseID for new (created) course
@@ -398,7 +449,9 @@ sub parse_coursereqs {
 #########################################################
 
 sub build_course {
-    my ($cdom,$num,$context,$details,$longroles,$logmsg,$newusermsg,$addresult,$enrollcount,$output,$keysmsg,$udom,$uname,$cnum,$category) = @_;
+    my ($cdom,$num,$context,$details,$longroles,$logmsg,$clonemsg,$newusermsg,
+        $addresult,$enrollcount,$output,$keysmsg,$udom,$uname,$cnum,$category,
+        $coderef,$callercontext,$user_lh) = @_;
     return unless (ref($details) eq 'HASH');
     my $owner_uname = $details->{'owner'};
     my $owner_domain = $details->{'domain'};
@@ -415,7 +468,11 @@ sub build_course {
             $rolenames = $longroles->{'Community'};
         }
     } else {
-        $crstype = 'Course';
+        if ($details->{'crstype'} eq 'Placement') {
+            $crstype = $details->{'crstype'};
+        } else {
+            $crstype = 'Course';
+        }
         $ccrole = 'cc';
         if (ref($longroles) eq 'HASH') {
             $rolenames = $longroles->{'Course'};
@@ -438,6 +495,8 @@ sub build_course {
     if ($firstres eq '') {
         if ($crstype eq 'Community') {
             $firstres = 'nav';
+        } elsif ($crstype eq 'Placement') {
+            $firstres = 'blank'; 
         } else {
             $firstres = 'syl';
         }
@@ -486,6 +545,9 @@ sub build_course {
             $details->{'datemode'} = 'shift';
             $details->{'dateshift'} = 365;
         }
+        if ($details->{'tinyurls'} !~ /^(delete|transfer|create)$/) {
+            $details->{'tinyurls'} = 'create';
+        }
         my $courseargs = {
                ccuname => $details->{'owner'},
                ccdomain => $details->{'domain'},
@@ -498,10 +560,12 @@ sub build_course {
                crscode => $details->{'coursecode'},
                defaultcredits => $details->{'defaultcredits'},
                crsquota => $details->{'crsquota'},
+               uniquecode => $details->{'uniquecode'},
                clonecourse => $details->{'clonecrs'},
                clonedomain => $details->{'clonedom'},
                datemode => $details->{'datemode'},
                dateshift => $details->{'dateshift'},
+               tinyurls => $details->{'tinyurls'},
                crsid => $details->{'optional_id'},
                curruser => $details->{'owner'},
                crssections => $sectionstr,
@@ -520,28 +584,39 @@ sub build_course {
                endaccess => $details->{'accessend'},
                setpolicy => $details->{'setpolicy'},
                setcontent => $details->{'setcontent'},
+               setcomment => $details->{'setcomment'},
                reshome => $reshome,
                setkeys => $details->{'setkeys'},
                keyauth => $details->{'keyauth'},
                disresdis => $details->{'disresdis'},
                disablechat => $details->{'disablechat'},
                openall => $details->{'openall'},
+               openallfrom => $details->{'openallfrom'},
                firstres => $firstres
                };
+        if ($details->{'textbook'}) {
+            $courseargs->{'textbook'} = $details->{'textbook'};
+        }
         my %host_servers = &Apache::lonnet::get_servers($cdom,'library');
         if (! exists($host_servers{$details->{'coursehome'}})) {
             $$logmsg .= &mt('Invalid home server for course').': '.$details->{'coursehome'};
             return;
         }
-        my ($success, $msg) = &Apache::loncommon::construct_course($courseargs,$logmsg,\$courseid,\$crsudom,\$crsunum,$udom,$uname,$context,$cnum,$category);
+        my ($success,$msg,$cloneinfo) = 
+            &Apache::loncommon::construct_course($courseargs,$logmsg,\$courseid,\$crsudom,\$crsunum,
+                                                 $udom,$uname,$context,$cnum,$category,$coderef,
+                                                 $callercontext,$user_lh);
 	$$logmsg .= $msg;
+        if ((ref($clonemsg) eq 'ARRAY') && (ref($cloneinfo) eq 'ARRAY')) {
+             push(@{$clonemsg},@{$cloneinfo});
+        }
         if (!$success) {
             return;
         }
     } else {
         return;
     }
-    
+
 #
 # Make owner a coordinator
 #