File:  [LON-CAPA] / rat / lonpageflip.pm
Revision 1.108: download - view: text, annotated - select for diffs
Fri Aug 6 01:27:04 2021 UTC (2 years, 8 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD
- Bug 6907 Content in a course can be set to be deep-link only.
  - deeplink parameter has 5 components:
    state, others, listing, scope, protect and menus.
  - if value of others component is hide, then resources besides deeplinked
    item(s) are not accessible to students.

    1: # The LearningOnline Network with CAPA
    2: #
    3: # Page flip handler
    4: #
    5: # $Id: lonpageflip.pm,v 1.108 2021/08/06 01:27:04 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::lonpageflip;
   33: 
   34: use strict;
   35: use LONCAPA;
   36: use Apache::Constants qw(:common :http REDIRECT);
   37: use Apache::lonnet;
   38: use Apache::loncommon();
   39: use Apache::lonnavmaps();
   40: use Apache::lonuserstate;
   41: use Apache::lonlocal;
   42: use HTML::TokeParser;
   43: use GDBM_File;
   44: 
   45: # ========================================================== Module Global Hash
   46:   
   47: my %hash;
   48: 
   49: sub cleanup {
   50:     if (tied(%hash)){
   51: 	&Apache::lonnet::logthis('Cleanup pageflip: hash');
   52:         unless (untie(%hash)) {
   53: 	    &Apache::lonnet::logthis('Failed cleanup pageflip: hash');
   54:         }
   55:     }
   56:     return OK;
   57: }
   58: 
   59: sub addrid {
   60:     my ($current,$new,$condid)=@_;
   61:     unless ($condid) { $condid=0; }
   62: 
   63: 	if ($current) {
   64: 	    $current.=','.$new;
   65:         } else {
   66:             $current=''.$new;
   67:         }
   68: 
   69:     return $current;
   70: }
   71: 
   72: sub fullmove {
   73:     my ($rid,$mapurl,$direction)=@_;
   74:     if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
   75:                         &GDBM_READER(),0640)) {
   76: 	($rid,$mapurl)=&move($rid,$mapurl,$direction);
   77:         untie(%hash);
   78:     }
   79:     return($rid,$mapurl);
   80: }
   81: 
   82: sub hash_src {
   83:     my ($id)=@_;
   84:     my ($mapid,$resid)=split(/\./,$id);
   85:     my $symb=&Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},
   86: 					  $resid,$hash{'src_'.$id});
   87:     my $anchor;
   88:     if ($hash{'ext_'.$id} eq 'true:') {
   89:         if ($hash{'src_'.$id} =~ /(\#.+)$/) {
   90:             $anchor = $1;
   91:         }
   92:     }
   93:     if ($hash{'encrypted_'.$id}) {
   94: 	return (&Apache::lonenc::encrypted($hash{'src_'.$id}),
   95: 		&Apache::lonenc::encrypted($symb),
   96:                 $hash{'encrypted_'.$id},$anchor);
   97:     }
   98:     return ($hash{'src_'.$id},$symb,$hash{'encrypted_'.$id},$anchor);
   99: }
  100: 
  101: sub move {
  102:     my ($next,$endupmap,$direction,$firstres) = @_;
  103:     my $safecount=0;
  104:     my $allowed=0;
  105:     my $deeplinkonly=0;
  106:     my $deeplinkchecked;
  107:     my $deeplink_login_pc;
  108:     my $prev=$next;
  109:     my ($prevmapid)=split(/\./,$next);
  110:     do {
  111: 	($next,$endupmap)=&get_next_possible_move($next,$endupmap,$direction);
  112: 
  113: 	my $url = $hash{'src_'.$next};
  114: 	my ($mapid,$resid)=split(/\./,$next);
  115: 	my $symb = &Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},
  116: 						$resid,$url);
  117: 	if ($url eq '' || $symb eq '') {
  118: 	    $allowed = 0;
  119: 	} else {
  120:             my $nodeeplinkcheck = 0;
  121:             if ($hash{'is_map_'.$next}) {
  122:                 $nodeeplinkcheck = 1;
  123:             }
  124: 	    my $priv = &Apache::lonnet::allowed('bre',$url,$symb,'','','','',$nodeeplinkcheck);
  125: 	    $allowed = (($priv eq 'F') || ($priv eq '2') || ($priv eq 'A'));
  126: 	}
  127:         $deeplinkonly = 0;
  128:         if ($hash{'deeplinkonly_'.$next}) {
  129:             my ($value,$level) = split(/:/,$hash{'deeplinkonly_'.$next});
  130:             my ($state,$others,$listed,$scope,$protect) = split(/,/,$value);
  131:             unless (($state eq 'both') || ($hash{'is_map_'.$next})) {
  132:                 if ($level eq 'resource') {
  133:                     $deeplinkonly = 1;
  134:                 } elsif ($level eq 'map') {
  135:                     if ($scope eq 'rec') {
  136:                         unless ($mapid == $prevmapid) {
  137:                             unless ($deeplinkchecked) {
  138:                                 $deeplink_login_pc = &get_deeplink_login_pc();
  139:                                 $deeplinkchecked = 1;
  140:                             }
  141:                             if ($deeplink_login_pc) {
  142:                                 my $poss_map_pc;
  143:                                 if ($hash{'is_map_'.$next}) {
  144:                                     $poss_map_pc = $hash{'map_pc_'.$url};
  145:                                 } else {
  146:                                     $poss_map_pc = $hash{'map_pc_'.$hash{'map_id_'.$mapid}};
  147:                                 }
  148:                                 unless ($deeplink_login_pc == $poss_map_pc) {
  149:                                     unless (grep(/^$deeplink_login_pc$/,split(/,/,$hash{'map_hierarchy_'.$poss_map_pc}))) {
  150:                                         $deeplinkonly = 1;
  151:                                     }
  152:                                 }
  153:                             } else {
  154:                                 $deeplinkonly = 1;
  155:                             }
  156:                         }
  157:                     } elsif ($mapid != $prevmapid) {
  158:                         $deeplinkonly = 1;
  159:                     }
  160:                 }
  161:             }
  162:         } elsif (($hash{'deeplinkonly_'.$prev}) && (!$firstres)) {
  163:             my ($value,$level) = split(/:/,$hash{'deeplinkonly_'.$prev});
  164:             my ($state,$others,$listed,$scope,$protect) = split(/,/,$value);
  165:             unless (($state eq 'both') || ($hash{'is_map_'.$prev})) {
  166:                 if ($level eq 'resource') {
  167:                     $deeplinkonly = 1;
  168:                 } elsif ($level eq 'map') {
  169:                     if ($scope eq 'rec') {
  170:                         unless ($mapid == $prevmapid) {
  171:                             unless ($deeplinkchecked) {
  172:                                 $deeplink_login_pc = &get_deeplink_login_pc();
  173:                                 $deeplinkchecked = 1;
  174:                             }
  175:                             if ($deeplink_login_pc) {
  176:                                 my $poss_map_pc;
  177:                                 if ($hash{'is_map_'.$prev}) {
  178:                                     $poss_map_pc = $hash{'map_pc_'.$url};
  179:                                 } else {
  180:                                     $poss_map_pc = $hash{'map_pc_'.$hash{'map_id_'.$mapid}};
  181:                                 }
  182:                                 unless ($deeplink_login_pc == $poss_map_pc) {
  183:                                     unless (grep(/^$deeplink_login_pc$/,split(/,/,$hash{'map_hierarchy_'.$poss_map_pc}))) {
  184:                                         $deeplinkonly = 1;
  185:                                     }
  186:                                 }
  187:                             }
  188:                         }
  189:                     } else {
  190:                         if ($mapid != $prevmapid) {
  191:                             $deeplinkonly = 1;
  192:                         }
  193:                     }
  194:                 }
  195:             }
  196:         }
  197: 	$safecount++;
  198:     } while (   ($next)
  199: 	     && ($next!~/\,/)
  200: 	     && (
  201: 		    (!$hash{'src_'.$next})
  202: 		 || (
  203:                         (!$env{'request.role.adv'})
  204:                      && (($hash{'randomout_'.$next})
  205:                      ||  ($deeplinkonly)
  206:                      ||  ($hash{'deeplinkout_'.$next}))
  207: 		    )
  208: 		 || (!$allowed)
  209: 		)
  210: 	     && ($safecount<10000));
  211: 
  212:     return ($next,$endupmap);
  213: }
  214: 
  215: sub get_next_possible_move {
  216:     my ($rid,$mapurl,$direction)=@_;
  217:     my $startoutrid=$rid;
  218: 
  219:     my $next='';
  220: 
  221:               my $mincond=1;
  222:               my $posnext='';
  223:               if ($direction eq 'forward') {
  224: # --------------------------------------------------------------------- Forward
  225:                   while ($hash{'type_'.$rid} eq 'finish') {
  226: 	             $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
  227:                   }
  228: 		  foreach my $id (split(/\,/,$hash{'to_'.$rid})) {
  229: 		     my $condition= $hash{'conditions_'.$hash{'goesto_'.$id}};
  230: 		     my $rescond  = &Apache::lonnet::docondval($condition);
  231: 		     my $linkcond = &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$id}});
  232: 		     my $thiscond = ($rescond<$linkcond)?$rescond:$linkcond;
  233: 		     if ($thiscond>=$mincond) {
  234: 		          if ($posnext) {
  235: 		             $posnext.=','.$id.':'.$thiscond;
  236:                           } else {
  237:                              $posnext=$id.':'.$thiscond;
  238: 		          }
  239:                           if ($thiscond>$mincond) { $mincond=$thiscond; }
  240: 	              }
  241:                   }
  242: 		  foreach my $id (split(/\,/,$posnext))  {
  243:                       my ($linkid,$condval)=split(/\:/,$id);
  244:                       if ($condval>=$mincond) {
  245: 		          $next=&addrid($next,$hash{'goesto_'.$linkid},
  246:                                 $hash{'condid_'.$hash{'undercond_'.$linkid}});
  247:                       }
  248:                   }
  249:                   if ($hash{'is_map_'.$next}) {
  250: # This jumps to the beginning of a new map (going down level)
  251:                       if (
  252:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
  253: 			  $mapurl=$hash{'src_'.$next};
  254: 			  $next=$hash{'map_start_'.$hash{'src_'.$next}};
  255:                      } elsif (
  256: # This jumps back up from an empty sequence, to a page up one level
  257:                          $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
  258:                          $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
  259:                      }
  260:                   } elsif 
  261:                     ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
  262: # This comes up from a map (coming up one level);
  263: 		      $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
  264: 		  }
  265:               } elsif ($direction eq 'back') {
  266: # ------------------------------------------------------------------- Backwards
  267:                  while ($hash{'type_'.$rid} eq 'start') {
  268: 	             $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
  269: 		 }
  270: 		 foreach my $id (split(/\,/,$hash{'from_'.$rid})) {
  271: 		     my $condition= $hash{'conditions_'.$hash{'comesfrom_'.$id}};
  272: 		     my $rescond  = &Apache::lonnet::docondval($condition);
  273: 		     my $linkcond = &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$id}});
  274: 		     my $thiscond = ($rescond<$linkcond)?$rescond:$linkcond;
  275: 		     if ($thiscond>=$mincond) {
  276: 			 if ($posnext) {
  277: 		             $posnext.=','.$id.':'.$thiscond;
  278: 			 } else {
  279:                              $posnext=$id.':'.$thiscond;
  280: 			 }
  281: 			 if ($thiscond>$mincond) { $mincond=$thiscond; }
  282: 		     }
  283: 		 }
  284: 		 foreach my $id (split(/\,/,$posnext)) {
  285: 		     my ($linkid,$condval)=split(/\:/,$id);
  286: 		     if ($condval>=$mincond) {
  287: 			 $next=&addrid($next,$hash{'comesfrom_'.$linkid},
  288: 				       $hash{'condid_'.$hash{'undercond_'.$linkid}});
  289: 		     }
  290: 		 }
  291:                   if ($hash{'is_map_'.$next}) {
  292: # This jumps to the end of a new map (going down one level)
  293:                       if (
  294:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
  295: 			  $mapurl=$hash{'src_'.$next};
  296: 			  $next=$hash{'map_finish_'.$hash{'src_'.$next}};
  297:                       } elsif (
  298:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
  299: # This jumps back up from an empty sequence, to a page up one level
  300:                           $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
  301:                       }
  302:                   } elsif 
  303:                     ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
  304: # This comes back up from a map (going up one level);
  305: 		      $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
  306:                   }
  307: 	      }
  308:               return ($next,$mapurl);
  309: }
  310: 
  311: sub first_accessible_resource {
  312:     my $furl;
  313:     if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
  314: 	    &GDBM_READER(),0640)) {
  315: 	$furl=$hash{'first_url'};
  316: 	my (%args,$url,$argstr);
  317: 	if ($furl =~ m{^/enc/}) {
  318: 	    ($url,$argstr) = split(/\?/,&Apache::lonenc::unencrypted($furl));
  319: 	} else {
  320: 	    ($url,$argstr) = split(/\?/,$furl);
  321: 	}
  322: 	foreach my $pair (split(/\&/,$argstr)) {
  323: 	    my ($name,$value) = split(/=/,$pair);
  324: 	    $args{&unescape($name)} = &unescape($value);
  325: 	}
  326:         my $priv = &Apache::lonnet::allowed('bre',$url,$args{'symb'});
  327:         my $allowed = (($priv eq 'F') || ($priv eq '2') || ($priv eq 'A'));
  328:         if (!$allowed) {
  329: # Wow, we cannot see this ... move forward to the next one that we can see
  330: 	    my ($newrid,$newmap)=&move($hash{'first_rid'},$hash{'first_mapurl'},'forward',1);
  331: # Build the new URL
  332:             if ($newrid eq '') {
  333:                 $furl = '/adm/navmaps';
  334:             } else {
  335: 	        my ($newmapid,$newresid)=split(/\./,$newrid);
  336: 	        my $symb=&Apache::lonnet::encode_symb($newmap,$newresid,$hash{'src_'.$newrid});
  337: 	        $furl=&add_get_param($hash{'src_'.$newrid},{ 'symb' => $symb });
  338: 	        if ($hash{'encrypted_'.$newrid}) {
  339: 		    $furl=&Apache::lonenc::encrypted($furl);
  340: 	        }
  341:             }
  342: 	}
  343: 	untie(%hash);
  344: 	return $furl;
  345:     } else {
  346: 	return '/adm/navmaps';
  347:     }
  348: }
  349: 
  350: sub first_answerable_ressymb {
  351:     my $navmap = Apache::lonnavmaps::navmap->new;
  352:     return unless (ref($navmap));
  353:     my $iterator = $navmap->getIterator(undef,undef,undef,1);
  354:     return unless (ref($iterator));
  355:     my ($curRes,$result);
  356:     while ($curRes = $iterator->next()) {
  357:         if (ref($curRes) && $curRes->is_problem()) {
  358:             foreach my $part (@{$curRes->parts()}) {
  359:                 if ($curRes->tries($part) < $curRes->maxtries($part)) {
  360:                     $result = $curRes->link().'?symb='.$curRes->shown_symb();
  361:                     last;
  362:                 }    
  363:             }
  364:         }
  365:     }
  366:     if ($result) {
  367:         return $result; 
  368:     } else {
  369:         return &first_accessible_resource(); 
  370:     }
  371: }
  372: 
  373: sub check_http_req {
  374:     my ($srcref,$hostname) = @_;
  375:     return unless (ref($srcref) eq 'SCALAR');
  376:     my $usehttp;
  377:     if ($env{'request.course.id'}) {
  378:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  379:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  380:         if (($$srcref =~ m{^\Q/public/$cdom/$cnum/syllabus\E($|\?)}) &&
  381:             ($ENV{'SERVER_PORT'} == 443) &&
  382:             ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://})) {
  383:             unless ((&Apache::lonnet::uses_sts()) ||
  384:                     (&Apache::lonnet::waf_allssl($hostname))) {
  385:                 $$srcref .= (($$srcref =~/\?/)? '&':'?') . 'usehttp=1';
  386:                 $usehttp = 1;
  387:             }
  388:         } elsif (($$srcref =~ m{^\Q/adm/wrapper/ext/\E(?!https:)}) &&
  389:                  ($ENV{'SERVER_PORT'} == 443)) {
  390:             unless ((&Apache::lonnet::uses_sts()) ||
  391:                     (&Apache::lonnet::waf_allssl($hostname))) {
  392:                 my ($url,$anchor) = ($$srcref =~ /^([^\#]+)(?:|(\#[^\#]+))$/);
  393:                 $$srcref = $url . (($$srcref =~/\?/)? '&':'?') . 'usehttp=1' .$anchor; 
  394:                 $usehttp = 1;
  395:             }
  396:         }
  397:     }
  398:     return $usehttp;
  399: }
  400: 
  401: sub reinited_js {
  402:     my ($url,$cid,$timeout) = @_;
  403:     if (!$timeout) {
  404:         $timeout = 0;
  405:     }
  406:     return <<"END";
  407: <script type="text/javascript">
  408: // <![CDATA[
  409: setTimeout(function() {
  410:     var newurl = '$url';
  411:     if (document.getElementById('LC_update_$cid')) {
  412:         document.getElementById('LC_update_$cid').style.display = 'none';
  413:     }
  414:     if ((newurl !== null) && (newurl !== '') && (newurl !== 'undefined')) {
  415:         window.location.href = "$url";
  416:     }
  417: }, $timeout);
  418: // ]]>
  419: </script>
  420: END
  421: }
  422: 
  423: sub get_deeplink_login_pc {
  424:     my $deeplink_login_pc;
  425:     if (($env{'request.deeplink.login'}) && ($env{'request.course.id'})) {
  426:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  427:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  428:         if ($env{'request.deeplink.login'}) {
  429:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  430:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  431:             my $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
  432:             if ($deeplink_symb) {
  433:                 my $loginmap;
  434:                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
  435:                     $loginmap = &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
  436:                 } else {
  437:                     $loginmap = &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($deeplink_symb))[0]);
  438:                 }
  439:                 $deeplink_login_pc = $hash{'map_pc_'.$loginmap};
  440:             }
  441:         }
  442:     }
  443:     return $deeplink_login_pc;
  444: }
  445: 
  446: # ================================================================ Main Handler
  447: 
  448: sub handler {
  449:    my $r=shift;
  450: 
  451: # ------------------------------------------- Set document type for header only
  452: 
  453:   if ($r->header_only) {
  454:       &Apache::loncommon::content_type($r,'text/html');
  455:       $r->send_http_header;
  456:       return OK;
  457:   }
  458: 
  459:   my %cachehash=(); 
  460:   my $multichoice=0;
  461:   my %multichoicehash=();
  462:   my %prog_state=();
  463:   my ($redirecturl,$redirectsymb,$enc,$anchor,$deeplinklevel);
  464:   my $next='';
  465:   my $hostname = $r->hostname();
  466:   my @possibilities=();
  467:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['postdata']);
  468:   if (($env{'form.postdata'})&&($env{'request.course.fn'})) {
  469:       my ($direction,$currenturl) = ($env{'form.postdata'}=~/(\w+)\:(.*)/);
  470:       if ($currenturl=~m|^/enc/|) {
  471:           $currenturl=&Apache::lonenc::unencrypted($currenturl);
  472:       }
  473:       $currenturl=~s/\.\d+\.(\w+)$/\.$1/;
  474:       $currenturl=~s/^https?\:\/\///;
  475:       $currenturl=~s/^[^\/]+//;
  476:       my ($preupdatepos,$last,$reinitcheck);
  477:       if ($direction eq 'return') {
  478:           if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  479:                     &GDBM_READER(),0640)) {
  480:               $last=$hash{'last_known'};
  481:               untie(%hash);
  482:           }
  483:       } elsif ($direction eq 'firstanswerable') {
  484:           my $furl = &first_answerable_ressymb();
  485:           my $usehttp = &check_http_req(\$furl,$hostname);
  486:           if (($usehttp) && ($hostname ne '')) {
  487:               $furl='http://'.$hostname.$furl;
  488:           } else {
  489:               $furl=&Apache::lonnet::absolute_url().$furl;
  490:           }
  491:           &Apache::loncommon::content_type($r,'text/html');
  492:           $r->header_out(Location => $furl);
  493:           return REDIRECT;
  494:       } elsif ($direction eq 'endplacement') {
  495:           &Apache::loncommon::content_type($r,'text/html');
  496:           $r->send_http_header;
  497:           $r->print(&Apache::lonplacementtest::showresult());
  498:           return OK;
  499:       }
  500:       if ($env{'request.course.id'}) {
  501:           # Check if course needs to be re-initialized
  502:           my $loncaparev = $r->dir_config('lonVersion');
  503:           ($reinitcheck,my @reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
  504:           if ($reinitcheck eq 'switch') {
  505:               &Apache::loncommon::content_type($r,'text/html');
  506:               $r->send_http_header;
  507:               $r->print(&Apache::loncommon::check_release_result(@reinit));
  508:               return OK;
  509:           } elsif ($reinitcheck eq 'update') {
  510:               my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  511:               my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
  512:               $preupdatepos = &Apache::lonnet::symbread($currenturl);
  513:               unless ($direction eq 'return') {
  514:                   if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  515:                                 &GDBM_READER(),0640)) {
  516:                       $last=$hash{'last_known'};
  517:                       untie(%hash);
  518:                   }
  519:               }
  520:               &Apache::loncommon::content_type($r,'text/html');
  521:               $r->send_http_header;
  522:               $r->print(&Apache::loncommon::start_page('Content Changed'));
  523:               my $preamble = '<div id="LC_update_'.$env{'request.course.id'}.'" class="LC_info">'.
  524:                              '<br />'.
  525:                              &mt('Your course session is being updated because of recent changes by course personnel.').
  526:                              ' '.&mt('Please be patient').'.<br /></div>'.
  527:                              '<div style="padding:0;clear:both;margin:0;border:0"></div>';
  528:               %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,undef,$preamble);
  529:               &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Updating course'));
  530:               my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
  531:               &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Finished!'));
  532:               if ($ferr) {
  533:                   &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  534:                   my $requrl = $r->uri;
  535:                   $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
  536:                   $env{'user.reinit'} = 1;
  537:                   return HTTP_NOT_ACCEPTABLE;
  538:               } else {
  539:                   if ($last) {
  540:                       my ($murl,$id,$fn)=&Apache::lonnet::decode_symb($last);
  541:                       unless (&Apache::lonnet::symbverify($last,$fn)) {
  542:                           undef($last);
  543:                       }
  544:                   }
  545:               }
  546:           }
  547:       }
  548:       if ($direction eq 'firstres') {
  549: 	  my $furl=&first_accessible_resource();
  550:           my $usehttp = &check_http_req(\$furl,$hostname);
  551:           if (($usehttp) && ($hostname ne '')) {
  552:               $furl='http://'.$hostname.$furl;
  553:           } else {
  554:               $furl=&Apache::lonnet::absolute_url().$furl;
  555:           }
  556:           if ($reinitcheck eq 'update') {
  557:               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  558:               $r->print(&reinited_js($furl,$env{'request.course.id'},100));
  559:               $r->print(&Apache::loncommon::end_page());
  560:               return OK;
  561:           } else {
  562: 	      &Apache::loncommon::content_type($r,'text/html');
  563: 	      $r->header_out(Location => $furl);
  564: 	      return REDIRECT;
  565:           }
  566:       }
  567:       if ($direction eq 'return') {
  568: # -------------------------------------------------------- Return to last known
  569:          my ($newloc,$usehttp);
  570:          if (($last) && (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
  571:                         &GDBM_READER(),0640))) {
  572:             my ($murl,$id,$fn)=&Apache::lonnet::decode_symb($last);
  573: 	    $id=$hash{'map_pc_'.&Apache::lonnet::clutter($murl)}.'.'.$id;
  574: 	    $newloc=$hash{'src_'.$id};
  575: 	    if ($newloc) {
  576:                 $usehttp = &check_http_req(\$newloc,$hostname);
  577: 		if ($hash{'encrypted_'.$id}) { 
  578:                     $newloc=&Apache::lonenc::encrypted($newloc);
  579:                 }
  580:                 if ($newloc =~ m{^(/adm/wrapper/ext/[^\#]+)(?:|(\#[^\#]+))$}) {
  581:                     my ($url,$anchor) = ($1,$2);
  582:                     if ($anchor) {
  583:                         $newloc = $url.(($url=~/\?/)?'&':'?').'symb='.&escape($last).$anchor;
  584:                     }
  585:                 }
  586: 	    } else {
  587: 		$newloc='/adm/navmaps';
  588: 	    }
  589:             untie %hash;
  590:          } else {
  591: 	    $newloc='/adm/navmaps';
  592:          }
  593:          if (($usehttp) && ($hostname ne '')) {
  594:              $newloc='http://'.$hostname.$newloc;
  595:          } else {
  596:              $newloc=&Apache::lonnet::absolute_url().$newloc
  597:          }
  598:          if ($reinitcheck eq 'update') {
  599:              $r->print(&reinited_js($newloc,$env{'request.course.id'},100));
  600:              $r->print(&Apache::loncommon::end_page());
  601:              return OK;
  602:          } else {
  603: 	     &Apache::loncommon::content_type($r,'text/html');
  604: 	     $r->header_out(Location => $newloc);
  605: 	     return REDIRECT;
  606:          }
  607:       }
  608: #
  609: # Is the current URL on the map? If not, start with last known URL
  610: #
  611: 
  612:       unless (&Apache::lonnet::is_on_map($currenturl)) {
  613:          if ($preupdatepos) {
  614:              undef($preupdatepos);
  615:          } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  616:                             &GDBM_READER(),0640)) {
  617:              $last=$hash{'last_known'};
  618:              untie(%hash);
  619:          }
  620:          if ($last) {
  621: 	     $currenturl=&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($last))[2]);
  622: 	 } else {
  623:              my $newloc = &Apache::lonnet::absolute_url().
  624:                           '/adm/navmaps'; 
  625:              if ($reinitcheck eq 'update') {
  626:                  &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  627:                  $r->print(&reinited_js($newloc,$env{'request.course.id'},100));
  628:                  $r->print(&Apache::loncommon::end_page());
  629:                  return OK;
  630:              } else {
  631: 	         &Apache::loncommon::content_type($r,'text/html');
  632: 	         $r->header_out(Location => $newloc); 
  633: 	         return REDIRECT;
  634:              }
  635:          }
  636:       }
  637: # ------------------------------------------- Do we have any idea where we are?
  638:       my $position;
  639:       if ($preupdatepos) {
  640:           $position = $preupdatepos;
  641:       } else {
  642:           $position=Apache::lonnet::symbread($currenturl);
  643:       }
  644:       if ($position) {
  645: # ------------------------------------------------------------------------- Yes
  646: 	  my ($startoutmap,$mapnum,$thisurl)=&Apache::lonnet::decode_symb($position);
  647:           $cachehash{$startoutmap}{$thisurl}=[$thisurl,$mapnum];
  648:           $cachehash{$startoutmap}{'last_known'}=
  649:                              [&Apache::lonnet::declutter($currenturl),$mapnum];
  650: 
  651: # ============================================================ Tie the big hash
  652:           if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
  653:                         &GDBM_READER(),0640)) {
  654:               my $rid=$hash{'map_pc_'.&Apache::lonnet::clutter($startoutmap)}.
  655:                       '.'.$mapnum;
  656: 
  657: # ------------------------------------------------- Move forward, backward, etc
  658:               my $endupmap;
  659:               ($next,$endupmap)=&move($rid,$startoutmap,$direction);
  660: # -------------------------------------- Do we have one and only one empty URL?
  661: # We are now at at least one non-empty URL
  662: # ----------------------------------------------------- Check out possibilities
  663:               if ($next) {
  664:                   @possibilities=split(/\,/,$next);
  665:                   if ($#possibilities==0) {
  666: # ---------------------------------------------- Only one possibility, redirect
  667: 	              ($redirecturl,$redirectsymb,$enc,$anchor)=&hash_src($next);
  668:                       $cachehash{$endupmap}{$redirecturl}=
  669: 			  [$redirecturl,(split(/\./,$next))[1]];
  670:                   } else {
  671: # ------------------------ There are multiple possibilities for a next resource
  672:                       $multichoice=1;
  673: 		      foreach my $id (@possibilities) {
  674: 			  $multichoicehash{'src_'.$id}=$hash{'src_'.$id};
  675:                           $multichoicehash{'title_'.$id}=$hash{'title_'.$id};
  676:                           $multichoicehash{'type_'.$id}=$hash{'type_'.$id};
  677:                           (my $first, my $second) = $id =~ /(\d+).(\d+)/;
  678:                           my $symbSrc = Apache::lonnet::declutter($hash{'src_'.$id});
  679:                           $multichoicehash{'symb_'.$id} = 
  680:                               Apache::lonnet::declutter($hash{'map_id_'.$first}.'___'.
  681:                                                         $second.'___'.$symbSrc);
  682:                                                          
  683:                           my ($choicemap,$choiceres)=split(/\./,$id);
  684: 			  my $map=&Apache::lonnet::declutter($hash{'src_'.$choicemap});
  685: 			  my $url=$multichoicehash{'src_'.$id};
  686:                           $cachehash{$map}{$url}=[$url,$choiceres];
  687:                       }
  688:                   }
  689: 	      } else {
  690: # -------------------------------------------------------------- No place to go
  691:                   $multichoice=-1;
  692:                   if ($position && $env{'request.deeplink.login'}) {
  693:                       my ($map,$resid,$url) = &Apache::lonnet::decode_symb($position);
  694:                       my $mapid = $hash{'map_pc_'.&Apache::lonnet::clutter($map)};
  695:                       my $position_deeplink = $hash{'deeplinkonly_'.$mapid.'.'.$resid};
  696:                       if ($position_deeplink) {
  697:                           (my $value,$deeplinklevel) = split(/:/,$position_deeplink);
  698:                       }
  699:                   }
  700:               }
  701: # ----------------- The program must come past this point to untie the big hash
  702: 	      untie(%hash);
  703: # --------------------------------------------------------- Store position info
  704:               $cachehash{$startoutmap}{'last_direction'}=[$direction,'notasymb'];
  705:               foreach my $thismap (keys(%cachehash)) {
  706: 		  my $mapnum=$cachehash{$thismap}->{'mapnum'};
  707: 		  delete($cachehash{$thismap}->{'mapnum'});
  708: 		  &Apache::lonnet::symblist($thismap,
  709: 					    %{$cachehash{$thismap}});
  710: 	      }
  711: # ============================================== Do not return before this line
  712:               if ($redirecturl) {
  713: # ----------------------------------------------------- There is a URL to go to
  714: 		  if ($direction eq 'forward') {
  715:                      &Apache::lonnet::linklog($currenturl,$redirecturl);
  716: 		  }
  717: 		  if ($direction eq 'back') {
  718:                      &Apache::lonnet::linklog($redirecturl,$currenturl);
  719: 		  }
  720: # ------------------------------------- Check for and display critical messages
  721:                   my ($redirect, $url) = &Apache::loncommon::critical_redirect(300,'flip');
  722:                   unless ($redirect) {
  723:                       my $usehttp = &check_http_req(\$redirecturl,$hostname);
  724:                       if (($usehttp) && ($hostname ne '')) {
  725:                           $url='http://'.$hostname.$redirecturl;
  726:                       } else {
  727:                           $url=&Apache::lonnet::absolute_url().$redirecturl;
  728:                       }
  729:                       my $addanchor;
  730:                       if (($anchor ne '') && (!$enc || $env{'request.role.adv'})) {
  731:                           $addanchor = 1;
  732:                           $url =~ s/\#.+$//;
  733:                       }
  734:                       $url = &add_get_param($url, { 'symb' => $redirectsymb});
  735:                       if ($addanchor) {
  736:                           $url .= $anchor;
  737:                       }
  738:                   }
  739:                   if ($reinitcheck eq 'update') {
  740:                       &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  741:                       $r->print(&reinited_js($url,$env{'request.course.id'},100)); 
  742:                       $r->print(&Apache::loncommon::end_page());
  743:                       return OK;
  744:                   } else {
  745:                       &Apache::loncommon::content_type($r,'text/html');
  746:                       $r->header_out(Location => $url);
  747:                       return REDIRECT;
  748:                   }
  749: 	      } else {
  750: # --------------------------------------------------------- There was a problem
  751:                   &Apache::loncommon::content_type($r,'text/html');
  752:                   $r->send_http_header;
  753: 		  my %lt=&Apache::lonlocal::texthash('title' => 'End of Sequence',
  754:                                                      'deeplink' => 'No link available',
  755:                                                      'deeplinkres' =>
  756:                                                      'Navigation to other content is unavailable when accessing content via deep-linking',
  757:                                                      'deeplinkmap' =>
  758:                                                      'You have reached the end of the sequence of available materials for access via deep-linking',
  759: 						     'explain' =>
  760: 						     'You have reached the end of the sequence of materials.',
  761: 						     'back' => 'Go Back',
  762: 						     'nav' => 'Course Contents',
  763: 						     'wherenext' =>
  764: 						     'There are several possibilities of where to go next',
  765: 						     'pick' =>
  766: 						     'Please click on the the resource you intend to access',
  767: 						     'titleheader' => 'Title',
  768: 						     'type' => 'Type',
  769:                                                      'update' => 'Content updated',
  770:                                                      'expupdate' => 'As a result of a recent update to the sequence of materials, it is not possible to complete the page flip.',
  771:                                                      'gonav' => 'Go to the Contents page to select a resource to display.',
  772:                                                      );
  773:                   if (&Apache::loncommon::course_type() eq 'Community') {
  774:                       $lt{'nav'} = &mt('Community Contents');
  775:                   }
  776:                   if ($#possibilities>0) {
  777: 		      my $start_page=
  778: 			  &Apache::loncommon::start_page('Multiple Resources');
  779:                      $r->print(<<ENDSTART);
  780: $start_page
  781: <h3>$lt{'wherenext'}</h3>
  782: <p>
  783: $lt{'pick'}:
  784: <p>
  785: <table border="2">
  786: <tr><th>$lt{'titleheader'}</th><th>$lt{'type'}</th></tr>
  787: ENDSTART
  788:                      foreach my $id (@possibilities) {
  789:                         my $src = $multichoicehash{'src_'.$id};
  790:                         my $usehttp = &check_http_req(\$src,$hostname);
  791:                         if (($usehttp) && ($hostname ne '')) {
  792:                             $src = 'http://'.$hostname.$src;
  793:                         }
  794:                         $r->print(
  795:                               '<tr><td><a href="'.
  796: 				  &add_get_param($src,
  797: 						 {'symb' =>
  798: 						      $multichoicehash{'symb_'.$id},
  799: 						  }).'">'.
  800:                               $multichoicehash{'title_'.$id}.
  801:                               '</a></td><td>'.$multichoicehash{'type_'.$id}.
  802: 			      '</td></tr>');
  803:                      }
  804:                      $r->print('</table>');
  805:                   } else {
  806:                       if ($reinitcheck) {
  807:                           if (&Apache::loncommon::course_type() eq 'Community') {
  808:                               $r->print(
  809:                                   &Apache::loncommon::start_page('Community Contents Updated'));
  810:                           } else { 
  811:                               $r->print(
  812:                                   &Apache::loncommon::start_page('Course Contents Updated'));
  813:                           }
  814:                           $r->print('<h2>'.$lt{'update'}.'</h2>'
  815:                                   .'<p>'.$lt{'expupdate'}.'<br />'
  816:                                   .$lt{'gonav'}.'</p>');
  817:                       } else {
  818:                           if (($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement') && 
  819:                               (!$env{'request.role.adv'})) {
  820:                               my ($score,$incomplete) = &Apache::lonplacementtest::check_completion(undef,undef,1); 
  821:                               if ($incomplete) {
  822:                                   $r->print(&Apache::lonplacementtest::showincomplete($incomplete)); 
  823:                               } else {
  824:                                   $r->print(&Apache::lonplacementtest::showresult(1));
  825:                               }
  826:                           } else {
  827:                               $r->print(
  828:                                   &Apache::loncommon::start_page('No Resource'));
  829:                               if ($deeplinklevel eq 'resource') {
  830:                                   $r->print('<h2>'.$lt{'deeplink'}.'</h2>'
  831:                                            .'<p>'.$lt{'deeplinkres'}.'</p>');
  832:                               } elsif ($deeplinklevel eq 'map') {
  833:                                   $r->print('<h2>'.$lt{'title'}.'</h2>'
  834:                                            .'<p>'.$lt{'deeplinkmap'}.'</p>');
  835:                               } else {
  836:                                   $r->print('<h2>'.$lt{'title'}.'</h2>'
  837:                                            .'<p>'.$lt{'explain'}.'</p>');
  838:                               }
  839:                           }
  840:                       }
  841: 		  }
  842:                   unless (($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement') ||
  843:                           ($env{'request.role.adv'})) {
  844:                       if ($deeplinklevel) {
  845:                           $r->print(
  846:                               &Apache::lonhtmlcommon::actionbox(
  847:                                   ['<a href="/adm/flip?postdata=return:">'.$lt{'back'}.'</a>']));
  848:                       } elsif ((!@possibilities) && ($reinitcheck))  {
  849:                           $r->print(
  850:                               &Apache::lonhtmlcommon::actionbox(
  851:                                   ['<a href="/adm/navmaps">'.$lt{'nav'}.'</a></li>'
  852:                                   ]));
  853:                       } else {
  854:                           $r->print(
  855:                               &Apache::lonhtmlcommon::actionbox(
  856:                                   ['<a href="/adm/flip?postdata=return:">'.$lt{'back'}.'</a></li>',
  857:                                    '<a href="/adm/navmaps">'.$lt{'nav'}.'</a></li>'
  858:                                   ]));
  859:                       }
  860: 
  861:                   }
  862:                   $r->print(&Apache::loncommon::end_page());
  863:       
  864:                   return OK;
  865: 	      }
  866: 	  } else {
  867: # ------------------------------------------------- Problem, could not tie hash
  868:               if ($reinitcheck eq 'update') {
  869:                   &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  870:                   $r->print(&Apache::loncommon::end_page());
  871:               } 
  872:               $env{'user.error.msg'}="/adm/flip:bre:0:1:Course Data Missing";
  873:               return HTTP_NOT_ACCEPTABLE; 
  874:           }
  875:       } else {
  876: # ---------------------------------------- No, could not determine where we are
  877:           my $newloc = '/adm/ambiguous';
  878:           if ($reinitcheck eq 'update') {
  879:               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
  880:               $r->print(&reinited_js($newloc,$env{'request.course.id'},100));
  881:               $r->print(&Apache::loncommon::end_page());
  882:           } else {
  883: 	      $r->internal_redirect($newloc);
  884:           }
  885:           return OK;
  886:       }
  887:   } else {
  888: # -------------------------- Class was not initialized or page fliped strangely
  889:       $env{'user.error.msg'}="/adm/flip:bre:0:0:Choose Course";
  890:       return HTTP_NOT_ACCEPTABLE; 
  891:   } 
  892: }
  893: 
  894: 1;
  895: __END__
  896: 
  897: =pod
  898: 
  899: =head1 NAME
  900: 
  901: Apache::lonpageflip
  902: 
  903: =head1 SYNOPSIS
  904: 
  905: Deals with forward, backward, and other page flips.
  906: 
  907: This is part of the LearningOnline Network with CAPA project
  908: described at http://www.lon-capa.org.
  909: 
  910: =head1 OVERVIEW
  911: 
  912: (empty)
  913: 
  914: =head1 SUBROUTINES
  915: 
  916: =over cleanup()
  917: 
  918: =item addrid()
  919: 
  920: =item fullmove()
  921: 
  922: =item hash_src()
  923: 
  924: =item move()
  925: 
  926: =item get_next_possible_move()
  927: 
  928: =item first_accessible_resource()
  929: 
  930: =item handler()
  931: 
  932: =back
  933: 
  934: =cut
  935: 
  936: 
  937: 
  938: 
  939: 
  940: 

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