Annotation of rat/lonpageflip.pm, revision 1.48

1.1       www         1: # The LearningOnline Network with CAPA
                      2: #
                      3: # Page flip handler
                      4: #
1.48    ! albertel    5: # $Id: lonpageflip.pm,v 1.47 2004/04/08 09:14:41 raeburn Exp $
1.18      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: # (Page Handler
                     30: #
                     31: # (TeX Content Handler
                     32: #
                     33: # 05/29/00,05/30 Gerd Kortemeyer)
                     34: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
                     35: # 10/02 Gerd Kortemeyer)
                     36: #
1.13      www        37: # 10/03,10/05,10/06,10/07,10/09,10/10,10/11,10/16,10/17,
1.14      www        38: # 11/14,11/16,
1.17      www        39: # 10/01/01,05/01,05/28,07/05 Gerd Kortemeyer
1.1       www        40: 
                     41: package Apache::lonpageflip;
                     42: 
                     43: use strict;
1.4       www        44: use Apache::Constants qw(:common :http REDIRECT);
1.1       www        45: use Apache::lonnet();
                     46: use HTML::TokeParser;
                     47: use GDBM_File;
                     48: 
1.3       www        49: # ========================================================== Module Global Hash
                     50:   
1.1       www        51: my %hash;
1.34      www        52: 
                     53: sub cleanup {
                     54:     if (tied(%hash)){
                     55: 	&Apache::lonnet::logthis('Cleanup pageflip: hash');
                     56:         unless (untie(%hash)) {
                     57: 	    &Apache::lonnet::logthis('Failed cleanup pageflip: hash');
                     58:         }
                     59:     }
                     60: }
1.1       www        61: 
1.3       www        62: sub addrid {
1.4       www        63:     my ($current,$new,$condid)=@_;
                     64:     unless ($condid) { $condid=0; }
1.27      www        65: 
1.3       www        66: 	if ($current) {
1.5       www        67: 	    $current.=','.$new;
1.3       www        68:         } else {
1.5       www        69:             $current=''.$new;
1.3       www        70:         }
1.27      www        71: 
1.3       www        72:     return $current;
1.25      www        73: }
                     74: 
                     75: sub fullmove {
                     76:     my ($rid,$mapurl,$direction)=@_;
                     77:     if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.28      albertel   78:                         &GDBM_READER(),0640)) {
1.25      www        79: 	($rid,$mapurl)=&move($rid,$mapurl,$direction);
                     80:         untie(%hash);
                     81:     }
                     82:     return($rid,$mapurl);
1.1       www        83: }
                     84: 
