Annotation of rat/lonsequence.pm, revision 1.51

1.1       www         1: # The LearningOnline Network with CAPA
                      2: #
                      3: # Sequence Handler
                      4: #
1.51    ! raeburn     5: # $Id: lonsequence.pm,v 1.50 2018/04/14 17:52:53 raeburn Exp $
1.5       www         6: #
                      7: # Copyright Michigan State University Board of Trustees
                      8: #
                      9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                     10: #
                     11: # LON-CAPA is free software; you can redistribute it and/or modify
                     12: # it under the terms of the GNU General Public License as published by
                     13: # the Free Software Foundation; either version 2 of the License, or
                     14: # (at your option) any later version.
                     15: #
                     16: # LON-CAPA is distributed in the hope that it will be useful,
                     17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     19: # GNU General Public License for more details.
                     20: #
                     21: # You should have received a copy of the GNU General Public License
                     22: # along with LON-CAPA; if not, write to the Free Software
                     23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     24: #
                     25: # /home/httpd/html/adm/gpl.txt
                     26: #
                     27: # http://www.lon-capa.org/
                     28: #
1.1       www        29: 
1.33      jms        30: 
                     31: 
1.3       www        32: package Apache::lonsequence;
1.1       www        33: 
                     34: use strict;
                     35: use Apache::lonnet;
1.3       www        36: use Apache::Constants qw(:common :http REDIRECT);
1.1       www        37: use GDBM_File;
1.28      albertel   38: use LONCAPA::map();
1.49      raeburn    39: use LONCAPA::ltiutils;
1.41      foxr       40: use LONCAPA;
1.28      albertel   41: use Apache::lonpageflip();
                     42: use Apache::loncommon();
1.31      albertel   43: use Apache::groupsort();
1.16      www        44: use Apache::lonlocal;
1.46      raeburn    45: use Apache::lonnavmaps();
                     46: use Apache::lonenc();
1.30      albertel   47: use HTML::Entities();
1.1       www        48: 
1.12      www        49: my %selhash;
                     50: my $successtied;
1.8       www        51: 
                     52: # ----------------------------------------- Attempt to read from resource space
                     53: 
                     54: sub attemptread {
1.32      albertel   55:     my ($fn,$unsorted)=@_;
1.8       www        56:     &Apache::lonnet::repcopy($fn);
                     57:     if (-e $fn) {
1.32      albertel   58: 	return &LONCAPA::map::attemptread($fn,$unsorted);
1.8       www        59:     } else {
                     60:         return ();
                     61:     }
                     62: }
                     63: 
1.15      www        64: sub mapread {
                     65:     my $fn=shift;
                     66:     &Apache::lonnet::repcopy($fn);
                     67:     if (-e $fn) {
1.28      albertel   68: 	return &LONCAPA::map::mapread($fn,'');
1.15      www        69:     } else {
                     70:         return ();
                     71:     }
                     72: }
                     73: 
