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.47 2002/11/18 15:17:56 www 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: # (Server for RAT Maps
29: #
30: # (Edit Handler for RAT Maps
31: # (TeX Content Handler
32: #
33: # YEAR=2000
34: # 05/29/00,05/30 Gerd Kortemeyer)
35: # 7/1 Gerd Kortemeyer)
36: # 7/1,7/3,7/4,7/7,7/8,7/10 Gerd Kortemeyer)
37: #
38: # 7/15,7/17,7/18,8/1,8/2,8/4,8/5,8/21,8/22,8/23,8/30,
39: # 9/2,9/4,9/29,9/30,10/2,10/11,10/30,10/31,
40: # 11/1,11/2,11/14,11/16,11/22,12/28,
41: # YEAR=2001
42: # 07/05/01,08/30,08/31 Gerd Kortemeyer
43: # 12/16 Scott Harrison
44: #
45: ###
46:
47: package Apache::lonuserstate;
48:
49: # ------------------------------------------------- modules used by this module
50: use strict;
51: use Apache::Constants qw(:common :http);
52: use Apache::File;
53: use HTML::TokeParser;
54: use Apache::lonnet();
55: use Apache::loncommon();
56: use GDBM_File;
57: use Apache::lonmsg;
58: use Safe;
59: use Safe::Hole;
60: use Opcode;
61:
62: # ---------------------------------------------------- Globals for this package
63:
64: my $pc; # Package counter
65: my %hash; # The big tied hash
66: my %parmhash;# The hash with the parameters
67: my @cond; # Array with all of the conditions
68: my $errtext; # variable with all errors
69: my $retfurl; # variable with the very first URL in the course
70: my %randompick; # randomly picked resources
71: my %actualversion; # version of resource as loaded now
72: my %setversion; # forced version of resource
73: my %lastversion; # version when CC came in last
74: my $versionmode; # how versioning is handled in this course
75:
76: # --------------------------------------------------------- Loads map from disk
77:
78: sub loadmap {
79: my $uri=shift;
80: if ($hash{'map_pc_'.$uri}) { return OK; }
81:
82: $pc++;
83: my $lpc=$pc;
84: $hash{'map_pc_'.$uri}=$lpc;
85: $hash{'map_id_'.$lpc}=$uri;
86:
87: # Determine and check filename
88: my $fn=&Apache::lonnet::filelocation('',$uri);
89:
90: my $ispage=($fn=~/\.page$/);
91:
92: unless (($fn=~/\.sequence$/) ||
93: ($fn=~/\.page$/)) {
94: $errtext.="Invalid map: $fn\n";
95: return OK;
96: }
97:
98: my $instr=&Apache::lonnet::getfile($fn);
99:
100: unless ($instr == -1) {
101:
102: # Successfully got file, parse it
103:
104: my $parser = HTML::TokeParser->new(\$instr);
105: my $token;
106:
107: my $linkpc=0;
108:
109: $fn=~/\.(\w+)$/;
110:
111: $hash{'map_type_'.$lpc}=$1;
112:
113: while ($token = $parser->get_token) {
114: if ($token->[0] eq 'S') {
115: if ($token->[1] eq 'resource') {
116: # -------------------------------------------------------------------- Resource
117:
118: my $rid=$lpc.'.'.$token->[2]->{'id'};
119:
120: $hash{'kind_'.$rid}='res';
121: $hash{'title_'.$rid}=$token->[2]->{'title'};
122: my $turi=$token->[2]->{'src'};
123: $Apache::lonnet::titlecache{
124: &Apache::lonnet::symbclean(
125: &Apache::lonnet::declutter($uri).'___'.
126: $token->[2]->{'id'}.'___'.
127: &Apache::lonnet::declutter($turi))}=
128: $token->[2]->{'title'};
129: unless ($ispage) {
130: $turi=~/\.(\w+)$/;
131: my $embstyle=&Apache::loncommon::fileembstyle($1);
132: if ($token->[2]->{'external'} eq 'true') { # external
133: $turi=~s/^http\:\/\//\/adm\/wrapper\/ext\//;
134: } elsif ($turi=~/^\/*uploaded\//) { # uploaded
135: if (($embstyle eq 'img') || ($embstyle eq 'emb')
136: || ($embstyle eq 'ssi')) {
137: $turi='/adm/wrapper'.$turi;
138: } elsif ($turi!~/\.(sequence|page)$/) {
139: $turi='/adm/coursedocs/showdoc'.$turi;
140: }
141: } else { # normal internal resource
142: if (($embstyle eq 'img') || ($embstyle eq 'emb')
143: || ($turi=~/\/(syllabus|aboutme|navmaps|smppg|bulletinboard)$/)) {
144: $turi='/adm/wrapper'.$turi;
145: }
146: }
147: }
148: $hash{'src_'.$rid}=$turi;
149:
150: if (defined($hash{'ids_'.$turi})) {
151: $hash{'ids_'.$turi}.=','.$rid;
152: } else {
153: $hash{'ids_'.$turi}=''.$rid;
154: }
155:
156: if ($token->[2]->{'external'} eq 'true') {
157: $hash{'ext_'.$rid}='true:';
158: } else {
159: $hash{'ext_'.$rid}='false:';
160: }
161: if ($token->[2]->{'type'}) {
162: $hash{'type_'.$rid}=$token->[2]->{'type'};
163: if ($token->[2]->{'type'} eq 'start') {
164: $hash{'map_start_'.$uri}="$rid";
165: }
166: if ($token->[2]->{'type'} eq 'finish') {
167: $hash{'map_finish_'.$uri}="$rid";
168: }
169: } else {
170: $hash{'type_'.$rid}='normal';
171: }
172:
173: if (($turi=~/\.sequence$/) ||
174: ($turi=~/\.page$/)) {
175: $hash{'is_map_'.$rid}=1;
176: &loadmap($turi);
177: }
178:
179: } elsif ($token->[1] eq 'condition') {
180: # ------------------------------------------------------------------- Condition
181:
182: my $rid=$lpc.'.'.$token->[2]->{'id'};
183:
184: $hash{'kind_'.$rid}='cond';
185: $cond[$#cond+1]=$token->[2]->{'value'};
186: $hash{'condid_'.$rid}=$#cond;
187: if ($token->[2]->{'type'}) {
188: $cond[$#cond].=':'.$token->[2]->{'type'};
189: } else {
190: $cond[$#cond].=':normal';
191: }
192:
193: } elsif ($token->[1] eq 'link') {
194: # ----------------------------------------------------------------------- Links
195:
196: $linkpc++;
197: my $linkid=$lpc.'.'.$linkpc;
198:
199: my $goesto=$lpc.'.'.$token->[2]->{'to'};
200: my $comesfrom=$lpc.'.'.$token->[2]->{'from'};
201: my $undercond=0;
202:
203: if ($token->[2]->{'condition'}) {
204: $undercond=$lpc.'.'.$token->[2]->{'condition'};
205: }
206:
207: $hash{'goesto_'.$linkid}=$goesto;
208: $hash{'comesfrom_'.$linkid}=$comesfrom;
209: $hash{'undercond_'.$linkid}=$undercond;
210:
211: if (defined($hash{'to_'.$comesfrom})) {
212: $hash{'to_'.$comesfrom}.=','.$linkid;
213: } else {
214: $hash{'to_'.$comesfrom}=''.$linkid;
215: }
216: if (defined($hash{'from_'.$goesto})) {
217: $hash{'from_'.$goesto}.=','.$linkid;
218: } else {
219: $hash{'from_'.$goesto}=''.$linkid;
220: }
221: } elsif ($token->[1] eq 'param') {
222: # ------------------------------------------------------------------- Parameter
223:
224: my $referid=$lpc.'.'.$token->[2]->{'to'};
225: my $part=$token->[2]->{'part'};
226: unless ($part) { $part=0; }
227: my $newparam=
228: &Apache::lonnet::escape($token->[2]->{'type'}).':'.
229: &Apache::lonnet::escape($part.'.'.
230: $token->[2]->{'name'}).'='.
231: &Apache::lonnet::escape($token->[2]->{'value'});
232: if (defined($hash{'param_'.$referid})) {
233: $hash{'param_'.$referid}.='&'.$newparam;
234: } else {
235: $hash{'param_'.$referid}=''.$newparam;
236: }
237: if ($token->[2]->{'name'} eq 'parameter_mapalias') {
238: $hash{'mapalias_'.$token->[2]->{'value'}}=$referid;
239: }
240: if ($token->[2]->{'name'} eq 'parameter_randompick') {
241: $randompick{$referid}=$token->[2]->{'value'};
242: }
243: }
244:
245: }
246: }
247:
248: } else {
249: $errtext.='Map not loaded: The file does not exist. ';
250: }
251: }
252:
253: # --------------------------------------------------------- Simplify expression
254:
255: sub simplify {
256: my $expression=shift;
257: # (8)=8
258: $expression=~s/\((\d+)\)/$1/g;
259: # 8&8=8
260: $expression=~s/(\D)(\d+)\&\2(\D)/$1$2$3/g;
261: # 8|8=8
262: $expression=~s/(\D)(\d+)\|\2(\D)/$1$2$3/g;
263: # (5&3)&4=5&3&4
264: $expression=~s/\((\d+)((?:\&\d+)+)\)\&(\d+\D)/$1$2\&$3/g;
265: # (((5&3)|(4&6)))=((5&3)|(4&6))
266: $expression=~
267: s/\((\(\(\d+(?:\&\d+)*\)(?:\|\(\d+(?:\&\d+)*\))+\))\)/$1/g;
268: # ((5&3)|(4&6))|(1&2)=(5&3)|(4&6)|(1&2)
269: $expression=~
270: s/\((\(\d+(?:\&\d+)*\))((?:\|\(\d+(?:\&\d+)*\))+)\)\|(\(\d+(?:\&\d+)*\))/\($1$2\|$3\)/g;
271: return $expression;
272: }
273:
274: # -------------------------------------------------------- Build condition hash
275:
276: sub traceroute {
277: my ($sofar,$rid,$beenhere)=@_;
278: $sofar=simplify($sofar);
279: unless ($beenhere=~/\&$rid\&/) {
280: $beenhere.=$rid.'&';
281: if (($retfurl eq '') && ($hash{'src_'.$rid})) {
282: my ($mapid,$resid)=split(/\./,$rid);
283: $retfurl=$hash{'src_'.$rid}.
284: (($hash{'src_'.$rid}=~/\?/)?'&':'?').'symb='.
285: &Apache::lonnet::symbclean(
286: &Apache::lonnet::declutter($hash{'map_id_'.$mapid}).
287: '___'.$resid.'___'.
288: &Apache::lonnet::declutter($hash{'src_'.$rid}));
289: }
290: if (defined($hash{'conditions_'.$rid})) {
291: $hash{'conditions_'.$rid}=simplify(
292: '('.$hash{'conditions_'.$rid}.')|('.$sofar.')');
293: } else {
294: $hash{'conditions_'.$rid}=$sofar;
295: }
296: if (defined($hash{'is_map_'.$rid})) {
297: if (defined($hash{'map_start_'.$hash{'src_'.$rid}})) {
298: &traceroute($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},'&');
299: if (defined($hash{'map_finish_'.$hash{'src_'.$rid}})) {
300: $sofar=
301: $hash{'conditions_'.$hash{'map_finish_'.$hash{'src_'.$rid}}};
302: }
303: }
304: }
305: if (defined($hash{'to_'.$rid})) {
306: foreach (split(/\,/,$hash{'to_'.$rid})) {
307: my $further=$sofar;
308: if ($hash{'undercond_'.$_}) {
309: if (defined($hash{'condid_'.$hash{'undercond_'.$_}})) {
310: $further=simplify('('.$further.')&('.
311: $hash{'condid_'.$hash{'undercond_'.$_}}.')');
312: } else {
313: $errtext.='Undefined condition ID: '
314: .$hash{'undercond_'.$_}.'. ';
315: }
316: }
317: &traceroute($further,$hash{'goesto_'.$_},$beenhere);
318: }
319: }
320: }
321: }
322:
323: # ------------------------------ Cascading conditions, quick access, parameters
324:
325: sub accinit {
326: my ($uri,$short,$fn)=@_;
327: my %acchash=();
328: my %captured=();
329: my $condcounter=0;
330: $acchash{'acc.cond.'.$short.'.0'}=0;
331: foreach (keys %hash) {
332: if ($_=~/^conditions/) {
333: my $expr=$hash{$_};
334: foreach ($expr=~m/(\(\(\d+(?:\&\d+)+\)(?:\|\(\d+(?:\&\d+)+\))+\))/g) {
335: my $sub=$_;
336: my $orig=$_;
337: $sub=~/\(\((\d+\&(:?\d+\&)*)(?:\d+\&*)+\)(?:\|\(\1(?:\d+\&*)+\))+\)/;
338: my $factor=$1;
339: $sub=~s/$factor//g;
340: $sub=~s/^\(/\($factor\(/;
341: $sub.=')';
342: $sub=simplify($sub);
343: $orig=~s/(\W)/\\$1/g;
344: $expr=~s/$orig/$sub/;
345: }
346: $hash{$_}=$expr;
347: unless (defined($captured{$expr})) {
348: $condcounter++;
349: $captured{$expr}=$condcounter;
350: $acchash{'acc.cond.'.$short.'.'.$condcounter}=$expr;
351: }
352: } elsif ($_=~/^param_(\d+)\.(\d+)/) {
353: my $prefix=&Apache::lonnet::declutter($hash{'map_id_'.$1}).
354: '___'.$2.'___'.&Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
355: foreach (split(/\&/,$hash{$_})) {
356: my ($typename,$value)=split(/\=/,$_);
357: my ($type,$name)=split(/\:/,$typename);
358: $parmhash{$prefix.'.'.&Apache::lonnet::unescape($name)}=
359: &Apache::lonnet::unescape($value);
360: $parmhash{$prefix.'.'.&Apache::lonnet::unescape($name).'.type'}=
361: &Apache::lonnet::unescape($type);
362: }
363: }
364: }
365: foreach (keys %hash) {
366: if ($_=~/^ids/) {
367: foreach (split(/\,/,$hash{$_})) {
368: my $resid=$_;
369: my $uri=$hash{'src_'.$resid};
370: $uri=~s/^\/adm\/wrapper//;
371: my @uriparts=split(/\//,$uri);
372: my $urifile=$uriparts[$#uriparts];
373: $#uriparts--;
374: my $uripath=join('/',@uriparts);
375: $uripath=~s/^\/res\///;
376: if ($uripath) {
377: my $uricond='0';
378: if (defined($hash{'conditions_'.$resid})) {
379: $uricond=$captured{$hash{'conditions_'.$resid}};
380: }
381: if (defined($acchash{'acc.res.'.$short.'.'.$uripath})) {
382: if ($acchash{'acc.res.'.$short.'.'.$uripath}=~
383: /(\&$urifile\:[^\&]*)/) {
384: my $replace=$1;
385: my $regexp=$replace;
386: $regexp=~s/\|/\\\|/g;
387: $acchash{'acc.res.'.$short.'.'.$uripath}
388: =~s/$regexp/$replace\|$uricond/;
389: } else {
390: $acchash{'acc.res.'.$short.'.'.$uripath}.=
391: $urifile.':'.$uricond.'&';
392: }
393: } else {
394: $acchash{'acc.res.'.$short.'.'.$uripath}=
395: '&'.$urifile.':'.$uricond.'&';
396: }
397: }
398: }
399: }
400: }
401: $acchash{'acc.res.'.$short.'.'}='&:0&';
402: my $courseuri=$uri;
403: $courseuri=~s/^\/res\///;
404: &Apache::lonnet::delenv('(acc\.|httpref\.)');
405: &Apache::lonnet::appenv(%acchash,
406: "request.course.id" => $short,
407: "request.course.fn" => $fn,
408: "request.course.uri" => $courseuri);
409: }
410:
411: # ------------------------------------- Selectively delete from randompick maps
412:
413: sub pickrandom {
414: my $randomoutentry='';
415: foreach my $rid (keys %randompick) {
416: my $rndpick=$randompick{$rid};
417: my $mpc=$hash{'map_pc_'.$hash{'src_'.$rid}};
418: # ------------------------------------------- put existing resources into array
419: my @currentrids=();
420: foreach (keys %hash) {
421: if ($_=~/^src_($mpc\.\d+)/) {
422: if ($hash{'src_'.$1}) { push @currentrids, $1; }
423: }
424: }
425: next if ($#currentrids<$rndpick);
426: # -------------------------------- randomly eliminate the ones that should stay
427: srand(&Apache::lonnet::rndseed($rid)); # use rid instead of symb
428: for (my $i=1;$i<=$rndpick;$i++) {
429: while (1) {
430: my $randomidx=int(rand($#currentrids+1));
431: if ($currentrids[$randomidx]) {
432: $currentrids[$randomidx]='';
433: last;
434: }
435: }
436: }
437: # -------------------------------------------------------- delete the leftovers
438: for (my $k=0; $k<=$#currentrids; $k++) {
439: if ($currentrids[$k]) {
440: $hash{'randomout_'.$currentrids[$k]}=1;
441: my ($mapid,$resid)=split(/\./,$currentrids[$k]);
442: $randomoutentry.='&'.
443: &Apache::lonnet::symbclean(
444: &Apache::lonnet::declutter($hash{'map_id_'.$mapid}).
445: '___'.$resid.'___'.
446: &Apache::lonnet::declutter($hash{'src_'.$currentrids[$k]})
447: ).'&';
448: }
449: }
450: }
451: if ($randomoutentry) {
452: &Apache::lonnet::appenv('acc.randomout' => $randomoutentry);
453: }
454: }
455:
456: # ---------------------------------------------------- Read map and all submaps
457:
458: sub readmap {
459: my $short=shift;
460: $short=~s/^\///;
461: my %cenv=&Apache::lonnet::coursedescription($short);
462: my $fn=$cenv{'fn'};
463: my $uri;
464: $short=~s/\//\_/g;
465: unless ($uri=$cenv{'url'}) {
466: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
467: "Could not load course $short.</font>");
468: return 'No course data available.';
469: }
470: @cond=('true:normal');
471: unlink($fn.'.db');
472: unlink($fn.'_symb.db');
473: unlink($fn.'.state');
474: unlink($fn.'parms.db');
475: undef %randompick;
476: $retfurl='';
477: if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_WRCREAT(),0640)) &&
478: (tie(%parmhash,'GDBM_File',$fn.'_parms.db',&GDBM_WRCREAT(),0640))) {
479: %hash=();
480: %parmhash=();
481: $errtext='';
482: $pc=0;
483: my $furi=&Apache::lonnet::clutter($uri);
484: $hash{'src_0.0'}=$furi;
485: $hash{'title_0.0'}=&Apache::lonnet::metadata($uri,'title');
486: $hash{'ids_'.$furi}='0.0';
487: $hash{'is_map_0.0'}=1;
488: loadmap($uri);
489: if (defined($hash{'map_start_'.$uri})) {
490: &traceroute('0',$hash{'map_start_'.$uri},'&');
491: &accinit($uri,$short,$fn);
492: &pickrandom();
493: }
494: # ------------------------------------------------------------ Version tracking
495: if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
496: &Apache::lonnet::logthis('Will be version tracking');
497: }
498: unless ((untie(%hash)) && (untie(%parmhash))) {
499: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
500: "Could not untie coursemap $fn for $uri.</font>");
501: }
502: {
503: my $cfh;
504: if ($cfh=Apache::File->new(">$fn.state")) {
505: print $cfh join("\n",@cond);
506: } else {
507: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
508: "Could not write statemap $fn for $uri.</font>");
509: }
510: }
511: } else {
512: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
513: "Could not tie coursemap $fn for $uri.</font>");
514: }
515: &Apache::lonmsg::author_res_msg($ENV{'request.course.uri'},$errtext);
516: # ------------------------------------------------- Check for critical messages
517:
518: my @what=&Apache::lonnet::dump('critical',$ENV{'user.domain'},
519: $ENV{'user.name'});
520: if ($what[0]) {
521: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
522: $retfurl='/adm/email?critical=display';
523: }
524: }
525:
526:
527: return ($retfurl,$errtext);
528: }
529:
530: # ------------------------------------------------------- Evaluate state string
531:
532: sub evalstate {
533:
534: my $fn=$ENV{'request.course.fn'}.'.state';
535: my $state='2';
536: if (-e $fn) {
537: my @conditions=();
538: {
539: my $fh=Apache::File->new($fn);
540: @conditions=<$fh>;
541: }
542: my $safeeval = new Safe;
543: my $safehole = new Safe::Hole;
544: $safeeval->permit("entereval");
545: $safeeval->permit(":base_math");
546: $safeeval->deny(":base_io");
547: $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
548: foreach (@conditions) {
549: my $line=$_;
550: chomp($line);
551: my ($condition,$weight)=split(/\:/,$_);
552: if ($safeeval->reval($condition)) {
553: if ($weight eq 'force') {
554: $state.='3';
555: } else {
556: $state.='2';
557: }
558: } else {
559: if ($weight eq 'stop') {
560: $state.='0';
561: } else {
562: $state.='1';
563: }
564: }
565: }
566: }
567: &Apache::lonnet::appenv('user.state.'.$ENV{'request.course.id'} => $state);
568: return $state;
569: }
570:
571: 1;
572: __END__
573:
574: =head1 NAME
575:
576: Apache::lonuserstate - Construct and maintain state and binary representation
577: of course for user
578:
579: =head1 SYNOPSIS
580:
581: Invoked by lonroles.pm.
582:
583: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
584:
585: =head1 INTRODUCTION
586:
587: This module constructs and maintains state and binary representation
588: of course for user.
589:
590: This is part of the LearningOnline Network with CAPA project
591: described at http://www.lon-capa.org.
592:
593: =head1 HANDLER SUBROUTINE
594:
595: There is no handler subroutine.
596:
597: =head1 OTHER SUBROUTINES
598:
599: =over 4
600:
601: =item *
602:
603: loadmap() : Loads map from disk
604:
605: =item *
606:
607: simplify() : Simplify expression
608:
609: =item *
610:
611: traceroute() : Build condition hash
612:
613: =item *
614:
615: accinit() : Cascading conditions, quick access, parameters
616:
617: =item *
618:
619: readmap() : Read map and all submaps
620:
621: =item *
622:
623: evalstate() : Evaluate state string
624:
625: =back
626:
627: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonuserstate.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / rat