Return to lonsequence.pm CVS log

Up to [LON-CAPA] / rat

- New items added to big hash, where keys are map_breadcrumbs_$pc.
- Values differ from those for corresponding map_hierarchy_$pc items
  through omission of intermediate folders not shown in Course Contents.
- Used to genarate breadcrumb trail when displaying resource in course
  context contains with clickable links for folder hierarchy.

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