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.45 2002/10/07 19:00:43 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: unless ($ispage) {
124: $turi=~/\.(\w+)$/;
125: my $embstyle=&Apache::loncommon::fileembstyle($1);
126: if ($token->[2]->{'external'} eq 'true') { # external
127: $turi=~s/^http\:\/\//\/adm\/wrapper\/ext\//;
128: } elsif ($turi=~/^\/*uploaded\//) { # uploaded
129: if (($embstyle eq 'img') || ($embstyle eq 'emb')
130: || ($embstyle eq 'ssi')) {
131: $turi='/adm/wrapper'.$turi;
132: } elsif ($turi!~/\.(sequence|page)$/) {
133: $turi='/adm/coursedocs/showdoc'.$turi;
134: }
135: } else { # normal internal resource
136: if (($embstyle eq 'img') || ($embstyle eq 'emb')
137: || ($turi=~/\/(syllabus|aboutme|navmaps|smppg|bulletinboard)$/)) {
138: $turi='/adm/wrapper'.$turi;
139: }
140: }
141: }
142: $hash{'src_'.$rid}=$turi;
143:
144: if (defined($hash{'ids_'.$turi})) {
145: $hash{'ids_'.$turi}.=','.$rid;
146: } else {
147: $hash{'ids_'.$turi}=''.$rid;
148: }
149:
150: if ($token->[2]->{'external'} eq 'true') {
151: $hash{'ext_'.$rid}='true:';
152: } else {
153: $hash{'ext_'.$rid}='false:';
154: }
155: if ($token->[2]->{'type'}) {
156: $hash{'type_'.$rid}=$token->[2]->{'type'};
157: if ($token->[2]->{'type'} eq 'start') {
158: $hash{'map_start_'.$uri}="$rid";
159: }
160: if ($token->[2]->{'type'} eq 'finish') {
161: $hash{'map_finish_'.$uri}="$rid";
162: }
163: } else {
164: $hash{'type_'.$rid}='normal';
165: }
166:
167: if (($turi=~/\.sequence$/) ||
168: ($turi=~/\.page$/)) {
169: $hash{'is_map_'.$rid}=1;
170: &loadmap($turi);
171: }
172:
173: } elsif ($token->[1] eq 'condition') {
174: # ------------------------------------------------------------------- Condition
175:
176: my $rid=$lpc.'.'.$token->[2]->{'id'};
177:
178: $hash{'kind_'.$rid}='cond';
179: $cond[$#cond+1]=$token->[2]->{'value'};
180: $hash{'condid_'.$rid}=$#cond;
181: if ($token->[2]->{'type'}) {
182: $cond[$#cond].=':'.$token->[2]->{'type'};
183: } else {
184: $cond[$#cond].=':normal';
185: }
186:
187: } elsif ($token->[1] eq 'link') {
188: # ----------------------------------------------------------------------- Links
189:
190: $linkpc++;
191: my $linkid=$lpc.'.'.$linkpc;
192:
193: my $goesto=$lpc.'.'.$token->[2]->{'to'};
194: my $comesfrom=$lpc.'.'.$token->[2]->{'from'};
195: my $undercond=0;
196:
197: if ($token->[2]->{'condition'}) {
198: $undercond=$lpc.'.'.$token->[2]->{'condition'};
199: }
200:
201: $hash{'goesto_'.$linkid}=$goesto;
202: $hash{'comesfrom_'.$linkid}=$comesfrom;
203: $hash{'undercond_'.$linkid}=$undercond;
204:
205: if (defined($hash{'to_'.$comesfrom})) {
206: $hash{'to_'.$comesfrom}.=','.$linkid;
207: } else {
208: $hash{'to_'.$comesfrom}=''.$linkid;
209: }
210: if (defined($hash{'from_'.$goesto})) {
211: $hash{'from_'.$goesto}.=','.$linkid;
212: } else {
213: $hash{'from_'.$goesto}=''.$linkid;
214: }
215: } elsif ($token->[1] eq 'param') {
216: # ------------------------------------------------------------------- Parameter
217:
218: my $referid=$lpc.'.'.$token->[2]->{'to'};
219: my $part=$token->[2]->{'part'};
220: unless ($part) { $part=0; }
221: my $newparam=
222: &Apache::lonnet::escape($token->[2]->{'type'}).':'.
223: &Apache::lonnet::escape($part.'.'.
224: $token->[2]->{'name'}).'='.
225: &Apache::lonnet::escape($token->[2]->{'value'});
226: if (defined($hash{'param_'.$referid})) {
227: $hash{'param_'.$referid}.='&'.$newparam;
228: } else {
229: $hash{'param_'.$referid}=''.$newparam;
230: }
231: if ($token->[2]->{'name'} eq 'parameter_mapalias') {
232: $hash{'mapalias_'.$token->[2]->{'value'}}=$referid;
233: }
234: if ($token->[2]->{'name'} eq 'parameter_randompick') {
235: $randompick{$referid}=$token->[2]->{'value'};
236: }
237: }
238:
239: }
240: }
241:
242: } else {
243: $errtext.='Map not loaded: The file does not exist. ';
244: }
245: }
246:
247: # --------------------------------------------------------- Simplify expression
248:
249: sub simplify {
250: my $expression=shift;
251: # (8)=8
252: $expression=~s/\((\d+)\)/$1/g;
253: # 8&8=8
254: $expression=~s/(\D)(\d+)\&\2(\D)/$1$2$3/g;
255: # 8|8=8
256: $expression=~s/(\D)(\d+)\|\2(\D)/$1$2$3/g;
257: # (5&3)&4=5&3&4
258: $expression=~s/\((\d+)((?:\&\d+)+)\)\&(\d+\D)/$1$2\&$3/g;
259: # (((5&3)|(4&6)))=((5&3)|(4&6))
260: $expression=~
261: s/\((\(\(\d+(?:\&\d+)*\)(?:\|\(\d+(?:\&\d+)*\))+\))\)/$1/g;
262: # ((5&3)|(4&6))|(1&2)=(5&3)|(4&6)|(1&2)
263: $expression=~
264: s/\((\(\d+(?:\&\d+)*\))((?:\|\(\d+(?:\&\d+)*\))+)\)\|(\(\d+(?:\&\d+)*\))/\($1$2\|$3\)/g;
265: return $expression;
266: }
267:
268: # -------------------------------------------------------- Build condition hash
269:
270: sub traceroute {
271: my ($sofar,$rid,$beenhere)=@_;
272: $sofar=simplify($sofar);
273: unless ($beenhere=~/\&$rid\&/) {
274: $beenhere.=$rid.'&';
275: if (($retfurl eq '') && ($hash{'src_'.$rid})) {
276: my ($mapid,$resid)=split(/\./,$rid);
277: $retfurl=$hash{'src_'.$rid}.
278: (($hash{'src_'.$rid}=~/\?/)?'&':'?').'symb='.
279: &Apache::lonnet::symbclean(
280: &Apache::lonnet::declutter($hash{'map_id_'.$mapid}).
281: '___'.$resid.'___'.
282: &Apache::lonnet::declutter($hash{'src_'.$rid}));
283: }
284: if (defined($hash{'conditions_'.$rid})) {
285: $hash{'conditions_'.$rid}=simplify(
286: '('.$hash{'conditions_'.$rid}.')|('.$sofar.')');
287: } else {
288: $hash{'conditions_'.$rid}=$sofar;
289: }
290: if (defined($hash{'is_map_'.$rid})) {
291: if (defined($hash{'map_start_'.$hash{'src_'.$rid}})) {
292: &traceroute($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},'&');
293: if (defined($hash{'map_finish_'.$hash{'src_'.$rid}})) {
294: $sofar=
295: $hash{'conditions_'.$hash{'map_finish_'.$hash{'src_'.$rid}}};
296: }
297: }
298: }
299: if (defined($hash{'to_'.$rid})) {
300: foreach (split(/\,/,$hash{'to_'.$rid})) {
301: my $further=$sofar;
302: if ($hash{'undercond_'.$_}) {
303: if (defined($hash{'condid_'.$hash{'undercond_'.$_}})) {
304: $further=simplify('('.$further.')&('.
305: $hash{'condid_'.$hash{'undercond_'.$_}}.')');
306: } else {
307: $errtext.='Undefined condition ID: '
308: .$hash{'undercond_'.$_}.'. ';
309: }
310: }
311: &traceroute($further,$hash{'goesto_'.$_},$beenhere);
312: }
313: }
314: }
315: }
316:
317: # ------------------------------ Cascading conditions, quick access, parameters
318:
319: sub accinit {
320: my ($uri,$short,$fn)=@_;
321: my %acchash=();
322: my %captured=();
323: my $condcounter=0;
324: $acchash{'acc.cond.'.$short.'.0'}=0;
325: foreach (keys %hash) {
326: if ($_=~/^conditions/) {
327: my $expr=$hash{$_};
328: foreach ($expr=~m/(\(\(\d+(?:\&\d+)+\)(?:\|\(\d+(?:\&\d+)+\))+\))/g) {
329: my $sub=$_;
330: my $orig=$_;
331: $sub=~/\(\((\d+\&(:?\d+\&)*)(?:\d+\&*)+\)(?:\|\(\1(?:\d+\&*)+\))+\)/;
332: my $factor=$1;
333: $sub=~s/$factor//g;
334: $sub=~s/^\(/\($factor\(/;
335: $sub.=')';
336: $sub=simplify($sub);
337: $orig=~s/(\W)/\\$1/g;
338: $expr=~s/$orig/$sub/;
339: }
340: $hash{$_}=$expr;
341: unless (defined($captured{$expr})) {
342: $condcounter++;
343: $captured{$expr}=$condcounter;
344: $acchash{'acc.cond.'.$short.'.'.$condcounter}=$expr;
345: }
346: } elsif ($_=~/^param_(\d+)\.(\d+)/) {
347: my $prefix=&Apache::lonnet::declutter($hash{'map_id_'.$1}).
348: '___'.$2.'___'.&Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
349: foreach (split(/\&/,$hash{$_})) {
350: my ($typename,$value)=split(/\=/,$_);
351: my ($type,$name)=split(/\:/,$typename);
352: $parmhash{$prefix.'.'.&Apache::lonnet::unescape($name)}=
353: &Apache::lonnet::unescape($value);
354: $parmhash{$prefix.'.'.&Apache::lonnet::unescape($name).'.type'}=
355: &Apache::lonnet::unescape($type);
356: }
357: }
358: }
359: foreach (keys %hash) {
360: if ($_=~/^ids/) {
361: foreach (split(/\,/,$hash{$_})) {
362: my $resid=$_;
363: my $uri=$hash{'src_'.$resid};
364: $uri=~s/^\/adm\/wrapper//;
365: my @uriparts=split(/\//,$uri);
366: my $urifile=$uriparts[$#uriparts];
367: $#uriparts--;
368: my $uripath=join('/',@uriparts);
369: $uripath=~s/^\/res\///;
370: if ($uripath) {
371: my $uricond='0';
372: if (defined($hash{'conditions_'.$resid})) {
373: $uricond=$captured{$hash{'conditions_'.$resid}};
374: }
375: if (defined($acchash{'acc.res.'.$short.'.'.$uripath})) {
376: if ($acchash{'acc.res.'.$short.'.'.$uripath}=~
377: /(\&$urifile\:[^\&]*)/) {
378: my $replace=$1;
379: my $regexp=$replace;
380: $regexp=~s/\|/\\\|/g;
381: $acchash{'acc.res.'.$short.'.'.$uripath}
382: =~s/$regexp/$replace\|$uricond/;
383: } else {
384: $acchash{'acc.res.'.$short.'.'.$uripath}.=
385: $urifile.':'.$uricond.'&';
386: }
387: } else {
388: $acchash{'acc.res.'.$short.'.'.$uripath}=
389: '&'.$urifile.':'.$uricond.'&';
390: }
391: }
392: }
393: }
394: }
395: $acchash{'acc.res.'.$short.'.'}='&:0&';
396: my $courseuri=$uri;
397: $courseuri=~s/^\/res\///;
398: &Apache::lonnet::delenv('(acc\.|httpref\.)');
399: &Apache::lonnet::appenv(%acchash,
400: "request.course.id" => $short,
401: "request.course.fn" => $fn,
402: "request.course.uri" => $courseuri);
403: }
404:
405: # ------------------------------------- Selectively delete from randompick maps
406:
407: sub pickrandom {
408: my $randomoutentry='';
409: foreach my $rid (keys %randompick) {
410: my $rndpick=$randompick{$rid};
411: my $mpc=$hash{'map_pc_'.$hash{'src_'.$rid}};
412: # ------------------------------------------- put existing resources into array
413: my @currentrids=();
414: foreach (keys %hash) {
415: if ($_=~/^src_($mpc\.\d+)/) {
416: if ($hash{'src_'.$1}) { push @currentrids, $1; }
417: }
418: }
419: next if ($#currentrids<$rndpick);
420: # -------------------------------- randomly eliminate the ones that should stay
421: srand(&Apache::lonnet::rndseed($rid)); # use rid instead of symb
422: for (my $i=1;$i<=$rndpick;$i++) {
423: while (1) {
424: my $randomidx=int(rand($#currentrids+1));
425: if ($currentrids[$randomidx]) {
426: $currentrids[$randomidx]='';
427: last;
428: }
429: }
430: }
431: # -------------------------------------------------------- delete the leftovers
432: for (my $k=0; $k<=$#currentrids; $k++) {
433: if ($currentrids[$k]) {
434: $hash{'randomout_'.$currentrids[$k]}=1;
435: my ($mapid,$resid)=split(/\./,$currentrids[$k]);
436: $randomoutentry.='&'.
437: &Apache::lonnet::symbclean(
438: &Apache::lonnet::declutter($hash{'map_id_'.$mapid}).
439: '___'.$resid.'___'.
440: &Apache::lonnet::declutter($hash{'src_'.$currentrids[$k]})
441: ).'&';
442: }
443: }
444: }
445: if ($randomoutentry) {
446: &Apache::lonnet::appenv('acc.randomout' => $randomoutentry);
447: }
448: }
449:
450: # ---------------------------------------------------- Read map and all submaps
451:
452: sub readmap {
453: my $short=shift;
454: $short=~s/^\///;
455: my %cenv=&Apache::lonnet::coursedescription($short);
456: my $fn=$cenv{'fn'};
457: my $uri;
458: $short=~s/\//\_/g;
459: unless ($uri=$cenv{'url'}) {
460: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
461: "Could not load course $short.</font>");
462: return 'No course data available.';
463: }
464: @cond=('true:normal');
465: unlink($fn.'.db');
466: unlink($fn.'_symb.db');
467: unlink($fn.'.state');
468: unlink($fn.'parms.db');
469: undef %randompick;
470: $retfurl='';
471: if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_WRCREAT(),0640)) &&
472: (tie(%parmhash,'GDBM_File',$fn.'_parms.db',&GDBM_WRCREAT(),0640))) {
473: %hash=();
474: %parmhash=();
475: $errtext='';
476: $pc=0;
477: my $furi=&Apache::lonnet::clutter($uri);
478: $hash{'src_0.0'}=$furi;
479: $hash{'title_0.0'}=&Apache::lonnet::metadata($uri,'title');
480: $hash{'ids_'.$furi}='0.0';
481: $hash{'is_map_0.0'}=1;
482: loadmap($uri);
483: if (defined($hash{'map_start_'.$uri})) {
484: &traceroute('0',$hash{'map_start_'.$uri},'&');
485: &accinit($uri,$short,$fn);
486: &pickrandom();
487: }
488: # ------------------------------------------------------------ Version tracking
489: if (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
490: &Apache::lonnet::logthis('Will be version tracking');
491: }
492: unless ((untie(%hash)) && (untie(%parmhash))) {
493: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
494: "Could not untie coursemap $fn for $uri.</font>");
495: }
496: {
497: my $cfh;
498: if ($cfh=Apache::File->new(">$fn.state")) {
499: print $cfh join("\n",@cond);
500: } else {
501: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
502: "Could not write statemap $fn for $uri.</font>");
503: }
504: }
505: } else {
506: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
507: "Could not tie coursemap $fn for $uri.</font>");
508: }
509: &Apache::lonmsg::author_res_msg($ENV{'request.course.uri'},$errtext);
510: return ($retfurl,$errtext);
511: }
512:
513: # ------------------------------------------------------- Evaluate state string
514:
515: sub evalstate {
516:
517: my $fn=$ENV{'request.course.fn'}.'.state';
518: my $state='2';
519: if (-e $fn) {
520: my @conditions=();
521: {
522: my $fh=Apache::File->new($fn);
523: @conditions=<$fh>;
524: }
525: my $safeeval = new Safe;
526: my $safehole = new Safe::Hole;
527: $safeeval->permit("entereval");
528: $safeeval->permit(":base_math");
529: $safeeval->deny(":base_io");
530: $safehole->wrap(\&Apache::lonnet::EXT,$safeeval,'&EXT');
531: foreach (@conditions) {
532: my $line=$_;
533: chomp($line);
534: my ($condition,$weight)=split(/\:/,$_);
535: if ($safeeval->reval($condition)) {
536: if ($weight eq 'force') {
537: $state.='3';
538: } else {
539: $state.='2';
540: }
541: } else {
542: if ($weight eq 'stop') {
543: $state.='0';
544: } else {
545: $state.='1';
546: }
547: }
548: }
549: }
550: &Apache::lonnet::appenv('user.state.'.$ENV{'request.course.id'} => $state);
551: return $state;
552: }
553:
554: 1;
555: __END__
556:
557: =head1 NAME
558:
559: Apache::lonuserstate - Construct and maintain state and binary representation
560: of course for user
561:
562: =head1 SYNOPSIS
563:
564: Invoked by lonroles.pm.
565:
566: &Apache::lonuserstate::readmap($cdom.'/'.$cnum);
567:
568: =head1 INTRODUCTION
569:
570: This module constructs and maintains state and binary representation
571: of course for user.
572:
573: This is part of the LearningOnline Network with CAPA project
574: described at http://www.lon-capa.org.
575:
576: =head1 HANDLER SUBROUTINE
577:
578: There is no handler subroutine.
579:
580: =head1 OTHER SUBROUTINES
581:
582: =over 4
583:
584: =item *
585:
586: loadmap() : Loads map from disk
587:
588: =item *
589:
590: simplify() : Simplify expression
591:
592: =item *
593:
594: traceroute() : Build condition hash
595:
596: =item *
597:
598: accinit() : Cascading conditions, quick access, parameters
599:
600: =item *
601:
602: readmap() : Read map and all submaps
603:
604: =item *
605:
606: evalstate() : Evaluate state string
607:
608: =back
609:
610: =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