Annotation of rat/lonuserstate.pm, revision 1.122

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

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