1.8       www        74: # ---------------------------------------------------------------- View Handler
                     75: 
                     76: sub viewmap {
1.9       www        77:     my ($r,$url)=@_;
1.26      albertel   78: 
                     79:     my $js;
                     80:     if ($env{'form.forceselect'}) {
                     81: 	$js = (<<ENDSCRIPT);
                     82: <script type="text/javascript">
1.8       www        83: 
                     84: function select_group() {
1.12      www        85:     window.location="/adm/groupsort?catalogmode=groupsec&mode=rat&acts="+document.forms.fileattr.acts.value;
1.8       www        86: }
                     87: 
                     88: function queue(val) {
                     89:     if (eval("document.forms."+val+".filelink.checked")) {
                     90: 	var l=val.length;
                     91: 	var v=val.substring(4,l);
                     92: 	document.forms.fileattr.acts.value+='1a'+v+'b';
                     93:     }
                     94:     else {
                     95: 	var l=val.length;
                     96: 	var v=val.substring(4,l);
                     97: 	document.forms.fileattr.acts.value+='0a'+v+'b';
                     98:     }
                     99: }
                    100: 
                    101: </script>
                    102: ENDSCRIPT
                    103:     }
1.26      albertel  104: 
                    105:     $r->print(&Apache::loncommon::start_page('Map Contents',$js).
                    106: 	      '<h1>'.$url.'</h1>');
1.12      www       107: # ------------------ This is trying to select. Provide buttons and tie %selhash
1.24      albertel  108:     if ($env{'form.forceselect'}) { $r->print(<<ENDSELECT);
1.38      bisitz    109: <form name="fileattr"><input type="hidden" name="acts" value="" />
                    110: <input type="button" name="close" value="CLOSE" onClick="self.close()" />
                    111: <input type="button" name="groupimport" value="GROUP IMPORT"
                    112: onClick="javascript:select_group()" />
1.8       www       113: </form>   
                    114: ENDSELECT
1.12      www       115:     my $diropendb = 
1.41      foxr      116:   LONCAPA::tempdir() .
                    117:     "$env{'user.domain'}\_$env{'user.name'}_sel_res.db";
1.13      albertel  118:         if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
1.24      albertel  119: 	    if ($env{'form.launch'} eq '1') {
1.12      www       120: 	       &start_fresh_session();
                    121: 	    }
                    122:             $successtied=1;
                    123: 
                    124: # - Evaluate actions from previous page (both cumulatively and chronologically)
1.31      albertel  125: 	    if ($env{'form.catalogmode'} eq 'import') {
                    126: 		&Apache::groupsort::update_actions_hash(\%selhash);
1.12      www       127: 	    }
                    128: # -
                    129:         }
1.8       www       130:     }
1.12      www       131: # ----------------------------- successtied is now '1' if in working selectmode
1.15      www       132:     my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),'');
                    133:     if ($fatal==1) {
1.37      bisitz    134:        $r->print('<p class="LC_warning">'
                    135:                 .&mt('Map contents are not shown in order.')
                    136:                 .'</p><br />');
1.15      www       137:     }
1.8       www       138:     my $idx=0;
1.45      raeburn   139:     foreach my $entry (&attemptread(&Apache::lonnet::filelocation('',$url))) {
                    140: 	if (defined($entry)) {
1.8       www       141:             $idx++;
1.12      www       142:             if ($successtied) { 
1.8       www       143: 		$r->print('<form name="form'.$idx.'">');
                    144:             }
1.45      raeburn   145: 	    my ($title,$url)=split(/\:/,$entry);
1.30      albertel  146: 	    $title = &LONCAPA::map::qtescape($title);
                    147: 	    unless ($title) { $title=(split(/\//,$url))[-1] };
                    148:             my $enc_title = &HTML::Entities::encode($title,'\'"<>&');
                    149: 	    unless ($title) {
                    150: 		$title='<i>'.&mt('Empty').'</i>';
                    151: 		$enc_title = &mt('Empty');
                    152: 	    }
                    153: 	    $url  = &LONCAPA::map::qtescape($url);
                    154:             my $enc_url = &HTML::Entities::encode($url,'\'"<>&');
1.8       www       155:             if ($url) {
1.12      www       156: 		if ($successtied) {
                    157: 		    my $checked='';
                    158: 	           if ($selhash{'store_'.$url}) {
1.38      bisitz    159: 	       	      $checked=' checked="checked"';
1.12      www       160: 	           }
                    161: 	           $selhash{"pre_${idx}_link"}=$url;
                    162: 	           $selhash{"pre_${idx}_title"}=$title;
1.30      albertel  163: 		    
                    164: 		    $url  = &HTML::Entities::encode($url, '\'"<>&');
1.8       www       165: 		    $r->print(<<ENDCHECKBOX);
                    166: <input type='checkbox' name='filelink' 
1.30      albertel  167: value='$enc_url' onClick='javascript:queue("form$idx")'$checked />
                    168: <input type='hidden' name='title' value='$enc_title' />
1.8       www       169: ENDCHECKBOX
                    170:                 }
1.30      albertel  171: 		$r->print('<a href="'.$enc_url.'">');
1.8       www       172:             }
1.30      albertel  173:             $r->print($enc_title);
1.8       www       174:             if ($url) { $r->print('</a>'); }
1.12      www       175:             if ($successtied) {
1.8       www       176: 		$r->print('</form>');
                    177:             } else {
1.39      bisitz    178: 		$r->print('<br />');
1.8       www       179:             }
                    180:         }
                    181:     }
1.26      albertel  182:     $r->print(&Apache::loncommon::end_page());
1.12      www       183:     if ($successtied) {
                    184: 	untie %selhash;
                    185:     }
1.8       www       186: }
                    187: 
1.12      www       188: # ----------------------------------------------------------- Clean out selhash
                    189: sub start_fresh_session {
1.45      raeburn   190:     foreach my $item (keys(%selhash)) {
                    191: 	if ($item =~ /^pre_/) {
                    192: 	    delete $selhash{$item};
1.12      www       193: 	}
1.45      raeburn   194: 	if ($item =~ /^store/) {
                    195: 	    delete $selhash{$item};
1.12      www       196: 	}
                    197:     }
                    198: }
                    199: 
                    200: 
1.1       www       201: # ================================================================ Main Handler
                    202: 
                    203: sub handler {
                    204:    my $r=shift;
                    205: 
                    206:    if ($r->header_only) {
1.16      www       207:       &Apache::loncommon::content_type($r,'text/html');
1.1       www       208:       $r->send_http_header;
                    209:       return OK;
                    210:    }
1.46      raeburn   211: 
                    212:    my $requrl=$r->uri;
1.8       www       213:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.46      raeburn   214:                                           ['forceselect','launch','navmap']);
                    215: 
                    216:    if (($env{'request.course.fn'}) && ($env{'form.navmap'}) && ($env{'request.course.id'})) {
                    217:        my $crstype = &Apache::loncommon::course_type();
                    218:        unless (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
                    219: 
                    220:            # Check for critical messages and redirect if present.
                    221:            my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents');
                    222:            if ($redirect) {
                    223:                &Apache::loncommon::content_type($r,'text/html');
                    224:                $r->header_out(Location => $url);
                    225:                return REDIRECT;
                    226:            }
                    227: 
                    228:            # Check if course needs to be re-initialized
                    229:            my $loncaparev = $r->dir_config('lonVersion');
                    230:            my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
                    231: 
                    232:            if ($result eq 'switch') {
                    233:                &Apache::loncommon::content_type($r,'text/html');
                    234:                $r->send_http_header;
                    235:                $r->print(&Apache::loncommon::check_release_result(@reinit));
                    236:                return OK;
                    237:            } elsif ($result eq 'update') {
                    238:                my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    239:                my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                    240:                my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                    241:                if ($ferr) {
                    242:                    my $requrl = $r->uri;
                    243:                    $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
                    244:                    $env{'user.reinit'} = 1;
                    245:                    return HTTP_NOT_ACCEPTABLE;
                    246:                }
                    247:            }
                    248: 
1.51    ! raeburn   249:            &Apache::loncommon::content_type($r,'text/html');
        !           250:            $r->send_http_header;
        !           251: 
        !           252:            my $mapurl = &Apache::lonnet::declutter($requrl);
        !           253:            my $maptitle = &Apache::lonnet::gettitle($mapurl);
        !           254:            my @crumbs = ({text => $maptitle, no_mt => 1});
        !           255:            my $args = {'bread_crumbs' => \@crumbs,
        !           256:                        'bread_crumbs_nomenu' => 1};
        !           257: 
1.46      raeburn   258:            # Create the nav map
                    259:            my $navmap = Apache::lonnavmaps::navmap->new();
                    260: 
                    261:            if (ref($navmap)) {
                    262:                # renderer call
                    263:                if (&Apache::lonnet::is_on_map($requrl)) {
1.50      raeburn   264:                    my ($ltiscope,$ltiuri);
1.49      raeburn   265:                    if (($env{'request.lti.login'}) && ($env{'request.lti.uri'})) {
                    266:                        my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    267:                        my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
1.50      raeburn   268:                        ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},$cdom,$cnum);
1.49      raeburn   269:                    }
1.51    ! raeburn   270:                    @crumbs = ();
1.50      raeburn   271:                    unless ($ltiscope eq 'resource') {
                    272:                        unless ($ltiscope eq 'map') {
                    273:                            @crumbs = ({text  => $crstype.' Contents',
                    274:                                        href  => "javascript:gopost('/adm/navmaps','')"});
                    275:                        }
1.49      raeburn   276:                        my $res = $navmap->getResourceByUrl($mapurl);
                    277:                        if (ref($res)) {
                    278:                            my $symb = $res->symb();
                    279:                            if ($symb) {
                    280:                                my ($parent) = &Apache::lonnet::decode_symb($res->symb());
1.50      raeburn   281:                                if (($parent ne $env{'course.'.$env{'request.course.id'}.'.url'}) &&
                    282:                                    !(($ltiscope eq 'map') && ($requrl eq $ltiuri))) {
1.49      raeburn   283:                                    my @mapcrumbs = $navmap->recursed_crumbs($parent);
                    284:                                    if (@mapcrumbs) {
                    285:                                        push(@crumbs,@mapcrumbs);
                    286:                                    }
1.48      raeburn   287:                                }
1.49      raeburn   288:                                $env{'request.symb'} = $symb;
1.46      raeburn   289:                            }
                    290:                        }
                    291:                    }
                    292:                    push(@crumbs,{text => $maptitle, no_mt => 1});
1.51    ! raeburn   293:                    $args = {'bread_crumbs' => \@crumbs,
        !           294:                             'bread_crumbs_nomenu' => 1};
1.46      raeburn   295:                    $r->print(&Apache::loncommon::start_page($maptitle,undef,$args));
                    296: 
                    297:                    my $renderArgs = { 'cols'                    => [0,1,2,3],
                    298:                                       'url'                     => $mapurl,
                    299:                                       'navmap'                  => $navmap,
                    300:                                       'suppressNavmap'          => 1,
                    301:                                       'suppressEmptySequences'  => 1,
                    302:                                       'filterFunc'              => undef,
                    303:                                       'resource_no_folder_link' => 1,
                    304:                                       'r'                       => $r,
                    305:                                       'caller'                  => 'sequence',
                    306:                                       'notools'                 => 1,
                    307:                                       'iterator_map'            => $mapurl,
                    308:                                     };
                    309: 
                    310:                    my $render = &Apache::lonnavmaps::render($renderArgs);
                    311: 
                    312:                    # If no resources were found let the user know.
                    313:                    if ($renderArgs->{'counter'} == 0) {
1.51    ! raeburn   314:                        $r->print('<p class="LC_info">'.
        !           315:                                  &mt('No items found in folder').
        !           316:                                  '</p>');
1.46      raeburn   317:                    }
                    318:                    $r->print(&Apache::loncommon::end_page());
1.51    ! raeburn   319:                } else {
        !           320:                    $r->print(&Apache::loncommon::start_page($maptitle,undef,$args).
        !           321:                              '<p class="LC_info">'.
        !           322:                              &mt('Folder no longer appears to be a part of the course').
        !           323:                              '</p>'.
        !           324:                              &Apache::loncommon::end_page());
1.46      raeburn   325:                }
1.51    ! raeburn   326:            } else {
        !           327:                $r->print(&Apache::loncommon::start_page($maptitle,undef,$args).
        !           328:                          '<p class="LC_warning">'.
        !           329:                          &mt('Error: could not determine contents of folder').
        !           330:                          '</p>'.
        !           331:                          &Apache::loncommon::end_page());
1.46      raeburn   332:            }
1.51    ! raeburn   333:            $r->rflush();
        !           334:            return OK;
1.46      raeburn   335:        }
                    336:    }
