Return to lonnet.pm CVS log

Up to [LON-CAPA] / loncom / lonnet / perl

Domain roles now stored in nohist_domainroles.db file in /home/httpd/lonUsers/$dom on library servers in domain.  To be switched to storage on a single "primary" library server.

lonnotify::print_display_option_form() uses contents of nohist_domainroles.db to present choice of Domain Coordinators when selecting options for display of sent mail.

lond routines added for storage of broadcase dcmail.

Future consolidation of put/dump lond routines for domain-level db files is desirable.

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