File:  [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.560: download - view: text, annotated - select for diffs
Wed Nov 3 21:12:12 2004 UTC (19 years, 8 months ago) by banghart
Branches: MAIN
CVS tags: HEAD
	mark_as_readonly seems to work (superficially tested),
	unmark_as_readonly still untested

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

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