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.197 and 1.264

-version 1.197, 2002/01/04 16:31:41
+version 1.264, 2002/08/08 20:33:50
  Line 66
  # 12/18 Scott Harrison
  # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
  # YEAR=2002
- # 1/4 Gerd Kortemeyer
+ # 1/4,2/4,2/7 Gerd Kortemeyer
  #
  ###
  Line 77  use Apache::File;
  use LWP::UserAgent();
  use HTTP::Headers;
  use vars
- qw(%perlvar %hostname %homecache %hostip %spareid %hostdom
+ qw(%perlvar %hostname %homecache %badServerCache %hostip %spareid %hostdom
     %libserv %pr %prp %metacache %packagetab
     %courselogs %accesshash $processmarker $dumpcount
-    %coursedombuf %coursehombuf);
+    %coursedombuf %coursehombuf %courseresdatacache %domaindescription);
  use IO::Socket;
  use GDBM_File;
  use Apache::Constants qw(:common :http);
- use HTML::TokeParser;
+ use HTML::LCParser;
  use Fcntl qw(:flock);
  my $readit;
  Line 137  sub subreply {
  sub reply {
      my ($cmd,$server)=@_;
+     unless (defined($hostname{$server})) { return 'no_such_host'; }
      my $answer=subreply($cmd,$server);
-     if ($answer eq 'con_lost') { $answer=subreply($cmd,$server); }
+     if ($answer eq 'con_lost') {
+        #sleep 5;
+        #$answer=subreply($cmd,$server);
+        #if ($answer eq 'con_lost') {
+ 	#   &logthis("Second attempt con_lost on $server");
+         #   my $peerfile="$perlvar{'lonSockDir'}/$server";
+         #   my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
+         #                                    Type    => SOCK_STREAM,
+         #                                    Timeout => 10)
+         #              or return "con_lost";
+         #   &logthis("Killing socket");
+         #   print $client "close_connection_exit\n";
+            #sleep 5;
+         #   $answer=subreply($cmd,$server);
+        #}
+     }
      if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
         &logthis("<font color=blue>WARNING:".
                  " $cmd to $server returned $answer</font>");
- Line 348  sub spareserver {
+ Line 364  sub spareserver {
      return $spareserver;
  }
+ # --------------------------------------------- Try to change a user's password
+ sub changepass {
+     my ($uname,$udom,$currentpass,$newpass,$server)=@_;
+     $currentpass = &escape($currentpass);
+     $newpass     = &escape($newpass);
+     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
+ 		       $server);
+     if (! $answer) {
+ 	&logthis("No reply on password change request to $server ".
+ 		 "by $uname in domain $udom.");
+     } elsif ($answer =~ "^ok") {
+         &logthis("$uname in $udom successfully changed their password ".
+ 		 "on $server.");
+     } elsif ($answer =~ "^pwchange_failure") {
+ 	&logthis("$uname in $udom was unable to change their password ".
+ 		 "on $server.  The action was blocked by either lcpasswd ".
+ 		 "or pwchange");
+     } elsif ($answer =~ "^non_authorized") {
+         &logthis("$uname in $udom did not get their password correct when ".
+ 		 "attempting to change it on $server.");
+     } elsif ($answer =~ "^auth_mode_error") {
+         &logthis("$uname in $udom attempted to change their password despite ".
+ 		 "not being locally or internally authenticated on $server.");
+     } elsif ($answer =~ "^unknown_user") {
+         &logthis("$uname in $udom attempted to change their password ".
+ 		 "on $server but were unable to because $server is not ".
+ 		 "their home server.");
+     } elsif ($answer =~ "^refused") {
+ 	&logthis("$server refused to change $uname in $udom password because ".
+ 		 "it was sent an unencrypted request to change the password.");
+     }
+     return $answer;
+ }
  # ----------------------- Try to determine user's current authentication scheme
  sub queryauthenticate {
- Line 391  sub queryauthenticate {
+ Line 442  sub queryauthenticate {
  sub authenticate {
      my ($uname,$upass,$udom)=@_;
      $upass=escape($upass);
+     $uname=~s/\W//g;
      if (($perlvar{'lonRole'} eq 'library') &&
          ($udom eq $perlvar{'lonDefDomain'})) {
      my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
- Line 429  sub authenticate {
+ Line 481  sub authenticate {
  # ---------------------- Find the homebase for a user from domain's lib servers
  sub homeserver {
-     my ($uname,$udom)=@_;
+     my ($uname,$udom,$ignoreBadCache)=@_;
      my $index="$uname:$udom";
-     if ($homecache{$index}) { return "$homecache{$index}"; }
+     if ($homecache{$index}) {
+         return "$homecache{$index}";
+     }
      my $tryserver;
      foreach $tryserver (keys %libserv) {
+         next if ($ignoreBadCache ne 'true' &&
+ 		 exists($badServerCache{$tryserver}));
  	if ($hostdom{$tryserver} eq $udom) {
             my $answer=reply("home:$udom:$uname",$tryserver);
             if ($answer eq 'found') {
- 	      $homecache{$index}=$tryserver;
+               $homecache{$index}=$tryserver;
                return $tryserver;
- 	   }
+            } elsif ($answer eq 'no_host') {
+ 	       $badServerCache{$tryserver}=1;
+            }
         }
      }
      return 'no_host';
- Line 552  sub userenvironment {
+ Line 608  sub userenvironment {
      return %returnhash;
  }
+ # -------------------------------------------------------------------- New chat
+ sub chatsend {
+     my ($newentry,$anon)=@_;
+     my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
+     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
+     my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
+     &reply('chatsend:'.$cdom.':'.$cnum.':'.
+ 	   &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
+ 		   &escape($newentry)),$chome);
+ }
  # ----------------------------- Subscribe to a resource, return URL if possible
  sub subscribe {
- Line 575  sub subscribe {
+ Line 643  sub subscribe {
  sub repcopy {
      my $filename=shift;
      $filename=~s/\/+/\//g;
+     if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
      my $transname="$filename.in.transfer";
      if ((-e $filename) || (-e $transname)) { return OK; }
      my $remoteurl=subscribe($filename);
- Line 640  sub ssi {
+ Line 709  sub ssi {
      if (%form) {
        $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
-       $request->content(join '&', map { "$_=$form{$_}" } keys %form);
+       $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
      } else {
        $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
      }
- Line 651  sub ssi {
+ Line 720  sub ssi {
      return $response->content;
  }
+ # ------- Add a token to a remote URI's query string to vouch for access rights
+ sub tokenwrapper {
+     my $uri=shift;
+     $uri=~s/^http\:\/\/([^\/]+)//;
+     $uri=~s/^\///;
+     $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
+     my $token=$1;
+     if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
+ 	&appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
+         return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
+                (($uri=~/\?/)?'&':'?').'token='.$token;
+     } else {
+ 	return '/adm/notfound.html';
+     }
+ }
+ # --------------- Take an uploaded file and put it into the userfiles directory
+ # input: name of form element, coursedoc=1 means this is for the course
+ # output: url of file in userspace
+ sub userfileupload {
+     my ($formname,$coursedoc)=@_;
+     my $fname=$ENV{'form.'.$formname.'.filename'};
+     $fname=~s/\\/\//g;
+     $fname=~s/^.*\/([^\/]+)$/$1/;
+     unless ($fname) { return 'error: no uploaded file'; }
+     chop($ENV{'form.'.$formname});
+ # Create the directory if not present
+     my $docuname='';
+     my $docudom='';
+     my $docuhome='';
+     if ($coursedoc) {
+ 	$docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
+ 	$docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
+ 	$docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
+     } else {
+         $docuname=$ENV{'user.name'};
+         $docudom=$ENV{'user.domain'};
+         $docuhome=$ENV{'user.home'};
+     }
+     my $path=$docudom.'/'.$docuname.'/';
+     my $filepath=$perlvar{'lonDocRoot'};
+     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
+     my $count;
+     for ($count=4;$count<=$#parts;$count++) {
+         $filepath.="/$parts[$count]";
+         if ((-e $filepath)!=1) {
+ 	    mkdir($filepath,0777);
+         }
+     }
+ # Save the file
+     {
+        my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
+        print $fh $ENV{'form.'.$formname};
+     }
+ # Notify homeserver to grep it
+ #
+     if
+ (&reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome) eq 'ok')
+     {
+ #
+ # Return the URL to it
+         return '/uploaded/'.$path.$fname;
+     } else {
+         return '/adm/notfound.html';
+     }
+ }
  # ------------------------------------------------------------------------- Log
  sub log {
- Line 742  sub checkout {
+ Line 880  sub checkout {
      my $now=time;
      my $lonhost=$perlvar{'lonHostID'};
      my $infostr=&escape(
+                  'CHECKOUTTOKEN&'.
                   $tuname.'&'.
                   $tudom.'&'.
                   $tcrsid.'&'.
- Line 791  sub checkin {
+ Line 930  sub checkin {
      $lonhost=~tr/A-Z/a-z/;
      my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
      $dtoken=~s/\W/\_/g;
-     my ($tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
+     my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
                   split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
      unless (($tuname) && ($tudom)) {
- Line 861  sub devalidate {
+ Line 1000  sub devalidate {
      }
  }
+ sub arrayref2str {
+   my ($arrayref) = @_;
+   my $result='_ARRAY_REF__';
+   foreach my $elem (@$arrayref) {
+     if (ref($elem) eq 'ARRAY') {
+       $result.=&escape(&arrayref2str($elem)).'&';
+     } elsif (ref($elem) eq 'HASH') {
+       $result.=&escape(&hashref2str($elem)).'&';
+     } elsif (ref($elem)) {
+       &logthis("Got a ref of ".(ref($elem))." skipping.");
+     } else {
+       $result.=&escape($elem).'&';
+     }
+   }
+   $result=~s/\&$//;
+   return $result;
+ }
  sub hash2str {
-   my (%hash)=@_;
+   my (%hash) = @_;
-   my $result='';
+   my $result=&hashref2str(\%hash);
-   foreach (keys %hash) { $result.=escape($_).'='.escape($hash{$_}).'&'; }
+   $result=~s/^_HASH_REF__//;
+   return $result;
+ }
+ sub hashref2str {
+   my ($hashref)=@_;
+   my $result='_HASH_REF__';
+   foreach (keys(%$hashref)) {
+     if (ref($_) eq 'ARRAY') {
+       $result.=&escape(&arrayref2str($_)).'=';
+     } elsif (ref($_) eq 'HASH') {
+       $result.=&escape(&hashref2str($_)).'=';
+     } elsif (ref($_)) {
+       &logthis("Got a ref of ".(ref($_))." skipping.");
+     } else {
+       $result.=&escape($_).'=';
+     }
+     if (ref($$hashref{$_}) eq 'ARRAY') {
+       $result.=&escape(&arrayref2str($$hashref{$_})).'&';
+     } elsif (ref($$hashref{$_}) eq 'HASH') {
+       $result.=&escape(&hashref2str($$hashref{$_})).'&';
+     } elsif (ref($$hashref{$_})) {
+       &logthis("Got a ref of ".(ref($$hashref{$_}))." skipping.");
+     } else {
+       $result.=&escape($$hashref{$_}).'&';
+     }
+   }
    $result=~s/\&$//;
    return $result;
  }
- Line 874  sub str2hash {
+ Line 1058  sub str2hash {
    my %returnhash;
    foreach (split(/\&/,$string)) {
      my ($name,$value)=split(/\=/,$_);
-     $returnhash{&unescape($name)}=&unescape($value);
+     $name=&unescape($name);
+     $value=&unescape($value);
+     if ($value =~ /^_HASH_REF__/) {
+       $value =~ s/^_HASH_REF__//;
+       my %hash=&str2hash($value);
+       $value=\%hash;
+     } elsif ($value =~ /^_ARRAY_REF__/) {
+       $value =~ s/^_ARRAY_REF__//;
+       my @array=&str2array($value);
+       $value=\@array;
+     }
+     $returnhash{$name}=$value;
    }
-   return %returnhash;
+   return (%returnhash);
+ }
+ sub str2array {
+   my ($string) = @_;
+   my @returnarray;
+   foreach my $value (split(/\&/,$string)) {
+     $value=&unescape($value);
+     if ($value =~ /^_HASH_REF__/) {
+       $value =~ s/^_HASH_REF__//;
+       my %hash=&str2hash($value);
+       $value=\%hash;
+     } elsif ($value =~ /^_ARRAY_REF__/) {
+       $value =~ s/^_ARRAY_REF__//;
+       my @array=&str2array($value);
+       $value=\@array;
+     }
+     push(@returnarray,$value);
+   }
+   return (@returnarray);
  }
  # -------------------------------------------------------------------Temp Store
- Line 900  sub tmpreset {
+ Line 1114  sub tmpreset {
    my %hash;
    if (tie(%hash,'GDBM_File',
  	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
- 	  &GDBM_WRCREAT,0640)) {
+ 	  &GDBM_WRCREAT(),0640)) {
      foreach my $key (keys %hash) {
        if ($key=~ /:$symb/) {
  	delete($hash{$key});
- Line 936  sub tmpstore {
+ Line 1150  sub tmpstore {
    my $path=$perlvar{'lonDaemons'}.'/tmp';
    if (tie(%hash,'GDBM_File',
  	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
- 	  &GDBM_WRCREAT,0640)) {
+ 	  &GDBM_WRCREAT(),0640)) {
      $hash{"version:$symb"}++;
      my $version=$hash{"version:$symb"};
      my $allkeys='';
- Line 980  sub tmprestore {
+ Line 1194  sub tmprestore {
    my $path=$perlvar{'lonDaemons'}.'/tmp';
    if (tie(%hash,'GDBM_File',
  	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
- 	  &GDBM_READER,0640)) {
+ 	  &GDBM_READER(),0640)) {
      my $version=$hash{"version:$symb"};
      $returnhash{'version'}=$version;
      my $scope;
- Line 1011  sub store {
+ Line 1225  sub store {
      if ($stuname) { $home=&homeserver($stuname,$domain); }
+     $symb=&symbclean($symb);
      if (!$symb) { unless ($symb=&symbread()) { return ''; } }
      &devalidate($symb);
- Line 1041  sub cstore {
+ Line 1256  sub cstore {
      if ($stuname) { $home=&homeserver($stuname,$domain); }
+     $symb=&symbclean($symb);
      if (!$symb) { unless ($symb=&symbread()) { return ''; } }
      &devalidate($symb);
- Line 1076  sub restore {
+ Line 1292  sub restore {
      if (!$symb) {
        unless ($symb=escape(&symbread())) { return ''; }
      } else {
-       $symb=&escape($symb);
+       $symb=&escape(&symbclean($symb));
      }
      if (!$namespace) {
         unless ($namespace=$ENV{'request.course.id'}) {
- Line 1366  sub allowed {
+ Line 1582  sub allowed {
  # Free bre to public access
      if ($priv eq 'bre') {
- 	if (&metadata($uri,'copyright') eq 'public') { return 'F'; }
+         my $copyright=&metadata($uri,'copyright');
+ 	if ($copyright eq 'public') { return 'F'; }
+         if ($copyright eq 'priv') {
+             $uri=~/([^\/]+)\/([^\/]+)\//;
+ 	    unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
+ 		return '';
+             }
+         }
+         if ($copyright eq 'domain') {
+             $uri=~/([^\/]+)\/([^\/]+)\//;
+ 	    unless (($ENV{'user.domain'} eq $1) ||
+                  ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
+ 		return '';
+             }
+         }
+         if ($ENV{'request.role'}=~ /li\.\//) {
+             # Library role, so allow browsing of resources in this domain.
+             return 'F';
+         }
+     }
+     # Domain coordinator is trying to create a course
+     if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
+         # uri is the requested domain in this case.
+         # comparison to 'request.role.domain' shows if the user has selected
+         # a role of dc for the domain in question.
+         return 'F' if ($uri eq $ENV{'request.role.domain'});
      }
      my $thisallowed='';
- Line 1414  sub allowed {
+ Line 1655  sub allowed {
  # the course
      if ($ENV{'request.course.id'}) {
         $courseprivid=$ENV{'request.course.id'};
         if ($ENV{'request.course.sec'}) {
            $courseprivid.='/'.$ENV{'request.course.sec'};
         }
         $courseprivid=~s/\_/\//;
         my $checkreferer=1;
-        my @uriparts=split(/\//,$uri);
+        my ($match,$cond)=&is_on_map($uri);
-        my $filename=$uriparts[$#uriparts];
+        if ($match) {
-        my $pathname=$uri;
+            $statecond=$cond;
-        $pathname=~s/\/$filename$//;
-        if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
-            /\&$filename\:([\d\|]+)\&/) {
-            $statecond=$1;
             if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
                 =~/$priv\&([^\:]*)/) {
                 $thisallowed.=$1;
- Line 1436  sub allowed {
+ Line 1674  sub allowed {
         if ($checkreferer) {
  	  my $refuri=$ENV{'httpref.'.$orguri};
              unless ($refuri) {
                  foreach (keys %ENV) {
  		    if ($_=~/^httpref\..*\*/) {
- Line 1450  sub allowed {
+ Line 1687  sub allowed {
                      }
                  }
              }
           if ($refuri) {
  	  $refuri=&declutter($refuri);
-           my @uriparts=split(/\//,$refuri);
+           my ($match,$cond)=&is_on_map($refuri);
-           my $filename=$uriparts[$#uriparts];
+             if ($match) {
-           my $pathname=$refuri;
+               my $refstatecond=$cond;
-           $pathname=~s/\/$filename$//;
-             if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
-               /\&$filename\:([\d\|]+)\&/) {
-               my $refstatecond=$1;
                if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
                    =~/$priv\&([^\:]*)/) {
                    $thisallowed.=$1;
- Line 1517  sub allowed {
+ Line 1751  sub allowed {
                  || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
  		   if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
                         &log($ENV{'user.domain'},$ENV{'user.name'},
-                             $ENV{'user.host'},
+                             $ENV{'user.home'},
                              'Locked by res: '.$priv.' for '.$uri.' due to '.
                              $cdom.'/'.$cnum.'/'.$csec.' expire '.
                              $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
- Line 1528  sub allowed {
+ Line 1762  sub allowed {
                  || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
  		   if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
                         &log($ENV{'user.domain'},$ENV{'user.name'},
-                             $ENV{'user.host'},
+                             $ENV{'user.home'},
                              'Locked by priv: '.$priv.' for '.$uri.' due to '.
                              $cdom.'/'.$cnum.'/'.$csec.' expire '.
                              $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
- Line 1556  sub allowed {
+ Line 1790  sub allowed {
     if ($thisallowed=~/C/) {
         my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
+        my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
         if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
  	   =~/$rolecode/) {
             &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
- Line 1563  sub allowed {
+ Line 1798  sub allowed {
                  $ENV{'request.course.id'});
             return '';
         }
+        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
+ 	   =~/$unamedom/) {
+            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
+                 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
+                 $ENV{'request.course.id'});
+            return '';
+        }
     }
  # Resource preferences
- Line 1586  sub allowed {
+ Line 1829  sub allowed {
         }
     }
- # Restricted by state?
+ # Restricted by state or randomout?
     if ($thisallowed=~/X/) {
+       if ($ENV{'acc.randomout'}) {
+          my $symb=&symbread($uri,1);
+          if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
+             return '';
+          }
+       }
        if (&condval($statecond)) {
  	 return '2';
        } else {
- Line 1599  sub allowed {
+ Line 1848  sub allowed {
     return 'F';
  }
+ # --------------------------------------------------- Is a resource on the map?
+ sub is_on_map {
+     my $uri=&declutter(shift);
+     my @uriparts=split(/\//,$uri);
+     my $filename=$uriparts[$#uriparts];
+     my $pathname=$uri;
+     $pathname=~s/\/$filename$//;
+     my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
+ 	       /\&$filename\:([\d\|]+)\&/);
+     if ($match) {
+        return (1,$1);
+    } else {
+        return (0,0);
+    }
+ }
  # ----------------------------------------------------------------- Define Role
  sub definerole {
- Line 1644  sub definerole {
+ Line 1910  sub definerole {
  # ---------------- Make a metadata query against the network of library servers
  sub metadata_query {
-     my ($query,$custom,$customshow)=@_;
+     my ($query,$custom,$customshow,$server_array)=@_;
      my %rhash;
-     for my $server (keys %libserv) {
+     my @server_list = (defined($server_array) ? @$server_array
+                                               : keys(%libserv) );
+     for my $server (@server_list) {
  	unless ($custom or $customshow) {
  	    my $reply=&reply("querysend:".&escape($query),$server);
  	    $rhash{$server}=$reply;
- Line 1661  sub metadata_query {
+ Line 1929  sub metadata_query {
      return \%rhash;
  }
+ # ----------------------------------------- Send log queries and wait for reply
+ sub log_query {
+     my ($uname,$udom,$query,%filters)=@_;
+     my $uhome=&homeserver($uname,$udom);
+     if ($uhome eq 'no_host') { return 'error: no_host'; }
+     my $uhost=$hostname{$uhome};
+     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
+     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
+                        $uhome);
+     unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
+     return get_query_reply($queryid);
+ }
+ sub get_query_reply {
+     my $queryid=shift;
+     my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
+     my $reply='';
+     for (1..100) {
+ 	sleep 2;
+         if (-e $replyfile.'.end') {
+ 	    if (my $fh=Apache::File->new($replyfile)) {
+                $reply.=<$fh>;
+                $fh->close;
+ 	   } else { return 'error: reply_file_error'; }
+            return &unescape($reply);
+ 	}
+     }
+     return 'timeout:'.$queryid;
+ }
+ sub courselog_query {
+ #
+ # possible filters:
+ # url: url or symb
+ # username
+ # domain
+ # action: view, submit, grade
+ # start: timestamp
+ # end: timestamp
+ #
+     my (%filters)=@_;
+     unless ($ENV{'request.course.id'}) { return 'no_course'; }
+     if ($filters{'url'}) {
+ 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
+         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
+         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
+     }
+     my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
+     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
+     return &log_query($cname,$cdom,'courselog',%filters);
+ }
+ sub userlog_query {
+     my ($uname,$udom,%filters)=@_;
+     return &log_query($uname,$udom,'userlog',%filters);
+ }
  # ------------------------------------------------------------------ Plain Text
  sub plaintext {
- Line 1732  sub modifyuserauth {
+ Line 2058  sub modifyuserauth {
  # --------------------------------------------------------------- Modify a user
  sub modifyuser {
-     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
+     my ($udom,    $uname, $uid,
-         $forceid)=@_;
+         $umode,   $upass, $first,
+         $middle,  $last,  $gene,
+         $forceid, $desiredhome)=@_;
+     $udom=~s/\W//g;
+     $uname=~s/\W//g;
      &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
               $umode.', '.$first.', '.$middle.', '.
- 	     $last.', '.$gene.'(forceid: '.$forceid.') by '.
+ 	     $last.', '.$gene.'(forceid: '.$forceid.')'.
-              $ENV{'user.name'}.' at '.$ENV{'user.domain'});
+              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
-     my $uhome=&homeserver($uname,$udom);
+                                      ' desiredhome not specified').
+              ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'});
+     my $uhome=&homeserver($uname,$udom,'true');
  # ----------------------------------------------------------------- Create User
      if (($uhome eq 'no_host') && ($umode) && ($upass)) {
          my $unhome='';
- 	if ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
+         if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
+             $unhome = $desiredhome;
+ 	} elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
  	    $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
-         } else {
+         } else { # load balancing routine for determining $unhome
              my $tryserver;
              my $loadm=10000000;
              foreach $tryserver (keys %libserv) {
- Line 1760  sub modifyuser {
+ Line 2093  sub modifyuser {
  	    }
          }
          if (($unhome eq '') || ($unhome eq 'no_host')) {
- 	    return 'error: find home';
+ 	    return 'error: unable to find a home server for '.$uname.
+                    ' in domain '.$udom;
          }
          my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
                           &escape($upass),$unhome);
  	unless ($reply eq 'ok') {
              return 'error: '.$reply;
          }
-         $uhome=&homeserver($uname,$udom);
+         $uhome=&homeserver($uname,$udom,'true');
          if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
  	    return 'error: verify home';
          }
-     }
+     }   # End of creation of new user
  # ---------------------------------------------------------------------- Add ID
      if ($uid) {
         $uid=~tr/A-Z/a-z/;
- Line 1789  sub modifyuser {
+ Line 2123  sub modifyuser {
      my %names=&get('environment',
  		   ['firstname','middlename','lastname','generation'],
  		   $udom,$uname);
+     if ($names{'firstname'} =~ m/^error:.*/) { %names=(); }
      if ($first)  { $names{'firstname'}  = $first; }
      if ($middle) { $names{'middlename'} = $middle; }
      if ($last)   { $names{'lastname'}   = $last; }
- Line 1806  sub modifyuser {
+ Line 2141  sub modifyuser {
  sub modifystudent {
      my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
-         $end,$start,$forceid)=@_;
+         $end,$start,$forceid,$desiredhome)=@_;
      my $cid='';
      unless ($cid=$ENV{'request.course.id'}) {
  	return 'not_in_class';
      }
  # --------------------------------------------------------------- Make the user
      my $reply=&modifyuser
- 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid);
+ 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
+          $desiredhome);
      unless ($reply eq 'ok') { return $reply; }
      my $uhome=&homeserver($uname,$udom);
      if (($uhome eq '') || ($uhome eq 'no_host')) {
- Line 1859  sub writecoursepref {
+ Line 2195  sub writecoursepref {
  # ---------------------------------------------------------- Make/modify course
  sub createcourse {
-     my ($udom,$description,$url)=@_;
+     my ($udom,$description,$url,$course_server)=@_;
      $url=&declutter($url);
      my $cid='';
-     unless (&allowed('ccc',$ENV{'user.domain'})) {
+     unless (&allowed('ccc',$udom)) {
-         return 'refused';
-     }
-     unless ($udom eq $ENV{'user.domain'}) {
          return 'refused';
      }
  # ------------------------------------------------------------------- Create ID
     my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
  # ----------------------------------------------- Make sure that does not exist
-    my $uhome=&homeserver($uname,$udom);
+    my $uhome=&homeserver($uname,$udom,'true');
     unless (($uhome eq '') || ($uhome eq 'no_host')) {
         $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
          unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
-        $uhome=&homeserver($uname,$udom);
+        $uhome=&homeserver($uname,$udom,'true');
         unless (($uhome eq '') || ($uhome eq 'no_host')) {
             return 'error: unable to generate unique course-ID';
         }
     }
+ # ------------------------------------------------ Check supplied server name
+     $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
+     if (! exists($libserv{$course_server})) {
+         return 'error:bad server name '.$course_server;
+     }
  # ------------------------------------------------------------- Make the course
      my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
-                       $ENV{'user.home'});
+                       $course_server);
      unless ($reply eq 'ok') { return 'error: '.$reply; }
-     $uhome=&homeserver($uname,$udom);
+     $uhome=&homeserver($uname,$udom,'true');
      if (($uhome eq '') || ($uhome eq 'no_host')) {
  	return 'error: no such course';
      }
- Line 1922  sub revokecustomrole {
+ Line 2260  sub revokecustomrole {
  # ------------------------------------------------------------ Directory lister
  sub dirlist {
-     my $uri=shift;
+     my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
      $uri=~s/^\///;
      $uri=~s/\/$//;
-     my ($res,$udom,$uname,@rest)=split(/\//,$uri);
+     my ($udom, $uname);
-     if ($udom) {
+     (undef,$udom,$uname)=split(/\//,$uri);
-      if ($uname) {
+     if(defined($userdomain)) {
-        my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/'.$uri,
+         $udom = $userdomain;
-                       homeserver($uname,$udom));
+     }
-        return split(/:/,$listing);
+     if(defined($username)) {
-      } else {
+         $uname = $username;
-        my $tryserver;
+     }
-        my %allusers=();
-        foreach $tryserver (keys %libserv) {
+     my $dirRoot = $perlvar{'lonDocRoot'};
- 	  if ($hostdom{$tryserver} eq $udom) {
+     if(defined($alternateDirectoryRoot)) {
-              my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.$udom,
+         $dirRoot = $alternateDirectoryRoot;
- 			       $tryserver);
+         $dirRoot =~ s/\/$//;
-              if (($listing ne 'no_such_dir') && ($listing ne 'empty')
+     }
-               && ($listing ne 'con_lost')) {
-                 foreach (split(/:/,$listing)) {
+     if($udom) {
-                   my ($entry,@stat)=split(/&/,$_);
+         if($uname) {
-                   $allusers{$entry}=1;
+             my $listing=reply('ls:'.$dirRoot.'/'.$uri,
+                               homeserver($uname,$udom));
+             return split(/:/,$listing);
+         } elsif(!defined($alternateDirectoryRoot)) {
+             my $tryserver;
+             my %allusers=();
+             foreach $tryserver (keys %libserv) {
+                 if($hostdom{$tryserver} eq $udom) {
+                     my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
+                                       $udom, $tryserver);
+                     if (($listing ne 'no_such_dir') && ($listing ne 'empty')
+                         && ($listing ne 'con_lost')) {
+                         foreach (split(/:/,$listing)) {
+                             my ($entry,@stat)=split(/&/,$_);
+                             $allusers{$entry}=1;
+                         }
+                     }
                  }
-              }
+             }
- 	  }
+             my $alluserstr='';
-        }
+             foreach (sort keys %allusers) {
-        my $alluserstr='';
+                 $alluserstr.=$_.'&user:';
-        foreach (sort keys %allusers) {
+             }
-            $alluserstr.=$_.'&user:';
+             $alluserstr=~s/:$//;
-        }
+             return split(/:/,$alluserstr);
-        $alluserstr=~s/:$//;
+         } else {
-        return split(/:/,$alluserstr);
+             my @emptyResults = ();
-      }
+             push(@emptyResults, 'missing user name');
-    } else {
+             return split(':',@emptyResults);
-        my $tryserver;
+         }
-        my %alldom=();
+     } elsif(!defined($alternateDirectoryRoot)) {
-        foreach $tryserver (keys %libserv) {
+         my $tryserver;
- 	   $alldom{$hostdom{$tryserver}}=1;
+         my %alldom=();
-        }
+         foreach $tryserver (keys %libserv) {
-        my $alldomstr='';
+             $alldom{$hostdom{$tryserver}}=1;
-        foreach (sort keys %alldom) {
+         }
-           $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
+         my $alldomstr='';
-        }
+         foreach (sort keys %alldom) {
-        $alldomstr=~s/:$//;
+             $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
-        return split(/:/,$alldomstr);
+         }
-    }
+         $alldomstr=~s/:$//;
+         return split(/:/,$alldomstr);
+     } else {
+         my @emptyResults = ();
+         push(@emptyResults, 'missing domain');
+         return split(':',@emptyResults);
+     }
  }
  # -------------------------------------------------------- Value of a Condition
- Line 2021  sub condval {
+ Line 2382  sub condval {
      return $result;
  }
+ # --------------------------------------------------- Course Resourcedata Query
+ sub courseresdata {
+     my ($coursenum,$coursedomain,@which)=@_;
+     my $coursehom=&homeserver($coursenum,$coursedomain);
+     my $hashid=$coursenum.':'.$coursedomain;
+     my $dodump=0;
+     if (!defined($courseresdatacache{$hashid.'.time'})) {
+ 	$dodump=1;
+     } else {
+ 	if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
+     }
+     if ($dodump) {
+ 	my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
+ 	my ($tmp) = keys(%dumpreply);
+ 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
+ 	    $courseresdatacache{$hashid.'.time'}=time;
+ 	    $courseresdatacache{$hashid}=\%dumpreply;
+ 	}
+     }
+     foreach my $item (@which) {
+ 	if ($courseresdatacache{$hashid}->{$item}) {
+ 	    return $courseresdatacache{$hashid}->{$item};
+ 	}
+     }
+     return '';
+ }
  # --------------------------------------------------------- Value of a Variable
  sub EXT {
-     my ($varname,$symbparm)=@_;
+     my ($varname,$symbparm,$udom,$uname)=@_;
      unless ($varname) { return ''; }
+     #get real user name/domain, courseid and symb
+     my $courseid;
+     if (!($uname && $udom)) {
+       (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
+       if (!$symbparm) {	$symbparm=$cursymb; }
+     } else {
+ 	$courseid=$ENV{'request.course.id'};
+     }
      my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
      my $rest;
      if ($therest[0]) {
- Line 2040  sub EXT {
+ Line 2440  sub EXT {
      if ($realm eq 'user') {
  # --------------------------------------------------------------- user.resource
  	if ($space eq 'resource') {
- 	    my %restored=&restore();
+ 	    my %restored=&restore(undef,undef,$udom,$uname);
              return $restored{$qualifierrest};
  # ----------------------------------------------------------------- user.access
          } elsif ($space eq 'access') {
+ 	    # FIXME - not supporting calls for a specific user
              return &allowed($qualifier,$rest);
  # ------------------------------------------ user.preferences, user.environment
          } elsif (($space eq 'preferences') || ($space eq 'environment')) {
-             return $ENV{join('.',('environment',$qualifierrest))};
+ 	    if (($uname eq $ENV{'user.name'}) &&
+ 		($udom eq $ENV{'user.domain'})) {
+ 		return $ENV{join('.',('environment',$qualifierrest))};
+ 	    } else {
+ 		my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
+ 		return $returnhash{$qualifierrest};
+ 	    }
  # ----------------------------------------------------------------- user.course
          } elsif ($space eq 'course') {
+ 	    # FIXME - not supporting calls for a specific user
              return $ENV{join('.',('request.course',$qualifier))};
  # ------------------------------------------------------------------- user.role
          } elsif ($space eq 'role') {
+ 	    # FIXME - not supporting calls for a specific user
              my ($role,$where)=split(/\./,$ENV{'request.role'});
              if ($qualifier eq 'value') {
  		return $role;
- Line 2061  sub EXT {
+ Line 2470  sub EXT {
              }
  # ----------------------------------------------------------------- user.domain
          } elsif ($space eq 'domain') {
-             return $ENV{'user.domain'};
+             return $udom;
  # ------------------------------------------------------------------- user.name
          } elsif ($space eq 'name') {
-             return $ENV{'user.name'};
+             return $uname;
  # ---------------------------------------------------- Any other user namespace
          } else {
              my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
              my %reply=&get($space,[$item]);
              return $reply{$item};
          }
-     } elsif ($realm eq 'request') {
+     } elsif ($realm eq 'query') {
+ # ---------------------------------------------- pull stuff out of query string
+         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},[$space]);
+ 	return $ENV{'form.'.$space};
+    } elsif ($realm eq 'request') {
  # ------------------------------------------------------------- request.browser
          if ($space eq 'browser') {
  	    return $ENV{'browser.'.$qualifier};
- Line 2081  sub EXT {
+ Line 2494  sub EXT {
          }
      } elsif ($realm eq 'course') {
  # ---------------------------------------------------------- course.description
-         return $ENV{'course.'.$ENV{'request.course.id'}.'.'.
+         return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
-                               $spacequalifierrest};
      } elsif ($realm eq 'resource') {
-        if ($ENV{'request.course.id'}) {
- #	   print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
+ 	if ($courseid eq $ENV{'request.course.id'}) {
+ 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
  # ----------------------------------------------------- Cascading lookup scheme
-          my $symbp;
+ 	    if (!$symbparm) { $symbparm=&symbread(); }
-          if ($symbparm) {
+ 	    my $symbp=$symbparm;
-             $symbp=$symbparm;
+ 	    my $mapp=(split(/\_\_\_/,$symbp))[0];
- 	 } else {
-             $symbp=&symbread();
+ 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
-          }
+ 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
-          my $mapp=(split(/\_\_\_/,$symbp))[0];
+ 	    my $section;
-          my $symbparm=$symbp.'.'.$spacequalifierrest;
+ 	    if (($ENV{'user.name'} eq $uname) &&
-          my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
+ 		($ENV{'user.domain'} eq $udom)) {
+ 		$section=$ENV{'request.course.sec'};
-          my $seclevel=
+ 	    } else {
-             $ENV{'request.course.id'}.'.['.
+ 		$section=&usection($udom,$uname,$courseid);
- 		$ENV{'request.course.sec'}.'].'.$spacequalifierrest;
+ 	    }
-          my $seclevelr=
-             $ENV{'request.course.id'}.'.['.
- 		$ENV{'request.course.sec'}.'].'.$symbparm;
-          my $seclevelm=
-             $ENV{'request.course.id'}.'.['.
- 		$ENV{'request.course.sec'}.'].'.$mapparm;
-          my $courselevel=
-             $ENV{'request.course.id'}.'.'.$spacequalifierrest;
-          my $courselevelr=
-             $ENV{'request.course.id'}.'.'.$symbparm;
-          my $courselevelm=
-             $ENV{'request.course.id'}.'.'.$mapparm;
- # ----------------------------------------------------------- first, check user
+ 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
-          my %resourcedata=get('resourcedata',
+ 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
-                            [$courselevelr,$courselevelm,$courselevel]);
+ 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
-          if (($resourcedata{$courselevelr}!~/^error\:/) &&
-              ($resourcedata{$courselevelr}!~/^con_lost/)) {
+ 	    my $courselevel=$courseid.'.'.$spacequalifierrest;
+ 	    my $courselevelr=$courseid.'.'.$symbparm;
-          if ($resourcedata{$courselevelr}) {
+ 	    my $courselevelm=$courseid.'.'.$mapparm;
-             return $resourcedata{$courselevelr}; }
-          if ($resourcedata{$courselevelm}) {
-             return $resourcedata{$courselevelm}; }
-          if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
-       } else {
+ # ----------------------------------------------------------- first, check user
- 	  if ($resourcedata{$courselevelr}!~/No such file/) {
+ 	    my %resourcedata=&get('resourcedata',
- 	    &logthis("<font color=blue>WARNING:".
+ 				  [$courselevelr,$courselevelm,$courselevel],
- 		   " Trying to get resource data for ".$ENV{'user.name'}." at "
+ 				 $udom,$uname);
-                    .$ENV{'user.domain'}.": ".$resourcedata{$courselevelr}.
+ 	    if (($resourcedata{$courselevelr}!~/^error\:/) &&
-                  "</font>");
+ 		($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/) {
+ 		    &logthis("<font color=blue>WARNING:".
+ 			     " Trying to get resource data for ".
+ 			     $uname." at ".$udom.": ".
+ 			     $resourcedata{$courselevelr}."</font>");
+ 		}
+ 	    }
  # -------------------------------------------------------- second, check course
-         my $reply=&reply('get:'.
+ 	    my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
-               $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
+ 					  $ENV{'course.'.$courseid.'.domain'},
-               $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
+ 					  ($seclevelr,$seclevelm,$seclevel,
- 	      ':resourcedata:'.
+ 					   $courselevelr,$courselevelm,
-    &escape($seclevelr).'&'.&escape($seclevelm).'&'.&escape($seclevel).'&'.
+ 					   $courselevel));
-    &escape($courselevelr).'&'.&escape($courselevelm).'&'.&escape($courselevel),
+ 	    if ($coursereply) { return $coursereply; }
- 		   $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
-       if ($reply!~/^error\:/) {
- 	  foreach (split(/\&/,$reply)) {
- 	      if ($_) { return &unescape($_); }
-           }
-       }
-       if (($reply=~/^con_lost/) || ($reply=~/^error\:/)) {
- 	  &logthis("<font color=blue>WARNING:".
-                 " Getting ".$reply." asking for ".$varname." for ".
-                 $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
-                 ' at '.
-                 $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.
-                 ' from '.
-                 $ENV{'course.'.$ENV{'request.course.id'}.'.home'}.
-                  "</font>");
-       }
  # ------------------------------------------------------ third, check map parms
-        my %parmhash=();
+ 	    my %parmhash=();
-        my $thisparm='';
+ 	    my $thisparm='';
-        if (tie(%parmhash,'GDBM_File',
+ 	    if (tie(%parmhash,'GDBM_File',
-           $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640)) {
+ 		    $ENV{'request.course.fn'}.'_parms.db',
-            $thisparm=$parmhash{$symbparm};
+ 		    &GDBM_READER(),0640)) {
- 	   untie(%parmhash);
+ 		$thisparm=$parmhash{$symbparm};
-        }
+ 		untie(%parmhash);
-        if ($thisparm) { return $thisparm; }
+ 	    }
-      }
+ 	    if ($thisparm) { return $thisparm; }
+ 	}
  # --------------------------------------------- last, look in resource metadata
-       $spacequalifierrest=~s/\./\_/;
+ 	$spacequalifierrest=~s/\./\_/;
-       my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
+ 	my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
-       if ($metadata) { return $metadata; }
+ 	if ($metadata) { return $metadata; }
-       $metadata=&metadata($ENV{'request.filename'},
+ 	$metadata=&metadata($ENV{'request.filename'},
-                                          'parameter_'.$spacequalifierrest);
+ 			    'parameter_'.$spacequalifierrest);
-       if ($metadata) { return $metadata; }
+ 	if ($metadata) { return $metadata; }
  # ------------------------------------------------------------------ Cascade up
+ 	unless ($space eq '0') {
-       unless ($space eq '0') {
+ 	    my ($part,$id)=split(/\_/,$space);
-           my ($part,$id)=split(/\_/,$space);
+ 	    if ($id) {
-           if ($id) {
+ 		my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
- 	      my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
+ 				     $symbparm,$udom,$uname);
-                                    $symbparm);
+ 		if ($partgeneral) { return $partgeneral; }
-               if ($partgeneral) { return $partgeneral; }
+ 	    } else {
-           } else {
+ 		my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
-               my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
+ 					 $symbparm,$udom,$uname);
-                                        $symbparm);
+ 		if ($resourcegeneral) { return $resourcegeneral; }
-               if ($resourcegeneral) { return $resourcegeneral; }
+ 	    }
-           }
+ 	}
-       }
  # ---------------------------------------------------- Any other user namespace
      } elsif ($realm eq 'environment') {
  # ----------------------------------------------------------------- environment
-         return $ENV{'environment.'.$spacequalifierrest};
+ 	if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
+ 	    return $ENV{'environment.'.$spacequalifierrest};
+ 	} else {
+ 	    my %returnhash=&userenvironment($udom,$uname,
+ 					    $spacequalifierrest);
+ 	    return $returnhash{$spacequalifierrest};
+ 	}
      } elsif ($realm eq 'system') {
  # ----------------------------------------------------------------- system.time
  	if ($space eq 'time') {
- Line 2235  sub metadata {
+ Line 2633  sub metadata {
          my %metathesekeys=();
          unless ($filename=~/\.meta$/) { $filename.='.meta'; }
  	my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
-         my $parser=HTML::TokeParser->new(\$metastring);
+         my $parser=HTML::LCParser->new(\$metastring);
          my $token;
          undef %metathesekeys;
          while ($token=$parser->get_token) {
- Line 2324  sub metadata {
+ Line 2722  sub metadata {
  		  $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
                }
                unless (
-                  $metacache{$uri.':'.$unikey}=$parser->get_text('/'.$entry)
+                  $metacache{$uri.':'.$unikey}=&HTML::Entities::decode($parser->get_text('/'.$entry))
  		      ) { $metacache{$uri.':'.$unikey}=
  			      $metacache{$uri.':'.$unikey.'.default'};
  		      }
- Line 2335  sub metadata {
+ Line 2733  sub metadata {
  # the next is the end of "start tag"
  	 }
         }
+ 	&metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
         $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
         $metacache{$uri.':cachedtimestamp'}=time;
  # this is the end of "was not already recently cached
- Line 2342  sub metadata {
+ Line 2741  sub metadata {
      return $metacache{$uri.':'.$what};
  }
+ sub metadata_generate_part0 {
+     my ($metadata,$metacache,$uri) = @_;
+     my %allnames;
+     foreach my $metakey (sort keys %$metadata) {
+ 	if ($metakey=~/^parameter\_(.*)/) {
+ 	  my $part=$$metacache{$uri.':'.$metakey.'.part'};
+ 	  my $name=$$metacache{$uri.':'.$metakey.'.name'};
+ 	  if (! exists($$metadata{'parameter_0_'.$name})) {
+ 	    $allnames{$name}=$part;
+ 	  }
+ 	}
+     }
+     foreach my $name (keys(%allnames)) {
+       $$metadata{"parameter_0_$name"}=1;
+       my $key="$uri:parameter_0_$name";
+       $$metacache{"$key.part"}='0';
+       $$metacache{"$key.name"}=$name;
+       $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
+ 					   $allnames{$name}.'_'.$name.
+ 					   '.type'};
+       my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
+ 			     '.display'};
+       my $expr='\\[Part: '.$allnames{$name}.'\\]';
+       $olddis=~s/$expr/\[Part: 0\]/;
+       $$metacache{"$key.display"}=$olddis;
+     }
+ }
  # ------------------------------------------------- Update symbolic store links
  sub symblist {
- Line 2350  sub symblist {
+ Line 2777  sub symblist {
      my %hash;
      if (($ENV{'request.course.fn'}) && (%newhash)) {
          if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
-                       &GDBM_WRCREAT,0640)) {
+                       &GDBM_WRCREAT(),0640)) {
  	    foreach (keys %newhash) {
                  $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
              }
- Line 2362  sub symblist {
+ Line 2789  sub symblist {
      return 'error';
  }
+ # --------------------------------------------------------------- Verify a symb
+ sub symbverify {
+     my ($symb,$thisfn)=@_;
+     $thisfn=&declutter($thisfn);
+ # 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);
+     unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
+     $symb=&symbclean($symb);
+     my %bighash;
+     my $okay=0;
+     if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
+                             &GDBM_READER(),0640)) {
+         my $ids=$bighash{'ids_/res/'.$thisfn};
+         unless ($ids) {
+            $ids=$bighash{'ids_/'.$thisfn};
+         }
+         if ($ids) {
+ # ------------------------------------------------------------------- Has ID(s)
+ 	    foreach (split(/\,/,$ids)) {
+                my ($mapid,$resid)=split(/\./,$_);
+                if (
+   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
+    eq $symb) {
+                   $okay=1;
+                }
+ 	   }
+         }
+ 	untie(%bighash);
+     }
+     return $okay;
+ }
+ # --------------------------------------------------------------- Clean-up symb
+ sub symbclean {
+     my $symb=shift;
+ # remove version from map
+     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
+ # remove version from URL
+     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
+     return $symb;
+ }
  # ------------------------------------------------------ Return symb list entry
  sub symbread {
-     my $thisfn=shift;
+     my ($thisfn,$donotrecurse)=@_;
+ # no filename provided? try from environment
      unless ($thisfn) {
-         if ($ENV{'request.symb'}) { return $ENV{'request.symb'}; }
+         if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
  	$thisfn=$ENV{'request.filename'};
      }
+ # is that filename actually a symb? Verify, clean, and return
+     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
+ 	if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
+     }
      $thisfn=declutter($thisfn);
      my %hash;
      my %bighash;
      my $syval='';
      if (($ENV{'request.course.fn'}) && ($thisfn)) {
          if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
-                       &GDBM_READER,0640)) {
+                       &GDBM_READER(),0640)) {
  	    $syval=$hash{$thisfn};
              untie(%hash);
          }
- Line 2392  sub symbread {
+ Line 2875  sub symbread {
          } else {
  # ------------------------------------------------------- Was not in symb table
             if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
-                             &GDBM_READER,0640)) {
+                             &GDBM_READER(),0640)) {
  # ---------------------------------------------- Get ID(s) for current resource
                my $ids=$bighash{'ids_/res/'.$thisfn};
                unless ($ids) {
                   $ids=$bighash{'ids_/'.$thisfn};
                }
+               unless ($ids) {
+ # alias?
+ 		  $ids=$bighash{'mapalias_'.$thisfn};
+               }
                if ($ids) {
  # ------------------------------------------------------------------- Has ID(s)
                   my @possibilities=split(/\,/,$ids);
- Line 2405  sub symbread {
+ Line 2892  sub symbread {
  # ----------------------------------------------- There is only one possibility
  		     my ($mapid,$resid)=split(/\./,$ids);
                       $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
-                  } else {
+                  } elsif (!$donotrecurse) {
  # ------------------------------------------ There is more than one possibility
                       my $realpossible=0;
                       foreach (@possibilities) {
- Line 2420  sub symbread {
+ Line 2907  sub symbread {
  			 }
                       }
  		     if ($realpossible!=1) { $syval=''; }
+                  } else {
+                      $syval='';
                   }
  	      }
                untie(%bighash)
             }
          }
          if ($syval) {
-            return $syval.'___'.$thisfn;
+            return &symbclean($syval.'___'.$thisfn);
          }
      }
      &appenv('request.ambiguous' => $thisfn);
- Line 2488  sub ireceipt {
+ Line 2977  sub ireceipt {
  }
  sub receipt {
-     return &ireceipt($ENV{'user.name'},$ENV{'user.domain'},
+   my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
-                      $ENV{'request.course.id'},&symbread());
+   return &ireceipt($name,$domain,$courseid,$symb);
  }
  # ------------------------------------------------------------ Serves up a file
  # returns either the contents of the file or a -1
  sub getfile {
- Line 2530  sub hreflocation {
+ Line 3019  sub hreflocation {
      unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
         my $finalpath=filelocation($dir,$file);
         $finalpath=~s/^\/home\/httpd\/html//;
+        $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
         return $finalpath;
      } else {
         return $file;
- Line 2543  sub declutter {
+ Line 3033  sub declutter {
      $thisfn=~s/^$perlvar{'lonDocRoot'}//;
      $thisfn=~s/^\///;
      $thisfn=~s/^res\///;
+     $thisfn=~s/\?.+$//;
      return $thisfn;
  }
- Line 2565  sub unescape {
+ Line 3056  sub unescape {
  # ================================================================ Main Program
  sub goodbye {
+    &logthis("Starting Shut down");
     &flushcourselogs();
     &logthis("Shutting down");
  }
  BEGIN {
- # ------------------------------------------------------------ Read access.conf
+ # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
      unless ($readit) {
  {
-     my $config=Apache::File->new("/etc/httpd/conf/access.conf");
+     my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
      while (my $configline=<$config>) {
-         if ($configline =~ /PerlSetVar/) {
+         if ($configline =~ /^[^\#]*PerlSetVar/) {
+ 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
+            chomp($varvalue);
+            $perlvar{$varname}=$varvalue;
+         }
+     }
+ }
+ {
+     my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
+     while (my $configline=<$config>) {
+         if ($configline =~ /^[^\#]*PerlSetVar/) {
  	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
             chomp($varvalue);
             $perlvar{$varname}=$varvalue;
- Line 2590  BEGIN {
+ Line 3093  BEGIN {
      while (my $configline=<$config>) {
         chomp($configline);
-        my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
+        my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
-        $hostname{$id}=$name;
+        if ($id && $domain && $role && $name && $ip) {
-        $hostdom{$id}=$domain;
+ 	 $hostname{$id}=$name;
-        $hostip{$id}=$ip;
+ 	 $hostdom{$id}=$domain;
-        if ($role eq 'library') { $libserv{$id}=$name; }
+ 	 $hostip{$id}=$ip;
+ 	 if ($domdescr) { $domaindescription{$domain}=$domdescr; }
+ 	 if ($role eq 'library') { $libserv{$id}=$name; }
+        } else {
+ 	 if ($configline) {
+ 	   &logthis("Skipping hosts.tab line -$configline-");
+ 	 }
+        }
      }
  }
- Line 2664  $readit=1;
+ Line 3174  $readit=1;
 ;
  __END__
+ =pod
  =head1 NAME
- Apache::lonnet - TCP networking package
+ Apache::lonnet - Subroutines to ask questions about things in the network.
  =head1 SYNOPSIS
- Invoked by other LON-CAPA modules.
+ Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
   &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
+ Common parameters:
+ =over 4
+ =item *
+ $uname : an internal username (if $cname expecting a course Id specifically)
+ =item *
+ $udom : a domain (if $cdom expecting a course's domain specifically)
+ =item *
+ $symb : a resource instance identifier
+ =item *
+ $namespace : the name of a .db file that contains the data needed or
+ being set.
+ =back
  =head1 INTRODUCTION
  This module provides subroutines which interact with the
- lonc/lond (TCP) network layer of LON-CAPA.
+ lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about
+ - classes
+ - 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
  described at http://www.lon-capa.org.
- =head1 HANDLER SUBROUTINE
+ =head1 RETURN MESSAGES
- There is no handler routine for this module.
- =head1 OTHER SUBROUTINES
  =over 4
  =item *
- logtouch() : make sure the logfile, lonnet.log, exists
+ con_lost : unable to contact remote host
  =item *
- logthis() : append message to lonnet.log
+ con_delayed : unable to contact remote host, message will be delivered
+ when the connection is brought back up
  =item *
- logperm() : append a permanent message to lonnet.perm.log
+ con_failed : unable to contact remote host and unable to save message
+ for later delivery
  =item *
- subreply() : non-critical communication, called by &reply
+ error: : an error a occured, a description of the error follows the :
  =item *
- reply() : makes two attempts to pass message; logs refusals and rejections
+ no_such_host : unable to fund a host associated with the user/domain
+ that was requested
- =item *
+ =back
- reconlonc() : tries to reconnect lonc client processes.
+ =head1 PUBLIC SUBROUTINES
- =item *
+ =head2 Session Environment Functions
- critical() : passes a critical message to another server; if cannot get
+ =over 4
- through then place message in connection buffer
  =item *
- appenv(%hash) : read in current user environment, append new environment
+ appenv(%hash) : the value of %hash is written to the user envirnoment
- values to make new user environment
+ file, and will be restored for each access this user makes during this
+ session, also modifies the %ENV for the current process
  =item *
- delenv($varname) : read in current user environment, remove all values
+ 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.
- beginning with $varname, write new user environment (note: flock is used
- to prevent conflicting shared read/writes with file)
- =item *
+ =back
- spareserver() : find server with least workload from spare.tab
+ =head2 User Information
+ =over 4
  =item *
- Line 2742  authentication scheme
+ Line 3282  authentication scheme
  =item *
  authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
- servers (first use the current one)
+ servers (first use the current one), $upass should be the users password
  =item *
- homeserver($uname,$udom) : find the homebase for a user from domain's lib
+ homeserver($uname,$udom) : find the server which has the user's
- servers
+ directory and files (there must be only one), this caches the answer,
+ and also caches if there is a borken connection.
  =item *
- idget($udom,@ids) : find the usernames behind a list of IDs (returns hash:
+ idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
+ unique resource in a domain, there must be only 1 ID per username, and
+ only 1 username per ID in a specific domain) (returns hash:
  id=>name,id=>name)
  =item *
- Line 2765  idput($udom,%ids) : store away a list of
+ Line 3308  idput($udom,%ids) : store away a list of
  =item *
- usection($domain,$user,$courseid) : output of section name/number or '' for
+ rolesinit($udom,$username,$authhost) : get user privileges
- "not in course" and '-1' for "no section"
+ =item *
+ 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 *
+ userenvironment($udom,$uname,@what) : gets the values of the keys
+ passed in @what from the requested user's environment, returns a hash
+ =back
+ =head2 User Roles
+ =over 4
+ =item *
+ allowed($priv,$uri) : check for a user privilege; returns codes for allowed
+ actions
+  F: full access
+  U,I,K: authentication modes (cxx only)
+  '': forbidden
+: user needs to choose course
+: browse allowed
  =item *
- userenvironment($domain,$user,$what) : puts out any environment parameter
+ definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
- for a user
+ role rolename set privileges in format of lonTabs/roles.tab for system, domain,
+ and course level
  =item *
- subscribe($fname) : subscribe to a resource, return URL if possible
+ plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
+ explanation of a user role term
+ =back
+ =head2 User Modification
+ =over 4
  =item *
- repcopy($filename) : replicate file
+ assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
+ user for the level given by URL.  Optional start and end dates (leave empty
+ string or zero for "no date")
  =item *
- ssi($url,%hash) : server side include, does a complete request cycle on url to
+ changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
- localhost, posts hash
+ change a users, password, possible return values are: ok,
+ pwchange_failure, non_authorized, auth_mode_error, unknown_user,
+ refused
  =item *
- log($domain,$name,$home,$message) : write to permanent log for user; use
+ modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
- critical subroutine
  =item *
- flushcourselogs() : flush (save) buffer logs and access logs
+ modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
+ modify user
  =item *
- courselog($what) : save message for course in hash
+ modifystudent($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,$end,$start) : modify student
  =item *
- courseacclog($what) : save message for course using &courselog().  Perform
+ assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
- special processing for specific resource types (problems, exams, quizzes, etc).
+ custom role; give a custom role to a user for the level given by URL.  Specify
+ name and domain of role author, and role name
  =item *
- countacc($url) : count the number of accesses to a given URL
+ revokerole($udom,$uname,$url,$role) : revoke a role for url
  =item *
- sub checkout($symb,$tuname,$tudom,$tcrsid) : check out an item
+ revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
+ =back
+ =head2 Course Infomation
+ =over 4
  =item *
- sub checkin($token) : check in an item
+ coursedescription($courseid) : course description
  =item *
- sub expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
+ courseresdata($coursenum,$coursedomain,@which) : request for current
+ parameter setting for a specific course, @what should be a list of
+ parameters to ask about. This routine caches answers for 5 minutes.
+ =back
+ =head2 Course Modification
+ =over 4
  =item *
- devalidate($symb) : devalidate spreadsheets
+ writecoursepref($courseid,%prefs) : write preferences (environment
+ database) for a course
  =item *
- hash2str(%hash) : convert a hash into a string complete with escaping and '='
+ createcourse($udom,$description,$url) : make/modify course
- and '&' separators
+ =back
+ =head2 Resource Subroutines
+ =over 4
  =item *
- str2hash($string) : convert string to hash using unescaping and splitting on
+ subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
- '=' and '&'
  =item *
- tmpreset($symb,$namespace,$domain,$stuname) : temporary storage
+ repcopy($filename) : subscribes to the requested file, and attempts to
+ replicate from the owning library server, Might return
+ HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
+ HTTP_BAD_REQUEST, also attempts to grab the metadata for the
+ resource. Expects the local filesystem pathname
+ (/home/httpd/html/res/....)
+ =back
+ =head2 Resource Information
+ =over 4
  =item *
- tmprestore($symb,$namespace,$domain,$stuname) : temporary restore
+ EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
+ a vairety of different possible values, $varname should be a request
+ string, and the other parameters can be used to specify who and what
+ one is asking about.
+ Possible values for $varname are environment.lastname (or other item
+ from the envirnment hash), user.name (or someother aspect about the
+ user), resource.0.maxtries (or some other part and parameter of a
+ resource)
  =item *
- store($storehash,$symb,$namespace,$domain,$stuname) : stores hash permanently
+ directcondval($number) : get current value of a condition; reads from a state
- for this url; hashref needs to be given and should be a \%hashname; the
+ string
- remaining args aren't required and if they aren't passed or are '' they will
- be derived from the ENV
  =item *
- cstore($storehash,$symb,$namespace,$domain,$stuname) : same as store but
+ condval($condidx) : value of condition index based on state
- uses critical subroutine
  =item *
- restore($symb,$namespace,$domain,$stuname) : returns hash for this symb;
+ metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
- all args are optional
+ resource's metadata, $what should be either a specific key, or either
+ 'keys' (to get a list of possible keys) or 'packages' to get a list of
+ packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
+ this function automatically caches all requests
  =item *
- coursedescription($courseid) : course description
+ metadata_query($query,$custom,$customshow) : make a metadata query against the
+ network of library servers; returns file handle of where SQL and regex results
+ will be stored for query
  =item *
- rolesinit($domain,$username,$authhost) : get user privileges
+ symbread($filename) : return symbolic list entry (filename argument optional);
+ returns the data handle
  =item *
- get($namespace,$storearr,$udomain,$uname) : returns hash with keys from array
+ symbverify($symb,$thisfn) : verifies that $symb actually exists and is
- reference filled in from namesp ($udomain and $uname are optional)
+ a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
+ failure, user must be in a course, as it assumes the existance of the
+ course initi hash, and uses $ENV('request.course.id'}
  =item *
- del($namespace,$storearr,$udomain,$uname) : deletes keys out of array from
+ symbclean($symb) : removes versions numbers from a symb, returns the
- namesp ($udomain and $uname are optional)
+ cleaned symb
  =item *
- dump($namespace,$udomain,$uname,$regexp) :
+ is_on_map($uri) : checks if the $uri is somewhere on the current
- dumps the complete (or key matching regexp) namespace into a hash
+ course map, user must be in a course for it to work.
- ($udomain, $uname and $regexp are optional)
  =item *
- put($namespace,$storehash,$udomain,$uname) : stores hash in namesp
+ numval($salt) : return random seed value (addend for rndseed)
- ($udomain and $uname are optional)
  =item *
- cput($namespace,$storehash,$udomain,$uname) : critical put
+ rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
- ($udomain and $uname are optional)
+ a random seed, all arguments are optional, if they aren't sent it uses the
+ environment to derive them. Note: if symb isn't sent and it can't get one
+ from &symbread it will use the current time as its return value
  =item *
- eget($namespace,$storearr,$udomain,$uname) : returns hash with keys from array
+ ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
- reference filled in from namesp (encrypts the return communication)
+ unfakeable, receipt
- ($udomain and $uname are optional)
  =item *
- allowed($priv,$uri) : check for a user privilege; returns codes for allowed
+ receipt() : API to ireceipt working off of ENV values; given out to users
- actions
-  F: full access
-  U,I,K: authentication modes (cxx only)
-  '': forbidden
-: user needs to choose course
-: browse allowed
  =item *
- definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
+ countacc($url) : count the number of accesses to a given URL
- role rolename set privileges in format of lonTabs/roles.tab for system, domain,
- and course level
  =item *
- metadata_query($query,$custom,$customshow) : make a metadata query against the
+ checkout($symb,$tuname,$tudom,$tcrsid) :  creates a record of a user having looked at an item, most likely printed out or otherwise using a resource
- network of library servers; returns file handle of where SQL and regex results
- will be stored for query
  =item *
- plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
+ checkin($token) : updates that a resource has beeen returned (a hard copy version for instance) and returns the data that $token was Checkout with ($symb, $tuname, $tudom, and $tcrsid)
- explanation of a user role term
  =item *
- assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
+ expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
- user for the level given by URL.  Optional start and end dates (leave empty
- string or zero for "no date")
  =item *
- modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
+ devalidate($symb) : devalidate temporary spreadsheet calculations,
+ forcing spreadsheet to reevaluate the resource scores next time.
+ =back
+ =head2 Storing/Retreiving Data
+ =over 4
  =item *
- modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
+ store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
- modify user
+ 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
  =item *
- modifystudent($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
+ cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
- $end,$start) : modify student
+ uses critical subroutine
  =item *
- writecoursepref($courseid,%prefs) : write preferences for a course
+ restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
+ all args are optional
  =item *
- createcourse($udom,$description,$url) : make/modify course
+ tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
+ works very similar to store/cstore, but all data is stored in a
+ temporary location and can be reset using tmpreset, $storehash should
+ be a hash reference, returns nothing on success
  =item *
- assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
+ tmprestore($symb,$namespace,$udom,$uname) : storage that works very
- custom role; give a custom role to a user for the level given by URL.  Specify
+ similar to restore, but all data is stored in a temporary location and
- name and domain of role author, and role name
+ can be reset using tmpreset. Returns a hash of values on success,
+ error string otherwise.
  =item *
- revokerole($udom,$uname,$url,$role) : revoke a role for url
+ tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
+ deltes all keys for $symb form the temporary storage hash.
  =item *
- revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
+ get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
+ reference filled in from namesp ($udom and $uname are optional)
+ =item *
+ del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
+ namesp ($udom and $uname are optional)
+ =item *
+ dump($namespace,$udom,$uname,$regexp) :
+ dumps the complete (or key matching regexp) namespace into a hash
+ ($udom, $uname and $regexp are optional)
+ =item *
+ put($namespace,$storehash,$udom,$uname) : stores hash in namesp
+ ($udom and $uname are optional)
+ =item *
+ cput($namespace,$storehash,$udom,$uname) : critical put
+ ($udom and $uname are optional)
+ =item *
+ eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
+ reference filled in from namesp (encrypts the return communication)
+ ($udom and $uname are optional)
+ =item *
+ log($udom,$name,$home,$message) : write to permanent log for user; use
+ critical subroutine
+ =back
+ =head2 Network Status Functions
+ =over 4
  =item *
- Line 2974  dirlist($uri) : return directory list ba
+ Line 3641  dirlist($uri) : return directory list ba
  =item *
- directcondval($number) : get current value of a condition; reads from a state
+ spareserver() : find server with least workload from spare.tab
- string
+ =back
+ =head2 Apache Request
+ =over 4
  =item *
- condval($condidx) : value of condition index based on state
+ ssi($url,%hash) : server side include, does a complete request cycle on url to
+ localhost, posts hash
+ =back
+ =head2 Data to String to Data
+ =over 4
  =item *
- EXT($varname,$symbparm) : value of a variable
+ hash2str(%hash) : convert a hash into a string complete with escaping and '='
+ and '&' separators, supports elements that are arrayrefs and hashrefs
  =item *
- metadata($uri,$what,$liburi,$prefix,$depthcount) : get metadata; returns the
+ hashref2str($hashref) : convert a hashref into a string complete with
- metadata entry for a file; entry='keys', returns a comma separated list of keys
+ escaping and '=' and '&' separators, supports elements that are
+ arrayrefs and hashrefs
  =item *
- symblist($mapname,%newhash) : update symbolic storage links
+ arrayref2str($arrayref) : convert an arrayref into a string complete
+ with escaping and '&' separators, supports elements that are arrayrefs
+ and hashrefs
  =item *
- symbread($filename) : return symbolic list entry (filename argument optional);
+ str2hash($string) : convert string to hash using unescaping and
- returns the data handle
+ splitting on '=' and '&', supports elements that are arrayrefs and
+ hashrefs
  =item *
- numval($salt) : return random seed value (addend for rndseed)
+ str2array($string) : convert string to hash using unescaping and
+ splitting on '&', supports elements that are arrayrefs and hashrefs
+ =back
+ =head2 Logging Routines
+ =over 4
+ These routines allow one to make log messages in the lonnet.log and
+ lonnet.perm logfiles.
  =item *
- rndseed($symb,$courseid,$domain,$username) : create a random sum; returns
+ logtouch() : make sure the logfile, lonnet.log, exists
- a random seed, all arguments are optional, if they aren't sent it uses the
- environment to derive them. Note: if symb isn't sent and it can't get one
- from &symbread it will use the current time as its return value
  =item *
- ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
+ logthis() : append message to the normal lonnet.log file, it gets
- unfakeable, receipt
+ preiodically rolled over and deleted.
  =item *
- receipt() : API to ireceipt working off of ENV values; given out to users
+ logperm() : append a permanent message to lonnet.perm.log, this log
+ file never gets deleted by any automated portion of the system, only
+ messages of critical importance should go in here.
+ =back
+ =head2 General File Helper Routines
+ =over 4
  =item *
- getfile($file) : serves up a file, returns the contents of a file or -1;
+ getfile($file) : returns the entire contents of a file or -1; it
- replicates and subscribes to the file
+ properly subscribes to and replicates the file if neccessary.
  =item *
- filelocation($dir,$file) : returns file system location of a file based on URI;
+ filelocation($dir,$file) : returns file system location of a file
- meant to be "fairly clean" absolute reference
+ based on URI; meant to be "fairly clean" absolute reference, $dir is a
+ directory that relative $file lookups are to looked in ($dir of /a/dir
+ and a file of ../bob will become /a/bob)
  =item *
- Line 3038  filelocation except for hrefs
+ Line 3739  filelocation except for hrefs
  declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
+ =back
+ =head2 HTTP Helper Routines
+ =over 4
  =item *
  escape() : unpack non-word characters into CGI-compatible hex codes
- Line 3046  escape() : unpack non-word characters in
+ Line 3753  escape() : unpack non-word characters in
  unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
+ =back
+ =head1 PRIVATE SUBROUTINES
+ =head2 Underlying communication routines (Shouldn't call)
+ =over 4
+ =item *
+ subreply() : tries to pass a message to lonc, returns con_lost if incapable
+ =item *
+ reply() : uses subreply to send a message to remote machine, logs all failures
+ =item *
+ critical() : passes a critical message to another server; if cannot
+ get through then place message in connection buffer directory and
+ returns con_delayed, if incapable of saving message, returns
+ con_failed
+ =item *
+ reconlonc() : tries to reconnect lonc client processes.
+ =back
+ =head2 Resource Access Logging
+ =over 4
+ =item *
+ flushcourselogs() : flush (save) buffer logs and access logs
+ =item *
+ courselog($what) : save message for course in hash
+ =item *
+ courseacclog($what) : save message for course using &courselog().  Perform
+ special processing for specific resource types (problems, exams, quizzes, etc).
  =item *
  goodbye() : flush course logs and log shutting down; it is called in srm.conf
- Line 3053  as a PerlChildExitHandler
+ Line 3806  as a PerlChildExitHandler
  =back
+ =head2 Other
+ =over 4
+ =item *
+ symblist($mapname,%newhash) : update symbolic storage links
+ =back
  =cut

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

Removed from v.1.197
changed lines
	Added in v.1.264