--- loncom/interface/loncourserespicker.pm 2013/01/15 17:39:58 1.5 +++ loncom/interface/loncourserespicker.pm 2024/12/20 12:25:13 1.20 @@ -1,6 +1,6 @@ # The LearningOnline Network # -# $Id: loncourserespicker.pm,v 1.5 2013/01/15 17:39:58 raeburn Exp $ +# $Id: loncourserespicker.pm,v 1.20 2024/12/20 12:25:13 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -33,53 +33,79 @@ loncourserespicker - Utilities to choose =head1 SYNOPSIS -loncourserespicker provides an interface for selecting which folders and/or -resources are to be either: +loncourserespicker provides either (1) an interface for selecting which +folders and/or resources are to be selected for a specific action, one of: -(a) exported to an IMS Content Package -(b) subject to access blocking for the duriation of an exam/quiz. +(a) export to an IMS Content Package +(b) be subject to access blocking for the duration of an exam/quiz. +(c) dump to an Authoring Space +(d) receive shortened URLs to be used when deep-linking into a course + +or (2) an interface for selecting a single folder or resource for which +existing passback credentials can be used to send scores to another Course +Management System (CMS). =head1 DESCRIPTION This module provides routines to generate a hierarchical display of folders -and resources in a course which can be selected for specific actions. - -The choice of items is copied back to the main window from which the pop-up -window used to display the Course Contents was opened. +and resources in a course which can be selected for specific actions. In +all except one use case all items in the course are shown. The case where +only a filtered list is shown is passback of scores, and filtering limits +folders and resources to those items for which passback credentials exist, +(and their parent folders). + +When the display is shown in a pop-up window, The choice of items will be +copied back to the main window from which the pop-up window used to display +the Course Contents was opened. =head1 OVERVIEW -The main subroutine: &create_picker() will display the hierarchy of folders, -sub-folders, and resources in the Main Course Documents area. Items can be -selected using checkboxes, and/or a "Check All" button. Selection of a folder -causes the contents of the folder to also be selected automatically. The -propagation of check status is recursive into sub-folders. Likewise, if an -item deep in a nested set of folders and sub-folders is unchecked, the -uncheck will propagate up through the hierarchy causing any folders at -a higher level to become unchecked. +In the cases where multiple items may be selected the main subroutine: +&create_picker() will display the hierarchy of folders, sub-folders, and +resources in the Main Content area. Items can be selected using checkboxes, +and/or a "Check All" button. Selection of a folder causes the contents of +the folder to also be selected automatically. The propagation of check +status is recursive into sub-folders. Likewise, if an item deep in a nested +set of folders and sub-folders is unchecked, the uncheck will propagate up +through the hierarchy causing any folders at a higher level to become +unchecked. + +In the case where only a single item may be selected the main subroutine: +&create_picker() will display the hierarchy of folders and sub-folders for +only those items for which passback credentials exist, There is a submit button, which will be named differently according to the -content in which resource/folder selection is being made. +context in which resource/folder selection is being made. -The two contexts currently supported are: IMS export and selection of +The five contexts currently supported are: IMS export, selection of content to be subject to access restructions for the duration of an -exam. +exam, selection of items for dumping to an Authoring Space, display or +creation of shortened URLs for deep-linking, and selection of a single +item for apssback of grades to another CMS. =head1 INTERNAL SUBROUTINES =item &create_picker() -Created HTML mark up to display contents of course with checkboxes to +In the cases where multiple items may be selected ... + +Creates HTML markup to display contents of course with checkboxes to select items. Checking a folder causes recursive checking of items within the folder. Unchecking a resource causing unchecking of folders containing the item back up to the top level. -Inputs: 7. +In the case where only a single item may be selected ... + +Creates HTML markup to display filtered contents of course with radio +buttons to select an item. + +Inputs: 13. - $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. @@ -95,23 +121,52 @@ Inputs: 7. - $block -- An internal ID (integer) used to track which exam block currently being configured. + - $preamble -- HTML form elements used to select Authoring Space + if more than one available, and also set name of 'Folder + in Authoring Space' where content will be dumped, when + context is 'dumpdocs'. + + - $numhome -- number of possible Authoring Spaces where content could + be dumped when context is 'dumpdocs'. + + - $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. + + - $passback -- Reference to hash: keys are symbs of course items for + which passback credentials exist. For each symb the + hash value is itself a hash of deeplink launch items + for that symb with inner hash key set to: + $linkuri\0$linkprotector\0$scope, and corresponding + value of 1. + + - $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, + and radio buttons will be disabled, if this is for + passback of scores to another CMS, + Output: $output is the HTML mark-up for display/selection of content - items in the pop-up window. + items, either in a pop-up window, or in the main window, + depending on context. =item &respicker_javascript() Creates javascript functions for checking/unchecking all items, and for recursive checking triggered by checking a folder, or recursive -(upeards) unchecking of an item within a folder. +(upwards) unchecking of an item within a folder. -Inputs: 7. +Inputs: 9. - $startcount -- Starting offset of form element numbering for items - - $numcount -- Total numer of folders and resources in course. + - $numcount -- Total number of folders and resources in course. - $context -- Context in which resources are being displayed - (imsexport or examblock). + (imsexport, examblock, dumpdocs, shorturls, or + crsauthored). - $formname -- Name of form. @@ -121,7 +176,13 @@ Inputs: 7. - $checked_maps -- Reference to array of folders currently checked. -Output: 1. Javascript (witthin tags. + - $numhome -- Number of possible Authoring Spaces on this server + (context is dumpdocs or crsauthored). + + - $chkname -- Name of checkboxes used to indicate selection of folder + or resource. + +Output: 1. Javascript (within tags. =item &get_navmap_object() @@ -132,7 +193,51 @@ no object instantiated. Inputs: 2. - $crstype -- Container type: Course or Community - - $context -- Context: imsexport or examblock + - $context -- Context: imsexport, examblock, dumpdocs, shorturls + or passback. + + +=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. + + +=item &enumerate_course_contents() + +Create hashes of maps (for folders/pages) and symbs (for resources) in +a course, where keys are numbers (starting with 1) and values are +map url, or symb, for an iteration through the course, as seen by +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 elements during dumping of selected course + content to Authoring Space. +(c) processing of checked checkboxes for creation of shortened URLs for + deep-linking to course content. + +Inputs: 7 + + $navmap - navmaps object + + $map_url - reference to hash to contain URLs of maps in course + + $resource_symb - reference to hash to contain symbs for + resources in course + + $title_ref - reference to hash containing titles for items in + course + + $context - examblock, dumpdocs or shorturls + + $cdom - course's domain + + $cnum - courseID + +Outputs: None + +Side Effects: $map_url and $resource_symb hashrefs are populated. + =over @@ -153,15 +258,72 @@ use Apache::lonlocal; use LONCAPA qw(:DEFAULT :match); sub create_picker { - my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block) = @_; + my ($navmap,$context,$formname,$crstype,$blockedmaps,$blockedresources,$block,$preamble, + $numhome,$uploadedfiles,$tiny,$passback,$readonly) = @_; return unless (ref($navmap)); - my ($it,$output,$numdisc,%maps,%resources,%discussiontime,%currmaps,%currresources); + my ($it,$output,$numdisc,%discussiontime,%currmaps,%currresources,%files, + %shorturls,%shownmaps,%shownsymbs,%recursed,%retrieved,%pb,$chkname); + $chkname = 'archive'; + if ($context eq 'shorturls') { + $chkname = 'addtiny'; + } elsif ($context eq 'passback') { + $chkname = 'passback'; + } $it = $navmap->getIterator(undef,undef,undef,1,undef,undef); if (ref($blockedmaps) eq 'HASH') { %currmaps = %{$blockedmaps}; } if (ref($blockedresources) eq 'HASH') { %currresources = %{$blockedresources}; + } elsif (ref($uploadedfiles) eq 'HASH') { + %files = %{$uploadedfiles}; + } elsif (ref($tiny) eq 'HASH') { + %shorturls = %{$tiny}; + } elsif ($context eq 'passback') { + if (ref($passback) eq 'HASH') { + %pb = %{$passback}; + foreach my $symb (keys(%pb)) { + my ($map,$id,$url) = &Apache::lonnet::decode_symb($symb); + my @recurseup; + if ($url =~ /\.(page|sequence)$/) { + @recurseup = $navmap->recurseup_maps($url); + $shownmaps{&Apache::lonnet::clutter($url)} = 1; + if (ref($pb{$symb}) eq 'HASH') { + foreach my $entry (keys(%{$pb{$symb}})) { + my $scope = (split("\0",$entry))[-1]; + if (($scope eq 'map') || ($scope eq 'rec')) { + my @contents; + if ($scope eq 'map') { + unless ($retrieved{$url} || $recursed{$url}) { + @contents = $navmap->retrieveResources($url,sub { $_[0]->is_gradable() },0); + $retrieved{$url} = 1; + } + } elsif ($scope eq 'rec') { + unless ($recursed{$url}) { + @contents = $navmap->retrieveResources($url,sub { $_[0]->is_gradable() },1,0,1); + my @subfolders = $navmap->retrieveResources($url,sub { $_[0]->is_map() },1,0,1); + if (@subfolders) { + map { $shownmaps{$_->src()} = 1; } @subfolders; + } + $recursed{$url} = 1; + } + } + if (@contents) { + map { $shownsymbs{$_->symb()} = 1; } @contents; + } + } + } + } + } else { + @recurseup = $navmap->recurseup_maps($map); + $shownmaps{&Apache::lonnet::clutter($map)} = 1; + $shownsymbs{$symb} = 1; + } + if (@recurseup) { + map { $shownmaps{&Apache::lonnet::clutter($_)} = 1; } @recurseup; + } + } + } } my @checked_maps; my $curRes; @@ -174,42 +336,63 @@ sub create_picker { my %children = (); my %hierarchy = (); my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons"); - my $whitespace = + my $whitespace = ''; - my $onsubmit; + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $crsprefix = &propath($cdom,$cnum).'/userfiles/'; + + my ($info,$display,$onsubmit,$togglebuttons,$disabled,$action); 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"'; + } } - my $display = - '
'; + if ($context eq 'passback') { + return $display; + } + my $scripttag = &respicker_javascript($startcount,$numcount,$context,$formname,\%children, - \%hierarchy,\@checked_maps); + \%hierarchy,\@checked_maps,$numhome,$chkname); + if (($context eq 'dumpdocs') || ($context eq 'shorturls')) { + return $scripttag.$display; + } my ($title,$crumbs,$args); - if ($context eq 'imsexport') { + if ($context eq 'imsexport') { $title = 'Export '.$crstype.' to IMS Package'; } elsif ($context eq 'examblock') { $title = 'Resources with Access blocked'; @@ -361,6 +719,9 @@ sub create_picker { if ($context eq 'imsexport') { $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 .= $display; if ($context eq 'examblock') { @@ -373,12 +734,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 $scripttag = <<"START"; - +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"; +