--- rat/lonsequence.pm 2007/07/11 23:51:02 1.31 +++ rat/lonsequence.pm 2022/10/19 00:03:12 1.57 @@ -2,7 +2,7 @@ # # Sequence Handler # -# $Id: lonsequence.pm,v 1.31 2007/07/11 23:51:02 albertel Exp $ +# $Id: lonsequence.pm,v 1.57 2022/10/19 00:03:12 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,6 +27,8 @@ # http://www.lon-capa.org/ # + + package Apache::lonsequence; use strict; @@ -34,10 +36,14 @@ use Apache::lonnet; use Apache::Constants qw(:common :http REDIRECT); use GDBM_File; use LONCAPA::map(); +use LONCAPA::ltiutils; +use LONCAPA; use Apache::lonpageflip(); use Apache::loncommon(); use Apache::groupsort(); use Apache::lonlocal; +use Apache::lonnavmaps(); +use Apache::lonenc(); use HTML::Entities(); my %selhash; @@ -46,10 +52,10 @@ my $successtied; # ----------------------------------------- Attempt to read from resource space sub attemptread { - my $fn=shift; + my ($fn,$unsorted)=@_; &Apache::lonnet::repcopy($fn); if (-e $fn) { - return &LONCAPA::map::attemptread($fn); + return &LONCAPA::map::attemptread($fn,$unsorted); } else { return (); } @@ -100,14 +106,15 @@ ENDSCRIPT '

'.$url.'