1.1       www       337: 
1.2       www       338:    my %hash;
1.1       www       339:    my %bighash;
1.2       www       340: 
1.12      www       341:    $successtied=0;
1.3       www       342: # ------------------------------------------------------------ Tie symb db file
1.9       www       343:   my $disurl='';
                    344:   my $dismapid='';
1.18      raeburn   345:   my $exitdisid = '';
                    346:   my $arrow_dir = '';
1.40      raeburn   347:   my $is_encrypted = '';
1.9       www       348: 
1.24      albertel  349:   if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) {
1.2       www       350:        my $last;
1.24      albertel  351:        if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.13      albertel  352:                     &GDBM_READER(),0640)) {
1.2       www       353: 	   $last=$hash{'last_direction'};
                    354:            untie(%hash);
                    355:        }
1.3       www       356:        my $direction='';
                    357:        my $prevmap='';
                    358:        if ($last) {
1.23      albertel  359: 	   ($prevmap,undef,$direction)=&Apache::lonnet::decode_symb($last);
1.3       www       360:        }
                    361: # ------------------------------------------------------------- Tie big db file
1.24      albertel  362:        if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.13      albertel  363:                     &GDBM_READER(),0640)) {
1.3       www       364: 	   my $disid='';
1.17      raeburn   365:            my $randomout ='';
1.10      www       366: 
1.3       www       367:            if ($direction eq 'back') {
                    368: 	       $disid=$bighash{'map_finish_'.$requrl};
                    369:            } else {
                    370:                $disid=$bighash{'map_start_'.$requrl};
1.18      raeburn   371:            }
1.3       www       372:            if ($disid) {
                    373: 	       $disurl=$bighash{'src_'.$disid};
1.4       www       374:                $dismapid=(split(/\./,$disid))[1];
1.25      albertel  375: 	       if (!$env{'request.role.adv'}) {
                    376: 		   $randomout = $bighash{'randomout_'.$disid};
                    377: 	       }
1.40      raeburn   378:                if (!$env{'request.role.adv'}) {
                    379:                    $is_encrypted = $bighash{'encrypted_'.$disid};
                    380:                }
1.24      albertel  381:            } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.18      raeburn   382:                     &GDBM_READER(),0640)) {
                    383:                $last=$hash{'last_known'};
                    384:                untie(%hash);
1.3       www       385:            }
1.18      raeburn   386: 
                    387: 
