--- loncom/lonnet/perl/lonnet.pm	2001/01/11 11:11:27	1.97
+++ loncom/lonnet/perl/lonnet.pm	2001/04/17 13:53:26	1.123
@@ -3,6 +3,9 @@
 #
 # Functions for use by content handlers:
 #
+# metadata_query(sql-query-string,custom-metadata-regex) : 
+#                                    returns file handle of where sql and
+#                                    regex results will be stored for query
 # plaintext(short)   : plain text explanation of short term
 # fileembstyle(ext)  : embed style in page for file extension
 # filedescription(ext) : descriptor text for file extension
@@ -13,7 +16,7 @@
 #                      1: user needs to choose course
 #                      2: browse allowed
 # definerole(rolename,sys,dom,cou) : define a custom role rolename
-#                      set priviledges in format of lonTabs/roles.tab for
+#                      set privileges in format of lonTabs/roles.tab for
 #                      system, domain and course level, 
 # assignrole(udom,uname,url,role,end,start) : give a role to a user for the
 #                      level given by url. Optional start and end dates
@@ -25,9 +28,18 @@
 # revokecustomrole (udom,uname,url,rdom,rnam,rolename) : Revoke a custom role
 # appenv(hash)       : adds hash to session environment
 # delenv(varname)    : deletes all environment entries starting with varname
-# store(hash)        : stores hash permanently for this url
-# cstore(hash)       : critical store
-# restore            : returns hash for this url
+# store(hashref,symb,courseid,udom,uname,homeserver)
+#                    : stores hash permanently for this url
+#                      hashref needs to be given, and should be a \%hashname
+#                      the remaining args aren't required and if they aren't
+#                      passed or are '' they will be derived from the ENV
+# cstore(hashref,symb,courseid,udom,uname,homeserver)
+#                    : same as store but uses the critical interface to 
+#                      guarentee a store
+# restore(symb,courseid,udom,uname,homeserver)
+#                    : returns hash for this symb, all args are optional
+#                      if they aren't given they will be derived from the current
+#                      enviroment
 # eget(namesp,array) : returns hash with keys from array filled in from namesp
 # get(namesp,array)  : returns hash with keys from array filled in from namesp
 # del(namesp,array)  : deletes keys out of array from namesp
@@ -49,7 +61,7 @@
 # receipt()          : returns a receipt to be given out to users 
 # getfile(filename)  : returns the contents of filename, or a -1 if it can't
 #                      be found, replicates and subscribes to the file
-# filelocation(dir,file) : returns a farily clean absolute reference to file 
+# filelocation(dir,file) : returns a fairly clean absolute reference to file 
 #                          from the directory dir
 # hreflocation(dir,file) : same as filelocation, but for hrefs
 # log(domain,user,home,msg) : write to permanent log for user
@@ -86,6 +98,11 @@
 # 05/01,06/01,09/01 Gerd Kortemeyer
 # 09/01 Guy Albertelli
 # 09/01,10/01,11/01 Gerd Kortemeyer
+# 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
 
 package Apache::lonnet;
 
@@ -622,52 +639,108 @@ sub log {
     return critical("log:$dom:$nam:$what",$hom);
 }
 