1.15      www        85: sub move {
                     86:     my ($rid,$mapurl,$direction)=@_;
1.23      www        87:     my $startoutrid=$rid;
1.15      www        88: 
                     89:     my $next='';
                     90: 
                     91:               my $mincond=1;
                     92:               my $posnext='';
                     93:               if ($direction eq 'forward') {
                     94: # --------------------------------------------------------------------- Forward
1.33      www        95:                   while ($hash{'type_'.$rid} eq 'finish') {
                     96: 	             $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
1.15      www        97:                   }
                     98:                   map {
                     99:                       my $thiscond=
                    100:       &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
                    101:                       if ($thiscond>=$mincond) {
                    102: 		          if ($posnext) {
                    103: 		             $posnext.=','.$_.':'.$thiscond;
                    104:                           } else {
                    105:                              $posnext=$_.':'.$thiscond;
                    106: 		          }
                    107:                           if ($thiscond>$mincond) { $mincond=$thiscond; }
                    108: 	              }
                    109:                   } split(/\,/,$hash{'to_'.$rid});
                    110:                   map {
                    111:                       my ($linkid,$condval)=split(/\:/,$_);
                    112:                       if ($condval>=$mincond) {
                    113: 		          $next=&addrid($next,$hash{'goesto_'.$linkid},
                    114:                                 $hash{'condid_'.$hash{'undercond_'.$linkid}});
                    115:                       }
                    116:                   } split(/\,/,$posnext);
                    117:                   if ($hash{'is_map_'.$next}) {
1.23      www       118: # This jumps to the beginning of a new map (going down level)
1.15      www       119:                       if (
                    120:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
                    121: 			  $mapurl=$hash{'src_'.$next};
                    122: 			  $next=$hash{'map_start_'.$hash{'src_'.$next}};
1.47      raeburn   123:                      } elsif (
                    124: # This jumps back up from an empty sequence, to a page up one level
                    125:                          $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
                    126:                          $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
1.15      www       127:                      }
1.23      www       128:                   } elsif 
                    129:                     ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
                    130: # This comes up from a map (coming up one level);
                    131: 		      $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
1.15      www       132:                   }
                    133:               } elsif ($direction eq 'back') {
                    134: # ------------------------------------------------------------------- Backwards
1.33      www       135:                  while ($hash{'type_'.$rid} eq 'start') {
                    136: 	             $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
                    137: 		 }
1.15      www       138:                   map {
                    139:                       my $thiscond=
                    140:       &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
                    141:                       if ($thiscond>=$mincond) {
                    142: 		          if ($posnext) {
                    143: 		             $posnext.=','.$_.':'.$thiscond;
                    144:                           } else {
                    145:                              $posnext=$_.':'.$thiscond;
                    146: 		          }
                    147:                           if ($thiscond>$mincond) { $mincond=$thiscond; }
                    148: 	              }
                    149:                   } split(/\,/,$hash{'from_'.$rid});
                    150:                   map {
                    151:                       my ($linkid,$condval)=split(/\:/,$_);
                    152:                       if ($condval>=$mincond) {
                    153: 		          $next=&addrid($next,$hash{'comesfrom_'.$linkid},
                    154:                                 $hash{'condid_'.$hash{'undercond_'.$linkid}});
                    155:                       }
                    156:                   } split(/\,/,$posnext);
                    157:                   if ($hash{'is_map_'.$next}) {
1.24      www       158: # This jumps to the end of a new map (going down one level)
1.15      www       159:                       if (
                    160:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
                    161: 			  $mapurl=$hash{'src_'.$next};
                    162: 			  $next=$hash{'map_finish_'.$hash{'src_'.$next}};
1.47      raeburn   163:                       } elsif (
                    164:       $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
                    165: # This jumps back up from an empty sequence, to a page up one level
                    166:                           $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
                    167:                       }
1.24      www       168:                   } elsif 
                    169:                     ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
                    170: # This comes back up from a map (going up one level);
                    171: 		      $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
1.15      www       172:                   }
                    173: 	      }
                    174:               return ($next,$mapurl);
                    175: }
                    176: 
1.1       www       177: # ================================================================ Main Handler
                    178: 
                    179: sub handler {
1.2       www       180:    my $r=shift;
1.1       www       181: 
                    182: # ------------------------------------------- Set document type for header only
                    183: 
1.2       www       184:   if ($r->header_only) {
1.1       www       185:      $r->content_type('text/html');
                    186:      $r->send_http_header;
1.2       www       187:      return OK;
                    188:   }
                    189: 
1.5       www       190:   my %cachehash=(); 
                    191:   my $multichoice=0;
                    192:   my %multichoicehash=();
1.4       www       193:   my $redirecturl='';
                    194:   my $next='';
                    195:   my @possibilities=();
1.37      www       196:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['postdata']);
1.2       www       197:   if (($ENV{'form.postdata'})&&($ENV{'request.course.fn'})) {
                    198:       $ENV{'form.postdata'}=~/(\w+)\:(.*)/;
                    199:       my $direction=$1;
1.40      www       200:       my $currenturl=$2;
1.46      www       201:       $currenturl=~s/\.\d+\.(\w+)$/\.$1/;
1.10      www       202:       if ($direction eq 'return') {
                    203: # -------------------------------------------------------- Return to last known
                    204:          my $last;
                    205:          if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.28      albertel  206:                     &GDBM_READER(),0640)) {
1.10      www       207: 	     $last=$hash{'last_known'};
                    208:              untie(%hash);
                    209:          }
                    210:          my $newloc;
