--- loncom/interface/loncourserespicker.pm	2013/11/13 01:40:07	1.8
+++ loncom/interface/loncourserespicker.pm	2024/11/22 22:42:27	1.17
@@ -1,6 +1,6 @@
 # The LearningOnline Network
 #
-# $Id: loncourserespicker.pm,v 1.8 2013/11/13 01:40:07 raeburn Exp $
+# $Id: loncourserespicker.pm,v 1.17 2024/11/22 22:42:27 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -37,8 +37,9 @@ loncourserespicker provides an interface
 resources are to be either:
 
 (a) exported to an IMS Content Package
-(b) subject to access blocking for the duriation of an exam/quiz.
+(b) subject to access blocking for the duration of an exam/quiz.
 (c) dumped to an Authoring Space
+(d) receive shortened URLs to be used when deep-linking into a course
 
 =head1 DESCRIPTION
 
@@ -62,9 +63,10 @@ a higher level to become unchecked.
 There is a submit button, which will be named differently according to the 
 context in which resource/folder selection is being made.
 
-The three contexts currently supported are: IMS export, selection of
+The four contexts currently supported are: IMS export, selection of
 content to be subject to access restructions for the duration of an
-exam, and selection of items for dumping to an Authoring Space.
+exam, selection of items for dumping to an Authoring Space, and 
+display or creation of shortened URLs for deep-linking,
 
 =head1 INTERNAL SUBROUTINES
 
@@ -75,12 +77,13 @@ select items.  Checking a folder causes
 within the folder. Unchecking a resource causing unchecking of folders
 containing the item back up to the top level.
 
-Inputs: 9.
+Inputs: 11.
    - $navmap  -- Reference to LON-CAPA navmap object 
                 (encapsulates information about resources in the course). 
 
    - $context -- Context in which course resource selection is being made.
-                 Currently imsexport and examblock are supported.
+                 Currently imsexport, examblock, dumpdocs, and shorturls
+                 are supported.
 
    - $formname  -- Name of the form in the window from which the pop-up
                    used to select course items was launched. 
@@ -107,6 +110,13 @@ Inputs: 9.
    - $uploadedfiles -- Reference to hash: keys are paths to files in
                        /home/httpd/lonUsers/$cdom/$1/$2/$3/$cnum/userfiles.
 
+   - $tiny -- Reference to hash: keys are symbs of course items for which
+              shortened URLs have already been created.
+
+   - $readonly -- if true, no "check all" or "uncheck all" buttons will
+                  be displayed, and checkboxes will be disabled, if this 
+                  is for an exam block or for shortened URL creation.
+
 
 Output: $output is the HTML mark-up for display/selection of content
         items in the pop-up window.
@@ -123,7 +133,7 @@ Inputs: 7.
    - $numcount -- Total numer of folders and resources in course.
 
    - $context -- Context in which resources are being displayed
-                 (imsexport, examblock or dumpdocs). 
+                 (imsexport, examblock,  dumpdocs or shorturls). 
 
    - $formname --  Name of form.
 
@@ -144,14 +154,14 @@ no object instantiated.
 Inputs: 2.
    - $crstype -- Container type: Course or Community
 
-   - $context -- Context: imsexport, examblock or dumpdocs
+   - $context -- Context: imsexport, examblock, dumpdocs, or shorturls
 
 
 =item &clean()
  
 Takes incoming title and replaces non-alphanumeric characters with underscore,
 so title can be used as suggested file name (with appended extension) for file
-copied from course to Authoring space.
+copied from course to Authoring Space.
 
 
 =item &enumerate_course_contents()
@@ -162,7 +172,8 @@ map url, or symb, for an iteration throu
 a Course Coordinator. Used to generate numerical IDs to facilitate
 (a) storage of lists of maps or resources to be blocked during an exam,
 (b) processing selected form element during dumping of selected course
-    content to Authoring space.
+    content to Authoring Space.
+(c) 
 
 Inputs: 7 
 
@@ -176,7 +187,7 @@ Inputs: 7
       $title_ref - reference to hash containing titles for items in
                    course
 
-      $context - examblock or dumpdocs
+      $context - examblock, dumpdocs or shorturls
 
       $cdom - course's domain
 
@@ -206,9 +217,15 @@ use Apache::lonlocal;
 use LONCAPA qw(:DEFAULT :match);
 
 sub create_picker {
-    my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block,$preamble,$numhome,$uploadedfiles) = @_;
+    my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block,$preamble,
+        $numhome,$uploadedfiles,$tiny,$readonly) = @_;
     return unless (ref($navmap));
