--- loncom/lonnet/perl/lonnet.pm	2001/03/15 13:40:20	1.105
+++ loncom/lonnet/perl/lonnet.pm	2001/07/27 20:17:14	1.134
@@ -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
@@ -25,15 +28,39 @@
 # 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
-# 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
-# put(namesp,hash)   : stores hash in namesp
-# cput(namesp,hash)  : critical put
-# dump(namesp)       : dumps the complete namespace into a hash
+# store(hashref,symb,courseid,udom,uname)
+#                    : 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)
+#                    : same as store but uses the critical interface to 
+#                      guarentee a store
+# restore(symb,courseid,udom,uname)
+#                    : returns hash for this symb, all args are optional
+#                      if they aren't given they will be derived from the 
+#                      current enviroment
+#
+#
+# for the next 6 functions udom and uname are optional
+#         if supplied they use udom as the domain and uname
+#         as the username for the function (supply a courseid
+#         for the uname if you want a course database)
+#         if not supplied it uses %ENV and looks at 
+#         user. attribute for the values
+#
+# eget(namesp,arrayref,udom,uname)
+#                    : returns hash with keys from array  reference filled
+#                      in from namesp (encrypts the return communication)
+# get(namesp,arrayref,udom,uname)
+#                    : returns hash with keys from array  reference filled
+#                      in from namesp
+# dump(namesp,udom,uname) : dumps the complete namespace into a hash
+# del(namesp,array,udom,uname)  : deletes keys out of array from namesp
+# put(namesp,hash,udom,uname)   : stores hash in namesp
+# cput(namesp,hash,udom,uname)  : critical put
+#
+#
 # ssi(url,hash)      : does a complete request cycle on url to localhost, posts
 #                      hash
 # coursedescription(id) : returns and caches course description for id
@@ -49,7 +76,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
@@ -88,7 +115,13 @@
 # 09/01,10/01,11/01 Gerd Kortemeyer
 # 02/27/01 Scott Harrison
 # 3/2 Gerd Kortemeyer
-# 3/15 Scott Harrison
+# 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
+#
 
 package Apache::lonnet;
 
