File:  [LON-CAPA] / rat / lonsequence.pm
Revision 1.35: download - view: text, annotated - select for diffs
Thu Nov 20 15:19:05 2008 UTC (15 years, 5 months ago) by jms
Branches: MAIN
CVS tags: HEAD
Moved POD comments to bottom of file

    1: # The LearningOnline Network with CAPA
    2: #
    3: # Sequence Handler
    4: #
    5: # $Id: lonsequence.pm,v 1.35 2008/11/20 15:19:05 jms Exp $
    6: #
    7: # Copyright Michigan State University Board of Trustees
    8: #
    9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   10: #
   11: # LON-CAPA is free software; you can redistribute it and/or modify
   12: # it under the terms of the GNU General Public License as published by
   13: # the Free Software Foundation; either version 2 of the License, or
   14: # (at your option) any later version.
   15: #
   16: # LON-CAPA is distributed in the hope that it will be useful,
   17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   19: # GNU General Public License for more details.
   20: #
   21: # You should have received a copy of the GNU General Public License
   22: # along with LON-CAPA; if not, write to the Free Software
   23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   24: #
   25: # /home/httpd/html/adm/gpl.txt
   26: #
   27: # http://www.lon-capa.org/
   28: #
   29: 
   30: 
   31: 
   32: package Apache::lonsequence;
   33: 
   34: use strict;
   35: use Apache::lonnet;
   36: use Apache::Constants qw(:common :http REDIRECT);
   37: use GDBM_File;
   38: use LONCAPA::map();
   39: use Apache::lonpageflip();
   40: use Apache::loncommon();
   41: use Apache::groupsort();
   42: use Apache::lonlocal;
   43: use HTML::Entities();
   44: 
   45: my %selhash;
   46: my $successtied;
   47: 
   48: # ----------------------------------------- Attempt to read from resource space
   49: 
   50: sub attemptread {
   51:     my ($fn,$unsorted)=@_;
   52:     &Apache::lonnet::repcopy($fn);
   53:     if (-e $fn) {
   54: 	return &LONCAPA::map::attemptread($fn,$unsorted);
   55:     } else {
   56:         return ();
   57:     }
   58: }
   59: 
   60: sub mapread {
   61:     my $fn=shift;
   62:     &Apache::lonnet::repcopy($fn);
   63:     if (-e $fn) {
   64: 	return &LONCAPA::map::mapread($fn,'');
   65:     } else {
   66:         return ();
   67:     }
   68: }
   69: 
   70: # ---------------------------------------------------------------- View Handler
   71: 
   72: sub viewmap {
   73:     my ($r,$url)=@_;
   74: 
   75:     my $js;
   76:     if ($env{'form.forceselect'}) {
   77: 	$js = (<<ENDSCRIPT);
   78: <script type="text/javascript">
   79: 
   80: function select_group() {
   81:     window.location="/adm/groupsort?catalogmode=groupsec&mode=rat&acts="+document.forms.fileattr.acts.value;
   82: }
   83: 
   84: function queue(val) {
   85:     if (eval("document.forms."+val+".filelink.checked")) {
   86: 	var l=val.length;
   87: 	var v=val.substring(4,l);
   88: 	document.forms.fileattr.acts.value+='1a'+v+'b';
   89:     }
   90:     else {
   91: 	var l=val.length;
   92: 	var v=val.substring(4,l);
   93: 	document.forms.fileattr.acts.value+='0a'+v+'b';
   94:     }
   95: }
   96: 
   97: </script>
   98: ENDSCRIPT
   99:     }
  100: 
  101:     $r->print(&Apache::loncommon::start_page('Map Contents',$js).
  102: 	      '<h1>'.$url.'</h1>');
  103: # ------------------ This is trying to select. Provide buttons and tie %selhash
  104:     if ($env{'form.forceselect'}) { $r->print(<<ENDSELECT);
  105: <form name=fileattr><input type=hidden name=acts value=''>
  106: <input type="button" name="close" value='CLOSE' onClick="self.close()">
  107: <input type="button" name="groupimport" value='GROUP IMPORT'
  108: onClick="javascript:select_group()">
  109: </form>   
  110: ENDSELECT
  111:     my $diropendb = 
  112:     "/home/httpd/perl/tmp/$env{'user.domain'}\_$env{'user.name'}_sel_res.db";
  113:         if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
  114: 	    if ($env{'form.launch'} eq '1') {
  115: 	       &start_fresh_session();
  116: 	    }
  117:             $successtied=1;
  118: 
  119: # - Evaluate actions from previous page (both cumulatively and chronologically)
  120: 	    if ($env{'form.catalogmode'} eq 'import') {
  121: 		&Apache::groupsort::update_actions_hash(\%selhash);
  122: 	    }
  123: # -
  124:         }
  125:     }
  126: # ----------------------------- successtied is now '1' if in working selectmode
  127:     my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),'');
  128:     if ($fatal==1) {
  129:        $r->print('<p><b><font color="red">'.&mt('Map contents are not shown in order.').'</font></b></p><br />');
  130:     }
  131:     my $idx=0;
  132:     foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) {
  133: 	if (defined($_)) {
  134:             $idx++;
  135:             if ($successtied) { 
  136: 		$r->print('<form name="form'.$idx.'">');
  137:             }
  138: 	    my ($title,$url)=split(/\:/,$_);
  139: 	    $title = &LONCAPA::map::qtescape($title);
  140: 	    unless ($title) { $title=(split(/\//,$url))[-1] };
  141:             my $enc_title = &HTML::Entities::encode($title,'\'"<>&');
  142: 	    unless ($title) {
  143: 		$title='<i>'.&mt('Empty').'</i>';
  144: 		$enc_title = &mt('Empty');
  145: 	    }
  146: 	    $url  = &LONCAPA::map::qtescape($url);
  147:             my $enc_url = &HTML::Entities::encode($url,'\'"<>&');
  148:             if ($url) {
  149: 		if ($successtied) {
  150: 		    my $checked='';
  151: 	           if ($selhash{'store_'.$url}) {
  152: 	       	      $checked=" checked";
  153: 	           }
  154: 	           $selhash{"pre_${idx}_link"}=$url;
  155: 	           $selhash{"pre_${idx}_title"}=$title;
  156: 		    
  157: 		    $url  = &HTML::Entities::encode($url, '\'"<>&');
  158: 		    $r->print(<<ENDCHECKBOX);
  159: <input type='checkbox' name='filelink' 
  160: value='$enc_url' onClick='javascript:queue("form$idx")'$checked />
  161: <input type='hidden' name='title' value='$enc_title' />
  162: ENDCHECKBOX
  163:                 }
  164: 		$r->print('<a href="'.$enc_url.'">');
  165:             }
  166:             $r->print($enc_title);
  167:             if ($url) { $r->print('</a>'); }
  168:             if ($successtied) {
  169: 		$r->print('</form>');
  170:             } else {
  171: 		$r->print('<br>');
  172:             }
  173:         }
  174:     }
  175:     $r->print(&Apache::loncommon::end_page());
  176:     if ($successtied) {
  177: 	untie %selhash;
  178:     }
  179: }
  180: 
  181: # ----------------------------------------------------------- Clean out selhash
  182: sub start_fresh_session {
  183:     foreach (keys %selhash) {
  184: 	if ($_ =~ /^pre_/) {
  185: 	    delete $selhash{$_};
  186: 	}
  187: 	if ($_ =~ /^store/) {
  188: 	    delete $selhash{$_};
  189: 	}
  190:     }
  191: }
  192: 
  193: 
  194: # ================================================================ Main Handler
  195: 
  196: sub handler {
  197:    my $r=shift;
  198: 
  199:    if ($r->header_only) {
  200:       &Apache::loncommon::content_type($r,'text/html');
  201:       $r->send_http_header;
  202:       return OK;
  203:    }
  204:  
  205:    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  206:                                           ['forceselect','launch']);
  207: 
  208:    my %hash;
  209:    my %bighash;
  210:    my $requrl=$r->uri;
  211: 
  212:    $successtied=0;
  213: # ------------------------------------------------------------ Tie symb db file
  214:   my $disurl='';
  215:   my $dismapid='';
  216:   my $exitdisid = '';
  217:   my $arrow_dir = '';
  218: 
  219:   if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) {
  220:        my $last;
  221:        if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  222:                     &GDBM_READER(),0640)) {
  223: 	   $last=$hash{'last_direction'};
  224:            untie(%hash);
  225:        }
  226:        my $direction='';
  227:        my $prevmap='';
  228:        if ($last) {
  229: 	   ($prevmap,undef,$direction)=&Apache::lonnet::decode_symb($last);
  230:        }
  231: # ------------------------------------------------------------- Tie big db file
  232:        if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
  233:                     &GDBM_READER(),0640)) {
  234: 	   my $disid='';
  235:            my $randomout ='';
  236: 
  237:            if ($direction eq 'back') {
  238: 	       $disid=$bighash{'map_finish_'.$requrl};
  239:            } else {
  240:                $disid=$bighash{'map_start_'.$requrl};
  241:            }
  242:            if ($disid) {
  243: 	       $disurl=$bighash{'src_'.$disid};
  244:                $dismapid=(split(/\./,$disid))[1];
  245: 	       if (!$env{'request.role.adv'}) {
  246: 		   $randomout = $bighash{'randomout_'.$disid};
  247: 	       }
  248:            } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
  249:                     &GDBM_READER(),0640)) {
  250:                $last=$hash{'last_known'};
  251:                untie(%hash);
  252:            }
  253: 
  254: 
  255: # ----------- If this is an empty one, or hidden, skip to next non-empty or non-hidden one
  256:            while ( ((!$disurl) && ($disid)) || ($randomout && $disid) ) {
  257: 	       $direction=($direction?$direction:'forward');
  258:                ($disid,$requrl)=
  259:                          &Apache::lonpageflip::fullmove($disid,
  260:                            &Apache::lonnet::declutter($requrl),$direction);
  261:                if ($disid) {
  262: 	           $disurl=$bighash{'src_'.$disid};
  263:                    $dismapid=(split(/\./,$disid))[1];
  264: 		   if (!$env{'request.role.adv'}) {
  265: 		       $randomout = $bighash{'randomout_'.$disid};
  266: 		   }
  267:                }
  268:  	   }
  269:            $exitdisid = $disid;
  270:            $arrow_dir = $direction;
  271: 
  272: # --------------------------------------- Untie hash, make sure to come by here
  273:            untie(%bighash);
  274:        }
  275:    }
  276: 
  277: # now either disurl is set (going to first page), or we need another display
  278:    if ($disurl) {
  279: # -------------------------------------------------- Has first or last resource
  280:       &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid],
  281: 				'last_known' => [$disurl,$dismapid]); 
  282:       &Apache::loncommon::content_type($r,'text/html');
  283:       $r->header_out(Location => 'http://'.$ENV{'HTTP_HOST'}.$disurl);
  284:       return REDIRECT;
  285:    } else {
  286:        &Apache::loncommon::content_type($r,'text/html');
  287:        $r->send_http_header;
  288:        if ($exitdisid eq '' && $arrow_dir ne '') {
  289:            my %lt =&Apache::lonlocal::texthash(
  290:                    'back' => 'beginning',
  291:                    'forward' => 'end',
  292:                    'nere' => 'Next resource could not be displayed',
  293:                    'goba' => 'Go Back',
  294:                    'nacc' => 'Navigate Course Content',
  295:                           );
  296:            my $warnmsg = &mt('As all folders and sequences ');
  297:            if ($arrow_dir eq 'forward') {
  298:                $warnmsg .= &mt('following the current resource were empty').',';
  299:            } elsif ($arrow_dir eq 'back') {
  300:                $warnmsg .= &mt('preceding the current resource were empty').',';
  301:            }
  302:            $warnmsg .= &mt('you have now reached the').' '.$lt{$arrow_dir}.' '.&mt('of the course.');
  303:            my $start_page=
  304: 	       &Apache::loncommon::start_page('Empty Folder/Sequence');
  305:            my $end_page=
  306: 	       &Apache::loncommon::end_page();
  307:            $r->print(<<ENDNONE);
  308: $start_page
  309: <h3>$lt{'nere'}</h3>
  310: <p>$warnmsg</p>
  311: <ul>
  312:   <li><a href="javascript:history.go(-1)">$lt{'goba'}</a></li>
  313:   <li><a href="/adm/navmaps">$lt{'nacc'}</a></li>
  314: </ul>
  315: $end_page
  316: ENDNONE
  317:        } else {
  318:            &viewmap($r,$requrl);
  319:        }
  320:        return OK;
  321:    }
  322: }
  323: 
  324: 1;
  325: __END__
  326: 
  327: =head1 NAME
  328: 
  329: Apache::lonsequence
  330: 
  331: =head1 SYNOPSIS
  332: 
  333: Handler for showing sequence objects of
  334: educational resources.
  335: 
  336: This is part of the LearningOnline Network with CAPA project
  337: described at http://www.lon-capa.org.
  338: 
  339: =head1 SUBROUTINES
  340: 
  341: =over
  342: 
  343: =item handler()
  344: 
  345: =item viewmap()
  346: 
  347: =item attemptread()
  348: 
  349: =item mapread()
  350: 
  351: =item start_fresh_session()
  352: 
  353: =back
  354: 
  355: =cut
  356: 
  357: 
  358: 
  359: 
  360: 

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