+# --------------------------------------------- Set Expire Date for Spreadsheet
+
+sub expirespread {
+    my ($uname,$udom,$stype,$usymb)=@_;
+    my $cid=$ENV{'request.course.id'}; 
+    if ($cid) {
+       my $now=time;
+       my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
+       return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
+                            $ENV{'course.'.$cid.'.num'}.
+	        	    ':nohist_expirationdates:'.
+                            &escape($key).'='.$now,
+                            $ENV{'course.'.$cid.'.home'})
+    }
+    return 'ok';
+}
+
+# ----------------------------------------------------- Devalidate Spreadsheets
+
+sub devalidate {
+    my $symb=shift;
+    my $cid=$ENV{'request.course.id'}; 
+    if ($cid) {
+	my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
+        my $status=
+          &reply('del:'.$ENV{'course.'.$cid.'.domain'}.':'.
+                        $ENV{'course.'.$cid.'.num'}.
+	                ':nohist_calculatedsheets:'.
+                        &escape($key.'studentcalc:'),
+                        $ENV{'course.'.$cid.'.home'})
+          .' '.
+          &reply('del:'.$ENV{'user.domain'}.':'.
+                        $ENV{'user.name'}.
+		        ':nohist_calculatedsheets_'.$cid.':'.
+                        &escape($key.'assesscalc:'.$symb),
+                        $ENV{'user.home'});
+        unless ($status eq 'ok ok') {
+           &logthis('Could not devalidate spreadsheet '.
+                    $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
+		    $symb.': '.$status);
+        } 
+    }
+}
+
 # ----------------------------------------------------------------------- Store
 
 sub store {
-    my %storehash=@_;
-    my $symb;
-    unless ($symb=escape(&symbread())) { return ''; }
-    my $namespace;
-    unless ($namespace=$ENV{'request.course.id'}) { return ''; }
+    my ($storehash,$symb,$namespace,$domain,$stuname,$home) = @_;
+    if (!$symb) { unless ($symb=&symbread()) { return ''; } }
+
+    &devalidate($symb);
+
+    $symb=escape($symb);
+    if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
+    if (!$domain) { $domain=$ENV{'user.domain'}; }
+    if (!$stuname) { $stuname=$ENV{'user.name'}; }
+    if (!$home) { $home=$ENV{'user.home'}; }
     my $namevalue='';
     map {
-        $namevalue.=escape($_).'='.escape($storehash{$_}).'&';
-    } keys %storehash;
+        $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
+    } keys %$storehash;
     $namevalue=~s/\&$//;
-    return reply(
-     "store:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb:$namevalue",
-		 "$ENV{'user.home'}");
+    return critical("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
 }
 
 # -------------------------------------------------------------- Critical Store
 
 sub cstore {
-    my %storehash=@_;
-    my $symb;
-    unless ($symb=escape(&symbread())) { return ''; }
-    my $namespace;
-    unless ($namespace=$ENV{'request.course.id'}) { return ''; }
+    my ($storehash,$symb,$namespace,$domain,$stuname,$home) = @_;
+    if (!$symb) { unless ($symb=&symbread()) { return ''; } }
+
+    &devalidate($symb);
+
+    $symb=escape($symb);
+    if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
+    if (!$domain) { $domain=$ENV{'user.domain'}; }
+    if (!$stuname) { $stuname=$ENV{'user.name'}; }
+    if (!$home) { $home=$ENV{'user.home'}; }
+
     my $namevalue='';
     map {
-        $namevalue.=escape($_).'='.escape($storehash{$_}).'&';
-    } keys %storehash;
+        $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
+    } keys %$storehash;
     $namevalue=~s/\&$//;
