loncom/lonnet/perl/lonnet.pm - diff

Return to lonnet.pm CVS log

Up to [LON-CAPA] / loncom / lonnet / perl

Diff for /loncom/lonnet/perl/lonnet.pm between versions 1.320 and 1.421

-version 1.320, 2003/01/28 00:09:57
+version 1.421, 2003/09/22 19:32:49
  Line 47
  # 09/01 Guy Albertelli
  # 09/01,10/01,11/01 Gerd Kortemeyer
  # YEAR=2001
- # 02/27/01 Scott Harrison
  # 3/2 Gerd Kortemeyer
- # 3/15,3/19 Scott Harrison
  # 3/19,3/20 Gerd Kortemeyer
- # 3/22,3/27,4/2,4/16,4/17 Scott Harrison
  # 5/26,5/28 Gerd Kortemeyer
  # 5/30 H. K. Ng
  # 6/1 Gerd Kortemeyer
  # July Guy Albertelli
  # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
  # 10/2 Gerd Kortemeyer
- # 10/5,10/10,11/13,11/15 Scott Harrison
  # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
  # 12/5 Matthew Hall
  # 12/5 Guy Albertelli
  # 12/6,12/7,12/12 Gerd Kortemeyer
- # 12/18 Scott Harrison
  # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
  # YEAR=2002
  # 1/4,2/4,2/7 Gerd Kortemeyer
- Line 79  use HTTP::Headers;
+ Line 74  use HTTP::Headers;
  use vars
  qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom
     %libserv %pr %prp %metacache %packagetab %titlecache
-    %courselogs %accesshash $processmarker $dumpcount
+    %courselogs %accesshash %userrolehash $processmarker $dumpcount
-    %coursedombuf %coursehombuf %courseresdatacache
+    %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache
-    %domaindescription);
+    %userresdatacache %usectioncache %domaindescription %domain_auth_def %domain_auth_arg_def
+    %domain_lang_def %domain_city %domain_longi %domain_lati $tmpdir);
  use IO::Socket;
  use GDBM_File;
  use Apache::Constants qw(:common :http);
  use HTML::LCParser;
  use Fcntl qw(:flock);
  use Apache::loncoursedata;
+ use Apache::lonlocal;
  my $readit;