1.17      raeburn   388: # ----------- If this is an empty one, or hidden, skip to next non-empty or non-hidden one
1.18      raeburn   389:            while ( ((!$disurl) && ($disid)) || ($randomout && $disid) ) {
1.11      www       390: 	       $direction=($direction?$direction:'forward');
                    391:                ($disid,$requrl)=
                    392:                          &Apache::lonpageflip::fullmove($disid,
                    393:                            &Apache::lonnet::declutter($requrl),$direction);
                    394:                if ($disid) {
                    395: 	           $disurl=$bighash{'src_'.$disid};
                    396:                    $dismapid=(split(/\./,$disid))[1];
1.25      albertel  397: 		   if (!$env{'request.role.adv'}) {
                    398: 		       $randomout = $bighash{'randomout_'.$disid};
                    399: 		   }
1.40      raeburn   400:                    if (!$env{'request.role.adv'}) {
                    401:                        $is_encrypted = $bighash{'encrypted_'.$disid};
                    402:                    }
1.11      www       403:                }
                    404:  	   }
1.18      raeburn   405:            $exitdisid = $disid;
                    406:            $arrow_dir = $direction;
1.11      www       407: 
1.3       www       408: # --------------------------------------- Untie hash, make sure to come by here
                    409:            untie(%bighash);
