Diff for /rat/lonpageflip.pm between versions 1.6 and 1.59

version 1.6, 2000/10/11 21:16:29 version 1.59, 2005/11/10 19:16:02
Line 2 Line 2
 #  #
 # Page flip handler  # Page flip handler
 #  #
 # (Page Handler  # $Id$
 #  #
 # (TeX Content Handler  # Copyright Michigan State University Board of Trustees
 #  #
 # 05/29/00,05/30 Gerd Kortemeyer)  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,  #
 # 10/02 Gerd Kortemeyer)  # LON-CAPA is free software; you can redistribute it and/or modify
   # it under the terms of the GNU General Public License as published by
   # the Free Software Foundation; either version 2 of the License, or
   # (at your option) any later version.
   #
   # LON-CAPA is distributed in the hope that it will be useful,
   # but WITHOUT ANY WARRANTY; without even the implied warranty of
   # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   # GNU General Public License for more details.
   #
   # You should have received a copy of the GNU General Public License
   # along with LON-CAPA; if not, write to the Free Software
   # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   #
   # /home/httpd/html/adm/gpl.txt
   #
   # http://www.lon-capa.org/
 #  #
 # 10/03,10/05,10/06,10/07,10/09,10/10,10/11 Gerd Kortemeyer  
   
 package Apache::lonpageflip;  package Apache::lonpageflip;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http REDIRECT);  use Apache::Constants qw(:common :http REDIRECT);
 use Apache::lonnet();  use Apache::lonnet;
 use HTML::TokeParser;  use HTML::TokeParser;
 use GDBM_File;  use GDBM_File;
   
