Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.665

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

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