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

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

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