- Line 249  sub critical {
+ Line 247  sub critical {
      return $answer;
  }
+ #
+ # -------------- Remove all key from the env that start witha lowercase letter
+ #                (Which is always a lon-capa value)
+ sub cleanenv {
+ #    unless (defined(&Apache::exists_config_define("MODPERL2"))) { return; }
+ #    unless (&Apache::exists_config_define("MODPERL2")) { return; }
+     foreach my $key (keys(%ENV)) {
+ 	if ($key =~ /^[a-z]/) {
+ 	    delete($ENV{$key});
+ 	}
+     }
+ }
+ # ------------------------------------------- Transfer profile into environment
+ sub transfer_profile_to_env {
+     my ($lonidsdir,$handle)=@_;
+     my @profile;
+     {
+ 	my $idf=Apache::File->new("$lonidsdir/$handle.id");
+ 	flock($idf,LOCK_SH);
+ 	@profile=<$idf>;
+ 	$idf->close();
+     }
+     my $envi;
+     for ($envi=0;$envi<=$#profile;$envi++) {
+ 	chomp($profile[$envi]);
+ 	my ($envname,$envvalue)=split(/=/,$profile[$envi]);
+ 	$ENV{$envname} = $envvalue;
+     }
+     $ENV{'user.environment'} = "$lonidsdir/$handle.id";
+ }
  # ---------------------------------------------------------- Append Environment
  sub appenv {
- Line 352  sub delenv {
+ Line 384  sub delenv {
      return 'ok';
  }
+ # ------------------------------------------ Find out current server userload
+ # there is a copy in lond
+ sub userload {
+     my $numusers=0;
+     {
+ 	opendir(LONIDS,$perlvar{'lonIDsDir'});
+ 	my $filename;
+ 	my $curtime=time;
+ 	while ($filename=readdir(LONIDS)) {
+ 	    if ($filename eq '.' || $filename eq '..') {next;}
+ 	    my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
+ 	    if ($curtime-$mtime < 3600) { $numusers++; }
+ 	}
+ 	closedir(LONIDS);
+     }
+     my $userloadpercent=0;
+     my $maxuserload=$perlvar{'lonUserLoadLim'};
+     if ($maxuserload) {
+ 	$userloadpercent=100*$numusers/$maxuserload;
+     }
+     $userloadpercent=sprintf("%.2f",$userloadpercent);
+     return $userloadpercent;
+ }
  # ------------------------------------------ Fight off request when overloaded
  sub overloaderror {
- Line 378  sub overloaderror {
+ Line 434  sub overloaderror {
  # ------------------------------ Find server with least workload from spare.tab
  sub spareserver {
-     my $loadpercent = shift;
+     my ($loadpercent,$userloadpercent) = @_;
      my $tryserver;
      my $spareserver='';
-     my $lowestserver=$loadpercent;
+     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
+     my $lowestserver=$loadpercent > $userloadpercent?
+ 	             $loadpercent :  $userloadpercent;
      foreach $tryserver (keys %spareid) {
-        my $answer=reply('load',$tryserver);
+ 	my $loadans=reply('load',$tryserver);
-        if (($answer =~ /\d/) && ($answer<$lowestserver)) {
+ 	my $userloadans=reply('userload',$tryserver);
- 	   $spareserver="http://$hostname{$tryserver}";
+ 	if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
-            $lowestserver=$answer;
+ 	    next; #didn't get a number from the server
-        }
+ 	}
-     }
+ 	my $answer;
+ 	if ($loadans =~ /\d/) {
+ 	    if ($userloadans =~ /\d/) {
+ 		#both are numbers, pick the bigger one
+ 		$answer=$loadans > $userloadans?
+ 		    $loadans :  $userloadans;
+ 	    } else {
+ 		$answer = $loadans;
+ 	    }
+ 	} else {
+ 	    $answer = $userloadans;
+ 	}
+ 	if (($answer =~ /\d/) && ($answer<$lowestserver)) {
+ 	    $spareserver="http://$hostname{$tryserver}";
+ 	    $lowestserver=$answer;
+ 	}
+     }
      return $spareserver;
  }
- Line 593  sub idput {
+ Line 667  sub idput {
      }
  }
+ # --------------------------------------------------- Assign a key to a student
+ sub assign_access_key {
+ #
+ # a valid key looks like uname:udom#comments
+ # comments are being appended
+ #
+     my ($ckey,$cdom,$cnum,$udom,$uname,$logentry)=@_;
+     $cdom=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
+     $cnum=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
+     $udom=$ENV{'user.name'} unless (defined($udom));
+     $uname=$ENV{'user.domain'} unless (defined($uname));
+     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
+     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
+         ($existing{$ckey}=~/^$uname\:$udom\#(.*)$/)) {
+                                                   # assigned to this person
+                                                   # - this should not happen,
+                                                   # unless something went wrong
+                                                   # the first time around
+ # ready to assign
+         $logentry=$1.'; '.$logentry;
+         if (&put('accesskey',{$ckey=>$uname.':'.$udom.'#'.$logentry},
+                                                  $cdom,$cnum) eq 'ok') {
+ # key now belongs to user
+ 	    my $envkey='key.'.$cdom.'_'.$cnum;
+             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
+                 &appenv('environment.'.$envkey => $ckey);
+                 return 'ok';
+             } else {
+                 return
+   'error: Count not permanently assign key, will need to be re-entered later.';
+ 	    }
+         } else {
+             return 'error: Could not assign key, try again later.';
+         }
+     } elsif (!$existing{$ckey}) {
+ # the key does not exist
+ 	return 'error: The key does not exist';
+     } else {
+ # the key is somebody else's
+ 	return 'error: The key is already in use';
+     }
+ }
+ # ------------------------------------------ put an additional comment on a key
+ sub comment_access_key {
+ #
+ # a valid key looks like uname:udom#comments
+ # comments are being appended
+ #
+     my ($ckey,$cdom,$cnum,$logentry)=@_;
+     $cdom=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
+     $cnum=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
+     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
+     if ($existing{$ckey}) {
+         $existing{$ckey}.='; '.$logentry;
+ # ready to assign
+         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
+                                                  $cdom,$cnum) eq 'ok') {
+ 	    return 'ok';
+         } else {
+ 	    return 'error: Count not store comment.';
+         }
+     } else {
+ # the key does not exist
+ 	return 'error: The key does not exist';
+     }
+ }
+ # ------------------------------------------------------ Generate a set of keys
+ sub generate_access_keys {
+     my ($number,$cdom,$cnum,$logentry)=@_;
+     $cdom=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
+     $cnum=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
+     unless (&allowed('mky',$cdom)) { return 0; }
+     unless (($cdom) && ($cnum)) { return 0; }
+     if ($number>10000) { return 0; }
+     sleep(2); # make sure don't get same seed twice
+     srand(time()^($$+($$<<15))); # from "Programming Perl"
+     my $total=0;
+     for (my $i=1;$i<=$number;$i++) {
+        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
+                   sprintf("%lx",int(100000*rand)).'-'.
+                   sprintf("%lx",int(100000*rand));
+        $newkey=~s/1/g/g; # folks mix up 1 and l
+        $newkey=~s/0/h/g; # and also 0 and O
+        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
+        if ($existing{$newkey}) {
+            $i--;
+        } else {
+ 	  if (&put('accesskeys',
+               { $newkey => '# generated '.localtime().
+                            ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}.
+                            '; '.$logentry },
+ 		   $cdom,$cnum) eq 'ok') {
+               $total++;
+ 	  }
+        }
+     }
+     &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
+          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
+     return $total;
+ }
+ # ------------------------------------------------------- Validate an accesskey
+ sub validate_access_key {
+     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
+     $cdom=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
+     $cnum=
+    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
+     $udom=$ENV{'user.name'} unless (defined($udom));
+     $uname=$ENV{'user.domain'} unless (defined($uname));
+     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
+     return ($existing{$ckey}=~/^$uname\:$udom\#/);
+ }
  # ------------------------------------- Find the section of student in a course
  sub getsection {
- Line 648  sub getsection {
+ Line 848  sub getsection {
      return '-1';
  }
+ sub devalidate_cache {
+     my ($cache,$id) = @_;
+     delete $$cache{$id.'.time'};
+     delete $$cache{$id};
+ }
+ sub is_cached {
+     my ($cache,$id,$time) = @_;
+     if (!$time) { $time=300; }
+     if (!exists($$cache{$id.'.time'})) {
+ 	return (undef,undef);
+     } else {
+ 	if (time-$$cache{$id.'.time'}>$time) {
+ 	    &devalidate_cache($cache,$id);
+ 	    return (undef,undef);
+ 	}
+     }
+     return ($$cache{$id},1);
+ }
+ sub do_cache {
+     my ($cache,$id,$value) = @_;
+     $$cache{$id.'.time'}=time;
+     # do_cache implictly return the set value
+     $$cache{$id}=$value;
+ }
  sub usection {
      my ($udom,$unam,$courseid)=@_;
+     my $hashid="$udom:$unam:$courseid";
+     my ($result,$cached)=&is_cached(\%usectioncache,$hashid);
+     if (defined($cached)) { return $result; }
      $courseid=~s/\_/\//g;
      $courseid=~s/^(\w)/\/$1/;
      foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
- Line 668  sub usection {
+ Line 899  sub usection {
              if ($end) {
                  if ($now>$end) { $notactive=1; }
              }
-             unless ($notactive) { return $section; }
+             unless ($notactive) {
+ 		return &do_cache(\%usectioncache,$hashid,$section);
+ 	    }
          }
      }
-     return '-1';
+     return &do_cache(\%usectioncache,$hashid,'-1');
  }
  # ------------------------------------- Read an entry from a user's environment
- Line 734  sub subscribe {
+ Line 967  sub subscribe {
      $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
      my ($udom,$uname)=split(/\//,$author);
      my $home=homeserver($uname,$udom);
      if ($home eq 'no_host') {
          return 'not_found';
      }
      my $answer=reply("sub:$fname",$home);
      if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
- Line 809  sub repcopy {
+ Line 1042  sub repcopy {
      }
  }
+ # ------------------------------------------------ Get server side include body
+ sub ssi_body {
+     my ($filelink,%form)=@_;
+     my $output=($filelink=~/^http\:/?&externalssi($filelink):
+                                      &ssi($filelink,%form));
+     $output=~s/^.*\<body[^\>]*\>//si;
+     $output=~s/\<\/body\s*\>.*$//si;
+     $output=~
+             s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
+     return $output;
+ }
  # --------------------------------------------------------- Server Side Include
  sub ssi {
- Line 832  sub ssi {
+ Line 1077  sub ssi {
      return $response->content;
  }
+ sub externalssi {
+     my ($url)=@_;
+     my $ua=new LWP::UserAgent;
+     my $request=new HTTP::Request('GET',$url);
+     my $response=$ua->request($request);
+     return $response->content;
+ }
  # ------- Add a token to a remote URI's query string to vouch for access rights
  sub tokenwrapper {
- Line 926  sub log {
+ Line 1179  sub log {
  }
  # ------------------------------------------------------------------ Course Log
+ #
+ # This routine flushes several buffers of non-mission-critical nature
+ #
  sub flushcourselogs {
-     &logthis('Flushing course log buffers');
+     &logthis('Flushing log buffers');
+ #
+ # course logs
+ # This is a log of all transactions in a course, which can be used
+ # for data mining purposes
+ #
+ # It also collects the courseid database, which lists last transaction
+ # times and course titles for all courseids
+ #
+     my %courseidbuffer=();
      foreach (keys %courselogs) {
          my $crsid=$_;
-         if (&reply('log:'.$coursedombuf{$crsid}.':'.
+         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
  		          &escape($courselogs{$crsid}),
  		          $coursehombuf{$crsid}) eq 'ok') {
  	    delete $courselogs{$crsid};
- Line 942  sub flushcourselogs {
+ Line 1207  sub flushcourselogs {
                          " exceeded maximum size, deleting.</font>");
                 delete $courselogs{$crsid};
              }
          }
+         if ($courseidbuffer{$coursehombuf{$crsid}}) {
+            $courseidbuffer{$coursehombuf{$crsid}}.='&'.
+ 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
+         } else {
+            $courseidbuffer{$coursehombuf{$crsid}}=
+ 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
+         }
+     }
+ #
+ # Write course id database (reverse lookup) to homeserver of courses
+ # Is used in pickcourse
+ #
+     foreach (keys %courseidbuffer) {
+         &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
      }
-     &logthis('Flushing access logs');
+ #
+ # File accesses
+ # Writes to the dynamic metadata of resources to get hit counts, etc.
+ #
      foreach (keys %accesshash) {
          my $entry=$_;
          $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
- Line 953  sub flushcourselogs {
+ Line 1235  sub flushcourselogs {
  	    delete $accesshash{$entry};
          }
      }
+ #
+ # Roles
+ # Reverse lookup of user roles for course faculty/staff and co-authorship
+ #
+     foreach (keys %userrolehash) {
+         my $entry=$_;
+         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
+ 	    split(/\:/,$entry);
+         if (&Apache::lonnet::put('nohist_userroles',
+              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
+                 $rudom,$runame) eq 'ok') {
+ 	    delete $userrolehash{$entry};
+         }
+     }
      $dumpcount++;
  }
- Line 961  sub courselog {
+ Line 1257  sub courselog {
      $what=time.':'.$what;
      unless ($ENV{'request.course.id'}) { return ''; }
      $coursedombuf{$ENV{'request.course.id'}}=
-        $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
+        $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
+     $coursenumbuf{$ENV{'request.course.id'}}=
         $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
      $coursehombuf{$ENV{'request.course.id'}}=
         $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
+     $coursedescrbuf{$ENV{'request.course.id'}}=
+        $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
      if (defined $courselogs{$ENV{'request.course.id'}}) {
  	$courselogs{$ENV{'request.course.id'}}.='&'.$what;
      } else {
- Line 979  sub courseacclog {
+ Line 1278  sub courseacclog {
      my $fnsymb=shift;
      unless ($ENV{'request.course.id'}) { return ''; }
      my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
-     if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
+     if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|page)$/) {
          $what.=':POST';
  	foreach (keys %ENV) {
              if ($_=~/^form\.(.*)/) {
- Line 1001  sub countacc {
+ Line 1300  sub countacc {
          $accesshash{$key}=1;
      }
  }
+ sub linklog {
+     my ($from,$to)=@_;
+     $from=&declutter($from);
+     $to=&declutter($to);
+     $accesshash{$from.'___'.$to.'___comefrom'}=1;
+     $accesshash{$to.'___'.$from.'___goto'}=1;
+ }
+ sub userrolelog {
+     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
+     if (($trole=~/^ca/) || ($trole=~/^in/) ||
+         ($trole=~/^cc/) || ($trole=~/^ep/) ||
+         ($trole=~/^cr/)) {
+        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
+        $userrolehash
+          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
+                     =$tend.':'.$tstart;
+    }
+ }
+ sub get_course_adv_roles {
+     my $cid=shift;
+     $cid=$ENV{'request.course.id'} unless (defined($cid));
+     my %coursehash=&coursedescription($cid);
+     my %returnhash=();
+     my %dumphash=
+             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
+     my $now=time;
+     foreach (keys %dumphash) {
+ 	my ($tend,$tstart)=split(/\:/,$dumphash{$_});
+         if (($tstart) && ($tstart<0)) { next; }
+         if (($tend) && ($tend<$now)) { next; }
+         if (($tstart) && ($now<$tstart)) { next; }
+         my ($role,$username,$domain,$section)=split(/\:/,$_);
+         my $key=&plaintext($role);
+         if ($section) { $key.=' (Sec/Grp '.$section.')'; }
+         if ($returnhash{$key}) {
+ 	    $returnhash{$key}.=','.$username.':'.$domain;
+         } else {
+             $returnhash{$key}=$username.':'.$domain;
+         }
+      }
+     return %returnhash;
+ }
+ sub get_my_roles {
+     my ($uname,$udom)=@_;
+     unless (defined($uname)) { $uname=$ENV{'user.name'}; }
+     unless (defined($udom)) { $udom=$ENV{'user.domain'}; }
+     my %dumphash=
+             &dump('nohist_userroles',$udom,$uname);
+     my %returnhash=();
+     my $now=time;
+     foreach (keys %dumphash) {
+ 	my ($tend,$tstart)=split(/\:/,$dumphash{$_});
+         if (($tstart) && ($tstart<0)) { next; }
+         if (($tend) && ($tend<$now)) { next; }
+         if (($tstart) && ($now<$tstart)) { next; }
+         my ($role,$username,$domain,$section)=split(/\:/,$_);
+ 	$returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
+      }
+     return %returnhash;
+ }
+ # ----------------------------------------------------- Frontpage Announcements
+ #
+ #
+ sub postannounce {
+     my ($server,$text)=@_;
+     unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
+     unless ($text=~/\w/) { $text=''; }
+     return &reply('setannounce:'.&escape($text),$server);
+ }
+ sub getannounce {
+     if (my $fh=Apache::File->new($perlvar{'lonDocRoot'}.'/announcement.txt')) {
+ 	my $announcement='';
+ 	while (<$fh>) { $announcement .=$_; }
+ 	$fh->close();
+ 	if ($announcement=~/\w/) {
+ 	    return
+    '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
+    '<tr><td bgcolor="#FFFFFF"><pre>'.$announcement.'</pre></td></tr></table>';
+ 	} else {
+ 	    return '';
+ 	}
+     } else {
+ 	return '';
+     }
+ }
+ # ---------------------------------------------------------- Course ID routines
+ # Deal with domain's nohist_courseid.db files
+ #
+ sub courseidput {
+     my ($domain,$what,$coursehome)=@_;
+     return &reply('courseidput:'.$domain.':'.$what,$coursehome);
+ }
+ sub courseiddump {
+     my ($domfilter,$descfilter,$sincefilter)=@_;
+     my %returnhash=();
+     unless ($domfilter) { $domfilter=''; }
+     foreach my $tryserver (keys %libserv) {
+ 	if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
+ 	    foreach (
+              split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
+ 			       $sincefilter.':'.&escape($descfilter),
+                                $tryserver))) {
+ 		my ($key,$value)=split(/\=/,$_);
+                 if (($key) && ($value)) {
+ 		    $returnhash{&unescape($key)}=&unescape($value);
+                 }
+             }
+         }
+     }
+     return %returnhash;
+ }
+ #
  # ----------------------------------------------------------- Check out an item
  sub checkout {
- Line 1109  sub expirespread {
+ Line 1531  sub expirespread {
  # ----------------------------------------------------- Devalidate Spreadsheets
  sub devalidate {
-     my $symb=shift;
+     my ($symb,$uname,$udom)=@_;
      my $cid=$ENV{'request.course.id'};
      if ($cid) {
- 	my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
+         # delete the stored spreadsheets for
+         # - the student level sheet of this user in course's homespace
+         # - the assessment level sheet for this resource
+         #   for this user in user's homespace
+ 	my $key=$uname.':'.$udom.':';
          my $status=
  	    &del('nohist_calculatedsheets',
- 		 [$key.'studentcalc'],
+ 		 [$key.'studentcalc:'],
  		 $ENV{'course.'.$cid.'.domain'},
  		 $ENV{'course.'.$cid.'.num'})
  		.' '.
  	    &del('nohist_calculatedsheets_'.$cid,
- 		 [$key.'assesscalc:'.$symb]);
+ 		 [$key.'assesscalc:'.$symb],$udom,$uname);
          unless ($status eq 'ok ok') {
             &logthis('Could not devalidate spreadsheet '.
-                     $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
+                     $uname.' at '.$udom.' for '.
  		    $symb.': '.$status);
          }
      }
- Line 1326  sub tmpreset {
+ Line 1752  sub tmpreset {
    my ($symb,$namespace,$domain,$stuname) = @_;
    if (!$symb) {
      $symb=&symbread();
-     if (!$symb) { $symb= $ENV{'REQUEST_URI'}; }
+     if (!$symb) { $symb= $ENV{'request.url'}; }
    }
    $symb=escape($symb);
- Line 1455  sub store {
+ Line 1881  sub store {
      $symb=&symbclean($symb);
      if (!$symb) { unless ($symb=&symbread()) { return ''; } }
-     &devalidate($symb);
+     if (!$domain) { $domain=$ENV{'user.domain'}; }
+     if (!$stuname) { $stuname=$ENV{'user.name'}; }
+     &devalidate($symb,$stuname,$domain);
      $symb=escape($symb);
      if (!$namespace) {
- Line 1463  sub store {
+ Line 1892  sub store {
            return '';
         }
      }
-     if (!$domain) { $domain=$ENV{'user.domain'}; }
-     if (!$stuname) { $stuname=$ENV{'user.name'}; }
      if (!$home) { $home=$ENV{'user.home'}; }
      my $namevalue='';
      foreach (keys %$storehash) {
- Line 1486  sub cstore {
+ Line 1913  sub cstore {
      $symb=&symbclean($symb);
      if (!$symb) { unless ($symb=&symbread()) { return ''; } }
-     &devalidate($symb);
+     if (!$domain) { $domain=$ENV{'user.domain'}; }
+     if (!$stuname) { $stuname=$ENV{'user.name'}; }
+     &devalidate($symb,$stuname,$domain);
      $symb=escape($symb);
      if (!$namespace) {
- Line 1494  sub cstore {
+ Line 1924  sub cstore {
            return '';
         }
      }
-     if (!$domain) { $domain=$ENV{'user.domain'}; }
-     if (!$stuname) { $stuname=$ENV{'user.name'}; }
      if (!$home) { $home=$ENV{'user.home'}; }
      my $namevalue='';
- Line 1600  sub rolesinit {
+ Line 2028  sub rolesinit {
              my ($trole,$tend,$tstart)=split(/_/,$role);
              $userroles.='user.role.'.$trole.'.'.$area.'='.
                          $tstart.'.'.$tend."\n";
+ # log the associated role with the area
+             &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
              if ($tend!=0) {
  	        if ($tend<$now) {
  	            $trole='';
- Line 1611  sub rolesinit {
+ Line 2041  sub rolesinit {
                  }
              }
              if (($area ne '') && ($trole ne '')) {
- 	       my $spec=$trole.'.'.$area;
+ 		my $spec=$trole.'.'.$area;
-                my ($tdummy,$tdomain,$trest)=split(/\//,$area);
+ 		my ($tdummy,$tdomain,$trest)=split(/\//,$area);
-                if ($trole =~ /^cr\//) {
+ 		if ($trole =~ /^cr\//) {
- 		   my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
+ 		    my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
-                    my $homsvr=homeserver($rauthor,$rdomain);
+  		    my $homsvr=homeserver($rauthor,$rdomain);
-                    if ($hostname{$homsvr} ne '') {
+ 		    if ($hostname{$homsvr} ne '') {
-                       my $roledef=
+ 			my ($rdummy,$roledef)=
- 			  reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
+ 			   &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
-                                 $homsvr);
-                       if (($roledef ne 'con_lost') && ($roledef ne '')) {
+ 			if (($rdummy ne 'con_lost') && ($roledef ne '')) {
-                          my ($syspriv,$dompriv,$coursepriv)=
+ 			    my ($syspriv,$dompriv,$coursepriv)=
- 			     split(/\_/,unescape($roledef));
+ 				split(/\_/,$roledef);
-  	                 $allroles{'cm./'}.=':'.$syspriv;
+ 			    if (defined($syspriv)) {
-                          $allroles{$spec.'./'}.=':'.$syspriv;
+ 				$allroles{'cm./'}.=':'.$syspriv;
-                          if ($tdomain ne '') {
+ 				$allroles{$spec.'./'}.=':'.$syspriv;
-                              $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
+ 			    }
-                              $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
+ 			    if ($tdomain ne '') {
-                              if ($trest ne '') {
+ 				if (defined($dompriv)) {
- 		                $allroles{'cm.'.$area}.=':'.$coursepriv;
+ 				    $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
- 		                $allroles{$spec.'.'.$area}.=':'.$coursepriv;
+ 				    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
-                              }
+ 				}
- 	                 }
+ 				if ($trest ne '') {
-                       }
+ 				    if (defined($coursepriv)) {
-                    }
+ 					$allroles{'cm.'.$area}.=':'.$coursepriv;
-                } else {
+ 					$allroles{$spec.'.'.$area}.=':'.$coursepriv;
- 	           $allroles{'cm./'}.=':'.$pr{$trole.':s'};
+ 				    }
- 	           $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
+ 				}
-                    if ($tdomain ne '') {
+ 			    }
-                      $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
+ 			}
-                      $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
+ 		    }
-                       if ($trest ne '') {
+ 		} else {
- 		          $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
+ 		    if (defined($pr{$trole.':s'})) {
- 		          $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
+ 			$allroles{'cm./'}.=':'.$pr{$trole.':s'};
-                       }
+ 			$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
- 	           }
+ 		    }
- 	       }
+ 		    if ($tdomain ne '') {
+ 			if (defined($pr{$trole.':d'})) {
+ 			    $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
+ 			    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
+ 			}
+ 			if ($trest ne '') {
+ 			    if (defined($pr{$trole.':c'})) {
+ 				$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
+ 				$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
+ 			    }
+ 			}
+ 		    }
+ 		}
              }
            }
          }
- Line 1744  sub dump {
+ Line 2186  sub dump {
     return %returnhash;
  }
+ # -------------------------------------------------------------- keys interface
+ sub getkeys {
+    my ($namespace,$udomain,$uname)=@_;
+    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+    if (!$uname) { $uname=$ENV{'user.name'}; }
+    my $uhome=&homeserver($uname,$udomain);
+    my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
+    my @keyarray=();
+    foreach (split(/\&/,$rep)) {
+       push (@keyarray,&unescape($_));
+    }
+    return @keyarray;
+ }
  # --------------------------------------------------------------- currentdump
  sub currentdump {
-    my ($namespace,$udomain,$uname)=@_;
+    my ($courseid,$sdom,$sname)=@_;
-    if (!$udomain) { $udomain = $ENV{'user.domain'}; }
+    $courseid = $ENV{'request.course.id'} if (! defined($courseid));
-    if (!$uname)   { $uname   = $ENV{'user.name'};   }
+    $sdom     = $ENV{'user.domain'}       if (! defined($sdom));
-    my $uhome = &homeserver($uname,$udomain);
+    $sname    = $ENV{'user.name'}         if (! defined($sname));
-    my $rep=reply("currentdump:$udomain:$uname:$namespace",$uhome);
+    my $uhome = &homeserver($sname,$sdom);
+    my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
     return if ($rep =~ /^(error:|no_such_host)/);
     #
     my %returnhash=();
- Line 1758  sub currentdump {
+ Line 2216  sub currentdump {
     if ($rep eq "unknown_cmd") {
         # an old lond will not know currentdump
         # Do a dump and make it look like a currentdump
-        my @tmp = &dump($namespace,$udomain,$uname,'.');
+        my @tmp = &dump($courseid,$sdom,$sname,'.');
         return if ($tmp[0] =~ /^(error:|no_such_host)/);
         my %hash = @tmp;
         @tmp=();
- Line 1848  sub eget {
+ Line 2306  sub eget {
     return %returnhash;
  }
+ # ---------------------------------------------- Custom access rule evaluation
+ sub customaccess {
+     my ($priv,$uri)=@_;
+     my ($urole,$urealm)=split(/\./,$ENV{'request.role'});
+     $urealm=~s/^\W//;
+     my ($udom,$ucrs,$usec)=split(/\//,$urealm);
+     my $access=0;
+     foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
+ 	my ($effect,$realm,$role)=split(/\:/,$_);
+         if ($role) {
+ 	   if ($role ne $urole) { next; }
+         }
+         foreach (split(/\s*\,\s*/,$realm)) {
+             my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
+             if ($tdom) {
+ 		if ($tdom ne $udom) { next; }
+             }
+             if ($tcrs) {
+ 		if ($tcrs ne $ucrs) { next; }
+             }
+             if ($tsec) {
+ 		if ($tsec ne $usec) { next; }
+             }
+             $access=($effect eq 'allow');
+             last;
+         }
+ 	if ($realm eq '' && $role eq '') {
+             $access=($effect eq 'allow');
+ 	}
+     }
+     return $access;
+ }
  # ------------------------------------------------- Check for a user privilege
  sub allowed {
- Line 1856  sub allowed {
+ Line 2348  sub allowed {
      my $orguri=$uri;
      $uri=&declutter($uri);
+     if (defined($ENV{'allowed.'.$priv})) { return $ENV{'allowed.'.$priv}; }
  # Free bre access to adm and meta resources
      if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
- Line 1886  sub allowed {
+ Line 2379  sub allowed {
              # Library role, so allow browsing of resources in this domain.
              return 'F';
          }
+         if ($copyright eq 'custom') {
+ 	    unless (&customaccess($priv,$uri)) { return ''; }
+         }
      }
      # Domain coordinator is trying to create a course
      if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
- Line 2103  sub allowed {
+ Line 2599  sub allowed {
     if ($thisallowed=~/R/) {
         my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
-        my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
+        if (&metadata($uri,'roledeny')=~/$rolecode/) {
-        if (-e $filename) {
+ 	  &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
-            my @content;
-            {
- 	     my $fh=Apache::File->new($filename);
-              @content=<$fh>;
- 	   }
-            if (join('',@content)=~
-                     /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
- 	       &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
                      'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
-            return '';
+           return '';
-            }
         }
     }
- Line 2147  sub is_on_map {
+ Line 2633  sub is_on_map {
      my $filename=$uriparts[$#uriparts];
      my $pathname=$uri;
      $pathname=~s|/\Q$filename\E$||;
+     $pathname=~s/^adm\/wrapper\///;
      #Trying to find the conditional for the file
      my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
  	       /\&\Q$filename\E\:([\d\|]+)\&/);
      if ($match) {
  	return (1,$1);
      } else {
- 	return (0,0);
+ 	my ($name,$ext)=($filename=~/^(.+)\.(\w+)$/);
+         $ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
+ 	       /\&(\Q$name\E\.\d+\.$ext)\:([\d\|]+)\&/;
+ 	return (0,$2,$pathname.'/'.$1);
      }
  }
- Line 2162  sub is_on_map {
+ Line 2652  sub is_on_map {
  sub definerole {
    if (allowed('mcr','/')) {
      my ($rolename,$sysrole,$domrole,$courole)=@_;
-     foreach (split('/',$sysrole)) {
+     foreach (split(':',$sysrole)) {
  	my ($crole,$cqual)=split(/\&/,$_);
          if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
          if ($pr{'cr:s'}=~/$crole\&/) {
- Line 2171  sub definerole {
+ Line 2661  sub definerole {
              }
          }
      }
-     foreach (split('/',$domrole)) {
+     foreach (split(':',$domrole)) {
  	my ($crole,$cqual)=split(/\&/,$_);
          if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
          if ($pr{'cr:d'}=~/$crole\&/) {
- Line 2180  sub definerole {
+ Line 2670  sub definerole {
              }
          }
      }
-     foreach (split('/',$courole)) {
+     foreach (split(':',$courole)) {
  	my ($crole,$cqual)=split(/\&/,$_);
          if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
          if ($pr{'cr:c'}=~/$crole\&/) {
- Line 2283  sub userlog_query {
+ Line 2773  sub userlog_query {
  sub plaintext {
      my $short=shift;
-     return $prp{$short};
+     return &mt($prp{$short});
  }
  # ----------------------------------------------------------------- Assign Role
  sub assignrole {
-     my ($udom,$uname,$url,$role,$end,$start)=@_;
+     my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
      my $mrole;
      if ($role =~ /^cr\//) {
- 	unless (&allowed('ccr',$url)) {
+         my $cwosec=$url;
+         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
+ 	unless (&allowed('ccr',$cwosec)) {
             &logthis('Refused custom assignrole: '.
               $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
  		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
- Line 2302  sub assignrole {
+ Line 2794  sub assignrole {
      } else {
          my $cwosec=$url;
          $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
-         unless (&allowed('c'.$role,$cwosec)) {
+         unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
             &logthis('Refused assignrole: '.
               $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
  		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
- Line 2320  sub assignrole {
+ Line 2812  sub assignrole {
             $command.='_0_'.$start;
          }
      }
-     return &reply($command,&homeserver($uname,$udom));
+ # actually delete
+     if ($deleteflag) {
+ 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
+ # modify command to delete the role
+            $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:".
+                 "$udom:$uname:$url".'_'."$mrole";
+ 	   &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom");
+ # set start and finish to negative values for userrolelog
+            $start=-1;
+            $end=-1;
+         }
+     }
+ # send command
+     my $answer=&reply($command,&homeserver($uname,$udom));
+ # log new user role if status is ok
+     if ($answer eq 'ok') {
+ 	&userrolelog($mrole,$uname,$udom,$url,$start,$end);
+     }
+     return $answer;
  }
  # -------------------------------------------------- Modify user authentication
- Line 2355  sub modifyuser {
+ Line 2865  sub modifyuser {
      my ($udom,    $uname, $uid,
          $umode,   $upass, $first,
          $middle,  $last,  $gene,
-         $forceid, $desiredhome)=@_;
+         $forceid, $desiredhome, $email)=@_;
      $udom=~s/\W//g;
      $uname=~s/\W//g;
      &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
- Line 2367  sub modifyuser {
+ Line 2877  sub modifyuser {
               ' in domain '.$ENV{'request.role.domain'});
      my $uhome=&homeserver($uname,$udom,'true');
  # ----------------------------------------------------------------- Create User
-     if (($uhome eq 'no_host') && ($umode) && ($upass)) {
+     if (($uhome eq 'no_host') &&
+ 	(($umode && $upass) || ($umode eq 'localauth'))) {
          my $unhome='';
          if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
              $unhome = $desiredhome;
- Line 2397  sub modifyuser {
+ Line 2908  sub modifyuser {
          }
          $uhome=&homeserver($uname,$udom,'true');
          if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
- 	    return 'error: verify home';
+ 	    return 'error: unable verify users home machine.';
          }
      }   # End of creation of new user
  # ---------------------------------------------------------------------- Add ID
- Line 2407  sub modifyuser {
+ Line 2918  sub modifyuser {
         if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
           && (!$forceid)) {
  	  unless ($uid eq $uidhash{$uname}) {
- 	      return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
+ 	      return 'error: user id "'.$uid.'" does not match '.
+                   'current user id "'.$uidhash{$uname}.'".';
            }
         } else {
  	  &idput($udom,($uname => $uid));
- Line 2423  sub modifyuser {
+ Line 2935  sub modifyuser {
      } else {
          %names = @tmp;
      }
+ #
+ # Make sure to not trash student environment if instructor does not bother
+ # to supply name and email information
+ #
      if ($first)  { $names{'firstname'}  = $first; }
-     if ($middle) { $names{'middlename'} = $middle; }
+     if (defined($middle)) { $names{'middlename'} = $middle; }
      if ($last)   { $names{'lastname'}   = $last; }
-     if ($gene)   { $names{'generation'} = $gene; }
+     if (defined($gene))   { $names{'generation'} = $gene; }
+     if ($email)  { $names{'notification'} = $email;
+                    $names{'critnotification'} = $email; }
      my $reply = &put('environment', \%names, $udom,$uname);
      if ($reply ne 'ok') { return 'error: '.$reply; }
      &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
- Line 2440  sub modifyuser {
+ Line 2959  sub modifyuser {
  sub modifystudent {
      my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
-         $end,$start,$forceid,$desiredhome)=@_;
+         $end,$start,$forceid,$desiredhome,$email)=@_;
      my $cid='';
      unless ($cid=$ENV{'request.course.id'}) {
  	return 'not_in_class';
- Line 2448  sub modifystudent {
+ Line 2967  sub modifystudent {
  # --------------------------------------------------------------- Make the user
      my $reply=&modifyuser
  	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
-          $desiredhome);
+          $desiredhome,$email);
      unless ($reply eq 'ok') { return $reply; }
      # This will cause &modify_student_enrollment to get the uid from the
      # students environment
- Line 2566  sub createcourse {
+ Line 3085  sub createcourse {
  	return 'error: no such course';
      }
  # ----------------------------------------------------------------- Course made
+ # log existance
+     &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description),
+                  $uhome);
+     &flushcourselogs();
+ # set toplevel url
      my $topurl=$url;
      unless ($nonstandard) {
  # ------------------------------------------ For standard courses, make top url
- Line 2594  ENDINITMAP
+ Line 3118  ENDINITMAP
  # ---------------------------------------------------------- Assign Custom Role
  sub assigncustomrole {
-     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
+     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
      return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
-                        $end,$start);
+                        $end,$start,$deleteflag);
  }
  # ----------------------------------------------------------------- Revoke Role
  sub revokerole {
-     my ($udom,$uname,$url,$role)=@_;
+     my ($udom,$uname,$url,$role,$deleteflag)=@_;
      my $now=time;
-     return &assignrole($udom,$uname,$url,$role,$now);
+     return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
  }
  # ---------------------------------------------------------- Revoke Custom Role
  sub revokecustomrole {
-     my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
+     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
      my $now=time;
-     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
+     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
+            $deleteflag);
  }
  # ------------------------------------------------------------ Directory lister
- Line 2677  sub dirlist {
+ Line 3202  sub dirlist {
          }
          my $alldomstr='';
          foreach (sort keys %alldom) {
-             $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
+             $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
          }
          $alldomstr=~s/:$//;
          return split(/:/,$alldomstr);
- Line 2693  sub dirlist {
+ Line 3218  sub dirlist {
  # when it was last modified.  It will also return an error of -1
  # if an error occurs
+ ##
+ ## FIXME: This subroutine assumes its caller knows something about the
+ ## directory structure of the home server for the student ($root).
+ ## Not a good assumption to make.  Since this is for looking up files
+ ## in user directories, the full path should be constructed by lond, not
+ ## whatever machine we request data from.
+ ##
  sub GetFileTimestamp {
      my ($studentDomain,$studentName,$filename,$root)=@_;
      $studentDomain=~s/\W//g;
- Line 2701  sub GetFileTimestamp {
+ Line 3233  sub GetFileTimestamp {
      $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
      my $proname="$studentDomain/$subdir/$studentName";
      $proname .= '/'.$filename;
-     my @dir = &Apache::lonnet::dirlist($proname, $studentDomain, $studentName,
+     my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
-                                        $root);
+                                               $studentName, $root);
-     my $fileStat = $dir[0];
      my @stats = split('&', $fileStat);
      if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
-         return $stats[9];
+         # @stats contains first the filename, then the stat output
+         return $stats[10]; # so this is 10 instead of 9.
      } else {
          return -1;
      }
- Line 2769  sub condval {
+ Line 3301  sub condval {
  sub devalidatecourseresdata {
      my ($coursenum,$coursedomain)=@_;
      my $hashid=$coursenum.':'.$coursedomain;
-     delete $courseresdatacache{$hashid.'.time'};
+     &devalidate_cache(\%courseresdatacache,$hashid);
  }
  # --------------------------------------------------- Course Resourcedata Query
- Line 2778  sub courseresdata {
+ Line 3310  sub courseresdata {
      my ($coursenum,$coursedomain,@which)=@_;
      my $coursehom=&homeserver($coursenum,$coursedomain);
      my $hashid=$coursenum.':'.$coursedomain;
-     my $dodump=0;
+     my ($result,$cached)=&is_cached(\%courseresdatacache,$hashid);
-     if (!defined($courseresdatacache{$hashid.'.time'})) {
+     unless (defined($cached)) {
- 	$dodump=1;
-     } else {
- 	if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
-     }
-     if ($dodump) {
  	my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
+ 	$result=\%dumpreply;
  	my ($tmp) = keys(%dumpreply);
  	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
- 	    $courseresdatacache{$hashid.'.time'}=time;
+ 	    &do_cache(\%courseresdatacache,$hashid,$result);
- 	    $courseresdatacache{$hashid}=\%dumpreply;
  	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
  	    return $tmp;
+ 	} elsif ($tmp =~ /^(error)/) {
+ 	    $result=undef;
+ 	    &do_cache(\%courseresdatacache,$hashid,$result);
  	}
      }
      foreach my $item (@which) {
- 	if (defined($courseresdatacache{$hashid}->{$item})) {
+ 	if (defined($result->{$item})) {
- 	    return $courseresdatacache{$hashid}->{$item};
+ 	    return $result->{$item};
  	}
      }
      return undef;
  }
- # --------------------------------------------------------- Value of a Variable
+ #
+ # EXT resource caching routines
+ #
+ sub clear_EXT_cache_status {
+     &delenv('cache.EXT.');
+ }
+ sub EXT_cache_status {
+     my ($target_domain,$target_user) = @_;
+     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
+     if (exists($ENV{$cachename}) && ($ENV{$cachename}+600) > time) {
+         # We know already the user has no data
+         return 1;
+     } else {
+         return 0;
+     }
+ }
+ sub EXT_cache_set {
+     my ($target_domain,$target_user) = @_;
+     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
+     &appenv($cachename => time);
+ }
+ # --------------------------------------------------------- Value of a Variable
  sub EXT {
-     my ($varname,$symbparm,$udom,$uname,)=@_;
+     my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
      unless ($varname) { return ''; }
      #get real user name/domain, courseid and symb
      my $courseid;
+     my $publicuser;
      if (!($uname && $udom)) {
-       (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
+       (my $cursymb,$courseid,$udom,$uname,$publicuser)=
+ 	  &Apache::lonxml::whichuser($symbparm);
        if (!$symbparm) {	$symbparm=$cursymb; }
      } else {
  	$courseid=$ENV{'request.course.id'};
- Line 2832  sub EXT {
+ Line 3387  sub EXT {
      if ($realm eq 'user') {
  # --------------------------------------------------------------- user.resource
  	if ($space eq 'resource') {
- 	    my %restored=&restore(undef,undef,$udom,$uname);
+ 	    if (defined($Apache::lonhomework::parsing_a_problem)) {
-             return $restored{$qualifierrest};
+ 		return $Apache::lonhomework::history{$qualifierrest};
+ 	    } else {
+ 		my %restored;
+ 		if ($publicuser || $ENV{'request.state'} eq 'construct') {
+ 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
+ 		} else {
+ 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
+ 		}
+ 		return $restored{$qualifierrest};
+ 	    }
  # ----------------------------------------------------------------- user.access
          } elsif ($space eq 'access') {
  	    # FIXME - not supporting calls for a specific user
- Line 2844  sub EXT {
+ Line 3408  sub EXT {
  		($udom eq $ENV{'user.domain'})) {
  		return $ENV{join('.',('environment',$qualifierrest))};
  	    } else {
- 		my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
+ 		my %returnhash;
+ 		if (!$publicuser) {
+ 		    %returnhash=&userenvironment($udom,$uname,
+ 						 $qualifierrest);
+ 		}
  		return $returnhash{$qualifierrest};
  	    }
  # ----------------------------------------------------------------- user.course
- Line 2868  sub EXT {
+ Line 3436  sub EXT {
              return $uname;
  # ---------------------------------------------------- Any other user namespace
          } else {
-             my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
+ 	    my %reply;
-             my %reply=&get($space,[$item]);
+ 	    if (!$publicuser) {
-             return $reply{$item};
+ 		%reply=&get($space,[$qualifierrest],$udom,$uname);
+ 	    }
+ 	    return $reply{$qualifierrest};
          }
      } elsif ($realm eq 'query') {
  # ---------------------------------------------- pull stuff out of query string
-         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},[$space]);
+         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
- 	return $ENV{'form.'.$space};
+ 						[$spacequalifierrest]);
+ 	return $ENV{'form.'.$spacequalifierrest};
     } elsif ($realm eq 'request') {
  # ------------------------------------------------------------- request.browser
          if ($space eq 'browser') {
- Line 2889  sub EXT {
+ Line 3460  sub EXT {
          return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
      } elsif ($realm eq 'resource') {
- 	if ($courseid eq $ENV{'request.course.id'}) {
+ 	my $section;
+ 	if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) {
  	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
  # ----------------------------------------------------- Cascading lookup scheme
  	    if (!$symbparm) { $symbparm=&symbread(); }
  	    my $symbp=$symbparm;
- 	    my $mapp=(split(/\_\_\_/,$symbp))[0];
+ 	    my $mapp=(&decode_symb($symbp))[0];
  	    my $symbparm=$symbp.'.'.$spacequalifierrest;
  	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
- 	    my $section;
  	    if (($ENV{'user.name'} eq $uname) &&
  		($ENV{'user.domain'} eq $udom)) {
  		$section=$ENV{'request.course.sec'};
  	    } else {
- 		$section=&usection($udom,$uname,$courseid);
+                 if (! defined($usection)) {
+                     $section=&usection($udom,$uname,$courseid);
+                 } else {
+                     $section = $usection;
+                 }
  	    }
  	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
- Line 2918  sub EXT {
+ Line 3493  sub EXT {
  	    my $courselevelm=$courseid.'.'.$mapparm;
  # ----------------------------------------------------------- first, check user
- 	    #most student don't have any data set, check if there is some data
+ 	    #most student don\'t have any data set, check if there is some data
-             #every thirty minutes
+ 	    if (! &EXT_cache_status($udom,$uname)) {
- 	    if (!
+ 		my $hashid="$udom:$uname";
- 		(exists($ENV{'cache.studentresdata'})
+ 		my ($result,$cached)=&is_cached(\%userresdatacache,$hashid);
- 		    && (($ENV{'cache.studentresdata'}+1800) > time))) {
+ 		if (!defined($cached)) {
- 		my %resourcedata=&get('resourcedata',
+ 		    my %resourcedata=&get('resourcedata',
- 				      [$courselevelr,$courselevelm,$courselevel],
+ 					  [$courselevelr,$courselevelm,
- 				      $udom,$uname);
+ 					   $courselevel],$udom,$uname);
- 		my ($tmp)=keys(%resourcedata);
+ 		    $result=\%resourcedata;
+ 		}
+ 		my ($tmp)=keys(%$result);
  		if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
- 		    if ($resourcedata{$courselevelr}) {
+ 		    &do_cache(\%userresdatacache,$hashid,$result);
- 			return $resourcedata{$courselevelr}; }
+ 		    if ($$result{$courselevelr}) {
- 		    if ($resourcedata{$courselevelm}) {
+ 			return $$result{$courselevelr}; }
- 			return $resourcedata{$courselevelm}; }
+ 		    if ($$result{$courselevelm}) {
- 		    if ($resourcedata{$courselevel}) {
+ 			return $$result{$courselevelm}; }
- 			return $resourcedata{$courselevel}; }
+ 		    if ($$result{$courselevel}) {
+ 			return $$result{$courselevel}; }
  		} else {
  		    if ($tmp!~/No such file/) {
  			&logthis("<font color=blue>WARNING:".
  				 " Trying to get resource data for ".
  				 $uname." at ".$udom.": ".
  				 $tmp."</font>");
+ 			&do_cache(\%userresdatacache,$hashid,undef);
  		    } elsif ($tmp=~/error:No such file/) {
- 			$ENV{'cache.studentresdata'}=time;
+                         &EXT_cache_set($udom,$uname);
- 			&appenv(('cache.studentresdata'=>
- 				 $ENV{'cache.studentresdata'}));
  		    } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
+ 			&do_cache(\%userresdatacache,$hashid,undef);
  			return $tmp;
  		    }
  		}
- Line 2976  sub EXT {
+ Line 3554  sub EXT {
  	my $filename;
  	if (!$symbparm) { $symbparm=&symbread(); }
  	if ($symbparm) {
- 	    $filename=(split(/\_\_\_/,$symbparm))[2];
+ 	    $filename=(&decode_symb($symbparm))[2];
  	} else {
  	    $filename=$ENV{'request.filename'};
  	}
- Line 2987  sub EXT {
+ Line 3565  sub EXT {
  # ------------------------------------------------------------------ Cascade up
  	unless ($space eq '0') {
- 	    my ($part,$id)=split(/\_/,$space);
+ 	    my @parts=split(/_/,$space);
- 	    if ($id) {
+ 	    my $id=pop(@parts);
- 		my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
+ 	    my $part=join('_',@parts);
- 				     $symbparm,$udom,$uname);
+ 	    if ($part eq '') { $part='0'; }
- 		if (defined($partgeneral)) { return $partgeneral; }
+ 	    my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
- 	    } else {
+ 				 $symbparm,$udom,$uname,$section,1);
- 		my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
+ 	    if (defined($partgeneral)) { return $partgeneral; }
- 					 $symbparm,$udom,$uname);
- 		if (defined($resourcegeneral)) { return $resourcegeneral; }
- 	    }
  	}
+ 	if ($recurse) { return undef; }
+ 	my $pack_def=&packages_tab_default($filename,$varname);
+ 	if (defined($pack_def)) { return $pack_def; }
  # ---------------------------------------------------- Any other user namespace
      } elsif ($realm eq 'environment') {
- Line 3018  sub EXT {
+ Line 3596  sub EXT {
      return '';
  }
+ sub packages_tab_default {
+     my ($uri,$varname)=@_;
+     my (undef,$part,$name)=split(/\./,$varname);
+     my $packages=&metadata($uri,'packages');
+     foreach my $package (split(/,/,$packages)) {
+ 	my ($pack_type,$pack_part)=split(/_/,$package,2);
+ 	if ($pack_part eq $part) {
+ 	    return $packagetab{"$pack_type&$name&default"};
+ 	}
+     }
+     return undef;
+ }
+ sub add_prefix_and_part {
+     my ($prefix,$part)=@_;
+     my $keyroot;
+     if (defined($prefix) && $prefix !~ /^__/) {
+ 	# prefix that has a part already
+ 	$keyroot=$prefix;
+     } elsif (defined($prefix)) {
+ 	# prefix that is missing a part
+ 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
+     } else {
+ 	# no prefix at all
+ 	if (defined($part)) { $keyroot='_'.$part; }
+     }
+     return $keyroot;
+ }
  # ---------------------------------------------------------------- Get metadata
  sub metadata {
- Line 3043  sub metadata {
+ Line 3650  sub metadata {
          if ($liburi) {
  	    $liburi=&declutter($liburi);
              $filename=$liburi;
-         }
+         } else {
+ 	    delete($metacache{$uri.':packages'});
+ 	}
          my %metathesekeys=();
          unless ($filename=~/\.meta$/) { $filename.='.meta'; }
- 	my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
+ 	my $metastring=&getfile(&filelocation('',&clutter($filename)));
          my $parser=HTML::LCParser->new(\$metastring);
          my $token;
          undef %metathesekeys;
          while ($token=$parser->get_token) {
-            if ($token->[0] eq 'S') {
+ 	    if ($token->[0] eq 'S') {
- 	     if (defined($token->[2]->{'package'})) {
+ 		if (defined($token->[2]->{'package'})) {
  #
  # This is a package - get package info
  #
- 	      my $package=$token->[2]->{'package'};
+ 		    my $package=$token->[2]->{'package'};
- 	      my $keyroot='';
+ 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
-               if ($prefix) {
+ 		    if (defined($token->[2]->{'id'})) {
- 		  $keyroot.=$prefix;
+ 			$keyroot.='_'.$token->[2]->{'id'};
-               } else {
+ 		    }
-                 if (defined($token->[2]->{'part'})) {
+ 		    if ($metacache{$uri.':packages'}) {
-                    $keyroot.='_'.$token->[2]->{'part'};
+ 			$metacache{$uri.':packages'}.=','.$package.$keyroot;
- 	        }
+ 		    } else {
- 	      }
+ 			$metacache{$uri.':packages'}=$package.$keyroot;
-               if (defined($token->[2]->{'id'})) {
+ 		    }
-                  $keyroot.='_'.$token->[2]->{'id'};
+ 		    foreach (keys %packagetab) {
- 	      }
+ 			if ($_=~/^$package\&/) {
-               if ($metacache{$uri.':packages'}) {
+ 			    my ($pack,$name,$subp)=split(/\&/,$_);
-                  $metacache{$uri.':packages'}.=','.$package.$keyroot;
+ 			    # ignore package.tab specified default values
-               } else {
+                             # here &package_tab_default() will fetch those
-                  $metacache{$uri.':packages'}=$package.$keyroot;
+ 			    if ($subp eq 'default') { next; }
- 	      }
+ 			    my $value=$packagetab{$_};
-               foreach (keys %packagetab) {
+ 			    my $part=$keyroot;
- 		  if ($_=~/^$package\&/) {
+ 			    $part=~s/^\_//;
- 		      my ($pack,$name,$subp)=split(/\&/,$_);
+ 			    if ($subp eq 'display') {
-                       my $value=$packagetab{$_};
+ 				$value.=' [Part: '.$part.']';
- 		      my $part=$keyroot;
+ 			    }
-                       $part=~s/^\_//;
+ 			    my $unikey='parameter'.$keyroot.'_'.$name;
-                       if ($subp eq 'display') {
+ 			    $metacache{$uri.':'.$unikey.'.part'}=$part;
- 			  $value.=' [Part: '.$part.']';
+ 			    $metathesekeys{$unikey}=1;
-                       }
+ 			    unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
-                       my $unikey='parameter'.$keyroot.'_'.$name;
+ 				$metacache{$uri.':'.$unikey.'.'.$subp}=$value;
-                       $metathesekeys{$unikey}=1;
+ 			    }
-                       $metacache{$uri.':'.$unikey.'.part'}=$part;
+ 			    if (defined($metacache{$uri.':'.$unikey.'.default'})) {
-                       unless
+ 				$metacache{$uri.':'.$unikey}=
-                        (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
+ 				    $metacache{$uri.':'.$unikey.'.default'};
-                          $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
+ 			    }
- 		      }
+ 			}
-                   }
+ 		    }
-               }
+ 		} else {
-              } else {
  #
  # This is not a package - some other kind of start tag
  #
-               my $entry=$token->[1];
+ 		    my $entry=$token->[1];
-               my $unikey;
+ 		    my $unikey;
-               if ($entry eq 'import') {
+ 		    if ($entry eq 'import') {
-                  $unikey='';
+ 			$unikey='';
-               } else {
+ 		    } else {
-                  $unikey=$entry;
+ 			$unikey=$entry;
- 	      }
+ 		    }
-               if ($prefix) {
+ 		    $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
- 		  $unikey.=$prefix;
-               } else {
+ 		    if (defined($token->[2]->{'id'})) {
-                 if (defined($token->[2]->{'part'})) {
+ 			$unikey.='_'.$token->[2]->{'id'};
-                    $unikey.='_'.$token->[2]->{'part'};
+ 		    }
- 	        }
- 	      }
-               if (defined($token->[2]->{'id'})) {
-                  $unikey.='_'.$token->[2]->{'id'};
- 	      }
-              if ($entry eq 'import') {
+ 		    if ($entry eq 'import') {
  #
  # Importing a library here
  #
-                  if ($depthcount<20) {
+ 			if ($depthcount<20) {
- 		     my $location=$parser->get_text('/import');
+ 			    my $location=$parser->get_text('/import');
- 		     my $dir=$filename;
+ 			    my $dir=$filename;
- 		     $dir=~s|[^/]*$||;
+ 			    $dir=~s|[^/]*$||;
- 		     $location=&filelocation($dir,$location);
+ 			    $location=&filelocation($dir,$location);
- 		     foreach (sort(split(/\,/,&metadata($uri,'keys',
+ 			    foreach (sort(split(/\,/,&metadata($uri,'keys',
- 							$location,$unikey,
+ 							       $location,$unikey,
- 							$depthcount+1)))) {
+ 							       $depthcount+1)))) {
-                          $metathesekeys{$_}=1;
+ 				$metathesekeys{$_}=1;
- 		     }
+ 			    }
- 		 }
+ 			}
-              } else {
+ 		    } else {
-               if (defined($token->[2]->{'name'})) {
+ 			if (defined($token->[2]->{'name'})) {
-                  $unikey.='_'.$token->[2]->{'name'};
+ 			    $unikey.='_'.$token->[2]->{'name'};
- 	      }
+ 			}
-               $metathesekeys{$unikey}=1;
+ 			$metathesekeys{$unikey}=1;
-               foreach (@{$token->[3]}) {
+ 			foreach (@{$token->[3]}) {
- 		  $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
+ 			    $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
-               }
+ 			}
-               unless (
+ 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
-                  $metacache{$uri.':'.$unikey}=&HTML::Entities::decode($parser->get_text('/'.$entry))
+ 			my $default=$metacache{$uri.':'.$unikey.'.default'};
- 		      ) { $metacache{$uri.':'.$unikey}=
+ 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
- 			      $metacache{$uri.':'.$unikey.'.default'};
+ 		 # only ws inside the tag, and not in default, so use default
- 		      }
+ 		 # as value
+ 			    $metacache{$uri.':'.$unikey}=$default;
+ 			} else {
+ 		  # either something interesting inside the tag or default
+                   # uninteresting
+ 			    $metacache{$uri.':'.$unikey}=$internaltext;
+ 			}
  # end of not-a-package not-a-library import
- 	   }
+ 		    }
  # end of not-a-package start tag
- 	  }
+ 		}
  # the next is the end of "start tag"
- 	 }
+ 	    }
-        }
+ 	}
-        $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
+ # are there custom rights to evaluate
+ 	if ($metacache{$uri.':copyright'} eq 'custom') {
+     #
+     # Importing a rights file here
+     #
+ 	    unless ($depthcount) {
+ 		my $location=$metacache{$uri.':customdistributionfile'};
+ 		my $dir=$filename;
+ 		$dir=~s|[^/]*$||;
+ 		$location=&filelocation($dir,$location);
+ 		foreach (sort(split(/\,/,&metadata($uri,'keys',
+ 						   $location,'_rights',
+ 						   $depthcount+1)))) {
+ 		    $metathesekeys{$_}=1;
+ 		}
+ 	    }
+ 	}
+ 	$metacache{$uri.':keys'}=join(',',keys %metathesekeys);
  	&metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
-        $metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
+ 	$metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
-        $metacache{$uri.':cachedtimestamp'}=time;
+ 	$metacache{$uri.':cachedtimestamp'}=time;
  # this is the end of "was not already recently cached
      }
      return $metacache{$uri.':'.$what};
- Line 3165  sub metadata_generate_part0 {
+ Line 3792  sub metadata_generate_part0 {
  	if ($metakey=~/^parameter\_(.*)/) {
  	  my $part=$$metacache{$uri.':'.$metakey.'.part'};
  	  my $name=$$metacache{$uri.':'.$metakey.'.name'};
- 	  if (! exists($$metadata{'parameter_0_'.$name})) {
+ 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
  	    $allnames{$name}=$part;
  	  }
  	}
- Line 3195  sub gettitle {
+ Line 3822  sub gettitle {
  	unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
          return &metadata($urlsymb,'title');
      }
-     if ($titlecache{$symb}) { return $titlecache{$symb}; }
+     my ($result,$cached)=&is_cached(\%titlecache,$symb,600);
-     my ($map,$resid,$url)=split(/\_\_\_/,$symb);
+     if (defined($cached)) { return $result; }
+     my ($map,$resid,$url)=&decode_symb($symb);
      my $title='';
      my %bighash;
      if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
- Line 3205  sub gettitle {
+ Line 3833  sub gettitle {
          $title=$bighash{'title_'.$mapid.'.'.$resid};
          untie %bighash;
      }
+     $title=~s/\&colon\;/\:/gs;
      if ($title) {
-         $titlecache{$symb}=$title;
+         return &do_cache(\%titlecache,$symb,$title);
-         return $title;
      } else {
  	return &metadata($urlsymb,'title');
      }
- Line 3241  sub symbverify {
+ Line 3869  sub symbverify {
  # direct jump to resource in page or to a sequence - will construct own symbs
      if ($thisfn=~/\.(page|sequence)$/) { return 1; }
  # check URL part
-     my ($map,$resid,$url)=split(/\_\_\_/,$symb);
+     my ($map,$resid,$url)=&decode_symb($symb);
      unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
      $symb=&symbclean($symb);
- Line 3284  sub symbclean {
+ Line 3912  sub symbclean {
      return $symb;
  }
+ # ---------------------------------------------- Split symb to find map and url
+ sub decode_symb {
+     my ($map,$resid,$url)=split(/\_\_\_/,shift);
+     return (&fixversion($map),$resid,&fixversion($url));
+ }
+ sub fixversion {
+     my $fn=shift;
+     if ($fn=~/^(adm|uploaded|public)/) { return $fn; }
+     my ($match,$cond,$versioned)=&is_on_map($fn);
+     unless ($match) {
+ 	$fn=$versioned;
+     }
+     return $fn;
+ }
  # ------------------------------------------------------ Return symb list entry
  sub symbread {
- Line 3378  sub numval {
+ Line 4023  sub numval {
      $txt=~tr/u-z/0-5/;
      $txt=~s/\D//g;
      return int($txt);
  }
+ sub latest_rnd_algorithm_id {
+     return '64bit';
+ }
  sub rndseed {
      my ($symb,$courseid,$domain,$username)=@_;
+     my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
      if (!$symb) {
-       unless ($symb=&symbread()) { return time; }
+ 	unless ($symb=$wsymb) { return time; }
+     }
+     if (!$courseid) { $courseid=$wcourseid; }
+     if (!$domain) { $domain=$wdomain; }
+     if (!$username) { $username=$wusername }
+     my $which=$ENV{"course.$courseid.rndseed"};
+     my $CODE=$ENV{'scantron.CODE'};
+     if (defined($CODE)) {
+ 	&rndseed_CODE_64bit($symb,$courseid,$domain,$username);
+     } elsif ($which eq '64bit') {
+ 	return &rndseed_64bit($symb,$courseid,$domain,$username);
+     }
+     return &rndseed_32bit($symb,$courseid,$domain,$username);
+ }
+ sub rndseed_32bit {
+     my ($symb,$courseid,$domain,$username)=@_;
+     {
+ 	use integer;
+ 	my $symbchck=unpack("%32C*",$symb) << 27;
+ 	my $symbseed=numval($symb) << 22;
+ 	my $namechck=unpack("%32C*",$username) << 17;
+ 	my $nameseed=numval($username) << 12;
+ 	my $domainseed=unpack("%32C*",$domain) << 7;
+ 	my $courseseed=unpack("%32C*",$courseid);
+ 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
+ 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
+ 	#&Apache::lonxml::debug("rndseed :$num:$symb");
+ 	return $num;
+     }
+ }
+ sub rndseed_64bit {
+     my ($symb,$courseid,$domain,$username)=@_;
+     {
+ 	use integer;
+ 	my $symbchck=unpack("%32S*",$symb) << 21;
+ 	my $symbseed=numval($symb) << 10;
+ 	my $namechck=unpack("%32S*",$username);
+ 	my $nameseed=numval($username) << 21;
+ 	my $domainseed=unpack("%32S*",$domain) << 10;
+ 	my $courseseed=unpack("%32S*",$courseid);
+ 	my $num1=$symbchck+$symbseed+$namechck;
+ 	my $num2=$nameseed+$domainseed+$courseseed;
+ 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
+ 	#&Apache::lonxml::debug("rndseed :$num:$symb");
+ 	return "$num1,$num2";
      }
-     if (!$courseid) { $courseid=$ENV{'request.course.id'};}
+ }
-     if (!$domain) {$domain=$ENV{'user.domain'};}
-     if (!$username) {$username=$ENV{'user.name'};}
+ sub rndseed_CODE_64bit {
+     my ($symb,$courseid,$domain,$username)=@_;
      {
-       use integer;
+ 	use integer;
-       my $symbchck=unpack("%32C*",$symb) << 27;
+ 	my $symbchck=unpack("%32S*",$symb) << 16;
-       my $symbseed=numval($symb) << 22;
+ 	my $symbseed=numval($symb);
-       my $namechck=unpack("%32C*",$username) << 17;
+ 	my $CODEseed=numval($ENV{'scantron.CODE'}) << 16;
-       my $nameseed=numval($username) << 12;
+ 	my $courseseed=unpack("%32S*",$courseid);
-       my $domainseed=unpack("%32C*",$domain) << 7;
+ 	my $num1=$symbseed+$CODEseed;
-       my $courseseed=unpack("%32C*",$courseid);
+ 	my $num2=$courseseed+$symbchck;
-       my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
+ 	#&Apache::lonxml::debug("$symbseed:$CODEseed|$courseseed:$symbchck");
-       #uncommenting these lines can break things!
+ 	#&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
-       #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
+ 	return "$num1,$num2";
-       #&Apache::lonxml::debug("rndseed :$num:$symb");
+     }
-       return $num;
+ }
+ sub setup_random_from_rndseed {
+     my ($rndseed)=@_;
+     if ($rndseed =~/,/) {
+ 	my ($num1,$num2)=split(/,/,$rndseed);
+ 	&Math::Random::random_set_seed(abs($num1),abs($num2));
+     } else {
+ 	&Math::Random::random_set_seed_from_phrase($rndseed);
      }
  }
- Line 3520  sub unescape {
+ Line 4228  sub unescape {
      return $str;
  }
+ sub mod_perl_version {
+     if (defined($perlvar{'MODPERL2'})) {
+ 	return 2;
+     }
+     return 1;
+ }
  # ================================================================ Main Program
  sub goodbye {
     &logthis("Starting Shut down");
     &flushcourselogs();
     &logthis("Shutting down");
+    return DONE;
  }
  BEGIN {
- Line 3554  BEGIN {
+ Line 4269  BEGIN {
      }
  }
+ # ------------------------------------------------------------ Read domain file
+ {
+     my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
+                             '/domain.tab');
+     %domaindescription = ();
+     %domain_auth_def = ();
+     %domain_auth_arg_def = ();
+     if ($fh) {
+        while (<$fh>) {
+            next if (/^(\#|\s*$)/);
+ #           next if /^\#/;
+            chomp;
+            my ($domain, $domain_description, $def_auth, $def_auth_arg,
+ 	       $def_lang, $city, $longi, $lati) = split(/:/,$_);
+ 	   $domain_auth_def{$domain}=$def_auth;
+            $domain_auth_arg_def{$domain}=$def_auth_arg;
+ 	   $domaindescription{$domain}=$domain_description;
+ 	   $domain_lang_def{$domain}=$def_lang;
+ 	   $domain_city{$domain}=$city;
+ 	   $domain_longi{$domain}=$longi;
+ 	   $domain_lati{$domain}=$lati;
+ #          &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
+ #          &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
+        }
+     }
+ }
  # ------------------------------------------------------------- Read hosts file
  {
      my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
- Line 3567  BEGIN {
+ Line 4311  BEGIN {
  	 $hostdom{$id}=$domain;
  	 $hostip{$id}=$ip;
  	 $iphost{$ip}=$id;
- 	 if ($domdescr) { $domaindescription{$domain}=$domdescr; }
  	 if ($role eq 'library') { $libserv{$id}=$name; }
         } else {
  	 if ($configline) {
- Line 3629  BEGIN {
+ Line 4372  BEGIN {
      }
  }
+ # ------------- set up temporary directory
+ {
+     $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
+ }
  %metacache=();
  $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
- Line 3678  being set.
+ Line 4427  being set.
  =back
- =head1 INTRODUCTION
+ =head1 OVERVIEW
- This module provides subroutines which interact with the
+ lonnet provides subroutines which interact with the
- lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about
+ lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
- - classes
+ about classes, users, and resources.
- - users
- - resources
  For many of these objects you can also use this to store data about
  them or modify them in various ways.
- This is part of the LearningOnline Network with CAPA project
+ =head2 Symbs
- described at http://www.lon-capa.org.
- =head1 RETURN MESSAGES
+ To identify a specific instance of a resource, LON-CAPA uses symbols
+ or "symbs"X<symb>. These identifiers are built from the URL of the
+ map, the resource number of the resource in the map, and the URL of
+ the resource itself. The latter is somewhat redundant, but might help
+ if maps change.
- =over 4
+ An example is
- =item *
+  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
- con_lost : unable to contact remote host
+ The respective map entry is
- =item *
+  <resource id="19" src="/res/msu/korte/tests/part12.problem"
+   title="Problem 2">
+  </resource>
- con_delayed : unable to contact remote host, message will be delivered
+ Symbs are used by the random number generator, as well as to store and
- when the connection is brought back up
+ restore data specific to a certain instance of for example a problem.
- =item *
+ =head2 Storing And Retrieving Data
- con_failed : unable to contact remote host and unable to save message
+ X<store()>X<cstore()>X<restore()>Three of the most important functions
- for later delivery
+ in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
+ C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
+ is is the non-critical message twin of cstore. These functions are for
+ handlers to store a perl hash to a user's permanent data space in an
+ easy manner, and to retrieve it again on another call. It is expected
+ that a handler would use this once at the beginning to retrieve data,
+ and then again once at the end to send only the new data back.
- =item *
+ The data is stored in the user's data directory on the user's
+ homeserver under the ID of the course.
- error: : an error a occured, a description of the error follows the :
+ The hash that is returned by restore will have all of the previous
+ value for all of the elements of the hash.
- =item *
+ Example:
+  #creating a hash
+  my %hash;
+  $hash{'foo'}='bar';
+  #storing it
+  &Apache::lonnet::cstore(\%hash);
- no_such_host : unable to fund a host associated with the user/domain
+  #changing a value
+  $hash{'foo'}='notbar';
+  #adding a new value
+  $hash{'bar'}='foo';
+  &Apache::lonnet::cstore(\%hash);
+  #retrieving the hash
+  my %history=&Apache::lonnet::restore();
+  #print the hash
+  foreach my $key (sort(keys(%history))) {
+    print("\%history{$key} = $history{$key}");
+  }
+ Will print out:
+  %history{1:foo} = bar
+  %history{1:keys} = foo:timestamp
+  %history{1:timestamp} = 990455579
+  %history{2:bar} = foo
+  %history{2:foo} = notbar
+  %history{2:keys} = foo:bar:timestamp
+  %history{2:timestamp} = 990455580
+  %history{bar} = foo
+  %history{foo} = notbar
+  %history{timestamp} = 990455580
+  %history{version} = 2
+ Note that the special hash entries C<keys>, C<version> and
+ C<timestamp> were added to the hash. C<version> will be equal to the
+ total number of versions of the data that have been stored. The
+ C<timestamp> attribute will be the UNIX time the hash was
+ stored. C<keys> is available in every historical section to list which
+ keys were added or changed at a specific historical revision of a
+ hash.
+ B<Warning>: do not store the hash that restore returns directly. This
+ will cause a mess since it will restore the historical keys as if the
+ were new keys. I.E. 1:foo will become 1:1:foo etc.
+ Calling convention:
+  my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
+  &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
+ For more detailed information, see lonnet specific documentation.
+ =head1 RETURN MESSAGES
+ =over 4
+ =item * B<con_lost>: unable to contact remote host
+ =item * B<con_delayed>: unable to contact remote host, message will be delivered
+ when the connection is brought back up
+ =item * B<con_failed>: unable to contact remote host and unable to save message
+ for later delivery
+ =item * B<error:>: an error a occured, a description of the error follows the :
+ =item * B<no_such_host>: unable to fund a host associated with the user/domain
  that was requested
  =back
- Line 3727  that was requested
+ Line 4556  that was requested
  =over 4
  =item *
+ X<appenv()>
- appenv(%hash) : the value of %hash is written to the user envirnoment
+ B<appenv(%hash)>: the value of %hash is written to
- file, and will be restored for each access this user makes during this
+ the user envirnoment file, and will be restored for each access this
- session, also modifies the %ENV for the current process
+ user makes during this session, also modifies the %ENV for the current
+ process
  =item *
+ X<delenv()>
- delenv($regexp) : removes all items from the session environment file that matches the regular expression in $regexp. The values are also delted from the current processes %ENV.
+ B<delenv($regexp)>: removes all items from the session
+ environment file that matches the regular expression in $regexp. The
+ values are also delted from the current processes %ENV.
  =back
- Line 3744  delenv($regexp) : removes all items from
+ Line 4576  delenv($regexp) : removes all items from
  =over 4
  =item *
+ X<queryauthenticate()>
- queryauthenticate($uname,$udom) : try to determine user's current
+ B<queryauthenticate($uname,$udom)>: try to determine user's current
  authentication scheme
  =item *
+ X<authenticate()>
- authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
+ B<authenticate($uname,$upass,$udom)>: try to
- servers (first use the current one), $upass should be the users password
+ authenticate user from domain's lib servers (first use the current
+ one). C<$upass> should be the users password.
  =item *
+ X<homeserver()>
- homeserver($uname,$udom) : find the server which has the user's
+ B<homeserver($uname,$udom)>: find the server which has
- directory and files (there must be only one), this caches the answer,
+ the user's directory and files (there must be only one), this caches
- and also caches if there is a borken connection.
+ the answer, and also caches if there is a borken connection.
  =item *
+ X<idget()>
- idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
+ B<idget($udom,@ids)>: find the usernames behind a list of IDs
- unique resource in a domain, there must be only 1 ID per username, and
+ (IDs are a unique resource in a domain, there must be only 1 ID per
- only 1 username per ID in a specific domain) (returns hash:
+ username, and only 1 username per ID in a specific domain) (returns
- id=>name,id=>name)
+ hash: id=>name,id=>name)
  =item *
+ X<idrget()>
- idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
+ B<idrget($udom,@unames)>: find the IDs behind a list of
- name=>id,name=>id)
+ usernames (returns hash: name=>id,name=>id)
  =item *
+ X<idput()>
- idput($udom,%ids) : store away a list of names and associated IDs
+ B<idput($udom,%ids)>: store away a list of names and associated IDs
  =item *
+ X<rolesinit()>
- rolesinit($udom,$username,$authhost) : get user privileges
+ B<rolesinit($udom,$username,$authhost)>: get user privileges
  =item *
+ X<usection()>
- usection($udom,$uname,$cname) : finds the section of student in the
+ B<usection($udom,$uname,$cname)>: finds the section of student in the
  course $cname, return section name/number or '' for "not in course"
  and '-1' for "no section"
  =item *
+ X<userenvironment()>
- userenvironment($udom,$uname,@what) : gets the values of the keys
+ B<userenvironment($udom,$uname,@what)>: gets the values of the keys
  passed in @what from the requested user's environment, returns a hash
  =back

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

Removed from v.1.320
changed lines
	Added in v.1.421