-    my ($it,$output,$numdisc,%maps,%resources,%discussiontime,%currmaps,%currresources,%files);
+    my ($it,$output,$numdisc,%discussiontime,%currmaps,%currresources,%files,
+        %shorturls,$chkname);
+    $chkname = 'archive';
+    if ($context eq 'shorturls') {
+        $chkname = 'addtiny';
+    }
     $it = $navmap->getIterator(undef,undef,undef,1,undef,undef);
     if (ref($blockedmaps) eq 'HASH') {
         %currmaps = %{$blockedmaps};
@@ -217,6 +234,8 @@ sub create_picker {
         %currresources = %{$blockedresources};
     } elsif (ref($uploadedfiles) eq 'HASH') {
         %files = %{$uploadedfiles};
+    } elsif (ref($tiny) eq 'HASH') {
+        %shorturls = %{$tiny}; 
     }
     my @checked_maps;
     my $curRes;
@@ -236,27 +255,38 @@ sub create_picker {
     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
     my $crsprefix = &propath($cdom,$cnum).'/userfiles/';
 
-    my ($info,$display,$onsubmit,$togglebuttons);
+    my ($info,$display,$onsubmit,$togglebuttons,$disabled);
     if ($context eq 'examblock') {
         my $maps_elem = 'docs_maps_'.$block;
         my $res_elem = 'docs_resources_'.$block;
         $onsubmit = ' onsubmit="return writeToOpener('."'$maps_elem','$res_elem'".');"';
         $info = &mt('Items in '.lc($crstype).' for which access will be blocked.');
+        if ($readonly) {
+            $disabled = ' disabled="disabled"';
+        }
     }
     if ($context eq 'dumpdocs') {
         $info = '<span class="LC_fontsize_medium">'.
-                &mt('Choose the uploaded course items and templated pages/problems to be copied to Authoring space.').
+                &mt('Choose the uploaded course items and templated pages/problems to be copied to Authoring Space.').
                 '</span><br /><br />';
         $startcount = 3 + $numhome;
-        $onsubmit = ' onsubmit="return checkUnique(document.'.$formname.',document.'.$formname.'.archive);"';
+        $onsubmit = ' onsubmit="return checkUnique(document.'.$formname.',document.'.$formname.'.'.$chkname.');"';
+    } elsif ($context eq 'shorturls') {
+        $info = '<span class="LC_fontsize_medium">'.
+                &mt('Choose the resource(s) and/or folder(s) from Main Content for which shortened URL(s) are needed.').
+                '</span><br /><br />';
     } elsif ($context eq 'imsexport') {
         $info = &mt('Choose which items you wish to export from your '.$crstype.'.');
         $startcount = 5;
     }
-    $togglebuttons = '<input type="button" value="'.&mt('check all').'" '.
-                     'onclick="javascript:checkAll(document.'.$formname.'.archive)" />'.
-                     '&nbsp;&nbsp;<input type="button" value="'.&mt('uncheck all').'"'.
-                     ' onclick="javascript:uncheckAll(document.'.$formname.'.archive)" />';
+    if ($disabled) {
+        $togglebuttons = '<br />';
+    } else {
+        $togglebuttons = '<input type="button" value="'.&mt('check all').'" '.
+                         'onclick="javascript:checkAll(document.'.$formname.'.'.$chkname.')" />'.
+                         '&nbsp;&nbsp;<input type="button" value="'.&mt('uncheck all').'"'.
+                         ' onclick="javascript:uncheckAll(document.'.$formname.'.'.$chkname.')" />';
+    }
     $display = '<form name="'.$formname.'" action="" method="post"'.$onsubmit.'>'."\n";
     if ($context eq 'imsexport') {
         $display .= $info.
@@ -278,7 +308,7 @@ sub create_picker {
                 '</fieldset>';
         }
         $display .= '</div>';
-    } elsif ($context eq 'examblock') {
+    } elsif (($context eq 'examblock') || ($context eq 'shorturls')) {
         $display .= $info.$togglebuttons;
     } elsif ($context eq 'dumpdocs') {
         $display .= $preamble.
@@ -299,9 +329,12 @@ sub create_picker {
         $display .= '<th>'.&mt('Access blocked?').'</th>';
     } elsif ($context eq 'dumpdocs') {
         $display .= '<th>'.&mt('Copy?').'</th>'.
-                    '<th>'.&mt("Title in $crstype").
+                    '<th>'.&mt("Title in $crstype").'</th>'.
                     '<th>'.&mt('Internal Identifier').'</th>'.
                     '<th>'.&mt('Save as ...').'</th>';
+    } elsif ($context eq 'shorturls') {
+        $display .= '<th colspan="2">'.&mt('Tiny URL').'</th>'.
+                    '<th>'.&mt("Title in $crstype").'</th>';
     }
     $display .= &Apache::loncommon::end_data_table_header_row();
     while ($curRes = $it->next()) {
@@ -327,35 +360,49 @@ sub create_picker {
                 }
             }
             $count ++;
-            my $currelem;
+            my ($currelem,$mapurl,$is_map);
             if ($context eq 'imsexport') {
                 $currelem = $count+$boards+$startcount;
             } else {
                 $currelem = $count+$startcount;
             }
-            $display .= &Apache::loncommon::start_data_table_row().
-                       '<td>'."\n".
-                       '<input type="checkbox" name="archive" value="'.$count.'" ';
+            $display .= &Apache::loncommon::start_data_table_row()."\n";
             if (($curRes->is_sequence()) || ($curRes->is_page())) {
                 $lastcontainer = $currelem;
-                $display .= 'onclick="javascript:checkFolder(document.'.$formname.','."'$currelem'".')" ';
-                my $mapurl = (&Apache::lonnet::decode_symb($symb))[2];
-                if ($currmaps{$mapurl}) {
-                    $display .= 'checked="checked"';
-                    push(@checked_maps,$currelem);
+                $mapurl = (&Apache::lonnet::decode_symb($symb))[2];
+                $is_map = 1;
+            }
+            if ($context eq 'shorturls') {
+                if ($shorturls{$symb}) {
+                    $display .= '<td>&nbsp;</td><td align="right"><b>'."/tiny/$cdom/$shorturls{$symb}".'</b></td>'."\n";
+                } else {
+                    $display .= '<td align="left"><label><input type="checkbox" name="'.$chkname.'" '.
+                                'value="'.$count.'"'.$disabled.' />'.&mt('Add').'</label></td>'.
+                                '<td>&nbsp;</td>'."\n";
                 }
             } else {
-                if ($curRes->is_problem()) {
-                    $numprobs ++;
-                }
-                $display .= 'onclick="javascript:checkResource(document.'.$formname.','."'$currelem'".')" ';
-                if ($currresources{$symb}) {
-                    $display .= 'checked="checked"';
+                $display .= '<td><input type="checkbox" name="'.$chkname.'" value="'.$count.'" ';
+                if ($is_map) {
+                    $display .= 'onclick="javascript:checkFolder(document.'.$formname.','."'$currelem'".')" ';
+                    if ($currmaps{$mapurl}) {
+                        $display .= 'checked="checked"';
+                        push(@checked_maps,$currelem);
+                    }
+                } else {
+                    if ($curRes->is_problem()) {
+                       $numprobs ++;
+                    }
+                    $display .= 'onclick="javascript:checkResource(document.'.$formname.','."'$currelem'".')" ';
+                    if ($currresources{$symb}) {
+                        $display .= 'checked="checked"';
+                    }
                 }
+                $display .= $disabled.' />'."\n";
             }
-            $display .= ' />'."\n";
             if ($context eq 'dumpdocs') {
                 $display .= '</td><td valign="top">';
+            } elsif ($context eq 'shorturls') {
+                $display .= '<td valign="top">';
             }
             for (my $i=0; $i<$depth; $i++) {
                 $display .= "$whitespace\n";
@@ -450,10 +497,12 @@ sub create_picker {
            &mt('Export').'" /></p>';
         $numcount = $count + $boards + $startcount;
     } elsif ($context eq 'examblock') {
-        $display .=
-            '<p>'.
-            '<input type="submit" name="resourceblocks" value="'.
-            &mt('Copy Choices to Main Window').'" /></p>';
+        unless ($readonly) {
+            $display .=
+                '<p>'.
+                '<input type="submit" name="resourceblocks" value="'.
+                &mt('Copy Choices to Main Window').'" /></p>';
+        }
         $numcount = $count + $startcount;
     } elsif ($context eq 'dumpdocs') {
         $display .= '</fieldset>'.
@@ -462,12 +511,19 @@ sub create_picker {
                     '<input type="submit" name="dumpcourse" value="'.&mt("Copy $crstype Content").'" />'.
                     '</div>';
         $numcount = $count + $startcount;
+    } elsif ($context eq 'shorturls') {
+        unless ($readonly) {
+            $display .=
+                '<p>'.
+                '<input type="submit" name="shorturls" value="'.
+                &mt('Create Tiny URL(s)').'" /></p>';
+        }
     }
     $display .= '</form>';
-    my $scripttag = 
+    my $scripttag =
         &respicker_javascript($startcount,$numcount,$context,$formname,\%children,
-                              \%hierarchy,\@checked_maps);
-    if ($context eq 'dumpdocs') {
+                              \%hierarchy,\@checked_maps,$numhome,$chkname);
+    if (($context eq 'dumpdocs') || ($context eq 'shorturls')) {
         return $scripttag.$display; 
     }
     my ($title,$crumbs,$args);
@@ -484,8 +540,8 @@ sub create_picker {
         $output .= &Apache::lonhtmlcommon::breadcrumbs('IMS Export').
                    &Apache::londocs::startContentScreen('tools');
     } elsif ($context eq 'dumpdocs') {
-         $output .= &Apache::lonhtmlcommon::breadcrumbs('Copying to Authoring Space').
-                    &Apache::londocs::startContentScreen('tools');
+        $output .= &Apache::lonhtmlcommon::breadcrumbs('Copying to Authoring Space').
+                   &Apache::londocs::startContentScreen('tools');
     }
     $output .= $display;
     if ($context eq 'examblock') {
@@ -498,21 +554,8 @@ sub create_picker {
 
 sub respicker_javascript {
     my ($startcount,$numitems,$context,$formname,$children,$hierarchy,
-        $checked_maps) = @_;
-    return unless ((ref($children) eq 'HASH') && (ref($hierarchy) eq 'HASH')
-                   && (ref($checked_maps) eq 'ARRAY'));
-    my ($elem,$nested,$nameforelem);
-    if ($context eq 'dumpdocs') {
-        $elem='((parseInt(item)-'.$startcount.')*2)+'.$startcount;
-        $nested='((parseInt(nesting[item][i])-'.$startcount.')*2)+'.$startcount;
-        $nameforelem=$elem+1;
-    } else {
-        $elem='parseInt(item)';
-        $nested='parseInt(nesting[item][i])';
-    }
-    my $scripttag = <<"START";
-<script type="text/javascript">
-// <![CDATA[
+        $checked_maps,$numhome,$chkname) = @_;
+    my $check_uncheck = <<"FIRST";
 function checkAll(field) {
     if (field.length > 0) {
         for (i = 0; i < field.length; i++) {
@@ -532,6 +575,31 @@ function uncheckAll(field) {
         field.checked = false;
     }
 }
+FIRST
+    if ($context eq 'shorturls') {
+        return <<"END";
+<script type="text/javascript">
+// <![CDATA[
+$check_uncheck
+// ]]>
+</script>
+END
+    }
+    return unless ((ref($children) eq 'HASH') && (ref($hierarchy) eq 'HASH')
+                   && (ref($checked_maps) eq 'ARRAY'));
+    my ($elem,$nested,$nameforelem);
+    if ($context eq 'dumpdocs') {
+        $elem='((parseInt(item)-'.$startcount.')*2)+'.$startcount;
+        $nested='((parseInt(nesting[item][i])-'.$startcount.')*2)+'.$startcount;
+        $nameforelem=$elem+1;
+    } else {
+        $elem='parseInt(item)';
+        $nested='parseInt(nesting[item][i])';
+    }
+    my $scripttag = <<"START";
+<script type="text/javascript">
+// <![CDATA[
+$check_uncheck
 
 function checkFolder(form,item) {
     var elem = $elem;
@@ -591,11 +659,16 @@ EXTRA
     } elsif ($context eq 'dumpdocs') {
         my $blankmsg = &mt('An item selected has no filename set in the "Save as ..." column.');
         my $dupmsg = &mt('Items selected for copying need unique filenames in the "Save as ..." column.');
+        my $homemsg = &mt('An Authoring Space needs to be selected.');
+        &js_escape(\$blankmsg);
+        &js_escape(\$dupmsg);
+        &js_escape(\$homemsg);
         $scripttag .= <<"EXTRA";
 
 function checkUnique(form,field) {
     var duplicate = 0;
     var blank = 0;
+    var numhome = '$numhome';
     if (field.length > 0) {
         for (i=0; i<field.length; i++) {
             if (field[i].checked) {
@@ -635,6 +708,12 @@ function checkUnique(form,field) {
         alert('$dupmsg');
         return false;
     }
+    if (numhome > 1) {
+        if (!form.authorspace.options[form.authorspace.selectedIndex].value) {
+            alert('$homemsg');
+            return false;
+        }
+    }
     return true;
 }
 
@@ -674,8 +753,8 @@ END
 function writeToOpener(maps,resources) {
     var checkedmaps = '';
     var checkedresources = '';
-    for (var i=0; i<document.$formname.archive.length; i++) {
-        if (document.$formname.archive[i].checked) {
+    for (var i=0; i<document.$formname.${chkname}.length; i++) {
+        if (document.$formname.${chkname}[i].checked) {
             var isResource = 1;
             var include = 1;
             var elemnum = i+1+$startcount;
@@ -685,18 +764,20 @@ function writeToOpener(maps,resources) {
                 }
             }
             if (isResource == 1) {
-                if (nesting[elemnum].length > 0) {
-                    var lastelem = nesting[elemnum].length-1;
-                    if (document.$formname.elements[nesting[elemnum][lastelem]].checked) {
-                        include = 0;
+                if (nesting[elemnum] != null) {
+                    if (nesting[elemnum].length > 0) {
+                        var lastelem = nesting[elemnum].length-1;
+                        if (document.$formname.elements[nesting[elemnum][lastelem]].checked) {
+                            include = 0;
+                        }
                     }
                 }
             }
             if (include == 1) {
                 if (isResource == 1) {
-                    checkedresources += document.$formname.archive[i].value+',';
+                    checkedresources += document.$formname.${chkname}[i].value+',';
                 } else {
-                    checkedmaps += document.$formname.archive[i].value+',';
+                    checkedmaps += document.$formname.${chkname}[i].value+',';
                 }
             }
         }
@@ -730,7 +811,9 @@ sub get_navmap_object {
                                                        undef,{'only_body' => 1,}).
                       '<h2>'.&mt('Resource Display Failed').'</h2>';  
         } elsif ($context eq 'dumpdocs') {
-            $outcome = '<h2>'.&mt('Copying to Authoring Space unavilable');
+            $outcome = '<h2>'.&mt('Copying to Authoring Space unavailable').'</h2>';
+        } elsif ($context eq 'shorturls') {
+            $outcome = '<h2>'.&mt('Display/Setting of shortened URLs unavailable').'</h2>';
         }
         $outcome .= '<div class="LC_error">';
         if ($crstype eq 'Community') {
@@ -739,7 +822,7 @@ sub get_navmap_object {
             $outcome .= &mt('Unable to retrieve information about course contents');
         }
         $outcome .= '</div>';
-        if (($context eq 'imsexport') || ($context eq 'dumpdocs')) {
+        if (($context eq 'imsexport') || ($context eq 'dumpdocs') || ($context eq 'shorturls') ) {
             $outcome .= '<a href="/adm/coursedocs">';
             if ($crstype eq 'Community') {
                 $outcome .= &mt('Return to Community Editor');
@@ -749,8 +832,10 @@ sub get_navmap_object {
             $outcome .= '</a>';
             if ($context eq 'imsexport') {
                 &Apache::lonnet::logthis('IMS export failed - could not create navmap object in '.lc($crstype).':'.$env{'request.course.id'});
-            } else {
+            } elsif ($context eq 'dumpdocs') {
                 &Apache::lonnet::logthis('Copying to Authoring Space failed - could not create navmap object in '.lc($crstype).':'.$env{'request.course.id'});
+            } elsif ($context eq 'shorturls') {
+                &Apache::lonnet::logthis('Displaying and/or saving URL shortcuts failed - could not create navmap object in '.lc($crstype).':'.$env{'request.course.id'});
             }
         } elsif ($context eq 'examblock') {
             $outcome .=  '<href="javascript:window.close();">'.&mt('Close window').'</a>';         
@@ -789,10 +874,14 @@ sub enumerate_course_contents {
                     }
                 }
                 $count ++;
-                if (($curRes->is_sequence()) || ($curRes->is_page())) {
-                    $map_url->{$count} = (&Apache::lonnet::decode_symb($symb))[2];
-                } else {
+                if ($context eq 'shorturls') {
                     $resource_symb->{$count} = $ressymb;
+                } else {
+                    if (($curRes->is_sequence()) || ($curRes->is_page())) {
+                        $map_url->{$count} = (&Apache::lonnet::decode_symb($symb))[2];
+                    } else {
+                        $resource_symb->{$count} = $ressymb;
+                    }
                 }
                 $titleref->{$count} = $curRes->title();
             }