Line 24  use GDBM_File; Line 39  use GDBM_File;
       
 my %hash;  my %hash;
   
   sub cleanup {
       if (tied(%hash)){
    &Apache::lonnet::logthis('Cleanup pageflip: hash');
           unless (untie(%hash)) {
       &Apache::lonnet::logthis('Failed cleanup pageflip: hash');
           }
       }
   }
   
 sub addrid {  sub addrid {
     my ($current,$new,$condid)=@_;      my ($current,$new,$condid)=@_;
     unless ($condid) { $condid=0; }      unless ($condid) { $condid=0; }
     if (&Apache::lonnet::allowed('bre',$hash{'src_'.$new})) {  
  if ($current) {   if ($current) {
     $current.=','.$new;      $current.=','.$new;
         } else {          } else {
             $current=''.$new;              $current=''.$new;
         }          }
     }  
     return $current;      return $current;
 }  }
   
 # ================================================================ Main Handler  sub fullmove {
       my ($rid,$mapurl,$direction)=@_;
 sub handler {      if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
    my $r=shift;                          &GDBM_READER(),0640)) {
    ($rid,$mapurl)=&move($rid,$mapurl,$direction);
           untie(%hash);
       }
       return($rid,$mapurl);
   }
   
 # ------------------------------------------- Set document type for header only  sub hash_src {
       my ($id)=@_;
       my ($mapid,$resid)=split(/\./,$id);
       my $symb=&Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},
     $resid,$hash{'src_'.$id});
       if ($hash{'encrypted_'.$id}) {
    return (&Apache::lonenc::encrypted($hash{'src_'.$id}),
    &Apache::lonenc::encrypted($symb));
       }
       return ($hash{'src_'.$id},$symb);
   }
   
   if ($r->header_only) {  sub move {
      $r->content_type('text/html');      my ($rid,$mapurl,$direction)=@_;
      $r->send_http_header;      my $startoutrid=$rid;
      return OK;  
   }  
   
   my %cachehash=();       my $next='';
   my $multichoice=0;  
   my %multichoicehash=();  
   my $redirecturl='';  
   my $next='';  
   my @possibilities=();  
   
   if (($ENV{'form.postdata'})&&($ENV{'request.course.fn'})) {  
       $ENV{'form.postdata'}=~/(\w+)\:(.*)/;  
       my $direction=$1;  
       my $currenturl=$2;  
       $currenturl=~s/^http\:\/\///;  
       $currenturl=~s/^[^\/]+//;  
 # ------------------------------------------- Do we have any idea where we are?  
       my $position;  
       if ($position=Apache::lonnet::symbread($currenturl)) {  
 # ------------------------------------------------------------------------- Yes  
   my ($mapurl,$mapnum,$thisurl)=split(/\_\_\_/,$position);  
           $cachehash{$thisurl}=$mapnum;  
 # ============================================================ Tie the big hash  
           if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'.db',  
                         &GDBM_READER,0640)) {  
               my $rid=$hash{'map_pc_/res/'.$mapurl}.'.'.$mapnum;  
               my $next='';  
               my $mincond=1;                my $mincond=1;
               my $posnext='';                my $posnext='';
               if ($direction eq 'forward') {                if ($direction eq 'forward') {
 # --------------------------------------------------------------------- Forward  # --------------------------------------------------------------------- Forward
                     while ($hash{'type_'.$rid} eq 'finish') {
                $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
                     }
                   map {                    map {
                       my $thiscond=                        my $thiscond=
       &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});        &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
Line 97  sub handler { Line 115  sub handler {
                                 $hash{'condid_'.$hash{'undercond_'.$linkid}});                                  $hash{'condid_'.$hash{'undercond_'.$linkid}});
                       }                        }
                   } split(/\,/,$posnext);                    } split(/\,/,$posnext);
                     if ($hash{'is_map_'.$next}) {
   # This jumps to the beginning of a new map (going down level)
                         if (
         $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
     $mapurl=$hash{'src_'.$next};
     $next=$hash{'map_start_'.$hash{'src_'.$next}};
                        } elsif (
   # This jumps back up from an empty sequence, to a page up one level
                            $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
                            $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
                        }
                     } elsif 
                       ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
   # This comes up from a map (coming up one level);
         $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
                     }
               } elsif ($direction eq 'back') {                } elsif ($direction eq 'back') {
 # ------------------------------------------------------------------- Backwards  # ------------------------------------------------------------------- Backwards
                    while ($hash{'type_'.$rid} eq 'start') {
                $rid=$hash{'ids_'.$hash{'map_id_'.(split(/\./,$rid))[0]}};
    }
                   map {                    map {
                       my $thiscond=                        my $thiscond=
       &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});        &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
Line 118  sub handler { Line 155  sub handler {
                                 $hash{'condid_'.$hash{'undercond_'.$linkid}});                                  $hash{'condid_'.$hash{'undercond_'.$linkid}});
                       }                        }
                   } split(/\,/,$posnext);                    } split(/\,/,$posnext);
        } elsif ($direction eq 'up') {                    if ($hash{'is_map_'.$next}) {
 # -------------------------------------------------------------------------- Up  # This jumps to the end of a new map (going down one level)
               } elsif ($direction eq 'down') {                        if (
 # ------------------------------------------------------------------------ Down        $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'sequence') {
     $mapurl=$hash{'src_'.$next};
     $next=$hash{'map_finish_'.$hash{'src_'.$next}};
                         } elsif (
         $hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$next}}} eq 'page') {
   # This jumps back up from an empty sequence, to a page up one level
                             $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
                         }
                     } elsif 
                       ((split(/\./,$startoutrid))[0]!=(split(/\./,$next))[0]) {
   # This comes back up from a map (going up one level);
         $mapurl=$hash{'map_id_'.(split(/\./,$next))[0]};
                     }
         }
                 return ($next,$mapurl);
   }
   
   sub navlaunch {
       my ($r)=@_;
       &Apache::loncommon::content_type($r,'text/html');
       &Apache::loncommon::no_cache($r);
       $r->send_http_header;
       my $html=&Apache::lonxml::xmlbegin();
       $r->print("$html<head>\n");
       $r->print('</head>'.
         &Apache::loncommon::bodytag('Launched'));   
       $r->print(<<ENDNAV);
       <p><a href="/adm/flip?postdata=firstres%3a">Goto first resource</a></p>
       <script type="text/javascript">
    function collapse() {
       menu=window.open("/adm/navmaps?collapseExternal","loncapanav",
        "height=600,width=400,scrollbars=1");
       this.document.location='/adm/navmaps?turningOffExternal';
    }
       </script>
       <p><a href="javascript:collapse();">Collapse external navigation window</a></p>
   ENDNAV
       $r->print(&Apache::loncommon::endbodytag().'</html>');
   }
   # ================================================================ Main Handler
   
   sub handler {
      my $r=shift;
   
   # ------------------------------------------- Set document type for header only
   
     if ($r->header_only) {
         &Apache::loncommon::content_type($r,'text/html');
         $r->send_http_header;
         return OK;
     }
   
     my %cachehash=(); 
     my $multichoice=0;
     my %multichoicehash=();
     my ($redirecturl,$redirectsymb);
     my $next='';
     my @possibilities=();
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['postdata']);
     if (($env{'form.postdata'})&&($env{'request.course.fn'})) {
         $env{'form.postdata'}=~/(\w+)\:(.*)/;
         my $direction=$1;
         my $currenturl=$2;
         if ($currenturl=~m|^/enc/|) {
     $currenturl=&Apache::lonenc::unencrypted($currenturl);
         }
         $currenturl=~s/\.\d+\.(\w+)$/\.$1/;
         if ($direction eq 'firstres') {
     my $furl;
     if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
     &GDBM_READER(),0640)) {
         $furl=$bighash{'first_url'};
         untie(%bighash);
     }
     &Apache::loncommon::content_type($r,'text/html');
     $r->header_out(Location => 
    'http://'.$ENV{'HTTP_HOST'}.$furl);
        
     return REDIRECT;
         }
         if ($direction eq 'return' || $direction eq 'navlaunch') {
   # -------------------------------------------------------- Return to last known
            my $last;
            if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
                       &GDBM_READER(),0640)) {
        $last=$hash{'last_known'};
                untie(%hash);
            }
            my $newloc;
            if (($last) && (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
                           &GDBM_READER(),0640))) {
               my ($murl,$id,$fn)=&Apache::lonnet::decode_symb($last);
       $id=$hash{'map_pc_'.&Apache::lonnet::clutter($murl)}.'.'.$id;
       $newloc=$hash{'src_'.$id};
       if ($newloc) {
    if ($hash{'encrypted_'.$id}) { $newloc=&Apache::lonenc::encrypted($newloc); }
         
       } else {
    $newloc='/adm/navmaps';
       }
               untie %hash;
            } else {
       $newloc='/adm/navmaps';
            }  
    if ($newloc eq '/adm/navmaps' && $direction eq 'navlaunch') {
        &navlaunch($r);
        return OK;
    } else {
        &Apache::loncommon::content_type($r,'text/html');
        $r->header_out(Location => 
       'http://'.$ENV{'HTTP_HOST'}.$newloc);
        
        return REDIRECT;
    }
         }
         $currenturl=~s/^http\:\/\///;
         $currenturl=~s/^[^\/]+//;
   #
   # Is the current URL on the map? If not, start with last known URL
   #
         unless (&Apache::lonnet::is_on_map($currenturl)) {
    my $last;
            if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
                       &GDBM_READER(),0640)) {
        $last=$hash{'last_known'};
                untie(%hash);
            }
            if ($last) {
        $currenturl=&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($last))[2]);
    } else {
        if ($direction eq 'return') {
    &Apache::loncommon::content_type($r,'text/html');
    $r->header_out(Location => 
    'http://'.$ENV{'HTTP_HOST'}.'/adm/noidea.html');
    return REDIRECT;
        } else {
    &navlaunch($r);
    return OK;
        }
            }
         }
   # ------------------------------------------- Do we have any idea where we are?
         my $position;
         if ($position=Apache::lonnet::symbread($currenturl)) {
   # ------------------------------------------------------------------------- Yes
     my ($startoutmap,$mapnum,$thisurl)=&Apache::lonnet::decode_symb($position);
             $cachehash{$startoutmap}{$thisurl}=[$thisurl,$mapnum];
             $cachehash{$startoutmap}{'last_known'}=
                                [&Apache::lonnet::declutter($currenturl),$mapnum];
   
   # ============================================================ Tie the big hash
             if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'.db',
                           &GDBM_READER(),0640)) {
                 my $rid=$hash{'map_pc_'.&Apache::lonnet::clutter($startoutmap)}.
                         '.'.$mapnum;
   
   # ------------------------------------------------- Move forward, backward, etc
                 my $endupmap;
                 ($next,$endupmap)=&move($rid,$startoutmap,$direction);
   # -------------------------------------- Do we have one and only one empty URL?
                 my $safecount=0;
                 while (($next) && ($next!~/\,/) && 
                        ((!$hash{'src_'.$next}) || 
         ((!$env{'request.role.adv'}) && $hash{'randomout_'.$next}))
                        && ($safecount<10000)) {
                     ($next,$endupmap)=&move($next,$endupmap,$direction);
                     $safecount++;
               }                }
   # We are now at at least one non-empty URL
 # ----------------------------------------------------- Check out possibilities  # ----------------------------------------------------- Check out possibilities
               if ($next) {                if ($next) {
                   @possibilities=split(/\,/,$next);                    @possibilities=split(/\,/,$next);
                   if ($#possibilities==0) {                    if ($#possibilities==0) {
 # ---------------------------------------------- Only one possibility, redirect  # ---------------------------------------------- Only one possibility, redirect
               $redirecturl=$hash{'src_'.$next};                ($redirecturl,$redirectsymb)=&hash_src($next);
                       $cachehash{&Apache::lonnet::declutter($redirecturl)}                        $cachehash{$endupmap}{$redirecturl}=
                                  =(split(/\./,$next))[1];    [$redirecturl,(split(/\./,$next))[1]];
                   } else {                    } else {
 # ------------------------ There are multiple possibilities for a next resource  # ------------------------ There are multiple possibilities for a next resource
                       $multichoice=1;                        $multichoice=1;
Line 138  sub handler { Line 342  sub handler {
   $multichoicehash{'src_'.$_}=$hash{'src_'.$_};    $multichoicehash{'src_'.$_}=$hash{'src_'.$_};
                           $multichoicehash{'title_'.$_}=$hash{'title_'.$_};                            $multichoicehash{'title_'.$_}=$hash{'title_'.$_};
                           $multichoicehash{'type_'.$_}=$hash{'type_'.$_};                            $multichoicehash{'type_'.$_}=$hash{'type_'.$_};
                           $cachehash                            (my $first, my $second) = $_ =~ /(\d+).(\d+)/;
                             {&Apache::lonnet::declutter(                            my $symbSrc = Apache::lonnet::declutter($hash{'src_'.$_});
       $multichoicehash                            $multichoicehash{'symb_'.$_} = 
                                                          {'src_'.$_}                                Apache::lonnet::declutter($hash{'map_id_'.$first}.'___'.
                                                        )}                                                          $second.'___'.$symbSrc);
                                  =(split(/\./,$_))[1];                                                           
                             my ($choicemap,$choiceres)=split(/\./,$_);
     my $map=&Apache::lonnet::declutter($hash{'src_'.$choicemap});
     my $url=$multichoicehash{'src_'.$_};
                             $cachehash{$map}{$url}=[$url,$choiceres];
                       } @possibilities;                        } @possibilities;
                   }                    }
       } else {        } else {
Line 153  sub handler { Line 361  sub handler {
 # ----------------- The program must come past this point to untie the big hash  # ----------------- The program must come past this point to untie the big hash
       untie(%hash);        untie(%hash);
 # --------------------------------------------------------- Store position info  # --------------------------------------------------------- Store position info
               $cachehash{'last_direction'}=$direction;                $cachehash{$startoutmap}{'last_direction'}=[$direction,'notasymb'];
               &Apache::lonnet::symblist($mapurl,%cachehash);                foreach my $thismap (keys %cachehash) {
     my $mapnum=$cachehash{$thismap}->{'mapnum'};
     delete($cachehash{$thismap}->{'mapnum'});
     &Apache::lonnet::symblist($thismap,
       %{$cachehash{$thismap}});
         }
 # ============================================== Do not return before this line  # ============================================== Do not return before this line
               if ($redirecturl) {                if ($redirecturl) {
 # ----------------------------------------------------- There is a URL to go to  # ----------------------------------------------------- There is a URL to go to
   $r->content_type('text/html');    if ($direction eq 'forward') {
                   $r->header_out(Location =>                        &Apache::lonnet::linklog($currenturl,$redirecturl);
                                 'http://'.$ENV{'HTTP_HOST'}.$redirecturl);    }
     if ($direction eq 'back') {
                        &Apache::lonnet::linklog($redirecturl,$currenturl);
     }
   # ------------------------------------------------- Check for critical messages
     if ((time-$env{'user.criticalcheck.time'})>300) {
                        my @what=&Apache::lonnet::dump
                                     ('critical',$env{'user.domain'},
                                                 $env{'user.name'});
                        if ($what[0]) {
                   if (($what[0] ne 'con_lost') && 
                               ($what[0]!~/^error\:/)) {
                      $redirecturl='/adm/email?critical=display';
      $redirectsymb='';
                           }
                        }
                        &Apache::lonnet::appenv('user.criticalcheck.time'=>time);
     }
   
     &Apache::loncommon::content_type($r,'text/html');
     my $url='http://'.$ENV{'HTTP_HOST'}.$redirecturl;
     if ($redirectsymb ne '') { $url.='?symb='.&Apache::lonnet::escape($redirectsymb); }
                     $r->header_out(Location => $url);
                   return REDIRECT;                    return REDIRECT;
       } else {        } else {
 # --------------------------------------------------------- There was a problem  # --------------------------------------------------------- There was a problem
               }                    &Apache::loncommon::content_type($r,'text/html');
                     $r->send_http_header;
     my %lt=&Apache::lonlocal::texthash('title' => 'End of Sequence',
        'explain' =>
        'You have reached the end of the sequence of materials.',
        'back' => 'Go Back',
        'nav' => 'Navigate Course Content',
        'wherenext' =>
        'There are several possibilities of where to go next',
        'pick' =>
        'Please click on the the resource you intend to access',
        'titleheader' => 'Title',
        'type' => 'Type');
                     if ($#possibilities>0) {
         my $bodytag=
                                &Apache::loncommon::bodytag('Multiple Resources');
                        $r->print(<<ENDSTART);
   <head><title>Choose Next Location</title></head>
   $bodytag
   <h3>$lt{'wherenext'}</h3>
   <p>
   $lt{'pick'}:
   <p>
   <table border=2>
   <tr><th>$lt{'titleheader'}</th><th>$lt{'type'}</th></tr>
   ENDSTART
                        foreach (@possibilities) {
                           $r->print(
                                 '<tr><td><a href="'.
                                 $multichoicehash{'src_'.$_}.'?symb=' .
                                     Apache::lonnet::escape($multichoicehash{'symb_'.$_}).'">'.
                                 $multichoicehash{'title_'.$_}.
                                 '</a></td><td>'.$multichoicehash{'type_'.$_}.
         '</td></tr>');
                        }
                        $r->print('</table>');
                     } else {
         my $bodytag=&Apache::loncommon::bodytag('No Resource');
         $r->print(<<ENDNONE);
   <head><title>No Resource</title></head>
   $bodytag
   <h3>$lt{'title'}</h3>
   <p>$lt{'explain'}</p>
   ENDNONE
     }
     $r->print(<<ENDMENU);
   <ul>
   <li><a href="/adm/flip?postdata=return:">$lt{'back'}</a></li>
   <li><a href="/adm/navmaps">$lt{'nav'}</a></li>
   </ul></body></html>
   ENDMENU
                     return OK;
         }
   } else {    } else {
 # ------------------------------------------------- Problem, could not tie hash  # ------------------------------------------------- Problem, could not tie hash
               $ENV{'user.error.msg'}="/adm/flip:bre:0:1:Course Data Missing";                $env{'user.error.msg'}="/adm/flip:bre:0:1:Course Data Missing";
               return HTTP_NOT_ACCEPTABLE;                 return HTTP_NOT_ACCEPTABLE; 
           }            }
       } else {        } else {
 # ---------------------------------------- No, could not determine where we are  # ---------------------------------------- No, could not determine where we are
          $r->internal_redirect('/adm/ambiguous');    if ( &Apache::lonnet::mod_perl_version() == 2 ) {
         &Apache::lonnet::cleanenv();
     }
     $r->internal_redirect('/adm/ambiguous');
       }        }
   } else {    } else {
 # -------------------------- Class was not initialized or page fliped strangely  # -------------------------- Class was not initialized or page fliped strangely
       $ENV{'user.error.msg'}="/adm/flip:bre:0:0:Choose Course";        $env{'user.error.msg'}="/adm/flip:bre:0:0:Choose Course";
       return HTTP_NOT_ACCEPTABLE;         return HTTP_NOT_ACCEPTABLE; 
   }     } 
 }  }

Removed from v.1.6  
changed lines
  Added in v.1.59


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