1.36      www       211:          if (($last) && (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
                    212:                         &GDBM_READER(),0640))) {
1.41      www       213:             my ($murl,$fn)=&Apache::lonnet::decode_symb($last);
1.37      www       214:             my $id;
1.41      www       215:             ($murl,$id,$fn)=&Apache::lonnet::decode_symb(&Apache::lonnet::symbread($fn));
1.37      www       216: 	    $newloc=$hash{'src_'.
                    217:                 $hash{'map_pc_'.&Apache::lonnet::clutter($murl)}.'.'.$id};
                    218:             unless ($newloc) { $newloc='/adm/noidea.html'; }
1.36      www       219:             untie %hash;
1.10      www       220:          } else {
                    221: 	    $newloc='/adm/noidea.html';
                    222:          }  
                    223: 	 $r->content_type('text/html');
                    224:          $r->header_out(Location => 
                    225: 			'http://'.$ENV{'HTTP_HOST'}.$newloc);
                    226:                                
                    227:          return REDIRECT;
                    228:       }
1.2       www       229:       $currenturl=~s/^http\:\/\///;
                    230:       $currenturl=~s/^[^\/]+//;
1.35      www       231: #
                    232: # Is the current URL on the map? If not, start with last known URL
                    233: #
                    234:       unless (&Apache::lonnet::is_on_map($currenturl)) {
1.7       www       235: 	 my $last;
                    236:          if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.28      albertel  237:                     &GDBM_READER(),0640)) {
1.7       www       238: 	     $last=$hash{'last_known'};
                    239:              untie(%hash);
                    240:          }
                    241:          if ($last) {
1.41      www       242: 	     $currenturl=&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($last))[1]);
1.7       www       243: 	 } else {
                    244: 	     $r->content_type('text/html');
                    245:              $r->header_out(Location => 
                    246:                                'http://'.$ENV{'HTTP_HOST'}.'/adm/noidea.html');
1.9       www       247:              return REDIRECT;
1.7       www       248:          }
                    249:       }
1.3       www       250: # ------------------------------------------- Do we have any idea where we are?
                    251:       my $position;
                    252:       if ($position=Apache::lonnet::symbread($currenturl)) {
                    253: # ------------------------------------------------------------------------- Yes
1.41      www       254: 	  my ($startoutmap,$mapnum,$thisurl)=&Apache::lonnet::decode_symb($position);
1.22      www       255:           $cachehash{$startoutmap}{$thisurl}=$mapnum;
1.23      www       256:           $cachehash{$startoutmap}{'last_known'}=
                    257:                                        &Apache::lonnet::declutter($currenturl);
1.20      albertel  258: 
1.5       www       259: # ============================================================ Tie the big hash
1.3       www       260:           if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.28      albertel  261:                         &GDBM_READER(),0640)) {
1.29      www       262:               my $rid=$hash{'map_pc_'.&Apache::lonnet::clutter($startoutmap)}.
                    263:                       '.'.$mapnum;
1.14      www       264: 
1.15      www       265: # ------------------------------------------------- Move forward, backward, etc
1.22      www       266:               my $endupmap;
                    267:               ($next,$endupmap)=&move($rid,$startoutmap,$direction);
1.15      www       268: # -------------------------------------- Do we have one and only one empty URL?
                    269:               my $safecount=0;
1.26      www       270:               while (($next) && ($next!~/\,/) && 
1.48    ! albertel  271:                      ((!$hash{'src_'.$next}) || 
        !           272: 		      ($ENV{'request.role.adv'}) && $hash{'randomout_'.$next}))
1.26      www       273:                      && ($safecount<10000)) {
1.22      www       274:                   ($next,$endupmap)=&move($next,$endupmap,$direction);
1.15      www       275:                   $safecount++;
                    276:               }