'); # ------------------ This is trying to select. Provide buttons and tie %selhash if ($env{'form.forceselect'}) { $r->print(< - - +
+ +
ENDSELECT my $diropendb = - "/home/httpd/perl/tmp/$env{'user.domain'}\_$env{'user.name'}_sel_res.db"; + LONCAPA::tempdir() . + "$env{'user.domain'}\_$env{'user.name'}_sel_res.db"; if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) { if ($env{'form.launch'} eq '1') { &start_fresh_session(); @@ -124,16 +131,18 @@ ENDSELECT # ----------------------------- successtied is now '1' if in working selectmode my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),''); if ($fatal==1) { - $r->print('

'.&mt('Map contents are not shown in order.').'


'); + $r->print('

' + .&mt('Map contents are not shown in order.') + .'


'); } my $idx=0; - foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) { - if (defined($_)) { + foreach my $entry (&attemptread(&Apache::lonnet::filelocation('',$url))) { + if (defined($entry)) { $idx++; if ($successtied) { $r->print('
'); } - my ($title,$url)=split(/\:/,$_); + my ($title,$url)=split(/\:/,$entry); $title = &LONCAPA::map::qtescape($title); unless ($title) { $title=(split(/\//,$url))[-1] }; my $enc_title = &HTML::Entities::encode($title,'\'"<>&'); @@ -147,7 +156,7 @@ ENDSELECT if ($successtied) { my $checked=''; if ($selhash{'store_'.$url}) { - $checked=" checked"; + $checked=' checked="checked"'; } $selhash{"pre_${idx}_link"}=$url; $selhash{"pre_${idx}_title"}=$title; @@ -166,7 +175,7 @@ ENDCHECKBOX if ($successtied) { $r->print('
'); } else { - $r->print('
'); + $r->print('
'); } } } @@ -178,12 +187,12 @@ ENDCHECKBOX # ----------------------------------------------------------- Clean out selhash sub start_fresh_session { - foreach (keys %selhash) { - if ($_ =~ /^pre_/) { - delete $selhash{$_}; + foreach my $item (keys(%selhash)) { + if ($item =~ /^pre_/) { + delete $selhash{$item}; } - if ($_ =~ /^store/) { - delete $selhash{$_}; + if ($item =~ /^store/) { + delete $selhash{$item}; } } } @@ -199,13 +208,136 @@ sub handler { $r->send_http_header; return OK; } - + + my $requrl=$r->uri; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, - ['forceselect','launch']); + ['forceselect','launch','navmap']); + + if (($env{'request.course.fn'}) && ($env{'form.navmap'}) && ($env{'request.course.id'})) { + my $crstype = &Apache::loncommon::course_type(); + unless (($crstype eq 'Placement') && (!$env{'request.role.adv'})) { + + # Check for critical messages and redirect if present. + my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents'); + if ($redirect) { + &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $url); + return REDIRECT; + } + + # Check if course needs to be re-initialized + my $loncaparev = $r->dir_config('lonVersion'); + my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev); + + if ($result eq 'switch') { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + $r->print(&Apache::loncommon::check_release_result(@reinit)); + return OK; + } elsif (($result eq 'main') || ($result eq 'both')) { + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum"); + if ($ferr) { + my $requrl = $r->uri; + $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; + $env{'user.reinit'} = 1; + return HTTP_NOT_ACCEPTABLE; + } + } + + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + + my $mapurl = &Apache::lonnet::declutter($requrl); + my $maptitle = &Apache::lonnet::gettitle($mapurl); + my @crumbs = ({text => $maptitle, no_mt => 1}); + my $args = {'bread_crumbs' => \@crumbs, + 'bread_crumbs_nomenu' => 1}; + + # Create the nav map + my $navmap = Apache::lonnavmaps::navmap->new(); + + if (ref($navmap)) { + # renderer call + if (&Apache::lonnet::is_on_map($requrl)) { + my ($ltiscope,$ltiuri); + if (($env{'request.lti.login'}) && ($env{'request.lti.uri'})) { + my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; + my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},$cdom,$cnum); + } + @crumbs = (); + unless ($ltiscope eq 'resource') { + unless ($ltiscope eq 'map') { + @crumbs = ({text => $crstype.' Contents', + href => "javascript:gopost('/adm/navmaps','')"}); + } + my $res = $navmap->getResourceByUrl($mapurl); + if (ref($res)) { + my $symb = $res->symb(); + if ($symb) { + my ($parent) = &Apache::lonnet::decode_symb($res->symb()); + if (($parent ne $env{'course.'.$env{'request.course.id'}.'.url'}) && + !(($ltiscope eq 'map') && ($requrl eq $ltiuri))) { + my @mapcrumbs = $navmap->recursed_crumbs($parent); + if (@mapcrumbs) { + push(@crumbs,@mapcrumbs); + } + } + $env{'request.symb'} = $symb; + } + } + } + push(@crumbs,{text => $maptitle, no_mt => 1}); + $args = {'bread_crumbs' => \@crumbs, + 'bread_crumbs_nomenu' => 1, + 'no_auto_mt_title' => 1}; + $r->print(&Apache::loncommon::start_page($maptitle,undef,$args)); + + my $renderArgs = { 'cols' => [0,1,2,3], + 'url' => $mapurl, + 'navmap' => $navmap, + 'suppressNavmap' => 1, + 'suppressEmptySequences' => 1, + 'filterFunc' => undef, + 'resource_no_folder_link' => 1, + 'r' => $r, + 'caller' => 'sequence', + 'notools' => 1, + 'iterator_map' => $mapurl, + }; + + my $render = &Apache::lonnavmaps::render($renderArgs); + + # If no resources were found let the user know. + if ($renderArgs->{'counter'} == 0) { + $r->print('

'. + &mt('No items found in folder'). + '

'); + } + $r->print(&Apache::loncommon::end_page()); + } else { + $r->print(&Apache::loncommon::start_page($maptitle,undef,$args). + '

'. + &mt('Folder no longer appears to be a part of the course'). + '

'. + &Apache::loncommon::end_page()); + } + } else { + $r->print(&Apache::loncommon::start_page($maptitle,undef,$args). + '

'. + &mt('Error: could not determine contents of folder'). + '

'. + &Apache::loncommon::end_page()); + } + $r->rflush(); + return OK; + } + } my %hash; my %bighash; - my $requrl=$r->uri; $successtied=0; # ------------------------------------------------------------ Tie symb db file @@ -213,6 +345,7 @@ sub handler { my $dismapid=''; my $exitdisid = ''; my $arrow_dir = ''; + my $is_encrypted = ''; if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) { my $last; @@ -242,7 +375,8 @@ sub handler { $dismapid=(split(/\./,$disid))[1]; if (!$env{'request.role.adv'}) { $randomout = $bighash{'randomout_'.$disid}; - } + $is_encrypted = $bighash{'encrypted_'.$disid}; + } } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', &GDBM_READER(),0640)) { $last=$hash{'last_known'}; @@ -261,7 +395,8 @@ sub handler { $dismapid=(split(/\./,$disid))[1]; if (!$env{'request.role.adv'}) { $randomout = $bighash{'randomout_'.$disid}; - } + $is_encrypted = $bighash{'encrypted_'.$disid}; + } } } $exitdisid = $disid; @@ -275,29 +410,42 @@ sub handler { # now either disurl is set (going to first page), or we need another display if ($disurl) { # -------------------------------------------------- Has first or last resource - &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid], - 'last_known' => [$disurl,$dismapid]); + my $showdisurl = $disurl; + if ($is_encrypted) { + $showdisurl = &Apache::lonenc::encrypted($disurl); + } + if ($disurl =~ m{^/adm/navmaps(\?|$)}) { + &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid]); + } else { + &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid], + 'last_known' => [$disurl,$dismapid]); + } &Apache::loncommon::content_type($r,'text/html'); - $r->header_out(Location => 'http://'.$ENV{'HTTP_HOST'}.$disurl); + $r->header_out(Location => &Apache::lonnet::absolute_url(). + $showdisurl); return REDIRECT; } else { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; if ($exitdisid eq '' && $arrow_dir ne '') { my %lt =&Apache::lonlocal::texthash( - 'back' => 'beginning', - 'forward' => 'end', 'nere' => 'Next resource could not be displayed', 'goba' => 'Go Back', - 'nacc' => 'Navigate Course Content', + 'nacc' => 'Course Contents', ); - my $warnmsg = &mt('As all folders and sequences '); + if (&Apache::loncommon::course_type() eq 'Community') { + $lt{'nav'} = &mt('Community Contents'); + } + my $warnmsg; if ($arrow_dir eq 'forward') { - $warnmsg .= &mt('following the current resource were empty').','; + $warnmsg = &mt('As all folders and sequences ' + .'following the current resource were empty, ' + .'you have now reached the end of the course.'); } elsif ($arrow_dir eq 'back') { - $warnmsg .= &mt('preceding the current resource were empty').','; + $warnmsg = &mt('As all folders and sequences ' + .'preceding the current resource were empty, ' + .'you have now reached the beginning of the course.'); } - $warnmsg .= &mt('you have now reached the').' '.$lt{$arrow_dir}.' '.&mt('of the course.'); my $start_page= &Apache::loncommon::start_page('Empty Folder/Sequence'); my $end_page= @@ -322,7 +470,35 @@ ENDNONE 1; __END__ +=head1 NAME + +Apache::lonsequence + +=head1 SYNOPSIS + +Handler for showing sequence objects of +educational resources. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 SUBROUTINES + +=over + +=item handler() + +=item viewmap() + +=item attemptread() + +=item mapread() + +=item start_fresh_session() + +=back +=cut