1.9       www       410:        }
                    411:    }
                    412: 
                    413: # now either disurl is set (going to first page), or we need another display
                    414:    if ($disurl) {
1.3       www       415: # -------------------------------------------------- Has first or last resource
1.40      raeburn   416:       my $showdisurl = $disurl;
                    417:       if ($is_encrypted) {
                    418:           $showdisurl = &Apache::lonenc::encrypted($disurl);
                    419:       }
1.23      albertel  420:       &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid],
                    421: 				'last_known' => [$disurl,$dismapid]); 
1.16      www       422:       &Apache::loncommon::content_type($r,'text/html');
1.36      raeburn   423:       $r->header_out(Location => &Apache::lonnet::absolute_url($ENV{'SERVER_NAME'}).
1.40      raeburn   424:                                  $showdisurl);
1.9       www       425:       return REDIRECT;
1.1       www       426:    } else {
1.16      www       427:        &Apache::loncommon::content_type($r,'text/html');
1.9       www       428:        $r->send_http_header;
1.21      albertel  429:        if ($exitdisid eq '' && $arrow_dir ne '') {
1.18      raeburn   430:            my %lt =&Apache::lonlocal::texthash(
                    431:                    'nere' => 'Next resource could not be displayed',
                    432:                    'goba' => 'Go Back',
1.44      raeburn   433:                    'nacc' => 'Course Contents',
1.18      raeburn   434:                           );
1.44      raeburn   435:            if (&Apache::loncommon::course_type() eq 'Community') {
                    436:                $lt{'nav'} = &mt('Community Contents');
                    437:            }
1.42      raeburn   438:            my $warnmsg;
1.18      raeburn   439:            if ($arrow_dir eq 'forward') {
1.42      raeburn   440:                $warnmsg = &mt('As all folders and sequences '
                    441:                              .'following the current resource were empty, '
                    442:                              .'you have now reached the end of the course.');
1.18      raeburn   443:            } elsif ($arrow_dir eq 'back') {
1.43      raeburn   444:                $warnmsg = &mt('As all folders and sequences '
1.42      raeburn   445:                              .'preceding the current resource were empty, '
                    446:                              .'you have now reached the beginning of the course.');
1.18      raeburn   447:            }
1.26      albertel  448:            my $start_page=
                    449: 	       &Apache::loncommon::start_page('Empty Folder/Sequence');
                    450:            my $end_page=
                    451: 	       &Apache::loncommon::end_page();
1.18      raeburn   452:            $r->print(<<ENDNONE);
1.26      albertel  453: $start_page
1.18      raeburn   454: <h3>$lt{'nere'}</h3>
                    455: <p>$warnmsg</p>
                    456: <ul>
                    457:   <li><a href="javascript:history.go(-1)">$lt{'goba'}</a></li>
                    458:   <li><a href="/adm/navmaps">$lt{'nacc'}</a></li>
                    459: </ul>
1.26      albertel  460: $end_page
1.18      raeburn   461: ENDNONE
                    462:        } else {
                    463:            &viewmap($r,$requrl);
                    464:        }
1.9       www       465:        return OK;
1.1       www       466:    }
                    467: }
                    468: 
                    469: 1;
                    470: __END__
                    471: 
1.35      jms       472: =head1 NAME
                    473: 
                    474: Apache::lonsequence
                    475: 
                    476: =head1 SYNOPSIS
                    477: 
                    478: Handler for showing sequence objects of
                    479: educational resources.
                    480: 
                    481: This is part of the LearningOnline Network with CAPA project
                    482: described at http://www.lon-capa.org.
                    483: 
                    484: =head1 SUBROUTINES
                    485: 
                    486: =over
                    487: 
                    488: =item handler()
                    489: 
                    490: =item viewmap()
                    491: 
                    492: =item attemptread()
1.1       www       493: 
1.35      jms       494: =item mapread()
                    495: 
                    496: =item start_fresh_session()
                    497: 
                    498: =back
                    499: 
                    500: =cut
1.1       www       501: 
                    502: 
                    503: 
                    504: 
                    505: 

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