File:  [LON-CAPA] / rat / lonuserstate.pm
Revision 1.103: download - view: text, annotated - select for diffs
Wed Feb 22 23:44:55 2006 UTC (18 years, 2 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- reverting expirement for now

    1: # The LearningOnline Network with CAPA
    2: # Construct and maintain state and binary representation of course for user
    3: #
    4: # $Id: lonuserstate.pm,v 1.103 2006/02/22 23:44:55 albertel Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: ###
   29: 
   30: package Apache::lonuserstate;
   31: 
   32: # ------------------------------------------------- modules used by this module
   33: use strict;
   34: use HTML::TokeParser;
   35: use Apache::lonnet;
   36: use Apache::loncommon();
   37: use GDBM_File;
   38: use Apache::lonmsg;
   39: use Safe;
   40: use Safe::Hole;
   41: use Opcode;
   42: use Apache::lonenc;
   43: use Fcntl qw(:flock);
   44: 
   45: # ---------------------------------------------------- Globals for this package
   46: 
   47: my $pc;      # Package counter
   48: my %hash;    # The big tied hash
   49: my %parmhash;# The hash with the parameters
   50: my @cond;    # Array with all of the conditions
   51: my $errtext; # variable with all errors
   52: my $retfurl; # variable with the very first URL in the course
   53: my %randompick; # randomly picked resources
   54: my %randompickseed; # optional seed for randomly picking resources
   55: my %encurl; # URLs in this folder are supposed to be encrypted
   56: my %hiddenurl; # this URL (or complete folder) is supposed to be hidden
   57: 
   58: # ----------------------------------- Remove version from URL and store in hash
   59: 
   60: sub versiontrack {
   61:     my $uri=shift;
   62:     if ($uri=~/\.(\d+)\.\w+$/) {
   63: 	my $version=$1;
   64: 	$uri=~s/\.\d+\.(\w+)$/\.$1/;
   65:         unless ($hash{'version_'.$uri}) {
   66: 	    $hash{'version_'.$uri}=$version;
   67: 	}
   68:     }
   69:     return $uri;
   70: }
   71: 
   72: # -------------------------------------------------------------- Put in version
   73: 
   74: sub putinversion {
   75:     my $uri=shift;
   76:     my $key=$env{'request.course.id'}.'_'.&Apache::lonnet::clutter($uri);
   77:     if ($hash{'version_'.$uri}) {
   78: 	my $version=$hash{'version_'.$uri};
   79: 	if ($version eq 'mostrecent') { return $uri; }
   80: 	if ($version eq &Apache::lonnet::getversion(
   81: 			&Apache::lonnet::filelocation('',$uri))) 
   82: 	             { return $uri; }
   83: 	$uri=~s/\.(\w+)$/\.$version\.$1/;
   84:     }
   85:     &Apache::lonnet::do_cache_new('courseresversion',$key,&Apache::lonnet::declutter($uri),600);
   86:     return $uri;
   87: }
   88: 
   89: # ----------------------------------------- Processing versions file for course
   90: 
   91: sub processversionfile {
   92:     my %cenv=@_;
   93:     my %versions=&Apache::lonnet::dump('resourceversions',
   94: 				       $cenv{'domain'},
   95: 				       $cenv{'num'});
   96:     foreach (keys %versions) {
   97: 	if ($_=~/^error\:/) { return; }
   98: 	$hash{'version_'.$_}=$versions{$_};
   99:     }
  100: }
  101: 
  102: # --------------------------------------------------------- Loads map from disk
  103: 
  104: sub loadmap { 
  105:     my $uri=shift;
  106:     if ($hash{'map_pc_'.$uri}) { return; }
  107: 
  108:     $pc++;
  109:     my $lpc=$pc;
  110:     $hash{'map_pc_'.$uri}=$lpc;
  111:     $hash{'map_id_'.$lpc}=$uri;
  112: 
  113: # Determine and check filename
  114:     my $fn=&Apache::lonnet::filelocation('',&putinversion($uri));
  115: 
  116:     my $ispage=($fn=~/\.page$/);
  117: 
  118:     unless (($fn=~/\.sequence$/) ||
  119:             ($fn=~/\.page$/)) { 
  120: 	$errtext.="Invalid map: $fn\n";
  121: 	return; 
  122:     }
  123: 
  124:     my $instr=&Apache::lonnet::getfile($fn);
  125: 
  126:     unless ($instr eq -1) {
  127: 
  128: # Successfully got file, parse it
  129: 
  130:         my $parser = HTML::TokeParser->new(\$instr);
  131: 	$parser->attr_encoded(1);
  132:         my $token;
  133: 
  134:         my $linkpc=0;
  135: 
  136:         $fn=~/\.(\w+)$/;
  137: 
  138:         $hash{'map_type_'.$lpc}=$1;
  139: 
  140:         while ($token = $parser->get_token) {
  141: 	    if ($token->[0] eq 'S') {
  142:                 if ($token->[1] eq 'resource') {
  143: # -------------------------------------------------------------------- Resource
  144:                     if ($token->[2]->{'type'} eq 'zombie') { next; }
  145:                     my $rid=$lpc.'.'.$token->[2]->{'id'};
  146: 
  147:                     $hash{'kind_'.$rid}='res';
  148:                     $hash{'title_'.$rid}=$token->[2]->{'title'};
  149:                     my $turi=&versiontrack($token->[2]->{'src'});
  150:                     if ($token->[2]->{'version'}) {
  151: 			unless ($hash{'version_'.$turi}) {
  152: 			    $hash{'version_'.$turi}=$1;
  153: 			}
  154: 		    }
  155: 		    my $title=$token->[2]->{'title'};
  156: 		    $title=~s/\&colon\;/\:/gs;
  157: #		    my $symb=&Apache::lonnet::encode_symb($uri,
  158: #							  $token->[2]->{'id'},
  159: #							  $turi);
  160: #		    &Apache::lonnet::do_cache_new('title',$symb,$title);
  161:                     unless ($ispage) {
  162:                         $turi=~/\.(\w+)$/;
  163:                         my $embstyle=&Apache::loncommon::fileembstyle($1);
  164:                         if ($token->[2]->{'external'} eq 'true') { # external
  165:                             $turi=~s/^http\:\/\//\/adm\/wrapper\/ext\//;
  166:                         } elsif ($turi=~/^\/*uploaded\//) { # uploaded
  167: 			    if (($embstyle eq 'img') 
  168: 				|| ($embstyle eq 'emb')
  169: 				|| ($embstyle eq 'wrp')) {
  170:                                 $turi='/adm/wrapper'.$turi;
  171: 			    } elsif ($embstyle eq 'ssi') {
  172: 				#do nothing with these
  173: 			    } elsif ($turi!~/\.(sequence|page)$/) {
  174: 				$turi='/adm/coursedocs/showdoc'.$turi;
  175:                             }
  176:                         } elsif ($turi=~/\S/) { # normal non-empty internal resource
  177: 			    my $mapdir=$uri;
  178: 			    $mapdir=~s/[^\/]+$//;
  179: 			    $turi=&Apache::lonnet::hreflocation($mapdir,$turi);
  180: 			    if (($embstyle eq 'img') 
  181: 				|| ($embstyle eq 'emb')
  182: 				|| ($embstyle eq 'wrp')) {
  183: 				$turi='/adm/wrapper'.$turi;
  184: 			    }
  185:                         }
  186: 		    }
  187: # Store reverse lookup, remove query string
  188: 		    my $idsuri=$turi;
  189: 		    $idsuri=~s/\?.+$//;
  190:                     if (defined($hash{'ids_'.$idsuri})) {
  191:                         $hash{'ids_'.$idsuri}.=','.$rid;
  192:                     } else {
  193:                         $hash{'ids_'.$idsuri}=''.$rid;
  194:                     }
  195:                
  196:                     if ($turi=~/\/(syllabus|aboutme|navmaps|smppg|bulletinboard)$/) {
  197: 			$turi.='?register=1';
  198: 		    }
  199: 
  200:                     $hash{'src_'.$rid}=$turi;
  201: 
  202:                     if ($token->[2]->{'external'} eq 'true') {
  203:                         $hash{'ext_'.$rid}='true:';
  204:                     } else {
  205:                         $hash{'ext_'.$rid}='false:';
  206:                     }
  207:                     if ($token->[2]->{'type'}) {
  208: 			$hash{'type_'.$rid}=$token->[2]->{'type'};
  209:                         if ($token->[2]->{'type'} eq 'start') {
  210: 			    $hash{'map_start_'.$uri}="$rid";
  211:                         }
  212:                         if ($token->[2]->{'type'} eq 'finish') {
  213: 			    $hash{'map_finish_'.$uri}="$rid";
  214:                         }
  215:                     }  else {
  216:                         $hash{'type_'.$rid}='normal';
  217:                     }
  218: 
  219:                     if (($turi=~/\.sequence$/) ||
  220:                         ($turi=~/\.page$/)) {
  221:                         $hash{'is_map_'.$rid}=1;
  222:                         &loadmap($turi);
  223:                     } 
  224:                     
  225:                 } elsif ($token->[1] eq 'condition') {
  226: # ------------------------------------------------------------------- Condition
  227: 
  228:                     my $rid=$lpc.'.'.$token->[2]->{'id'};
  229: 
  230:                     $hash{'kind_'.$rid}='cond';
  231:                     $cond[$#cond+1]=$token->[2]->{'value'};
  232:                     $hash{'condid_'.$rid}=$#cond;
  233:                     if ($token->[2]->{'type'}) {
  234:                         $cond[$#cond].=':'.$token->[2]->{'type'};
  235:                     }  else {
  236:                         $cond[$#cond].=':normal';
  237:                     }
  238: 
  239:                 } elsif ($token->[1] eq 'link') {
  240: # ----------------------------------------------------------------------- Links
  241: 
  242:                     $linkpc++;
  243:                     my $linkid=$lpc.'.'.$linkpc;
  244: 
  245:                     my $goesto=$lpc.'.'.$token->[2]->{'to'};
  246:                     my $comesfrom=$lpc.'.'.$token->[2]->{'from'};
  247:                     my $undercond=0;
  248: 
  249:                     if ($token->[2]->{'condition'}) {
  250: 			$undercond=$lpc.'.'.$token->[2]->{'condition'};
  251:                     }
  252: 
  253:                     $hash{'goesto_'.$linkid}=$goesto;
  254:                     $hash{'comesfrom_'.$linkid}=$comesfrom;
  255:                     $hash{'undercond_'.$linkid}=$undercond;
  256: 
  257:                     if (defined($hash{'to_'.$comesfrom})) {
  258:                         $hash{'to_'.$comesfrom}.=','.$linkid;
  259:                     } else {
  260:                         $hash{'to_'.$comesfrom}=''.$linkid;
  261:                     }
  262:                     if (defined($hash{'from_'.$goesto})) {
  263:                         $hash{'from_'.$goesto}.=','.$linkid;
  264:                     } else {
  265:                         $hash{'from_'.$goesto}=''.$linkid;
  266:                     }
  267:                 } elsif ($token->[1] eq 'param') {
  268: # ------------------------------------------------------------------- Parameter
  269: 
  270:                     my $referid=$lpc.'.'.$token->[2]->{'to'};
  271: 		    my $name=$token->[2]->{'name'};
  272: 		    my $part;
  273: 		    if ($name=~/^parameter_(.*)_/) {
  274: 			$part=$1;
  275: 		    } else {
  276: 			$part=0;
  277: 		    }
  278: 		    $name=~s/^.*_([^_]*)$/$1/;
  279:                     my $newparam=
  280: 			&Apache::lonnet::escape($token->[2]->{'type'}).':'.
  281: 			&Apache::lonnet::escape($part.'.'.$name).'='.
  282: 			&Apache::lonnet::escape($token->[2]->{'value'});
  283:                     if (defined($hash{'param_'.$referid})) {
  284:                         $hash{'param_'.$referid}.='&'.$newparam;
  285:                     } else {
  286:                         $hash{'param_'.$referid}=''.$newparam;
  287:                     }
  288:                     if ($token->[2]->{'name'}=~/^parameter_(0_)*mapalias$/) {
  289: 			$hash{'mapalias_'.$token->[2]->{'value'}}=$referid;
  290:                     }
  291:                     if ($token->[2]->{'name'}=~/^parameter_(0_)*randompick$/) {
  292: 			$randompick{$referid}=$token->[2]->{'value'};
  293:                     }
  294:                     if ($token->[2]->{'name'}=~/^parameter_(0_)*randompickseed$/) {
  295: 			$randompick{$referid}=$token->[2]->{'value'};
  296:                     }
  297:                     if ($token->[2]->{'name'}=~/^parameter_(0_)*encrypturl$/) {
  298: 			if ($token->[2]->{'value'}=~/^yes$/i) {
  299: 			    $encurl{$referid}=1;
  300: 			}
  301:                     }
  302:                     if ($token->[2]->{'name'}=~/^parameter_(0_)*hiddenresource$/) {
  303: 			if ($token->[2]->{'value'}=~/^yes$/i) {
  304: 			    $hiddenurl{$referid}=1;
  305: 			}
  306:                     }
  307:                 } 
  308: 		
  309:             }
  310:         }
  311: 
  312:     } else {
  313:         $errtext.='Map not loaded: The file ('.$fn.') does not exist. ';
  314:     }
  315: }
  316: 
  317: # --------------------------------------------------------- Simplify expression
  318: 
  319: sub simplify {
  320:     my $expression=shift;
  321: # (0&1) = 1
  322:     $expression=~s/\(0\&(\d+)\)/$1/g;
  323: # (8)=8
  324:     $expression=~s/\((\d+)\)/$1/g;
  325: # 8&8=8
  326:     $expression=~s/(\D)(\d+)\&\2(\D)/$1$2$3/g;
  327: # 8|8=8
  328:     $expression=~s/(\D)(\d+)\|\2(\D)/$1$2$3/g;
  329: # (5&3)&4=5&3&4
  330:     $expression=~s/\((\d+)((?:\&\d+)+)\)\&(\d+\D)/$1$2\&$3/g;
  331: # (((5&3)|(4&6)))=((5&3)|(4&6))
  332: #    $expression=~
  333: #	s/\((\(\(\d+(?:\&\d+)*\)(?:\|\(\d+(?:\&\d+)*\))+\))\)/$1/g;
  334: # ((5&3)|(4&6))|(1&2)=(5&3)|(4&6)|(1&2)
  335:     $expression=~
  336: 	s/\((\(\d+(?:\&\d+)*\))((?:\|\(\d+(?:\&\d+)*\))+)\)\|(\(\d+(?:\&\d+)*\))/\($1$2\|$3\)/g;
  337:     return $expression;
  338: }
  339: 
  340: # -------------------------------------------------------- Build condition hash
  341: 
  342: sub traceroute {
  343:     my ($sofar,$rid,$beenhere,$encflag,$hdnflag)=@_;
  344:     my $newsofar=$sofar=simplify($sofar);
  345:     unless ($beenhere=~/\&$rid\&/) {
  346: 	$beenhere.=$rid.'&';  
  347: 	my ($mapid,$resid)=split(/\./,$rid);
  348: 	my $symb=&Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},$resid,$hash{'src_'.$rid});
  349: 	my $hidden=&Apache::lonnet::EXT('resource.0.hiddenresource',$symb);
  350: 
  351: 	if ($hdnflag || lc($hidden) eq 'yes') {
  352: 	    $hiddenurl{$rid}=1;
  353: 	}
  354: 	if (!$hdnflag && lc($hidden) eq 'no') {
  355: 	    delete($hiddenurl{$rid});
  356: 	}
  357: 
  358: 	my $encrypt=&Apache::lonnet::EXT('resource.0.encrypturl',$symb);
  359: 	if ($encflag || lc($encrypt) eq 'yes') { $encurl{$rid}=1; }
  360: 	if (($retfurl eq '') && ($hash{'src_'.$rid})
  361: 	    && ($hash{'src_'.$rid}!~/\.sequence$/)) {
  362: 	    $retfurl=$hash{'src_'.$rid}.(($hash{'src_'.$rid}=~/\?/)?'&':'?').
  363: 		'symb='.$symb;
  364: 	}
  365: 	if (defined($hash{'conditions_'.$rid})) {
  366: 	    $hash{'conditions_'.$rid}=simplify(
  367:            '('.$hash{'conditions_'.$rid}.')|('.$sofar.')');
  368: 	} else {
  369: 	    $hash{'conditions_'.$rid}=$sofar;
  370: 	}
  371: 	$newsofar=$hash{'conditions_'.$rid};
  372: 	if (defined($hash{'is_map_'.$rid})) {
  373: 	    if (defined($hash{'map_start_'.$hash{'src_'.$rid}})) {
  374: 		$sofar=$newsofar=
  375: 		    &traceroute($sofar,
  376: 				$hash{'map_start_'.$hash{'src_'.$rid}},'&',
  377: 				$encflag || $encurl{$rid},
  378: 				$hdnflag || $hiddenurl{$rid});
  379: 	    }
  380: 	}
  381: 	if (defined($hash{'to_'.$rid})) {
  382: 	    foreach (split(/\,/,$hash{'to_'.$rid})) {
  383: 		my $further=$sofar;
  384:                 if ($hash{'undercond_'.$_}) {
  385: 		    if (defined($hash{'condid_'.$hash{'undercond_'.$_}})) {
  386: 			$further=simplify('('.$further.')&('.
  387: 					  $hash{'condid_'.$hash{'undercond_'.$_}}.')');
  388: 		    } else {
  389: 			$errtext.='Undefined condition ID: '
  390: 			    .$hash{'undercond_'.$_}.'. ';
  391: 		    }
  392:                 }
  393:                 $newsofar=&traceroute($further,$hash{'goesto_'.$_},$beenhere,
  394: 				      $encflag,$hdnflag);
  395: 	    }
  396: 	}
  397:     }
  398:     return $newsofar;
  399: }
  400: 
  401: # ------------------------------ Cascading conditions, quick access, parameters
  402: 
  403: sub accinit {
  404:     my ($uri,$short,$fn)=@_;
  405:     my %acchash=();
  406:     my %captured=();
  407:     my $condcounter=0;
  408:     $acchash{'acc.cond.'.$short.'.0'}=0;
  409:     foreach (keys %hash) {
  410: 	if ($_=~/^conditions/) {
  411: 	    my $expr=$hash{$_};
  412: 	    foreach ($expr=~m/(\(\(\d+(?:\&\d+)+\)(?:\|\(\d+(?:\&\d+)+\))+\))/g) {
  413: 		my $sub=$_;
  414: 		my $orig=$_;
  415: 		$sub=~/\(\((\d+\&(:?\d+\&)*)(?:\d+\&*)+\)(?:\|\(\1(?:\d+\&*)+\))+\)/;
  416: 		my $factor=$1;
  417: 		$sub=~s/$factor//g;
  418: 		$sub=~s/^\(/\($factor\(/;
  419: 		$sub.=')';
  420: 		$sub=simplify($sub);
  421: 		$orig=~s/(\W)/\\$1/g;
  422: 		$expr=~s/$orig/$sub/;
  423: 	    }
  424: 	    $hash{$_}=$expr;
  425: 	    unless (defined($captured{$expr})) {
  426: 		$condcounter++;
  427: 		$captured{$expr}=$condcounter;
  428: 		$acchash{'acc.cond.'.$short.'.'.$condcounter}=$expr;
  429: 	    } 
  430: 	} elsif ($_=~/^param_(\d+)\.(\d+)/) {
  431: 	    my $prefix=&Apache::lonnet::encode_symb($hash{'map_id_'.$1},$2,
  432: 						    $hash{'src_'.$1.'.'.$2});
  433: 	    foreach (split(/\&/,$hash{$_})) {
  434: 		my ($typename,$value)=split(/\=/,$_);
  435: 		my ($type,$name)=split(/\:/,$typename);
  436: 		$parmhash{$prefix.'.'.&Apache::lonnet::unescape($name)}=
  437: 		    &Apache::lonnet::unescape($value);
  438: 		$parmhash{$prefix.'.'.&Apache::lonnet::unescape($name).'.type'}=
  439: 		    &Apache::lonnet::unescape($type);
  440: 	    }
  441: 	}
  442:     }
  443:     foreach (keys %hash) {
  444: 	if ($_=~/^ids/) {
  445: 	    foreach (split(/\,/,$hash{$_})) {
  446: 		my $resid=$_;
  447: 		my $uri=$hash{'src_'.$resid};
  448: 		my ($uripath,$urifile) =
  449: 		    &Apache::lonnet::split_uri_for_cond($uri);
  450: 		if ($uripath) {
  451: 		    my $uricond='0';
  452: 		    if (defined($hash{'conditions_'.$resid})) {
  453: 			$uricond=$captured{$hash{'conditions_'.$resid}};
  454: 		    }
  455: 		    if (defined($acchash{'acc.res.'.$short.'.'.$uripath})) {
  456: 			if ($acchash{'acc.res.'.$short.'.'.$uripath}=~
  457: 			    /(\&\Q$urifile\E\:[^\&]*)/) {
  458: 			    my $replace=$1;
  459: 			    my $regexp=$replace;
  460: 			    #$regexp=~s/\|/\\\|/g;
  461: 			    $acchash{'acc.res.'.$short.'.'.$uripath}
  462: 			    =~s/\Q$regexp\E/$replace\|$uricond/;
  463: 			} else {
  464: 			    $acchash{'acc.res.'.$short.'.'.$uripath}.=
  465: 				$urifile.':'.$uricond.'&';
  466: 			}
  467: 		    } else {
  468: 			$acchash{'acc.res.'.$short.'.'.$uripath}=
  469: 			    '&'.$urifile.':'.$uricond.'&';
  470: 		    }
  471: 		} 
  472: 	    }
  473: 	}
  474:     }
  475:     $acchash{'acc.res.'.$short.'.'}='&:0&';
  476:     my $courseuri=$uri;
  477:     $courseuri=~s/^\/res\///;
  478:     &Apache::lonnet::delenv('(acc\.|httpref\.)');
  479:     &Apache::lonnet::appenv(%acchash);
  480: }
  481: 
  482: # ---------------- Selectively delete from randompick maps and hidden url parms
  483: 
  484: sub hiddenurls {
  485:     my $randomoutentry='';
  486:     foreach my $rid (keys %randompick) {
  487:         my $rndpick=$randompick{$rid};
  488:         my $mpc=$hash{'map_pc_'.$hash{'src_'.$rid}};
  489: # ------------------------------------------- put existing resources into array
  490:         my @currentrids=();
  491:         foreach (sort(keys(%hash))) {
  492: 	    if ($_=~/^src_($mpc\.\d+)/) {
  493: 		if ($hash{'src_'.$1}) { push @currentrids, $1; }
  494:             }
  495:         }
  496: 	# rids are number.number and we want to numercially sort on 
  497:         # the second number
  498: 	@currentrids=sort {
  499: 	    my (undef,$aid)=split(/\./,$a);
  500: 	    my (undef,$bid)=split(/\./,$b);
  501: 	    $aid <=> $bid;
  502: 	} @currentrids;
  503:         next if ($#currentrids<$rndpick);
  504: # -------------------------------- randomly eliminate the ones that should stay
  505: 	my (undef,$id)=split(/\./,$rid);
  506:         if ($randompickseed{$rid}) { $id=$randompickseed{$rid}; }
  507: 	my $rndseed=&Apache::lonnet::rndseed($id); # use id instead of symb
  508: 	&Apache::lonnet::setup_random_from_rndseed($rndseed);
  509: 	my @whichids=&Math::Random::random_permuted_index($#currentrids+1);
  510:         for (my $i=1;$i<=$rndpick;$i++) { $currentrids[$whichids[$i]]=''; }
  511: 	#&Apache::lonnet::logthis("$id,$rndseed,".join(':',@whichids));
  512: # -------------------------------------------------------- delete the leftovers
  513:         for (my $k=0; $k<=$#currentrids; $k++) {
  514:             if ($currentrids[$k]) {
  515: 		$hash{'randomout_'.$currentrids[$k]}=1;
  516:                 my ($mapid,$resid)=split(/\./,$currentrids[$k]);
  517:                 $randomoutentry.='&'.
  518: 		    &Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},
  519: 						 $resid,
  520: 						 $hash{'src_'.$currentrids[$k]}
  521: 						 ).'&';
  522:             }
  523:         }
  524:     }
  525: # ------------------------------ take care of explicitly hidden urls or folders
  526:     foreach my $rid (keys %hiddenurl) {
  527: 	$hash{'randomout_'.$rid}=1;
  528: 	my ($mapid,$resid)=split(/\./,$rid);
  529: 	$randomoutentry.='&'.
  530: 	    &Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},$resid,
  531: 					 $hash{'src_'.$rid}).'&';
  532:     }
  533: # --------------------------------------- append randomout entry to environment
  534:     if ($randomoutentry) {
  535: 	&Apache::lonnet::appenv('acc.randomout' => $randomoutentry);
  536:     }
  537: }
  538: 
  539: # ---------------------------------------------------- Read map and all submaps
  540: 
  541: sub readmap {
  542:     my $short=shift;
  543:     $short=~s/^\///;
  544:     my %cenv=&Apache::lonnet::coursedescription($short);
  545:     my $fn=$cenv{'fn'};
  546:     my $uri;
  547:     $short=~s/\//\_/g;
  548:     unless ($uri=$cenv{'url'}) { 
  549: 	&Apache::lonnet::logthis("<font color=blue>WARNING: ".
  550: 				 "Could not load course $short.</font>"); 
  551: 	return 'No course data available.';
  552:     }
  553:     @cond=('true:normal');
  554: 
  555:     open(LOCKFILE,">$fn.db.lock");
  556:     my $lock=0;
  557:     if (flock(LOCKFILE,LOCK_EX|LOCK_NB)) {
  558: 	$lock=1;
  559: 	unlink($fn.'.db');
  560: 	unlink($fn.'_symb.db');
  561: 	unlink($fn.'.state');
  562: 	unlink($fn.'parms.db');
  563:     }
  564:     undef %randompick;
  565:     undef %hiddenurl;
  566:     undef %encurl;
  567:     $retfurl='';
  568:     if ($lock && (tie(%hash,'GDBM_File',"$fn.db",&GDBM_WRCREAT(),0640)) &&
  569: 	(tie(%parmhash,'GDBM_File',$fn.'_parms.db',&GDBM_WRCREAT(),0640))) {
  570: 	%hash=();
  571: 	%parmhash=();
  572: 	$errtext='';
  573: 	$pc=0;
  574: 	&processversionfile(%cenv);
  575: 	my $furi=&Apache::lonnet::clutter($uri);
  576: 	$hash{'src_0.0'}=&versiontrack($furi);
  577: 	$hash{'title_0.0'}=&Apache::lonnet::metadata($uri,'title');
  578: 	$hash{'ids_'.$furi}='0.0';
  579: 	$hash{'is_map_0.0'}=1;
  580: 	loadmap($uri);
  581: 	if (defined($hash{'map_start_'.$uri})) {
  582: 	    &Apache::lonnet::appenv("request.course.id"  => $short,
  583: 				    "request.course.fn"  => $fn,
  584: 				    "request.course.uri" => $uri);
  585: 	    &traceroute('0',$hash{'map_start_'.$uri},'&');
  586: 	    &accinit($uri,$short,$fn);
  587: 	    &hiddenurls();
  588: 	}
  589: # ------------------------------------------------------- Put versions into src
  590: 	foreach (keys %hash) {
  591: 	    if ($_=~/^src\_/) {
  592: 		$hash{$_}=&putinversion($hash{$_});
  593: 	    }
  594: 	}
  595: # ---------------------------------------------------------------- Encrypt URLs
  596: 	foreach (keys %encurl) {
  597: #	    $hash{'src_'.$_}=&Apache::lonenc::encrypted($hash{'src_'.$_});
  598: 	    $hash{'encrypted_'.$_}=1;
  599: 	}
  600: # ----------------------------------------------- Close hashes to finally store
  601: # --------------------------------- Routine must pass this point, no early outs
  602: 	$hash{'first_url'}=$retfurl;
  603: 	unless ((untie(%hash)) && (untie(%parmhash))) {
  604: 	    &Apache::lonnet::logthis("<font color=blue>WARNING: ".
  605: 				     "Could not untie coursemap $fn for $uri.</font>"); 
  606: 	}
  607: # ---------------------------------------------------- Store away initial state
  608: 	{
  609: 	    my $cfh;
  610: 	    if (open($cfh,">$fn.state")) {
  611: 		print $cfh join("\n",@cond);
  612: 	    } else {
  613: 		&Apache::lonnet::logthis("<font color=blue>WARNING: ".
  614: 					 "Could not write statemap $fn for $uri.</font>"); 
  615: 	    }
  616: 	}
  617: 	flock(LOCKFILE,LOCK_UN);
  618: 	close(LOCKFILE);
  619:     } else {
  620: 	# if we are here it is likely because we are already trying to 
  621: 	# initialize the course in another child, busy wait trying to 
  622: 	# tie the hashes for the next 90 seconds, if we succeed forward 
  623: 	# them on to navmaps, if we fail, throw up the Could not init 
  624: 	# course screen
  625: 	if ($lock) {
  626: 	    # Got the lock but not the DB files
  627: 	    flock(LOCKFILE,LOCK_UN);
  628: 	}
  629: 	untie(%hash);
  630: 	untie(%parmhash);
  631: 	&Apache::lonnet::logthis("<font color=blue>WARNING: ".
  632: 				 "Could not tie coursemap $fn for $uri.</font>"); 
  633: 	my $i=0;
  634: 	while($i<90) {
  635: 	    $i++;
  636: 	    sleep(1);
  637: 	    if (flock(LOCKFILE,LOCK_EX|LOCK_NB) &&
  638: 		(tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640))) {
  639: 		if (tie(%parmhash,'GDBM_File',$fn.'_parms.db',&GDBM_READER(),0640)) {
  640: 		    $retfurl='/adm/navmaps';
  641: 		    &Apache::lonnet::appenv("request.course.id"  => $short,
  642: 					    "request.course.fn"  => $fn,
  643: 					    "request.course.uri" => $uri);
  644: 		    untie(%hash);
  645: 		    untie(%parmhash);
  646: 		    last;
  647: 		}
  648: 	    }
  649: 	    untie(%hash);
  650: 	    untie(%parmhash);
  651: 	}
  652: 	flock(LOCKFILE,LOCK_UN);
  653: 	close(LOCKFILE);
  654:     }
  655:     &Apache::lonmsg::author_res_msg($env{'request.course.uri'},$errtext);
  656: # ------------------------------------------------- Check for critical messages
  657: 
  658:     my @what=&Apache::lonnet::dump('critical',$env{'user.domain'},
  659: 				   $env{'user.name'});
  660:     if ($what[0]) {
  661: 	if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
  662: 	    $retfurl='/adm/email?critical=display';
  663:         }
  664:     }
  665:     return ($retfurl,$errtext);
  666: }
  667: 
  668: # ------------------------------------------------------- Evaluate state string
  669: 
  670: sub evalstate {
  671:     my $fn=$env{'request.course.fn'}.'.state';
  672:     my $state='';
  673:     if (-e $fn) {
  674: 	my @conditions=();
  675: 	{
  676: 	    my $fh=Apache::File->new($fn);
  677: 	    @conditions=<$fh>;
  678: 	}  
  679: 	my $safeeval = new Safe;
  680: 	my $safehole = new Safe::Hole;
  681: 	$safeeval->permit("entereval");
  682: 	$safeeval->permit(":base_math");
  683: 	$safeeval->deny(":base_io");
  684: 	$safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
  685: 	foreach my $line (@conditions) {
  686: 	    chomp($line);
  687: 	    my ($condition,$weight)=split(/\:/,$line);
  688: 	    if ($safeeval->reval($condition)) {
  689: 		if ($weight eq 'force') {
  690: 		    $state.='3';
  691: 		} else {
  692: 		    $state.='2';
  693: 		}
  694: 	    } else {
  695: 		if ($weight eq 'stop') {
  696: 		    $state.='0';
  697: 		} else {
  698: 		    $state.='1';
  699: 		}
  700: 	    }
  701: 	}
  702:     }
  703:     &Apache::lonnet::appenv('user.state.'.$env{'request.course.id'} => $state);
  704:     return $state;
  705: }
  706: 
  707: 1;
  708: __END__
  709: 
  710: =head1 NAME
  711: 
  712: Apache::lonuserstate - Construct and maintain state and binary representation
  713: of course for user
  714: 
  715: =head1 SYNOPSIS
  716: 
  717: Invoked by lonroles.pm.
  718: 
  719: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
  720: 
  721: =head1 INTRODUCTION
  722: 
  723: This module constructs and maintains state and binary representation
  724: of course for user.
  725: 
  726: This is part of the LearningOnline Network with CAPA project
  727: described at http://www.lon-capa.org.
  728: 
  729: =head1 HANDLER SUBROUTINE
  730: 
  731: There is no handler subroutine.
  732: 
  733: =head1 OTHER SUBROUTINES
  734: 
  735: =over 4
  736: 
  737: =item *
  738: 
  739: loadmap() : Loads map from disk
  740: 
  741: =item *
  742: 
  743: simplify() : Simplify expression
  744: 
  745: =item *
  746: 
  747: traceroute() : Build condition hash
  748: 
  749: =item *
  750: 
  751: accinit() : Cascading conditions, quick access, parameters
  752: 
  753: =item *
  754: 
  755: readmap() : Read map and all submaps
  756: 
  757: =item *
  758: 
  759: evalstate() : Evaluate state string
  760: 
  761: =back
  762: 
  763: =cut

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