File:  [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.423: download - view: text, annotated - select for diffs
Thu Sep 25 20:02:54 2003 UTC (20 years, 9 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- block to other version of CSTR space too

    1: # The LearningOnline Network
    2: # TCP networking package
    3: #
    4: # $Id: lonnet.pm,v 1.423 2003/09/25 20:02:54 albertel Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
   29: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
   30: # 11/8,11/16,11/18,11/22,11/23,12/22,
   31: # 01/06,01/13,02/24,02/28,02/29,
   32: # 03/01,03/02,03/06,03/07,03/13,
   33: # 04/05,05/29,05/31,06/01,
   34: # 06/05,06/26 Gerd Kortemeyer
   35: # 06/26 Ben Tyszka
   36: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
   37: # 08/14 Ben Tyszka
   38: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
   39: # 10/04 Gerd Kortemeyer
   40: # 10/04 Guy Albertelli
   41: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29, 
   42: # 10/30,10/31,
   43: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
   44: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
   45: # 05/01/01 Guy Albertelli
   46: # 05/01,06/01,09/01 Gerd Kortemeyer
   47: # 09/01 Guy Albertelli
   48: # 09/01,10/01,11/01 Gerd Kortemeyer
   49: # YEAR=2001
   50: # 3/2 Gerd Kortemeyer
   51: # 3/19,3/20 Gerd Kortemeyer
   52: # 5/26,5/28 Gerd Kortemeyer
   53: # 5/30 H. K. Ng
   54: # 6/1 Gerd Kortemeyer
   55: # July Guy Albertelli
   56: # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
   57: # 10/2 Gerd Kortemeyer
   58: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
   59: # 12/5 Matthew Hall
   60: # 12/5 Guy Albertelli
   61: # 12/6,12/7,12/12 Gerd Kortemeyer
   62: # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
   63: # YEAR=2002
   64: # 1/4,2/4,2/7 Gerd Kortemeyer
   65: #
   66: ###
   67: 
   68: package Apache::lonnet;
   69: 
   70: use strict;
   71: use Apache::File;
   72: use LWP::UserAgent();
   73: use HTTP::Headers;
   74: use vars 
   75: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom 
   76:    %libserv %pr %prp %metacache %packagetab %titlecache 
   77:    %courselogs %accesshash %userrolehash $processmarker $dumpcount 
   78:    %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache 
   79:    %userresdatacache %usectioncache %domaindescription %domain_auth_def %domain_auth_arg_def 
   80:    %domain_lang_def %domain_city %domain_longi %domain_lati $tmpdir);
   81: 
   82: use IO::Socket;
   83: use GDBM_File;
   84: use Apache::Constants qw(:common :http);
   85: use HTML::LCParser;
   86: use Fcntl qw(:flock);
   87: use Apache::loncoursedata;
   88: use Apache::lonlocal;
   89: 
   90: my $readit;
   91: 
   92: # --------------------------------------------------------------------- Logging
   93: 
   94: sub logtouch {
   95:     my $execdir=$perlvar{'lonDaemons'};
   96:     unless (-e "$execdir/logs/lonnet.log") {
   97: 	my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
   98: 	close $fh;
   99:     }
  100:     my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
  101:     chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
  102: }
  103: 
  104: sub logthis {
  105:     my $message=shift;
  106:     my $execdir=$perlvar{'lonDaemons'};
  107:     my $now=time;
  108:     my $local=localtime($now);
  109:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
  110:     print $fh "$local ($$): $message\n";
  111:     return 1;
  112: }
  113: 
  114: sub logperm {
  115:     my $message=shift;
  116:     my $execdir=$perlvar{'lonDaemons'};
  117:     my $now=time;
  118:     my $local=localtime($now);
  119:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
  120:     print $fh "$now:$message:$local\n";
  121:     return 1;
  122: }
  123: 
  124: # -------------------------------------------------- Non-critical communication
  125: sub subreply {
  126:     my ($cmd,$server)=@_;
  127:     my $peerfile="$perlvar{'lonSockDir'}/$server";
  128:     my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
  129:                                      Type    => SOCK_STREAM,
  130:                                      Timeout => 10)
  131:        or return "con_lost";
  132:     print $client "$cmd\n";
  133:     my $answer=<$client>;
  134:     if (!$answer) { $answer="con_lost"; }
  135:     chomp($answer);
  136:     return $answer;
  137: }
  138: 
  139: sub reply {
  140:     my ($cmd,$server)=@_;
  141:     unless (defined($hostname{$server})) { return 'no_such_host'; }
  142:     my $answer=subreply($cmd,$server);
  143:     if ($answer eq 'con_lost') {
  144:         #sleep 5; 
  145:         #$answer=subreply($cmd,$server);
  146:         #if ($answer eq 'con_lost') {
  147: 	#   &logthis("Second attempt con_lost on $server");
  148:         #   my $peerfile="$perlvar{'lonSockDir'}/$server";
  149:         #   my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
  150:         #                                    Type    => SOCK_STREAM,
  151:         #                                    Timeout => 10)
  152:         #              or return "con_lost";
  153:         #   &logthis("Killing socket");
  154:         #   print $client "close_connection_exit\n";
  155:            #sleep 5;
  156:         #   $answer=subreply($cmd,$server);       
  157:        #}   
  158:     }
  159:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
  160:        &logthis("<font color=blue>WARNING:".
  161:                 " $cmd to $server returned $answer</font>");
  162:     }
  163:     return $answer;
  164: }
  165: 
  166: # ----------------------------------------------------------- Send USR1 to lonc
  167: 
  168: sub reconlonc {
  169:     my $peerfile=shift;
  170:     &logthis("Trying to reconnect for $peerfile");
  171:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
  172:     if (my $fh=Apache::File->new("$loncfile")) {
  173: 	my $loncpid=<$fh>;
  174:         chomp($loncpid);
  175:         if (kill 0 => $loncpid) {
  176: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
  177:             kill USR1 => $loncpid;
  178:             sleep 1;
  179:             if (-e "$peerfile") { return; }
  180:             &logthis("$peerfile still not there, give it another try");
  181:             sleep 5;
  182:             if (-e "$peerfile") { return; }
  183:             &logthis(
  184:   "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
  185:         } else {
  186: 	    &logthis(
  187:                "<font color=blue>WARNING:".
  188:                " lonc at pid $loncpid not responding, giving up</font>");
  189:         }
  190:     } else {
  191:      &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
  192:     }
  193: }
  194: 
  195: # ------------------------------------------------------ Critical communication
  196: 
  197: sub critical {
  198:     my ($cmd,$server)=@_;
  199:     unless ($hostname{$server}) {
  200:         &logthis("<font color=blue>WARNING:".
  201:                " Critical message to unknown server ($server)</font>");
  202:         return 'no_such_host';
  203:     }
  204:     my $answer=reply($cmd,$server);
  205:     if ($answer eq 'con_lost') {
  206:         my $pingreply=reply('ping',$server);
  207: 	&reconlonc("$perlvar{'lonSockDir'}/$server");
  208:         my $pongreply=reply('pong',$server);
  209:         &logthis("Ping/Pong for $server: $pingreply/$pongreply");
  210:         $answer=reply($cmd,$server);
  211:         if ($answer eq 'con_lost') {
  212:             my $now=time;
  213:             my $middlename=$cmd;
  214:             $middlename=substr($middlename,0,16);
  215:             $middlename=~s/\W//g;
  216:             my $dfilename=
  217:       "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
  218:             $dumpcount++;
  219:             {
  220:              my $dfh;
  221:              if ($dfh=Apache::File->new(">$dfilename")) {
  222:                 print $dfh "$cmd\n";
  223: 	     }
  224:             }
  225:             sleep 2;
  226:             my $wcmd='';
  227:             {
  228: 	     my $dfh;
  229:              if ($dfh=Apache::File->new("$dfilename")) {
  230:                 $wcmd=<$dfh>;
  231: 	     }
  232:             }
  233:             chomp($wcmd);
  234:             if ($wcmd eq $cmd) {
  235: 		&logthis("<font color=blue>WARNING: ".
  236:                          "Connection buffer $dfilename: $cmd</font>");
  237:                 &logperm("D:$server:$cmd");
  238: 	        return 'con_delayed';
  239:             } else {
  240:                 &logthis("<font color=red>CRITICAL:"
  241:                         ." Critical connection failed: $server $cmd</font>");
  242:                 &logperm("F:$server:$cmd");
  243:                 return 'con_failed';
  244:             }
  245:         }
  246:     }
  247:     return $answer;
  248: }
  249: 
  250: #
  251: # -------------- Remove all key from the env that start witha lowercase letter
  252: #                (Which is always a lon-capa value)
  253: 
  254: sub cleanenv {
  255: #    unless (defined(&Apache::exists_config_define("MODPERL2"))) { return; }
  256: #    unless (&Apache::exists_config_define("MODPERL2")) { return; }
  257:     foreach my $key (keys(%ENV)) {
  258: 	if ($key =~ /^[a-z]/) {
  259: 	    delete($ENV{$key});
  260: 	}
  261:     }
  262: }
  263:  
  264: # ------------------------------------------- Transfer profile into environment
  265: 
  266: sub transfer_profile_to_env {
  267:     my ($lonidsdir,$handle)=@_;
  268:     my @profile;
  269:     {
  270: 	my $idf=Apache::File->new("$lonidsdir/$handle.id");
  271: 	flock($idf,LOCK_SH);
  272: 	@profile=<$idf>;
  273: 	$idf->close();
  274:     }
  275:     my $envi;
  276:     for ($envi=0;$envi<=$#profile;$envi++) {
  277: 	chomp($profile[$envi]);
  278: 	my ($envname,$envvalue)=split(/=/,$profile[$envi]);
  279: 	$ENV{$envname} = $envvalue;
  280:     }
  281:     $ENV{'user.environment'} = "$lonidsdir/$handle.id";
  282: }
  283: 
  284: # ---------------------------------------------------------- Append Environment
  285: 
  286: sub appenv {
  287:     my %newenv=@_;
  288:     foreach (keys %newenv) {
  289: 	if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
  290:             &logthis("<font color=blue>WARNING: ".
  291:                 "Attempt to modify environment ".$_." to ".$newenv{$_}
  292:                 .'</font>');
  293: 	    delete($newenv{$_});
  294:         } else {
  295:             $ENV{$_}=$newenv{$_};
  296:         }
  297:     }
  298: 
  299:     my $lockfh;
  300:     unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
  301:        return 'error: '.$!;
  302:     }
  303:     unless (flock($lockfh,LOCK_EX)) {
  304:          &logthis("<font color=blue>WARNING: ".
  305:                   'Could not obtain exclusive lock in appenv: '.$!);
  306:          $lockfh->close();
  307:          return 'error: '.$!;
  308:     }
  309: 
  310:     my @oldenv;
  311:     {
  312:      my $fh;
  313:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
  314: 	return 'error: '.$!;
  315:      }
  316:      @oldenv=<$fh>;
  317:      $fh->close();
  318:     }
  319:     for (my $i=0; $i<=$#oldenv; $i++) {
  320:         chomp($oldenv[$i]);
  321:         if ($oldenv[$i] ne '') {
  322:            my ($name,$value)=split(/=/,$oldenv[$i]);
  323:            unless (defined($newenv{$name})) {
  324: 	      $newenv{$name}=$value;
  325: 	   }
  326:         }
  327:     }
  328:     {
  329:      my $fh;
  330:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
  331: 	return 'error';
  332:      }
  333:      my $newname;
  334:      foreach $newname (keys %newenv) {
  335: 	 print $fh "$newname=$newenv{$newname}\n";
  336:      }
  337:      $fh->close();
  338:     }
  339: 
  340:     $lockfh->close();
  341:     return 'ok';
  342: }
  343: # ----------------------------------------------------- Delete from Environment
  344: 
  345: sub delenv {
  346:     my $delthis=shift;
  347:     my %newenv=();
  348:     if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
  349:         &logthis("<font color=blue>WARNING: ".
  350:                 "Attempt to delete from environment ".$delthis);
  351:         return 'error';
  352:     }
  353:     my @oldenv;
  354:     {
  355:      my $fh;
  356:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
  357: 	return 'error';
  358:      }
  359:      unless (flock($fh,LOCK_SH)) {
  360:          &logthis("<font color=blue>WARNING: ".
  361:                   'Could not obtain shared lock in delenv: '.$!);
  362:          $fh->close();
  363:          return 'error: '.$!;
  364:      }
  365:      @oldenv=<$fh>;
  366:      $fh->close();
  367:     }
  368:     {
  369:      my $fh;
  370:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
  371: 	return 'error';
  372:      }
  373:      unless (flock($fh,LOCK_EX)) {
  374:          &logthis("<font color=blue>WARNING: ".
  375:                   'Could not obtain exclusive lock in delenv: '.$!);
  376:          $fh->close();
  377:          return 'error: '.$!;
  378:      }
  379:      foreach (@oldenv) {
  380: 	 unless ($_=~/^$delthis/) { print $fh $_; }
  381:      }
  382:      $fh->close();
  383:     }
  384:     return 'ok';
  385: }
  386: 
  387: # ------------------------------------------ Find out current server userload
  388: # there is a copy in lond
  389: sub userload {
  390:     my $numusers=0;
  391:     {
  392: 	opendir(LONIDS,$perlvar{'lonIDsDir'});
  393: 	my $filename;
  394: 	my $curtime=time;
  395: 	while ($filename=readdir(LONIDS)) {
  396: 	    if ($filename eq '.' || $filename eq '..') {next;}
  397: 	    my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
  398: 	    if ($curtime-$mtime < 3600) { $numusers++; }
  399: 	}
  400: 	closedir(LONIDS);
  401:     }
  402:     my $userloadpercent=0;
  403:     my $maxuserload=$perlvar{'lonUserLoadLim'};
  404:     if ($maxuserload) {
  405: 	$userloadpercent=100*$numusers/$maxuserload;
  406:     }
  407:     $userloadpercent=sprintf("%.2f",$userloadpercent);
  408:     return $userloadpercent;
  409: }
  410: 
  411: # ------------------------------------------ Fight off request when overloaded
  412: 
  413: sub overloaderror {
  414:     my ($r,$checkserver)=@_;
  415:     unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
  416:     my $loadavg;
  417:     if ($checkserver eq $perlvar{'lonHostID'}) {
  418:        my $loadfile=Apache::File->new('/proc/loadavg');
  419:        $loadavg=<$loadfile>;
  420:        $loadavg =~ s/\s.*//g;
  421:        $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
  422:     } else {
  423:        $loadavg=&reply('load',$checkserver);
  424:     }
  425:     my $overload=$loadavg-100;
  426:     if ($overload>0) {
  427: 	$r->err_headers_out->{'Retry-After'}=$overload;
  428:         $r->log_error('Overload of '.$overload.' on '.$checkserver);
  429:         return 413;
  430:     }    
  431:     return '';
  432: }
  433: 
  434: # ------------------------------ Find server with least workload from spare.tab
  435: 
  436: sub spareserver {
  437:     my ($loadpercent,$userloadpercent) = @_;
  438:     my $tryserver;
  439:     my $spareserver='';
  440:     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
  441:     my $lowestserver=$loadpercent > $userloadpercent?
  442: 	             $loadpercent :  $userloadpercent;
  443:     foreach $tryserver (keys %spareid) {
  444: 	my $loadans=reply('load',$tryserver);
  445: 	my $userloadans=reply('userload',$tryserver);
  446: 	if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
  447: 	    next; #didn't get a number from the server
  448: 	}
  449: 	my $answer;
  450: 	if ($loadans =~ /\d/) {
  451: 	    if ($userloadans =~ /\d/) {
  452: 		#both are numbers, pick the bigger one
  453: 		$answer=$loadans > $userloadans?
  454: 		    $loadans :  $userloadans;
  455: 	    } else {
  456: 		$answer = $loadans;
  457: 	    }
  458: 	} else {
  459: 	    $answer = $userloadans;
  460: 	}
  461: 	if (($answer =~ /\d/) && ($answer<$lowestserver)) {
  462: 	    $spareserver="http://$hostname{$tryserver}";
  463: 	    $lowestserver=$answer;
  464: 	}
  465:     }
  466:     return $spareserver;
  467: }
  468: 
  469: # --------------------------------------------- Try to change a user's password
  470: 
  471: sub changepass {
  472:     my ($uname,$udom,$currentpass,$newpass,$server)=@_;
  473:     $currentpass = &escape($currentpass);
  474:     $newpass     = &escape($newpass);
  475:     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
  476: 		       $server);
  477:     if (! $answer) {
  478: 	&logthis("No reply on password change request to $server ".
  479: 		 "by $uname in domain $udom.");
  480:     } elsif ($answer =~ "^ok") {
  481:         &logthis("$uname in $udom successfully changed their password ".
  482: 		 "on $server.");
  483:     } elsif ($answer =~ "^pwchange_failure") {
  484: 	&logthis("$uname in $udom was unable to change their password ".
  485: 		 "on $server.  The action was blocked by either lcpasswd ".
  486: 		 "or pwchange");
  487:     } elsif ($answer =~ "^non_authorized") {
  488:         &logthis("$uname in $udom did not get their password correct when ".
  489: 		 "attempting to change it on $server.");
  490:     } elsif ($answer =~ "^auth_mode_error") {
  491:         &logthis("$uname in $udom attempted to change their password despite ".
  492: 		 "not being locally or internally authenticated on $server.");
  493:     } elsif ($answer =~ "^unknown_user") {
  494:         &logthis("$uname in $udom attempted to change their password ".
  495: 		 "on $server but were unable to because $server is not ".
  496: 		 "their home server.");
  497:     } elsif ($answer =~ "^refused") {
  498: 	&logthis("$server refused to change $uname in $udom password because ".
  499: 		 "it was sent an unencrypted request to change the password.");
  500:     }
  501:     return $answer;
  502: }
  503: 
  504: # ----------------------- Try to determine user's current authentication scheme
  505: 
  506: sub queryauthenticate {
  507:     my ($uname,$udom)=@_;
  508:     if (($perlvar{'lonRole'} eq 'library') && 
  509:         ($udom eq $perlvar{'lonDefDomain'})) {
  510: 	my $answer=reply("encrypt:currentauth:$udom:$uname",
  511: 			 $perlvar{'lonHostID'});
  512: 	unless ($answer eq 'unknown_user' or $answer eq 'refused') {
  513: 	    if (length($answer)) {
  514: 		return $answer;
  515: 	    }
  516: 	    else {
  517: 	&logthis("User $uname at $udom lacks an authentication mechanism");
  518: 		return 'no_host';
  519: 	    }
  520: 	}
  521:     }
  522: 
  523:     my $tryserver;
  524:     foreach $tryserver (keys %libserv) {
  525: 	if ($hostdom{$tryserver} eq $udom) {
  526:            my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
  527: 	   unless ($answer eq 'unknown_user' or $answer eq 'refused') {
  528: 	       if (length($answer)) {
  529: 		   return $answer;
  530: 	       }
  531: 	       else {
  532: 	   &logthis("User $uname at $udom lacks an authentication mechanism");
  533: 		   return 'no_host';
  534: 	       }
  535: 	   }
  536:        }
  537:     }
  538:     &logthis("User $uname at $udom lacks an authentication mechanism");    
  539:     return 'no_host';
  540: }
  541: 
  542: # --------- Try to authenticate user from domain's lib servers (first this one)
  543: 
  544: sub authenticate {
  545:     my ($uname,$upass,$udom)=@_;
  546:     $upass=escape($upass);
  547:     $uname=~s/\W//g;
  548:     if (($perlvar{'lonRole'} eq 'library') && 
  549:         ($udom eq $perlvar{'lonDefDomain'})) {
  550:     my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
  551:         if ($answer =~ /authorized/) {
  552:               if ($answer eq 'authorized') {
  553:                  &logthis("User $uname at $udom authorized by local server"); 
  554:                  return $perlvar{'lonHostID'}; 
  555:               }
  556:               if ($answer eq 'non_authorized') {
  557:                  &logthis("User $uname at $udom rejected by local server"); 
  558:                  return 'no_host'; 
  559:               }
  560: 	}
  561:     }
  562: 
  563:     my $tryserver;
  564:     foreach $tryserver (keys %libserv) {
  565: 	if ($hostdom{$tryserver} eq $udom) {
  566:            my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
  567:            if ($answer =~ /authorized/) {
  568:               if ($answer eq 'authorized') {
  569:                  &logthis("User $uname at $udom authorized by $tryserver"); 
  570:                  return $tryserver; 
  571:               }
  572:               if ($answer eq 'non_authorized') {
  573:                  &logthis("User $uname at $udom rejected by $tryserver");
  574:                  return 'no_host';
  575:               } 
  576: 	   }
  577:        }
  578:     }
  579:     &logthis("User $uname at $udom could not be authenticated");    
  580:     return 'no_host';
  581: }
  582: 
  583: # ---------------------- Find the homebase for a user from domain's lib servers
  584: 
  585: sub homeserver {
  586:     my ($uname,$udom,$ignoreBadCache)=@_;
  587:     my $index="$uname:$udom";
  588:     if ($homecache{$index}) { 
  589:         return "$homecache{$index}"; 
  590:     }
  591:     my $tryserver;
  592:     foreach $tryserver (keys %libserv) {
  593:         next if ($ignoreBadCache ne 'true' && 
  594: 		 exists($badServerCache{$tryserver}));
  595: 	if ($hostdom{$tryserver} eq $udom) {
  596:            my $answer=reply("home:$udom:$uname",$tryserver);
  597:            if ($answer eq 'found') { 
  598:               $homecache{$index}=$tryserver;
  599:               return $tryserver; 
  600:            } elsif ($answer eq 'no_host') {
  601: 	       $badServerCache{$tryserver}=1;
  602:            }
  603:        }
  604:     }    
  605:     return 'no_host';
  606: }
  607: 
  608: # ------------------------------------- Find the usernames behind a list of IDs
  609: 
  610: sub idget {
  611:     my ($udom,@ids)=@_;
  612:     my %returnhash=();
  613:     
  614:     my $tryserver;
  615:     foreach $tryserver (keys %libserv) {
  616:        if ($hostdom{$tryserver} eq $udom) {
  617: 	  my $idlist=join('&',@ids);
  618:           $idlist=~tr/A-Z/a-z/; 
  619: 	  my $reply=&reply("idget:$udom:".$idlist,$tryserver);
  620:           my @answer=();
  621:           if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
  622: 	      @answer=split(/\&/,$reply);
  623:           }                    ;
  624:           my $i;
  625:           for ($i=0;$i<=$#ids;$i++) {
  626:               if ($answer[$i]) {
  627: 		  $returnhash{$ids[$i]}=$answer[$i];
  628:               } 
  629:           }
  630:        }
  631:     }    
  632:     return %returnhash;
  633: }
  634: 
  635: # ------------------------------------- Find the IDs behind a list of usernames
  636: 
  637: sub idrget {
  638:     my ($udom,@unames)=@_;
  639:     my %returnhash=();
  640:     foreach (@unames) {
  641:         $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
  642:     }
  643:     return %returnhash;
  644: }
  645: 
  646: # ------------------------------- Store away a list of names and associated IDs
  647: 
  648: sub idput {
  649:     my ($udom,%ids)=@_;
  650:     my %servers=();
  651:     foreach (keys %ids) {
  652:         my $uhom=&homeserver($_,$udom);
  653:         if ($uhom ne 'no_host') {
  654:             my $id=&escape($ids{$_});
  655:             $id=~tr/A-Z/a-z/;
  656:             my $unam=&escape($_);
  657: 	    if ($servers{$uhom}) {
  658: 		$servers{$uhom}.='&'.$id.'='.$unam;
  659:             } else {
  660:                 $servers{$uhom}=$id.'='.$unam;
  661:             }
  662:             &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
  663:         }
  664:     }
  665:     foreach (keys %servers) {
  666:         &critical('idput:'.$udom.':'.$servers{$_},$_);
  667:     }
  668: }
  669: 
  670: # --------------------------------------------------- Assign a key to a student
  671: 
  672: sub assign_access_key {
  673: #
  674: # a valid key looks like uname:udom#comments
  675: # comments are being appended
  676: #
  677:     my ($ckey,$cdom,$cnum,$udom,$uname,$logentry)=@_;
  678:     $cdom=
  679:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
  680:     $cnum=
  681:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
  682:     $udom=$ENV{'user.name'} unless (defined($udom));
  683:     $uname=$ENV{'user.domain'} unless (defined($uname));
  684:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
  685:     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
  686:         ($existing{$ckey}=~/^$uname\:$udom\#(.*)$/)) { 
  687:                                                   # assigned to this person
  688:                                                   # - this should not happen,
  689:                                                   # unless something went wrong
  690:                                                   # the first time around
  691: # ready to assign
  692:         $logentry=$1.'; '.$logentry;
  693:         if (&put('accesskey',{$ckey=>$uname.':'.$udom.'#'.$logentry},
  694:                                                  $cdom,$cnum) eq 'ok') {
  695: # key now belongs to user
  696: 	    my $envkey='key.'.$cdom.'_'.$cnum;
  697:             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
  698:                 &appenv('environment.'.$envkey => $ckey);
  699:                 return 'ok';
  700:             } else {
  701:                 return 
  702:   'error: Count not permanently assign key, will need to be re-entered later.';
  703: 	    }
  704:         } else {
  705:             return 'error: Could not assign key, try again later.';
  706:         }
  707:     } elsif (!$existing{$ckey}) {
  708: # the key does not exist
  709: 	return 'error: The key does not exist';
  710:     } else {
  711: # the key is somebody else's
  712: 	return 'error: The key is already in use';
  713:     }
  714: }
  715: 
  716: # ------------------------------------------ put an additional comment on a key
  717: 
  718: sub comment_access_key {
  719: #
  720: # a valid key looks like uname:udom#comments
  721: # comments are being appended
  722: #
  723:     my ($ckey,$cdom,$cnum,$logentry)=@_;
  724:     $cdom=
  725:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
  726:     $cnum=
  727:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
  728:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
  729:     if ($existing{$ckey}) {
  730:         $existing{$ckey}.='; '.$logentry;
  731: # ready to assign
  732:         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
  733:                                                  $cdom,$cnum) eq 'ok') {
  734: 	    return 'ok';
  735:         } else {
  736: 	    return 'error: Count not store comment.';
  737:         }
  738:     } else {
  739: # the key does not exist
  740: 	return 'error: The key does not exist';
  741:     }
  742: }
  743: 
  744: # ------------------------------------------------------ Generate a set of keys
  745: 
  746: sub generate_access_keys {
  747:     my ($number,$cdom,$cnum,$logentry)=@_;
  748:     $cdom=
  749:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
  750:     $cnum=
  751:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
  752:     unless (&allowed('mky',$cdom)) { return 0; }
  753:     unless (($cdom) && ($cnum)) { return 0; }
  754:     if ($number>10000) { return 0; }
  755:     sleep(2); # make sure don't get same seed twice
  756:     srand(time()^($$+($$<<15))); # from "Programming Perl"
  757:     my $total=0;
  758:     for (my $i=1;$i<=$number;$i++) {
  759:        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
  760:                   sprintf("%lx",int(100000*rand)).'-'.
  761:                   sprintf("%lx",int(100000*rand));
  762:        $newkey=~s/1/g/g; # folks mix up 1 and l
  763:        $newkey=~s/0/h/g; # and also 0 and O
  764:        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
  765:        if ($existing{$newkey}) {
  766:            $i--;
  767:        } else {
  768: 	  if (&put('accesskeys',
  769:               { $newkey => '# generated '.localtime().
  770:                            ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}.
  771:                            '; '.$logentry },
  772: 		   $cdom,$cnum) eq 'ok') {
  773:               $total++;
  774: 	  }
  775:        }
  776:     }
  777:     &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
  778:          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
  779:     return $total;
  780: }
  781: 
  782: # ------------------------------------------------------- Validate an accesskey
  783: 
  784: sub validate_access_key {
  785:     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
  786:     $cdom=
  787:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
  788:     $cnum=
  789:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
  790:     $udom=$ENV{'user.name'} unless (defined($udom));
  791:     $uname=$ENV{'user.domain'} unless (defined($uname));
  792:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
  793:     return ($existing{$ckey}=~/^$uname\:$udom\#/);
  794: }
  795: 
  796: # ------------------------------------- Find the section of student in a course
  797: 
  798: sub getsection {
  799:     my ($udom,$unam,$courseid)=@_;
  800:     $courseid=~s/\_/\//g;
  801:     $courseid=~s/^(\w)/\/$1/;
  802:     my %Pending; 
  803:     my %Expired;
  804:     #
  805:     # Each role can either have not started yet (pending), be active, 
  806:     #    or have expired.
  807:     #
  808:     # If there is an active role, we are done.
  809:     #
  810:     # If there is more than one role which has not started yet, 
  811:     #     choose the one which will start sooner
  812:     # If there is one role which has not started yet, return it.
  813:     #
  814:     # If there is more than one expired role, choose the one which ended last.
  815:     # If there is a role which has expired, return it.
  816:     #
  817:     foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
  818:                         &homeserver($unam,$udom)))) {
  819:         my ($key,$value)=split(/\=/,$_);
  820:         $key=&unescape($key);
  821:         next if ($key !~/^$courseid(?:\/)*(\w+)*\_st$/);
  822:         my $section=$1;
  823:         if ($key eq $courseid.'_st') { $section=''; }
  824:         my ($dummy,$end,$start)=split(/\_/,&unescape($value));
  825:         my $now=time;
  826:         if (defined($end) && ($now > $end)) {
  827:             $Expired{$end}=$section;
  828:             next;
  829:         }
  830:         if (defined($start) && ($now < $start)) {
  831:             $Pending{$start}=$section;
  832:             next;
  833:         }
  834:         return $section;
  835:     }
  836:     #
  837:     # Presumedly there will be few matching roles from the above
  838:     # loop and the sorting time will be negligible.
  839:     if (scalar(keys(%Pending))) {
  840:         my ($time) = sort {$a <=> $b} keys(%Pending);
  841:         return $Pending{$time};
  842:     } 
  843:     if (scalar(keys(%Expired))) {
  844:         my @sorted = sort {$a <=> $b} keys(%Expired);
  845:         my $time = pop(@sorted);
  846:         return $Expired{$time};
  847:     }
  848:     return '-1';
  849: }
  850: 
  851: sub devalidate_cache {
  852:     my ($cache,$id) = @_;
  853:     delete $$cache{$id.'.time'};
  854:     delete $$cache{$id};
  855: }
  856: 
  857: sub is_cached {
  858:     my ($cache,$id,$time) = @_;
  859:     if (!$time) { $time=300; }
  860:     if (!exists($$cache{$id.'.time'})) {
  861: 	return (undef,undef);
  862:     } else {
  863: 	if (time-$$cache{$id.'.time'}>$time) {
  864: 	    &devalidate_cache($cache,$id);
  865: 	    return (undef,undef);
  866: 	}
  867:     }
  868:     return ($$cache{$id},1);
  869: }
  870: 
  871: sub do_cache {
  872:     my ($cache,$id,$value) = @_;
  873:     $$cache{$id.'.time'}=time;
  874:     # do_cache implictly return the set value
  875:     $$cache{$id}=$value;
  876: }
  877: 
  878: sub usection {
  879:     my ($udom,$unam,$courseid)=@_;
  880:     my $hashid="$udom:$unam:$courseid";
  881:     
  882:     my ($result,$cached)=&is_cached(\%usectioncache,$hashid);
  883:     if (defined($cached)) { return $result; }
  884:     $courseid=~s/\_/\//g;
  885:     $courseid=~s/^(\w)/\/$1/;
  886:     foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
  887:                         &homeserver($unam,$udom)))) {
  888:         my ($key,$value)=split(/\=/,$_);
  889:         $key=&unescape($key);
  890:         if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
  891:             my $section=$1;
  892:             if ($key eq $courseid.'_st') { $section=''; }
  893: 	    my ($dummy,$end,$start)=split(/\_/,&unescape($value));
  894:             my $now=time;
  895:             my $notactive=0;
  896:             if ($start) {
  897: 		if ($now<$start) { $notactive=1; }
  898:             }
  899:             if ($end) {
  900:                 if ($now>$end) { $notactive=1; }
  901:             } 
  902:             unless ($notactive) {
  903: 		return &do_cache(\%usectioncache,$hashid,$section);
  904: 	    }
  905:         }
  906:     }
  907:     return &do_cache(\%usectioncache,$hashid,'-1');
  908: }
  909: 
  910: # ------------------------------------- Read an entry from a user's environment
  911: 
  912: sub userenvironment {
  913:     my ($udom,$unam,@what)=@_;
  914:     my %returnhash=();
  915:     my @answer=split(/\&/,
  916:                 &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
  917:                       &homeserver($unam,$udom)));
  918:     my $i;
  919:     for ($i=0;$i<=$#what;$i++) {
  920: 	$returnhash{$what[$i]}=&unescape($answer[$i]);
  921:     }
  922:     return %returnhash;
  923: }
  924: 
  925: # -------------------------------------------------------------------- New chat
  926: 
  927: sub chatsend {
  928:     my ($newentry,$anon)=@_;
  929:     my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
  930:     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
  931:     my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
  932:     &reply('chatsend:'.$cdom.':'.$cnum.':'.
  933: 	   &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
  934: 		   &escape($newentry)),$chome);
  935: }
  936: 
  937: # ------------------------------------------ Find current version of a resource
  938: 
  939: sub getversion {
  940:     my $fname=&clutter(shift);
  941:     unless ($fname=~/^\/res\//) { return -1; }
  942:     return &currentversion(&filelocation('',$fname));
  943: }
  944: 
  945: sub currentversion {
  946:     my $fname=shift;
  947:     my $author=$fname;
  948:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
  949:     my ($udom,$uname)=split(/\//,$author);
  950:     my $home=homeserver($uname,$udom);
  951:     if ($home eq 'no_host') { 
  952:         return -1; 
  953:     }
  954:     my $answer=reply("currentversion:$fname",$home);
  955:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
  956: 	return -1;
  957:     }
  958:     return $answer;
  959: }
  960: 
  961: # ----------------------------- Subscribe to a resource, return URL if possible
  962: 
  963: sub subscribe {
  964:     my $fname=shift;
  965:     if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
  966:     my $author=$fname;
  967:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
  968:     my ($udom,$uname)=split(/\//,$author);
  969:     my $home=homeserver($uname,$udom);
  970:     if ($home eq 'no_host') {
  971:         return 'not_found';
  972:     }
  973:     my $answer=reply("sub:$fname",$home);
  974:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
  975: 	$answer.=' by '.$home;
  976:     }
  977:     return $answer;
  978: }
  979:     
  980: # -------------------------------------------------------------- Replicate file
  981: 
  982: sub repcopy {
  983:     my $filename=shift;
  984:     $filename=~s/\/+/\//g;
  985:     if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
  986:     my $transname="$filename.in.transfer";
  987:     if ((-e $filename) || (-e $transname)) { return OK; }
  988:     my $remoteurl=subscribe($filename);
  989:     if ($remoteurl =~ /^con_lost by/) {
  990: 	   &logthis("Subscribe returned $remoteurl: $filename");
  991:            return HTTP_SERVICE_UNAVAILABLE;
  992:     } elsif ($remoteurl eq 'not_found') {
  993: 	   &logthis("Subscribe returned not_found: $filename");
  994: 	   return HTTP_NOT_FOUND;
  995:     } elsif ($remoteurl =~ /^rejected by/) {
  996: 	   &logthis("Subscribe returned $remoteurl: $filename");
  997:            return FORBIDDEN;
  998:     } elsif ($remoteurl eq 'directory') {
  999:            return OK;
 1000:     } else {
 1001:         my $author=$filename;
 1002:         $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
 1003:         my ($udom,$uname)=split(/\//,$author);
 1004:         my $home=homeserver($uname,$udom);
 1005:         unless ($home eq $perlvar{'lonHostID'}) {
 1006:            my @parts=split(/\//,$filename);
 1007:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
 1008:            if ($path ne "$perlvar{'lonDocRoot'}/res") {
 1009:                &logthis("Malconfiguration for replication: $filename");
 1010: 	       return HTTP_BAD_REQUEST;
 1011:            }
 1012:            my $count;
 1013:            for ($count=5;$count<$#parts;$count++) {
 1014:                $path.="/$parts[$count]";
 1015:                if ((-e $path)!=1) {
 1016: 		   mkdir($path,0777);
 1017:                }
 1018:            }
 1019:            my $ua=new LWP::UserAgent;
 1020:            my $request=new HTTP::Request('GET',"$remoteurl");
 1021:            my $response=$ua->request($request,$transname);
 1022:            if ($response->is_error()) {
 1023: 	       unlink($transname);
 1024:                my $message=$response->status_line;
 1025:                &logthis("<font color=blue>WARNING:"
 1026:                        ." LWP get: $message: $filename</font>");
 1027:                return HTTP_SERVICE_UNAVAILABLE;
 1028:            } else {
 1029: 	       if ($remoteurl!~/\.meta$/) {
 1030:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
 1031:                   my $mresponse=$ua->request($mrequest,$filename.'.meta');
 1032:                   if ($mresponse->is_error()) {
 1033: 		      unlink($filename.'.meta');
 1034:                       &logthis(
 1035:                      "<font color=yellow>INFO: No metadata: $filename</font>");
 1036:                   }
 1037: 	       }
 1038:                rename($transname,$filename);
 1039:                return OK;
 1040:            }
 1041:        }
 1042:     }
 1043: }
 1044: 
 1045: # ------------------------------------------------ Get server side include body
 1046: sub ssi_body {
 1047:     my ($filelink,%form)=@_;
 1048:     my $output=($filelink=~/^http\:/?&externalssi($filelink):
 1049:                                      &ssi($filelink,%form));
 1050:     $output=~s/^.*\<body[^\>]*\>//si;
 1051:     $output=~s/\<\/body\s*\>.*$//si;
 1052:     $output=~
 1053:             s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
 1054:     return $output;
 1055: }
 1056: 
 1057: # --------------------------------------------------------- Server Side Include
 1058: 
 1059: sub ssi {
 1060: 
 1061:     my ($fn,%form)=@_;
 1062: 
 1063:     my $ua=new LWP::UserAgent;
 1064:     
 1065:     my $request;
 1066:     
 1067:     if (%form) {
 1068:       $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
 1069:       $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
 1070:     } else {
 1071:       $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
 1072:     }
 1073: 
 1074:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
 1075:     my $response=$ua->request($request);
 1076: 
 1077:     return $response->content;
 1078: }
 1079: 
 1080: sub externalssi {
 1081:     my ($url)=@_;
 1082:     my $ua=new LWP::UserAgent;
 1083:     my $request=new HTTP::Request('GET',$url);
 1084:     my $response=$ua->request($request);
 1085:     return $response->content;
 1086: }
 1087: 
 1088: # ------- Add a token to a remote URI's query string to vouch for access rights
 1089: 
 1090: sub tokenwrapper {
 1091:     my $uri=shift;
 1092:     $uri=~s/^http\:\/\/([^\/]+)//;
 1093:     $uri=~s/^\///;
 1094:     $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
 1095:     my $token=$1;
 1096:     if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
 1097: 	&appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
 1098:         return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
 1099:                (($uri=~/\?/)?'&':'?').'token='.$token.
 1100:                                '&tokenissued='.$perlvar{'lonHostID'};
 1101:     } else {
 1102: 	return '/adm/notfound.html';
 1103:     }
 1104: }
 1105:     
 1106: # --------------- Take an uploaded file and put it into the userfiles directory
 1107: # input: name of form element, coursedoc=1 means this is for the course
 1108: # output: url of file in userspace
 1109: 
 1110: sub userfileupload {
 1111:     my ($formname,$coursedoc)=@_;
 1112:     my $fname=$ENV{'form.'.$formname.'.filename'};
 1113: # Replace Windows backslashes by forward slashes
 1114:     $fname=~s/\\/\//g;
 1115: # Get rid of everything but the actual filename
 1116:     $fname=~s/^.*\/([^\/]+)$/$1/;
 1117: # Replace spaces by underscores
 1118:     $fname=~s/\s+/\_/g;
 1119: # Replace all other weird characters by nothing
 1120:     $fname=~s/[^\w\.\-]//g;
 1121: # See if there is anything left
 1122:     unless ($fname) { return 'error: no uploaded file'; }
 1123:     chop($ENV{'form.'.$formname});
 1124: # Create the directory if not present
 1125:     my $docuname='';
 1126:     my $docudom='';
 1127:     my $docuhome='';
 1128:     if ($coursedoc) {
 1129: 	$docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
 1130: 	$docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
 1131: 	$docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
 1132:     } else {
 1133:         $docuname=$ENV{'user.name'};
 1134:         $docudom=$ENV{'user.domain'};
 1135:         $docuhome=$ENV{'user.home'};
 1136:     }
 1137:     return 
 1138:         &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
 1139: }
 1140: 
 1141: sub finishuserfileupload {
 1142:     my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
 1143:     my $path=$docudom.'/'.$docuname.'/';
 1144:     my $filepath=$perlvar{'lonDocRoot'};
 1145:     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
 1146:     my $count;
 1147:     for ($count=4;$count<=$#parts;$count++) {
 1148:         $filepath.="/$parts[$count]";
 1149:         if ((-e $filepath)!=1) {
 1150: 	    mkdir($filepath,0777);
 1151:         }
 1152:     }
 1153: # Save the file
 1154:     {
 1155:        my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
 1156:        print $fh $ENV{'form.'.$formname};
 1157:     }
 1158: # Notify homeserver to grep it
 1159: #
 1160:     
 1161:     my $fetchresult= 
 1162:  &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome);
 1163:     if ($fetchresult eq 'ok') {
 1164: #
 1165: # Return the URL to it
 1166:         return '/uploaded/'.$path.$fname;
 1167:     } else {
 1168:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$fname.
 1169:          ' to host '.$docuhome.': '.$fetchresult);
 1170:         return '/adm/notfound.html';
 1171:     }    
 1172: }
 1173: 
 1174: # ------------------------------------------------------------------------- Log
 1175: 
 1176: sub log {
 1177:     my ($dom,$nam,$hom,$what)=@_;
 1178:     return critical("log:$dom:$nam:$what",$hom);
 1179: }
 1180: 
 1181: # ------------------------------------------------------------------ Course Log
 1182: #
 1183: # This routine flushes several buffers of non-mission-critical nature
 1184: #
 1185: 
 1186: sub flushcourselogs {
 1187:     &logthis('Flushing log buffers');
 1188: #
 1189: # course logs
 1190: # This is a log of all transactions in a course, which can be used
 1191: # for data mining purposes
 1192: #
 1193: # It also collects the courseid database, which lists last transaction
 1194: # times and course titles for all courseids
 1195: #
 1196:     my %courseidbuffer=();
 1197:     foreach (keys %courselogs) {
 1198:         my $crsid=$_;
 1199:         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
 1200: 		          &escape($courselogs{$crsid}),
 1201: 		          $coursehombuf{$crsid}) eq 'ok') {
 1202: 	    delete $courselogs{$crsid};
 1203:         } else {
 1204:             &logthis('Failed to flush log buffer for '.$crsid);
 1205:             if (length($courselogs{$crsid})>40000) {
 1206:                &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
 1207:                         " exceeded maximum size, deleting.</font>");
 1208:                delete $courselogs{$crsid};
 1209:             }
 1210:         }
 1211:         if ($courseidbuffer{$coursehombuf{$crsid}}) {
 1212:            $courseidbuffer{$coursehombuf{$crsid}}.='&'.
 1213: 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
 1214:         } else {
 1215:            $courseidbuffer{$coursehombuf{$crsid}}=
 1216: 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
 1217:         }    
 1218:     }
 1219: #
 1220: # Write course id database (reverse lookup) to homeserver of courses 
 1221: # Is used in pickcourse
 1222: #
 1223:     foreach (keys %courseidbuffer) {
 1224:         &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
 1225:     }
 1226: #
 1227: # File accesses
 1228: # Writes to the dynamic metadata of resources to get hit counts, etc.
 1229: #
 1230:     foreach (keys %accesshash) {
 1231:         my $entry=$_;
 1232:         $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
 1233:         my %temphash=($entry => $accesshash{$entry});
 1234:         if (&Apache::lonnet::put('nohist_resevaldata',\%temphash,$1,$2) eq 'ok') {
 1235: 	    delete $accesshash{$entry};
 1236:         }
 1237:     }
 1238: #
 1239: # Roles
 1240: # Reverse lookup of user roles for course faculty/staff and co-authorship
 1241: #
 1242:     foreach (keys %userrolehash) {
 1243:         my $entry=$_;
 1244:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
 1245: 	    split(/\:/,$entry);
 1246:         if (&Apache::lonnet::put('nohist_userroles',
 1247:              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
 1248:                 $rudom,$runame) eq 'ok') {
 1249: 	    delete $userrolehash{$entry};
 1250:         }
 1251:     }
 1252:     $dumpcount++;
 1253: }
 1254: 
 1255: sub courselog {
 1256:     my $what=shift;
 1257:     $what=time.':'.$what;
 1258:     unless ($ENV{'request.course.id'}) { return ''; }
 1259:     $coursedombuf{$ENV{'request.course.id'}}=
 1260:        $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
 1261:     $coursenumbuf{$ENV{'request.course.id'}}=
 1262:        $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
 1263:     $coursehombuf{$ENV{'request.course.id'}}=
 1264:        $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
 1265:     $coursedescrbuf{$ENV{'request.course.id'}}=
 1266:        $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
 1267:     if (defined $courselogs{$ENV{'request.course.id'}}) {
 1268: 	$courselogs{$ENV{'request.course.id'}}.='&'.$what;
 1269:     } else {
 1270: 	$courselogs{$ENV{'request.course.id'}}.=$what;
 1271:     }
 1272:     if (length($courselogs{$ENV{'request.course.id'}})>4048) {
 1273: 	&flushcourselogs();
 1274:     }
 1275: }
 1276: 
 1277: sub courseacclog {
 1278:     my $fnsymb=shift;
 1279:     unless ($ENV{'request.course.id'}) { return ''; }
 1280:     my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
 1281:     if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|page)$/) {
 1282:         $what.=':POST';
 1283: 	foreach (keys %ENV) {
 1284:             if ($_=~/^form\.(.*)/) {
 1285: 		$what.=':'.$1.'='.$ENV{$_};
 1286:             }
 1287:         }
 1288:     }
 1289:     &courselog($what);
 1290: }
 1291: 
 1292: sub countacc {
 1293:     my $url=&declutter(shift);
 1294:     unless ($ENV{'request.course.id'}) { return ''; }
 1295:     $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
 1296:     my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
 1297:     if (defined($accesshash{$key})) {
 1298: 	$accesshash{$key}++;
 1299:     } else {
 1300:         $accesshash{$key}=1;
 1301:     }
 1302: }
 1303: 
 1304: sub linklog {
 1305:     my ($from,$to)=@_;
 1306:     $from=&declutter($from);
 1307:     $to=&declutter($to);
 1308:     $accesshash{$from.'___'.$to.'___comefrom'}=1;
 1309:     $accesshash{$to.'___'.$from.'___goto'}=1;
 1310: }
 1311:   
 1312: sub userrolelog {
 1313:     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
 1314:     if (($trole=~/^ca/) || ($trole=~/^in/) || 
 1315:         ($trole=~/^cc/) || ($trole=~/^ep/) ||
 1316:         ($trole=~/^cr/)) {
 1317:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
 1318:        $userrolehash
 1319:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
 1320:                     =$tend.':'.$tstart;
 1321:    }
 1322: }
 1323: 
 1324: sub get_course_adv_roles {
 1325:     my $cid=shift;
 1326:     $cid=$ENV{'request.course.id'} unless (defined($cid));
 1327:     my %coursehash=&coursedescription($cid);
 1328:     my %returnhash=();
 1329:     my %dumphash=
 1330:             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
 1331:     my $now=time;
 1332:     foreach (keys %dumphash) {
 1333: 	my ($tend,$tstart)=split(/\:/,$dumphash{$_});
 1334:         if (($tstart) && ($tstart<0)) { next; }
 1335:         if (($tend) && ($tend<$now)) { next; }
 1336:         if (($tstart) && ($now<$tstart)) { next; }
 1337:         my ($role,$username,$domain,$section)=split(/\:/,$_);
 1338:         my $key=&plaintext($role);
 1339:         if ($section) { $key.=' (Sec/Grp '.$section.')'; }
 1340:         if ($returnhash{$key}) {
 1341: 	    $returnhash{$key}.=','.$username.':'.$domain;
 1342:         } else {
 1343:             $returnhash{$key}=$username.':'.$domain;
 1344:         }
 1345:      }
 1346:     return %returnhash;
 1347: }
 1348: 
 1349: sub get_my_roles {
 1350:     my ($uname,$udom)=@_;
 1351:     unless (defined($uname)) { $uname=$ENV{'user.name'}; }
 1352:     unless (defined($udom)) { $udom=$ENV{'user.domain'}; }
 1353:     my %dumphash=
 1354:             &dump('nohist_userroles',$udom,$uname);
 1355:     my %returnhash=();
 1356:     my $now=time;
 1357:     foreach (keys %dumphash) {
 1358: 	my ($tend,$tstart)=split(/\:/,$dumphash{$_});
 1359:         if (($tstart) && ($tstart<0)) { next; }
 1360:         if (($tend) && ($tend<$now)) { next; }
 1361:         if (($tstart) && ($now<$tstart)) { next; }
 1362:         my ($role,$username,$domain,$section)=split(/\:/,$_);
 1363: 	$returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
 1364:      }
 1365:     return %returnhash;
 1366: }
 1367: 
 1368: # ----------------------------------------------------- Frontpage Announcements
 1369: #
 1370: #
 1371: 
 1372: sub postannounce {
 1373:     my ($server,$text)=@_;
 1374:     unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
 1375:     unless ($text=~/\w/) { $text=''; }
 1376:     return &reply('setannounce:'.&escape($text),$server);
 1377: }
 1378: 
 1379: sub getannounce {
 1380:     if (my $fh=Apache::File->new($perlvar{'lonDocRoot'}.'/announcement.txt')) {
 1381: 	my $announcement='';
 1382: 	while (<$fh>) { $announcement .=$_; }
 1383: 	$fh->close();
 1384: 	if ($announcement=~/\w/) { 
 1385: 	    return 
 1386:    '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
 1387:    '<tr><td bgcolor="#FFFFFF"><pre>'.$announcement.'</pre></td></tr></table>'; 
 1388: 	} else {
 1389: 	    return '';
 1390: 	}
 1391:     } else {
 1392: 	return '';
 1393:     }
 1394: }
 1395: 
 1396: # ---------------------------------------------------------- Course ID routines
 1397: # Deal with domain's nohist_courseid.db files
 1398: #
 1399: 
 1400: sub courseidput {
 1401:     my ($domain,$what,$coursehome)=@_;
 1402:     return &reply('courseidput:'.$domain.':'.$what,$coursehome);
 1403: }
 1404: 
 1405: sub courseiddump {
 1406:     my ($domfilter,$descfilter,$sincefilter)=@_;
 1407:     my %returnhash=();
 1408:     unless ($domfilter) { $domfilter=''; }
 1409:     foreach my $tryserver (keys %libserv) {
 1410: 	if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
 1411: 	    foreach (
 1412:              split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
 1413: 			       $sincefilter.':'.&escape($descfilter),
 1414:                                $tryserver))) {
 1415: 		my ($key,$value)=split(/\=/,$_);
 1416:                 if (($key) && ($value)) {
 1417: 		    $returnhash{&unescape($key)}=&unescape($value);
 1418:                 }
 1419:             }
 1420: 
 1421:         }
 1422:     }
 1423:     return %returnhash;
 1424: }
 1425: 
 1426: #
 1427: # ----------------------------------------------------------- Check out an item
 1428: 
 1429: sub checkout {
 1430:     my ($symb,$tuname,$tudom,$tcrsid)=@_;
 1431:     my $now=time;
 1432:     my $lonhost=$perlvar{'lonHostID'};
 1433:     my $infostr=&escape(
 1434:                  'CHECKOUTTOKEN&'.
 1435:                  $tuname.'&'.
 1436:                  $tudom.'&'.
 1437:                  $tcrsid.'&'.
 1438:                  $symb.'&'.
 1439: 		 $now.'&'.$ENV{'REMOTE_ADDR'});
 1440:     my $token=&reply('tmpput:'.$infostr,$lonhost);
 1441:     if ($token=~/^error\:/) { 
 1442:         &logthis("<font color=blue>WARNING: ".
 1443:                 "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
 1444:                  "</font>");
 1445:         return ''; 
 1446:     }
 1447: 
 1448:     $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
 1449:     $token=~tr/a-z/A-Z/;
 1450: 
 1451:     my %infohash=('resource.0.outtoken' => $token,
 1452:                   'resource.0.checkouttime' => $now,
 1453:                   'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
 1454: 
 1455:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
 1456:        return '';
 1457:     } else {
 1458:         &logthis("<font color=blue>WARNING: ".
 1459:                 "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
 1460:                  "</font>");
 1461:     }    
 1462: 
 1463:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
 1464:                          &escape('Checkout '.$infostr.' - '.
 1465:                                                  $token)) ne 'ok') {
 1466: 	return '';
 1467:     } else {
 1468:         &logthis("<font color=blue>WARNING: ".
 1469:                 "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
 1470:                  "</font>");
 1471:     }
 1472:     return $token;
 1473: }
 1474: 
 1475: # ------------------------------------------------------------ Check in an item
 1476: 
 1477: sub checkin {
 1478:     my $token=shift;
 1479:     my $now=time;
 1480:     my ($ta,$tb,$lonhost)=split(/\*/,$token);
 1481:     $lonhost=~tr/A-Z/a-z/;
 1482:     my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
 1483:     $dtoken=~s/\W/\_/g;
 1484:     my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
 1485:                  split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
 1486: 
 1487:     unless (($tuname) && ($tudom)) {
 1488:         &logthis('Check in '.$token.' ('.$dtoken.') failed');
 1489:         return '';
 1490:     }
 1491:     
 1492:     unless (&allowed('mgr',$tcrsid)) {
 1493:         &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
 1494:                  $ENV{'user.name'}.' - '.$ENV{'user.domain'});
 1495:         return '';
 1496:     }
 1497: 
 1498:     my %infohash=('resource.0.intoken' => $token,
 1499:                   'resource.0.checkintime' => $now,
 1500:                   'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
 1501: 
 1502:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
 1503:        return '';
 1504:     }    
 1505: 
 1506:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
 1507:                          &escape('Checkin - '.$token)) ne 'ok') {
 1508: 	return '';
 1509:     }
 1510: 
 1511:     return ($symb,$tuname,$tudom,$tcrsid);    
 1512: }
 1513: 
 1514: # --------------------------------------------- Set Expire Date for Spreadsheet
 1515: 
 1516: sub expirespread {
 1517:     my ($uname,$udom,$stype,$usymb)=@_;
 1518:     my $cid=$ENV{'request.course.id'}; 
 1519:     if ($cid) {
 1520:        my $now=time;
 1521:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
 1522:        return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
 1523:                             $ENV{'course.'.$cid.'.num'}.
 1524: 	        	    ':nohist_expirationdates:'.
 1525:                             &escape($key).'='.$now,
 1526:                             $ENV{'course.'.$cid.'.home'})
 1527:     }
 1528:     return 'ok';
 1529: }
 1530: 
 1531: # ----------------------------------------------------- Devalidate Spreadsheets
 1532: 
 1533: sub devalidate {
 1534:     my ($symb,$uname,$udom)=@_;
 1535:     my $cid=$ENV{'request.course.id'}; 
 1536:     if ($cid) {
 1537:         # delete the stored spreadsheets for
 1538:         # - the student level sheet of this user in course's homespace
 1539:         # - the assessment level sheet for this resource 
 1540:         #   for this user in user's homespace
 1541: 	my $key=$uname.':'.$udom.':';
 1542:         my $status=
 1543: 	    &del('nohist_calculatedsheets',
 1544: 		 [$key.'studentcalc:'],
 1545: 		 $ENV{'course.'.$cid.'.domain'},
 1546: 		 $ENV{'course.'.$cid.'.num'})
 1547: 		.' '.
 1548: 	    &del('nohist_calculatedsheets_'.$cid,
 1549: 		 [$key.'assesscalc:'.$symb],$udom,$uname);
 1550:         unless ($status eq 'ok ok') {
 1551:            &logthis('Could not devalidate spreadsheet '.
 1552:                     $uname.' at '.$udom.' for '.
 1553: 		    $symb.': '.$status);
 1554:         }
 1555:     }
 1556: }
 1557: 
 1558: sub get_scalar {
 1559:     my ($string,$end) = @_;
 1560:     my $value;
 1561:     if ($$string =~ s/^([^&]*?)($end)/$2/) {
 1562: 	$value = $1;
 1563:     } elsif ($$string =~ s/^([^&]*?)&//) {
 1564: 	$value = $1;
 1565:     }
 1566:     return &unescape($value);
 1567: }
 1568: 
 1569: sub array2str {
 1570:   my (@array) = @_;
 1571:   my $result=&arrayref2str(\@array);
 1572:   $result=~s/^__ARRAY_REF__//;
 1573:   $result=~s/__END_ARRAY_REF__$//;
 1574:   return $result;
 1575: }
 1576: 
 1577: sub arrayref2str {
 1578:   my ($arrayref) = @_;
 1579:   my $result='__ARRAY_REF__';
 1580:   foreach my $elem (@$arrayref) {
 1581:     if(ref($elem) eq 'ARRAY') {
 1582:       $result.=&arrayref2str($elem).'&';
 1583:     } elsif(ref($elem) eq 'HASH') {
 1584:       $result.=&hashref2str($elem).'&';
 1585:     } elsif(ref($elem)) {
 1586:       #print("Got a ref of ".(ref($elem))." skipping.");
 1587:     } else {
 1588:       $result.=&escape($elem).'&';
 1589:     }
 1590:   }
 1591:   $result=~s/\&$//;
 1592:   $result .= '__END_ARRAY_REF__';
 1593:   return $result;
 1594: }
 1595: 
 1596: sub hash2str {
 1597:   my (%hash) = @_;
 1598:   my $result=&hashref2str(\%hash);
 1599:   $result=~s/^__HASH_REF__//;
 1600:   $result=~s/__END_HASH_REF__$//;
 1601:   return $result;
 1602: }
 1603: 
 1604: sub hashref2str {
 1605:   my ($hashref)=@_;
 1606:   my $result='__HASH_REF__';
 1607:   foreach (keys(%$hashref)) {
 1608:     if (ref($_) eq 'ARRAY') {
 1609:       $result.=&arrayref2str($_).'=';
 1610:     } elsif (ref($_) eq 'HASH') {
 1611:       $result.=&hashref2str($_).'=';
 1612:     } elsif (ref($_)) {
 1613:       $result.='=';
 1614:       #print("Got a ref of ".(ref($_))." skipping.");
 1615:     } else {
 1616: 	if ($_) {$result.=&escape($_).'=';} else { last; }
 1617:     }
 1618: 
 1619:     if(ref($hashref->{$_}) eq 'ARRAY') {
 1620:       $result.=&arrayref2str($hashref->{$_}).'&';
 1621:     } elsif(ref($hashref->{$_}) eq 'HASH') {
 1622:       $result.=&hashref2str($hashref->{$_}).'&';
 1623:     } elsif(ref($hashref->{$_})) {
 1624:        $result.='&';
 1625:       #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
 1626:     } else {
 1627:       $result.=&escape($hashref->{$_}).'&';
 1628:     }
 1629:   }
 1630:   $result=~s/\&$//;
 1631:   $result .= '__END_HASH_REF__';
 1632:   return $result;
 1633: }
 1634: 
 1635: sub str2hash {
 1636:     my ($string)=@_;
 1637:     my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
 1638:     return %$hash;
 1639: }
 1640: 
 1641: sub str2hashref {
 1642:   my ($string) = @_;
 1643: 
 1644:   my %hash;
 1645: 
 1646:   if($string !~ /^__HASH_REF__/) {
 1647:       if (! ($string eq '' || !defined($string))) {
 1648: 	  $hash{'error'}='Not hash reference';
 1649:       }
 1650:       return (\%hash, $string);
 1651:   }
 1652: 
 1653:   $string =~ s/^__HASH_REF__//;
 1654: 
 1655:   while($string !~ /^__END_HASH_REF__/) {
 1656:       #key
 1657:       my $key='';
 1658:       if($string =~ /^__HASH_REF__/) {
 1659:           ($key, $string)=&str2hashref($string);
 1660:           if(defined($key->{'error'})) {
 1661:               $hash{'error'}='Bad data';
 1662:               return (\%hash, $string);
 1663:           }
 1664:       } elsif($string =~ /^__ARRAY_REF__/) {
 1665:           ($key, $string)=&str2arrayref($string);
 1666:           if($key->[0] eq 'Array reference error') {
 1667:               $hash{'error'}='Bad data';
 1668:               return (\%hash, $string);
 1669:           }
 1670:       } else {
 1671:           $string =~ s/^(.*?)=//;
 1672: 	  $key=&unescape($1);
 1673:       }
 1674:       $string =~ s/^=//;
 1675: 
 1676:       #value
 1677:       my $value='';
 1678:       if($string =~ /^__HASH_REF__/) {
 1679:           ($value, $string)=&str2hashref($string);
 1680:           if(defined($value->{'error'})) {
 1681:               $hash{'error'}='Bad data';
 1682:               return (\%hash, $string);
 1683:           }
 1684:       } elsif($string =~ /^__ARRAY_REF__/) {
 1685:           ($value, $string)=&str2arrayref($string);
 1686:           if($value->[0] eq 'Array reference error') {
 1687:               $hash{'error'}='Bad data';
 1688:               return (\%hash, $string);
 1689:           }
 1690:       } else {
 1691: 	  $value=&get_scalar(\$string,'__END_HASH_REF__');
 1692:       }
 1693:       $string =~ s/^&//;
 1694: 
 1695:       $hash{$key}=$value;
 1696:   }
 1697: 
 1698:   $string =~ s/^__END_HASH_REF__//;
 1699: 
 1700:   return (\%hash, $string);
 1701: }
 1702: 
 1703: sub str2array {
 1704:     my ($string)=@_;
 1705:     my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
 1706:     return @$array;
 1707: }
 1708: 
 1709: sub str2arrayref {
 1710:   my ($string) = @_;
 1711:   my @array;
 1712: 
 1713:   if($string !~ /^__ARRAY_REF__/) {
 1714:       if (! ($string eq '' || !defined($string))) {
 1715: 	  $array[0]='Array reference error';
 1716:       }
 1717:       return (\@array, $string);
 1718:   }
 1719: 
 1720:   $string =~ s/^__ARRAY_REF__//;
 1721: 
 1722:   while($string !~ /^__END_ARRAY_REF__/) {
 1723:       my $value='';
 1724:       if($string =~ /^__HASH_REF__/) {
 1725:           ($value, $string)=&str2hashref($string);
 1726:           if(defined($value->{'error'})) {
 1727:               $array[0] ='Array reference error';
 1728:               return (\@array, $string);
 1729:           }
 1730:       } elsif($string =~ /^__ARRAY_REF__/) {
 1731:           ($value, $string)=&str2arrayref($string);
 1732:           if($value->[0] eq 'Array reference error') {
 1733:               $array[0] ='Array reference error';
 1734:               return (\@array, $string);
 1735:           }
 1736:       } else {
 1737: 	  $value=&get_scalar(\$string,'__END_ARRAY_REF__');
 1738:       }
 1739:       $string =~ s/^&//;
 1740: 
 1741:       push(@array, $value);
 1742:   }
 1743: 
 1744:   $string =~ s/^__END_ARRAY_REF__//;
 1745: 
 1746:   return (\@array, $string);
 1747: }
 1748: 
 1749: # -------------------------------------------------------------------Temp Store
 1750: 
 1751: sub tmpreset {
 1752:   my ($symb,$namespace,$domain,$stuname) = @_;
 1753:   if (!$symb) {
 1754:     $symb=&symbread();
 1755:     if (!$symb) { $symb= $ENV{'request.url'}; }
 1756:   }
 1757:   $symb=escape($symb);
 1758: 
 1759:   if (!$namespace) { $namespace=$ENV{'request.state'}; }
 1760:   $namespace=~s/\//\_/g;
 1761:   $namespace=~s/\W//g;
 1762: 
 1763:   #FIXME needs to do something for /pub resources
 1764:   if (!$domain) { $domain=$ENV{'user.domain'}; }
 1765:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1766:   my $path=$perlvar{'lonDaemons'}.'/tmp';
 1767:   my %hash;
 1768:   if (tie(%hash,'GDBM_File',
 1769: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
 1770: 	  &GDBM_WRCREAT(),0640)) {
 1771:     foreach my $key (keys %hash) {
 1772:       if ($key=~ /:$symb/) {
 1773: 	delete($hash{$key});
 1774:       }
 1775:     }
 1776:   }
 1777: }
 1778: 
 1779: sub tmpstore {
 1780:   my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
 1781: 
 1782:   if (!$symb) {
 1783:     $symb=&symbread();
 1784:     if (!$symb) { $symb= $ENV{'request.url'}; }
 1785:   }
 1786:   $symb=escape($symb);
 1787: 
 1788:   if (!$namespace) {
 1789:     # I don't think we would ever want to store this for a course.
 1790:     # it seems this will only be used if we don't have a course.
 1791:     #$namespace=$ENV{'request.course.id'};
 1792:     #if (!$namespace) {
 1793:       $namespace=$ENV{'request.state'};
 1794:     #}
 1795:   }
 1796:   $namespace=~s/\//\_/g;
 1797:   $namespace=~s/\W//g;
 1798: #FIXME needs to do something for /pub resources
 1799:   if (!$domain) { $domain=$ENV{'user.domain'}; }
 1800:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1801:   my $now=time;
 1802:   my %hash;
 1803:   my $path=$perlvar{'lonDaemons'}.'/tmp';
 1804:   if (tie(%hash,'GDBM_File',
 1805: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
 1806: 	  &GDBM_WRCREAT(),0640)) {
 1807:     $hash{"version:$symb"}++;
 1808:     my $version=$hash{"version:$symb"};
 1809:     my $allkeys=''; 
 1810:     foreach my $key (keys(%$storehash)) {
 1811:       $allkeys.=$key.':';
 1812:       $hash{"$version:$symb:$key"}=$$storehash{$key};
 1813:     }
 1814:     $hash{"$version:$symb:timestamp"}=$now;
 1815:     $allkeys.='timestamp';
 1816:     $hash{"$version:keys:$symb"}=$allkeys;
 1817:     if (untie(%hash)) {
 1818:       return 'ok';
 1819:     } else {
 1820:       return "error:$!";
 1821:     }
 1822:   } else {
 1823:     return "error:$!";
 1824:   }
 1825: }
 1826: 
 1827: # -----------------------------------------------------------------Temp Restore
 1828: 
 1829: sub tmprestore {
 1830:   my ($symb,$namespace,$domain,$stuname) = @_;
 1831: 
 1832:   if (!$symb) {
 1833:     $symb=&symbread();
 1834:     if (!$symb) { $symb= $ENV{'request.url'}; }
 1835:   }
 1836:   $symb=escape($symb);
 1837: 
 1838:   if (!$namespace) { $namespace=$ENV{'request.state'}; }
 1839:   #FIXME needs to do something for /pub resources
 1840:   if (!$domain) { $domain=$ENV{'user.domain'}; }
 1841:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1842: 
 1843:   my %returnhash;
 1844:   $namespace=~s/\//\_/g;
 1845:   $namespace=~s/\W//g;
 1846:   my %hash;
 1847:   my $path=$perlvar{'lonDaemons'}.'/tmp';
 1848:   if (tie(%hash,'GDBM_File',
 1849: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
 1850: 	  &GDBM_READER(),0640)) {
 1851:     my $version=$hash{"version:$symb"};
 1852:     $returnhash{'version'}=$version;
 1853:     my $scope;
 1854:     for ($scope=1;$scope<=$version;$scope++) {
 1855:       my $vkeys=$hash{"$scope:keys:$symb"};
 1856:       my @keys=split(/:/,$vkeys);
 1857:       my $key;
 1858:       $returnhash{"$scope:keys"}=$vkeys;
 1859:       foreach $key (@keys) {
 1860: 	$returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
 1861: 	$returnhash{"$key"}=$hash{"$scope:$symb:$key"};
 1862:       }
 1863:     }
 1864:     if (!(untie(%hash))) {
 1865:       return "error:$!";
 1866:     }
 1867:   } else {
 1868:     return "error:$!";
 1869:   }
 1870:   return %returnhash;
 1871: }
 1872: 
 1873: # ----------------------------------------------------------------------- Store
 1874: 
 1875: sub store {
 1876:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
 1877:     my $home='';
 1878: 
 1879:     if ($stuname) { $home=&homeserver($stuname,$domain); }
 1880: 
 1881:     $symb=&symbclean($symb);
 1882:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
 1883: 
 1884:     if (!$domain) { $domain=$ENV{'user.domain'}; }
 1885:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1886: 
 1887:     &devalidate($symb,$stuname,$domain);
 1888: 
 1889:     $symb=escape($symb);
 1890:     if (!$namespace) { 
 1891:        unless ($namespace=$ENV{'request.course.id'}) { 
 1892:           return ''; 
 1893:        } 
 1894:     }
 1895:     if (!$home) { $home=$ENV{'user.home'}; }
 1896:     my $namevalue='';
 1897:     foreach (keys %$storehash) {
 1898:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
 1899:     }
 1900:     $namevalue=~s/\&$//;
 1901:     &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
 1902:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
 1903: }
 1904: 
 1905: # -------------------------------------------------------------- Critical Store
 1906: 
 1907: sub cstore {
 1908:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
 1909:     my $home='';
 1910: 
 1911:     if ($stuname) { $home=&homeserver($stuname,$domain); }
 1912: 
 1913:     $symb=&symbclean($symb);
 1914:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
 1915: 
 1916:     if (!$domain) { $domain=$ENV{'user.domain'}; }
 1917:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1918: 
 1919:     &devalidate($symb,$stuname,$domain);
 1920: 
 1921:     $symb=escape($symb);
 1922:     if (!$namespace) { 
 1923:        unless ($namespace=$ENV{'request.course.id'}) { 
 1924:           return ''; 
 1925:        } 
 1926:     }
 1927:     if (!$home) { $home=$ENV{'user.home'}; }
 1928: 
 1929:     my $namevalue='';
 1930:     foreach (keys %$storehash) {
 1931:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
 1932:     }
 1933:     $namevalue=~s/\&$//;
 1934:     &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
 1935:     return critical
 1936:                 ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
 1937: }
 1938: 
 1939: # --------------------------------------------------------------------- Restore
 1940: 
 1941: sub restore {
 1942:     my ($symb,$namespace,$domain,$stuname) = @_;
 1943:     my $home='';
 1944: 
 1945:     if ($stuname) { $home=&homeserver($stuname,$domain); }
 1946: 
 1947:     if (!$symb) {
 1948:       unless ($symb=escape(&symbread())) { return ''; }
 1949:     } else {
 1950:       $symb=&escape(&symbclean($symb));
 1951:     }
 1952:     if (!$namespace) { 
 1953:        unless ($namespace=$ENV{'request.course.id'}) { 
 1954:           return ''; 
 1955:        } 
 1956:     }
 1957:     if (!$domain) { $domain=$ENV{'user.domain'}; }
 1958:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
 1959:     if (!$home) { $home=$ENV{'user.home'}; }
 1960:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
 1961: 
 1962:     my %returnhash=();
 1963:     foreach (split(/\&/,$answer)) {
 1964: 	my ($name,$value)=split(/\=/,$_);
 1965:         $returnhash{&unescape($name)}=&unescape($value);
 1966:     }
 1967:     my $version;
 1968:     for ($version=1;$version<=$returnhash{'version'};$version++) {
 1969:        foreach (split(/\:/,$returnhash{$version.':keys'})) {
 1970:           $returnhash{$_}=$returnhash{$version.':'.$_};
 1971:        }
 1972:     }
 1973:     return %returnhash;
 1974: }
 1975: 
 1976: # ---------------------------------------------------------- Course Description
 1977: 
 1978: sub coursedescription {
 1979:     my $courseid=shift;
 1980:     $courseid=~s/^\///;
 1981:     $courseid=~s/\_/\//g;
 1982:     my ($cdomain,$cnum)=split(/\//,$courseid);
 1983:     my $chome=&homeserver($cnum,$cdomain);
 1984:     my $normalid=$cdomain.'_'.$cnum;
 1985:     # need to always cache even if we get errors otherwise we keep 
 1986:     # trying and trying and trying to get the course description.
 1987:     my %envhash=();
 1988:     my %returnhash=();
 1989:     $envhash{'course.'.$normalid.'.last_cache'}=time;
 1990:     if ($chome ne 'no_host') {
 1991:        %returnhash=&dump('environment',$cdomain,$cnum);
 1992:        if (!exists($returnhash{'con_lost'})) {
 1993:            $returnhash{'home'}= $chome;
 1994: 	   $returnhash{'domain'} = $cdomain;
 1995: 	   $returnhash{'num'} = $cnum;
 1996:            while (my ($name,$value) = each %returnhash) {
 1997:                $envhash{'course.'.$normalid.'.'.$name}=$value;
 1998:            }
 1999:            $returnhash{'url'}=&clutter($returnhash{'url'});
 2000:            $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
 2001: 	       $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
 2002:            $envhash{'course.'.$normalid.'.home'}=$chome;
 2003:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
 2004:            $envhash{'course.'.$normalid.'.num'}=$cnum;
 2005:        }
 2006:     }
 2007:     &appenv(%envhash);
 2008:     return %returnhash;
 2009: }
 2010: 
 2011: # -------------------------------------------------------- Get user privileges
 2012: 
 2013: sub rolesinit {
 2014:     my ($domain,$username,$authhost)=@_;
 2015:     my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
 2016:     if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
 2017:     my %allroles=();
 2018:     my %thesepriv=();
 2019:     my $now=time;
 2020:     my $userroles="user.login.time=$now\n";
 2021:     my $thesestr;
 2022: 
 2023:     if ($rolesdump ne '') {
 2024:         foreach (split(/&/,$rolesdump)) {
 2025: 	  if ($_!~/^rolesdef\&/) {
 2026:             my ($area,$role)=split(/=/,$_);
 2027:             $area=~s/\_\w\w$//;
 2028:             my ($trole,$tend,$tstart)=split(/_/,$role);
 2029:             $userroles.='user.role.'.$trole.'.'.$area.'='.
 2030:                         $tstart.'.'.$tend."\n";
 2031: # log the associated role with the area
 2032:             &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
 2033:             if ($tend!=0) {
 2034: 	        if ($tend<$now) {
 2035: 	            $trole='';
 2036:                 } 
 2037:             }
 2038:             if ($tstart!=0) {
 2039:                 if ($tstart>$now) {
 2040:                    $trole='';        
 2041:                 }
 2042:             }
 2043:             if (($area ne '') && ($trole ne '')) {
 2044: 		my $spec=$trole.'.'.$area;
 2045: 		my ($tdummy,$tdomain,$trest)=split(/\//,$area);
 2046: 		if ($trole =~ /^cr\//) {
 2047: 		    my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
 2048:  		    my $homsvr=homeserver($rauthor,$rdomain);
 2049: 		    if ($hostname{$homsvr} ne '') {
 2050: 			my ($rdummy,$roledef)=
 2051: 			   &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
 2052: 				
 2053: 			if (($rdummy ne 'con_lost') && ($roledef ne '')) {
 2054: 			    my ($syspriv,$dompriv,$coursepriv)=
 2055: 				split(/\_/,$roledef);
 2056: 			    if (defined($syspriv)) {
 2057: 				$allroles{'cm./'}.=':'.$syspriv;
 2058: 				$allroles{$spec.'./'}.=':'.$syspriv;
 2059: 			    }
 2060: 			    if ($tdomain ne '') {
 2061: 				if (defined($dompriv)) {
 2062: 				    $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
 2063: 				    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
 2064: 				}
 2065: 				if ($trest ne '') {
 2066: 				    if (defined($coursepriv)) {
 2067: 					$allroles{'cm.'.$area}.=':'.$coursepriv;
 2068: 					$allroles{$spec.'.'.$area}.=':'.$coursepriv;
 2069: 				    }
 2070: 				}
 2071: 			    }
 2072: 			}
 2073: 		    }
 2074: 		} else {
 2075: 		    if (defined($pr{$trole.':s'})) {
 2076: 			$allroles{'cm./'}.=':'.$pr{$trole.':s'};
 2077: 			$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
 2078: 		    }
 2079: 		    if ($tdomain ne '') {
 2080: 			if (defined($pr{$trole.':d'})) {
 2081: 			    $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
 2082: 			    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
 2083: 			}
 2084: 			if ($trest ne '') {
 2085: 			    if (defined($pr{$trole.':c'})) {
 2086: 				$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
 2087: 				$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
 2088: 			    }
 2089: 			}
 2090: 		    }
 2091: 		}
 2092:             }
 2093:           } 
 2094:         }
 2095:         my $adv=0;
 2096:         my $author=0;
 2097:         foreach (keys %allroles) {
 2098:             %thesepriv=();
 2099:             if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
 2100:             if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
 2101:             foreach (split(/:/,$allroles{$_})) {
 2102:                 if ($_ ne '') {
 2103: 		    my ($privilege,$restrictions)=split(/&/,$_);
 2104:                     if ($restrictions eq '') {
 2105: 			$thesepriv{$privilege}='F';
 2106:                     } else {
 2107:                         if ($thesepriv{$privilege} ne 'F') {
 2108: 			    $thesepriv{$privilege}.=$restrictions;
 2109:                         }
 2110:                     }
 2111:                 }
 2112:             }
 2113:             $thesestr='';
 2114:             foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
 2115:             $userroles.='user.priv.'.$_.'='.$thesestr."\n";
 2116:         }
 2117:         $userroles.='user.adv='.$adv."\n".
 2118: 	            'user.author='.$author."\n";
 2119:         $ENV{'user.adv'}=$adv;
 2120:     }
 2121:     return $userroles;  
 2122: }
 2123: 
 2124: # --------------------------------------------------------------- get interface
 2125: 
 2126: sub get {
 2127:    my ($namespace,$storearr,$udomain,$uname)=@_;
 2128:    my $items='';
 2129:    foreach (@$storearr) {
 2130:        $items.=escape($_).'&';
 2131:    }
 2132:    $items=~s/\&$//;
 2133:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2134:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2135:    my $uhome=&homeserver($uname,$udomain);
 2136: 
 2137:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
 2138:    my @pairs=split(/\&/,$rep);
 2139:    if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
 2140:      return @pairs;
 2141:    }
 2142:    my %returnhash=();
 2143:    my $i=0;
 2144:    foreach (@$storearr) {
 2145:       $returnhash{$_}=unescape($pairs[$i]);
 2146:       $i++;
 2147:    }
 2148:    return %returnhash;
 2149: }
 2150: 
 2151: # --------------------------------------------------------------- del interface
 2152: 
 2153: sub del {
 2154:    my ($namespace,$storearr,$udomain,$uname)=@_;
 2155:    my $items='';
 2156:    foreach (@$storearr) {
 2157:        $items.=escape($_).'&';
 2158:    }
 2159:    $items=~s/\&$//;
 2160:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2161:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2162:    my $uhome=&homeserver($uname,$udomain);
 2163: 
 2164:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
 2165: }
 2166: 
 2167: # -------------------------------------------------------------- dump interface
 2168: 
 2169: sub dump {
 2170:    my ($namespace,$udomain,$uname,$regexp)=@_;
 2171:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2172:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2173:    my $uhome=&homeserver($uname,$udomain);
 2174:    if ($regexp) {
 2175:        $regexp=&escape($regexp);
 2176:    } else {
 2177:        $regexp='.';
 2178:    }
 2179:    my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
 2180:    my @pairs=split(/\&/,$rep);
 2181:    my %returnhash=();
 2182:    foreach (@pairs) {
 2183:       my ($key,$value)=split(/=/,$_);
 2184:       $returnhash{unescape($key)}=unescape($value);
 2185:    }
 2186:    return %returnhash;
 2187: }
 2188: 
 2189: # -------------------------------------------------------------- keys interface
 2190: 
 2191: sub getkeys {
 2192:    my ($namespace,$udomain,$uname)=@_;
 2193:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2194:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2195:    my $uhome=&homeserver($uname,$udomain);
 2196:    my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
 2197:    my @keyarray=();
 2198:    foreach (split(/\&/,$rep)) {
 2199:       push (@keyarray,&unescape($_));
 2200:    }
 2201:    return @keyarray;
 2202: }
 2203: 
 2204: # --------------------------------------------------------------- currentdump
 2205: sub currentdump {
 2206:    my ($courseid,$sdom,$sname)=@_;
 2207:    $courseid = $ENV{'request.course.id'} if (! defined($courseid));
 2208:    $sdom     = $ENV{'user.domain'}       if (! defined($sdom));
 2209:    $sname    = $ENV{'user.name'}         if (! defined($sname));
 2210:    my $uhome = &homeserver($sname,$sdom);
 2211:    my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
 2212:    return if ($rep =~ /^(error:|no_such_host)/);
 2213:    #
 2214:    my %returnhash=();
 2215:    #
 2216:    if ($rep eq "unknown_cmd") { 
 2217:        # an old lond will not know currentdump
 2218:        # Do a dump and make it look like a currentdump
 2219:        my @tmp = &dump($courseid,$sdom,$sname,'.');
 2220:        return if ($tmp[0] =~ /^(error:|no_such_host)/);
 2221:        my %hash = @tmp;
 2222:        @tmp=();
 2223:        # Code ripped from lond, essentially.  The only difference
 2224:        # here is the unescaping done by lonnet::dump().  Conceivably
 2225:        # we might run in to problems with parameter names =~ /^v\./
 2226:        while (my ($key,$value) = each(%hash)) {
 2227:            my ($v,$symb,$param) = split(/:/,$key);
 2228:            next if ($v eq 'version' || $symb eq 'keys');
 2229:            next if (exists($returnhash{$symb}) &&
 2230:                     exists($returnhash{$symb}->{$param}) &&
 2231:                     $returnhash{$symb}->{'v.'.$param} > $v);
 2232:            $returnhash{$symb}->{$param}=$value;
 2233:            $returnhash{$symb}->{'v.'.$param}=$v;
 2234:        }
 2235:        #
 2236:        # Remove all of the keys in the hashes which keep track of
 2237:        # the version of the parameter.
 2238:        while (my ($symb,$param_hash) = each(%returnhash)) {
 2239:            # use a foreach because we are going to delete from the hash.
 2240:            foreach my $key (keys(%$param_hash)) {
 2241:                delete($param_hash->{$key}) if ($key =~ /^v\./);
 2242:            }
 2243:        }
 2244:    } else {
 2245:        my @pairs=split(/\&/,$rep);
 2246:        foreach (@pairs) {
 2247:            my ($key,$value)=split(/=/,$_);
 2248:            my ($symb,$param) = split(/:/,$key);
 2249:            $returnhash{&unescape($symb)}->{&unescape($param)} = 
 2250:                                                           &unescape($value);
 2251:        }
 2252:    }
 2253:    return %returnhash;
 2254: }
 2255: 
 2256: # --------------------------------------------------------------- put interface
 2257: 
 2258: sub put {
 2259:    my ($namespace,$storehash,$udomain,$uname)=@_;
 2260:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2261:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2262:    my $uhome=&homeserver($uname,$udomain);
 2263:    my $items='';
 2264:    foreach (keys %$storehash) {
 2265:        $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
 2266:    }
 2267:    $items=~s/\&$//;
 2268:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
 2269: }
 2270: 
 2271: # ------------------------------------------------------ critical put interface
 2272: 
 2273: sub cput {
 2274:    my ($namespace,$storehash,$udomain,$uname)=@_;
 2275:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2276:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2277:    my $uhome=&homeserver($uname,$udomain);
 2278:    my $items='';
 2279:    foreach (keys %$storehash) {
 2280:        $items.=escape($_).'='.escape($$storehash{$_}).'&';
 2281:    }
 2282:    $items=~s/\&$//;
 2283:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
 2284: }
 2285: 
 2286: # -------------------------------------------------------------- eget interface
 2287: 
 2288: sub eget {
 2289:    my ($namespace,$storearr,$udomain,$uname)=@_;
 2290:    my $items='';
 2291:    foreach (@$storearr) {
 2292:        $items.=escape($_).'&';
 2293:    }
 2294:    $items=~s/\&$//;
 2295:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 2296:    if (!$uname) { $uname=$ENV{'user.name'}; }
 2297:    my $uhome=&homeserver($uname,$udomain);
 2298:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
 2299:    my @pairs=split(/\&/,$rep);
 2300:    my %returnhash=();
 2301:    my $i=0;
 2302:    foreach (@$storearr) {
 2303:       $returnhash{$_}=unescape($pairs[$i]);
 2304:       $i++;
 2305:    }
 2306:    return %returnhash;
 2307: }
 2308: 
 2309: # ---------------------------------------------- Custom access rule evaluation
 2310: 
 2311: sub customaccess {
 2312:     my ($priv,$uri)=@_;
 2313:     my ($urole,$urealm)=split(/\./,$ENV{'request.role'});
 2314:     $urealm=~s/^\W//;
 2315:     my ($udom,$ucrs,$usec)=split(/\//,$urealm);
 2316:     my $access=0;
 2317:     foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
 2318: 	my ($effect,$realm,$role)=split(/\:/,$_);
 2319:         if ($role) {
 2320: 	   if ($role ne $urole) { next; }
 2321:         }
 2322:         foreach (split(/\s*\,\s*/,$realm)) {
 2323:             my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
 2324:             if ($tdom) {
 2325: 		if ($tdom ne $udom) { next; }
 2326:             }
 2327:             if ($tcrs) {
 2328: 		if ($tcrs ne $ucrs) { next; }
 2329:             }
 2330:             if ($tsec) {
 2331: 		if ($tsec ne $usec) { next; }
 2332:             }
 2333:             $access=($effect eq 'allow');
 2334:             last;
 2335:         }
 2336: 	if ($realm eq '' && $role eq '') {
 2337:             $access=($effect eq 'allow');
 2338: 	}
 2339:     }
 2340:     return $access;
 2341: }
 2342: 
 2343: # ------------------------------------------------- Check for a user privilege
 2344: 
 2345: sub allowed {
 2346:     my ($priv,$uri)=@_;
 2347: 
 2348:     my $orguri=$uri;
 2349:     $uri=&declutter($uri);
 2350: 
 2351:     if (defined($ENV{'allowed.'.$priv})) { return $ENV{'allowed.'.$priv}; }
 2352: # Free bre access to adm and meta resources
 2353: 
 2354:     if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
 2355: 	return 'F';
 2356:     }
 2357: 
 2358: # Free bre to public access
 2359: 
 2360:     if ($priv eq 'bre') {
 2361:         my $copyright=&metadata($uri,'copyright');
 2362: 	if (($copyright eq 'public') && (!$ENV{'request.course.id'})) { 
 2363:            return 'F'; 
 2364:         }
 2365:         if ($copyright eq 'priv') {
 2366:             $uri=~/([^\/]+)\/([^\/]+)\//;
 2367: 	    unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
 2368: 		return '';
 2369:             }
 2370:         }
 2371:         if ($copyright eq 'domain') {
 2372:             $uri=~/([^\/]+)\/([^\/]+)\//;
 2373: 	    unless (($ENV{'user.domain'} eq $1) ||
 2374:                  ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
 2375: 		return '';
 2376:             }
 2377:         }
 2378:         if ($ENV{'request.role'}=~ /li\.\//) {
 2379:             # Library role, so allow browsing of resources in this domain.
 2380:             return 'F';
 2381:         }
 2382:         if ($copyright eq 'custom') {
 2383: 	    unless (&customaccess($priv,$uri)) { return ''; }
 2384:         }
 2385:     }
 2386:     # Domain coordinator is trying to create a course
 2387:     if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
 2388:         # uri is the requested domain in this case.
 2389:         # comparison to 'request.role.domain' shows if the user has selected
 2390:         # a role of dc for the domain in question. 
 2391:         return 'F' if ($uri eq $ENV{'request.role.domain'});
 2392:     }
 2393: 
 2394:     my $thisallowed='';
 2395:     my $statecond=0;
 2396:     my $courseprivid='';
 2397: 
 2398: # Course
 2399: 
 2400:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
 2401:        $thisallowed.=$1;
 2402:     }
 2403: 
 2404: # Domain
 2405: 
 2406:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
 2407:        =~/$priv\&([^\:]*)/) {
 2408:        $thisallowed.=$1;
 2409:     }
 2410: 
 2411: # Course: uri itself is a course
 2412:     my $courseuri=$uri;
 2413:     $courseuri=~s/\_(\d)/\/$1/;
 2414:     $courseuri=~s/^([^\/])/\/$1/;
 2415: 
 2416:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
 2417:        =~/$priv\&([^\:]*)/) {
 2418:        $thisallowed.=$1;
 2419:     }
 2420: 
 2421: # URI is an uploaded document for this course
 2422: 
 2423:     if (($priv eq 'bre') && 
 2424:         ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
 2425:         return 'F';
 2426:     }
 2427: # Full access at system, domain or course-wide level? Exit.
 2428: 
 2429:     if ($thisallowed=~/F/) {
 2430: 	return 'F';
 2431:     }
 2432: 
 2433: # If this is generating or modifying users, exit with special codes
 2434: 
 2435:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
 2436: 	return $thisallowed;
 2437:     }
 2438: #
 2439: # Gathered so far: system, domain and course wide privileges
 2440: #
 2441: # Course: See if uri or referer is an individual resource that is part of 
 2442: # the course
 2443: 
 2444:     if ($ENV{'request.course.id'}) {
 2445: 
 2446:        $courseprivid=$ENV{'request.course.id'};
 2447:        if ($ENV{'request.course.sec'}) {
 2448:           $courseprivid.='/'.$ENV{'request.course.sec'};
 2449:        }
 2450:        $courseprivid=~s/\_/\//;
 2451:        my $checkreferer=1;
 2452:        my ($match,$cond)=&is_on_map($uri);
 2453:        if ($match) {
 2454:            $statecond=$cond;
 2455:            if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
 2456:                =~/$priv\&([^\:]*)/) {
 2457:                $thisallowed.=$1;
 2458:                $checkreferer=0;
 2459:            }
 2460:        }
 2461:        
 2462:        if ($checkreferer) {
 2463: 	  my $refuri=$ENV{'httpref.'.$orguri};
 2464:             unless ($refuri) {
 2465:                 foreach (keys %ENV) {
 2466: 		    if ($_=~/^httpref\..*\*/) {
 2467: 			my $pattern=$_;
 2468:                         $pattern=~s/^httpref\.\/res\///;
 2469:                         $pattern=~s/\*/\[\^\/\]\+/g;
 2470:                         $pattern=~s/\//\\\//g;
 2471:                         if ($orguri=~/$pattern/) {
 2472: 			    $refuri=$ENV{$_};
 2473:                         }
 2474:                     }
 2475:                 }
 2476:             }
 2477: 
 2478:          if ($refuri) { 
 2479: 	  $refuri=&declutter($refuri);
 2480:           my ($match,$cond)=&is_on_map($refuri);
 2481:             if ($match) {
 2482:               my $refstatecond=$cond;
 2483:               if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
 2484:                   =~/$priv\&([^\:]*)/) {
 2485:                   $thisallowed.=$1;
 2486:                   $uri=$refuri;
 2487:                   $statecond=$refstatecond;
 2488:               }
 2489:           }
 2490:         }
 2491:        }
 2492:    }
 2493: 
 2494: #
 2495: # Gathered now: all privileges that could apply, and condition number
 2496: # 
 2497: #
 2498: # Full or no access?
 2499: #
 2500: 
 2501:     if ($thisallowed=~/F/) {
 2502: 	return 'F';
 2503:     }
 2504: 
 2505:     unless ($thisallowed) {
 2506:         return '';
 2507:     }
 2508: 
 2509: # Restrictions exist, deal with them
 2510: #
 2511: #   C:according to course preferences
 2512: #   R:according to resource settings
 2513: #   L:unless locked
 2514: #   X:according to user session state
 2515: #
 2516: 
 2517: # Possibly locked functionality, check all courses
 2518: # Locks might take effect only after 10 minutes cache expiration for other
 2519: # courses, and 2 minutes for current course
 2520: 
 2521:     my $envkey;
 2522:     if ($thisallowed=~/L/) {
 2523:         foreach $envkey (keys %ENV) {
 2524:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
 2525:                my $courseid=$2;
 2526:                my $roleid=$1.'.'.$2;
 2527:                $courseid=~s/^\///;
 2528:                my $expiretime=600;
 2529:                if ($ENV{'request.role'} eq $roleid) {
 2530: 		  $expiretime=120;
 2531:                }
 2532: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
 2533:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
 2534:                if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
 2535: 		   &coursedescription($courseid);
 2536:                }
 2537:                if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
 2538:                 || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
 2539: 		   if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
 2540:                        &log($ENV{'user.domain'},$ENV{'user.name'},
 2541:                             $ENV{'user.home'},
 2542:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
 2543:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
 2544:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
 2545: 		       return '';
 2546:                    }
 2547:                }
 2548:                if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
 2549:                 || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
 2550: 		   if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
 2551:                        &log($ENV{'user.domain'},$ENV{'user.name'},
 2552:                             $ENV{'user.home'},
 2553:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
 2554:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
 2555:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
 2556: 		       return '';
 2557:                    }
 2558:                }
 2559: 	   }
 2560:        }
 2561:     }
 2562:    
 2563: #
 2564: # Rest of the restrictions depend on selected course
 2565: #
 2566: 
 2567:     unless ($ENV{'request.course.id'}) {
 2568:        return '1';
 2569:     }
 2570: 
 2571: #
 2572: # Now user is definitely in a course
 2573: #
 2574: 
 2575: 
 2576: # Course preferences
 2577: 
 2578:    if ($thisallowed=~/C/) {
 2579:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
 2580:        my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
 2581:        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
 2582: 	   =~/$rolecode/) {
 2583:            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
 2584:                 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
 2585:                 $ENV{'request.course.id'});
 2586:            return '';
 2587:        }
 2588: 
 2589:        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
 2590: 	   =~/$unamedom/) {
 2591:            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
 2592:                 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
 2593:                 $ENV{'request.course.id'});
 2594:            return '';
 2595:        }
 2596:    }
 2597: 
 2598: # Resource preferences
 2599: 
 2600:    if ($thisallowed=~/R/) {
 2601:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
 2602:        if (&metadata($uri,'roledeny')=~/$rolecode/) {
 2603: 	  &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
 2604:                     'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
 2605:           return '';
 2606:        }
 2607:    }
 2608: 
 2609: # Restricted by state or randomout?
 2610: 
 2611:    if ($thisallowed=~/X/) {
 2612:       if ($ENV{'acc.randomout'}) {
 2613:          my $symb=&symbread($uri,1);
 2614:          if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) { 
 2615:             return ''; 
 2616:          }
 2617:       }
 2618:       if (&condval($statecond)) {
 2619: 	 return '2';
 2620:       } else {
 2621:          return '';
 2622:       }
 2623:    }
 2624: 
 2625:    return 'F';
 2626: }
 2627: 
 2628: # --------------------------------------------------- Is a resource on the map?
 2629: 
 2630: sub is_on_map {
 2631:     my $uri=&declutter(shift);
 2632:     my @uriparts=split(/\//,$uri);
 2633:     my $filename=$uriparts[$#uriparts];
 2634:     my $pathname=$uri;
 2635:     $pathname=~s|/\Q$filename\E$||;
 2636:     $pathname=~s/^adm\/wrapper\///;    
 2637:     #Trying to find the conditional for the file
 2638:     my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
 2639: 	       /\&\Q$filename\E\:([\d\|]+)\&/);
 2640:     if ($match) {
 2641: 	return (1,$1);
 2642:     } else {
 2643: 	my ($name,$ext)=($filename=~/^(.+)\.(\w+)$/);
 2644:         $ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
 2645: 	       /\&(\Q$name\E\.\d+\.$ext)\:([\d\|]+)\&/;
 2646: 	return (0,$2,$pathname.'/'.$1);
 2647:     }
 2648: }
 2649: 
 2650: # ----------------------------------------------------------------- Define Role
 2651: 
 2652: sub definerole {
 2653:   if (allowed('mcr','/')) {
 2654:     my ($rolename,$sysrole,$domrole,$courole)=@_;
 2655:     foreach (split(':',$sysrole)) {
 2656: 	my ($crole,$cqual)=split(/\&/,$_);
 2657:         if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
 2658:         if ($pr{'cr:s'}=~/$crole\&/) {
 2659: 	    if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) { 
 2660:                return "refused:s:$crole&$cqual"; 
 2661:             }
 2662:         }
 2663:     }
 2664:     foreach (split(':',$domrole)) {
 2665: 	my ($crole,$cqual)=split(/\&/,$_);
 2666:         if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
 2667:         if ($pr{'cr:d'}=~/$crole\&/) {
 2668: 	    if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) { 
 2669:                return "refused:d:$crole&$cqual"; 
 2670:             }
 2671:         }
 2672:     }
 2673:     foreach (split(':',$courole)) {
 2674: 	my ($crole,$cqual)=split(/\&/,$_);
 2675:         if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
 2676:         if ($pr{'cr:c'}=~/$crole\&/) {
 2677: 	    if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) { 
 2678:                return "refused:c:$crole&$cqual"; 
 2679:             }
 2680:         }
 2681:     }
 2682:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
 2683:                 "$ENV{'user.domain'}:$ENV{'user.name'}:".
 2684: 	        "rolesdef_$rolename=".
 2685:                 escape($sysrole.'_'.$domrole.'_'.$courole);
 2686:     return reply($command,$ENV{'user.home'});
 2687:   } else {
 2688:     return 'refused';
 2689:   }
 2690: }
 2691: 
 2692: # ---------------- Make a metadata query against the network of library servers
 2693: 
 2694: sub metadata_query {
 2695:     my ($query,$custom,$customshow,$server_array)=@_;
 2696:     my %rhash;
 2697:     my @server_list = (defined($server_array) ? @$server_array
 2698:                                               : keys(%libserv) );
 2699:     for my $server (@server_list) {
 2700: 	unless ($custom or $customshow) {
 2701: 	    my $reply=&reply("querysend:".&escape($query),$server);
 2702: 	    $rhash{$server}=$reply;
 2703: 	}
 2704: 	else {
 2705: 	    my $reply=&reply("querysend:".&escape($query).':'.
 2706: 			     &escape($custom).':'.&escape($customshow),
 2707: 			     $server);
 2708: 	    $rhash{$server}=$reply;
 2709: 	}
 2710:     }
 2711:     return \%rhash;
 2712: }
 2713: 
 2714: # ----------------------------------------- Send log queries and wait for reply
 2715: 
 2716: sub log_query {
 2717:     my ($uname,$udom,$query,%filters)=@_;
 2718:     my $uhome=&homeserver($uname,$udom);
 2719:     if ($uhome eq 'no_host') { return 'error: no_host'; }
 2720:     my $uhost=$hostname{$uhome};
 2721:     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
 2722:     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
 2723:                        $uhome);
 2724:     unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
 2725:     return get_query_reply($queryid);
 2726: }
 2727: 
 2728: sub get_query_reply {
 2729:     my $queryid=shift;
 2730:     my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
 2731:     my $reply='';
 2732:     for (1..100) {
 2733: 	sleep 2;
 2734:         if (-e $replyfile.'.end') {
 2735: 	    if (my $fh=Apache::File->new($replyfile)) {
 2736:                $reply.=<$fh>;
 2737:                $fh->close;
 2738: 	   } else { return 'error: reply_file_error'; }
 2739:            return &unescape($reply);
 2740: 	}
 2741:     }
 2742:     return 'timeout:'.$queryid;
 2743: }
 2744: 
 2745: sub courselog_query {
 2746: #
 2747: # possible filters:
 2748: # url: url or symb
 2749: # username
 2750: # domain
 2751: # action: view, submit, grade
 2752: # start: timestamp
 2753: # end: timestamp
 2754: #
 2755:     my (%filters)=@_;
 2756:     unless ($ENV{'request.course.id'}) { return 'no_course'; }
 2757:     if ($filters{'url'}) {
 2758: 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
 2759:         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
 2760:         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
 2761:     }
 2762:     my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
 2763:     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
 2764:     return &log_query($cname,$cdom,'courselog',%filters);
 2765: }
 2766: 
 2767: sub userlog_query {
 2768:     my ($uname,$udom,%filters)=@_;
 2769:     return &log_query($uname,$udom,'userlog',%filters);
 2770: }
 2771: 
 2772: # ------------------------------------------------------------------ Plain Text
 2773: 
 2774: sub plaintext {
 2775:     my $short=shift;
 2776:     return &mt($prp{$short});
 2777: }
 2778: 
 2779: # ----------------------------------------------------------------- Assign Role
 2780: 
 2781: sub assignrole {
 2782:     my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
 2783:     my $mrole;
 2784:     if ($role =~ /^cr\//) {
 2785:         my $cwosec=$url;
 2786:         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
 2787: 	unless (&allowed('ccr',$cwosec)) {
 2788:            &logthis('Refused custom assignrole: '.
 2789:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
 2790: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 2791:            return 'refused'; 
 2792:         }
 2793:         $mrole='cr';
 2794:     } else {
 2795:         my $cwosec=$url;
 2796:         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
 2797:         unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) { 
 2798:            &logthis('Refused assignrole: '.
 2799:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
 2800: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 2801:            return 'refused'; 
 2802:         }
 2803:         $mrole=$role;
 2804:     }
 2805:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
 2806:                 "$udom:$uname:$url".'_'."$mrole=$role";
 2807:     if ($end) { $command.='_'.$end; }
 2808:     if ($start) {
 2809: 	if ($end) { 
 2810:            $command.='_'.$start; 
 2811:         } else {
 2812:            $command.='_0_'.$start;
 2813:         }
 2814:     }
 2815: # actually delete
 2816:     if ($deleteflag) {
 2817: 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
 2818: # modify command to delete the role
 2819:            $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:".
 2820:                 "$udom:$uname:$url".'_'."$mrole";
 2821: 	   &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom"); 
 2822: # set start and finish to negative values for userrolelog
 2823:            $start=-1;
 2824:            $end=-1;
 2825:         }
 2826:     }
 2827: # send command
 2828:     my $answer=&reply($command,&homeserver($uname,$udom));
 2829: # log new user role if status is ok
 2830:     if ($answer eq 'ok') {
 2831: 	&userrolelog($mrole,$uname,$udom,$url,$start,$end);
 2832:     }
 2833:     return $answer;
 2834: }
 2835: 
 2836: # -------------------------------------------------- Modify user authentication
 2837: # Overrides without validation
 2838: 
 2839: sub modifyuserauth {
 2840:     my ($udom,$uname,$umode,$upass)=@_;
 2841:     my $uhome=&homeserver($uname,$udom);
 2842:     unless (&allowed('mau',$udom)) { return 'refused'; }
 2843:     &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
 2844:              $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
 2845:              ' in domain '.$ENV{'request.role.domain'});  
 2846:     my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
 2847: 		     &escape($upass),$uhome);
 2848:     &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
 2849:         'Authentication changed for '.$udom.', '.$uname.', '.$umode.
 2850:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
 2851:     &log($udom,,$uname,$uhome,
 2852:         'Authentication changed by '.$ENV{'user.domain'}.', '.
 2853:                                      $ENV{'user.name'}.', '.$umode.
 2854:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
 2855:     unless ($reply eq 'ok') {
 2856:         &logthis('Authentication mode error: '.$reply);
 2857: 	return 'error: '.$reply;
 2858:     }   
 2859:     return 'ok';
 2860: }
 2861: 
 2862: # --------------------------------------------------------------- Modify a user
 2863: 
 2864: sub modifyuser {
 2865:     my ($udom,    $uname, $uid,
 2866:         $umode,   $upass, $first,
 2867:         $middle,  $last,  $gene,
 2868:         $forceid, $desiredhome, $email)=@_;
 2869:     $udom=~s/\W//g;
 2870:     $uname=~s/\W//g;
 2871:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
 2872:              $umode.', '.$first.', '.$middle.', '.
 2873: 	     $last.', '.$gene.'(forceid: '.$forceid.')'.
 2874:              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
 2875:                                      ' desiredhome not specified'). 
 2876:              ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
 2877:              ' in domain '.$ENV{'request.role.domain'});
 2878:     my $uhome=&homeserver($uname,$udom,'true');
 2879: # ----------------------------------------------------------------- Create User
 2880:     if (($uhome eq 'no_host') && 
 2881: 	(($umode && $upass) || ($umode eq 'localauth'))) {
 2882:         my $unhome='';
 2883:         if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) { 
 2884:             $unhome = $desiredhome;
 2885: 	} elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
 2886: 	    $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
 2887:         } else { # load balancing routine for determining $unhome
 2888:             my $tryserver;
 2889:             my $loadm=10000000;
 2890:             foreach $tryserver (keys %libserv) {
 2891: 	       if ($hostdom{$tryserver} eq $udom) {
 2892:                   my $answer=reply('load',$tryserver);
 2893:                   if (($answer=~/\d+/) && ($answer<$loadm)) {
 2894: 		      $loadm=$answer;
 2895:                       $unhome=$tryserver;
 2896:                   }
 2897: 	       }
 2898: 	    }
 2899:         }
 2900:         if (($unhome eq '') || ($unhome eq 'no_host')) {
 2901: 	    return 'error: unable to find a home server for '.$uname.
 2902:                    ' in domain '.$udom;
 2903:         }
 2904:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
 2905:                          &escape($upass),$unhome);
 2906: 	unless ($reply eq 'ok') {
 2907:             return 'error: '.$reply;
 2908:         }   
 2909:         $uhome=&homeserver($uname,$udom,'true');
 2910:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
 2911: 	    return 'error: unable verify users home machine.';
 2912:         }
 2913:     }   # End of creation of new user
 2914: # ---------------------------------------------------------------------- Add ID
 2915:     if ($uid) {
 2916:        $uid=~tr/A-Z/a-z/;
 2917:        my %uidhash=&idrget($udom,$uname);
 2918:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 
 2919:          && (!$forceid)) {
 2920: 	  unless ($uid eq $uidhash{$uname}) {
 2921: 	      return 'error: user id "'.$uid.'" does not match '.
 2922:                   'current user id "'.$uidhash{$uname}.'".';
 2923:           }
 2924:        } else {
 2925: 	  &idput($udom,($uname => $uid));
 2926:        }
 2927:     }
 2928: # -------------------------------------------------------------- Add names, etc
 2929:     my @tmp=&get('environment',
 2930: 		   ['firstname','middlename','lastname','generation'],
 2931: 		   $udom,$uname);
 2932:     my %names;
 2933:     if ($tmp[0] =~ m/^error:.*/) { 
 2934:         %names=(); 
 2935:     } else {
 2936:         %names = @tmp;
 2937:     }
 2938: #
 2939: # Make sure to not trash student environment if instructor does not bother
 2940: # to supply name and email information
 2941: #
 2942:     if ($first)  { $names{'firstname'}  = $first; }
 2943:     if (defined($middle)) { $names{'middlename'} = $middle; }
 2944:     if ($last)   { $names{'lastname'}   = $last; }
 2945:     if (defined($gene))   { $names{'generation'} = $gene; }
 2946:     if ($email)  { $names{'notification'} = $email;
 2947:                    $names{'critnotification'} = $email; }
 2948: 
 2949:     my $reply = &put('environment', \%names, $udom,$uname);
 2950:     if ($reply ne 'ok') { return 'error: '.$reply; }
 2951:     &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
 2952:              $umode.', '.$first.', '.$middle.', '.
 2953: 	     $last.', '.$gene.' by '.
 2954:              $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 2955:     return 'ok';
 2956: }
 2957: 
 2958: # -------------------------------------------------------------- Modify student
 2959: 
 2960: sub modifystudent {
 2961:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
 2962:         $end,$start,$forceid,$desiredhome,$email)=@_;
 2963:     my $cid='';
 2964:     unless ($cid=$ENV{'request.course.id'}) {
 2965: 	return 'not_in_class';
 2966:     }
 2967: # --------------------------------------------------------------- Make the user
 2968:     my $reply=&modifyuser
 2969: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
 2970:          $desiredhome,$email);
 2971:     unless ($reply eq 'ok') { return $reply; }
 2972:     # This will cause &modify_student_enrollment to get the uid from the
 2973:     # students environment
 2974:     $uid = undef if (!$forceid);
 2975:     $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,
 2976:                                         $last,$gene,$usec,$end,$start);
 2977:     return $reply;
 2978: }
 2979: 
 2980: sub modify_student_enrollment {
 2981:     my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start) = @_;
 2982:     # Get the course id from the environment
 2983:     my $cid='';
 2984:     unless ($cid=$ENV{'request.course.id'}) {
 2985: 	return 'not_in_class';
 2986:     }
 2987:     # Make sure the user exists
 2988:     my $uhome=&homeserver($uname,$udom);
 2989:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
 2990: 	return 'error: no such user';
 2991:     }
 2992:     #
 2993:     # Get student data if we were not given enough information
 2994:     if (!defined($first)  || $first  eq '' || 
 2995:         !defined($last)   || $last   eq '' || 
 2996:         !defined($uid)    || $uid    eq '' || 
 2997:         !defined($middle) || $middle eq '' || 
 2998:         !defined($gene)   || $gene   eq '') {
 2999:         # They did not supply us with enough data to enroll the student, so
 3000:         # we need to pick up more information.
 3001:         my %tmp = &get('environment',
 3002:                        ['firstname','middlename','lastname', 'generation','id']
 3003:                        ,$udom,$uname);
 3004: 
 3005:         foreach (keys(%tmp)) {
 3006:             &logthis("key $_ = ".$tmp{$_});
 3007:         }
 3008:         $first  = $tmp{'firstname'}  if (!defined($first)  || $first  eq '');
 3009:         $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
 3010:         $last   = $tmp{'lastname'}   if (!defined($last)   || $last eq '');
 3011:         $gene   = $tmp{'generation'} if (!defined($gene)   || $gene eq '');
 3012:         $uid    = $tmp{'id'}         if (!defined($uid)    || $uid  eq '');
 3013:     }
 3014:     my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
 3015:                                                            $first,$middle);
 3016:     my $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
 3017: 	              $ENV{'course.'.$cid.'.num'}.':classlist:'.
 3018:                       &escape($uname.':'.$udom).'='.
 3019:                       &escape(join(':',$end,$start,$uid,$usec,$fullname)),
 3020: 	              $ENV{'course.'.$cid.'.home'});
 3021:     unless (($reply eq 'ok') || ($reply eq 'delayed')) {
 3022: 	return 'error: '.$reply;
 3023:     }
 3024:     # Add student role to user
 3025:     my $uurl='/'.$cid;
 3026:     $uurl=~s/\_/\//g;
 3027:     if ($usec) {
 3028: 	$uurl.='/'.$usec;
 3029:     }
 3030:     return &assignrole($udom,$uname,$uurl,'st',$end,$start);
 3031: }
 3032: 
 3033: # ------------------------------------------------- Write to course preferences
 3034: 
 3035: sub writecoursepref {
 3036:     my ($courseid,%prefs)=@_;
 3037:     $courseid=~s/^\///;
 3038:     $courseid=~s/\_/\//g;
 3039:     my ($cdomain,$cnum)=split(/\//,$courseid);
 3040:     my $chome=homeserver($cnum,$cdomain);
 3041:     if (($chome eq '') || ($chome eq 'no_host')) { 
 3042: 	return 'error: no such course';
 3043:     }
 3044:     my $cstring='';
 3045:     foreach (keys %prefs) {
 3046: 	$cstring.=escape($_).'='.escape($prefs{$_}).'&';
 3047:     }
 3048:     $cstring=~s/\&$//;
 3049:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
 3050: }
 3051: 
 3052: # ---------------------------------------------------------- Make/modify course
 3053: 
 3054: sub createcourse {
 3055:     my ($udom,$description,$url,$course_server,$nonstandard)=@_;
 3056:     $url=&declutter($url);
 3057:     my $cid='';
 3058:     unless (&allowed('ccc',$udom)) {
 3059:         return 'refused';
 3060:     }
 3061: # ------------------------------------------------------------------- Create ID
 3062:    my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
 3063:        unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
 3064: # ----------------------------------------------- Make sure that does not exist
 3065:    my $uhome=&homeserver($uname,$udom,'true');
 3066:    unless (($uhome eq '') || ($uhome eq 'no_host')) {
 3067:        $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
 3068:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
 3069:        $uhome=&homeserver($uname,$udom,'true');       
 3070:        unless (($uhome eq '') || ($uhome eq 'no_host')) {
 3071:            return 'error: unable to generate unique course-ID';
 3072:        } 
 3073:    }
 3074: # ------------------------------------------------ Check supplied server name
 3075:     $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
 3076:     if (! exists($libserv{$course_server})) {
 3077:         return 'error:bad server name '.$course_server;
 3078:     }
 3079: # ------------------------------------------------------------- Make the course
 3080:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
 3081:                       $course_server);
 3082:     unless ($reply eq 'ok') { return 'error: '.$reply; }
 3083:     $uhome=&homeserver($uname,$udom,'true');
 3084:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
 3085: 	return 'error: no such course';
 3086:     }
 3087: # ----------------------------------------------------------------- Course made
 3088: # log existance
 3089:     &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description),
 3090:                  $uhome);
 3091:     &flushcourselogs();
 3092: # set toplevel url
 3093:     my $topurl=$url;
 3094:     unless ($nonstandard) {
 3095: # ------------------------------------------ For standard courses, make top url
 3096:         my $mapurl=&clutter($url);
 3097:         if ($mapurl eq '/res/') { $mapurl=''; }
 3098:         $ENV{'form.initmap'}=(<<ENDINITMAP);
 3099: <map>
 3100: <resource id="1" type="start"></resource>
 3101: <resource id="2" src="$mapurl"></resource>
 3102: <resource id="3" type="finish"></resource>
 3103: <link index="1" from="1" to="2"></link>
 3104: <link index="2" from="2" to="3"></link>
 3105: </map>
 3106: ENDINITMAP
 3107:         $topurl=&declutter(
 3108:         &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
 3109:                           );
 3110:     }
 3111: # ----------------------------------------------------------- Write preferences
 3112:     &writecoursepref($udom.'_'.$uname,
 3113:                      ('description' => $description,
 3114:                       'url'         => $topurl));
 3115:     return '/'.$udom.'/'.$uname;
 3116: }
 3117: 
 3118: # ---------------------------------------------------------- Assign Custom Role
 3119: 
 3120: sub assigncustomrole {
 3121:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
 3122:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
 3123:                        $end,$start,$deleteflag);
 3124: }
 3125: 
 3126: # ----------------------------------------------------------------- Revoke Role
 3127: 
 3128: sub revokerole {
 3129:     my ($udom,$uname,$url,$role,$deleteflag)=@_;
 3130:     my $now=time;
 3131:     return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
 3132: }
 3133: 
 3134: # ---------------------------------------------------------- Revoke Custom Role
 3135: 
 3136: sub revokecustomrole {
 3137:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
 3138:     my $now=time;
 3139:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
 3140:            $deleteflag);
 3141: }
 3142: 
 3143: # ------------------------------------------------------------ Directory lister
 3144: 
 3145: sub dirlist {
 3146:     my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
 3147: 
 3148:     $uri=~s/^\///;
 3149:     $uri=~s/\/$//;
 3150:     my ($udom, $uname);
 3151:     (undef,$udom,$uname)=split(/\//,$uri);
 3152:     if(defined($userdomain)) {
 3153:         $udom = $userdomain;
 3154:     }
 3155:     if(defined($username)) {
 3156:         $uname = $username;
 3157:     }
 3158: 
 3159:     my $dirRoot = $perlvar{'lonDocRoot'};
 3160:     if(defined($alternateDirectoryRoot)) {
 3161:         $dirRoot = $alternateDirectoryRoot;
 3162:         $dirRoot =~ s/\/$//;
 3163:     }
 3164: 
 3165:     if($udom) {
 3166:         if($uname) {
 3167:             my $listing=reply('ls:'.$dirRoot.'/'.$uri,
 3168:                               homeserver($uname,$udom));
 3169:             return split(/:/,$listing);
 3170:         } elsif(!defined($alternateDirectoryRoot)) {
 3171:             my $tryserver;
 3172:             my %allusers=();
 3173:             foreach $tryserver (keys %libserv) {
 3174:                 if($hostdom{$tryserver} eq $udom) {
 3175:                     my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
 3176:                                       $udom, $tryserver);
 3177:                     if (($listing ne 'no_such_dir') && ($listing ne 'empty')
 3178:                         && ($listing ne 'con_lost')) {
 3179:                         foreach (split(/:/,$listing)) {
 3180:                             my ($entry,@stat)=split(/&/,$_);
 3181:                             $allusers{$entry}=1;
 3182:                         }
 3183:                     }
 3184:                 }
 3185:             }
 3186:             my $alluserstr='';
 3187:             foreach (sort keys %allusers) {
 3188:                 $alluserstr.=$_.'&user:';
 3189:             }
 3190:             $alluserstr=~s/:$//;
 3191:             return split(/:/,$alluserstr);
 3192:         } else {
 3193:             my @emptyResults = ();
 3194:             push(@emptyResults, 'missing user name');
 3195:             return split(':',@emptyResults);
 3196:         }
 3197:     } elsif(!defined($alternateDirectoryRoot)) {
 3198:         my $tryserver;
 3199:         my %alldom=();
 3200:         foreach $tryserver (keys %libserv) {
 3201:             $alldom{$hostdom{$tryserver}}=1;
 3202:         }
 3203:         my $alldomstr='';
 3204:         foreach (sort keys %alldom) {
 3205:             $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
 3206:         }
 3207:         $alldomstr=~s/:$//;
 3208:         return split(/:/,$alldomstr);       
 3209:     } else {
 3210:         my @emptyResults = ();
 3211:         push(@emptyResults, 'missing domain');
 3212:         return split(':',@emptyResults);
 3213:     }
 3214: }
 3215: 
 3216: # --------------------------------------------- GetFileTimestamp
 3217: # This function utilizes dirlist and returns the date stamp for
 3218: # when it was last modified.  It will also return an error of -1
 3219: # if an error occurs
 3220: 
 3221: ##
 3222: ## FIXME: This subroutine assumes its caller knows something about the
 3223: ## directory structure of the home server for the student ($root).
 3224: ## Not a good assumption to make.  Since this is for looking up files
 3225: ## in user directories, the full path should be constructed by lond, not
 3226: ## whatever machine we request data from.
 3227: ##
 3228: sub GetFileTimestamp {
 3229:     my ($studentDomain,$studentName,$filename,$root)=@_;
 3230:     $studentDomain=~s/\W//g;
 3231:     $studentName=~s/\W//g;
 3232:     my $subdir=$studentName.'__';
 3233:     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
 3234:     my $proname="$studentDomain/$subdir/$studentName";
 3235:     $proname .= '/'.$filename;
 3236:     my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain, 
 3237:                                               $studentName, $root);
 3238:     my @stats = split('&', $fileStat);
 3239:     if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
 3240:         # @stats contains first the filename, then the stat output
 3241:         return $stats[10]; # so this is 10 instead of 9.
 3242:     } else {
 3243:         return -1;
 3244:     }
 3245: }
 3246: 
 3247: # -------------------------------------------------------- Value of a Condition
 3248: 
 3249: sub directcondval {
 3250:     my $number=shift;
 3251:     if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
 3252:        return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
 3253:     } else {
 3254:        return 2;
 3255:     }
 3256: }
 3257: 
 3258: sub condval {
 3259:     my $condidx=shift;
 3260:     my $result=0;
 3261:     my $allpathcond='';
 3262:     foreach (split(/\|/,$condidx)) {
 3263:        if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
 3264: 	   $allpathcond.=
 3265:                '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
 3266:        }
 3267:     }
 3268:     $allpathcond=~s/\|$//;
 3269:     if ($ENV{'request.course.id'}) {
 3270:        if ($allpathcond) {
 3271:           my $operand='|';
 3272: 	  my @stack;
 3273:            foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
 3274:               if ($_ eq '(') {
 3275:                  push @stack,($operand,$result)
 3276:               } elsif ($_ eq ')') {
 3277:                   my $before=pop @stack;
 3278: 		  if (pop @stack eq '&') {
 3279: 		      $result=$result>$before?$before:$result;
 3280:                   } else {
 3281:                       $result=$result>$before?$result:$before;
 3282:                   }
 3283:               } elsif (($_ eq '&') || ($_ eq '|')) {
 3284:                   $operand=$_;
 3285:               } else {
 3286:                   my $new=directcondval($_);
 3287:                   if ($operand eq '&') {
 3288:                      $result=$result>$new?$new:$result;
 3289:                   } else {
 3290:                      $result=$result>$new?$result:$new;
 3291:                   }
 3292:               }
 3293:           }
 3294:        }
 3295:     }
 3296:     return $result;
 3297: }
 3298: 
 3299: # ---------------------------------------------------- Devalidate courseresdata
 3300: 
 3301: sub devalidatecourseresdata {
 3302:     my ($coursenum,$coursedomain)=@_;
 3303:     my $hashid=$coursenum.':'.$coursedomain;
 3304:     &devalidate_cache(\%courseresdatacache,$hashid);
 3305: }
 3306: 
 3307: # --------------------------------------------------- Course Resourcedata Query
 3308: 
 3309: sub courseresdata {
 3310:     my ($coursenum,$coursedomain,@which)=@_;
 3311:     my $coursehom=&homeserver($coursenum,$coursedomain);
 3312:     my $hashid=$coursenum.':'.$coursedomain;
 3313:     my ($result,$cached)=&is_cached(\%courseresdatacache,$hashid);
 3314:     unless (defined($cached)) {
 3315: 	my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
 3316: 	$result=\%dumpreply;
 3317: 	my ($tmp) = keys(%dumpreply);
 3318: 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
 3319: 	    &do_cache(\%courseresdatacache,$hashid,$result);
 3320: 	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
 3321: 	    return $tmp;
 3322: 	} elsif ($tmp =~ /^(error)/) {
 3323: 	    $result=undef;
 3324: 	    &do_cache(\%courseresdatacache,$hashid,$result);
 3325: 	}
 3326:     }
 3327:     foreach my $item (@which) {
 3328: 	if (defined($result->{$item})) {
 3329: 	    return $result->{$item};
 3330: 	}
 3331:     }
 3332:     return undef;
 3333: }
 3334: 
 3335: #
 3336: # EXT resource caching routines
 3337: #
 3338: 
 3339: sub clear_EXT_cache_status {
 3340:     &delenv('cache.EXT.');
 3341: }
 3342: 
 3343: sub EXT_cache_status {
 3344:     my ($target_domain,$target_user) = @_;
 3345:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
 3346:     if (exists($ENV{$cachename}) && ($ENV{$cachename}+600) > time) {
 3347:         # We know already the user has no data
 3348:         return 1;
 3349:     } else {
 3350:         return 0;
 3351:     }
 3352: }
 3353: 
 3354: sub EXT_cache_set {
 3355:     my ($target_domain,$target_user) = @_;
 3356:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
 3357:     &appenv($cachename => time);
 3358: }
 3359: 
 3360: # --------------------------------------------------------- Value of a Variable
 3361: sub EXT {
 3362:     my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
 3363: 
 3364:     unless ($varname) { return ''; }
 3365:     #get real user name/domain, courseid and symb
 3366:     my $courseid;
 3367:     my $publicuser;
 3368:     if (!($uname && $udom)) {
 3369:       (my $cursymb,$courseid,$udom,$uname,$publicuser)=
 3370: 	  &Apache::lonxml::whichuser($symbparm);
 3371:       if (!$symbparm) {	$symbparm=$cursymb; }
 3372:     } else {
 3373: 	$courseid=$ENV{'request.course.id'};
 3374:     }
 3375:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
 3376:     my $rest;
 3377:     if (defined($therest[0])) {
 3378:        $rest=join('.',@therest);
 3379:     } else {
 3380:        $rest='';
 3381:     }
 3382: 
 3383:     my $qualifierrest=$qualifier;
 3384:     if ($rest) { $qualifierrest.='.'.$rest; }
 3385:     my $spacequalifierrest=$space;
 3386:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
 3387:     if ($realm eq 'user') {
 3388: # --------------------------------------------------------------- user.resource
 3389: 	if ($space eq 'resource') {
 3390: 	    if (defined($Apache::lonhomework::parsing_a_problem)) {
 3391: 		return $Apache::lonhomework::history{$qualifierrest};
 3392: 	    } else {
 3393: 		my %restored;
 3394: 		if ($publicuser || $ENV{'request.state'} eq 'construct') {
 3395: 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
 3396: 		} else {
 3397: 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
 3398: 		}
 3399: 		return $restored{$qualifierrest};
 3400: 	    }
 3401: # ----------------------------------------------------------------- user.access
 3402:         } elsif ($space eq 'access') {
 3403: 	    # FIXME - not supporting calls for a specific user
 3404:             return &allowed($qualifier,$rest);
 3405: # ------------------------------------------ user.preferences, user.environment
 3406:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
 3407: 	    if (($uname eq $ENV{'user.name'}) &&
 3408: 		($udom eq $ENV{'user.domain'})) {
 3409: 		return $ENV{join('.',('environment',$qualifierrest))};
 3410: 	    } else {
 3411: 		my %returnhash;
 3412: 		if (!$publicuser) {
 3413: 		    %returnhash=&userenvironment($udom,$uname,
 3414: 						 $qualifierrest);
 3415: 		}
 3416: 		return $returnhash{$qualifierrest};
 3417: 	    }
 3418: # ----------------------------------------------------------------- user.course
 3419:         } elsif ($space eq 'course') {
 3420: 	    # FIXME - not supporting calls for a specific user
 3421:             return $ENV{join('.',('request.course',$qualifier))};
 3422: # ------------------------------------------------------------------- user.role
 3423:         } elsif ($space eq 'role') {
 3424: 	    # FIXME - not supporting calls for a specific user
 3425:             my ($role,$where)=split(/\./,$ENV{'request.role'});
 3426:             if ($qualifier eq 'value') {
 3427: 		return $role;
 3428:             } elsif ($qualifier eq 'extent') {
 3429:                 return $where;
 3430:             }
 3431: # ----------------------------------------------------------------- user.domain
 3432:         } elsif ($space eq 'domain') {
 3433:             return $udom;
 3434: # ------------------------------------------------------------------- user.name
 3435:         } elsif ($space eq 'name') {
 3436:             return $uname;
 3437: # ---------------------------------------------------- Any other user namespace
 3438:         } else {
 3439: 	    my %reply;
 3440: 	    if (!$publicuser) {
 3441: 		%reply=&get($space,[$qualifierrest],$udom,$uname);
 3442: 	    }
 3443: 	    return $reply{$qualifierrest};
 3444:         }
 3445:     } elsif ($realm eq 'query') {
 3446: # ---------------------------------------------- pull stuff out of query string
 3447:         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
 3448: 						[$spacequalifierrest]);
 3449: 	return $ENV{'form.'.$spacequalifierrest}; 
 3450:    } elsif ($realm eq 'request') {
 3451: # ------------------------------------------------------------- request.browser
 3452:         if ($space eq 'browser') {
 3453: 	    return $ENV{'browser.'.$qualifier};
 3454: # ------------------------------------------------------------ request.filename
 3455:         } else {
 3456:             return $ENV{'request.'.$spacequalifierrest};
 3457:         }
 3458:     } elsif ($realm eq 'course') {
 3459: # ---------------------------------------------------------- course.description
 3460:         return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
 3461:     } elsif ($realm eq 'resource') {
 3462: 
 3463: 	my $section;
 3464: 	if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) {
 3465: 
 3466: 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
 3467: 
 3468: # ----------------------------------------------------- Cascading lookup scheme
 3469: 	    if (!$symbparm) { $symbparm=&symbread(); }
 3470: 	    my $symbp=$symbparm;
 3471: 	    my $mapp=(&decode_symb($symbp))[0];
 3472: 
 3473: 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
 3474: 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
 3475: 
 3476: 	    if (($ENV{'user.name'} eq $uname) &&
 3477: 		($ENV{'user.domain'} eq $udom)) {
 3478: 		$section=$ENV{'request.course.sec'};
 3479: 	    } else {
 3480:                 if (! defined($usection)) {
 3481:                     $section=&usection($udom,$uname,$courseid);
 3482:                 } else {
 3483:                     $section = $usection;
 3484:                 }
 3485: 	    }
 3486: 
 3487: 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
 3488: 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
 3489: 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
 3490: 
 3491: 	    my $courselevel=$courseid.'.'.$spacequalifierrest;
 3492: 	    my $courselevelr=$courseid.'.'.$symbparm;
 3493: 	    my $courselevelm=$courseid.'.'.$mapparm;
 3494: 
 3495: # ----------------------------------------------------------- first, check user
 3496: 	    #most student don\'t have any data set, check if there is some data
 3497: 	    if (! &EXT_cache_status($udom,$uname)) {
 3498: 		my $hashid="$udom:$uname";
 3499: 		my ($result,$cached)=&is_cached(\%userresdatacache,$hashid);
 3500: 		if (!defined($cached)) { 
 3501: 		    my %resourcedata=&get('resourcedata',
 3502: 					  [$courselevelr,$courselevelm,
 3503: 					   $courselevel],$udom,$uname);
 3504: 		    $result=\%resourcedata;
 3505: 		}
 3506: 		my ($tmp)=keys(%$result);
 3507: 		if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
 3508: 		    &do_cache(\%userresdatacache,$hashid,$result);
 3509: 		    if ($$result{$courselevelr}) {
 3510: 			return $$result{$courselevelr}; }
 3511: 		    if ($$result{$courselevelm}) {
 3512: 			return $$result{$courselevelm}; }
 3513: 		    if ($$result{$courselevel}) {
 3514: 			return $$result{$courselevel}; }
 3515: 		} else {
 3516: 		    if ($tmp!~/No such file/) {
 3517: 			&logthis("<font color=blue>WARNING:".
 3518: 				 " Trying to get resource data for ".
 3519: 				 $uname." at ".$udom.": ".
 3520: 				 $tmp."</font>");
 3521: 			&do_cache(\%userresdatacache,$hashid,undef);
 3522: 		    } elsif ($tmp=~/error:No such file/) {
 3523:                         &EXT_cache_set($udom,$uname);
 3524: 		    } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
 3525: 			&do_cache(\%userresdatacache,$hashid,undef);
 3526: 			return $tmp;
 3527: 		    }
 3528: 		}
 3529: 	    }
 3530: 
 3531: # -------------------------------------------------------- second, check course
 3532: 
 3533: 	    my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
 3534: 					  $ENV{'course.'.$courseid.'.domain'},
 3535: 					  ($seclevelr,$seclevelm,$seclevel,
 3536: 					   $courselevelr,$courselevelm,
 3537: 					   $courselevel));
 3538: 	    if (defined($coursereply)) { return $coursereply; }
 3539: 
 3540: # ------------------------------------------------------ third, check map parms
 3541: 	    my %parmhash=();
 3542: 	    my $thisparm='';
 3543: 	    if (tie(%parmhash,'GDBM_File',
 3544: 		    $ENV{'request.course.fn'}.'_parms.db',
 3545: 		    &GDBM_READER(),0640)) {
 3546: 		$thisparm=$parmhash{$symbparm};
 3547: 		untie(%parmhash);
 3548: 	    }
 3549: 	    if ($thisparm) { return $thisparm; }
 3550: 	}
 3551: # --------------------------------------------- last, look in resource metadata
 3552: 
 3553: 	$spacequalifierrest=~s/\./\_/;
 3554: 	my $filename;
 3555: 	if (!$symbparm) { $symbparm=&symbread(); }
 3556: 	if ($symbparm) {
 3557: 	    $filename=(&decode_symb($symbparm))[2];
 3558: 	} else {
 3559: 	    $filename=$ENV{'request.filename'};
 3560: 	}
 3561: 	my $metadata=&metadata($filename,$spacequalifierrest);
 3562: 	if (defined($metadata)) { return $metadata; }
 3563: 	$metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
 3564: 	if (defined($metadata)) { return $metadata; }
 3565: 
 3566: # ------------------------------------------------------------------ Cascade up
 3567: 	unless ($space eq '0') {
 3568: 	    my @parts=split(/_/,$space);
 3569: 	    my $id=pop(@parts);
 3570: 	    my $part=join('_',@parts);
 3571: 	    if ($part eq '') { $part='0'; }
 3572: 	    my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
 3573: 				 $symbparm,$udom,$uname,$section,1);
 3574: 	    if (defined($partgeneral)) { return $partgeneral; }
 3575: 	}
 3576: 	if ($recurse) { return undef; }
 3577: 	my $pack_def=&packages_tab_default($filename,$varname);
 3578: 	if (defined($pack_def)) { return $pack_def; }
 3579: 
 3580: # ---------------------------------------------------- Any other user namespace
 3581:     } elsif ($realm eq 'environment') {
 3582: # ----------------------------------------------------------------- environment
 3583: 	if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
 3584: 	    return $ENV{'environment.'.$spacequalifierrest};
 3585: 	} else {
 3586: 	    my %returnhash=&userenvironment($udom,$uname,
 3587: 					    $spacequalifierrest);
 3588: 	    return $returnhash{$spacequalifierrest};
 3589: 	}
 3590:     } elsif ($realm eq 'system') {
 3591: # ----------------------------------------------------------------- system.time
 3592: 	if ($space eq 'time') {
 3593: 	    return time;
 3594:         }
 3595:     }
 3596:     return '';
 3597: }
 3598: 
 3599: sub packages_tab_default {
 3600:     my ($uri,$varname)=@_;
 3601:     my (undef,$part,$name)=split(/\./,$varname);
 3602:     my $packages=&metadata($uri,'packages');
 3603:     foreach my $package (split(/,/,$packages)) {
 3604: 	my ($pack_type,$pack_part)=split(/_/,$package,2);
 3605: 	if ($pack_part eq $part) {
 3606: 	    return $packagetab{"$pack_type&$name&default"};
 3607: 	}
 3608:     }
 3609:     return undef;
 3610: }
 3611: 
 3612: sub add_prefix_and_part {
 3613:     my ($prefix,$part)=@_;
 3614:     my $keyroot;
 3615:     if (defined($prefix) && $prefix !~ /^__/) {
 3616: 	# prefix that has a part already
 3617: 	$keyroot=$prefix;
 3618:     } elsif (defined($prefix)) {
 3619: 	# prefix that is missing a part
 3620: 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
 3621:     } else {
 3622: 	# no prefix at all
 3623: 	if (defined($part)) { $keyroot='_'.$part; }
 3624:     }
 3625:     return $keyroot;
 3626: }
 3627: 
 3628: # ---------------------------------------------------------------- Get metadata
 3629: 
 3630: sub metadata {
 3631:     my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
 3632:     $uri=&declutter($uri);
 3633:     # if it is a non metadata possible uri return quickly
 3634:     if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
 3635:         ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
 3636: 	($uri =~ m|home/[^/]+/public_html/|)) {
 3637: 	return '';
 3638:     }
 3639:     my $filename=$uri;
 3640:     $uri=~s/\.meta$//;
 3641: #
 3642: # Is the metadata already cached?
 3643: # Look at timestamp of caching
 3644: # Everything is cached by the main uri, libraries are never directly cached
 3645: #
 3646:     unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
 3647: #
 3648: # Is this a recursive call for a library?
 3649: #
 3650:         if ($liburi) {
 3651: 	    $liburi=&declutter($liburi);
 3652:             $filename=$liburi;
 3653:         } else {
 3654: 	    delete($metacache{$uri.':packages'});
 3655: 	}
 3656:         my %metathesekeys=();
 3657:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
 3658: 	my $metastring=&getfile(&filelocation('',&clutter($filename)));
 3659:         my $parser=HTML::LCParser->new(\$metastring);
 3660:         my $token;
 3661:         undef %metathesekeys;
 3662:         while ($token=$parser->get_token) {
 3663: 	    if ($token->[0] eq 'S') {
 3664: 		if (defined($token->[2]->{'package'})) {
 3665: #
 3666: # This is a package - get package info
 3667: #
 3668: 		    my $package=$token->[2]->{'package'};
 3669: 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
 3670: 		    if (defined($token->[2]->{'id'})) { 
 3671: 			$keyroot.='_'.$token->[2]->{'id'}; 
 3672: 		    }
 3673: 		    if ($metacache{$uri.':packages'}) {
 3674: 			$metacache{$uri.':packages'}.=','.$package.$keyroot;
 3675: 		    } else {
 3676: 			$metacache{$uri.':packages'}=$package.$keyroot;
 3677: 		    }
 3678: 		    foreach (keys %packagetab) {
 3679: 			if ($_=~/^$package\&/) {
 3680: 			    my ($pack,$name,$subp)=split(/\&/,$_);
 3681: 			    # ignore package.tab specified default values
 3682:                             # here &package_tab_default() will fetch those
 3683: 			    if ($subp eq 'default') { next; }
 3684: 			    my $value=$packagetab{$_};
 3685: 			    my $part=$keyroot;
 3686: 			    $part=~s/^\_//;
 3687: 			    if ($subp eq 'display') {
 3688: 				$value.=' [Part: '.$part.']';
 3689: 			    }
 3690: 			    my $unikey='parameter'.$keyroot.'_'.$name;
 3691: 			    $metacache{$uri.':'.$unikey.'.part'}=$part;
 3692: 			    $metathesekeys{$unikey}=1;
 3693: 			    unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
 3694: 				$metacache{$uri.':'.$unikey.'.'.$subp}=$value;
 3695: 			    }
 3696: 			    if (defined($metacache{$uri.':'.$unikey.'.default'})) {
 3697: 				$metacache{$uri.':'.$unikey}=
 3698: 				    $metacache{$uri.':'.$unikey.'.default'};
 3699: 			    }
 3700: 			}
 3701: 		    }
 3702: 		} else {
 3703: #
 3704: # This is not a package - some other kind of start tag
 3705: #
 3706: 		    my $entry=$token->[1];
 3707: 		    my $unikey;
 3708: 		    if ($entry eq 'import') {
 3709: 			$unikey='';
 3710: 		    } else {
 3711: 			$unikey=$entry;
 3712: 		    }
 3713: 		    $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
 3714: 
 3715: 		    if (defined($token->[2]->{'id'})) { 
 3716: 			$unikey.='_'.$token->[2]->{'id'}; 
 3717: 		    }
 3718: 
 3719: 		    if ($entry eq 'import') {
 3720: #
 3721: # Importing a library here
 3722: #
 3723: 			if ($depthcount<20) {
 3724: 			    my $location=$parser->get_text('/import');
 3725: 			    my $dir=$filename;
 3726: 			    $dir=~s|[^/]*$||;
 3727: 			    $location=&filelocation($dir,$location);
 3728: 			    foreach (sort(split(/\,/,&metadata($uri,'keys',
 3729: 							       $location,$unikey,
 3730: 							       $depthcount+1)))) {
 3731: 				$metathesekeys{$_}=1;
 3732: 			    }
 3733: 			}
 3734: 		    } else { 
 3735: 			
 3736: 			if (defined($token->[2]->{'name'})) { 
 3737: 			    $unikey.='_'.$token->[2]->{'name'}; 
 3738: 			}
 3739: 			$metathesekeys{$unikey}=1;
 3740: 			foreach (@{$token->[3]}) {
 3741: 			    $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
 3742: 			}
 3743: 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
 3744: 			my $default=$metacache{$uri.':'.$unikey.'.default'};
 3745: 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
 3746: 		 # only ws inside the tag, and not in default, so use default
 3747: 		 # as value
 3748: 			    $metacache{$uri.':'.$unikey}=$default;
 3749: 			} else {
 3750: 		  # either something interesting inside the tag or default
 3751:                   # uninteresting
 3752: 			    $metacache{$uri.':'.$unikey}=$internaltext;
 3753: 			}
 3754: # end of not-a-package not-a-library import
 3755: 		    }
 3756: # end of not-a-package start tag
 3757: 		}
 3758: # the next is the end of "start tag"
 3759: 	    }
 3760: 	}
 3761: # are there custom rights to evaluate
 3762: 	if ($metacache{$uri.':copyright'} eq 'custom') {
 3763: 
 3764:     #
 3765:     # Importing a rights file here
 3766:     #
 3767: 	    unless ($depthcount) {
 3768: 		my $location=$metacache{$uri.':customdistributionfile'};
 3769: 		my $dir=$filename;
 3770: 		$dir=~s|[^/]*$||;
 3771: 		$location=&filelocation($dir,$location);
 3772: 		foreach (sort(split(/\,/,&metadata($uri,'keys',
 3773: 						   $location,'_rights',
 3774: 						   $depthcount+1)))) {
 3775: 		    $metathesekeys{$_}=1;
 3776: 		}
 3777: 	    }
 3778: 	}
 3779: 	$metacache{$uri.':keys'}=join(',',keys %metathesekeys);
 3780: 	&metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
 3781: 	$metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
 3782: 	$metacache{$uri.':cachedtimestamp'}=time;
 3783: # this is the end of "was not already recently cached
 3784:     }
 3785:     return $metacache{$uri.':'.$what};
 3786: }
 3787: 
 3788: sub metadata_generate_part0 {
 3789:     my ($metadata,$metacache,$uri) = @_;
 3790:     my %allnames;
 3791:     foreach my $metakey (sort keys %$metadata) {
 3792: 	if ($metakey=~/^parameter\_(.*)/) {
 3793: 	  my $part=$$metacache{$uri.':'.$metakey.'.part'};
 3794: 	  my $name=$$metacache{$uri.':'.$metakey.'.name'};
 3795: 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
 3796: 	    $allnames{$name}=$part;
 3797: 	  }
 3798: 	}
 3799:     }
 3800:     foreach my $name (keys(%allnames)) {
 3801:       $$metadata{"parameter_0_$name"}=1;
 3802:       my $key="$uri:parameter_0_$name";
 3803:       $$metacache{"$key.part"}='0';
 3804:       $$metacache{"$key.name"}=$name;
 3805:       $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
 3806: 					   $allnames{$name}.'_'.$name.
 3807: 					   '.type'};
 3808:       my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
 3809: 			     '.display'};
 3810:       my $expr='\\[Part: '.$allnames{$name}.'\\]';
 3811:       $olddis=~s/$expr/\[Part: 0\]/;
 3812:       $$metacache{"$key.display"}=$olddis;
 3813:     }
 3814: }
 3815: 
 3816: # ------------------------------------------------- Get the title of a resource
 3817: 
 3818: sub gettitle {
 3819:     my $urlsymb=shift;
 3820:     my $symb=&symbread($urlsymb);
 3821:     unless ($symb) {
 3822: 	unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
 3823:         return &metadata($urlsymb,'title'); 
 3824:     }
 3825:     my ($result,$cached)=&is_cached(\%titlecache,$symb,600);
 3826:     if (defined($cached)) { return $result; }
 3827:     my ($map,$resid,$url)=&decode_symb($symb);
 3828:     my $title='';
 3829:     my %bighash;
 3830:     if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
 3831:                             &GDBM_READER(),0640)) {
 3832:         my $mapid=$bighash{'map_pc_'.&clutter($map)};
 3833:         $title=$bighash{'title_'.$mapid.'.'.$resid};
 3834:         untie %bighash;
 3835:     }
 3836:     $title=~s/\&colon\;/\:/gs;
 3837:     if ($title) {
 3838:         return &do_cache(\%titlecache,$symb,$title);
 3839:     } else {
 3840: 	return &metadata($urlsymb,'title');
 3841:     }
 3842: }
 3843:     
 3844: # ------------------------------------------------- Update symbolic store links
 3845: 
 3846: sub symblist {
 3847:     my ($mapname,%newhash)=@_;
 3848:     $mapname=declutter($mapname);
 3849:     my %hash;
 3850:     if (($ENV{'request.course.fn'}) && (%newhash)) {
 3851:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
 3852:                       &GDBM_WRCREAT(),0640)) {
 3853: 	    foreach (keys %newhash) {
 3854:                 $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
 3855:             }
 3856:             if (untie(%hash)) {
 3857: 		return 'ok';
 3858:             }
 3859:         }
 3860:     }
 3861:     return 'error';
 3862: }
 3863: 
 3864: # --------------------------------------------------------------- Verify a symb
 3865: 
 3866: sub symbverify {
 3867:     my ($symb,$thisfn)=@_;
 3868:     $thisfn=&declutter($thisfn);
 3869: # direct jump to resource in page or to a sequence - will construct own symbs
 3870:     if ($thisfn=~/\.(page|sequence)$/) { return 1; }
 3871: # check URL part
 3872:     my ($map,$resid,$url)=&decode_symb($symb);
 3873:     unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
 3874: 
 3875:     $symb=&symbclean($symb);
 3876: 
 3877:     my %bighash;
 3878:     my $okay=0;
 3879:     if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
 3880:                             &GDBM_READER(),0640)) {
 3881:         my $ids=$bighash{'ids_'.&clutter($thisfn)};
 3882:         unless ($ids) { 
 3883:            $ids=$bighash{'ids_/'.$thisfn};
 3884:         }
 3885:         if ($ids) {
 3886: # ------------------------------------------------------------------- Has ID(s)
 3887: 	    foreach (split(/\,/,$ids)) {
 3888:                my ($mapid,$resid)=split(/\./,$_);
 3889:                if (
 3890:   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
 3891:    eq $symb) { 
 3892:                   $okay=1; 
 3893:                }
 3894: 	   }
 3895:         }
 3896: 	untie(%bighash);
 3897:     }
 3898:     return $okay;
 3899: }
 3900: 
 3901: # --------------------------------------------------------------- Clean-up symb
 3902: 
 3903: sub symbclean {
 3904:     my $symb=shift;
 3905: 
 3906: # remove version from map
 3907:     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
 3908: 
 3909: # remove version from URL
 3910:     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
 3911: 
 3912:     return $symb;
 3913: }
 3914: 
 3915: # ---------------------------------------------- Split symb to find map and url
 3916: 
 3917: sub decode_symb {
 3918:     my ($map,$resid,$url)=split(/\_\_\_/,shift);
 3919:     return (&fixversion($map),$resid,&fixversion($url));
 3920: }
 3921: 
 3922: sub fixversion {
 3923:     my $fn=shift;
 3924:     if ($fn=~/^(adm|uploaded|public)/) { return $fn; }
 3925:     my ($match,$cond,$versioned)=&is_on_map($fn);
 3926:     unless ($match) {
 3927: 	$fn=$versioned;
 3928:     }
 3929:     return $fn;
 3930: }
 3931: 
 3932: # ------------------------------------------------------ Return symb list entry
 3933: 
 3934: sub symbread {
 3935:     my ($thisfn,$donotrecurse)=@_;
 3936: # no filename provided? try from environment
 3937:     unless ($thisfn) {
 3938:         if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
 3939: 	$thisfn=$ENV{'request.filename'};
 3940:     }
 3941: # is that filename actually a symb? Verify, clean, and return
 3942:     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
 3943: 	if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
 3944:     }
 3945:     $thisfn=declutter($thisfn);
 3946:     my %hash;
 3947:     my %bighash;
 3948:     my $syval='';
 3949:     if (($ENV{'request.course.fn'}) && ($thisfn)) {
 3950:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
 3951:                       &GDBM_READER(),0640)) {
 3952: 	    $syval=$hash{$thisfn};
 3953:             untie(%hash);
 3954:         }
 3955: # ---------------------------------------------------------- There was an entry
 3956:         if ($syval) {
 3957:            unless ($syval=~/\_\d+$/) {
 3958: 	       unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
 3959:                   &appenv('request.ambiguous' => $thisfn);
 3960:                   return '';
 3961:                }    
 3962:                $syval.=$1;
 3963: 	   }
 3964:         } else {
 3965: # ------------------------------------------------------- Was not in symb table
 3966:            if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
 3967:                             &GDBM_READER(),0640)) {
 3968: # ---------------------------------------------- Get ID(s) for current resource
 3969:               my $ids=$bighash{'ids_'.&clutter($thisfn)};
 3970:               unless ($ids) { 
 3971:                  $ids=$bighash{'ids_/'.$thisfn};
 3972:               }
 3973:               unless ($ids) {
 3974: # alias?
 3975: 		  $ids=$bighash{'mapalias_'.$thisfn};
 3976:               }
 3977:               if ($ids) {
 3978: # ------------------------------------------------------------------- Has ID(s)
 3979:                  my @possibilities=split(/\,/,$ids);
 3980:                  if ($#possibilities==0) {
 3981: # ----------------------------------------------- There is only one possibility
 3982: 		     my ($mapid,$resid)=split(/\./,$ids);
 3983:                      $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
 3984:                  } elsif (!$donotrecurse) {
 3985: # ------------------------------------------ There is more than one possibility
 3986:                      my $realpossible=0;
 3987:                      foreach (@possibilities) {
 3988: 			 my $file=$bighash{'src_'.$_};
 3989:                          if (&allowed('bre',$file)) {
 3990:          		    my ($mapid,$resid)=split(/\./,$_);
 3991:                             if ($bighash{'map_type_'.$mapid} ne 'page') {
 3992: 				$realpossible++;
 3993:                                 $syval=declutter($bighash{'map_id_'.$mapid}).
 3994:                                        '___'.$resid;
 3995:                             }
 3996: 			 }
 3997:                      }
 3998: 		     if ($realpossible!=1) { $syval=''; }
 3999:                  } else {
 4000:                      $syval='';
 4001:                  }
 4002: 	      }
 4003:               untie(%bighash)
 4004:            } 
 4005:         }
 4006:         if ($syval) {
 4007:            return &symbclean($syval.'___'.$thisfn); 
 4008:         }
 4009:     }
 4010:     &appenv('request.ambiguous' => $thisfn);
 4011:     return '';
 4012: }
 4013: 
 4014: # ---------------------------------------------------------- Return random seed
 4015: 
 4016: sub numval {
 4017:     my $txt=shift;
 4018:     $txt=~tr/A-J/0-9/;
 4019:     $txt=~tr/a-j/0-9/;
 4020:     $txt=~tr/K-T/0-9/;
 4021:     $txt=~tr/k-t/0-9/;
 4022:     $txt=~tr/U-Z/0-5/;
 4023:     $txt=~tr/u-z/0-5/;
 4024:     $txt=~s/\D//g;
 4025:     return int($txt);
 4026: }
 4027: 
 4028: sub latest_rnd_algorithm_id {
 4029:     return '64bit';
 4030: }
 4031: 
 4032: sub rndseed {
 4033:     my ($symb,$courseid,$domain,$username)=@_;
 4034: 
 4035:     my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
 4036:     if (!$symb) {
 4037: 	unless ($symb=$wsymb) { return time; }
 4038:     }
 4039:     if (!$courseid) { $courseid=$wcourseid; }
 4040:     if (!$domain) { $domain=$wdomain; }
 4041:     if (!$username) { $username=$wusername }
 4042:     my $which=$ENV{"course.$courseid.rndseed"};
 4043:     my $CODE=$ENV{'scantron.CODE'};
 4044:     if (defined($CODE)) {
 4045: 	&rndseed_CODE_64bit($symb,$courseid,$domain,$username);
 4046:     } elsif ($which eq '64bit') {
 4047: 	return &rndseed_64bit($symb,$courseid,$domain,$username);
 4048:     }
 4049:     return &rndseed_32bit($symb,$courseid,$domain,$username);
 4050: }
 4051: 
 4052: sub rndseed_32bit {
 4053:     my ($symb,$courseid,$domain,$username)=@_;
 4054:     {
 4055: 	use integer;
 4056: 	my $symbchck=unpack("%32C*",$symb) << 27;
 4057: 	my $symbseed=numval($symb) << 22;
 4058: 	my $namechck=unpack("%32C*",$username) << 17;
 4059: 	my $nameseed=numval($username) << 12;
 4060: 	my $domainseed=unpack("%32C*",$domain) << 7;
 4061: 	my $courseseed=unpack("%32C*",$courseid);
 4062: 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
 4063: 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
 4064: 	#&Apache::lonxml::debug("rndseed :$num:$symb");
 4065: 	return $num;
 4066:     }
 4067: }
 4068: 
 4069: sub rndseed_64bit {
 4070:     my ($symb,$courseid,$domain,$username)=@_;
 4071:     {
 4072: 	use integer;
 4073: 	my $symbchck=unpack("%32S*",$symb) << 21;
 4074: 	my $symbseed=numval($symb) << 10;
 4075: 	my $namechck=unpack("%32S*",$username);
 4076: 	
 4077: 	my $nameseed=numval($username) << 21;
 4078: 	my $domainseed=unpack("%32S*",$domain) << 10;
 4079: 	my $courseseed=unpack("%32S*",$courseid);
 4080: 	
 4081: 	my $num1=$symbchck+$symbseed+$namechck;
 4082: 	my $num2=$nameseed+$domainseed+$courseseed;
 4083: 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
 4084: 	#&Apache::lonxml::debug("rndseed :$num:$symb");
 4085: 	return "$num1,$num2";
 4086:     }
 4087: }
 4088: 
 4089: sub rndseed_CODE_64bit {
 4090:     my ($symb,$courseid,$domain,$username)=@_;
 4091:     {
 4092: 	use integer;
 4093: 	my $symbchck=unpack("%32S*",$symb) << 16;
 4094: 	my $symbseed=numval($symb);
 4095: 	my $CODEseed=numval($ENV{'scantron.CODE'}) << 16;
 4096: 	my $courseseed=unpack("%32S*",$courseid);
 4097: 	my $num1=$symbseed+$CODEseed;
 4098: 	my $num2=$courseseed+$symbchck;
 4099: 	#&Apache::lonxml::debug("$symbseed:$CODEseed|$courseseed:$symbchck");
 4100: 	#&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
 4101: 	return "$num1,$num2";
 4102:     }
 4103: }
 4104: 
 4105: sub setup_random_from_rndseed {
 4106:     my ($rndseed)=@_;
 4107:     if ($rndseed =~/,/) {
 4108: 	my ($num1,$num2)=split(/,/,$rndseed);
 4109: 	&Math::Random::random_set_seed(abs($num1),abs($num2));
 4110:     } else {
 4111: 	&Math::Random::random_set_seed_from_phrase($rndseed);
 4112:     }
 4113: }
 4114: 
 4115: sub ireceipt {
 4116:     my ($funame,$fudom,$fucourseid,$fusymb)=@_;
 4117:     my $cuname=unpack("%32C*",$funame);
 4118:     my $cudom=unpack("%32C*",$fudom);
 4119:     my $cucourseid=unpack("%32C*",$fucourseid);
 4120:     my $cusymb=unpack("%32C*",$fusymb);
 4121:     my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
 4122:     return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
 4123:            ($cunique%$cuname+
 4124:             $cunique%$cudom+
 4125:             $cusymb%$cuname+
 4126:             $cusymb%$cudom+
 4127:             $cucourseid%$cuname+
 4128:             $cucourseid%$cudom);
 4129: }
 4130: 
 4131: sub receipt {
 4132:   my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
 4133:   return &ireceipt($name,$domain,$courseid,$symb);
 4134: }
 4135: 
 4136: # ------------------------------------------------------------ Serves up a file
 4137: # returns either the contents of the file or a -1
 4138: sub getfile {
 4139:  my $file=shift;
 4140:  if ($file=~/^\/*uploaded\//) { # user file
 4141:     my $ua=new LWP::UserAgent;
 4142:     my $request=new HTTP::Request('GET',&tokenwrapper($file));
 4143:     my $response=$ua->request($request);
 4144:     if ($response->is_success()) {
 4145:        return $response->content;
 4146:     } else { 
 4147:        return -1; 
 4148:     }
 4149:  } else { # normal file from res space
 4150:   &repcopy($file);
 4151:   if (! -e $file ) { return -1; };
 4152:   my $fh=Apache::File->new($file);
 4153:   my $a='';
 4154:   while (<$fh>) { $a .=$_; }
 4155:   return $a;
 4156:  }
 4157: }
 4158: 
 4159: sub filelocation {
 4160:   my ($dir,$file) = @_;
 4161:   my $location;
 4162:   $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
 4163:   if ($file=~m:^/~:) { # is a contruction space reference
 4164:     $location = $file;
 4165:     $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
 4166:   } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
 4167:     $location=$file;
 4168:   } else {
 4169:     $file=~s/^$perlvar{'lonDocRoot'}//;
 4170:     $file=~s:^/*res::;
 4171:     if ( !( $file =~ m:^/:) ) {
 4172:       $location = $dir. '/'.$file;
 4173:     } else {
 4174:       $location = '/home/httpd/html/res'.$file;
 4175:     }
 4176:   }
 4177:   $location=~s://+:/:g; # remove duplicate /
 4178:   while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
 4179:   return $location;
 4180: }
 4181: 
 4182: sub hreflocation {
 4183:     my ($dir,$file)=@_;
 4184:     unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
 4185:        my $finalpath=filelocation($dir,$file);
 4186:        $finalpath=~s/^\/home\/httpd\/html//;
 4187:        $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
 4188:        return $finalpath;
 4189:     } else {
 4190:        return $file;
 4191:     }
 4192: }
 4193: 
 4194: # ------------------------------------------------------------- Declutters URLs
 4195: 
 4196: sub declutter {
 4197:     my $thisfn=shift;
 4198:     $thisfn=~s/^$perlvar{'lonDocRoot'}//;
 4199:     $thisfn=~s/^\///;
 4200:     $thisfn=~s/^res\///;
 4201:     $thisfn=~s/\?.+$//;
 4202:     return $thisfn;
 4203: }
 4204: 
 4205: # ------------------------------------------------------------- Clutter up URLs
 4206: 
 4207: sub clutter {
 4208:     my $thisfn='/'.&declutter(shift);
 4209:     unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) { 
 4210:        $thisfn='/res'.$thisfn; 
 4211:     }
 4212:     return $thisfn;
 4213: }
 4214: 
 4215: # -------------------------------------------------------- Escape Special Chars
 4216: 
 4217: sub escape {
 4218:     my $str=shift;
 4219:     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
 4220:     return $str;
 4221: }
 4222: 
 4223: # ----------------------------------------------------- Un-Escape Special Chars
 4224: 
 4225: sub unescape {
 4226:     my $str=shift;
 4227:     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
 4228:     return $str;
 4229: }
 4230: 
 4231: sub mod_perl_version {
 4232:     if (defined($perlvar{'MODPERL2'})) {
 4233: 	return 2;
 4234:     }
 4235:     return 1;
 4236: }
 4237: # ================================================================ Main Program
 4238: 
 4239: sub goodbye {
 4240:    &logthis("Starting Shut down");
 4241:    &flushcourselogs();
 4242:    &logthis("Shutting down");
 4243:    return DONE;
 4244: }
 4245: 
 4246: BEGIN {
 4247: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
 4248:     unless ($readit) {
 4249: {
 4250:     my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
 4251: 
 4252:     while (my $configline=<$config>) {
 4253:         if ($configline =~ /^[^\#]*PerlSetVar/) {
 4254: 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
 4255:            chomp($varvalue);
 4256:            $perlvar{$varname}=$varvalue;
 4257:         }
 4258:     }
 4259: }
 4260: {
 4261:     my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
 4262: 
 4263:     while (my $configline=<$config>) {
 4264:         if ($configline =~ /^[^\#]*PerlSetVar/) {
 4265: 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
 4266:            chomp($varvalue);
 4267:            $perlvar{$varname}=$varvalue;
 4268:         }
 4269:     }
 4270: }
 4271: 
 4272: # ------------------------------------------------------------ Read domain file
 4273: {
 4274:     my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
 4275:                             '/domain.tab');
 4276:     %domaindescription = ();
 4277:     %domain_auth_def = ();
 4278:     %domain_auth_arg_def = ();
 4279:     if ($fh) {
 4280:        while (<$fh>) {
 4281:            next if (/^(\#|\s*$)/);
 4282: #           next if /^\#/;
 4283:            chomp;
 4284:            my ($domain, $domain_description, $def_auth, $def_auth_arg,
 4285: 	       $def_lang, $city, $longi, $lati) = split(/:/,$_);
 4286: 	   $domain_auth_def{$domain}=$def_auth;
 4287:            $domain_auth_arg_def{$domain}=$def_auth_arg;
 4288: 	   $domaindescription{$domain}=$domain_description;
 4289: 	   $domain_lang_def{$domain}=$def_lang;
 4290: 	   $domain_city{$domain}=$city;
 4291: 	   $domain_longi{$domain}=$longi;
 4292: 	   $domain_lati{$domain}=$lati;
 4293: 
 4294: #          &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
 4295: #          &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
 4296:        }
 4297:     }
 4298: }
 4299: 
 4300: 
 4301: # ------------------------------------------------------------- Read hosts file
 4302: {
 4303:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
 4304: 
 4305:     while (my $configline=<$config>) {
 4306:        next if ($configline =~ /^(\#|\s*$)/);
 4307:        chomp($configline);
 4308:        my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
 4309:        if ($id && $domain && $role && $name && $ip) {
 4310: 	 $hostname{$id}=$name;
 4311: 	 $hostdom{$id}=$domain;
 4312: 	 $hostip{$id}=$ip;
 4313: 	 $iphost{$ip}=$id;
 4314: 	 if ($role eq 'library') { $libserv{$id}=$name; }
 4315:        } else {
 4316: 	 if ($configline) {
 4317: 	   &logthis("Skipping hosts.tab line -$configline-");
 4318: 	 }
 4319:        }
 4320:     }
 4321: }
 4322: 
 4323: # ------------------------------------------------------ Read spare server file
 4324: {
 4325:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
 4326: 
 4327:     while (my $configline=<$config>) {
 4328:        chomp($configline);
 4329:        if ($configline) {
 4330:           $spareid{$configline}=1;
 4331:        }
 4332:     }
 4333: }
 4334: # ------------------------------------------------------------ Read permissions
 4335: {
 4336:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
 4337: 
 4338:     while (my $configline=<$config>) {
 4339:        chomp($configline);
 4340:       if ($configline) {
 4341:        my ($role,$perm)=split(/ /,$configline);
 4342:        if ($perm ne '') { $pr{$role}=$perm; }
 4343:       }
 4344:     }
 4345: }
 4346: 
 4347: # -------------------------------------------- Read plain texts for permissions
 4348: {
 4349:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
 4350: 
 4351:     while (my $configline=<$config>) {
 4352:        chomp($configline);
 4353:       if ($configline) {
 4354:        my ($short,$plain)=split(/:/,$configline);
 4355:        if ($plain ne '') { $prp{$short}=$plain; }
 4356:       }
 4357:     }
 4358: }
 4359: 
 4360: # ---------------------------------------------------------- Read package table
 4361: {
 4362:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
 4363: 
 4364:     while (my $configline=<$config>) {
 4365:        chomp($configline);
 4366:        my ($short,$plain)=split(/:/,$configline);
 4367:        my ($pack,$name)=split(/\&/,$short);
 4368:        if ($plain ne '') {
 4369:           $packagetab{$pack.'&'.$name.'&name'}=$name; 
 4370:           $packagetab{$short}=$plain; 
 4371:        }
 4372:     }
 4373: }
 4374: 
 4375: # ------------- set up temporary directory
 4376: {
 4377:     $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
 4378: 
 4379: }
 4380: 
 4381: %metacache=();
 4382: 
 4383: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
 4384: $dumpcount=0;
 4385: 
 4386: &logtouch();
 4387: &logthis('<font color=yellow>INFO: Read configuration</font>');
 4388: $readit=1;
 4389: }
 4390: }
 4391: 
 4392: 1;
 4393: __END__
 4394: 
 4395: =pod
 4396: 
 4397: =head1 NAME
 4398: 
 4399: Apache::lonnet - Subroutines to ask questions about things in the network.
 4400: 
 4401: =head1 SYNOPSIS
 4402: 
 4403: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
 4404: 
 4405:  &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
 4406: 
 4407: Common parameters:
 4408: 
 4409: =over 4
 4410: 
 4411: =item *
 4412: 
 4413: $uname : an internal username (if $cname expecting a course Id specifically)
 4414: 
 4415: =item *
 4416: 
 4417: $udom : a domain (if $cdom expecting a course's domain specifically)
 4418: 
 4419: =item *
 4420: 
 4421: $symb : a resource instance identifier
 4422: 
 4423: =item *
 4424: 
 4425: $namespace : the name of a .db file that contains the data needed or
 4426: being set.
 4427: 
 4428: =back
 4429: 
 4430: =head1 OVERVIEW
 4431: 
 4432: lonnet provides subroutines which interact with the
 4433: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
 4434: about classes, users, and resources.
 4435: 
 4436: For many of these objects you can also use this to store data about
 4437: them or modify them in various ways.
 4438: 
 4439: =head2 Symbs
 4440: 
 4441: To identify a specific instance of a resource, LON-CAPA uses symbols
 4442: or "symbs"X<symb>. These identifiers are built from the URL of the
 4443: map, the resource number of the resource in the map, and the URL of
 4444: the resource itself. The latter is somewhat redundant, but might help
 4445: if maps change.
 4446: 
 4447: An example is
 4448: 
 4449:  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
 4450: 
 4451: The respective map entry is
 4452: 
 4453:  <resource id="19" src="/res/msu/korte/tests/part12.problem"
 4454:   title="Problem 2">
 4455:  </resource>
 4456: 
 4457: Symbs are used by the random number generator, as well as to store and
 4458: restore data specific to a certain instance of for example a problem.
 4459: 
 4460: =head2 Storing And Retrieving Data
 4461: 
 4462: X<store()>X<cstore()>X<restore()>Three of the most important functions
 4463: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
 4464: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
 4465: is is the non-critical message twin of cstore. These functions are for
 4466: handlers to store a perl hash to a user's permanent data space in an
 4467: easy manner, and to retrieve it again on another call. It is expected
 4468: that a handler would use this once at the beginning to retrieve data,
 4469: and then again once at the end to send only the new data back.
 4470: 
 4471: The data is stored in the user's data directory on the user's
 4472: homeserver under the ID of the course.
 4473: 
 4474: The hash that is returned by restore will have all of the previous
 4475: value for all of the elements of the hash.
 4476: 
 4477: Example:
 4478: 
 4479:  #creating a hash
 4480:  my %hash;
 4481:  $hash{'foo'}='bar';
 4482: 
 4483:  #storing it
 4484:  &Apache::lonnet::cstore(\%hash);
 4485: 
 4486:  #changing a value
 4487:  $hash{'foo'}='notbar';
 4488: 
 4489:  #adding a new value
 4490:  $hash{'bar'}='foo';
 4491:  &Apache::lonnet::cstore(\%hash);
 4492: 
 4493:  #retrieving the hash
 4494:  my %history=&Apache::lonnet::restore();
 4495: 
 4496:  #print the hash
 4497:  foreach my $key (sort(keys(%history))) {
 4498:    print("\%history{$key} = $history{$key}");
 4499:  }
 4500: 
 4501: Will print out:
 4502: 
 4503:  %history{1:foo} = bar
 4504:  %history{1:keys} = foo:timestamp
 4505:  %history{1:timestamp} = 990455579
 4506:  %history{2:bar} = foo
 4507:  %history{2:foo} = notbar
 4508:  %history{2:keys} = foo:bar:timestamp
 4509:  %history{2:timestamp} = 990455580
 4510:  %history{bar} = foo
 4511:  %history{foo} = notbar
 4512:  %history{timestamp} = 990455580
 4513:  %history{version} = 2
 4514: 
 4515: Note that the special hash entries C<keys>, C<version> and
 4516: C<timestamp> were added to the hash. C<version> will be equal to the
 4517: total number of versions of the data that have been stored. The
 4518: C<timestamp> attribute will be the UNIX time the hash was
 4519: stored. C<keys> is available in every historical section to list which
 4520: keys were added or changed at a specific historical revision of a
 4521: hash.
 4522: 
 4523: B<Warning>: do not store the hash that restore returns directly. This
 4524: will cause a mess since it will restore the historical keys as if the
 4525: were new keys. I.E. 1:foo will become 1:1:foo etc.
 4526: 
 4527: Calling convention:
 4528: 
 4529:  my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
 4530:  &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
 4531: 
 4532: For more detailed information, see lonnet specific documentation.
 4533: 
 4534: =head1 RETURN MESSAGES
 4535: 
 4536: =over 4
 4537: 
 4538: =item * B<con_lost>: unable to contact remote host
 4539: 
 4540: =item * B<con_delayed>: unable to contact remote host, message will be delivered
 4541: when the connection is brought back up
 4542: 
 4543: =item * B<con_failed>: unable to contact remote host and unable to save message
 4544: for later delivery
 4545: 
 4546: =item * B<error:>: an error a occured, a description of the error follows the :
 4547: 
 4548: =item * B<no_such_host>: unable to fund a host associated with the user/domain
 4549: that was requested
 4550: 
 4551: =back
 4552: 
 4553: =head1 PUBLIC SUBROUTINES
 4554: 
 4555: =head2 Session Environment Functions
 4556: 
 4557: =over 4
 4558: 
 4559: =item * 
 4560: X<appenv()>
 4561: B<appenv(%hash)>: the value of %hash is written to
 4562: the user envirnoment file, and will be restored for each access this
 4563: user makes during this session, also modifies the %ENV for the current
 4564: process
 4565: 
 4566: =item *
 4567: X<delenv()>
 4568: B<delenv($regexp)>: removes all items from the session
 4569: environment file that matches the regular expression in $regexp. The
 4570: values are also delted from the current processes %ENV.
 4571: 
 4572: =back
 4573: 
 4574: =head2 User Information
 4575: 
 4576: =over 4
 4577: 
 4578: =item *
 4579: X<queryauthenticate()>
 4580: B<queryauthenticate($uname,$udom)>: try to determine user's current 
 4581: authentication scheme
 4582: 
 4583: =item *
 4584: X<authenticate()>
 4585: B<authenticate($uname,$upass,$udom)>: try to
 4586: authenticate user from domain's lib servers (first use the current
 4587: one). C<$upass> should be the users password.
 4588: 
 4589: =item *
 4590: X<homeserver()>
 4591: B<homeserver($uname,$udom)>: find the server which has
 4592: the user's directory and files (there must be only one), this caches
 4593: the answer, and also caches if there is a borken connection.
 4594: 
 4595: =item *
 4596: X<idget()>
 4597: B<idget($udom,@ids)>: find the usernames behind a list of IDs
 4598: (IDs are a unique resource in a domain, there must be only 1 ID per
 4599: username, and only 1 username per ID in a specific domain) (returns
 4600: hash: id=>name,id=>name)
 4601: 
 4602: =item *
 4603: X<idrget()>
 4604: B<idrget($udom,@unames)>: find the IDs behind a list of
 4605: usernames (returns hash: name=>id,name=>id)
 4606: 
 4607: =item *
 4608: X<idput()>
 4609: B<idput($udom,%ids)>: store away a list of names and associated IDs
 4610: 
 4611: =item *
 4612: X<rolesinit()>
 4613: B<rolesinit($udom,$username,$authhost)>: get user privileges
 4614: 
 4615: =item *
 4616: X<usection()>
 4617: B<usection($udom,$uname,$cname)>: finds the section of student in the
 4618: course $cname, return section name/number or '' for "not in course"
 4619: and '-1' for "no section"
 4620: 
 4621: =item *
 4622: X<userenvironment()>
 4623: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
 4624: passed in @what from the requested user's environment, returns a hash
 4625: 
 4626: =back
 4627: 
 4628: =head2 User Roles
 4629: 
 4630: =over 4
 4631: 
 4632: =item *
 4633: 
 4634: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
 4635: actions
 4636:  F: full access
 4637:  U,I,K: authentication modes (cxx only)
 4638:  '': forbidden
 4639:  1: user needs to choose course
 4640:  2: browse allowed
 4641: 
 4642: =item *
 4643: 
 4644: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
 4645: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
 4646: and course level
 4647: 
 4648: =item *
 4649: 
 4650: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
 4651: explanation of a user role term
 4652: 
 4653: =back
 4654: 
 4655: =head2 User Modification
 4656: 
 4657: =over 4
 4658: 
 4659: =item *
 4660: 
 4661: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
 4662: user for the level given by URL.  Optional start and end dates (leave empty
 4663: string or zero for "no date")
 4664: 
 4665: =item *
 4666: 
 4667: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
 4668: change a users, password, possible return values are: ok,
 4669: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
 4670: refused
 4671: 
 4672: =item *
 4673: 
 4674: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
 4675: 
 4676: =item *
 4677: 
 4678: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) : 
 4679: modify user
 4680: 
 4681: =item *
 4682: 
 4683: modifystudent
 4684: 
 4685: modify a students enrollment and identification information.
 4686: The course id is resolved based on the current users environment.  
 4687: This means the envoking user must be a course coordinator or otherwise
 4688: associated with a course.
 4689: 
 4690: This call is essentially a wrapper for lonnet::modifyuser and
 4691: lonnet::modify_student_enrollment
 4692: 
 4693: Inputs: 
 4694: 
 4695: =over 4
 4696: 
 4697: =item B<$udom> Students loncapa domain
 4698: 
 4699: =item B<$uname> Students loncapa login name
 4700: 
 4701: =item B<$uid> Students id/student number
 4702: 
 4703: =item B<$umode> Students authentication mode
 4704: 
 4705: =item B<$upass> Students password
 4706: 
 4707: =item B<$first> Students first name
 4708: 
 4709: =item B<$middle> Students middle name
 4710: 
 4711: =item B<$last> Students last name
 4712: 
 4713: =item B<$gene> Students generation
 4714: 
 4715: =item B<$usec> Students section in course
 4716: 
 4717: =item B<$end> Unix time of the roles expiration
 4718: 
 4719: =item B<$start> Unix time of the roles start date
 4720: 
 4721: =item B<$forceid> If defined, allow $uid to be changed
 4722: 
 4723: =item B<$desiredhome> server to use as home server for student
 4724: 
 4725: =back
 4726: 
 4727: =item *
 4728: 
 4729: modify_student_enrollment
 4730: 
 4731: Change a students enrollment status in a class.  The environment variable
 4732: 'role.request.course' must be defined for this function to proceed.
 4733: 
 4734: Inputs:
 4735: 
 4736: =over 4
 4737: 
 4738: =item $udom, students domain
 4739: 
 4740: =item $uname, students name
 4741: 
 4742: =item $uid, students user id
 4743: 
 4744: =item $first, students first name
 4745: 
 4746: =item $middle
 4747: 
 4748: =item $last
 4749: 
 4750: =item $gene
 4751: 
 4752: =item $usec
 4753: 
 4754: =item $end
 4755: 
 4756: =item $start
 4757: 
 4758: =back
 4759: 
 4760: 
 4761: =item *
 4762: 
 4763: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
 4764: custom role; give a custom role to a user for the level given by URL.  Specify
 4765: name and domain of role author, and role name
 4766: 
 4767: =item *
 4768: 
 4769: revokerole($udom,$uname,$url,$role) : revoke a role for url
 4770: 
 4771: =item *
 4772: 
 4773: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
 4774: 
 4775: =back
 4776: 
 4777: =head2 Course Infomation
 4778: 
 4779: =over 4
 4780: 
 4781: =item *
 4782: 
 4783: coursedescription($courseid) : course description
 4784: 
 4785: =item *
 4786: 
 4787: courseresdata($coursenum,$coursedomain,@which) : request for current
 4788: parameter setting for a specific course, @what should be a list of
 4789: parameters to ask about. This routine caches answers for 5 minutes.
 4790: 
 4791: =back
 4792: 
 4793: =head2 Course Modification
 4794: 
 4795: =over 4
 4796: 
 4797: =item *
 4798: 
 4799: writecoursepref($courseid,%prefs) : write preferences (environment
 4800: database) for a course
 4801: 
 4802: =item *
 4803: 
 4804: createcourse($udom,$description,$url) : make/modify course
 4805: 
 4806: =back
 4807: 
 4808: =head2 Resource Subroutines
 4809: 
 4810: =over 4
 4811: 
 4812: =item *
 4813: 
 4814: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
 4815: 
 4816: =item *
 4817: 
 4818: repcopy($filename) : subscribes to the requested file, and attempts to
 4819: replicate from the owning library server, Might return
 4820: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
 4821: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
 4822: resource. Expects the local filesystem pathname
 4823: (/home/httpd/html/res/....)
 4824: 
 4825: =back
 4826: 
 4827: =head2 Resource Information
 4828: 
 4829: =over 4
 4830: 
 4831: =item *
 4832: 
 4833: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
 4834: a vairety of different possible values, $varname should be a request
 4835: string, and the other parameters can be used to specify who and what
 4836: one is asking about.
 4837: 
 4838: Possible values for $varname are environment.lastname (or other item
 4839: from the envirnment hash), user.name (or someother aspect about the
 4840: user), resource.0.maxtries (or some other part and parameter of a
 4841: resource)
 4842: 
 4843: =item *
 4844: 
 4845: directcondval($number) : get current value of a condition; reads from a state
 4846: string
 4847: 
 4848: =item *
 4849: 
 4850: condval($condidx) : value of condition index based on state
 4851: 
 4852: =item *
 4853: 
 4854: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
 4855: resource's metadata, $what should be either a specific key, or either
 4856: 'keys' (to get a list of possible keys) or 'packages' to get a list of
 4857: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
 4858: 
 4859: this function automatically caches all requests
 4860: 
 4861: =item *
 4862: 
 4863: metadata_query($query,$custom,$customshow) : make a metadata query against the
 4864: network of library servers; returns file handle of where SQL and regex results
 4865: will be stored for query
 4866: 
 4867: =item *
 4868: 
 4869: symbread($filename) : return symbolic list entry (filename argument optional);
 4870: returns the data handle
 4871: 
 4872: =item *
 4873: 
 4874: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
 4875: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
 4876: failure, user must be in a course, as it assumes the existance of the
 4877: course initi hash, and uses $ENV('request.course.id'}
 4878: 
 4879: 
 4880: =item *
 4881: 
 4882: symbclean($symb) : removes versions numbers from a symb, returns the
 4883: cleaned symb
 4884: 
 4885: =item *
 4886: 
 4887: is_on_map($uri) : checks if the $uri is somewhere on the current
 4888: course map, user must be in a course for it to work.
 4889: 
 4890: =item *
 4891: 
 4892: numval($salt) : return random seed value (addend for rndseed)
 4893: 
 4894: =item *
 4895: 
 4896: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
 4897: a random seed, all arguments are optional, if they aren't sent it uses the
 4898: environment to derive them. Note: if symb isn't sent and it can't get one
 4899: from &symbread it will use the current time as its return value
 4900: 
 4901: =item *
 4902: 
 4903: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
 4904: unfakeable, receipt
 4905: 
 4906: =item *
 4907: 
 4908: receipt() : API to ireceipt working off of ENV values; given out to users
 4909: 
 4910: =item *
 4911: 
 4912: countacc($url) : count the number of accesses to a given URL
 4913: 
 4914: =item *
 4915: 
 4916: 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
 4917: 
 4918: =item *
 4919: 
 4920: 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)
 4921: 
 4922: =item *
 4923: 
 4924: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
 4925: 
 4926: =item *
 4927: 
 4928: devalidate($symb) : devalidate temporary spreadsheet calculations,
 4929: forcing spreadsheet to reevaluate the resource scores next time.
 4930: 
 4931: =back
 4932: 
 4933: =head2 Storing/Retreiving Data
 4934: 
 4935: =over 4
 4936: 
 4937: =item *
 4938: 
 4939: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
 4940: for this url; hashref needs to be given and should be a \%hashname; the
 4941: remaining args aren't required and if they aren't passed or are '' they will
 4942: be derived from the ENV
 4943: 
 4944: =item *
 4945: 
 4946: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
 4947: uses critical subroutine
 4948: 
 4949: =item *
 4950: 
 4951: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
 4952: all args are optional
 4953: 
 4954: =item *
 4955: 
 4956: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
 4957: works very similar to store/cstore, but all data is stored in a
 4958: temporary location and can be reset using tmpreset, $storehash should
 4959: be a hash reference, returns nothing on success
 4960: 
 4961: =item *
 4962: 
 4963: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
 4964: similar to restore, but all data is stored in a temporary location and
 4965: can be reset using tmpreset. Returns a hash of values on success,
 4966: error string otherwise.
 4967: 
 4968: =item *
 4969: 
 4970: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
 4971: deltes all keys for $symb form the temporary storage hash.
 4972: 
 4973: =item *
 4974: 
 4975: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
 4976: reference filled in from namesp ($udom and $uname are optional)
 4977: 
 4978: =item *
 4979: 
 4980: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
 4981: namesp ($udom and $uname are optional)
 4982: 
 4983: =item *
 4984: 
 4985: dump($namespace,$udom,$uname,$regexp) : 
 4986: dumps the complete (or key matching regexp) namespace into a hash
 4987: ($udom, $uname and $regexp are optional)
 4988: 
 4989: =item *
 4990: 
 4991: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
 4992: ($udom and $uname are optional)
 4993: 
 4994: =item *
 4995: 
 4996: cput($namespace,$storehash,$udom,$uname) : critical put
 4997: ($udom and $uname are optional)
 4998: 
 4999: =item *
 5000: 
 5001: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
 5002: reference filled in from namesp (encrypts the return communication)
 5003: ($udom and $uname are optional)
 5004: 
 5005: =item *
 5006: 
 5007: log($udom,$name,$home,$message) : write to permanent log for user; use
 5008: critical subroutine
 5009: 
 5010: =back
 5011: 
 5012: =head2 Network Status Functions
 5013: 
 5014: =over 4
 5015: 
 5016: =item *
 5017: 
 5018: dirlist($uri) : return directory list based on URI
 5019: 
 5020: =item *
 5021: 
 5022: spareserver() : find server with least workload from spare.tab
 5023: 
 5024: =back
 5025: 
 5026: =head2 Apache Request
 5027: 
 5028: =over 4
 5029: 
 5030: =item *
 5031: 
 5032: ssi($url,%hash) : server side include, does a complete request cycle on url to
 5033: localhost, posts hash
 5034: 
 5035: =back
 5036: 
 5037: =head2 Data to String to Data
 5038: 
 5039: =over 4
 5040: 
 5041: =item *
 5042: 
 5043: hash2str(%hash) : convert a hash into a string complete with escaping and '='
 5044: and '&' separators, supports elements that are arrayrefs and hashrefs
 5045: 
 5046: =item *
 5047: 
 5048: hashref2str($hashref) : convert a hashref into a string complete with
 5049: escaping and '=' and '&' separators, supports elements that are
 5050: arrayrefs and hashrefs
 5051: 
 5052: =item *
 5053: 
 5054: arrayref2str($arrayref) : convert an arrayref into a string complete
 5055: with escaping and '&' separators, supports elements that are arrayrefs
 5056: and hashrefs
 5057: 
 5058: =item *
 5059: 
 5060: str2hash($string) : convert string to hash using unescaping and
 5061: splitting on '=' and '&', supports elements that are arrayrefs and
 5062: hashrefs
 5063: 
 5064: =item *
 5065: 
 5066: str2array($string) : convert string to hash using unescaping and
 5067: splitting on '&', supports elements that are arrayrefs and hashrefs
 5068: 
 5069: =back
 5070: 
 5071: =head2 Logging Routines
 5072: 
 5073: =over 4
 5074: 
 5075: These routines allow one to make log messages in the lonnet.log and
 5076: lonnet.perm logfiles.
 5077: 
 5078: =item *
 5079: 
 5080: logtouch() : make sure the logfile, lonnet.log, exists
 5081: 
 5082: =item *
 5083: 
 5084: logthis() : append message to the normal lonnet.log file, it gets
 5085: preiodically rolled over and deleted.
 5086: 
 5087: =item *
 5088: 
 5089: logperm() : append a permanent message to lonnet.perm.log, this log
 5090: file never gets deleted by any automated portion of the system, only
 5091: messages of critical importance should go in here.
 5092: 
 5093: =back
 5094: 
 5095: =head2 General File Helper Routines
 5096: 
 5097: =over 4
 5098: 
 5099: =item *
 5100: 
 5101: getfile($file) : returns the entire contents of a file or -1; it
 5102: properly subscribes to and replicates the file if neccessary.
 5103: 
 5104: =item *
 5105: 
 5106: filelocation($dir,$file) : returns file system location of a file
 5107: based on URI; meant to be "fairly clean" absolute reference, $dir is a
 5108: directory that relative $file lookups are to looked in ($dir of /a/dir
 5109: and a file of ../bob will become /a/bob)
 5110: 
 5111: =item *
 5112: 
 5113: hreflocation($dir,$file) : returns file system location or a URL; same as
 5114: filelocation except for hrefs
 5115: 
 5116: =item *
 5117: 
 5118: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
 5119: 
 5120: =back
 5121: 
 5122: =head2 HTTP Helper Routines
 5123: 
 5124: =over 4
 5125: 
 5126: =item *
 5127: 
 5128: escape() : unpack non-word characters into CGI-compatible hex codes
 5129: 
 5130: =item *
 5131: 
 5132: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
 5133: 
 5134: =back
 5135: 
 5136: =head1 PRIVATE SUBROUTINES
 5137: 
 5138: =head2 Underlying communication routines (Shouldn't call)
 5139: 
 5140: =over 4
 5141: 
 5142: =item *
 5143: 
 5144: subreply() : tries to pass a message to lonc, returns con_lost if incapable
 5145: 
 5146: =item *
 5147: 
 5148: reply() : uses subreply to send a message to remote machine, logs all failures
 5149: 
 5150: =item *
 5151: 
 5152: critical() : passes a critical message to another server; if cannot
 5153: get through then place message in connection buffer directory and
 5154: returns con_delayed, if incapable of saving message, returns
 5155: con_failed
 5156: 
 5157: =item *
 5158: 
 5159: reconlonc() : tries to reconnect lonc client processes.
 5160: 
 5161: =back
 5162: 
 5163: =head2 Resource Access Logging
 5164: 
 5165: =over 4
 5166: 
 5167: =item *
 5168: 
 5169: flushcourselogs() : flush (save) buffer logs and access logs
 5170: 
 5171: =item *
 5172: 
 5173: courselog($what) : save message for course in hash
 5174: 
 5175: =item *
 5176: 
 5177: courseacclog($what) : save message for course using &courselog().  Perform
 5178: special processing for specific resource types (problems, exams, quizzes, etc).
 5179: 
 5180: =item *
 5181: 
 5182: goodbye() : flush course logs and log shutting down; it is called in srm.conf
 5183: as a PerlChildExitHandler
 5184: 
 5185: =back
 5186: 
 5187: =head2 Other
 5188: 
 5189: =over 4
 5190: 
 5191: =item *
 5192: 
 5193: symblist($mapname,%newhash) : update symbolic storage links
 5194: 
 5195: =back
 5196: 
 5197: =cut

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