File:  [LON-CAPA] / rat / lonuserstate.pm
Revision 1.123: download - view: text, annotated - select for diffs
Tue Aug 28 16:45:20 2007 UTC (16 years, 8 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- conditions get stored intoa file delimited by newlines, thus need to ensure the conditions are newline free

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

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