Diff for /rat/lonsequence.pm between versions 1.2 and 1.56

version 1.2, 2000/10/16 21:09:33 version 1.56, 2021/07/19 15:48:25
Line 2 Line 2
 #  #
 # Sequence Handler  # Sequence Handler
 #  #
 # (Handler to resolve ambiguous file locations  # $Id$
 #  #
 # (TeX Content Handler  # Copyright Michigan State University Board of Trustees
 #  #
 # 05/29/00,05/30,10/11 Gerd Kortemeyer)  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
 #  #
 # 10/11,10/12 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.
 #  #
 # 10/16 Gerd Kortemeyer  # 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/
   #
   
   
   
 package Apache::lonambiguous;  package Apache::lonsequence;
   
 use strict;  use strict;
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::Constants qw(:common REDIRECT);  use Apache::Constants qw(:common :http REDIRECT);
 use GDBM_File;  use GDBM_File;
   use LONCAPA::map();
   use LONCAPA::ltiutils;
   use LONCAPA;
   use Apache::lonpageflip();
   use Apache::loncommon();
   use Apache::groupsort();
   use Apache::lonlocal;
   use Apache::lonnavmaps();
   use Apache::lonenc();
   use HTML::Entities();
   
   my %selhash;
   my $successtied;
   
   # ----------------------------------------- Attempt to read from resource space
   
   sub attemptread {
       my ($fn,$unsorted)=@_;
       &Apache::lonnet::repcopy($fn);
       if (-e $fn) {
    return &LONCAPA::map::attemptread($fn,$unsorted);
       } else {
           return ();
       }
   }
   
   sub mapread {
       my $fn=shift;
       &Apache::lonnet::repcopy($fn);
       if (-e $fn) {
    return &LONCAPA::map::mapread($fn,'');
       } else {
           return ();
       }
   }
   
   # ---------------------------------------------------------------- View Handler
   
   sub viewmap {
       my ($r,$url)=@_;
   
       my $js;
       if ($env{'form.forceselect'}) {
    $js = (<<ENDSCRIPT);
   <script type="text/javascript">
   
   function select_group() {
       window.location="/adm/groupsort?catalogmode=groupsec&mode=rat&acts="+document.forms.fileattr.acts.value;
   }
   
   function queue(val) {
       if (eval("document.forms."+val+".filelink.checked")) {
    var l=val.length;
    var v=val.substring(4,l);
    document.forms.fileattr.acts.value+='1a'+v+'b';
       }
       else {
    var l=val.length;
    var v=val.substring(4,l);
    document.forms.fileattr.acts.value+='0a'+v+'b';
       }
   }
   
   </script>
   ENDSCRIPT
       }
   
 # ----------------------------------------------------------- Could not resolve      $r->print(&Apache::loncommon::start_page('Map Contents',$js).
         '<h1>'.$url.'</h1>');
   # ------------------ This is trying to select. Provide buttons and tie %selhash
       if ($env{'form.forceselect'}) { $r->print(<<ENDSELECT);
   <form name="fileattr"><input type="hidden" name="acts" value="" />
   <input type="button" name="close" value="CLOSE" onClick="self.close()" />
   <input type="button" name="groupimport" value="GROUP IMPORT"
   onClick="javascript:select_group()" />
   </form>   
   ENDSELECT
       my $diropendb = 
     LONCAPA::tempdir() .
       "$env{'user.domain'}\_$env{'user.name'}_sel_res.db";
           if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
       if ($env{'form.launch'} eq '1') {
          &start_fresh_session();
       }
               $successtied=1;
   
   # - Evaluate actions from previous page (both cumulatively and chronologically)
       if ($env{'form.catalogmode'} eq 'import') {
    &Apache::groupsort::update_actions_hash(\%selhash);
       }
   # -
           }
       }
   # ----------------------------- successtied is now '1' if in working selectmode
       my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),'');
       if ($fatal==1) {
          $r->print('<p class="LC_warning">'
                   .&mt('Map contents are not shown in order.')
                   .'</p><br />');
       }
       my $idx=0;
       foreach my $entry (&attemptread(&Apache::lonnet::filelocation('',$url))) {
    if (defined($entry)) {
               $idx++;
               if ($successtied) { 
    $r->print('<form name="form'.$idx.'">');
               }
       my ($title,$url)=split(/\:/,$entry);
       $title = &LONCAPA::map::qtescape($title);
       unless ($title) { $title=(split(/\//,$url))[-1] };
               my $enc_title = &HTML::Entities::encode($title,'\'"<>&');
       unless ($title) {
    $title='<i>'.&mt('Empty').'</i>';
    $enc_title = &mt('Empty');
       }
       $url  = &LONCAPA::map::qtescape($url);
               my $enc_url = &HTML::Entities::encode($url,'\'"<>&');
               if ($url) {
    if ($successtied) {
       my $checked='';
              if ($selhash{'store_'.$url}) {
               $checked=' checked="checked"';
              }
              $selhash{"pre_${idx}_link"}=$url;
              $selhash{"pre_${idx}_title"}=$title;
       
       $url  = &HTML::Entities::encode($url, '\'"<>&');
       $r->print(<<ENDCHECKBOX);
   <input type='checkbox' name='filelink' 
   value='$enc_url' onClick='javascript:queue("form$idx")'$checked />
   <input type='hidden' name='title' value='$enc_title' />
   ENDCHECKBOX
                   }
    $r->print('<a href="'.$enc_url.'">');
               }
               $r->print($enc_title);
               if ($url) { $r->print('</a>'); }
               if ($successtied) {
    $r->print('</form>');
               } else {
    $r->print('<br />');
               }
           }
       }
       $r->print(&Apache::loncommon::end_page());
       if ($successtied) {
    untie %selhash;
       }
   }
   
 sub getlost {  # ----------------------------------------------------------- Clean out selhash
     my ($r,$errmsg)=@_;  sub start_fresh_session {
     $r->content_type('text/html');      foreach my $item (keys(%selhash)) {
     $r->send_http_header;   if ($item =~ /^pre_/) {
     $r->print(      delete $selhash{$item};
  '<head><title>Unknown Error</title></head><body bgcolor="#FFFFFF"><h1>'.   }
  'LON-CAPA</h1>Could not handle ambiguous resource reference.<p>'.$errmsg.   if ($item =~ /^store/) {
  '</body></html>');      delete $selhash{$item};
    }
       }
 }  }
   
   
 # ================================================================ Main Handler  # ================================================================ Main Handler
   
 sub handler {  sub handler {
    my $r=shift;     my $r=shift;
   
    if ($r->header_only) {     if ($r->header_only) {
       $r->content_type('text/html');        &Apache::loncommon::content_type($r,'text/html');
       $r->send_http_header;        $r->send_http_header;
       return OK;        return OK;
    }     }
   
      my $requrl=$r->uri;
      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                                             ['forceselect','launch','navmap']);
   
      if (($env{'request.course.fn'}) && ($env{'form.navmap'}) && ($env{'request.course.id'})) {
          my $crstype = &Apache::loncommon::course_type();
          unless (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
   
              # Check for critical messages and redirect if present.
              my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents');
              if ($redirect) {
                  &Apache::loncommon::content_type($r,'text/html');
                  $r->header_out(Location => $url);
                  return REDIRECT;
              }
   
              # Check if course needs to be re-initialized
              my $loncaparev = $r->dir_config('lonVersion');
              my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
   
              if ($result eq 'switch') {
                  &Apache::loncommon::content_type($r,'text/html');
                  $r->send_http_header;
                  $r->print(&Apache::loncommon::check_release_result(@reinit));
                  return OK;
              } elsif ($result eq 'update') {
                  my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                  my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                  my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                  if ($ferr) {
                      my $requrl = $r->uri;
                      $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
                      $env{'user.reinit'} = 1;
                      return HTTP_NOT_ACCEPTABLE;
                  }
              }
   
              &Apache::loncommon::content_type($r,'text/html');
              $r->send_http_header;
   
              my $mapurl = &Apache::lonnet::declutter($requrl);
              my $maptitle = &Apache::lonnet::gettitle($mapurl);
              my @crumbs = ({text => $maptitle, no_mt => 1});
              my $args = {'bread_crumbs' => \@crumbs,
                          'bread_crumbs_nomenu' => 1};
   
              # Create the nav map
              my $navmap = Apache::lonnavmaps::navmap->new();
   
              if (ref($navmap)) {
                  # renderer call
                  if (&Apache::lonnet::is_on_map($requrl)) {
                      my ($ltiscope,$ltiuri);
                      if (($env{'request.lti.login'}) && ($env{'request.lti.uri'})) {
                          my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                          my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                          ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},$cdom,$cnum);
                      }
                      @crumbs = ();
                      unless ($ltiscope eq 'resource') {
                          unless ($ltiscope eq 'map') {
                              @crumbs = ({text  => $crstype.' Contents',
                                          href  => "javascript:gopost('/adm/navmaps','')"});
                          }
                          my $res = $navmap->getResourceByUrl($mapurl);
                          if (ref($res)) {
                              my $symb = $res->symb();
                              if ($symb) {
                                  my ($parent) = &Apache::lonnet::decode_symb($res->symb());
                                  if (($parent ne $env{'course.'.$env{'request.course.id'}.'.url'}) &&
                                      !(($ltiscope eq 'map') && ($requrl eq $ltiuri))) {
                                      my @mapcrumbs = $navmap->recursed_crumbs($parent);
                                      if (@mapcrumbs) {
                                          push(@crumbs,@mapcrumbs);
                                      }
                                  }
                                  $env{'request.symb'} = $symb;
                              }
                          }
                      }
                      push(@crumbs,{text => $maptitle, no_mt => 1});
                      $args = {'bread_crumbs' => \@crumbs,
                               'bread_crumbs_nomenu' => 1,
                               'no_auto_mt_title' => 1};
                      $r->print(&Apache::loncommon::start_page($maptitle,undef,$args));
   
                      my $renderArgs = { 'cols'                    => [0,1,2,3],
                                         'url'                     => $mapurl,
                                         'navmap'                  => $navmap,
                                         'suppressNavmap'          => 1,
                                         'suppressEmptySequences'  => 1,
                                         'filterFunc'              => undef,
                                         'resource_no_folder_link' => 1,
                                         'r'                       => $r,
                                         'caller'                  => 'sequence',
                                         'notools'                 => 1,
                                         'iterator_map'            => $mapurl,
                                       };
   
                      my $render = &Apache::lonnavmaps::render($renderArgs);
   
                      # If no resources were found let the user know.
                      if ($renderArgs->{'counter'} == 0) {
                          $r->print('<p class="LC_info">'.
                                    &mt('No items found in folder').
                                    '</p>');
                      }
                      $r->print(&Apache::loncommon::end_page());
                  } else {
                      $r->print(&Apache::loncommon::start_page($maptitle,undef,$args).
                                '<p class="LC_info">'.
                                &mt('Folder no longer appears to be a part of the course').
                                '</p>'.
                                &Apache::loncommon::end_page());
                  }
              } else {
                  $r->print(&Apache::loncommon::start_page($maptitle,undef,$args).
                            '<p class="LC_warning">'.
                            &mt('Error: could not determine contents of folder').
                            '</p>'.
                            &Apache::loncommon::end_page());
              }
              $r->rflush();
              return OK;
          }
      }
   
    my %hash;     my %hash;
    my %bighash;     my %bighash;
    my $requrl=$r->uri;  
   
 # ----------------------------------------------------------------- Tie db file     $successtied=0;
   if ($ENV{'request.course.fn'}) {  # ------------------------------------------------------------ Tie symb db file
     my $disurl='';
     my $dismapid='';
     my $exitdisid = '';
     my $arrow_dir = '';
     my $is_encrypted = '';
   
     if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) {
        my $last;         my $last;
        if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
                     &GDBM_READER,0640)) {                      &GDBM_READER(),0640)) {
    $last=$hash{'last_direction'};     $last=$hash{'last_direction'};
            untie(%hash);             untie(%hash);
        }         }
        if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',         my $direction='';
                     &GDBM_READER,0640)) {         my $prevmap='';
            my $direction='';         if ($last) {
            my $prevmap='';     ($prevmap,undef,$direction)=&Apache::lonnet::decode_symb($last);
    if ($last) {  
        ($prevmap,$direction)=(split(/\_\_\_/,$last));  
            }  
                 
 # ===== Stuff goes here  
           foreach $envkey (keys %ENV) {  
              if ($envkey=~/^form\.(\d+)\.(\d+)$/) {  
          my $mapid=$1;  
                  my $resid=$2;  
                  my $resurl=$bighash{'src_'.$mapid.'.'.$resid};  
                  &Apache::lonnet::symblist($bighash{'map_id_'.$mapid},  
            $resurl => $resid);  
                  $r->header_out(Location =>   
                                 'http://'.$ENV{'HTTP_HOST'}.$resurl);  
                  return REDIRECT;  
              }  
   }  
           untie(%bighash);  
        } else {  
           &getlost($r,'Could not access course structure.');  
           return OK;  
        }         }
    } else {  # ------------------------------------------------------------- Tie big db file
       $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";         if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
       return HTTP_NOT_ACCEPTABLE;                       &GDBM_READER(),0640)) {
    }     my $disid='';
              my $randomout ='';
    return OK;  
              if ($direction eq 'back') {
          $disid=$bighash{'map_finish_'.$requrl};
              } else {
                  $disid=$bighash{'map_start_'.$requrl};
              }
              if ($disid) {
          $disurl=$bighash{'src_'.$disid};
                  $dismapid=(split(/\./,$disid))[1];
          if (!$env{'request.role.adv'}) {
      $randomout = $bighash{'randomout_'.$disid};
                      $is_encrypted = $bighash{'encrypted_'.$disid};
                  }
              } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
                       &GDBM_READER(),0640)) {
                  $last=$hash{'last_known'};
                  untie(%hash);
              }
   
 # ================================================================= TRASH BELOW  
   
 # ---------------------------------------------------------- Do we have a case?  # ----------- If this is an empty one, or hidden, skip to next non-empty or non-hidden one
              while ( ((!$disurl) && ($disid)) || ($randomout && $disid) ) {
          $direction=($direction?$direction:'forward');
                  ($disid,$requrl)=
                            &Apache::lonpageflip::fullmove($disid,
                              &Apache::lonnet::declutter($requrl),$direction);
                  if ($disid) {
              $disurl=$bighash{'src_'.$disid};
                      $dismapid=(split(/\./,$disid))[1];
      if (!$env{'request.role.adv'}) {
          $randomout = $bighash{'randomout_'.$disid};
                          $is_encrypted = $bighash{'encrypted_'.$disid};
                      }
                  }
       }
              $exitdisid = $disid;
              $arrow_dir = $direction;
   
    my $thisfn;  # --------------------------------------- Untie hash, make sure to come by here
    unless (($thisfn=$ENV{'request.ambiguous'})&&($ENV{'request.course.fn'})) {             untie(%bighash);
        &getlost($r,'Could not find information on resource.');         }
        return OK;  
    }     }
         
 # ---------------------------------- Should this file have been part of a page?  
   
     $thisfn=&Apache::lonnet::declutter($thisfn);  # now either disurl is set (going to first page), or we need another display
     my %hash;     if ($disurl) {
     my $syval='';  # -------------------------------------------------- Has first or last resource
             my $showdisurl = $disurl;
     if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',        if ($is_encrypted) {
                   &GDBM_READER,0640)) {            $showdisurl = &Apache::lonenc::encrypted($disurl);
        $syval=$hash{$thisfn};        }
        untie(%hash);        if ($disurl =~ m{^/adm/navmaps(\?|$)}) {
     }            &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid]);
         } else {
 # ---------------------------------------------------------- There was an entry            &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid],
                                       'last_known' => [$disurl,$dismapid]);
     if ($syval) {        }
         &Apache::loncommon::content_type($r,'text/html');
        if ($syval=~/\_$/) {        $r->header_out(Location => &Apache::lonnet::absolute_url().
 # ----------------------------------- Okay, this should have appeared on a page                                   $showdisurl);
    $syval=~s/\_\_\_$//;        return REDIRECT;
     $r->content_type('text/html');     } else {
            $r->header_out(Location =>          &Apache::loncommon::content_type($r,'text/html');
                 'http://'.$ENV{'HTTP_HOST'}.'/res/'.$syval);         $r->send_http_header;
            return REDIRECT;         if ($exitdisid eq '' && $arrow_dir ne '') {
              my %lt =&Apache::lonlocal::texthash(
                      'nere' => 'Next resource could not be displayed',
                      'goba' => 'Go Back',
                      'nacc' => 'Course Contents',
                             );
              if (&Apache::loncommon::course_type() eq 'Community') {
                  $lt{'nav'} = &mt('Community Contents');
              }
              my $warnmsg;
              if ($arrow_dir eq 'forward') {
                  $warnmsg = &mt('As all folders and sequences '
                                .'following the current resource were empty, '
                                .'you have now reached the end of the course.');
              } elsif ($arrow_dir eq 'back') {
                  $warnmsg = &mt('As all folders and sequences '
                                .'preceding the current resource were empty, '
                                .'you have now reached the beginning of the course.');
              }
              my $start_page=
          &Apache::loncommon::start_page('Empty Folder/Sequence');
              my $end_page=
          &Apache::loncommon::end_page();
              $r->print(<<ENDNONE);
   $start_page
   <h3>$lt{'nere'}</h3>
   <p>$warnmsg</p>
   <ul>
     <li><a href="javascript:history.go(-1)">$lt{'goba'}</a></li>
     <li><a href="/adm/navmaps">$lt{'nacc'}</a></li>
   </ul>
   $end_page
   ENDNONE
        } else {         } else {
 #  There is not really a problem (???), but cannot go back without endless loop             &viewmap($r,$requrl);
            &getlost($r,'The nature of the problem is unclear');  
            return OK;  
        }         }
     }         return OK;
      }
 # ------------------------------------------------ Would be standalone resource  
   
    if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',  
                     &GDBM_READER,0640)) {  
 # ---------------------------------------------- Get ID(s) for current resource  
       my $ids=$bighash{'ids_/res/'.$thisfn};  
       if ($ids) {  
 # ------------------------------------------------------------------- Has ID(s)  
          my @possibilities=split(/\,/,$ids);  
          my $couldbe='';  
          map {  
              if (&Apache::lonnet::allowed('bre',$bighash{'src_'.$_})) {  
          if ($couldbe) {  
      $couldbe.=','.$_;  
                  } else {  
                      $couldbe=$_;  
                  }  
              }  
  } @possibilities;  
          if ($couldbe) {  
             @possibilities=split(/\,/,$couldbe);  
             if ($#possibilities>0) {  
 # ----------------------------------------------- Okay, really multiple choices  
                $r->content_type('text/html');  
                $r->send_http_header;  
                $r->print(<<ENDSTART);  
 <head><title>Choose Location</title></head>  
 <body bgcolor="#FFFFFF">  
 <h1>LON-CAPA</h1>  
 The resource you had been accessing appears more than once in this course,  
 and LON-CAPA has insufficient session information to determine which instance  
 of the resource you meant.  
 <p>  
 Please click on the instance of the resource you intended to access:  
 <p>  
 <form action="/adm/ambiguous" method=post>  
 <input type=hidden name=orgurl value="$thisfn">  
 <input type=hidden name=selecturl value=1>  
 <table border=2>  
 <tr><th>&nbsp;</th><th>Title</th><th>Type</th><th>Part of ...</th></tr>  
 ENDSTART  
                map {  
                    my $mapurl=$bighash{'map_id_'.(split(/\./,$_))[0]};  
                    $r->print('<tr><td><input type=submit value=Select name="'.  
                               $_.'"></td><td>'.$bighash{'title_'.$_}.  
                               '</td><td>'.$bighash{'type_'.$_}.  
                               '</td><td><a href="'.$mapurl.'">'.$mapurl.  
       '</a></td></tr>');  
                } @possibilities;  
                $r->print('</table></form></body></html>');  
        untie(%bighash);  
                return OK;  
             }  
          }  
       }  
       untie(%bighash);  
   }  
   
 # ------------------------------------ This handler should not have been called  
    &getlost($r,'Invalid call of handler');  
    return OK;  
 }  }
   
 1;  1;
 __END__  __END__
   
   =head1 NAME
   
   Apache::lonsequence
   
   =head1 SYNOPSIS
   
   Handler for showing sequence objects of
   educational resources.
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org.
   
   =head1 SUBROUTINES
   
   =over
   
   =item handler()
   
   =item viewmap()
   
   =item attemptread()
   
   =item mapread()
   
   =item start_fresh_session()
   
   =back
   
   =cut
   
   
   

Removed from v.1.2  
changed lines
  Added in v.1.56


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