1.22      www       277: # We are now at at least one non-empty URL
1.4       www       278: # ----------------------------------------------------- Check out possibilities
                    279:               if ($next) {
                    280:                   @possibilities=split(/\,/,$next);
                    281:                   if ($#possibilities==0) {
1.5       www       282: # ---------------------------------------------- Only one possibility, redirect
                    283: 	              $redirecturl=$hash{'src_'.$next};
1.22      www       284:                       $cachehash{$endupmap}
1.19      www       285:                                 {&Apache::lonnet::declutter($redirecturl)}
1.5       www       286: 		                                 =(split(/\./,$next))[1];
1.4       www       287:                   } else {
1.5       www       288: # ------------------------ There are multiple possibilities for a next resource
                    289:                       $multichoice=1;
                    290:                       map {
                    291: 			  $multichoicehash{'src_'.$_}=$hash{'src_'.$_};
                    292:                           $multichoicehash{'title_'.$_}=$hash{'title_'.$_};
1.6       www       293:                           $multichoicehash{'type_'.$_}=$hash{'type_'.$_};
1.32      bowersj2  294:                           (my $first, my $second) = $_ =~ /(\d+).(\d+)/;
                    295:                           my $symbSrc = Apache::lonnet::declutter($hash{'src_'.$_});
                    296:                           $multichoicehash{'symb_'.$_} = 
                    297:                               Apache::lonnet::declutter($hash{'map_id_'.$first}.'___'.
                    298:                                                         $second.'___'.$symbSrc);
                    299:                                                          
1.22      www       300:                           my ($choicemap,$choiceres)=split(/\./,$_);
                    301:                           $cachehash
                    302: 			 {&Apache::lonnet::declutter($hash{'src_'.$choicemap})}
                    303:                          {&Apache::lonnet::declutter(
1.5       www       304: 						      $multichoicehash
                    305:                                                          {'src_'.$_}
                    306:                                                        )}
1.22      www       307: 		                                 =$choiceres;
1.5       www       308:                       } @possibilities;
1.4       www       309:                   }
1.5       www       310: 	      } else {
                    311: # -------------------------------------------------------------- No place to go
                    312:                   $multichoice=-1;
1.4       www       313:               }
1.5       www       314: # ----------------- The program must come past this point to untie the big hash
1.3       www       315: 	      untie(%hash);
1.5       www       316: # --------------------------------------------------------- Store position info
1.22      www       317:               $cachehash{$startoutmap}{'last_direction'}=$direction;
1.19      www       318:               foreach my $thismap (keys %cachehash) {
1.20      albertel  319:                  &Apache::lonnet::symblist($thismap,%{$cachehash{$thismap}});
1.19      www       320: 	      }
1.5       www       321: # ============================================== Do not return before this line
1.4       www       322:               if ($redirecturl) {
1.5       www       323: # ----------------------------------------------------- There is a URL to go to
1.38      www       324: 		  if ($direction eq 'forward') {
                    325:                      &Apache::lonnet::linklog($currenturl,$redirecturl);
                    326: 		  }
                    327: 		  if ($direction eq 'back') {
                    328:                      &Apache::lonnet::linklog($redirecturl,$currenturl);
                    329: 		  }
1.31      www       330: # ------------------------------------------------- Check for critical messages
                    331: 		  if ((time-$ENV{'user.criticalcheck.time'})>300) {
                    332:                      my @what=&Apache::lonnet::dump
                    333:                                   ('critical',$ENV{'user.domain'},
                    334:                                               $ENV{'user.name'});
                    335:                      if ($what[0]) {
                    336: 	                if (($what[0] ne 'con_lost') && 
                    337:                             ($what[0]!~/^error\:/)) {
                    338: 	                   $redirecturl='/adm/email?critical=display';
                    339:                         }
                    340:                      }
                    341:                      &Apache::lonnet::appenv('user.criticalcheck.time'=>time);
                    342: 		  }
                    343: 
1.4       www       344: 		  $r->content_type('text/html');
                    345:                   $r->header_out(Location => 
                    346:                                 'http://'.$ENV{'HTTP_HOST'}.$redirecturl);
                    347:                   return REDIRECT;
1.5       www       348: 	      } else {
                    349: # --------------------------------------------------------- There was a problem
1.8       www       350:                   $r->content_type('text/html');
                    351:                   $r->send_http_header;
                    352:                   if ($#possibilities>0) {
1.37      www       353: 		      my $bodytag=
                    354:                              &Apache::loncommon::bodytag('Multiple Resources');
1.8       www       355:                      $r->print(<<ENDSTART);
                    356: <head><title>Choose Next Location</title></head>
1.37      www       357: $bodytag
                    358: <h3>There are several possibilities of where to go next</h3>
1.8       www       359: <p>
                    360: Please click on the the resource you intend to access:
                    361: <p>
                    362: <table border=2>
                    363: <tr><th>Title</th><th>Type</th></tr>
                    364: ENDSTART
1.26      www       365:                      foreach (@possibilities) {
1.8       www       366:                         $r->print(
                    367:                               '<tr><td><a href="'.
1.32      bowersj2  368:                               $multichoicehash{'src_'.$_}.'?symb=' .
                    369:                                   Apache::lonnet::escape($multichoicehash{'symb_'.$_}).'">'.
1.8       www       370:                               $multichoicehash{'title_'.$_}.
                    371:                               '</a></td><td>'.$multichoicehash{'type_'.$_}.
                    372: 			      '</td></tr>');
1.26      www       373:                      }
1.8       www       374:                      $r->print('</table></body></html>');
                    375: 		     return OK;
                    376:                   } else {
1.37      www       377: 		      my $bodytag=&Apache::loncommon::bodytag('No Resource');
1.8       www       378:                      $r->print(<<ENDNONE);
1.37      www       379: <head><title>No Resource</title></head>
                    380: $bodytag
                    381: <h3>Next resource could not be identified.</h3>
                    382: <p>You probably are at the <b>beginning</b> or the <b>end</b> of the 
                    383: course.</p>
                    384: <ul>
                    385: <li><a href="/adm/flip?postdata=return:">Go Back</a></li>
                    386: <li><a href="/adm/navmaps">Navigate Course Content</a></li>
                    387: </ul>
1.8       www       388: </body>
                    389: </html>
                    390: ENDNONE
                    391:                      return OK;
                    392: 	         }
                    393: 	     }
1.5       www       394: 	  } else {
                    395: # ------------------------------------------------- Problem, could not tie hash
                    396:               $ENV{'user.error.msg'}="/adm/flip:bre:0:1:Course Data Missing";
                    397:               return HTTP_NOT_ACCEPTABLE; 
1.3       www       398:           }
1.5       www       399:       } else {
                    400: # ---------------------------------------- No, could not determine where we are
1.45      albertel  401: 	  if ( &Apache::lonnet::mod_perl_version() == 2 ) {
1.42      albertel  402: 	      &Apache::lonnet::cleanenv();
                    403: 	  }
                    404: 	  $r->internal_redirect('/adm/ambiguous');
1.2       www       405:       }
1.5       www       406:   } else {
1.2       www       407: # -------------------------- Class was not initialized or page fliped strangely
                    408:       $ENV{'user.error.msg'}="/adm/flip:bre:0:0:Choose Course";
                    409:       return HTTP_NOT_ACCEPTABLE; 
                    410:   } 
1.1       www       411: }
                    412: 
                    413: 1;
                    414: __END__
                    415: 
                    416: 
                    417: 
                    418: 
                    419: 
                    420: 
                    421: 

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