Diff for /loncom/interface/loncourserespicker.pm between versions 1.14 and 1.17

version 1.14, 2016/10/16 21:49:51 version 1.17, 2024/11/22 22:42:27
Line 37  loncourserespicker provides an interface Line 37  loncourserespicker provides an interface
 resources are to be either:  resources are to be either:
   
 (a) exported to an IMS Content Package  (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  (c) dumped to an Authoring Space
   (d) receive shortened URLs to be used when deep-linking into a course
   
 =head1 DESCRIPTION  =head1 DESCRIPTION
   
Line 62  a higher level to become unchecked. Line 63  a higher level to become unchecked.
 There is a submit button, which will be named differently according to the   There is a submit button, which will be named differently according to the 
 context in which resource/folder selection is being made.  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  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  =head1 INTERNAL SUBROUTINES
   
Line 80  Inputs: 11. Line 82  Inputs: 11.
                 (encapsulates information about resources in the course).                   (encapsulates information about resources in the course). 
   
    - $context -- Context in which course resource selection is being made.     - $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     - $formname  -- Name of the form in the window from which the pop-up
                    used to select course items was launched.                      used to select course items was launched. 
Line 106  Inputs: 11. Line 109  Inputs: 11.
   
    - $uploadedfiles -- Reference to hash: keys are paths to files in     - $uploadedfiles -- Reference to hash: keys are paths to files in
                        /home/httpd/lonUsers/$cdom/$1/$2/$3/$cnum/userfiles.                         /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     - $readonly -- if true, no "check all" or "uncheck all" buttons will
                   be displayed, and checkboxes will be disabled, if this                     be displayed, and checkboxes will be disabled, if this 
                   is for an exam block.                    is for an exam block or for shortened URL creation.
   
   
 Output: $output is the HTML mark-up for display/selection of content  Output: $output is the HTML mark-up for display/selection of content
Line 127  Inputs: 7. Line 133  Inputs: 7.
    - $numcount -- Total numer of folders and resources in course.     - $numcount -- Total numer of folders and resources in course.
   
    - $context -- Context in which resources are being displayed     - $context -- Context in which resources are being displayed
                  (imsexport, examblock or dumpdocs).                    (imsexport, examblock,  dumpdocs or shorturls). 
   
    - $formname --  Name of form.     - $formname --  Name of form.
   
Line 148  no object instantiated. Line 154  no object instantiated.
 Inputs: 2.  Inputs: 2.
    - $crstype -- Container type: Course or Community     - $crstype -- Container type: Course or Community
   
    - $context -- Context: imsexport, examblock or dumpdocs     - $context -- Context: imsexport, examblock, dumpdocs, or shorturls
   
   
 =item &clean()  =item &clean()
Line 167  a Course Coordinator. Used to generate n Line 173  a Course Coordinator. Used to generate n
 (a) storage of lists of maps or resources to be blocked during an exam,  (a) storage of lists of maps or resources to be blocked during an exam,
 (b) processing selected form element during dumping of selected course  (b) processing selected form element during dumping of selected course
     content to Authoring Space.      content to Authoring Space.
   (c) 
   
 Inputs: 7   Inputs: 7 
   
Line 180  Inputs: 7 Line 187  Inputs: 7
       $title_ref - reference to hash containing titles for items in        $title_ref - reference to hash containing titles for items in
                    course                     course
   
       $context - examblock or dumpdocs        $context - examblock, dumpdocs or shorturls
   
       $cdom - course's domain        $cdom - course's domain
   
Line 211  use LONCAPA qw(:DEFAULT :match); Line 218  use LONCAPA qw(:DEFAULT :match);
   
 sub create_picker {  sub create_picker {
     my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block,$preamble,      my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block,$preamble,
         $numhome,$uploadedfiles,$readonly) = @_;          $numhome,$uploadedfiles,$tiny,$readonly) = @_;
     return unless (ref($navmap));      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);      $it = $navmap->getIterator(undef,undef,undef,1,undef,undef);
     if (ref($blockedmaps) eq 'HASH') {      if (ref($blockedmaps) eq 'HASH') {
         %currmaps = %{$blockedmaps};          %currmaps = %{$blockedmaps};
Line 222  sub create_picker { Line 234  sub create_picker {
         %currresources = %{$blockedresources};          %currresources = %{$blockedresources};
     } elsif (ref($uploadedfiles) eq 'HASH') {      } elsif (ref($uploadedfiles) eq 'HASH') {
         %files = %{$uploadedfiles};          %files = %{$uploadedfiles};
       } elsif (ref($tiny) eq 'HASH') {
           %shorturls = %{$tiny}; 
     }      }
     my @checked_maps;      my @checked_maps;
     my $curRes;      my $curRes;
Line 256  sub create_picker { Line 270  sub create_picker {
                 &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 />';                  '</span><br /><br />';
         $startcount = 3 + $numhome;          $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') {      } elsif ($context eq 'imsexport') {
         $info = &mt('Choose which items you wish to export from your '.$crstype.'.');          $info = &mt('Choose which items you wish to export from your '.$crstype.'.');
         $startcount = 5;          $startcount = 5;
Line 265  sub create_picker { Line 283  sub create_picker {
         $togglebuttons = '<br />';          $togglebuttons = '<br />';
     } else {      } else {
         $togglebuttons = '<input type="button" value="'.&mt('check all').'" '.          $togglebuttons = '<input type="button" value="'.&mt('check all').'" '.
                          'onclick="javascript:checkAll(document.'.$formname.'.archive)" />'.                           'onclick="javascript:checkAll(document.'.$formname.'.'.$chkname.')" />'.
                          '&nbsp;&nbsp;<input type="button" value="'.&mt('uncheck all').'"'.                           '&nbsp;&nbsp;<input type="button" value="'.&mt('uncheck all').'"'.
                          ' onclick="javascript:uncheckAll(document.'.$formname.'.archive)" />';                           ' onclick="javascript:uncheckAll(document.'.$formname.'.'.$chkname.')" />';
     }      }
     $display = '<form name="'.$formname.'" action="" method="post"'.$onsubmit.'>'."\n";      $display = '<form name="'.$formname.'" action="" method="post"'.$onsubmit.'>'."\n";
     if ($context eq 'imsexport') {      if ($context eq 'imsexport') {
Line 290  sub create_picker { Line 308  sub create_picker {
                 '</fieldset>';                  '</fieldset>';
         }          }
         $display .= '</div>';          $display .= '</div>';
     } elsif ($context eq 'examblock') {      } elsif (($context eq 'examblock') || ($context eq 'shorturls')) {
         $display .= $info.$togglebuttons;          $display .= $info.$togglebuttons;
     } elsif ($context eq 'dumpdocs') {      } elsif ($context eq 'dumpdocs') {
         $display .= $preamble.          $display .= $preamble.
Line 311  sub create_picker { Line 329  sub create_picker {
         $display .= '<th>'.&mt('Access blocked?').'</th>';          $display .= '<th>'.&mt('Access blocked?').'</th>';
     } elsif ($context eq 'dumpdocs') {      } elsif ($context eq 'dumpdocs') {
         $display .= '<th>'.&mt('Copy?').'</th>'.          $display .= '<th>'.&mt('Copy?').'</th>'.
                     '<th>'.&mt("Title in $crstype").                      '<th>'.&mt("Title in $crstype").'</th>'.
                     '<th>'.&mt('Internal Identifier').'</th>'.                      '<th>'.&mt('Internal Identifier').'</th>'.
                     '<th>'.&mt('Save as ...').'</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();      $display .= &Apache::loncommon::end_data_table_header_row();
     while ($curRes = $it->next()) {      while ($curRes = $it->next()) {
Line 339  sub create_picker { Line 360  sub create_picker {
                 }                  }
             }              }
             $count ++;              $count ++;
             my $currelem;              my ($currelem,$mapurl,$is_map);
             if ($context eq 'imsexport') {              if ($context eq 'imsexport') {
                 $currelem = $count+$boards+$startcount;                  $currelem = $count+$boards+$startcount;
             } else {              } else {
                 $currelem = $count+$startcount;                  $currelem = $count+$startcount;
             }              }
             $display .= &Apache::loncommon::start_data_table_row().              $display .= &Apache::loncommon::start_data_table_row()."\n";
                        '<td>'."\n".  
                        '<input type="checkbox" name="archive" value="'.$count.'" ';  
             if (($curRes->is_sequence()) || ($curRes->is_page())) {              if (($curRes->is_sequence()) || ($curRes->is_page())) {
                 $lastcontainer = $currelem;                  $lastcontainer = $currelem;
                 $display .= 'onclick="javascript:checkFolder(document.'.$formname.','."'$currelem'".')" ';                  $mapurl = (&Apache::lonnet::decode_symb($symb))[2];
                 my $mapurl = (&Apache::lonnet::decode_symb($symb))[2];                  $is_map = 1;
                 if ($currmaps{$mapurl}) {              }
                     $display .= 'checked="checked"';              if ($context eq 'shorturls') {
                     push(@checked_maps,$currelem);                  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 {              } else {
                 if ($curRes->is_problem()) {                  $display .= '<td><input type="checkbox" name="'.$chkname.'" value="'.$count.'" ';
                     $numprobs ++;                  if ($is_map) {
                 }                      $display .= 'onclick="javascript:checkFolder(document.'.$formname.','."'$currelem'".')" ';
                 $display .= 'onclick="javascript:checkResource(document.'.$formname.','."'$currelem'".')" ';                      if ($currmaps{$mapurl}) {
                 if ($currresources{$symb}) {                          $display .= 'checked="checked"';
                     $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 .= $disabled.' />'."\n";  
             if ($context eq 'dumpdocs') {              if ($context eq 'dumpdocs') {
                 $display .= '</td><td valign="top">';                  $display .= '</td><td valign="top">';
               } elsif ($context eq 'shorturls') {
                   $display .= '<td valign="top">';
             }              }
             for (my $i=0; $i<$depth; $i++) {              for (my $i=0; $i<$depth; $i++) {
                 $display .= "$whitespace\n";                  $display .= "$whitespace\n";
Line 476  sub create_picker { Line 511  sub create_picker {
                     '<input type="submit" name="dumpcourse" value="'.&mt("Copy $crstype Content").'" />'.                      '<input type="submit" name="dumpcourse" value="'.&mt("Copy $crstype Content").'" />'.
                     '</div>';                      '</div>';
         $numcount = $count + $startcount;          $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>';      $display .= '</form>';
     my $scripttag =       my $scripttag =
         &respicker_javascript($startcount,$numcount,$context,$formname,\%children,          &respicker_javascript($startcount,$numcount,$context,$formname,\%children,
                               \%hierarchy,\@checked_maps,$numhome);                                \%hierarchy,\@checked_maps,$numhome,$chkname);
     if ($context eq 'dumpdocs') {      if (($context eq 'dumpdocs') || ($context eq 'shorturls')) {
         return $scripttag.$display;           return $scripttag.$display; 
     }      }
     my ($title,$crumbs,$args);      my ($title,$crumbs,$args);
Line 498  sub create_picker { Line 540  sub create_picker {
         $output .= &Apache::lonhtmlcommon::breadcrumbs('IMS Export').          $output .= &Apache::lonhtmlcommon::breadcrumbs('IMS Export').
                    &Apache::londocs::startContentScreen('tools');                     &Apache::londocs::startContentScreen('tools');
     } elsif ($context eq 'dumpdocs') {      } elsif ($context eq 'dumpdocs') {
          $output .= &Apache::lonhtmlcommon::breadcrumbs('Copying to Authoring Space').          $output .= &Apache::lonhtmlcommon::breadcrumbs('Copying to Authoring Space').
                     &Apache::londocs::startContentScreen('tools');                     &Apache::londocs::startContentScreen('tools');
     }      }
     $output .= $display;      $output .= $display;
     if ($context eq 'examblock') {      if ($context eq 'examblock') {
Line 512  sub create_picker { Line 554  sub create_picker {
   
 sub respicker_javascript {  sub respicker_javascript {
     my ($startcount,$numitems,$context,$formname,$children,$hierarchy,      my ($startcount,$numitems,$context,$formname,$children,$hierarchy,
         $checked_maps,$numhome) = @_;          $checked_maps,$numhome,$chkname) = @_;
     return unless ((ref($children) eq 'HASH') && (ref($hierarchy) eq 'HASH')      my $check_uncheck = <<"FIRST";
                    && (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[  
 function checkAll(field) {  function checkAll(field) {
     if (field.length > 0) {      if (field.length > 0) {
         for (i = 0; i < field.length; i++) {          for (i = 0; i < field.length; i++) {
Line 546  function uncheckAll(field) { Line 575  function uncheckAll(field) {
         field.checked = false;          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) {  function checkFolder(form,item) {
     var elem = $elem;      var elem = $elem;
Line 699  END Line 753  END
 function writeToOpener(maps,resources) {  function writeToOpener(maps,resources) {
     var checkedmaps = '';      var checkedmaps = '';
     var checkedresources = '';      var checkedresources = '';
     for (var i=0; i<document.$formname.archive.length; i++) {      for (var i=0; i<document.$formname.${chkname}.length; i++) {
         if (document.$formname.archive[i].checked) {          if (document.$formname.${chkname}[i].checked) {
             var isResource = 1;              var isResource = 1;
             var include = 1;              var include = 1;
             var elemnum = i+1+$startcount;              var elemnum = i+1+$startcount;
Line 721  function writeToOpener(maps,resources) { Line 775  function writeToOpener(maps,resources) {
             }              }
             if (include == 1) {              if (include == 1) {
                 if (isResource == 1) {                  if (isResource == 1) {
                     checkedresources += document.$formname.archive[i].value+',';                      checkedresources += document.$formname.${chkname}[i].value+',';
                 } else {                  } else {
                     checkedmaps += document.$formname.archive[i].value+',';                      checkedmaps += document.$formname.${chkname}[i].value+',';
                 }                  }
             }              }
         }          }
Line 757  sub get_navmap_object { Line 811  sub get_navmap_object {
                                                        undef,{'only_body' => 1,}).                                                         undef,{'only_body' => 1,}).
                       '<h2>'.&mt('Resource Display Failed').'</h2>';                          '<h2>'.&mt('Resource Display Failed').'</h2>';  
         } elsif ($context eq 'dumpdocs') {          } elsif ($context eq 'dumpdocs') {
             $outcome = '<h2>'.&mt('Copying to Authoring Space unavailable');              $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">';          $outcome .= '<div class="LC_error">';
         if ($crstype eq 'Community') {          if ($crstype eq 'Community') {
Line 766  sub get_navmap_object { Line 822  sub get_navmap_object {
             $outcome .= &mt('Unable to retrieve information about course contents');              $outcome .= &mt('Unable to retrieve information about course contents');
         }          }
         $outcome .= '</div>';          $outcome .= '</div>';
         if (($context eq 'imsexport') || ($context eq 'dumpdocs')) {          if (($context eq 'imsexport') || ($context eq 'dumpdocs') || ($context eq 'shorturls') ) {
             $outcome .= '<a href="/adm/coursedocs">';              $outcome .= '<a href="/adm/coursedocs">';
             if ($crstype eq 'Community') {              if ($crstype eq 'Community') {
                 $outcome .= &mt('Return to Community Editor');                  $outcome .= &mt('Return to Community Editor');
Line 776  sub get_navmap_object { Line 832  sub get_navmap_object {
             $outcome .= '</a>';              $outcome .= '</a>';
             if ($context eq 'imsexport') {              if ($context eq 'imsexport') {
                 &Apache::lonnet::logthis('IMS export failed - could not create navmap object in '.lc($crstype).':'.$env{'request.course.id'});                  &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'});                  &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') {          } elsif ($context eq 'examblock') {
             $outcome .=  '<href="javascript:window.close();">'.&mt('Close window').'</a>';                       $outcome .=  '<href="javascript:window.close();">'.&mt('Close window').'</a>';         
Line 816  sub enumerate_course_contents { Line 874  sub enumerate_course_contents {
                     }                      }
                 }                  }
                 $count ++;                  $count ++;
                 if (($curRes->is_sequence()) || ($curRes->is_page())) {                  if ($context eq 'shorturls') {
                     $map_url->{$count} = (&Apache::lonnet::decode_symb($symb))[2];  
                 } else {  
                     $resource_symb->{$count} = $ressymb;                      $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();                  $titleref->{$count} = $curRes->title();
             }              }

Removed from v.1.14  
changed lines
  Added in v.1.17


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>