--- rat/lonuserstate.pm 2013/05/06 18:08:39 1.145
+++ rat/lonuserstate.pm 2020/03/03 01:16:31 1.158
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Construct and maintain state and binary representation of course for user
#
-# $Id: lonuserstate.pm,v 1.145 2013/05/06 18:08:39 raeburn Exp $
+# $Id: lonuserstate.pm,v 1.158 2020/03/03 01:16:31 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -42,7 +42,7 @@ use Safe::Hole;
use Opcode;
use Apache::lonenc;
use Fcntl qw(:flock);
-use LONCAPA;
+use LONCAPA qw(:DEFAULT :match);
use File::Basename;
@@ -59,8 +59,12 @@ my $retfurl; # first URL
my %randompick; # randomly picked resources
my %randompickseed; # optional seed for randomly picking resources
my %randomorder; # maps to order contents randomly
+my %randomizationcode; # code used to grade folder for bubblesheet exam
my %encurl; # URLs in this folder are supposed to be encrypted
my %hiddenurl; # this URL (or complete folder) is supposed to be hidden
+my %deeplinkonly; # this URL (or complete folder) is deep-link only
+my %rescount; # count of unhidden items in each map
+my %mapcount; # count of unhidden maps in each map
# ----------------------------------- Remove version from URL and store in hash
@@ -140,10 +144,10 @@ sub processversionfile {
# Parameters:
# uri - URI of the map file.
# parent_rid - Resource id in the map of the parent resource (0.0 for the top level map)
-#
+# courseid - Course id for the course for which the map is being loaded
#
sub loadmap {
- my ($uri,$parent_rid)=@_;
+ my ($uri,$parent_rid,$courseid)=@_;
# Is the map already included?
@@ -183,7 +187,7 @@ sub loadmap {
# We can only nest sequences or pages. Anything else is an illegal nest.
unless (($fn=~/\.sequence$/) || $ispage) {
- $errtext.=&mt("
Invalid map: [_1]",$fn);
+ $errtext.='
'.&mt('Invalid map: [_1]',"$fn");
return;
}
@@ -192,7 +196,9 @@ sub loadmap {
my $instr=&Apache::lonnet::getfile($fn);
if ($instr eq -1) {
- $errtext.=&mt('
Map not loaded: The file [_1] does not exist.',$fn);
+ $errtext.= '
'
+ .&mt('Map not loaded: The file [_1] does not exist.',
+ "$fn");
return;
}
@@ -236,15 +242,37 @@ sub loadmap {
# This is handled in the next chunk of code.
my @map_ids;
+ my $codechecked;
+ $rescount{$lpc} = 0;
+ $mapcount{$lpc} = 0;
while (my $token = $parser->get_token) {
next if ($token->[0] ne 'S');
# Resource
if ($token->[1] eq 'resource') {
- my $resource_id = &parse_resource($token,$lpc,$ispage,$uri);
+ my $resource_id = &parse_resource($token,$lpc,$ispage,$uri,$courseid);
if (defined $resource_id) {
- push(@map_ids, $resource_id);
+ push(@map_ids, $resource_id);
+ if ($hash{'src_'.$lpc.'.'.$resource_id}) {
+ $rescount{$lpc} ++;
+ if (($hash{'src_'.$lpc.'.'.$resource_id}=~/\.sequence$/) ||
+ ($hash{'src_'.$lpc.'.'.$resource_id}=~/\.page$/)) {
+ $mapcount{$lpc} ++;
+ }
+ }
+ unless ($codechecked) {
+ my $startsymb =
+ &Apache::lonnet::encode_symb($hash{'map_id_'.$lpc},$resource_id,
+ $hash{'src_'."$lpc.$resource_id"});
+ my $code =
+ &Apache::lonnet::EXT('resource.0.examcode',$startsymb,undef,undef,
+ undef,undef,$courseid);
+ if ($code) {
+ $randomizationcode{$parent_rid} = $code;
+ }
+ $codechecked = 1;
+ }
}
# Link
@@ -260,17 +288,25 @@ sub loadmap {
&parse_condition($token,$lpc);
}
}
-
+ undef($codechecked);
# Handle randomization and random selection
if ($randomize) {
- if (!$env{'request.role.adv'}) {
+ my $advanced;
+ if ($env{'request.course.id'}) {
+ $advanced = (&Apache::lonnet::allowed('adv') eq 'F');
+ } else {
+ $env{'request.course.id'} = $courseid;
+ $advanced = (&Apache::lonnet::allowed('adv') eq 'F');
+ $env{'request.course.id'} = '';
+ }
+ unless ($advanced) {
+ # Order of resources is not randomized if user has and advanced role in the course.
my $seed;
- # In the advanced role, the map's random seed
- # parameter is used as the basis for computing the
- # seed ... if it has been specified:
+ # If the map's random seed parameter has been specified
+ # it is used as the basis for computing the seed ...
if (defined($randompickseed{$parent_rid})) {
$seed = $randompickseed{$parent_rid};
@@ -289,18 +325,30 @@ sub loadmap {
# TODO: Here for sure we need to pass along the username/domain
# so that we can impersonate users in lonprintout e.g.
+ my $setcode;
+ if (defined($randomizationcode{$parent_rid})) {
+ if ($env{'form.CODE'} eq '') {
+ $env{'form.CODE'} = $randomizationcode{$parent_rid};
+ $setcode = 1;
+ }
+ }
+
my $rndseed=&Apache::lonnet::rndseed($seed);
&Apache::lonnet::setup_random_from_rndseed($rndseed);
+ if ($setcode) {
+ undef($env{'form.CODE'});
+ undef($setcode);
+ }
+
# Take the set of map ids we have decoded and permute them to a
# random order based on the seed set above. All of this is
# processing the randomorder parameter if it is set, not
# randompick.
- @map_ids=&Math::Random::random_permutation(@map_ids);
+ @map_ids=&Math::Random::random_permutation(@map_ids);
}
-
my $from = shift(@map_ids);
my $from_rid = $lpc.'.'.$from;
$hash{'map_start_'.$uri} = $from_rid;
@@ -325,7 +373,7 @@ sub loadmap {
$parser = HTML::TokeParser->new(\$instr);
$parser->attr_encoded(1);
- # last parse out the mapalias params. Thes provide mnemonic
+ # last parse out the mapalias params. These provide mnemonic
# tags to resources that can be used in conditions
while (my $token = $parser->get_token) {
@@ -352,6 +400,7 @@ sub loadmap {
# $lpc - Map nesting level (?)
# $ispage - True if this resource is encapsulated in a .page (assembled resourcde).
# $uri - URI of the enclosing resource.
+# $courseid - Course id of the course containing the resource being parsed.
# Returns:
# Value of the id attribute of the tag.
#
@@ -372,7 +421,7 @@ sub loadmap {
sub parse_resource {
- my ($token,$lpc,$ispage,$uri) = @_;
+ my ($token,$lpc,$ispage,$uri,$courseid) = @_;
# I refuse to countenance code like this that has
# such a dirty side effect (and forcing this sub to be called within a loop).
@@ -421,7 +470,11 @@ sub parse_resource {
# is not a page. If the resource is a page then it must be
# assembled (at fetch time?).
- unless ($ispage) {
+ if ($ispage) {
+ if ($token->[2]->{'external'} eq 'true') { # external
+ $turi=~s{^http\://}{/ext/};
+ }
+ } else {
$turi=~/\.(\w+)$/;
my $embstyle=&Apache::loncommon::fileembstyle($1);
if ($token->[2]->{'external'} eq 'true') { # external
@@ -436,6 +489,8 @@ sub parse_resource {
} elsif ($turi!~/\.(sequence|page)$/) {
$turi='/adm/coursedocs/showdoc'.$turi;
}
+ } elsif ($turi=~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
+ $turi='/adm/wrapper'.$turi;
} elsif ($turi=~/\S/) { # normal non-empty internal resource
my $mapdir=$uri;
$mapdir=~s/[^\/]+$//;
@@ -511,7 +566,7 @@ sub parse_resource {
if (($turi=~/\.sequence$/) ||
($turi=~/\.page$/)) {
$hash{'is_map_'.$rid}=1;
- &loadmap($turi,$rid);
+ &loadmap($turi,$rid,$courseid);
}
return $token->[2]->{'id'};
}
@@ -667,7 +722,7 @@ sub parse_condition {
# Typical attributes:
# to=n - Number of the resource the parameter applies to.
# type=xx - Type of parameter value (e.g. string_yesno or int_pos).
-# name=xxx - Name ofr parameter (e.g. parameter_randompick or parameter_randomorder).
+# name=xxx - Name of parameter (e.g. parameter_randompick or parameter_randomorder).
# value=xxx - value of the parameter.
sub parse_param {
@@ -867,6 +922,14 @@ sub traceroute {
&& ($hash{'src_'.$rid}!~/\.sequence$/)) {
$retfrid=$rid;
}
+ my @deeplink=&Apache::lonnet::EXT('resource.0.deeplink',$symb);
+ unless ((@deeplink == 0) || ($deeplink[0] eq 'full')) {
+ $deeplinkonly{$rid}=join(':',@deeplink);
+ if ($deeplink[1] eq 'map') {
+ my $parent = (split(/\,/,$hash{'map_hierarchy_'.$mapid}))[-1];
+ $deeplinkonly{"$parent.$mapid"}=$deeplinkonly{$rid};
+ }
+ }
if (defined($hash{'conditions_'.$rid})) {
$hash{'conditions_'.$rid}=simplify(
@@ -909,7 +972,9 @@ sub traceroute {
$further=simplify('('.'_'.$rid.')&('.
$hash{'condid_'.$hash{'undercond_'.$id}}.')');
} else {
- $errtext.=&mt('
Undefined condition ID: [_1]',$hash{'undercond_'.$id});
+ $errtext.= '
'.
+ &mt('Undefined condition ID: [_1]',
+ $hash{'undercond_'.$id});
}
}
# Recurse to resoruces that have to's to us.
@@ -1031,7 +1096,7 @@ sub accinit {
sub hiddenurls {
my $randomoutentry='';
- foreach my $rid (keys %randompick) {
+ foreach my $rid (keys(%randompick)) {
my $rndpick=$randompick{$rid};
my $mpc=$hash{'map_pc_'.$hash{'src_'.$rid}};
# ------------------------------------------- put existing resources into array
@@ -1052,7 +1117,18 @@ sub hiddenurls {
# -------------------------------- randomly eliminate the ones that should stay
my (undef,$id)=split(/\./,$rid);
if ($randompickseed{$rid}) { $id=$randompickseed{$rid}; }
+ my $setcode;
+ if (defined($randomizationcode{$rid})) {
+ if ($env{'form.CODE'} eq '') {
+ $env{'form.CODE'} = $randomizationcode{$rid};
+ $setcode = 1;
+ }
+ }
my $rndseed=&Apache::lonnet::rndseed($id); # use id instead of symb
+ if ($setcode) {
+ undef($env{'form.CODE'});
+ undef($setcode);
+ }
&Apache::lonnet::setup_random_from_rndseed($rndseed);
my @whichids=&Math::Random::random_permuted_index($#currentrids+1);
for (my $i=1;$i<=$rndpick;$i++) { $currentrids[$whichids[$i]]=''; }
@@ -1062,6 +1138,14 @@ sub hiddenurls {
if ($currentrids[$k]) {
$hash{'randomout_'.$currentrids[$k]}=1;
my ($mapid,$resid)=split(/\./,$currentrids[$k]);
+ if ($rescount{$mapid}) {
+ $rescount{$mapid} --;
+ }
+ if ($hash{'is_map_'.$currentrids[$k]}) {
+ if ($mapcount{$mapid}) {
+ $mapcount{$mapid} --;
+ }
+ }
$randomoutentry.='&'.
&Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},
$resid,
@@ -1071,9 +1155,17 @@ sub hiddenurls {
}
}
# ------------------------------ take care of explicitly hidden urls or folders
- foreach my $rid (keys %hiddenurl) {
+ foreach my $rid (keys(%hiddenurl)) {
$hash{'randomout_'.$rid}=1;
my ($mapid,$resid)=split(/\./,$rid);
+ if ($rescount{$mapid}) {
+ $rescount{$mapid} --;
+ }
+ if ($hash{'is_map_'.$rid}) {
+ if ($mapcount{$mapid}) {
+ $mapcount{$mapid} --;
+ }
+ }
$randomoutentry.='&'.
&Apache::lonnet::encode_symb($hash{'map_id_'.$mapid},$resid,
$hash{'src_'.$rid}).'&';
@@ -1084,6 +1176,32 @@ sub hiddenurls {
}
}
+# -------------------------------------- populate big hash with map breadcrumbs
+
+# Create map_breadcrumbs_$pc from map_hierarchy_$pc by omitting intermediate
+# maps not shown in Course Contents table.
+
+sub mapcrumbs {
+ foreach my $key (keys(%rescount)) {
+ if ($hash{'map_hierarchy_'.$key}) {
+ my $skipnext = 0;
+ foreach my $id (split(/,/,$hash{'map_hierarchy_'.$key}),$key) {
+ unless ($skipnext) {
+ $hash{'map_breadcrumbs_'.$key} .= "$id,";
+ }
+ unless (($id == 0) || ($id == 1)) {
+ if ((!$rescount{$id}) || ($rescount{$id} == 1 && $mapcount{$id} == 1)) {
+ $skipnext = 1;
+ } else {
+ $skipnext = 0;
+ }
+ }
+ }
+ $hash{'map_breadcrumbs_'.$key} =~ s/,$//;
+ }
+ }
+}
+
# ---------------------------------------------------- Read map and all submaps
sub readmap {
@@ -1104,7 +1222,7 @@ sub readmap {
}
@cond=('true:normal');
- unless (open(LOCKFILE,">$fn.db.lock")) {
+ unless (open(LOCKFILE,">","$fn.db.lock")) {
#
# Most likely a permissions problem on the lockfile or its directory.
#
@@ -1122,8 +1240,14 @@ sub readmap {
&unlink_tmpfiles($fn);
}
undef %randompick;
+ undef %randompickseed;
+ undef %randomorder;
+ undef %randomizationcode;
undef %hiddenurl;
undef %encurl;
+ undef %deeplinkonly;
+ undef %rescount;
+ undef %mapcount;
$retfrid='';
$errtext='';
my ($untiedhash,$untiedparmhash,$tiedhash,$tiedparmhash); # More state flags.
@@ -1265,8 +1389,14 @@ sub readmap {
$lock=1;
}
undef %randompick;
+ undef %randompickseed;
+ undef %randomorder;
+ undef %randomizationcode;
undef %hiddenurl;
undef %encurl;
+ undef %deeplinkonly;
+ undef %rescount;
+ undef %mapcount;
$errtext='';
$retfrid='';
#
@@ -1370,7 +1500,7 @@ sub build_tmp_hashes {
# sub-maps.
- &loadmap($uri,'0.0');
+ &loadmap($uri,'0.0',$short);
# The code below only executes if there is a starting point for the map>
# Q/BUG??? If there is no start resource for the map should that be an error?
@@ -1385,6 +1515,7 @@ sub build_tmp_hashes {
&traceroute('0',$hash{'map_start_'.$uri},'&');
&accinit($uri,$short,$fn);
&hiddenurls();
+ &mapcrumbs();
}
$errtext .= &get_mapalias_errors();
# ------------------------------------------------------- Put versions into src
@@ -1402,6 +1533,10 @@ sub build_tmp_hashes {
# $hash{'src_'.$id}=&Apache::lonenc::encrypted($hash{'src_'.$id});
$hash{'encrypted_'.$id}=1;
}
+# ------------------------------------------------------------ Deep-linked URLs
+ foreach my $id (keys(%deeplinkonly)) {
+ $hash{'deeplinkonly_'.$id}=$deeplinkonly{$id};
+ }
# ----------------------------------------------- Close hashes to finally store
# --------------------------------- Routine must pass this point, no early outs
$hash{'first_rid'}=$retfrid;
@@ -1416,7 +1551,7 @@ sub build_tmp_hashes {
# ---------------------------------------------------- Store away initial state
{
my $cfh;
- if (open($cfh,">$fn.state")) {
+ if (open($cfh,">","$fn.state")) {
print $cfh join("\n",@cond);
$gotstate = 1;
} else {
@@ -1453,7 +1588,7 @@ sub evalstate {
if (-e $fn) {
my @conditions=();
{
- open(my $fh,"<$fn");
+ open(my $fh,"<",$fn);
@conditions=<$fh>;
close($fh);
}
@@ -1508,8 +1643,8 @@ sub evalstate {
$count++;
}
my ($mapid) = split(/\./,$id);
- &mt('Resource "[_1]"
in Map "[_2]"',
- $hash{'title_'.$id},
+ &mt('Resource [_1][_2]in Map [_3]',
+ $hash{'title_'.$id},'
',
$hash{'title_'.$hash{'ids_'.$hash{'map_id_'.$mapid}}});
} (@{ $mapalias_cache{$mapalias} }));
next if ($count < 2);