-    return critical(
-     "store:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb:$namevalue",
-		 "$ENV{'user.home'}");
+    return critical("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
 }
 
 # --------------------------------------------------------------------- Restore
 
 sub restore {
-    my $symb;
-    unless ($symb=escape(&symbread())) { return ''; }
-    my $namespace;
-    unless ($namespace=$ENV{'request.course.id'}) { return ''; }
-    my $answer=reply(
-              "restore:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb",
-              "$ENV{'user.home'}");
+    my ($symb,$namespace,$domain,$stuname,$home) = @_;
+    if (!$symb) {
+      unless ($symb=escape(&symbread())) { return ''; }
+    } else {
+      $symb=&escape($symb);
+    }
+    if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
+    if (!$domain) { $domain=$ENV{'user.domain'}; }
+    if (!$stuname) { $stuname=$ENV{'user.name'}; }
+    if (!$home) { $home=$ENV{'user.home'}; }
+    my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
+
     my %returnhash=();
     map {
 	my ($name,$value)=split(/\=/,$_);
@@ -719,7 +792,7 @@ sub coursedescription {
     return ();
 }
 
-# -------------------------------------------------------- Get user priviledges
+# -------------------------------------------------------- Get user privileges
 
 sub rolesinit {
     my ($domain,$username,$authhost)=@_;
@@ -793,12 +866,12 @@ sub rolesinit {
             %thesepriv=();
             map {
                 if ($_ ne '') {
-		    my ($priviledge,$restrictions)=split(/&/,$_);
+		    my ($privilege,$restrictions)=split(/&/,$_);
                     if ($restrictions eq '') {
-			$thesepriv{$priviledge}='F';
+			$thesepriv{$privilege}='F';
                     } else {
-                        if ($thesepriv{$priviledge} ne 'F') {
-			    $thesepriv{$priviledge}.=$restrictions;
+                        if ($thesepriv{$privilege} ne 'F') {
+			    $thesepriv{$privilege}.=$restrictions;
                         }
                     }
                 }
@@ -908,7 +981,7 @@ sub eget {
    return %returnhash;
 }
 
-# ------------------------------------------------- Check for a user priviledge
+# ------------------------------------------------- Check for a user privilege
 
 sub allowed {
     my ($priv,$uri)=@_;
@@ -959,7 +1032,7 @@ sub allowed {
 	return $thisallowed;
     }
 #
-# Gathered so far: system, domain and course wide priviledges
+# Gathered so far: system, domain and course wide privileges
 #
 # Course: See if uri or referer is an individual resource that is part of 
 # the course
@@ -1010,7 +1083,7 @@ sub allowed {
    }
 
 #
-# Gathered now: all priviledges that could apply, and condition number
+# Gathered now: all privileges that could apply, and condition number
 # 
 #
 # Full or no access?
@@ -1180,6 +1253,27 @@ sub definerole {
   }
 }
 
+# ---------------- Make a metadata query against the network of library servers
+
+sub metadata_query {
+    my ($query,$custom,$customshow)=@_;
+    # need to put in a library server loop here and return a hash
+    my %rhash;
+    for my $server (keys %libserv) {
+	unless ($custom or $customshow) {
+	    my $reply=&reply("querysend:".&escape($query),$server);
+	    $rhash{$server}=$reply;
+	}
+	else {
+	    my $reply=&reply("querysend:".&escape($query).':'.
+			     &escape($custom).':'.&escape($customshow),
+			     $server);
+	    $rhash{$server}=$reply;
+	}
+    }
+    return \%rhash;
+}
+
 # ------------------------------------------------------------------ Plain Text
 
 sub plaintext {
@@ -1207,12 +1301,22 @@ sub assignrole {
     my ($udom,$uname,$url,$role,$end,$start)=@_;
     my $mrole;
     if ($role =~ /^cr\//) {
-	unless (&allowed('ccr',$url)) { return 'refused'; }
+	unless (&allowed('ccr',$url)) {
+           &logthis('Refused custom assignrole: '.
+             $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
+		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
+           return 'refused'; 
+        }
         $mrole='cr';
     } else {
         my $cwosec=$url;
         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
-        unless (&allowed('c'.$role,$cwosec)) { return 'refused'; }
+        unless (&allowed('c'.$role,$cwosec)) { 
+           &logthis('Refused assignrole: '.
+             $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
+		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
+           return 'refused'; 
+        }
         $mrole=$role;
     }
     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
@@ -1543,7 +1647,7 @@ sub EXT {
     if ($realm eq 'user') {
 # --------------------------------------------------------------- user.resource
 	if ($space eq 'resource') {
-	    my %restored=&restore;
+	    my %restored=&restore();
             return $restored{$qualifierrest};
 # ----------------------------------------------------------------- user.access
         } elsif ($space eq 'access') {
@@ -1843,16 +1947,20 @@ sub numval {
 sub rndseed {
     my $symb;
     unless ($symb=&symbread()) { return time; }
-    my $symbchck=unpack("%32C*",$symb);
-    my $symbseed=numval($symb)%$symbchck;
-    my $namechck=unpack("%32C*",$ENV{'user.name'});
-    my $nameseed=numval($ENV{'user.name'})%$namechck;
-    return int( $symbseed
-	       .$nameseed
-               .unpack("%32C*",$ENV{'user.domain'})
-               .unpack("%32C*",$ENV{'request.course.id'})
-               .$namechck
-               .$symbchck);
+    { 
+      use integer;
+      my $symbchck=unpack("%32C*",$symb) << 27;
+      my $symbseed=numval($symb) << 22;
+      my $namechck=unpack("%32C*",$ENV{'user.name'}) << 17;
+      my $nameseed=numval($ENV{'user.name'}) << 12;
+      my $domainseed=unpack("%32C*",$ENV{'user.domain'}) << 7;
+      my $courseseed=unpack("%32C*",$ENV{'request.course.id'});
+      my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
+      #uncommenting these lines can break things!
+      #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
+      #&Apache::lonxml::debug("rndseed :$num:$symb");
+      return $num;
+    }
 }
 
 sub ireceipt {