@@ -625,52 +658,122 @@ 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=
+	    &del('nohist_calculatedsheet',
+		 [$key.'studentcalc'],
+		 $ENV{'course.'.$cid.'.domain'},
+		 $ENV{'course.'.$cid.'.num'})
+		.' '.
+	    &del('nohist_calculatedsheets_'.$cid,
+		 [$key.'assesscalc:'.$symb]);
+        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) = @_;
+    my $home='';
+
+    if ($stuname) {
+	$home=&homeserver($stuname,$domain);
+    }
+
+    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 reply("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) = @_;
+    my $home='';
+
+    if ($stuname) {
+	$home=&homeserver($stuname,$domain);
+    }
+
+    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) = @_;
+    my $home='';
+
+    if ($stuname) {
+	$home=&homeserver($stuname,$domain);
+    }
+
+    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(/\=/,$_);
@@ -692,22 +795,18 @@ sub coursedescription {
     $courseid=~s/^\///;
     $courseid=~s/\_/\//g;
     my ($cdomain,$cnum)=split(/\//,$courseid);
-    my $chome=homeserver($cnum,$cdomain);
+    my $chome=&homeserver($cnum,$cdomain);
     if ($chome ne 'no_host') {
-       my $rep=reply("dump:$cdomain:$cnum:environment",$chome);
-       if ($rep ne 'con_lost') {
+       my %returnhash=&dump('environment',$cdomain,$cnum);
+       if (!exists($returnhash{'con_lost'})) {
            my $normalid=$cdomain.'_'.$cnum;
            my %envhash=();
-           my %returnhash=('home'   => $chome, 
-                           'domain' => $cdomain,
-                           'num'    => $cnum);
-           map {
-               my ($name,$value)=split(/\=/,$_);
-               $name=&unescape($name);
-               $value=&unescape($value);
-               $returnhash{$name}=$value;
+           $returnhash{'home'}= $chome;
+	   $returnhash{'domain'} = $cdomain;
+	   $returnhash{'num'} = $cnum;
+           while (my ($name,$value) = each %returnhash) {
                $envhash{'course.'.$normalid.'.'.$name}=$value;
-           } split(/\&/,$rep);
+           }
            $returnhash{'url'}='/res/'.declutter($returnhash{'url'});
            $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
 	       $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
@@ -792,8 +891,12 @@ sub rolesinit {
             }
           } 
         } split(/&/,$rolesdump);
+        my $adv=0;
+        my $author=0;
         map {
             %thesepriv=();
+            if ($_!~/^st/) { $adv=1; }
+            if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
             map {
                 if ($_ ne '') {
 		    my ($privilege,$restrictions)=split(/&/,$_);
@@ -810,6 +913,9 @@ sub rolesinit {
             map { $thesestr.=':'.$_.'&'.$thesepriv{$_}; } keys %thesepriv;
             $userroles.='user.priv.'.$_.'='.$thesestr."\n";
         } keys %allroles;            
+        $userroles.='user.adv='.$adv."\n".
+	            'user.author='.$author."\n";
+        $ENV{'user.adv'}=$adv;
     }
     return $userroles;  
 }
@@ -817,43 +923,51 @@ sub rolesinit {
 # --------------------------------------------------------------- get interface
 
 sub get {
-   my ($namespace,@storearr)=@_;
+   my ($namespace,$storearr,$udomain,$uname)=@_;
    my $items='';
    map {
        $items.=escape($_).'&';
-   } @storearr;
+   } @$storearr;
    $items=~s/\&$//;
- my $rep=reply("get:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
-                 $ENV{'user.home'});
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
+
+   my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
    my @pairs=split(/\&/,$rep);
    my %returnhash=();
    my $i=0;
    map {
       $returnhash{$_}=unescape($pairs[$i]);
       $i++;
-   } @storearr;
+   } @$storearr;
    return %returnhash;
 }
 
 # --------------------------------------------------------------- del interface
 
 sub del {
-   my ($namespace,@storearr)=@_;
+   my ($namespace,$storearr,$udomain,$uname)=@_;
    my $items='';
    map {
        $items.=escape($_).'&';
-   } @storearr;
+   } @$storearr;
    $items=~s/\&$//;
-   return reply("del:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
-                 $ENV{'user.home'});
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
+
+   return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
 }
 
 # -------------------------------------------------------------- dump interface
 
 sub dump {
-   my $namespace=shift;
-   my $rep=reply("dump:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace",
-                $ENV{'user.home'});
+   my ($namespace,$udomain,$uname)=@_;
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
+   my $rep=reply("dump:$udomain:$uname:$namespace",$uhome);
    my @pairs=split(/\&/,$rep);
    my %returnhash=();
    map {
@@ -866,48 +980,53 @@ sub dump {
 # --------------------------------------------------------------- put interface
 
 sub put {
-   my ($namespace,%storehash)=@_;
+   my ($namespace,$storehash,$udomain,$uname)=@_;
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
    my $items='';
    map {
-       $items.=escape($_).'='.escape($storehash{$_}).'&';
-   } keys %storehash;
+       $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
+   } keys %$storehash;
    $items=~s/\&$//;
-   return reply("put:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
-                 $ENV{'user.home'});
+   return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
 }
 
 # ------------------------------------------------------ critical put interface
 
 sub cput {
-   my ($namespace,%storehash)=@_;
+   my ($namespace,$storehash,$udomain,$uname)=@_;
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
    my $items='';
    map {
-       $items.=escape($_).'='.escape($storehash{$_}).'&';
-   } keys %storehash;
+       $items.=escape($_).'='.escape($$storehash{$_}).'&';
+   } keys %$storehash;
    $items=~s/\&$//;
-   return critical
-           ("put:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
-                 $ENV{'user.home'});
+   return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
 }
 
 # -------------------------------------------------------------- eget interface
 
 sub eget {
-   my ($namespace,@storearr)=@_;
+   my ($namespace,$storearr,$udomain,$uname)=@_;
    my $items='';
    map {
        $items.=escape($_).'&';
-   } @storearr;
+   } @$storearr;
    $items=~s/\&$//;
- my $rep=reply("eget:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
-                 $ENV{'user.home'});
+   if (!$udomain) { $udomain=$ENV{'user.domain'}; }
+   if (!$uname) { $uname=$ENV{'user.name'}; }
+   my $uhome=&homeserver($uname,$udomain);
+   my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
    my @pairs=split(/\&/,$rep);
    my %returnhash=();
    my $i=0;
    map {
       $returnhash{$_}=unescape($pairs[$i]);
       $i++;
-   } @storearr;
+   } @$storearr;
    return %returnhash;
 }
 
@@ -1186,8 +1305,22 @@ sub definerole {
 # ---------------- Make a metadata query against the network of library servers
 
 sub metadata_query {
-    my ($query)=@_;
-    my $reply=&metadata_query("querysend:$query",'msul3');
+    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
@@ -1302,27 +1435,20 @@ sub modifyuser {
        }
     }
 # -------------------------------------------------------------- Add names, etc
-    my $names=&reply('get:'.$udom.':'.$uname.
-                     ':environment:firstname&middlename&lastname&generation',
-                     $uhome);
-    my ($efirst,$emiddle,$elast,$egene)=split(/\&/,$names);
-    if ($first)  { $efirst  = &escape($first); }
-    if ($middle) { $emiddle = &escape($middle); }
-    if ($last)   { $elast   = &escape($last); }
-    if ($gene)   { $egene   = &escape($gene); }
-    my $reply=&reply('put:'.$udom.':'.$uname.
-           ':environment:firstname='.$efirst.
-                      '&middlename='.$emiddle.
-                        '&lastname='.$elast.
-                      '&generation='.$egene,$uhome);
-    if ($reply ne 'ok') {
-	return 'error: '.$reply;
-    }
+    my %names=&get('environment',
+		   ['firstname','middlename','lastname','generation'],
+		   $udom,$uname);
+    if ($first)  { $names{'firstname'}  = $first; }
+    if ($middle) { $names{'middlename'} = $middle; }
+    if ($last)   { $names{'lastname'}   = $last; }
+    if ($gene)   { $names{'generation'} = $gene; }
+    my $reply = &put('environment', \%names, $udom,$uname);
+    if ($reply ne 'ok') { return 'error: '.$reply; }
     &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
              $umode.', '.$first.', '.$middle.', '.
 	     $last.', '.$gene.' by '.
              $ENV{'user.name'}.' at '.$ENV{'user.domain'});
-    return 'ok'; 
+    return 'ok';
 }
 
 # -------------------------------------------------------------- Modify student
