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

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

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