@@ -1563,7 +1689,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') {
@@ -1591,7 +1717,7 @@ sub EXT {
 # ---------------------------------------------------- Any other user namespace
         } else {
             my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
-            my %reply=&get($space,$item);
+            my %reply=&get($space,[$item]);
             return $reply{$item};
         }
     } elsif ($realm eq 'request') {
@@ -1604,49 +1730,45 @@ sub EXT {
         }
     } elsif ($realm eq 'course') {
 # ---------------------------------------------------------- course.description
-        my $section='';
-        if ($ENV{'request.course.sec'}) {
-	    $section='_'.$ENV{'request.course.sec'};
-        }
-        return $ENV{'course.'.$ENV{'request.course.id'}.$section.'.'.
+        return $ENV{'course.'.$ENV{'request.course.id'}.'.'.
                               $spacequalifierrest};
     } elsif ($realm eq 'resource') {
-      if ($ENV{'request.course.id'}) {
+       if ($ENV{'request.course.id'}) {
 # ----------------------------------------------------- Cascading lookup scheme
-       my $symbp=&symbread();
-       my $mapp=(split(/\_\_\_/,$symbp))[0];
+         my $symbp=&symbread();
+         my $mapp=(split(/\_\_\_/,$symbp))[0];
 
-       my $symbparm=$symbp.'.'.$spacequalifierrest;
-       my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
+         my $symbparm=$symbp.'.'.$spacequalifierrest;
+         my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
 
-       my $seclevel=
+         my $seclevel=
             $ENV{'request.course.id'}.'.['.
 		$ENV{'request.course.sec'}.'].'.$spacequalifierrest;
-       my $seclevelr=
+         my $seclevelr=
             $ENV{'request.course.id'}.'.['.
 		$ENV{'request.course.sec'}.'].'.$symbparm;
-       my $seclevelm=
+         my $seclevelm=
             $ENV{'request.course.id'}.'.['.
 		$ENV{'request.course.sec'}.'].'.$mapparm;
 
-       my $courselevel=
+         my $courselevel=
             $ENV{'request.course.id'}.'.'.$spacequalifierrest;
-       my $courselevelr=
+         my $courselevelr=
             $ENV{'request.course.id'}.'.'.$symbparm;
-       my $courselevelm=
+         my $courselevelm=
             $ENV{'request.course.id'}.'.'.$mapparm;
 
 # ----------------------------------------------------------- first, check user
-      my %resourcedata=get('resourcedata',
-                           ($courselevelr,$courselevelm,$courselevel));
-      if (($resourcedata{$courselevelr}!~/^error\:/) &&
-          ($resourcedata{$courselevelr}!~/^con_lost/)) {
-
-       if ($resourcedata{$courselevelr}) { 
-          return $resourcedata{$courselevelr}; }
-       if ($resourcedata{$courselevelm}) { 
-          return $resourcedata{$courselevelm}; }
-       if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
+         my %resourcedata=get('resourcedata',
+                           [$courselevelr,$courselevelm,$courselevel]);
+         if (($resourcedata{$courselevelr}!~/^error\:/) &&
+             ($resourcedata{$courselevelr}!~/^con_lost/)) {
+
+         if ($resourcedata{$courselevelr}) { 
+            return $resourcedata{$courselevelr}; }
+         if ($resourcedata{$courselevelm}) { 
+            return $resourcedata{$courselevelm}; }
+         if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
 
       } else {
 	  if ($resourcedata{$courselevelr}!~/No such file/) {
@@ -1704,7 +1826,7 @@ sub EXT {
 # ---------------------------------------------------- Any other user namespace
     } elsif ($realm eq 'environment') {
 # ----------------------------------------------------------------- environment
-        return $ENV{$spacequalifierrest};
+        return $ENV{'environment.'.$spacequalifierrest};
     } elsif ($realm eq 'system') {
 # ----------------------------------------------------------------- system.time
 	if ($space eq 'time') {