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

1.1       albertel    1: # The LearningOnline Network
                      2: # TCP networking package
1.12      www         3: #
1.1056.2.7! raeburn     4: # $Id: lonnet.pm,v 1.1056.2.6 2010/08/20 20:47:18 raeburn Exp $
1.178     www         5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.169     harris41   28: ###
                     29: 
1.971     jms        30: =pod
                     31: 
1.972     jms        32: =head1 NAME
                     33: 
                     34: Apache::lonnet.pm
                     35: 
                     36: =head1 SYNOPSIS
                     37: 
                     38: This file is an interface to the lonc processes of
                     39: the LON-CAPA network as well as set of elaborated functions for handling information
                     40: necessary for navigating through a given cluster of LON-CAPA machines within a
                     41: domain. There are over 40 specialized functions in this module which handle the
                     42: reading and transmission of metadata, user information (ids, names, environments, roles,
                     43: logs), file information (storage, reading, directories, extensions, replication, embedded
                     44: styles and descriptors), educational resources (course descriptions, section names and
                     45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
                     46: and from more descriptive phrases or explanations.
                     47: 
                     48: This is part of the LearningOnline Network with CAPA project
                     49: described at http://www.lon-capa.org.
                     50: 
1.971     jms        51: =head1 Package Variables
                     52: 
                     53: These are largely undocumented, so if you decipher one please note it here.
                     54: 
                     55: =over 4
                     56: 
                     57: =item $processmarker
                     58: 
                     59: Contains the time this process was started and this servers host id.
                     60: 
                     61: =item $dumpcount
                     62: 
                     63: Counts the number of times a message log flush has been attempted (regardless
                     64: of success) by this process.  Used as part of the filename when messages are
                     65: delayed.
                     66: 
                     67: =back
                     68: 
                     69: =cut
                     70: 
1.1       albertel   71: package Apache::lonnet;
                     72: 
                     73: use strict;
1.8       www        74: use LWP::UserAgent();
1.486     www        75: use HTTP::Date;
1.977     amueller   76: use Image::Magick;
                     77: 
1.871     albertel   78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.968     raeburn    79:             $_64bit %env %protocol);
1.871     albertel   80: 
                     81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
                     82:     %userrolehash, $processmarker, $dumpcount, %coursedombuf,
                     83:     %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958     www        84:     %courseownerbuf, %coursetypebuf,$locknum);
1.403     www        85: 
1.1       albertel   86: use IO::Socket;
1.31      www        87: use GDBM_File;
1.208     albertel   88: use HTML::LCParser;
1.88      www        89: use Fcntl qw(:flock);
1.870     albertel   90: use Storable qw(thaw nfreeze);
1.539     albertel   91: use Time::HiRes qw( gettimeofday tv_interval );
1.599     albertel   92: use Cache::Memcached;
1.676     albertel   93: use Digest::MD5;
1.790     albertel   94: use Math::Random;
1.1024    raeburn    95: use File::MMagic;
1.807     albertel   96: use LONCAPA qw(:DEFAULT :match);
1.740     www        97: use LONCAPA::Configuration;
1.676     albertel   98: 
1.195     www        99: my $readit;
1.550     foxr      100: my $max_connection_retries = 10;     # Or some such value.
1.1       albertel  101: 
1.619     albertel  102: require Exporter;
                    103: 
                    104: our @ISA = qw (Exporter);
                    105: our @EXPORT = qw(%env);
                    106: 
1.449     matthew   107: 
1.1       albertel  108: # --------------------------------------------------------------------- Logging
1.729     www       109: {
                    110:     my $logid;
                    111:     sub instructor_log {
1.957     raeburn   112: 	my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
                    113:         if (($cnum eq '') || ($cdom eq '')) {
                    114:             $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    115:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                    116:         }
1.729     www       117: 	$logid++;
1.957     raeburn   118:         my $now = time();
                    119: 	my $id=$now.'00000'.$$.'00000'.$logid;
1.729     www       120: 	return &Apache::lonnet::put('nohist_'.$hash_name,
1.730     www       121: 				    { $id => {
                    122: 					'exe_uname' => $env{'user.name'},
                    123: 					'exe_udom'  => $env{'user.domain'},
1.957     raeburn   124: 					'exe_time'  => $now,
1.730     www       125: 					'exe_ip'    => $ENV{'REMOTE_ADDR'},
                    126: 					'delflag'   => $delflag,
                    127: 					'logentry'  => $storehash,
                    128: 					'uname'     => $uname,
                    129: 					'udom'      => $udom,
                    130: 				    }
1.957     raeburn   131: 				  },$cdom,$cnum);
1.729     www       132:     }
                    133: }
1.1       albertel  134: 
1.163     harris41  135: sub logtouch {
                    136:     my $execdir=$perlvar{'lonDaemons'};
1.448     albertel  137:     unless (-e "$execdir/logs/lonnet.log") {	
                    138: 	open(my $fh,">>$execdir/logs/lonnet.log");
1.163     harris41  139: 	close $fh;
                    140:     }
                    141:     my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
                    142:     chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
                    143: }
                    144: 
1.1       albertel  145: sub logthis {
                    146:     my $message=shift;
                    147:     my $execdir=$perlvar{'lonDaemons'};
                    148:     my $now=time;
                    149:     my $local=localtime($now);
1.448     albertel  150:     if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986     foxr      151: 	my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
                    152: 	print $fh $logstring;
1.448     albertel  153: 	close($fh);
                    154:     }
1.1       albertel  155:     return 1;
                    156: }
                    157: 
                    158: sub logperm {
                    159:     my $message=shift;
                    160:     my $execdir=$perlvar{'lonDaemons'};
                    161:     my $now=time;
                    162:     my $local=localtime($now);
1.448     albertel  163:     if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
                    164: 	print $fh "$now:$message:$local\n";
                    165: 	close($fh);
                    166:     }
1.1       albertel  167:     return 1;
                    168: }
                    169: 
1.850     albertel  170: sub create_connection {
1.853     albertel  171:     my ($hostname,$lonid) = @_;
1.851     albertel  172:     my $client=IO::Socket::UNIX->new(Peer    => $perlvar{'lonSockCreate'},
1.850     albertel  173: 				     Type    => SOCK_STREAM,
                    174: 				     Timeout => 10);
                    175:     return 0 if (!$client);
1.890     albertel  176:     print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850     albertel  177:     my $result = <$client>;
                    178:     chomp($result);
                    179:     return 1 if ($result eq 'done');
                    180:     return 0;
                    181: }
                    182: 
1.983     raeburn   183: sub get_server_timezone {
                    184:     my ($cnum,$cdom) = @_;
                    185:     my $home=&homeserver($cnum,$cdom);
                    186:     if ($home ne 'no_host') {
                    187:         my $cachetime = 24*3600;
                    188:         my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
                    189:         if (defined($cached)) {
                    190:             return $timezone;
                    191:         } else {
                    192:             my $timezone = &reply('servertimezone',$home);
                    193:             return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
                    194:         }
                    195:     }
                    196: }
1.850     albertel  197: 
1.993     raeburn   198: sub get_server_loncaparev {
                    199:     my ($dom,$lonhost) = @_;
                    200:     if (defined($lonhost)) {
                    201:         if (!defined(&hostname($lonhost))) {
                    202:             undef($lonhost);
                    203:         }
                    204:     }
                    205:     if (!defined($lonhost)) {
                    206:         if (defined(&domain($dom,'primary'))) {
                    207:             $lonhost=&domain($dom,'primary');
                    208:             if ($lonhost eq 'no_host') {
                    209:                 undef($lonhost);
                    210:             }
                    211:         }
                    212:     }
                    213:     if (defined($lonhost)) {
                    214:         my $cachetime = 24*3600;
                    215:         my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
                    216:         if (defined($cached)) {
                    217:             return $loncaparev;
                    218:         } else {
                    219:             my $loncaparev = &reply('serverloncaparev',$lonhost);
                    220:             return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
                    221:         }
                    222:     }
                    223: }
                    224: 
1.1       albertel  225: # -------------------------------------------------- Non-critical communication
                    226: sub subreply {
                    227:     my ($cmd,$server)=@_;
1.838     albertel  228:     my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549     foxr      229:     #
                    230:     #  With loncnew process trimming, there's a timing hole between lonc server
                    231:     #  process exit and the master server picking up the listen on the AF_UNIX
                    232:     #  socket.  In that time interval, a lock file will exist:
                    233: 
                    234:     my $lockfile=$peerfile.".lock";
                    235:     while (-e $lockfile) {	# Need to wait for the lockfile to disappear.
                    236: 	sleep(1);
                    237:     }
                    238:     # At this point, either a loncnew parent is listening or an old lonc
1.550     foxr      239:     # or loncnew child is listening so we can connect or everything's dead.
1.549     foxr      240:     #
1.550     foxr      241:     #   We'll give the connection a few tries before abandoning it.  If
                    242:     #   connection is not possible, we'll con_lost back to the client.
                    243:     #   
                    244:     my $client;
                    245:     for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
                    246: 	$client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                    247: 				      Type    => SOCK_STREAM,
                    248: 				      Timeout => 10);
1.869     albertel  249: 	if ($client) {
1.550     foxr      250: 	    last;		# Connected!
1.850     albertel  251: 	} else {
1.853     albertel  252: 	    &create_connection(&hostname($server),$server);
1.550     foxr      253: 	}
1.850     albertel  254:         sleep(1);		# Try again later if failed connection.
1.550     foxr      255:     }
                    256:     my $answer;
                    257:     if ($client) {
1.704     albertel  258: 	print $client "sethost:$server:$cmd\n";
1.550     foxr      259: 	$answer=<$client>;
                    260: 	if (!$answer) { $answer="con_lost"; }
                    261: 	chomp($answer);
                    262:     } else {
                    263: 	$answer = 'con_lost';	# Failed connection.
                    264:     }
1.1       albertel  265:     return $answer;
                    266: }
                    267: 
                    268: sub reply {
                    269:     my ($cmd,$server)=@_;
1.838     albertel  270:     unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1       albertel  271:     my $answer=subreply($cmd,$server);
1.65      www       272:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672     albertel  273:        &logthis("<font color=\"blue\">WARNING:".
1.12      www       274:                 " $cmd to $server returned $answer</font>");
                    275:     }
1.1       albertel  276:     return $answer;
                    277: }
                    278: 
                    279: # ----------------------------------------------------------- Send USR1 to lonc
                    280: 
                    281: sub reconlonc {
1.891     albertel  282:     my ($lonid) = @_;
                    283:     my $hostname = &hostname($lonid);
                    284:     if ($lonid) {
                    285: 	my $peerfile="$perlvar{'lonSockDir'}/$hostname";
                    286: 	if ($hostname && -e $peerfile) {
                    287: 	    &logthis("Trying to reconnect lonc for $lonid ($hostname)");
                    288: 	    my $client=IO::Socket::UNIX->new(Peer    => $peerfile,
                    289: 					     Type    => SOCK_STREAM,
                    290: 					     Timeout => 10);
                    291: 	    if ($client) {
                    292: 		print $client ("reset_retries\n");
                    293: 		my $answer=<$client>;
                    294: 		#reset just this one.
                    295: 	    }
                    296: 	}
                    297: 	return;
                    298:     }
                    299: 
1.836     www       300:     &logthis("Trying to reconnect lonc");
1.1       albertel  301:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448     albertel  302:     if (open(my $fh,"<$loncfile")) {
1.1       albertel  303: 	my $loncpid=<$fh>;
                    304:         chomp($loncpid);
                    305:         if (kill 0 => $loncpid) {
                    306: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
                    307:             kill USR1 => $loncpid;
                    308:             sleep 1;
1.836     www       309:          } else {
1.12      www       310: 	    &logthis(
1.672     albertel  311:                "<font color=\"blue\">WARNING:".
1.12      www       312:                " lonc at pid $loncpid not responding, giving up</font>");
1.1       albertel  313:         }
                    314:     } else {
1.836     www       315: 	&logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1       albertel  316:     }
                    317: }
                    318: 
                    319: # ------------------------------------------------------ Critical communication
1.12      www       320: 
1.1       albertel  321: sub critical {
                    322:     my ($cmd,$server)=@_;
1.838     albertel  323:     unless (&hostname($server)) {
1.672     albertel  324:         &logthis("<font color=\"blue\">WARNING:".
1.89      www       325:                " Critical message to unknown server ($server)</font>");
                    326:         return 'no_such_host';
                    327:     }
1.1       albertel  328:     my $answer=reply($cmd,$server);
                    329:     if ($answer eq 'con_lost') {
                    330: 	&reconlonc("$perlvar{'lonSockDir'}/$server");
1.589     albertel  331: 	my $answer=reply($cmd,$server);
1.1       albertel  332:         if ($answer eq 'con_lost') {
                    333:             my $now=time;
                    334:             my $middlename=$cmd;
1.5       www       335:             $middlename=substr($middlename,0,16);
1.1       albertel  336:             $middlename=~s/\W//g;
                    337:             my $dfilename=
1.305     www       338:       "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
                    339:             $dumpcount++;
1.1       albertel  340:             {
1.448     albertel  341: 		my $dfh;
                    342: 		if (open($dfh,">$dfilename")) {
                    343: 		    print $dfh "$cmd\n"; 
                    344: 		    close($dfh);
                    345: 		}
1.1       albertel  346:             }
                    347:             sleep 2;
                    348:             my $wcmd='';
                    349:             {
1.448     albertel  350: 		my $dfh;
                    351: 		if (open($dfh,"<$dfilename")) {
                    352: 		    $wcmd=<$dfh>; 
                    353: 		    close($dfh);
                    354: 		}
1.1       albertel  355:             }
                    356:             chomp($wcmd);
1.7       www       357:             if ($wcmd eq $cmd) {
1.672     albertel  358: 		&logthis("<font color=\"blue\">WARNING: ".
1.12      www       359:                          "Connection buffer $dfilename: $cmd</font>");
1.1       albertel  360:                 &logperm("D:$server:$cmd");
                    361: 	        return 'con_delayed';
                    362:             } else {
1.672     albertel  363:                 &logthis("<font color=\"red\">CRITICAL:"
1.12      www       364:                         ." Critical connection failed: $server $cmd</font>");
1.1       albertel  365:                 &logperm("F:$server:$cmd");
                    366:                 return 'con_failed';
                    367:             }
                    368:         }
                    369:     }
                    370:     return $answer;
1.405     albertel  371: }
                    372: 
1.755     albertel  373: # ------------------------------------------- check if return value is an error
                    374: 
                    375: sub error {
                    376:     my ($result) = @_;
1.756     albertel  377:     if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755     albertel  378: 	if ($2 == 2) { return undef; }
                    379: 	return $1;
                    380:     }
                    381:     return undef;
                    382: }
                    383: 
1.783     albertel  384: sub convert_and_load_session_env {
                    385:     my ($lonidsdir,$handle)=@_;
                    386:     my @profile;
                    387:     {
1.917     albertel  388: 	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    389: 	if (!$opened) {
1.915     albertel  390: 	    return 0;
                    391: 	}
1.783     albertel  392: 	flock($idf,LOCK_SH);
                    393: 	@profile=<$idf>;
                    394: 	close($idf);
                    395:     }
                    396:     my %temp_env;
                    397:     foreach my $line (@profile) {
1.786     albertel  398: 	if ($line !~ m/=/) {
                    399: 	    return 0;
                    400: 	}
1.783     albertel  401: 	chomp($line);
                    402: 	my ($envname,$envvalue)=split(/=/,$line,2);
                    403: 	$temp_env{&unescape($envname)} = &unescape($envvalue);
                    404:     }
                    405:     unlink("$lonidsdir/$handle.id");
                    406:     if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
                    407: 	    0640)) {
                    408: 	%disk_env = %temp_env;
                    409: 	@env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
                    410: 	untie(%disk_env);
                    411:     }
1.786     albertel  412:     return 1;
1.783     albertel  413: }
                    414: 
1.374     www       415: # ------------------------------------------- Transfer profile into environment
1.780     albertel  416: my $env_loaded;
                    417: sub transfer_profile_to_env {
1.788     albertel  418:     my ($lonidsdir,$handle,$force_transfer) = @_;
                    419:     if (!$force_transfer && $env_loaded) { return; } 
1.374     www       420: 
1.720     albertel  421:     if (!defined($lonidsdir)) {
                    422: 	$lonidsdir = $perlvar{'lonIDsDir'};
                    423:     }
                    424:     if (!defined($handle)) {
                    425:         ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
                    426:     }
                    427: 
1.786     albertel  428:     my $convert;
                    429:     {
1.917     albertel  430:     	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    431: 	if (!$opened) {
1.915     albertel  432: 	    return;
                    433: 	}
1.786     albertel  434: 	flock($idf,LOCK_SH);
                    435: 	if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    436: 		&GDBM_READER(),0640)) {
                    437: 	    @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
                    438: 	    untie(%disk_env);
                    439: 	} else {
                    440: 	    $convert = 1;
                    441: 	}
                    442:     }
                    443:     if ($convert) {
                    444: 	if (!&convert_and_load_session_env($lonidsdir,$handle)) {
                    445: 	    &logthis("Failed to load session, or convert session.");
                    446: 	}
1.374     www       447:     }
1.783     albertel  448: 
1.786     albertel  449:     my %remove;
1.783     albertel  450:     while ( my $envname = each(%env) ) {
1.433     matthew   451:         if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
                    452:             if ($time < time-300) {
1.783     albertel  453:                 $remove{$key}++;
1.433     matthew   454:             }
                    455:         }
                    456:     }
1.783     albertel  457: 
1.619     albertel  458:     $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780     albertel  459:     $env_loaded=1;
1.783     albertel  460:     foreach my $expired_key (keys(%remove)) {
1.433     matthew   461:         &delenv($expired_key);
1.374     www       462:     }
1.1       albertel  463: }
                    464: 
1.916     albertel  465: # ---------------------------------------------------- Check for valid session 
                    466: sub check_for_valid_session {
                    467:     my ($r) = @_;
                    468:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
                    469:     my $lonid=$cookies{'lonID'};
                    470:     return undef if (!$lonid);
                    471: 
                    472:     my $handle=&LONCAPA::clean_handle($lonid->value);
                    473:     my $lonidsdir=$r->dir_config('lonIDsDir');
                    474:     return undef if (!-e "$lonidsdir/$handle.id");
                    475: 
1.917     albertel  476:     my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    477:     return undef if (!$opened);
1.916     albertel  478: 
                    479:     flock($idf,LOCK_SH);
                    480:     my %disk_env;
                    481:     if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    482: 	    &GDBM_READER(),0640)) {
                    483: 	return undef;	
                    484:     }
                    485: 
                    486:     if (!defined($disk_env{'user.name'})
                    487: 	|| !defined($disk_env{'user.domain'})) {
                    488: 	return undef;
                    489:     }
                    490:     return $handle;
                    491: }
                    492: 
1.830     albertel  493: sub timed_flock {
                    494:     my ($file,$lock_type) = @_;
                    495:     my $failed=0;
                    496:     eval {
                    497: 	local $SIG{__DIE__}='DEFAULT';
                    498: 	local $SIG{ALRM}=sub {
                    499: 	    $failed=1;
                    500: 	    die("failed lock");
                    501: 	};
                    502: 	alarm(13);
                    503: 	flock($file,$lock_type);
                    504: 	alarm(0);
                    505:     };
                    506:     if ($failed) {
                    507: 	return undef;
                    508:     } else {
                    509: 	return 1;
                    510:     }
                    511: }
                    512: 
1.5       www       513: # ---------------------------------------------------------- Append Environment
                    514: 
                    515: sub appenv {
1.949     raeburn   516:     my ($newenv,$roles) = @_;
                    517:     if (ref($newenv) eq 'HASH') {
                    518:         foreach my $key (keys(%{$newenv})) {
                    519:             my $refused = 0;
                    520: 	    if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
                    521:                 $refused = 1;
                    522:                 if (ref($roles) eq 'ARRAY') {
                    523:                     my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
                    524:                     if (grep(/^\Q$role\E$/,@{$roles})) {
                    525:                         $refused = 0;
                    526:                     }
                    527:                 }
                    528:             }
                    529:             if ($refused) {
                    530:                 &logthis("<font color=\"blue\">WARNING: ".
                    531:                          "Attempt to modify environment ".$key." to ".$newenv->{$key}
                    532:                          .'</font>');
                    533: 	        delete($newenv->{$key});
                    534:             } else {
                    535:                 $env{$key}=$newenv->{$key};
                    536:             }
                    537:         }
                    538:         my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    539:         if ($opened
                    540: 	    && &timed_flock($env_file,LOCK_EX)
                    541: 	    &&
                    542: 	    tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    543: 	        (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
                    544: 	    while (my ($key,$value) = each(%{$newenv})) {
                    545: 	        $disk_env{$key} = $value;
                    546: 	    }
                    547: 	    untie(%disk_env);
1.35      www       548:         }
1.191     harris41  549:     }
1.56      www       550:     return 'ok';
                    551: }
                    552: # ----------------------------------------------------- Delete from Environment
                    553: 
                    554: sub delenv {
1.987     raeburn   555:     my ($delthis,$regexp) = @_;
1.56      www       556:     if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672     albertel  557:         &logthis("<font color=\"blue\">WARNING: ".
1.56      www       558:                 "Attempt to delete from environment ".$delthis);
                    559:         return 'error';
                    560:     }
1.917     albertel  561:     my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    562:     if ($opened
1.915     albertel  563: 	&& &timed_flock($env_file,LOCK_EX)
1.830     albertel  564: 	&&
                    565: 	tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    566: 	    (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783     albertel  567: 	foreach my $key (keys(%disk_env)) {
1.987     raeburn   568: 	    if ($regexp) {
                    569:                 if ($key=~/^$delthis/) {
                    570:                     delete($env{$key});
                    571:                     delete($disk_env{$key});
                    572:                 } 
                    573:             } else {
                    574:                 if ($key=~/^\Q$delthis\E/) {
                    575: 		    delete($env{$key});
                    576: 		    delete($disk_env{$key});
                    577: 	        }
                    578:             }
1.448     albertel  579: 	}
1.783     albertel  580: 	untie(%disk_env);
1.5       www       581:     }
                    582:     return 'ok';
1.369     albertel  583: }
                    584: 
1.790     albertel  585: sub get_env_multiple {
                    586:     my ($name) = @_;
                    587:     my @values;
                    588:     if (defined($env{$name})) {
                    589:         # exists is it an array
                    590:         if (ref($env{$name})) {
                    591:             @values=@{ $env{$name} };
                    592:         } else {
                    593:             $values[0]=$env{$name};
                    594:         }
                    595:     }
                    596:     return(@values);
                    597: }
                    598: 
1.958     www       599: # ------------------------------------------------------------------- Locking
                    600: 
                    601: sub set_lock {
                    602:     my ($text)=@_;
                    603:     $locknum++;
                    604:     my $id=$$.'-'.$locknum;
                    605:     &appenv({'session.locks' => $env{'session.locks'}.','.$id,
                    606:              'session.lock.'.$id => $text});
                    607:     return $id;
                    608: }
                    609: 
                    610: sub get_locks {
                    611:     my $num=0;
                    612:     my %texts=();
                    613:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    614:        if ($lock=~/\w/) {
                    615:           $num++;
                    616:           $texts{$lock}=$env{'session.lock.'.$lock};
                    617:        }
                    618:    }
                    619:    return ($num,%texts);
                    620: }
                    621: 
                    622: sub remove_lock {
                    623:     my ($id)=@_;
                    624:     my $newlocks='';
                    625:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    626:        if (($lock=~/\w/) && ($lock ne $id)) {
                    627:           $newlocks.=','.$lock;
                    628:        }
                    629:     }
                    630:     &appenv({'session.locks' => $newlocks});
                    631:     &delenv('session.lock.'.$id);
                    632: }
                    633: 
                    634: sub remove_all_locks {
                    635:     my $activelocks=$env{'session.locks'};
                    636:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    637:        if ($lock=~/\w/) {
                    638:           &remove_lock($lock);
                    639:        }
                    640:     }
                    641: }
                    642: 
                    643: 
1.369     albertel  644: # ------------------------------------------ Find out current server userload
                    645: sub userload {
                    646:     my $numusers=0;
                    647:     {
                    648: 	opendir(LONIDS,$perlvar{'lonIDsDir'});
                    649: 	my $filename;
                    650: 	my $curtime=time;
                    651: 	while ($filename=readdir(LONIDS)) {
1.925     albertel  652: 	    next if ($filename eq '.' || $filename eq '..');
                    653: 	    next if ($filename =~ /publicuser_\d+\.id/);
1.404     albertel  654: 	    my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437     albertel  655: 	    if ($curtime-$mtime < 1800) { $numusers++; }
1.369     albertel  656: 	}
                    657: 	closedir(LONIDS);
                    658:     }
                    659:     my $userloadpercent=0;
                    660:     my $maxuserload=$perlvar{'lonUserLoadLim'};
                    661:     if ($maxuserload) {
1.371     albertel  662: 	$userloadpercent=100*$numusers/$maxuserload;
1.369     albertel  663:     }
1.372     albertel  664:     $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369     albertel  665:     return $userloadpercent;
1.283     www       666: }
                    667: 
                    668: # ------------------------------------------ Fight off request when overloaded
                    669: 
                    670: sub overloaderror {
                    671:     my ($r,$checkserver)=@_;
                    672:     unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
                    673:     my $loadavg;
                    674:     if ($checkserver eq $perlvar{'lonHostID'}) {
1.448     albertel  675:        open(my $loadfile,'/proc/loadavg');
1.283     www       676:        $loadavg=<$loadfile>;
                    677:        $loadavg =~ s/\s.*//g;
1.285     matthew   678:        $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448     albertel  679:        close($loadfile);
1.283     www       680:     } else {
                    681:        $loadavg=&reply('load',$checkserver);
                    682:     }
1.285     matthew   683:     my $overload=$loadavg-100;
1.283     www       684:     if ($overload>0) {
1.285     matthew   685: 	$r->err_headers_out->{'Retry-After'}=$overload;
1.283     www       686:         $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554     www       687:         return 413;
1.283     www       688:     }    
                    689:     return '';
1.5       www       690: }
1.1       albertel  691: 
                    692: # ------------------------------ Find server with least workload from spare.tab
1.11      www       693: 
1.1       albertel  694: sub spareserver {
1.670     albertel  695:     my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784     albertel  696:     my $spare_server;
1.370     albertel  697:     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784     albertel  698:     my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 
                    699:                                                      :  $userloadpercent;
                    700:     
                    701:     foreach my $try_server (@{ $spareid{'primary'} }) {
                    702: 	($spare_server, $lowest_load) =
                    703: 	    &compare_server_load($try_server, $spare_server, $lowest_load);
                    704:     }
                    705: 
                    706:     my $found_server = ($spare_server ne '' && $lowest_load < 100);
                    707: 
                    708:     if (!$found_server) {
                    709: 	foreach my $try_server (@{ $spareid{'default'} }) {
                    710: 	    ($spare_server, $lowest_load) =
                    711: 		&compare_server_load($try_server, $spare_server, $lowest_load);
                    712: 	}
                    713:     }
                    714: 
                    715:     if (!$want_server_name) {
1.968     raeburn   716:         my $protocol = 'http';
                    717:         if ($protocol{$spare_server} eq 'https') {
                    718:             $protocol = $protocol{$spare_server};
                    719:         }
1.1001    raeburn   720:         if (defined($spare_server)) {
                    721:             my $hostname = &hostname($spare_server);
                    722:             if (defined($hostname)) {  
                    723: 	        $spare_server = $protocol.'://'.$hostname;
                    724:             }
                    725:         }
1.784     albertel  726:     }
                    727:     return $spare_server;
                    728: }
                    729: 
                    730: sub compare_server_load {
                    731:     my ($try_server, $spare_server, $lowest_load) = @_;
                    732: 
                    733:     my $loadans     = &reply('load',    $try_server);
                    734:     my $userloadans = &reply('userload',$try_server);
                    735: 
                    736:     if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
                    737: 	next; #didn't get a number from the server
                    738:     }
                    739: 
                    740:     my $load;
                    741:     if ($loadans =~ /\d/) {
                    742: 	if ($userloadans =~ /\d/) {
                    743: 	    #both are numbers, pick the bigger one
                    744: 	    $load = ($loadans > $userloadans) ? $loadans 
                    745: 		                              : $userloadans;
1.411     albertel  746: 	} else {
1.784     albertel  747: 	    $load = $loadans;
1.411     albertel  748: 	}
1.784     albertel  749:     } else {
                    750: 	$load = $userloadans;
                    751:     }
                    752: 
                    753:     if (($load =~ /\d/) && ($load < $lowest_load)) {
                    754: 	$spare_server = $try_server;
                    755: 	$lowest_load  = $load;
1.370     albertel  756:     }
1.784     albertel  757:     return ($spare_server,$lowest_load);
1.202     matthew   758: }
1.914     albertel  759: 
                    760: # --------------------------- ask offload servers if user already has a session
                    761: sub find_existing_session {
                    762:     my ($udom,$uname) = @_;
                    763:     foreach my $try_server (@{ $spareid{'primary'} },
                    764: 			    @{ $spareid{'default'} }) {
                    765: 	return $try_server if (&has_user_session($try_server, $udom, $uname));
                    766:     }
                    767:     return;
                    768: }
                    769: 
                    770: # -------------------------------- ask if server already has a session for user
                    771: sub has_user_session {
                    772:     my ($lonid,$udom,$uname) = @_;
                    773:     my $result = &reply(join(':','userhassession',
                    774: 			     map {&escape($_)} ($udom,$uname)),$lonid);
                    775:     return 1 if ($result eq 'ok');
                    776: 
                    777:     return 0;
                    778: }
                    779: 
1.202     matthew   780: # --------------------------------------------- Try to change a user's password
                    781: 
                    782: sub changepass {
1.799     raeburn   783:     my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202     matthew   784:     $currentpass = &escape($currentpass);
                    785:     $newpass     = &escape($newpass);
1.1030    raeburn   786:     my $lonhost = $perlvar{'lonHostID'};
                    787:     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202     matthew   788: 		       $server);
                    789:     if (! $answer) {
                    790: 	&logthis("No reply on password change request to $server ".
                    791: 		 "by $uname in domain $udom.");
                    792:     } elsif ($answer =~ "^ok") {
                    793:         &logthis("$uname in $udom successfully changed their password ".
                    794: 		 "on $server.");
                    795:     } elsif ($answer =~ "^pwchange_failure") {
                    796: 	&logthis("$uname in $udom was unable to change their password ".
                    797: 		 "on $server.  The action was blocked by either lcpasswd ".
                    798: 		 "or pwchange");
                    799:     } elsif ($answer =~ "^non_authorized") {
                    800:         &logthis("$uname in $udom did not get their password correct when ".
                    801: 		 "attempting to change it on $server.");
                    802:     } elsif ($answer =~ "^auth_mode_error") {
                    803:         &logthis("$uname in $udom attempted to change their password despite ".
                    804: 		 "not being locally or internally authenticated on $server.");
                    805:     } elsif ($answer =~ "^unknown_user") {
                    806:         &logthis("$uname in $udom attempted to change their password ".
                    807: 		 "on $server but were unable to because $server is not ".
                    808: 		 "their home server.");
                    809:     } elsif ($answer =~ "^refused") {
                    810: 	&logthis("$server refused to change $uname in $udom password because ".
                    811: 		 "it was sent an unencrypted request to change the password.");
1.1030    raeburn   812:     } elsif ($answer =~ "invalid_client") {
                    813:         &logthis("$server refused to change $uname in $udom password because ".
                    814:                  "it was a reset by e-mail originating from an invalid server.");
1.202     matthew   815:     }
                    816:     return $answer;
1.1       albertel  817: }
                    818: 
1.169     harris41  819: # ----------------------- Try to determine user's current authentication scheme
                    820: 
                    821: sub queryauthenticate {
                    822:     my ($uname,$udom)=@_;
1.456     albertel  823:     my $uhome=&homeserver($uname,$udom);
                    824:     if (!$uhome) {
                    825: 	&logthis("User $uname at $udom is unknown when looking for authentication mechanism");
                    826: 	return 'no_host';
                    827:     }
                    828:     my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
                    829:     if ($answer =~ /^(unknown_user|refused|con_lost)/) {
                    830: 	&logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169     harris41  831:     }
1.456     albertel  832:     return $answer;
1.169     harris41  833: }
                    834: 
1.1       albertel  835: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11      www       836: 
1.1       albertel  837: sub authenticate {
1.952     raeburn   838:     my ($uname,$upass,$udom,$checkdefauth)=@_;
1.807     albertel  839:     $upass=&escape($upass);
                    840:     $uname= &LONCAPA::clean_username($uname);
1.836     www       841:     my $uhome=&homeserver($uname,$udom,1);
1.952     raeburn   842:     my $newhome;
1.836     www       843:     if ((!$uhome) || ($uhome eq 'no_host')) {
                    844: # Maybe the machine was offline and only re-appeared again recently?
                    845:         &reconlonc();
                    846: # One more
1.952     raeburn   847: 	$uhome=&homeserver($uname,$udom,1);
                    848:         if (($uhome eq 'no_host') && $checkdefauth) {
                    849:             if (defined(&domain($udom,'primary'))) {
                    850:                 $newhome=&domain($udom,'primary');
                    851:             }
                    852:             if ($newhome ne '') {
                    853:                 $uhome = $newhome;
                    854:             }
                    855:         }
1.836     www       856: 	if ((!$uhome) || ($uhome eq 'no_host')) {
                    857: 	    &logthis("User $uname at $udom is unknown in authenticate");
1.952     raeburn   858: 	    return 'no_host';
                    859:         }
1.1       albertel  860:     }
1.952     raeburn   861:     my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
1.471     albertel  862:     if ($answer eq 'authorized') {
1.952     raeburn   863:         if ($newhome) {
                    864:             &logthis("User $uname at $udom authorized by $uhome, but needs account");
                    865:             return 'no_account_on_host'; 
                    866:         } else {
                    867:             &logthis("User $uname at $udom authorized by $uhome");
                    868:             return $uhome;
                    869:         }
1.471     albertel  870:     }
                    871:     if ($answer eq 'non_authorized') {
                    872: 	&logthis("User $uname at $udom rejected by $uhome");
                    873: 	return 'no_host'; 
1.9       www       874:     }
1.471     albertel  875:     &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1       albertel  876:     return 'no_host';
                    877: }
                    878: 
                    879: # ---------------------- Find the homebase for a user from domain's lib servers
1.11      www       880: 
1.599     albertel  881: my %homecache;
1.1       albertel  882: sub homeserver {
1.230     stredwic  883:     my ($uname,$udom,$ignoreBadCache)=@_;
1.1       albertel  884:     my $index="$uname:$udom";
1.426     albertel  885: 
1.599     albertel  886:     if (exists($homecache{$index})) { return $homecache{$index}; }
1.841     albertel  887: 
                    888:     my %servers = &get_servers($udom,'library');
                    889:     foreach my $tryserver (keys(%servers)) {
1.230     stredwic  890:         next if ($ignoreBadCache ne 'true' && 
1.231     stredwic  891: 		 exists($badServerCache{$tryserver}));
1.841     albertel  892: 
                    893: 	my $answer=reply("home:$udom:$uname",$tryserver);
                    894: 	if ($answer eq 'found') {
                    895: 	    delete($badServerCache{$tryserver}); 
                    896: 	    return $homecache{$index}=$tryserver;
                    897: 	} elsif ($answer eq 'no_host') {
                    898: 	    $badServerCache{$tryserver}=1;
                    899: 	}
1.1       albertel  900:     }    
                    901:     return 'no_host';
1.70      www       902: }
                    903: 
                    904: # ------------------------------------- Find the usernames behind a list of IDs
                    905: 
                    906: sub idget {
                    907:     my ($udom,@ids)=@_;
                    908:     my %returnhash=();
                    909:     
1.841     albertel  910:     my %servers = &get_servers($udom,'library');
                    911:     foreach my $tryserver (keys(%servers)) {
                    912: 	my $idlist=join('&',@ids);
                    913: 	$idlist=~tr/A-Z/a-z/; 
                    914: 	my $reply=&reply("idget:$udom:".$idlist,$tryserver);
                    915: 	my @answer=();
                    916: 	if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
                    917: 	    @answer=split(/\&/,$reply);
                    918: 	}                    ;
                    919: 	my $i;
                    920: 	for ($i=0;$i<=$#ids;$i++) {
                    921: 	    if ($answer[$i]) {
                    922: 		$returnhash{$ids[$i]}=$answer[$i];
                    923: 	    } 
                    924: 	}
                    925:     } 
1.70      www       926:     return %returnhash;
                    927: }
                    928: 
                    929: # ------------------------------------- Find the IDs behind a list of usernames
                    930: 
                    931: sub idrget {
                    932:     my ($udom,@unames)=@_;
                    933:     my %returnhash=();
1.800     albertel  934:     foreach my $uname (@unames) {
                    935:         $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191     harris41  936:     }
1.70      www       937:     return %returnhash;
                    938: }
                    939: 
                    940: # ------------------------------- Store away a list of names and associated IDs
                    941: 
                    942: sub idput {
                    943:     my ($udom,%ids)=@_;
                    944:     my %servers=();
1.800     albertel  945:     foreach my $uname (keys(%ids)) {
                    946: 	&cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
                    947:         my $uhom=&homeserver($uname,$udom);
1.70      www       948:         if ($uhom ne 'no_host') {
1.800     albertel  949:             my $id=&escape($ids{$uname});
1.70      www       950:             $id=~tr/A-Z/a-z/;
1.800     albertel  951:             my $esc_unam=&escape($uname);
1.70      www       952: 	    if ($servers{$uhom}) {
1.800     albertel  953: 		$servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70      www       954:             } else {
1.800     albertel  955:                 $servers{$uhom}=$id.'='.$esc_unam;
1.70      www       956:             }
                    957:         }
1.191     harris41  958:     }
1.800     albertel  959:     foreach my $server (keys(%servers)) {
                    960:         &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191     harris41  961:     }
1.344     www       962: }
                    963: 
1.1023    raeburn   964: # ------------------------------dump from db file owned by domainconfig user
1.1012    raeburn   965: sub dump_dom {
1.1023    raeburn   966:     my ($namespace,$udom,$regexp,$range)=@_;
1.1012    raeburn   967:     if (!$udom) {
                    968:         $udom=$env{'user.domain'};
                    969:     }
                    970:     my %returnhash;
1.1023    raeburn   971:     if ($udom) {
                    972:         my $uname = &get_domainconfiguser($udom);
                    973:         %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1.1012    raeburn   974:     }
                    975:     return %returnhash;
                    976: }
                    977: 
1.1023    raeburn   978: # ------------------------------------------ get items from domain db files   
1.806     raeburn   979: 
                    980: sub get_dom {
1.860     raeburn   981:     my ($namespace,$storearr,$udom,$uhome)=@_;
1.806     raeburn   982:     my $items='';
                    983:     foreach my $item (@$storearr) {
                    984:         $items.=&escape($item).'&';
                    985:     }
                    986:     $items=~s/\&$//;
1.860     raeburn   987:     if (!$udom) {
                    988:         $udom=$env{'user.domain'};
                    989:         if (defined(&domain($udom,'primary'))) {
                    990:             $uhome=&domain($udom,'primary');
                    991:         } else {
1.874     albertel  992:             undef($uhome);
1.860     raeburn   993:         }
                    994:     } else {
                    995:         if (!$uhome) {
                    996:             if (defined(&domain($udom,'primary'))) {
                    997:                 $uhome=&domain($udom,'primary');
                    998:             }
                    999:         }
                   1000:     }
                   1001:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806     raeburn  1002:         my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866     raeburn  1003:         my %returnhash;
1.875     albertel 1004:         if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866     raeburn  1005:             return %returnhash;
                   1006:         }
1.806     raeburn  1007:         my @pairs=split(/\&/,$rep);
                   1008:         if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   1009:             return @pairs;
                   1010:         }
                   1011:         my $i=0;
                   1012:         foreach my $item (@$storearr) {
                   1013:             $returnhash{$item}=&thaw_unescape($pairs[$i]);
                   1014:             $i++;
                   1015:         }
                   1016:         return %returnhash;
                   1017:     } else {
1.880     banghart 1018:         &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806     raeburn  1019:     }
                   1020: }
                   1021: 
                   1022: # -------------------------------------------- put items in domain db files 
                   1023: 
                   1024: sub put_dom {
1.860     raeburn  1025:     my ($namespace,$storehash,$udom,$uhome)=@_;
                   1026:     if (!$udom) {
                   1027:         $udom=$env{'user.domain'};
                   1028:         if (defined(&domain($udom,'primary'))) {
                   1029:             $uhome=&domain($udom,'primary');
                   1030:         } else {
1.874     albertel 1031:             undef($uhome);
1.860     raeburn  1032:         }
                   1033:     } else {
                   1034:         if (!$uhome) {
                   1035:             if (defined(&domain($udom,'primary'))) {
                   1036:                 $uhome=&domain($udom,'primary');
                   1037:             }
                   1038:         }
                   1039:     } 
                   1040:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806     raeburn  1041:         my $items='';
                   1042:         foreach my $item (keys(%$storehash)) {
                   1043:             $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
                   1044:         }
                   1045:         $items=~s/\&$//;
                   1046:         return &reply("putdom:$udom:$namespace:$items",$uhome);
                   1047:     } else {
1.860     raeburn  1048:         &logthis("put_dom failed - no homeserver and/or domain");
1.806     raeburn  1049:     }
                   1050: }
                   1051: 
1.1023    raeburn  1052: # --------------------- newput for items in db file owned by domainconfig user
1.1012    raeburn  1053: sub newput_dom {
1.1023    raeburn  1054:     my ($namespace,$storehash,$udom) = @_;
1.1012    raeburn  1055:     my $result;
                   1056:     if (!$udom) {
                   1057:         $udom=$env{'user.domain'};
                   1058:     }
1.1023    raeburn  1059:     if ($udom) {
                   1060:         my $uname = &get_domainconfiguser($udom);
                   1061:         $result = &newput($namespace,$storehash,$udom,$uname);
1.1012    raeburn  1062:     }
                   1063:     return $result;
                   1064: }
                   1065: 
1.1023    raeburn  1066: # --------------------- delete for items in db file owned by domainconfig user
1.1012    raeburn  1067: sub del_dom {
1.1023    raeburn  1068:     my ($namespace,$storearr,$udom)=@_;
1.1012    raeburn  1069:     if (ref($storearr) eq 'ARRAY') {
                   1070:         if (!$udom) {
                   1071:             $udom=$env{'user.domain'};
                   1072:         }
1.1023    raeburn  1073:         if ($udom) {
                   1074:             my $uname = &get_domainconfiguser($udom); 
                   1075:             return &del($namespace,$storearr,$udom,$uname);
1.1012    raeburn  1076:         }
                   1077:     }
                   1078: }
                   1079: 
1.1023    raeburn  1080: # ----------------------------------construct domainconfig user for a domain 
                   1081: sub get_domainconfiguser {
                   1082:     my ($udom) = @_;
                   1083:     return $udom.'-domainconfig';
                   1084: }
                   1085: 
1.837     raeburn  1086: sub retrieve_inst_usertypes {
                   1087:     my ($udom) = @_;
                   1088:     my (%returnhash,@order);
1.989     raeburn  1089:     my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
                   1090:     if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 
                   1091:         (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
                   1092:         %returnhash = %{$domdefs{'inststatustypes'}};
                   1093:         @order = @{$domdefs{'inststatusorder'}};
                   1094:     } else {
                   1095:         if (defined(&domain($udom,'primary'))) {
                   1096:             my $uhome=&domain($udom,'primary');
                   1097:             my $rep=&reply("inst_usertypes:$udom",$uhome);
                   1098:             if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
                   1099:                 &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
                   1100:                 return (\%returnhash,\@order);
                   1101:             }
                   1102:             my ($hashitems,$orderitems) = split(/:/,$rep); 
                   1103:             my @pairs=split(/\&/,$hashitems);
                   1104:             foreach my $item (@pairs) {
                   1105:                 my ($key,$value)=split(/=/,$item,2);
                   1106:                 $key = &unescape($key);
                   1107:                 next if ($key =~ /^error: 2 /);
                   1108:                 $returnhash{$key}=&thaw_unescape($value);
                   1109:             }
                   1110:             my @esc_order = split(/\&/,$orderitems);
                   1111:             foreach my $item (@esc_order) {
                   1112:                 push(@order,&unescape($item));
                   1113:             }
                   1114:         } else {
                   1115:             &logthis("get_dom failed - no primary domain server for $udom");
1.837     raeburn  1116:         }
                   1117:     }
                   1118:     return (\%returnhash,\@order);
                   1119: }
                   1120: 
1.868     raeburn  1121: sub is_domainimage {
                   1122:     my ($url) = @_;
                   1123:     if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
                   1124:         if (&domain($1) ne '') {
                   1125:             return '1';
                   1126:         }
                   1127:     }
                   1128:     return;
                   1129: }
                   1130: 
1.899     raeburn  1131: sub inst_directory_query {
                   1132:     my ($srch) = @_;
                   1133:     my $udom = $srch->{'srchdomain'};
                   1134:     my %results;
                   1135:     my $homeserver = &domain($udom,'primary');
1.909     raeburn  1136:     my $outcome;
1.899     raeburn  1137:     if ($homeserver ne '') {
1.904     albertel 1138: 	my $queryid=&reply("querysend:instdirsearch:".
                   1139: 			   &escape($srch->{'srchby'}).':'.
                   1140: 			   &escape($srch->{'srchterm'}).':'.
                   1141: 			   &escape($srch->{'srchtype'}),$homeserver);
                   1142: 	my $host=&hostname($homeserver);
                   1143: 	if ($queryid !~/^\Q$host\E\_/) {
                   1144: 	    &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
                   1145: 	    return;
                   1146: 	}
                   1147: 	my $response = &get_query_reply($queryid);
                   1148: 	my $maxtries = 5;
                   1149: 	my $tries = 1;
                   1150: 	while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   1151: 	    $response = &get_query_reply($queryid);
                   1152: 	    $tries ++;
                   1153: 	}
                   1154: 
                   1155:         if (!&error($response) && $response ne 'refused') {
1.909     raeburn  1156:             if ($response eq 'unavailable') {
                   1157:                 $outcome = $response;
                   1158:             } else {
                   1159:                 $outcome = 'ok';
                   1160:                 my @matches = split(/\n/,$response);
                   1161:                 foreach my $match (@matches) {
                   1162:                     my ($key,$value) = split(/=/,$match);
                   1163:                     $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
                   1164:                 }
1.899     raeburn  1165:             }
                   1166:         }
                   1167:     }
1.909     raeburn  1168:     return ($outcome,%results);
1.899     raeburn  1169: }
                   1170: 
                   1171: sub usersearch {
                   1172:     my ($srch) = @_;
                   1173:     my $dom = $srch->{'srchdomain'};
                   1174:     my %results;
                   1175:     my %libserv = &all_library();
                   1176:     my $query = 'usersearch';
                   1177:     foreach my $tryserver (keys(%libserv)) {
                   1178:         if (&host_domain($tryserver) eq $dom) {
                   1179:             my $host=&hostname($tryserver);
                   1180:             my $queryid=
1.911     raeburn  1181:                 &reply("querysend:".&escape($query).':'.
                   1182:                        &escape($srch->{'srchby'}).':'.
1.899     raeburn  1183:                        &escape($srch->{'srchtype'}).':'.
                   1184:                        &escape($srch->{'srchterm'}),$tryserver);
                   1185:             if ($queryid !~/^\Q$host\E\_/) {
                   1186:                 &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902     raeburn  1187:                 next;
1.899     raeburn  1188:             }
                   1189:             my $reply = &get_query_reply($queryid);
                   1190:             my $maxtries = 1;
                   1191:             my $tries = 1;
                   1192:             while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   1193:                 $reply = &get_query_reply($queryid);
                   1194:                 $tries ++;
                   1195:             }
                   1196:             if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   1197:                 &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') -  maxtries: '.$maxtries.' tries: '.$tries);
                   1198:             } else {
1.911     raeburn  1199:                 my @matches;
                   1200:                 if ($reply =~ /\n/) {
                   1201:                     @matches = split(/\n/,$reply);
                   1202:                 } else {
                   1203:                     @matches = split(/\&/,$reply);
                   1204:                 }
1.899     raeburn  1205:                 foreach my $match (@matches) {
                   1206:                     my ($uname,$udom,%userhash);
1.911     raeburn  1207:                     foreach my $entry (split(/:/,$match)) {
                   1208:                         my ($key,$value) =
                   1209:                             map {&unescape($_);} split(/=/,$entry);
1.899     raeburn  1210:                         $userhash{$key} = $value;
                   1211:                         if ($key eq 'username') {
                   1212:                             $uname = $value;
                   1213:                         } elsif ($key eq 'domain') {
                   1214:                             $udom = $value;
1.911     raeburn  1215:                         }
1.899     raeburn  1216:                     }
                   1217:                     $results{$uname.':'.$udom} = \%userhash;
                   1218:                 }
                   1219:             }
                   1220:         }
                   1221:     }
                   1222:     return %results;
                   1223: }
                   1224: 
1.912     raeburn  1225: sub get_instuser {
                   1226:     my ($udom,$uname,$id) = @_;
                   1227:     my $homeserver = &domain($udom,'primary');
                   1228:     my ($outcome,%results);
                   1229:     if ($homeserver ne '') {
                   1230:         my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
                   1231:                            &escape($id).':'.&escape($udom),$homeserver);
                   1232:         my $host=&hostname($homeserver);
                   1233:         if ($queryid !~/^\Q$host\E\_/) {
                   1234:             &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
                   1235:             return;
                   1236:         }
                   1237:         my $response = &get_query_reply($queryid);
                   1238:         my $maxtries = 5;
                   1239:         my $tries = 1;
                   1240:         while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   1241:             $response = &get_query_reply($queryid);
                   1242:             $tries ++;
                   1243:         }
                   1244:         if (!&error($response) && $response ne 'refused') {
                   1245:             if ($response eq 'unavailable') {
                   1246:                 $outcome = $response;
                   1247:             } else {
                   1248:                 $outcome = 'ok';
                   1249:                 my @matches = split(/\n/,$response);
                   1250:                 foreach my $match (@matches) {
                   1251:                     my ($key,$value) = split(/=/,$match);
                   1252:                     $results{&unescape($key)} = &thaw_unescape($value);
                   1253:                 }
                   1254:             }
                   1255:         }
                   1256:     }
                   1257:     my %userinfo;
                   1258:     if (ref($results{$uname}) eq 'HASH') {
                   1259:         %userinfo = %{$results{$uname}};
                   1260:     } 
                   1261:     return ($outcome,%userinfo);
                   1262: }
                   1263: 
                   1264: sub inst_rulecheck {
1.923     raeburn  1265:     my ($udom,$uname,$id,$item,$rules) = @_;
1.912     raeburn  1266:     my %returnhash;
                   1267:     if ($udom ne '') {
                   1268:         if (ref($rules) eq 'ARRAY') {
                   1269:             @{$rules} = map {&escape($_);} (@{$rules});
                   1270:             my $rulestr = join(':',@{$rules});
                   1271:             my $homeserver=&domain($udom,'primary');
                   1272:             if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  1273:                 my $response;
                   1274:                 if ($item eq 'username') {                
                   1275:                     $response=&unescape(&reply('instrulecheck:'.&escape($udom).
                   1276:                                               ':'.&escape($uname).':'.$rulestr,
1.912     raeburn  1277:                                               $homeserver));
1.923     raeburn  1278:                 } elsif ($item eq 'id') {
                   1279:                     $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
                   1280:                                               ':'.&escape($id).':'.$rulestr,
                   1281:                                               $homeserver));
1.945     raeburn  1282:                 } elsif ($item eq 'selfcreate') {
                   1283:                     $response=&unescape(&reply('instselfcreatecheck:'.
1.943     raeburn  1284:                                                &escape($udom).':'.&escape($uname).
                   1285:                                               ':'.$rulestr,$homeserver));
1.923     raeburn  1286:                 }
1.912     raeburn  1287:                 if ($response ne 'refused') {
                   1288:                     my @pairs=split(/\&/,$response);
                   1289:                     foreach my $item (@pairs) {
                   1290:                         my ($key,$value)=split(/=/,$item,2);
                   1291:                         $key = &unescape($key);
                   1292:                         next if ($key =~ /^error: 2 /);
                   1293:                         $returnhash{$key}=&thaw_unescape($value);
                   1294:                     }
                   1295:                 }
                   1296:             }
                   1297:         }
                   1298:     }
                   1299:     return %returnhash;
                   1300: }
                   1301: 
                   1302: sub inst_userrules {
1.923     raeburn  1303:     my ($udom,$check) = @_;
1.912     raeburn  1304:     my (%ruleshash,@ruleorder);
                   1305:     if ($udom ne '') {
                   1306:         my $homeserver=&domain($udom,'primary');
                   1307:         if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  1308:             my $response;
                   1309:             if ($check eq 'id') {
                   1310:                 $response=&reply('instidrules:'.&escape($udom),
1.912     raeburn  1311:                                  $homeserver);
1.943     raeburn  1312:             } elsif ($check eq 'email') {
                   1313:                 $response=&reply('instemailrules:'.&escape($udom),
                   1314:                                  $homeserver);
1.923     raeburn  1315:             } else {
                   1316:                 $response=&reply('instuserrules:'.&escape($udom),
                   1317:                                  $homeserver);
                   1318:             }
1.912     raeburn  1319:             if (($response ne 'refused') && ($response ne 'error') && 
1.923     raeburn  1320:                 ($response ne 'unknown_cmd') && 
1.912     raeburn  1321:                 ($response ne 'no_such_host')) {
                   1322:                 my ($hashitems,$orderitems) = split(/:/,$response);
                   1323:                 my @pairs=split(/\&/,$hashitems);
                   1324:                 foreach my $item (@pairs) {
                   1325:                     my ($key,$value)=split(/=/,$item,2);
                   1326:                     $key = &unescape($key);
                   1327:                     next if ($key =~ /^error: 2 /);
                   1328:                     $ruleshash{$key}=&thaw_unescape($value);
                   1329:                 }
                   1330:                 my @esc_order = split(/\&/,$orderitems);
                   1331:                 foreach my $item (@esc_order) {
                   1332:                     push(@ruleorder,&unescape($item));
                   1333:                 }
                   1334:             }
                   1335:         }
                   1336:     }
                   1337:     return (\%ruleshash,\@ruleorder);
                   1338: }
                   1339: 
1.976     raeburn  1340: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943     raeburn  1341: 
                   1342: sub get_domain_defaults {
                   1343:     my ($domain) = @_;
                   1344:     my $cachetime = 60*60*24;
                   1345:     my ($result,$cached)=&is_cached_new('domdefaults',$domain);
                   1346:     if (defined($cached)) {
                   1347:         if (ref($result) eq 'HASH') {
                   1348:             return %{$result};
                   1349:         }
                   1350:     }
                   1351:     my %domdefaults;
                   1352:     my %domconfig =
1.989     raeburn  1353:          &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047    raeburn  1354:                                   'requestcourses','inststatus',
                   1355:                                   'coursedefaults'],$domain);
1.943     raeburn  1356:     if (ref($domconfig{'defaults'}) eq 'HASH') {
                   1357:         $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 
                   1358:         $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
                   1359:         $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982     raeburn  1360:         $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985     raeburn  1361:         $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.943     raeburn  1362:     } else {
                   1363:         $domdefaults{'lang_def'} = &domain($domain,'lang_def');
                   1364:         $domdefaults{'auth_def'} = &domain($domain,'auth_def');
                   1365:         $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
                   1366:     }
1.976     raeburn  1367:     if (ref($domconfig{'quotas'}) eq 'HASH') {
                   1368:         if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
                   1369:             $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
                   1370:         } else {
                   1371:             $domdefaults{'defaultquota'} = $domconfig{'quotas'};
                   1372:         } 
                   1373:         my @usertools = ('aboutme','blog','portfolio');
                   1374:         foreach my $item (@usertools) {
                   1375:             if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
                   1376:                 $domdefaults{$item} = $domconfig{'quotas'}{$item};
                   1377:             }
                   1378:         }
                   1379:     }
1.985     raeburn  1380:     if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006    raeburn  1381:         foreach my $item ('official','unofficial','community') {
1.985     raeburn  1382:             $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
                   1383:         }
                   1384:     }
1.989     raeburn  1385:     if (ref($domconfig{'inststatus'}) eq 'HASH') {
                   1386:         foreach my $item ('inststatustypes','inststatusorder') {
                   1387:             $domdefaults{$item} = $domconfig{'inststatus'}{$item};
                   1388:         }
                   1389:     }
1.1047    raeburn  1390:     if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
                   1391:         foreach my $item ('canuse_pdfforms') {
                   1392:             $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
                   1393:         }
                   1394:     }
1.943     raeburn  1395:     &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
                   1396:                                   $cachetime);
                   1397:     return %domdefaults;
                   1398: }
                   1399: 
1.344     www      1400: # --------------------------------------------------- Assign a key to a student
                   1401: 
                   1402: sub assign_access_key {
1.364     www      1403: #
                   1404: # a valid key looks like uname:udom#comments
                   1405: # comments are being appended
                   1406: #
1.498     www      1407:     my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
                   1408:     $kdom=
1.620     albertel 1409:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498     www      1410:     $knum=
1.620     albertel 1411:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344     www      1412:     $cdom=
1.620     albertel 1413:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      1414:     $cnum=
1.620     albertel 1415:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   1416:     $udom=$env{'user.name'} unless (defined($udom));
                   1417:     $uname=$env{'user.domain'} unless (defined($uname));
1.498     www      1418:     my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364     www      1419:     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479     albertel 1420:         ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 
1.364     www      1421:                                                   # assigned to this person
                   1422:                                                   # - this should not happen,
1.345     www      1423:                                                   # unless something went wrong
                   1424:                                                   # the first time around
                   1425: # ready to assign
1.364     www      1426:         $logentry=$1.'; '.$logentry;
1.496     www      1427:         if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498     www      1428:                                                  $kdom,$knum) eq 'ok') {
1.345     www      1429: # key now belongs to user
1.346     www      1430: 	    my $envkey='key.'.$cdom.'_'.$cnum;
1.345     www      1431:             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949     raeburn  1432:                 &appenv({'environment.'.$envkey => $ckey});
1.345     www      1433:                 return 'ok';
                   1434:             } else {
                   1435:                 return 
                   1436:   'error: Count not permanently assign key, will need to be re-entered later.';
                   1437: 	    }
                   1438:         } else {
                   1439:             return 'error: Could not assign key, try again later.';
                   1440:         }
1.364     www      1441:     } elsif (!$existing{$ckey}) {
1.345     www      1442: # the key does not exist
                   1443: 	return 'error: The key does not exist';
                   1444:     } else {
                   1445: # the key is somebody else's
                   1446: 	return 'error: The key is already in use';
                   1447:     }
1.344     www      1448: }
                   1449: 
1.364     www      1450: # ------------------------------------------ put an additional comment on a key
                   1451: 
                   1452: sub comment_access_key {
                   1453: #
                   1454: # a valid key looks like uname:udom#comments
                   1455: # comments are being appended
                   1456: #
                   1457:     my ($ckey,$cdom,$cnum,$logentry)=@_;
                   1458:     $cdom=
1.620     albertel 1459:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364     www      1460:     $cnum=
1.620     albertel 1461:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364     www      1462:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
                   1463:     if ($existing{$ckey}) {
                   1464:         $existing{$ckey}.='; '.$logentry;
                   1465: # ready to assign
1.367     www      1466:         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364     www      1467:                                                  $cdom,$cnum) eq 'ok') {
                   1468: 	    return 'ok';
                   1469:         } else {
                   1470: 	    return 'error: Count not store comment.';
                   1471:         }
                   1472:     } else {
                   1473: # the key does not exist
                   1474: 	return 'error: The key does not exist';
                   1475:     }
                   1476: }
                   1477: 
1.344     www      1478: # ------------------------------------------------------ Generate a set of keys
                   1479: 
                   1480: sub generate_access_keys {
1.364     www      1481:     my ($number,$cdom,$cnum,$logentry)=@_;
1.344     www      1482:     $cdom=
1.620     albertel 1483:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      1484:     $cnum=
1.620     albertel 1485:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361     www      1486:     unless (&allowed('mky',$cdom)) { return 0; }
1.344     www      1487:     unless (($cdom) && ($cnum)) { return 0; }
                   1488:     if ($number>10000) { return 0; }
                   1489:     sleep(2); # make sure don't get same seed twice
                   1490:     srand(time()^($$+($$<<15))); # from "Programming Perl"
                   1491:     my $total=0;
                   1492:     for (my $i=1;$i<=$number;$i++) {
                   1493:        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
                   1494:                   sprintf("%lx",int(100000*rand)).'-'.
                   1495:                   sprintf("%lx",int(100000*rand));
                   1496:        $newkey=~s/1/g/g; # folks mix up 1 and l
                   1497:        $newkey=~s/0/h/g; # and also 0 and O
                   1498:        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
                   1499:        if ($existing{$newkey}) {
                   1500:            $i--;
                   1501:        } else {
1.364     www      1502: 	  if (&put('accesskeys',
                   1503:               { $newkey => '# generated '.localtime().
1.620     albertel 1504:                            ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364     www      1505:                            '; '.$logentry },
                   1506: 		   $cdom,$cnum) eq 'ok') {
1.344     www      1507:               $total++;
                   1508: 	  }
                   1509:        }
                   1510:     }
1.620     albertel 1511:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344     www      1512:          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
                   1513:     return $total;
                   1514: }
                   1515: 
                   1516: # ------------------------------------------------------- Validate an accesskey
                   1517: 
                   1518: sub validate_access_key {
                   1519:     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
                   1520:     $cdom=
1.620     albertel 1521:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      1522:     $cnum=
1.620     albertel 1523:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   1524:     $udom=$env{'user.domain'} unless (defined($udom));
                   1525:     $uname=$env{'user.name'} unless (defined($uname));
1.345     www      1526:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479     albertel 1527:     return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70      www      1528: }
                   1529: 
                   1530: # ------------------------------------- Find the section of student in a course
1.652     albertel 1531: sub devalidate_getsection_cache {
                   1532:     my ($udom,$unam,$courseid)=@_;
                   1533:     my $hashid="$udom:$unam:$courseid";
                   1534:     &devalidate_cache_new('getsection',$hashid);
                   1535: }
1.298     matthew  1536: 
1.815     albertel 1537: sub courseid_to_courseurl {
                   1538:     my ($courseid) = @_;
                   1539:     #already url style courseid
                   1540:     return $courseid if ($courseid =~ m{^/});
                   1541: 
                   1542:     if (exists($env{'course.'.$courseid.'.num'})) {
                   1543: 	my $cnum = $env{'course.'.$courseid.'.num'};
                   1544: 	my $cdom = $env{'course.'.$courseid.'.domain'};
                   1545: 	return "/$cdom/$cnum";
                   1546:     }
                   1547: 
                   1548:     my %courseinfo=&Apache::lonnet::coursedescription($courseid);
                   1549:     if (exists($courseinfo{'num'})) {
                   1550: 	return "/$courseinfo{'domain'}/$courseinfo{'num'}";
                   1551:     }
                   1552: 
                   1553:     return undef;
                   1554: }
                   1555: 
1.298     matthew  1556: sub getsection {
                   1557:     my ($udom,$unam,$courseid)=@_;
1.599     albertel 1558:     my $cachetime=1800;
1.551     albertel 1559: 
                   1560:     my $hashid="$udom:$unam:$courseid";
1.599     albertel 1561:     my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551     albertel 1562:     if (defined($cached)) { return $result; }
                   1563: 
1.298     matthew  1564:     my %Pending; 
                   1565:     my %Expired;
                   1566:     #
                   1567:     # Each role can either have not started yet (pending), be active, 
                   1568:     #    or have expired.
                   1569:     #
                   1570:     # If there is an active role, we are done.
                   1571:     #
                   1572:     # If there is more than one role which has not started yet, 
                   1573:     #     choose the one which will start sooner
                   1574:     # If there is one role which has not started yet, return it.
                   1575:     #
                   1576:     # If there is more than one expired role, choose the one which ended last.
                   1577:     # If there is a role which has expired, return it.
                   1578:     #
1.815     albertel 1579:     $courseid = &courseid_to_courseurl($courseid);
1.817     raeburn  1580:     my %roleshash = &dump('roles',$udom,$unam,$courseid);
                   1581:     foreach my $key (keys(%roleshash)) {
1.479     albertel 1582:         next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298     matthew  1583:         my $section=$1;
                   1584:         if ($key eq $courseid.'_st') { $section=''; }
1.817     raeburn  1585:         my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298     matthew  1586:         my $now=time;
1.548     albertel 1587:         if (defined($end) && $end && ($now > $end)) {
1.298     matthew  1588:             $Expired{$end}=$section;
                   1589:             next;
                   1590:         }
1.548     albertel 1591:         if (defined($start) && $start && ($now < $start)) {
1.298     matthew  1592:             $Pending{$start}=$section;
                   1593:             next;
                   1594:         }
1.599     albertel 1595:         return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298     matthew  1596:     }
                   1597:     #
                   1598:     # Presumedly there will be few matching roles from the above
                   1599:     # loop and the sorting time will be negligible.
                   1600:     if (scalar(keys(%Pending))) {
                   1601:         my ($time) = sort {$a <=> $b} keys(%Pending);
1.599     albertel 1602:         return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298     matthew  1603:     } 
                   1604:     if (scalar(keys(%Expired))) {
                   1605:         my @sorted = sort {$a <=> $b} keys(%Expired);
                   1606:         my $time = pop(@sorted);
1.599     albertel 1607:         return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298     matthew  1608:     }
1.599     albertel 1609:     return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298     matthew  1610: }
1.70      www      1611: 
1.599     albertel 1612: sub save_cache {
                   1613:     &purge_remembered();
1.722     albertel 1614:     #&Apache::loncommon::validate_page();
1.620     albertel 1615:     undef(%env);
1.780     albertel 1616:     undef($env_loaded);
1.599     albertel 1617: }
1.452     albertel 1618: 
1.599     albertel 1619: my $to_remember=-1;
                   1620: my %remembered;
                   1621: my %accessed;
                   1622: my $kicks=0;
                   1623: my $hits=0;
1.849     albertel 1624: sub make_key {
                   1625:     my ($name,$id) = @_;
1.872     albertel 1626:     if (length($id) > 65 
                   1627: 	&& length(&escape($id)) > 200) {
                   1628: 	$id=length($id).':'.&Digest::MD5::md5_hex($id);
                   1629:     }
1.849     albertel 1630:     return &escape($name.':'.$id);
                   1631: }
                   1632: 
1.599     albertel 1633: sub devalidate_cache_new {
                   1634:     my ($name,$id,$debug) = @_;
                   1635:     if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849     albertel 1636:     $id=&make_key($name,$id);
1.599     albertel 1637:     $memcache->delete($id);
                   1638:     delete($remembered{$id});
                   1639:     delete($accessed{$id});
                   1640: }
                   1641: 
                   1642: sub is_cached_new {
                   1643:     my ($name,$id,$debug) = @_;
1.849     albertel 1644:     $id=&make_key($name,$id);
1.599     albertel 1645:     if (exists($remembered{$id})) {
                   1646: 	if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
                   1647: 	$accessed{$id}=[&gettimeofday()];
                   1648: 	$hits++;
                   1649: 	return ($remembered{$id},1);
                   1650:     }
                   1651:     my $value = $memcache->get($id);
                   1652:     if (!(defined($value))) {
                   1653: 	if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417     albertel 1654: 	return (undef,undef);
1.416     albertel 1655:     }
1.599     albertel 1656:     if ($value eq '__undef__') {
                   1657: 	if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
                   1658: 	$value=undef;
                   1659:     }
                   1660:     &make_room($id,$value,$debug);
                   1661:     if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
                   1662:     return ($value,1);
                   1663: }
                   1664: 
                   1665: sub do_cache_new {
                   1666:     my ($name,$id,$value,$time,$debug) = @_;
1.849     albertel 1667:     $id=&make_key($name,$id);
1.599     albertel 1668:     my $setvalue=$value;
                   1669:     if (!defined($setvalue)) {
                   1670: 	$setvalue='__undef__';
                   1671:     }
1.623     albertel 1672:     if (!defined($time) ) {
                   1673: 	$time=600;
                   1674:     }
1.599     albertel 1675:     if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910     albertel 1676:     my $result = $memcache->set($id,$setvalue,$time);
                   1677:     if (! $result) {
1.872     albertel 1678: 	&logthis("caching of id -> $id  failed");
1.910     albertel 1679: 	$memcache->disconnect_all();
1.872     albertel 1680:     }
1.600     albertel 1681:     # need to make a copy of $value
1.919     albertel 1682:     &make_room($id,$value,$debug);
1.599     albertel 1683:     return $value;
                   1684: }
                   1685: 
                   1686: sub make_room {
                   1687:     my ($id,$value,$debug)=@_;
1.919     albertel 1688: 
                   1689:     $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
                   1690:                                     : $value;
1.599     albertel 1691:     if ($to_remember<0) { return; }
                   1692:     $accessed{$id}=[&gettimeofday()];
                   1693:     if (scalar(keys(%remembered)) <= $to_remember) { return; }
                   1694:     my $to_kick;
                   1695:     my $max_time=0;
                   1696:     foreach my $other (keys(%accessed)) {
                   1697: 	if (&tv_interval($accessed{$other}) > $max_time) {
                   1698: 	    $to_kick=$other;
                   1699: 	    $max_time=&tv_interval($accessed{$other});
                   1700: 	}
                   1701:     }
                   1702:     delete($remembered{$to_kick});
                   1703:     delete($accessed{$to_kick});
                   1704:     $kicks++;
                   1705:     if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541     albertel 1706:     return;
                   1707: }
                   1708: 
1.599     albertel 1709: sub purge_remembered {
1.604     albertel 1710:     #&logthis("Tossing ".scalar(keys(%remembered)));
                   1711:     #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599     albertel 1712:     undef(%remembered);
                   1713:     undef(%accessed);
1.428     albertel 1714: }
1.70      www      1715: # ------------------------------------- Read an entry from a user's environment
                   1716: 
                   1717: sub userenvironment {
                   1718:     my ($udom,$unam,@what)=@_;
1.976     raeburn  1719:     my $items;
                   1720:     foreach my $item (@what) {
                   1721:         $items.=&escape($item).'&';
                   1722:     }
                   1723:     $items=~s/\&$//;
1.70      www      1724:     my %returnhash=();
1.1009    raeburn  1725:     my $uhome = &homeserver($unam,$udom);
                   1726:     unless ($uhome eq 'no_host') {
                   1727:         my @answer=split(/\&/, 
                   1728:             &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048    raeburn  1729:         if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
                   1730:             return %returnhash;
                   1731:         }
1.1009    raeburn  1732:         my $i;
                   1733:         for ($i=0;$i<=$#what;$i++) {
                   1734: 	    $returnhash{$what[$i]}=&unescape($answer[$i]);
                   1735:         }
1.70      www      1736:     }
                   1737:     return %returnhash;
1.1       albertel 1738: }
                   1739: 
1.617     albertel 1740: # ---------------------------------------------------------- Get a studentphoto
                   1741: sub studentphoto {
                   1742:     my ($udom,$unam,$ext) = @_;
                   1743:     my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706     raeburn  1744:     if (defined($env{'request.course.id'})) {
1.708     raeburn  1745:         if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706     raeburn  1746:             if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
                   1747:                 return(&retrievestudentphoto($udom,$unam,$ext)); 
                   1748:             } else {
                   1749:                 my ($result,$perm_reqd)=
1.707     albertel 1750: 		    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  1751:                 if ($result eq 'ok') {
                   1752:                     if (!($perm_reqd eq 'yes')) {
                   1753:                         return(&retrievestudentphoto($udom,$unam,$ext));
                   1754:                     }
                   1755:                 }
                   1756:             }
                   1757:         }
                   1758:     } else {
                   1759:         my ($result,$perm_reqd) = 
1.707     albertel 1760: 	    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  1761:         if ($result eq 'ok') {
                   1762:             if (!($perm_reqd eq 'yes')) {
                   1763:                 return(&retrievestudentphoto($udom,$unam,$ext));
                   1764:             }
                   1765:         }
                   1766:     }
                   1767:     return '/adm/lonKaputt/lonlogo_broken.gif';
                   1768: }
                   1769: 
                   1770: sub retrievestudentphoto {
                   1771:     my ($udom,$unam,$ext,$type) = @_;
                   1772:     my $home=&Apache::lonnet::homeserver($unam,$udom);
                   1773:     my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
                   1774:     if ($ret eq 'ok') {
                   1775:         my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
                   1776:         if ($type eq 'thumbnail') {
                   1777:             $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 
                   1778:         }
                   1779:         my $tokenurl=&Apache::lonnet::tokenwrapper($url);
                   1780:         return $tokenurl;
                   1781:     } else {
                   1782:         if ($type eq 'thumbnail') {
                   1783:             return '/adm/lonKaputt/genericstudent_tn.gif';
                   1784:         } else { 
                   1785:             return '/adm/lonKaputt/lonlogo_broken.gif';
                   1786:         }
1.617     albertel 1787:     }
                   1788: }
                   1789: 
1.263     www      1790: # -------------------------------------------------------------------- New chat
                   1791: 
                   1792: sub chatsend {
1.724     raeburn  1793:     my ($newentry,$anon,$group)=@_;
1.620     albertel 1794:     my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
                   1795:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   1796:     my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263     www      1797:     &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620     albertel 1798: 	   &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724     raeburn  1799: 		   &escape($newentry)).':'.$group,$chome);
1.292     www      1800: }
                   1801: 
                   1802: # ------------------------------------------ Find current version of a resource
                   1803: 
                   1804: sub getversion {
                   1805:     my $fname=&clutter(shift);
                   1806:     unless ($fname=~/^\/res\//) { return -1; }
                   1807:     return &currentversion(&filelocation('',$fname));
                   1808: }
                   1809: 
                   1810: sub currentversion {
                   1811:     my $fname=shift;
1.599     albertel 1812:     my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440     www      1813:     if (defined($cached)) { return $result; }
1.292     www      1814:     my $author=$fname;
                   1815:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   1816:     my ($udom,$uname)=split(/\//,$author);
                   1817:     my $home=homeserver($uname,$udom);
                   1818:     if ($home eq 'no_host') { 
                   1819:         return -1; 
                   1820:     }
                   1821:     my $answer=reply("currentversion:$fname",$home);
                   1822:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   1823: 	return -1;
                   1824:     }
1.599     albertel 1825:     return &do_cache_new('resversion',$fname,$answer,600);
1.263     www      1826: }
                   1827: 
1.1       albertel 1828: # ----------------------------- Subscribe to a resource, return URL if possible
1.11      www      1829: 
1.1       albertel 1830: sub subscribe {
                   1831:     my $fname=shift;
1.761     raeburn  1832:     if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532     albertel 1833:     $fname=~s/[\n\r]//g;
1.1       albertel 1834:     my $author=$fname;
                   1835:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   1836:     my ($udom,$uname)=split(/\//,$author);
                   1837:     my $home=homeserver($uname,$udom);
1.335     albertel 1838:     if ($home eq 'no_host') {
                   1839:         return 'not_found';
1.1       albertel 1840:     }
                   1841:     my $answer=reply("sub:$fname",$home);
1.64      www      1842:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   1843: 	$answer.=' by '.$home;
                   1844:     }
1.1       albertel 1845:     return $answer;
                   1846: }
                   1847:     
1.8       www      1848: # -------------------------------------------------------------- Replicate file
                   1849: 
                   1850: sub repcopy {
                   1851:     my $filename=shift;
1.23      www      1852:     $filename=~s/\/+/\//g;
1.607     raeburn  1853:     if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
                   1854:     if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538     albertel 1855:     if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609     banghart 1856: 	$filename=~m -^/*(uploaded|editupload)/-) { 
1.538     albertel 1857: 	return &repcopy_userfile($filename);
                   1858:     }
1.532     albertel 1859:     $filename=~s/[\n\r]//g;
1.8       www      1860:     my $transname="$filename.in.transfer";
1.828     www      1861: # FIXME: this should flock
1.607     raeburn  1862:     if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8       www      1863:     my $remoteurl=subscribe($filename);
1.64      www      1864:     if ($remoteurl =~ /^con_lost by/) {
                   1865: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  1866:            return 'unavailable';
1.8       www      1867:     } elsif ($remoteurl eq 'not_found') {
1.441     albertel 1868: 	   #&logthis("Subscribe returned not_found: $filename");
1.607     raeburn  1869: 	   return 'not_found';
1.64      www      1870:     } elsif ($remoteurl =~ /^rejected by/) {
                   1871: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  1872:            return 'forbidden';
1.20      www      1873:     } elsif ($remoteurl eq 'directory') {
1.607     raeburn  1874:            return 'ok';
1.8       www      1875:     } else {
1.290     www      1876:         my $author=$filename;
                   1877:         $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   1878:         my ($udom,$uname)=split(/\//,$author);
                   1879:         my $home=homeserver($uname,$udom);
                   1880:         unless ($home eq $perlvar{'lonHostID'}) {
1.8       www      1881:            my @parts=split(/\//,$filename);
                   1882:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
                   1883:            if ($path ne "$perlvar{'lonDocRoot'}/res") {
                   1884:                &logthis("Malconfiguration for replication: $filename");
1.607     raeburn  1885: 	       return 'bad_request';
1.8       www      1886:            }
                   1887:            my $count;
                   1888:            for ($count=5;$count<$#parts;$count++) {
                   1889:                $path.="/$parts[$count]";
                   1890:                if ((-e $path)!=1) {
                   1891: 		   mkdir($path,0777);
                   1892:                }
                   1893:            }
                   1894:            my $ua=new LWP::UserAgent;
                   1895:            my $request=new HTTP::Request('GET',"$remoteurl");
                   1896:            my $response=$ua->request($request,$transname);
                   1897:            if ($response->is_error()) {
                   1898: 	       unlink($transname);
                   1899:                my $message=$response->status_line;
1.672     albertel 1900:                &logthis("<font color=\"blue\">WARNING:"
1.12      www      1901:                        ." LWP get: $message: $filename</font>");
1.607     raeburn  1902:                return 'unavailable';
1.8       www      1903:            } else {
1.16      www      1904: 	       if ($remoteurl!~/\.meta$/) {
                   1905:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
                   1906:                   my $mresponse=$ua->request($mrequest,$filename.'.meta');
                   1907:                   if ($mresponse->is_error()) {
                   1908: 		      unlink($filename.'.meta');
                   1909:                       &logthis(
1.672     albertel 1910:                      "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16      www      1911:                   }
                   1912: 	       }
1.8       www      1913:                rename($transname,$filename);
1.607     raeburn  1914:                return 'ok';
1.8       www      1915:            }
1.290     www      1916:        }
1.8       www      1917:     }
1.330     www      1918: }
                   1919: 
                   1920: # ------------------------------------------------ Get server side include body
                   1921: sub ssi_body {
1.381     albertel 1922:     my ($filelink,%form)=@_;
1.606     matthew  1923:     if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
                   1924:         $form{'LONCAPA_INTERNAL_no_discussion'}='true';
                   1925:     }
1.953     www      1926:     my $output='';
                   1927:     my $response;
1.980     raeburn  1928:     if ($filelink=~/^https?\:/) {
1.954     raeburn  1929:        ($output,$response)=&externalssi($filelink);
1.953     www      1930:     } else {
1.1004    droeschl 1931:        $filelink .= $filelink=~/\?/ ? '&' : '?';
                   1932:        $filelink .= 'inhibitmenu=yes';
1.953     www      1933:        ($output,$response)=&ssi($filelink,%form);
                   1934:     }
1.778     albertel 1935:     $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451     albertel 1936:     $output=~s/^.*?\<body[^\>]*\>//si;
1.930     albertel 1937:     $output=~s/\<\/body\s*\>.*?$//si;
1.953     www      1938:     if (wantarray) {
                   1939:         return ($output, $response);
                   1940:     } else {
                   1941:         return $output;
                   1942:     }
1.8       www      1943: }
                   1944: 
1.15      www      1945: # --------------------------------------------------------- Server Side Include
                   1946: 
1.782     albertel 1947: sub absolute_url {
                   1948:     my ($host_name) = @_;
                   1949:     my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
                   1950:     if ($host_name eq '') {
                   1951: 	$host_name = $ENV{'SERVER_NAME'};
                   1952:     }
                   1953:     return $protocol.$host_name;
                   1954: }
                   1955: 
1.942     foxr     1956: #
                   1957: #   Server side include.
                   1958: # Parameters:
                   1959: #  fn     Possibly encrypted resource name/id.
                   1960: #  form   Hash that describes how the rendering should be done
                   1961: #         and other things.
1.944     foxr     1962: # Returns:
1.950     raeburn  1963: #   Scalar context: The content of the response.
                   1964: #   Array context:  2 element list of the content and the full response object.
1.942     foxr     1965: #     
1.15      www      1966: sub ssi {
                   1967: 
1.944     foxr     1968:     my ($fn,%form)=@_;
1.15      www      1969:     my $ua=new LWP::UserAgent;
1.23      www      1970:     my $request;
1.711     albertel 1971: 
                   1972:     $form{'no_update_last_known'}=1;
1.895     albertel 1973:     &Apache::lonenc::check_encrypt(\$fn);
1.23      www      1974:     if (%form) {
1.782     albertel 1975:       $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000    raeburn  1976:       $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23      www      1977:     } else {
1.782     albertel 1978:       $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23      www      1979:     }
                   1980: 
1.15      www      1981:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
                   1982:     my $response=$ua->request($request);
                   1983: 
1.944     foxr     1984:     if (wantarray) {
                   1985: 	return ($response->content, $response);
                   1986:     } else {
                   1987: 	return $response->content;
1.942     foxr     1988:     }
1.324     www      1989: }
                   1990: 
                   1991: sub externalssi {
                   1992:     my ($url)=@_;
                   1993:     my $ua=new LWP::UserAgent;
                   1994:     my $request=new HTTP::Request('GET',$url);
                   1995:     my $response=$ua->request($request);
1.954     raeburn  1996:     if (wantarray) {
                   1997:         return ($response->content, $response);
                   1998:     } else {
                   1999:         return $response->content;
                   2000:     }
1.15      www      2001: }
1.254     www      2002: 
1.492     albertel 2003: # -------------------------------- Allow a /uploaded/ URI to be vouched for
                   2004: 
                   2005: sub allowuploaded {
                   2006:     my ($srcurl,$url)=@_;
                   2007:     $url=&clutter(&declutter($url));
                   2008:     my $dir=$url;
                   2009:     $dir=~s/\/[^\/]+$//;
                   2010:     my %httpref=();
                   2011:     my $httpurl=&hreflocation('',$url);
                   2012:     $httpref{'httpref.'.$httpurl}=$srcurl;
1.949     raeburn  2013:     &Apache::lonnet::appenv(\%httpref);
1.254     www      2014: }
1.477     raeburn  2015: 
1.478     albertel 2016: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638     albertel 2017: # input: action, courseID, current domain, intended
1.637     raeburn  2018: #        path to file, source of file, instruction to parse file for objects,
                   2019: #        ref to hash for embedded objects,
                   2020: #        ref to hash for codebase of java objects.
                   2021: #
1.485     raeburn  2022: # output: url to file (if action was uploaddoc), 
                   2023: #         ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477     raeburn  2024: #
1.478     albertel 2025: # Allows directory structure to be used within lonUsers/../userfiles/ for a 
                   2026: # course.
1.477     raeburn  2027: #
1.478     albertel 2028: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2029: #          will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
                   2030: #          course's home server.
1.477     raeburn  2031: #
1.478     albertel 2032: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
                   2033: #          be copied from $source (current location) to 
                   2034: #          /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2035: #         and will then be copied to
                   2036: #          /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
                   2037: #         course's home server.
1.485     raeburn  2038: #
1.481     raeburn  2039: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620     albertel 2040: #         will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481     raeburn  2041: #         /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2042: #         and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
                   2043: #         in course's home server.
1.637     raeburn  2044: #
1.477     raeburn  2045: 
                   2046: sub process_coursefile {
1.638     albertel 2047:     my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477     raeburn  2048:     my $fetchresult;
1.638     albertel 2049:     my $home=&homeserver($docuname,$docudom);
1.477     raeburn  2050:     if ($action eq 'propagate') {
1.638     albertel 2051:         $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
                   2052: 			     $home);
1.481     raeburn  2053:     } else {
1.477     raeburn  2054:         my $fpath = '';
                   2055:         my $fname = $file;
1.478     albertel 2056:         ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477     raeburn  2057:         $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637     raeburn  2058:         my $filepath = &build_filepath($fpath);
1.481     raeburn  2059:         if ($action eq 'copy') {
                   2060:             if ($source eq '') {
                   2061:                 $fetchresult = 'no source file';
                   2062:                 return $fetchresult;
                   2063:             } else {
                   2064:                 my $destination = $filepath.'/'.$fname;
                   2065:                 rename($source,$destination);
                   2066:                 $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 2067:                                  $home);
1.481     raeburn  2068:             }
                   2069:         } elsif ($action eq 'uploaddoc') {
                   2070:             open(my $fh,'>'.$filepath.'/'.$fname);
1.620     albertel 2071:             print $fh $env{'form.'.$source};
1.481     raeburn  2072:             close($fh);
1.637     raeburn  2073:             if ($parser eq 'parse') {
1.1024    raeburn  2074:                 my $mm = new File::MMagic;
                   2075:                 my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
                   2076:                 if ($mime_type eq 'text/html') {
                   2077:                     my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
                   2078:                     unless ($parse_result eq 'ok') {
                   2079:                         &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
                   2080:                     }
1.637     raeburn  2081:                 }
                   2082:             }
1.477     raeburn  2083:             $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 2084:                                  $home);
1.481     raeburn  2085:             if ($fetchresult eq 'ok') {
                   2086:                 return '/uploaded/'.$fpath.'/'.$fname;
                   2087:             } else {
                   2088:                 &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 2089:                         ' to host '.$home.': '.$fetchresult);
1.481     raeburn  2090:                 return '/adm/notfound.html';
                   2091:             }
1.477     raeburn  2092:         }
                   2093:     }
1.485     raeburn  2094:     unless ( $fetchresult eq 'ok') {
1.477     raeburn  2095:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 2096:              ' to host '.$home.': '.$fetchresult);
1.477     raeburn  2097:     }
                   2098:     return $fetchresult;
                   2099: }
                   2100: 
1.637     raeburn  2101: sub build_filepath {
                   2102:     my ($fpath) = @_;
                   2103:     my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
                   2104:     unless ($fpath eq '') {
                   2105:         my @parts=split('/',$fpath);
                   2106:         foreach my $part (@parts) {
                   2107:             $filepath.= '/'.$part;
                   2108:             if ((-e $filepath)!=1) {
                   2109:                 mkdir($filepath,0777);
                   2110:             }
                   2111:         }
                   2112:     }
                   2113:     return $filepath;
                   2114: }
                   2115: 
                   2116: sub store_edited_file {
1.638     albertel 2117:     my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637     raeburn  2118:     my $file = $primary_url;
                   2119:     $file =~ s#^/uploaded/$docudom/$docuname/##;
                   2120:     my $fpath = '';
                   2121:     my $fname = $file;
                   2122:     ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
                   2123:     $fpath=$docudom.'/'.$docuname.'/'.$fpath;
                   2124:     my $filepath = &build_filepath($fpath);
                   2125:     open(my $fh,'>'.$filepath.'/'.$fname);
                   2126:     print $fh $content;
                   2127:     close($fh);
1.638     albertel 2128:     my $home=&homeserver($docuname,$docudom);
1.637     raeburn  2129:     $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 2130: 			  $home);
1.637     raeburn  2131:     if ($$fetchresult eq 'ok') {
                   2132:         return '/uploaded/'.$fpath.'/'.$fname;
                   2133:     } else {
1.638     albertel 2134:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
                   2135: 		 ' to host '.$home.': '.$$fetchresult);
1.637     raeburn  2136:         return '/adm/notfound.html';
                   2137:     }
                   2138: }
                   2139: 
1.531     albertel 2140: sub clean_filename {
1.831     albertel 2141:     my ($fname,$args)=@_;
1.315     www      2142: # Replace Windows backslashes by forward slashes
1.257     www      2143:     $fname=~s/\\/\//g;
1.831     albertel 2144:     if (!$args->{'keep_path'}) {
                   2145:         # Get rid of everything but the actual filename
                   2146: 	$fname=~s/^.*\/([^\/]+)$/$1/;
                   2147:     }
1.315     www      2148: # Replace spaces by underscores
                   2149:     $fname=~s/\s+/\_/g;
                   2150: # Replace all other weird characters by nothing
1.831     albertel 2151:     $fname=~s{[^/\w\.\-]}{}g;
1.540     albertel 2152: # Replace all .\d. sequences with _\d. so they no longer look like version
                   2153: # numbers
                   2154:     $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531     albertel 2155:     return $fname;
                   2156: }
1.1051    raeburn  2157: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 
                   2158: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 
                   2159: # image with the same aspect ratio as the original, but with dimensions which do 
                   2160: # not exceed $resizewidth and $resizeheight.
                   2161:  
1.984     neumanie 2162: sub resizeImage {
1.1051    raeburn  2163:     my ($img_path,$resizewidth,$resizeheight) = @_;
                   2164:     my $ima = Image::Magick->new;
                   2165:     my $resized;
                   2166:     if (-e $img_path) {
                   2167:         $ima->Read($img_path);
                   2168:         if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
                   2169:             my $width = $ima->Get('width');
                   2170:             my $height = $ima->Get('height');
                   2171:             if ($width > $resizewidth) {
                   2172: 	        my $factor = $width/$resizewidth;
                   2173:                 my $newheight = $height/$factor;
                   2174:                 $ima->Scale(width=>$resizewidth,height=>$newheight);
                   2175:                 $resized = 1;
                   2176:             }
                   2177:         }
                   2178:         if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
                   2179:             my $width = $ima->Get('width');
                   2180:             my $height = $ima->Get('height');
                   2181:             if ($height > $resizeheight) {
                   2182:                 my $factor = $height/$resizeheight;
                   2183:                 my $newwidth = $width/$factor;
                   2184:                 $ima->Scale(width=>$newwidth,height=>$resizeheight);
                   2185:                 $resized = 1;
                   2186:             }
                   2187:         }
                   2188:         if ($resized) {
                   2189:             $ima->Write($img_path);
                   2190:         }
                   2191:     }
                   2192:     return;
1.977     amueller 2193: }
                   2194: 
1.608     albertel 2195: # --------------- Take an uploaded file and put it into the userfiles directory
1.686     albertel 2196: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719     banghart 2197: #                    the desired filenam is in $env{"form.$formname.filename"}
1.686     albertel 2198: #        $coursedoc - if true up to the current course
                   2199: #                     if false
                   2200: #        $subdir - directory in userfile to store the file into
1.858     raeburn  2201: #        $parser - instruction to parse file for objects ($parser = parse)    
                   2202: #        $allfiles - reference to hash for embedded objects
                   2203: #        $codebase - reference to hash for codebase of java objects
                   2204: #        $desuname - username for permanent storage of uploaded file
                   2205: #        $dsetudom - domain for permanaent storage of uploaded file
1.860     raeburn  2206: #        $thumbwidth - width (pixels) of thumbnail to make for uploaded image 
                   2207: #        $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051    raeburn  2208: #        $resizewidth - width (pixels) to which to resize uploaded image
                   2209: #        $resizeheight - height (pixels) to which to resize uploaded image
1.858     raeburn  2210: # 
1.686     albertel 2211: # output: url of file in userspace, or error: <message> 
                   2212: #             or /adm/notfound.html if failure to upload occurse
1.608     albertel 2213: 
1.531     albertel 2214: sub userfileupload {
1.860     raeburn  2215:     my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1051    raeburn  2216:         $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
1.531     albertel 2217:     if (!defined($subdir)) { $subdir='unknown'; }
1.620     albertel 2218:     my $fname=$env{'form.'.$formname.'.filename'};
1.531     albertel 2219:     $fname=&clean_filename($fname);
1.315     www      2220: # See if there is anything left
1.257     www      2221:     unless ($fname) { return 'error: no uploaded file'; }
1.620     albertel 2222:     chop($env{'form.'.$formname});
1.523     raeburn  2223:     if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
                   2224:         my $now = time;
                   2225:         my $filepath = 'tmp/helprequests/'.$now;
                   2226:         my @parts=split(/\//,$filepath);
                   2227:         my $fullpath = $perlvar{'lonDaemons'};
                   2228:         for (my $i=0;$i<@parts;$i++) {
                   2229:             $fullpath .= '/'.$parts[$i];
                   2230:             if ((-e $fullpath)!=1) {
                   2231:                 mkdir($fullpath,0777);
                   2232:             }
                   2233:         }
                   2234:         open(my $fh,'>'.$fullpath.'/'.$fname);
1.620     albertel 2235:         print $fh $env{'form.'.$formname};
1.523     raeburn  2236:         close($fh);
1.741     raeburn  2237:         return $fullpath.'/'.$fname;
                   2238:     } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
                   2239:         my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
                   2240:                        '_'.$env{'user.domain'}.'/pending';
                   2241:         my @parts=split(/\//,$filepath);
                   2242:         my $fullpath = $perlvar{'lonDaemons'};
                   2243:         for (my $i=0;$i<@parts;$i++) {
                   2244:             $fullpath .= '/'.$parts[$i];
                   2245:             if ((-e $fullpath)!=1) {
                   2246:                 mkdir($fullpath,0777);
                   2247:             }
                   2248:         }
                   2249:         open(my $fh,'>'.$fullpath.'/'.$fname);
                   2250:         print $fh $env{'form.'.$formname};
                   2251:         close($fh);
                   2252:         return $fullpath.'/'.$fname;
1.523     raeburn  2253:     }
1.995     raeburn  2254:     if ($subdir eq 'scantron') {
                   2255:         $fname = 'scantron_orig_'.$fname;
                   2256:     } else {   
1.258     www      2257: # Create the directory if not present
1.995     raeburn  2258:         $fname="$subdir/$fname";
                   2259:     }
1.259     www      2260:     if ($coursedoc) {
1.638     albertel 2261: 	my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   2262: 	my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646     raeburn  2263:         if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638     albertel 2264:             return &finishuserfileupload($docuname,$docudom,
                   2265: 					 $formname,$fname,$parser,$allfiles,
1.1051    raeburn  2266: 					 $codebase,$thumbwidth,$thumbheight,
                   2267:                                          $resizewidth,$resizeheight);
1.481     raeburn  2268:         } else {
1.620     albertel 2269:             $fname=$env{'form.folder'}.'/'.$fname;
1.638     albertel 2270:             return &process_coursefile('uploaddoc',$docuname,$docudom,
                   2271: 				       $fname,$formname,$parser,
                   2272: 				       $allfiles,$codebase);
1.481     raeburn  2273:         }
1.719     banghart 2274:     } elsif (defined($destuname)) {
                   2275:         my $docuname=$destuname;
                   2276:         my $docudom=$destudom;
1.860     raeburn  2277: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   2278: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  2279:                                      $thumbwidth,$thumbheight,
                   2280:                                      $resizewidth,$resizeheight);
1.719     banghart 2281:         
1.259     www      2282:     } else {
1.638     albertel 2283:         my $docuname=$env{'user.name'};
                   2284:         my $docudom=$env{'user.domain'};
1.714     raeburn  2285:         if (exists($env{'form.group'})) {
                   2286:             $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   2287:             $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   2288:         }
1.860     raeburn  2289: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   2290: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  2291:                                      $thumbwidth,$thumbheight,
                   2292:                                      $resizewidth,$resizeheight);
1.259     www      2293:     }
1.271     www      2294: }
                   2295: 
                   2296: sub finishuserfileupload {
1.860     raeburn  2297:     my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1051    raeburn  2298:         $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
1.477     raeburn  2299:     my $path=$docudom.'/'.$docuname.'/';
1.258     www      2300:     my $filepath=$perlvar{'lonDocRoot'};
1.984     neumanie 2301:   
1.860     raeburn  2302:     my ($fnamepath,$file,$fetchthumb);
1.494     albertel 2303:     $file=$fname;
                   2304:     if ($fname=~m|/|) {
                   2305:         ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
                   2306: 	$path.=$fnamepath.'/';
                   2307:     }
1.259     www      2308:     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258     www      2309:     my $count;
                   2310:     for ($count=4;$count<=$#parts;$count++) {
                   2311:         $filepath.="/$parts[$count]";
                   2312:         if ((-e $filepath)!=1) {
                   2313: 	    mkdir($filepath,0777);
                   2314:         }
                   2315:     }
1.984     neumanie 2316: 
1.258     www      2317: # Save the file
                   2318:     {
1.701     albertel 2319: 	if (!open(FH,'>'.$filepath.'/'.$file)) {
                   2320: 	    &logthis('Failed to create '.$filepath.'/'.$file);
                   2321: 	    print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
                   2322: 	    return '/adm/notfound.html';
                   2323: 	}
                   2324: 	if (!print FH ($env{'form.'.$formname})) {
                   2325: 	    &logthis('Failed to write to '.$filepath.'/'.$file);
                   2326: 	    print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
                   2327: 	    return '/adm/notfound.html';
                   2328: 	}
1.570     albertel 2329: 	close(FH);
1.1051    raeburn  2330:         if ($resizewidth && $resizeheight) {
                   2331:             my $mm = new File::MMagic;
                   2332:             my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
                   2333:             if ($mime_type =~ m{^image/}) {
                   2334: 	        &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
                   2335:             }  
1.977     amueller 2336: 	}
1.258     www      2337:     }
1.637     raeburn  2338:     if ($parser eq 'parse') {
1.1024    raeburn  2339:         my $mm = new File::MMagic;
                   2340:         my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
                   2341:         if ($mime_type eq 'text/html') {
                   2342:             my $parse_result = &extract_embedded_items($filepath.'/'.$file,
                   2343:                                                        $allfiles,$codebase);
                   2344:             unless ($parse_result eq 'ok') {
                   2345:                 &logthis('Failed to parse '.$filepath.$file.
                   2346: 	   	         ' for embedded media: '.$parse_result); 
                   2347:             }
1.637     raeburn  2348:         }
                   2349:     }
1.860     raeburn  2350:     if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
                   2351:         my $input = $filepath.'/'.$file;
                   2352:         my $output = $filepath.'/'.'tn-'.$file;
                   2353:         my $thumbsize = $thumbwidth.'x'.$thumbheight;
                   2354:         system("convert -sample $thumbsize $input $output");
                   2355:         if (-e $filepath.'/'.'tn-'.$file) {
                   2356:             $fetchthumb  = 1; 
                   2357:         }
                   2358:     }
1.858     raeburn  2359:  
1.259     www      2360: # Notify homeserver to grep it
                   2361: #
1.984     neumanie 2362:     my $docuhome=&homeserver($docuname,$docudom);	
1.494     albertel 2363:     my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295     www      2364:     if ($fetchresult eq 'ok') {
1.860     raeburn  2365:         if ($fetchthumb) {
                   2366:             my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
                   2367:             if ($thumbresult ne 'ok') {
                   2368:                 &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
                   2369:                          $docuhome.': '.$thumbresult);
                   2370:             }
                   2371:         }
1.259     www      2372: #
1.258     www      2373: # Return the URL to it
1.494     albertel 2374:         return '/uploaded/'.$path.$file;
1.263     www      2375:     } else {
1.494     albertel 2376:         &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
                   2377: 		 ': '.$fetchresult);
1.263     www      2378:         return '/adm/notfound.html';
1.858     raeburn  2379:     }
1.493     albertel 2380: }
                   2381: 
1.637     raeburn  2382: sub extract_embedded_items {
1.961     raeburn  2383:     my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637     raeburn  2384:     my @state = ();
                   2385:     my %javafiles = (
                   2386:                       codebase => '',
                   2387:                       code => '',
                   2388:                       archive => ''
                   2389:                     );
                   2390:     my %mediafiles = (
                   2391:                       src => '',
                   2392:                       movie => '',
                   2393:                      );
1.648     raeburn  2394:     my $p;
                   2395:     if ($content) {
                   2396:         $p = HTML::LCParser->new($content);
                   2397:     } else {
1.961     raeburn  2398:         $p = HTML::LCParser->new($fullpath);
1.648     raeburn  2399:     }
1.641     albertel 2400:     while (my $t=$p->get_token()) {
1.640     albertel 2401: 	if ($t->[0] eq 'S') {
                   2402: 	    my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886     albertel 2403: 	    push(@state, $tagname);
1.648     raeburn  2404:             if (lc($tagname) eq 'allow') {
                   2405:                 &add_filetype($allfiles,$attr->{'src'},'src');
                   2406:             }
1.640     albertel 2407: 	    if (lc($tagname) eq 'img') {
                   2408: 		&add_filetype($allfiles,$attr->{'src'},'src');
                   2409: 	    }
1.886     albertel 2410: 	    if (lc($tagname) eq 'a') {
                   2411: 		&add_filetype($allfiles,$attr->{'href'},'href');
                   2412: 	    }
1.645     raeburn  2413:             if (lc($tagname) eq 'script') {
                   2414:                 if ($attr->{'archive'} =~ /\.jar$/i) {
                   2415:                     &add_filetype($allfiles,$attr->{'archive'},'archive');
                   2416:                 } else {
                   2417:                     &add_filetype($allfiles,$attr->{'src'},'src');
                   2418:                 }
                   2419:             }
                   2420:             if (lc($tagname) eq 'link') {
                   2421:                 if (lc($attr->{'rel'}) eq 'stylesheet') { 
                   2422:                     &add_filetype($allfiles,$attr->{'href'},'href');
                   2423:                 }
                   2424:             }
1.640     albertel 2425: 	    if (lc($tagname) eq 'object' ||
                   2426: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
                   2427: 		foreach my $item (keys(%javafiles)) {
                   2428: 		    $javafiles{$item} = '';
                   2429: 		}
                   2430: 	    }
                   2431: 	    if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
                   2432: 		my $name = lc($attr->{'name'});
                   2433: 		foreach my $item (keys(%javafiles)) {
                   2434: 		    if ($name eq $item) {
                   2435: 			$javafiles{$item} = $attr->{'value'};
                   2436: 			last;
                   2437: 		    }
                   2438: 		}
                   2439: 		foreach my $item (keys(%mediafiles)) {
                   2440: 		    if ($name eq $item) {
                   2441: 			&add_filetype($allfiles, $attr->{'value'}, 'value');
                   2442: 			last;
                   2443: 		    }
                   2444: 		}
                   2445: 	    }
                   2446: 	    if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
                   2447: 		foreach my $item (keys(%javafiles)) {
                   2448: 		    if ($attr->{$item}) {
                   2449: 			$javafiles{$item} = $attr->{$item};
                   2450: 			last;
                   2451: 		    }
                   2452: 		}
                   2453: 		foreach my $item (keys(%mediafiles)) {
                   2454: 		    if ($attr->{$item}) {
                   2455: 			&add_filetype($allfiles,$attr->{$item},$item);
                   2456: 			last;
                   2457: 		    }
                   2458: 		}
                   2459: 	    }
                   2460: 	} elsif ($t->[0] eq 'E') {
                   2461: 	    my ($tagname) = ($t->[1]);
                   2462: 	    if ($javafiles{'codebase'} ne '') {
                   2463: 		$javafiles{'codebase'} .= '/';
                   2464: 	    }  
                   2465: 	    if (lc($tagname) eq 'applet' ||
                   2466: 		lc($tagname) eq 'object' ||
                   2467: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
                   2468: 		) {
                   2469: 		foreach my $item (keys(%javafiles)) {
                   2470: 		    if ($item ne 'codebase' && $javafiles{$item} ne '') {
                   2471: 			my $file=$javafiles{'codebase'}.$javafiles{$item};
                   2472: 			&add_filetype($allfiles,$file,$item);
                   2473: 		    }
                   2474: 		}
                   2475: 	    } 
                   2476: 	    pop @state;
                   2477: 	}
                   2478:     }
1.637     raeburn  2479:     return 'ok';
                   2480: }
                   2481: 
1.639     albertel 2482: sub add_filetype {
                   2483:     my ($allfiles,$file,$type)=@_;
                   2484:     if (exists($allfiles->{$file})) {
                   2485: 	unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
                   2486: 	    push(@{$allfiles->{$file}}, &escape($type));
                   2487: 	}
                   2488:     } else {
                   2489: 	@{$allfiles->{$file}} = (&escape($type));
1.637     raeburn  2490:     }
                   2491: }
                   2492: 
1.493     albertel 2493: sub removeuploadedurl {
1.984     neumanie 2494:     my ($url)=@_;	
                   2495:     my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);    
1.613     albertel 2496:     return &removeuserfile($uname,$udom,$fname);
1.490     albertel 2497: }
                   2498: 
                   2499: sub removeuserfile {
                   2500:     my ($docuname,$docudom,$fname)=@_;
1.984     neumanie 2501:     my $home=&homeserver($docuname,$docudom);    
1.798     raeburn  2502:     my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984     neumanie 2503:     if ($result eq 'ok') {	
1.798     raeburn  2504:         if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
                   2505:             my $metafile = $fname.'.meta';
                   2506:             my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 
1.823     albertel 2507: 	    my $url = "/uploaded/$docudom/$docuname/$fname";
1.984     neumanie 2508:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];	   
1.821     raeburn  2509:             my $sqlresult = 
1.823     albertel 2510:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  2511:                                         'portfolio_metadata',$group,
                   2512:                                         'delete');
1.798     raeburn  2513:         }
                   2514:     }
                   2515:     return $result;
1.257     www      2516: }
1.15      www      2517: 
1.530     albertel 2518: sub mkdiruserfile {
                   2519:     my ($docuname,$docudom,$dir)=@_;
                   2520:     my $home=&homeserver($docuname,$docudom);
                   2521:     return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
                   2522: }
                   2523: 
1.531     albertel 2524: sub renameuserfile {
                   2525:     my ($docuname,$docudom,$old,$new)=@_;
                   2526:     my $home=&homeserver($docuname,$docudom);
1.798     raeburn  2527:     my $result = &reply("renameuserfile:$docudom:$docuname:".
                   2528:                         &escape("$old").':'.&escape("$new"),$home);
                   2529:     if ($result eq 'ok') {
                   2530:         if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
                   2531:             my $oldmeta = $old.'.meta';
                   2532:             my $newmeta = $new.'.meta';
                   2533:             my $metaresult = 
                   2534:                 &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823     albertel 2535: 	    my $url = "/uploaded/$docudom/$docuname/$old";
                   2536:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821     raeburn  2537:             my $sqlresult = 
1.823     albertel 2538:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  2539:                                         'portfolio_metadata',$group,
                   2540:                                         'delete');
1.798     raeburn  2541:         }
                   2542:     }
                   2543:     return $result;
1.531     albertel 2544: }
                   2545: 
1.14      www      2546: # ------------------------------------------------------------------------- Log
                   2547: 
                   2548: sub log {
                   2549:     my ($dom,$nam,$hom,$what)=@_;
1.47      www      2550:     return critical("log:$dom:$nam:$what",$hom);
1.157     www      2551: }
                   2552: 
                   2553: # ------------------------------------------------------------------ Course Log
1.352     www      2554: #
                   2555: # This routine flushes several buffers of non-mission-critical nature
                   2556: #
1.157     www      2557: 
                   2558: sub flushcourselogs {
1.352     www      2559:     &logthis('Flushing log buffers');
                   2560: #
                   2561: # course logs
                   2562: # This is a log of all transactions in a course, which can be used
                   2563: # for data mining purposes
                   2564: #
                   2565: # It also collects the courseid database, which lists last transaction
                   2566: # times and course titles for all courseids
                   2567: #
                   2568:     my %courseidbuffer=();
1.921     raeburn  2569:     foreach my $crsid (keys(%courselogs)) {
1.352     www      2570:         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188     www      2571: 		          &escape($courselogs{$crsid}),
                   2572: 		          $coursehombuf{$crsid}) eq 'ok') {
1.157     www      2573: 	    delete $courselogs{$crsid};
                   2574:         } else {
                   2575:             &logthis('Failed to flush log buffer for '.$crsid);
                   2576:             if (length($courselogs{$crsid})>40000) {
1.672     albertel 2577:                &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157     www      2578:                         " exceeded maximum size, deleting.</font>");
                   2579:                delete $courselogs{$crsid};
                   2580:             }
1.352     www      2581:         }
1.920     raeburn  2582:         $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936     raeburn  2583:             'description' => $coursedescrbuf{$crsid},
                   2584:             'inst_code'    => $courseinstcodebuf{$crsid},
                   2585:             'type'        => $coursetypebuf{$crsid},
                   2586:             'owner'       => $courseownerbuf{$crsid},
1.920     raeburn  2587:         };
1.191     harris41 2588:     }
1.352     www      2589: #
                   2590: # Write course id database (reverse lookup) to homeserver of courses 
                   2591: # Is used in pickcourse
                   2592: #
1.840     albertel 2593:     foreach my $crs_home (keys(%courseidbuffer)) {
1.918     raeburn  2594:         my $response = &courseidput(&host_domain($crs_home),
1.921     raeburn  2595:                                     $courseidbuffer{$crs_home},
                   2596:                                     $crs_home,'timeonly');
1.352     www      2597:     }
                   2598: #
                   2599: # File accesses
                   2600: # Writes to the dynamic metadata of resources to get hit counts, etc.
                   2601: #
1.449     matthew  2602:     foreach my $entry (keys(%accesshash)) {
1.458     matthew  2603:         if ($entry =~ /___count$/) {
                   2604:             my ($dom,$name);
1.807     albertel 2605:             ($dom,$name,undef)=
1.811     albertel 2606: 		($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458     matthew  2607:             if (! defined($dom) || $dom eq '' || 
                   2608:                 ! defined($name) || $name eq '') {
1.620     albertel 2609:                 my $cid = $env{'request.course.id'};
                   2610:                 $dom  = $env{'request.'.$cid.'.domain'};
                   2611:                 $name = $env{'request.'.$cid.'.num'};
1.458     matthew  2612:             }
1.450     matthew  2613:             my $value = $accesshash{$entry};
                   2614:             my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
                   2615:             my %temphash=($url => $value);
1.449     matthew  2616:             my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
                   2617:             if ($result eq 'ok') {
                   2618:                 delete $accesshash{$entry};
                   2619:             } elsif ($result eq 'unknown_cmd') {
                   2620:                 # Target server has old code running on it.
1.450     matthew  2621:                 my %temphash=($entry => $value);
1.449     matthew  2622:                 if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
                   2623:                     delete $accesshash{$entry};
                   2624:                 }
                   2625:             }
                   2626:         } else {
1.811     albertel 2627:             my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450     matthew  2628:             my %temphash=($entry => $accesshash{$entry});
1.449     matthew  2629:             if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
                   2630:                 delete $accesshash{$entry};
                   2631:             }
1.185     www      2632:         }
1.191     harris41 2633:     }
1.352     www      2634: #
                   2635: # Roles
                   2636: # Reverse lookup of user roles for course faculty/staff and co-authorship
                   2637: #
1.800     albertel 2638:     foreach my $entry (keys(%userrolehash)) {
1.351     www      2639:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349     www      2640: 	    split(/\:/,$entry);
                   2641:         if (&Apache::lonnet::put('nohist_userroles',
1.351     www      2642:              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349     www      2643:                 $rudom,$runame) eq 'ok') {
                   2644: 	    delete $userrolehash{$entry};
                   2645:         }
                   2646:     }
1.662     raeburn  2647: #
                   2648: # Reverse lookup of domain roles (dc, ad, li, sc, au)
                   2649: #
                   2650:     my %domrolebuffer = ();
1.1000    raeburn  2651:     foreach my $entry (keys(%domainrolehash)) {
1.901     albertel 2652:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662     raeburn  2653:         if ($domrolebuffer{$rudom}) {
                   2654:             $domrolebuffer{$rudom}.='&'.&escape($entry).
                   2655:                       '='.&escape($domainrolehash{$entry});
                   2656:         } else {
                   2657:             $domrolebuffer{$rudom}.=&escape($entry).
                   2658:                       '='.&escape($domainrolehash{$entry});
                   2659:         }
                   2660:         delete $domainrolehash{$entry};
                   2661:     }
                   2662:     foreach my $dom (keys(%domrolebuffer)) {
1.841     albertel 2663: 	my %servers = &get_servers($dom,'library');
                   2664: 	foreach my $tryserver (keys(%servers)) {
                   2665: 	    unless (&reply('domroleput:'.$dom.':'.
                   2666: 			   $domrolebuffer{$dom},$tryserver) eq 'ok') {
                   2667: 		&logthis('Put of domain roles failed for '.$dom.' and  '.$tryserver);
                   2668: 	    }
1.662     raeburn  2669:         }
                   2670:     }
1.186     www      2671:     $dumpcount++;
1.157     www      2672: }
                   2673: 
                   2674: sub courselog {
                   2675:     my $what=shift;
1.158     www      2676:     $what=time.':'.$what;
1.620     albertel 2677:     unless ($env{'request.course.id'}) { return ''; }
                   2678:     $coursedombuf{$env{'request.course.id'}}=
                   2679:        $env{'course.'.$env{'request.course.id'}.'.domain'};
                   2680:     $coursenumbuf{$env{'request.course.id'}}=
                   2681:        $env{'course.'.$env{'request.course.id'}.'.num'};
                   2682:     $coursehombuf{$env{'request.course.id'}}=
                   2683:        $env{'course.'.$env{'request.course.id'}.'.home'};
                   2684:     $coursedescrbuf{$env{'request.course.id'}}=
                   2685:        $env{'course.'.$env{'request.course.id'}.'.description'};
                   2686:     $courseinstcodebuf{$env{'request.course.id'}}=
                   2687:        $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
                   2688:     $courseownerbuf{$env{'request.course.id'}}=
                   2689:        $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741     raeburn  2690:     $coursetypebuf{$env{'request.course.id'}}=
                   2691:        $env{'course.'.$env{'request.course.id'}.'.type'};
1.620     albertel 2692:     if (defined $courselogs{$env{'request.course.id'}}) {
                   2693: 	$courselogs{$env{'request.course.id'}}.='&'.$what;
1.157     www      2694:     } else {
1.620     albertel 2695: 	$courselogs{$env{'request.course.id'}}.=$what;
1.157     www      2696:     }
1.620     albertel 2697:     if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157     www      2698: 	&flushcourselogs();
                   2699:     }
1.158     www      2700: }
                   2701: 
                   2702: sub courseacclog {
                   2703:     my $fnsymb=shift;
1.620     albertel 2704:     unless ($env{'request.course.id'}) { return ''; }
                   2705:     my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657     albertel 2706:     if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187     www      2707:         $what.=':POST';
1.583     matthew  2708:         # FIXME: Probably ought to escape things....
1.800     albertel 2709: 	foreach my $key (keys(%env)) {
                   2710:             if ($key=~/^form\.(.*)/) {
1.975     raeburn  2711:                 my $formitem = $1;
                   2712:                 if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
                   2713:                     $what.=':'.$formitem.'='.$env{$key};
                   2714:                 } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
                   2715:                     $what.=':'.$formitem.'='.$env{$key};
                   2716:                 }
1.158     www      2717:             }
1.191     harris41 2718:         }
1.583     matthew  2719:     } elsif ($fnsymb =~ m:^/adm/searchcat:) {
                   2720:         # FIXME: We should not be depending on a form parameter that someone
                   2721:         # editing lonsearchcat.pm might change in the future.
1.620     albertel 2722:         if ($env{'form.phase'} eq 'course_search') {
1.583     matthew  2723:             $what.= ':POST';
                   2724:             # FIXME: Probably ought to escape things....
                   2725:             foreach my $element ('courseexp','crsfulltext','crsrelated',
                   2726:                                  'crsdiscuss') {
1.620     albertel 2727:                 $what.=':'.$element.'='.$env{'form.'.$element};
1.583     matthew  2728:             }
                   2729:         }
1.158     www      2730:     }
                   2731:     &courselog($what);
1.149     www      2732: }
                   2733: 
1.185     www      2734: sub countacc {
                   2735:     my $url=&declutter(shift);
1.458     matthew  2736:     return if (! defined($url) || $url eq '');
1.620     albertel 2737:     unless ($env{'request.course.id'}) { return ''; }
                   2738:     $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281     www      2739:     my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450     matthew  2740:     $accesshash{$key}++;
1.185     www      2741: }
1.349     www      2742: 
1.361     www      2743: sub linklog {
                   2744:     my ($from,$to)=@_;
                   2745:     $from=&declutter($from);
                   2746:     $to=&declutter($to);
                   2747:     $accesshash{$from.'___'.$to.'___comefrom'}=1;
                   2748:     $accesshash{$to.'___'.$from.'___goto'}=1;
                   2749: }
                   2750:   
1.349     www      2751: sub userrolelog {
                   2752:     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661     raeburn  2753:     if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662     raeburn  2754:         ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661     raeburn  2755:         ($trole=~/^ep/) || ($trole=~/^cr/) ||
1.1041    raeburn  2756:         ($trole=~/^ta/) || ($trole=~/^co/)) {
1.350     www      2757:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   2758:        $userrolehash
                   2759:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349     www      2760:                     =$tend.':'.$tstart;
1.662     raeburn  2761:     }
1.898     albertel 2762:     if (($env{'request.role'} =~ /dc\./) &&
                   2763: 	(($trole=~/^au/) || ($trole=~/^in/) ||
                   2764: 	 ($trole=~/^cc/) || ($trole=~/^ep/) ||
1.1041    raeburn  2765: 	 ($trole=~/^cr/) || ($trole=~/^ta/) ||
                   2766:          ($trole=~/^co/))) {
1.898     albertel 2767:        $userrolehash
                   2768:          {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
                   2769:                     =$tend.':'.$tstart;
                   2770:     }
1.662     raeburn  2771:     if (($trole=~/^dc/) || ($trole=~/^ad/) ||
                   2772:         ($trole=~/^li/) || ($trole=~/^li/) ||
                   2773:         ($trole=~/^au/) || ($trole=~/^dg/) ||
                   2774:         ($trole=~/^sc/)) {
                   2775:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   2776:        $domainrolehash
                   2777:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
                   2778:                     = $tend.':'.$tstart;
                   2779:     }
1.351     www      2780: }
                   2781: 
1.957     raeburn  2782: sub courserolelog {
                   2783:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
                   2784:     if (($trole eq 'cc') || ($trole eq 'in') ||
                   2785:         ($trole eq 'ep') || ($trole eq 'ad') ||
                   2786:         ($trole eq 'ta') || ($trole eq 'st') ||
1.1044    raeburn  2787:         ($trole=~/^cr/) || ($trole eq 'gr') ||
                   2788:         ($trole eq 'co')) {
1.957     raeburn  2789:         if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
                   2790:             my $cdom = $1;
                   2791:             my $cnum = $2;
                   2792:             my $sec = $3;
                   2793:             my $namespace = 'rolelog';
                   2794:             my %storehash = (
                   2795:                                role    => $trole,
                   2796:                                start   => $tstart,
                   2797:                                end     => $tend,
                   2798:                                selfenroll => $selfenroll,
                   2799:                                context    => $context,
                   2800:                             );
                   2801:             if ($trole eq 'gr') {
                   2802:                 $namespace = 'groupslog';
                   2803:                 $storehash{'group'} = $sec;
                   2804:             } else {
                   2805:                 $storehash{'section'} = $sec;
                   2806:             }
                   2807:             &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996     raeburn  2808:             if (($trole ne 'st') || ($sec ne '')) {
                   2809:                 &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
                   2810:             }
1.957     raeburn  2811:         }
                   2812:     }
                   2813:     return;
                   2814: }
                   2815: 
1.351     www      2816: sub get_course_adv_roles {
1.948     raeburn  2817:     my ($cid,$codes) = @_;
1.620     albertel 2818:     $cid=$env{'request.course.id'} unless (defined($cid));
1.351     www      2819:     my %coursehash=&coursedescription($cid);
1.988     raeburn  2820:     my $crstype = &Apache::loncommon::course_type($cid);
1.470     www      2821:     my %nothide=();
1.800     albertel 2822:     foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937     raeburn  2823:         if ($user !~ /:/) {
                   2824: 	    $nothide{join(':',split(/[\@]/,$user))}=1;
                   2825:         } else {
                   2826:             $nothide{$user}=1;
                   2827:         }
1.470     www      2828:     }
1.351     www      2829:     my %returnhash=();
                   2830:     my %dumphash=
                   2831:             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
                   2832:     my $now=time;
1.997     raeburn  2833:     my %privileged;
1.1000    raeburn  2834:     foreach my $entry (keys(%dumphash)) {
1.800     albertel 2835: 	my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351     www      2836:         if (($tstart) && ($tstart<0)) { next; }
                   2837:         if (($tend) && ($tend<$now)) { next; }
                   2838:         if (($tstart) && ($now<$tstart)) { next; }
1.800     albertel 2839:         my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576     albertel 2840: 	if ($username eq '' || $domain eq '') { next; }
1.997     raeburn  2841:         unless (ref($privileged{$domain}) eq 'HASH') {
                   2842:             my %dompersonnel =
1.998     raeburn  2843:                 &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997     raeburn  2844:             $privileged{$domain} = {};
                   2845:             foreach my $server (keys(%dompersonnel)) {
1.999     raeburn  2846:                 if (ref($dompersonnel{$server}) eq 'HASH') {
1.997     raeburn  2847:                     foreach my $user (keys(%{$dompersonnel{$server}})) {
                   2848:                         my ($trole,$uname,$udom) = split(/:/,$user);
                   2849:                         $privileged{$udom}{$uname} = 1;
                   2850:                     }
                   2851:                 }
                   2852:             }
                   2853:         }
                   2854:         if ((exists($privileged{$domain}{$username})) && 
                   2855:             (!$nothide{$username.':'.$domain})) { next; }
1.656     albertel 2856: 	if ($role eq 'cr') { next; }
1.948     raeburn  2857:         if ($codes) {
                   2858:             if ($section) { $role .= ':'.$section; }
                   2859:             if ($returnhash{$role}) {
                   2860:                 $returnhash{$role}.=','.$username.':'.$domain;
                   2861:             } else {
                   2862:                 $returnhash{$role}=$username.':'.$domain;
                   2863:             }
1.351     www      2864:         } else {
1.988     raeburn  2865:             my $key=&plaintext($role,$crstype);
1.973     bisitz   2866:             if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948     raeburn  2867:             if ($returnhash{$key}) {
                   2868: 	        $returnhash{$key}.=','.$username.':'.$domain;
                   2869:             } else {
                   2870:                 $returnhash{$key}=$username.':'.$domain;
                   2871:             }
1.351     www      2872:         }
1.948     raeburn  2873:     }
1.400     www      2874:     return %returnhash;
                   2875: }
                   2876: 
                   2877: sub get_my_roles {
1.937     raeburn  2878:     my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620     albertel 2879:     unless (defined($uname)) { $uname=$env{'user.name'}; }
                   2880:     unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937     raeburn  2881:     my (%dumphash,%nothide);
1.858     raeburn  2882:     if ($context eq 'userroles') { 
                   2883:         %dumphash = &dump('roles',$udom,$uname);
                   2884:     } else {
                   2885:         %dumphash=
1.400     www      2886:             &dump('nohist_userroles',$udom,$uname);
1.937     raeburn  2887:         if ($hidepriv) {
                   2888:             my %coursehash=&coursedescription($udom.'_'.$uname);
                   2889:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   2890:                 if ($user !~ /:/) {
                   2891:                     $nothide{join(':',split(/[\@]/,$user))} = 1;
                   2892:                 } else {
                   2893:                     $nothide{$user} = 1;
                   2894:                 }
                   2895:             }
                   2896:         }
1.858     raeburn  2897:     }
1.400     www      2898:     my %returnhash=();
                   2899:     my $now=time;
1.999     raeburn  2900:     my %privileged;
1.800     albertel 2901:     foreach my $entry (keys(%dumphash)) {
1.867     raeburn  2902:         my ($role,$tend,$tstart);
                   2903:         if ($context eq 'userroles') {
                   2904: 	    ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
                   2905:         } else {
                   2906:             ($tend,$tstart)=split(/\:/,$dumphash{$entry});
                   2907:         }
1.400     www      2908:         if (($tstart) && ($tstart<0)) { next; }
1.832     raeburn  2909:         my $status = 'active';
1.939     raeburn  2910:         if (($tend) && ($tend<=$now)) {
1.832     raeburn  2911:             $status = 'previous';
                   2912:         } 
                   2913:         if (($tstart) && ($now<$tstart)) {
                   2914:             $status = 'future';
                   2915:         }
                   2916:         if (ref($types) eq 'ARRAY') {
                   2917:             if (!grep(/^\Q$status\E$/,@{$types})) {
                   2918:                 next;
                   2919:             } 
                   2920:         } else {
                   2921:             if ($status ne 'active') {
                   2922:                 next;
                   2923:             }
                   2924:         }
1.867     raeburn  2925:         my ($rolecode,$username,$domain,$section,$area);
                   2926:         if ($context eq 'userroles') {
                   2927:             ($area,$rolecode) = split(/_/,$entry);
                   2928:             (undef,$domain,$username,$section) = split(/\//,$area);
                   2929:         } else {
                   2930:             ($role,$username,$domain,$section) = split(/\:/,$entry);
                   2931:         }
1.832     raeburn  2932:         if (ref($roledoms) eq 'ARRAY') {
                   2933:             if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
                   2934:                 next;
                   2935:             }
                   2936:         }
                   2937:         if (ref($roles) eq 'ARRAY') {
                   2938:             if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922     raeburn  2939:                 if ($role =~ /^cr\//) {
                   2940:                     if (!grep(/^cr$/,@{$roles})) {
                   2941:                         next;
                   2942:                     }
                   2943:                 } else {
                   2944:                     next;
                   2945:                 }
1.832     raeburn  2946:             }
1.867     raeburn  2947:         }
1.937     raeburn  2948:         if ($hidepriv) {
1.999     raeburn  2949:             if ($context eq 'userroles') {
                   2950:                 if ((&privileged($username,$domain)) &&
                   2951:                     (!$nothide{$username.':'.$domain})) {
                   2952:                     next;
                   2953:                 }
                   2954:             } else {
                   2955:                 unless (ref($privileged{$domain}) eq 'HASH') {
                   2956:                     my %dompersonnel =
                   2957:                         &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
                   2958:                     $privileged{$domain} = {};
                   2959:                     if (keys(%dompersonnel)) {
                   2960:                         foreach my $server (keys(%dompersonnel)) {
                   2961:                             if (ref($dompersonnel{$server}) eq 'HASH') {
                   2962:                                 foreach my $user (keys(%{$dompersonnel{$server}})) {
                   2963:                                     my ($trole,$uname,$udom) = split(/:/,$user);
                   2964:                                     $privileged{$udom}{$uname} = $trole;
                   2965:                                 }
                   2966:                             }
                   2967:                         }
                   2968:                     }
                   2969:                 }
                   2970:                 if (exists($privileged{$domain}{$username})) {
                   2971:                     if (!$nothide{$username.':'.$domain}) {
                   2972:                         next;
                   2973:                     }
                   2974:                 }
1.937     raeburn  2975:             }
                   2976:         }
1.933     raeburn  2977:         if ($withsec) {
                   2978:             $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
                   2979:                 $tstart.':'.$tend;
                   2980:         } else {
                   2981:             $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
                   2982:         }
1.832     raeburn  2983:     }
1.373     www      2984:     return %returnhash;
1.399     www      2985: }
                   2986: 
                   2987: # ----------------------------------------------------- Frontpage Announcements
                   2988: #
                   2989: #
                   2990: 
                   2991: sub postannounce {
                   2992:     my ($server,$text)=@_;
1.844     albertel 2993:     unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399     www      2994:     unless ($text=~/\w/) { $text=''; }
                   2995:     return &reply('setannounce:'.&escape($text),$server);
                   2996: }
                   2997: 
                   2998: sub getannounce {
1.448     albertel 2999: 
                   3000:     if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399     www      3001: 	my $announcement='';
1.800     albertel 3002: 	while (my $line = <$fh>) { $announcement .= $line; }
1.448     albertel 3003: 	close($fh);
1.399     www      3004: 	if ($announcement=~/\w/) { 
                   3005: 	    return 
                   3006:    '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518     albertel 3007:    '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 
1.399     www      3008: 	} else {
                   3009: 	    return '';
                   3010: 	}
                   3011:     } else {
                   3012: 	return '';
                   3013:     }
1.351     www      3014: }
1.353     www      3015: 
                   3016: # ---------------------------------------------------------- Course ID routines
                   3017: # Deal with domain's nohist_courseid.db files
                   3018: #
                   3019: 
                   3020: sub courseidput {
1.921     raeburn  3021:     my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054    raeburn  3022:     return unless (ref($storehash) eq 'HASH');
1.921     raeburn  3023:     my $outcome;
                   3024:     if ($caller eq 'timeonly') {
                   3025:         my $cids = '';
                   3026:         foreach my $item (keys(%$storehash)) {
                   3027:             $cids.=&escape($item).'&';
                   3028:         }
                   3029:         $cids=~s/\&$//;
                   3030:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
                   3031:                           $coursehome);       
                   3032:     } else {
                   3033:         my $items = '';
                   3034:         foreach my $item (keys(%$storehash)) {
                   3035:             $items.= &escape($item).'='.
                   3036:                      &freeze_escape($$storehash{$item}).'&';
                   3037:         }
                   3038:         $items=~s/\&$//;
                   3039:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
                   3040:                           $coursehome);
1.918     raeburn  3041:     }
                   3042:     if ($outcome eq 'unknown_cmd') {
                   3043:         my $what;
                   3044:         foreach my $cid (keys(%$storehash)) {
                   3045:             $what .= &escape($cid).'=';
1.921     raeburn  3046:             foreach my $item ('description','inst_code','owner','type') {
1.936     raeburn  3047:                 $what .= &escape($storehash->{$cid}{$item}).':';
1.918     raeburn  3048:             }
                   3049:             $what =~ s/\:$/&/;
                   3050:         }
                   3051:         $what =~ s/\&$//;  
                   3052:         return &reply('courseidput:'.$domain.':'.$what,$coursehome);
                   3053:     } else {
                   3054:         return $outcome;
                   3055:     }
1.353     www      3056: }
                   3057: 
                   3058: sub courseiddump {
1.921     raeburn  3059:     my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947     raeburn  3060:         $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029    raeburn  3061:         $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1056.2.5  raeburn  3062:         $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
1.918     raeburn  3063:     my $as_hash = 1;
                   3064:     my %returnhash;
                   3065:     if (!$domfilter) { $domfilter=''; }
1.845     albertel 3066:     my %libserv = &all_library();
                   3067:     foreach my $tryserver (keys(%libserv)) {
                   3068:         if ( (  $hostidflag == 1 
                   3069: 	        && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 
                   3070: 	     || (!defined($hostidflag)) ) {
                   3071: 
1.918     raeburn  3072: 	    if (($domfilter eq '') ||
                   3073: 		(&host_domain($tryserver) eq $domfilter)) {
                   3074:                 my $rep = 
                   3075:                   &reply('courseiddump:'.&host_domain($tryserver).':'.
                   3076:                          $sincefilter.':'.&escape($descfilter).':'.
                   3077:                          &escape($instcodefilter).':'.&escape($ownerfilter).
                   3078:                          ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947     raeburn  3079:                          ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962     raeburn  3080:                          &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008    raeburn  3081:                          $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029    raeburn  3082:                          &escape($cc_clone).':'.$cloneonly.':'.
                   3083:                          &escape($createdbefore).':'.&escape($createdafter).':'.
1.1056.2.5  raeburn  3084:                          &escape($creationcontext).':'.$domcloner,
                   3085:                          $tryserver);
1.918     raeburn  3086:                 my @pairs=split(/\&/,$rep);
                   3087:                 foreach my $item (@pairs) {
                   3088:                     my ($key,$value)=split(/\=/,$item,2);
                   3089:                     $key = &unescape($key);
                   3090:                     next if ($key =~ /^error: 2 /);
                   3091:                     my $result = &thaw_unescape($value);
                   3092:                     if (ref($result) eq 'HASH') {
                   3093:                         $returnhash{$key}=$result;
                   3094:                     } else {
1.921     raeburn  3095:                         my @responses = split(/:/,$value);
                   3096:                         my @items = ('description','inst_code','owner','type');
1.918     raeburn  3097:                         for (my $i=0; $i<@responses; $i++) {
1.921     raeburn  3098:                             $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918     raeburn  3099:                         }
1.1008    raeburn  3100:                     }
1.353     www      3101:                 }
                   3102:             }
                   3103:         }
                   3104:     }
                   3105:     return %returnhash;
                   3106: }
                   3107: 
1.1055    raeburn  3108: sub courselastaccess {
                   3109:     my ($cdom,$cnum,$hostidref) = @_;
                   3110:     my %returnhash;
                   3111:     if ($cdom && $cnum) {
                   3112:         my $chome = &homeserver($cnum,$cdom);
                   3113:         if ($chome ne 'no_host') {
                   3114:             my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
                   3115:             &extract_lastaccess(\%returnhash,$rep);
                   3116:         }
                   3117:     } else {
                   3118:         if (!$cdom) { $cdom=''; }
                   3119:         my %libserv = &all_library();
                   3120:         foreach my $tryserver (keys(%libserv)) {
                   3121:             if (ref($hostidref) eq 'ARRAY') {
                   3122:                 next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
                   3123:             } 
                   3124:             if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
                   3125:                 my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
                   3126:                 &extract_lastaccess(\%returnhash,$rep);
                   3127:             }
                   3128:         }
                   3129:     }
                   3130:     return %returnhash;
                   3131: }
                   3132: 
                   3133: sub extract_lastaccess {
                   3134:     my ($returnhash,$rep) = @_;
                   3135:     if (ref($returnhash) eq 'HASH') {
                   3136:         unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 
                   3137:                 $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
                   3138:                  $rep eq '') {
                   3139:             my @pairs=split(/\&/,$rep);
                   3140:             foreach my $item (@pairs) {
                   3141:                 my ($key,$value)=split(/\=/,$item,2);
                   3142:                 $key = &unescape($key);
                   3143:                 next if ($key =~ /^error: 2 /);
                   3144:                 $returnhash->{$key} = &thaw_unescape($value);
                   3145:             }
                   3146:         }
                   3147:     }
                   3148:     return;
                   3149: }
                   3150: 
1.658     raeburn  3151: # ---------------------------------------------------------- DC e-mail
1.662     raeburn  3152: 
                   3153: sub dcmailput {
1.685     raeburn  3154:     my ($domain,$msgid,$message,$server)=@_;
1.662     raeburn  3155:     my $status = &Apache::lonnet::critical(
1.740     www      3156:        'dcmailput:'.$domain.':'.&escape($msgid).'='.
                   3157:        &escape($message),$server);
1.662     raeburn  3158:     return $status;
                   3159: }
                   3160: 
1.658     raeburn  3161: sub dcmaildump {
                   3162:     my ($dom,$startdate,$enddate,$senders) = @_;
1.685     raeburn  3163:     my %returnhash=();
1.846     albertel 3164: 
                   3165:     if (defined(&domain($dom,'primary'))) {
1.685     raeburn  3166:         my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
                   3167:                                                          &escape($enddate).':';
                   3168: 	my @esc_senders=map { &escape($_)} @$senders;
                   3169: 	$cmd.=&escape(join('&',@esc_senders));
1.846     albertel 3170: 	foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800     albertel 3171:             my ($key,$value) = split(/\=/,$line,2);
1.685     raeburn  3172:             if (($key) && ($value)) {
                   3173:                 $returnhash{&unescape($key)} = &unescape($value);
1.658     raeburn  3174:             }
                   3175:         }
                   3176:     }
                   3177:     return %returnhash;
                   3178: }
1.662     raeburn  3179: # ---------------------------------------------------------- Domain roles
                   3180: 
                   3181: sub get_domain_roles {
                   3182:     my ($dom,$roles,$startdate,$enddate)=@_;
1.1018    raeburn  3183:     if ((!defined($startdate)) || ($startdate eq '')) {
1.662     raeburn  3184:         $startdate = '.';
                   3185:     }
1.1018    raeburn  3186:     if ((!defined($enddate)) || ($enddate eq '')) {
1.662     raeburn  3187:         $enddate = '.';
                   3188:     }
1.922     raeburn  3189:     my $rolelist;
                   3190:     if (ref($roles) eq 'ARRAY') {
                   3191:         $rolelist = join(':',@{$roles});
                   3192:     }
1.662     raeburn  3193:     my %personnel = ();
1.841     albertel 3194: 
                   3195:     my %servers = &get_servers($dom,'library');
                   3196:     foreach my $tryserver (keys(%servers)) {
                   3197: 	%{$personnel{$tryserver}}=();
                   3198: 	foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
                   3199: 					    &escape($startdate).':'.
                   3200: 					    &escape($enddate).':'.
                   3201: 					    &escape($rolelist), $tryserver))) {
                   3202: 	    my ($key,$value) = split(/\=/,$line,2);
                   3203: 	    if (($key) && ($value)) {
                   3204: 		$personnel{$tryserver}{&unescape($key)} = &unescape($value);
                   3205: 	    }
                   3206: 	}
1.662     raeburn  3207:     }
                   3208:     return %personnel;
                   3209: }
1.658     raeburn  3210: 
1.149     www      3211: # ----------------------------------------------------------- Check out an item
                   3212: 
1.504     albertel 3213: sub get_first_access {
                   3214:     my ($type,$argsymb)=@_;
1.790     albertel 3215:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 3216:     if ($argsymb) { $symb=$argsymb; }
                   3217:     my ($map,$id,$res)=&decode_symb($symb);
1.926     albertel 3218:     if ($type eq 'course') {
                   3219: 	$res='course';
                   3220:     } elsif ($type eq 'map') {
1.588     albertel 3221: 	$res=&symbread($map);
                   3222:     } else {
                   3223: 	$res=$symb;
                   3224:     }
                   3225:     my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
                   3226:     return $times{"$courseid\0$res"};
1.504     albertel 3227: }
                   3228: 
                   3229: sub set_first_access {
                   3230:     my ($type)=@_;
1.790     albertel 3231:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 3232:     my ($map,$id,$res)=&decode_symb($symb);
1.928     albertel 3233:     if ($type eq 'course') {
                   3234: 	$res='course';
                   3235:     } elsif ($type eq 'map') {
1.588     albertel 3236: 	$res=&symbread($map);
                   3237:     } else {
                   3238: 	$res=$symb;
                   3239:     }
                   3240:     my $firstaccess=&get_first_access($type,$symb);
1.505     albertel 3241:     if (!$firstaccess) {
1.588     albertel 3242: 	return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505     albertel 3243:     }
                   3244:     return 'already_set';
1.504     albertel 3245: }
                   3246: 
1.149     www      3247: sub checkout {
                   3248:     my ($symb,$tuname,$tudom,$tcrsid)=@_;
                   3249:     my $now=time;
                   3250:     my $lonhost=$perlvar{'lonHostID'};
                   3251:     my $infostr=&escape(
1.234     www      3252:                  'CHECKOUTTOKEN&'.
1.149     www      3253:                  $tuname.'&'.
                   3254:                  $tudom.'&'.
                   3255:                  $tcrsid.'&'.
                   3256:                  $symb.'&'.
                   3257: 		 $now.'&'.$ENV{'REMOTE_ADDR'});
                   3258:     my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151     www      3259:     if ($token=~/^error\:/) { 
1.672     albertel 3260:         &logthis("<font color=\"blue\">WARNING: ".
1.151     www      3261:                 "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
                   3262:                  "</font>");
                   3263:         return ''; 
                   3264:     }
                   3265: 
1.149     www      3266:     $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
                   3267:     $token=~tr/a-z/A-Z/;
                   3268: 
1.153     www      3269:     my %infohash=('resource.0.outtoken' => $token,
                   3270:                   'resource.0.checkouttime' => $now,
                   3271:                   'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149     www      3272: 
                   3273:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
                   3274:        return '';
1.151     www      3275:     } else {
1.672     albertel 3276:         &logthis("<font color=\"blue\">WARNING: ".
1.151     www      3277:                 "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
                   3278:                  "</font>");
1.149     www      3279:     }    
                   3280: 
                   3281:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
                   3282:                          &escape('Checkout '.$infostr.' - '.
                   3283:                                                  $token)) ne 'ok') {
                   3284: 	return '';
1.151     www      3285:     } else {
1.672     albertel 3286:         &logthis("<font color=\"blue\">WARNING: ".
1.151     www      3287:                 "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
                   3288:                  "</font>");
1.149     www      3289:     }
1.151     www      3290:     return $token;
1.149     www      3291: }
                   3292: 
                   3293: # ------------------------------------------------------------ Check in an item
                   3294: 
                   3295: sub checkin {
                   3296:     my $token=shift;
1.150     www      3297:     my $now=time;
                   3298:     my ($ta,$tb,$lonhost)=split(/\*/,$token);
                   3299:     $lonhost=~tr/A-Z/a-z/;
1.838     albertel 3300:     my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150     www      3301:     $dtoken=~s/\W/\_/g;
1.234     www      3302:     my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150     www      3303:                  split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
                   3304: 
1.154     www      3305:     unless (($tuname) && ($tudom)) {
                   3306:         &logthis('Check in '.$token.' ('.$dtoken.') failed');
                   3307:         return '';
                   3308:     }
                   3309:     
                   3310:     unless (&allowed('mgr',$tcrsid)) {
                   3311:         &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620     albertel 3312:                  $env{'user.name'}.' - '.$env{'user.domain'});
1.154     www      3313:         return '';
                   3314:     }
                   3315: 
1.153     www      3316:     my %infohash=('resource.0.intoken' => $token,
                   3317:                   'resource.0.checkintime' => $now,
                   3318:                   'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150     www      3319: 
                   3320:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
                   3321:        return '';
                   3322:     }    
                   3323: 
                   3324:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
                   3325:                          &escape('Checkin - '.$token)) ne 'ok') {
                   3326: 	return '';
                   3327:     }
                   3328: 
                   3329:     return ($symb,$tuname,$tudom,$tcrsid);    
1.110     www      3330: }
                   3331: 
                   3332: # --------------------------------------------- Set Expire Date for Spreadsheet
                   3333: 
                   3334: sub expirespread {
                   3335:     my ($uname,$udom,$stype,$usymb)=@_;
1.620     albertel 3336:     my $cid=$env{'request.course.id'}; 
1.110     www      3337:     if ($cid) {
                   3338:        my $now=time;
                   3339:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620     albertel 3340:        return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
                   3341:                             $env{'course.'.$cid.'.num'}.
1.110     www      3342: 	        	    ':nohist_expirationdates:'.
                   3343:                             &escape($key).'='.$now,
1.620     albertel 3344:                             $env{'course.'.$cid.'.home'})
1.110     www      3345:     }
                   3346:     return 'ok';
1.14      www      3347: }
                   3348: 
1.109     www      3349: # ----------------------------------------------------- Devalidate Spreadsheets
                   3350: 
                   3351: sub devalidate {
1.325     www      3352:     my ($symb,$uname,$udom)=@_;
1.620     albertel 3353:     my $cid=$env{'request.course.id'}; 
1.109     www      3354:     if ($cid) {
1.391     matthew  3355:         # delete the stored spreadsheets for
                   3356:         # - the student level sheet of this user in course's homespace
                   3357:         # - the assessment level sheet for this resource 
                   3358:         #   for this user in user's homespace
1.553     albertel 3359: 	# - current conditional state info
1.325     www      3360: 	my $key=$uname.':'.$udom.':';
1.109     www      3361:         my $status=
1.299     matthew  3362: 	    &del('nohist_calculatedsheets',
1.391     matthew  3363: 		 [$key.'studentcalc:'],
1.620     albertel 3364: 		 $env{'course.'.$cid.'.domain'},
                   3365: 		 $env{'course.'.$cid.'.num'})
1.133     albertel 3366: 		.' '.
                   3367: 	    &del('nohist_calculatedsheets_'.$cid,
1.391     matthew  3368: 		 [$key.'assesscalc:'.$symb],$udom,$uname);
1.109     www      3369:         unless ($status eq 'ok ok') {
                   3370:            &logthis('Could not devalidate spreadsheet '.
1.325     www      3371:                     $uname.' at '.$udom.' for '.
1.109     www      3372: 		    $symb.': '.$status);
1.133     albertel 3373:         }
1.553     albertel 3374: 	&delenv('user.state.'.$cid);
1.109     www      3375:     }
                   3376: }
                   3377: 
1.265     albertel 3378: sub get_scalar {
                   3379:     my ($string,$end) = @_;
                   3380:     my $value;
                   3381:     if ($$string =~ s/^([^&]*?)($end)/$2/) {
                   3382: 	$value = $1;
                   3383:     } elsif ($$string =~ s/^([^&]*?)&//) {
                   3384: 	$value = $1;
                   3385:     }
                   3386:     return &unescape($value);
                   3387: }
                   3388: 
                   3389: sub array2str {
                   3390:   my (@array) = @_;
                   3391:   my $result=&arrayref2str(\@array);
                   3392:   $result=~s/^__ARRAY_REF__//;
                   3393:   $result=~s/__END_ARRAY_REF__$//;
                   3394:   return $result;
                   3395: }
                   3396: 
1.204     albertel 3397: sub arrayref2str {
                   3398:   my ($arrayref) = @_;
1.265     albertel 3399:   my $result='__ARRAY_REF__';
1.204     albertel 3400:   foreach my $elem (@$arrayref) {
1.265     albertel 3401:     if(ref($elem) eq 'ARRAY') {
                   3402:       $result.=&arrayref2str($elem).'&';
                   3403:     } elsif(ref($elem) eq 'HASH') {
                   3404:       $result.=&hashref2str($elem).'&';
                   3405:     } elsif(ref($elem)) {
                   3406:       #print("Got a ref of ".(ref($elem))." skipping.");
1.204     albertel 3407:     } else {
                   3408:       $result.=&escape($elem).'&';
                   3409:     }
                   3410:   }
                   3411:   $result=~s/\&$//;
1.265     albertel 3412:   $result .= '__END_ARRAY_REF__';
1.204     albertel 3413:   return $result;
                   3414: }
                   3415: 
1.168     albertel 3416: sub hash2str {
1.204     albertel 3417:   my (%hash) = @_;
                   3418:   my $result=&hashref2str(\%hash);
1.265     albertel 3419:   $result=~s/^__HASH_REF__//;
                   3420:   $result=~s/__END_HASH_REF__$//;
1.204     albertel 3421:   return $result;
                   3422: }
                   3423: 
                   3424: sub hashref2str {
                   3425:   my ($hashref)=@_;
1.265     albertel 3426:   my $result='__HASH_REF__';
1.800     albertel 3427:   foreach my $key (sort(keys(%$hashref))) {
                   3428:     if (ref($key) eq 'ARRAY') {
                   3429:       $result.=&arrayref2str($key).'=';
                   3430:     } elsif (ref($key) eq 'HASH') {
                   3431:       $result.=&hashref2str($key).'=';
                   3432:     } elsif (ref($key)) {
1.265     albertel 3433:       $result.='=';
1.800     albertel 3434:       #print("Got a ref of ".(ref($key))." skipping.");
1.204     albertel 3435:     } else {
1.800     albertel 3436: 	if ($key) {$result.=&escape($key).'=';} else { last; }
1.204     albertel 3437:     }
                   3438: 
1.800     albertel 3439:     if(ref($hashref->{$key}) eq 'ARRAY') {
                   3440:       $result.=&arrayref2str($hashref->{$key}).'&';
                   3441:     } elsif(ref($hashref->{$key}) eq 'HASH') {
                   3442:       $result.=&hashref2str($hashref->{$key}).'&';
                   3443:     } elsif(ref($hashref->{$key})) {
1.265     albertel 3444:        $result.='&';
1.800     albertel 3445:       #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204     albertel 3446:     } else {
1.800     albertel 3447:       $result.=&escape($hashref->{$key}).'&';
1.204     albertel 3448:     }
                   3449:   }
1.168     albertel 3450:   $result=~s/\&$//;
1.265     albertel 3451:   $result .= '__END_HASH_REF__';
1.168     albertel 3452:   return $result;
                   3453: }
                   3454: 
                   3455: sub str2hash {
1.265     albertel 3456:     my ($string)=@_;
                   3457:     my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
                   3458:     return %$hash;
                   3459: }
                   3460: 
                   3461: sub str2hashref {
1.168     albertel 3462:   my ($string) = @_;
1.265     albertel 3463: 
                   3464:   my %hash;
                   3465: 
                   3466:   if($string !~ /^__HASH_REF__/) {
                   3467:       if (! ($string eq '' || !defined($string))) {
                   3468: 	  $hash{'error'}='Not hash reference';
                   3469:       }
                   3470:       return (\%hash, $string);
                   3471:   }
                   3472: 
                   3473:   $string =~ s/^__HASH_REF__//;
                   3474: 
                   3475:   while($string !~ /^__END_HASH_REF__/) {
                   3476:       #key
                   3477:       my $key='';
                   3478:       if($string =~ /^__HASH_REF__/) {
                   3479:           ($key, $string)=&str2hashref($string);
                   3480:           if(defined($key->{'error'})) {
                   3481:               $hash{'error'}='Bad data';
                   3482:               return (\%hash, $string);
                   3483:           }
                   3484:       } elsif($string =~ /^__ARRAY_REF__/) {
                   3485:           ($key, $string)=&str2arrayref($string);
                   3486:           if($key->[0] eq 'Array reference error') {
                   3487:               $hash{'error'}='Bad data';
                   3488:               return (\%hash, $string);
                   3489:           }
                   3490:       } else {
                   3491:           $string =~ s/^(.*?)=//;
1.267     albertel 3492: 	  $key=&unescape($1);
1.265     albertel 3493:       }
                   3494:       $string =~ s/^=//;
                   3495: 
                   3496:       #value
                   3497:       my $value='';
                   3498:       if($string =~ /^__HASH_REF__/) {
                   3499:           ($value, $string)=&str2hashref($string);
                   3500:           if(defined($value->{'error'})) {
                   3501:               $hash{'error'}='Bad data';
                   3502:               return (\%hash, $string);
                   3503:           }
                   3504:       } elsif($string =~ /^__ARRAY_REF__/) {
                   3505:           ($value, $string)=&str2arrayref($string);
                   3506:           if($value->[0] eq 'Array reference error') {
                   3507:               $hash{'error'}='Bad data';
                   3508:               return (\%hash, $string);
                   3509:           }
                   3510:       } else {
                   3511: 	  $value=&get_scalar(\$string,'__END_HASH_REF__');
                   3512:       }
                   3513:       $string =~ s/^&//;
                   3514: 
                   3515:       $hash{$key}=$value;
1.204     albertel 3516:   }
1.265     albertel 3517: 
                   3518:   $string =~ s/^__END_HASH_REF__//;
                   3519: 
                   3520:   return (\%hash, $string);
1.204     albertel 3521: }
                   3522: 
                   3523: sub str2array {
1.265     albertel 3524:     my ($string)=@_;
                   3525:     my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
                   3526:     return @$array;
                   3527: }
                   3528: 
                   3529: sub str2arrayref {
1.204     albertel 3530:   my ($string) = @_;
1.265     albertel 3531:   my @array;
                   3532: 
                   3533:   if($string !~ /^__ARRAY_REF__/) {
                   3534:       if (! ($string eq '' || !defined($string))) {
                   3535: 	  $array[0]='Array reference error';
                   3536:       }
                   3537:       return (\@array, $string);
                   3538:   }
                   3539: 
                   3540:   $string =~ s/^__ARRAY_REF__//;
                   3541: 
                   3542:   while($string !~ /^__END_ARRAY_REF__/) {
                   3543:       my $value='';
                   3544:       if($string =~ /^__HASH_REF__/) {
                   3545:           ($value, $string)=&str2hashref($string);
                   3546:           if(defined($value->{'error'})) {
                   3547:               $array[0] ='Array reference error';
                   3548:               return (\@array, $string);
                   3549:           }
                   3550:       } elsif($string =~ /^__ARRAY_REF__/) {
                   3551:           ($value, $string)=&str2arrayref($string);
                   3552:           if($value->[0] eq 'Array reference error') {
                   3553:               $array[0] ='Array reference error';
                   3554:               return (\@array, $string);
                   3555:           }
                   3556:       } else {
                   3557: 	  $value=&get_scalar(\$string,'__END_ARRAY_REF__');
                   3558:       }
                   3559:       $string =~ s/^&//;
                   3560: 
                   3561:       push(@array, $value);
1.191     harris41 3562:   }
1.265     albertel 3563: 
                   3564:   $string =~ s/^__END_ARRAY_REF__//;
                   3565: 
                   3566:   return (\@array, $string);
1.168     albertel 3567: }
                   3568: 
1.167     albertel 3569: # -------------------------------------------------------------------Temp Store
                   3570: 
1.168     albertel 3571: sub tmpreset {
                   3572:   my ($symb,$namespace,$domain,$stuname) = @_;
                   3573:   if (!$symb) {
                   3574:     $symb=&symbread();
1.620     albertel 3575:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 3576:   }
                   3577:   $symb=escape($symb);
                   3578: 
1.620     albertel 3579:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.168     albertel 3580:   $namespace=~s/\//\_/g;
                   3581:   $namespace=~s/\W//g;
                   3582: 
1.620     albertel 3583:   if (!$domain) { $domain=$env{'user.domain'}; }
                   3584:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 3585:   if ($domain eq 'public' && $stuname eq 'public') {
                   3586:       $stuname=$ENV{'REMOTE_ADDR'};
                   3587:   }
1.168     albertel 3588:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   3589:   my %hash;
                   3590:   if (tie(%hash,'GDBM_File',
                   3591: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 3592: 	  &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  3593:     foreach my $key (keys(%hash)) {
1.180     albertel 3594:       if ($key=~ /:$symb/) {
1.168     albertel 3595: 	delete($hash{$key});
                   3596:       }
                   3597:     }
                   3598:   }
                   3599: }
                   3600: 
1.167     albertel 3601: sub tmpstore {
1.168     albertel 3602:   my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   3603: 
                   3604:   if (!$symb) {
                   3605:     $symb=&symbread();
1.620     albertel 3606:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 3607:   }
                   3608:   $symb=escape($symb);
                   3609: 
                   3610:   if (!$namespace) {
                   3611:     # I don't think we would ever want to store this for a course.
                   3612:     # it seems this will only be used if we don't have a course.
1.620     albertel 3613:     #$namespace=$env{'request.course.id'};
1.168     albertel 3614:     #if (!$namespace) {
1.620     albertel 3615:       $namespace=$env{'request.state'};
1.168     albertel 3616:     #}
                   3617:   }
                   3618:   $namespace=~s/\//\_/g;
                   3619:   $namespace=~s/\W//g;
1.620     albertel 3620:   if (!$domain) { $domain=$env{'user.domain'}; }
                   3621:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 3622:   if ($domain eq 'public' && $stuname eq 'public') {
                   3623:       $stuname=$ENV{'REMOTE_ADDR'};
                   3624:   }
1.168     albertel 3625:   my $now=time;
                   3626:   my %hash;
                   3627:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   3628:   if (tie(%hash,'GDBM_File',
                   3629: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 3630: 	  &GDBM_WRCREAT(),0640)) {
1.168     albertel 3631:     $hash{"version:$symb"}++;
                   3632:     my $version=$hash{"version:$symb"};
                   3633:     my $allkeys=''; 
                   3634:     foreach my $key (keys(%$storehash)) {
                   3635:       $allkeys.=$key.':';
1.591     albertel 3636:       $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168     albertel 3637:     }
                   3638:     $hash{"$version:$symb:timestamp"}=$now;
                   3639:     $allkeys.='timestamp';
                   3640:     $hash{"$version:keys:$symb"}=$allkeys;
                   3641:     if (untie(%hash)) {
                   3642:       return 'ok';
                   3643:     } else {
                   3644:       return "error:$!";
                   3645:     }
                   3646:   } else {
                   3647:     return "error:$!";
                   3648:   }
                   3649: }
1.167     albertel 3650: 
1.168     albertel 3651: # -----------------------------------------------------------------Temp Restore
1.167     albertel 3652: 
1.168     albertel 3653: sub tmprestore {
                   3654:   my ($symb,$namespace,$domain,$stuname) = @_;
1.167     albertel 3655: 
1.168     albertel 3656:   if (!$symb) {
                   3657:     $symb=&symbread();
1.620     albertel 3658:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 3659:   }
                   3660:   $symb=escape($symb);
                   3661: 
1.620     albertel 3662:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.591     albertel 3663: 
1.620     albertel 3664:   if (!$domain) { $domain=$env{'user.domain'}; }
                   3665:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 3666:   if ($domain eq 'public' && $stuname eq 'public') {
                   3667:       $stuname=$ENV{'REMOTE_ADDR'};
                   3668:   }
1.168     albertel 3669:   my %returnhash;
                   3670:   $namespace=~s/\//\_/g;
                   3671:   $namespace=~s/\W//g;
                   3672:   my %hash;
                   3673:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   3674:   if (tie(%hash,'GDBM_File',
                   3675: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 3676: 	  &GDBM_READER(),0640)) {
1.168     albertel 3677:     my $version=$hash{"version:$symb"};
                   3678:     $returnhash{'version'}=$version;
                   3679:     my $scope;
                   3680:     for ($scope=1;$scope<=$version;$scope++) {
                   3681:       my $vkeys=$hash{"$scope:keys:$symb"};
                   3682:       my @keys=split(/:/,$vkeys);
                   3683:       my $key;
                   3684:       $returnhash{"$scope:keys"}=$vkeys;
                   3685:       foreach $key (@keys) {
1.591     albertel 3686: 	$returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
                   3687: 	$returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167     albertel 3688:       }
                   3689:     }
1.168     albertel 3690:     if (!(untie(%hash))) {
                   3691:       return "error:$!";
                   3692:     }
                   3693:   } else {
                   3694:     return "error:$!";
                   3695:   }
                   3696:   return %returnhash;
1.167     albertel 3697: }
                   3698: 
1.9       www      3699: # ----------------------------------------------------------------------- Store
                   3700: 
                   3701: sub store {
1.124     www      3702:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   3703:     my $home='';
                   3704: 
1.168     albertel 3705:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      3706: 
1.213     www      3707:     $symb=&symbclean($symb);
1.122     albertel 3708:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      3709: 
1.620     albertel 3710:     if (!$domain) { $domain=$env{'user.domain'}; }
                   3711:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      3712: 
                   3713:     &devalidate($symb,$stuname,$domain);
1.109     www      3714: 
                   3715:     $symb=escape($symb);
1.187     www      3716:     if (!$namespace) { 
1.620     albertel 3717:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      3718:           return ''; 
                   3719:        } 
                   3720:     }
1.620     albertel 3721:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      3722: 
                   3723:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   3724:     $$storehash{'host'}=$perlvar{'lonHostID'};
                   3725: 
1.12      www      3726:     my $namevalue='';
1.800     albertel 3727:     foreach my $key (keys(%$storehash)) {
                   3728:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 3729:     }
1.12      www      3730:     $namevalue=~s/\&$//;
1.187     www      3731:     &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124     www      3732:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9       www      3733: }
                   3734: 
1.47      www      3735: # -------------------------------------------------------------- Critical Store
                   3736: 
                   3737: sub cstore {
1.124     www      3738:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   3739:     my $home='';
                   3740: 
1.168     albertel 3741:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      3742: 
1.213     www      3743:     $symb=&symbclean($symb);
1.122     albertel 3744:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      3745: 
1.620     albertel 3746:     if (!$domain) { $domain=$env{'user.domain'}; }
                   3747:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      3748: 
                   3749:     &devalidate($symb,$stuname,$domain);
1.109     www      3750: 
                   3751:     $symb=escape($symb);
1.187     www      3752:     if (!$namespace) { 
1.620     albertel 3753:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      3754:           return ''; 
                   3755:        } 
                   3756:     }
1.620     albertel 3757:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      3758: 
                   3759:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   3760:     $$storehash{'host'}=$perlvar{'lonHostID'};
1.122     albertel 3761: 
1.47      www      3762:     my $namevalue='';
1.800     albertel 3763:     foreach my $key (keys(%$storehash)) {
                   3764:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 3765:     }
1.47      www      3766:     $namevalue=~s/\&$//;
1.187     www      3767:     &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188     www      3768:     return critical
                   3769:                 ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47      www      3770: }
                   3771: 
1.9       www      3772: # --------------------------------------------------------------------- Restore
                   3773: 
                   3774: sub restore {
1.124     www      3775:     my ($symb,$namespace,$domain,$stuname) = @_;
                   3776:     my $home='';
                   3777: 
1.168     albertel 3778:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      3779: 
1.122     albertel 3780:     if (!$symb) {
                   3781:       unless ($symb=escape(&symbread())) { return ''; }
                   3782:     } else {
1.213     www      3783:       $symb=&escape(&symbclean($symb));
1.122     albertel 3784:     }
1.188     www      3785:     if (!$namespace) { 
1.620     albertel 3786:        unless ($namespace=$env{'request.course.id'}) { 
1.188     www      3787:           return ''; 
                   3788:        } 
                   3789:     }
1.620     albertel 3790:     if (!$domain) { $domain=$env{'user.domain'}; }
                   3791:     if (!$stuname) { $stuname=$env{'user.name'}; }
                   3792:     if (!$home) { $home=$env{'user.home'}; }
1.122     albertel 3793:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
                   3794: 
1.12      www      3795:     my %returnhash=();
1.800     albertel 3796:     foreach my $line (split(/\&/,$answer)) {
                   3797: 	my ($name,$value)=split(/\=/,$line);
1.591     albertel 3798:         $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191     harris41 3799:     }
1.75      www      3800:     my $version;
                   3801:     for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800     albertel 3802:        foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
                   3803:           $returnhash{$item}=$returnhash{$version.':'.$item};
1.191     harris41 3804:        }
1.75      www      3805:     }
1.13      www      3806:     return %returnhash;
1.34      www      3807: }
                   3808: 
                   3809: # ---------------------------------------------------------- Course Description
                   3810: 
                   3811: sub coursedescription {
1.731     albertel 3812:     my ($courseid,$args)=@_;
1.34      www      3813:     $courseid=~s/^\///;
1.49      www      3814:     $courseid=~s/\_/\//g;
1.34      www      3815:     my ($cdomain,$cnum)=split(/\//,$courseid);
1.129     albertel 3816:     my $chome=&homeserver($cnum,$cdomain);
1.302     albertel 3817:     my $normalid=$cdomain.'_'.$cnum;
                   3818:     # need to always cache even if we get errors otherwise we keep 
                   3819:     # trying and trying and trying to get the course description.
                   3820:     my %envhash=();
                   3821:     my %returnhash=();
1.731     albertel 3822:     
                   3823:     my $expiretime=600;
                   3824:     if ($env{'request.course.id'} eq $normalid) {
                   3825: 	$expiretime=120;
                   3826:     }
                   3827: 
                   3828:     my $prefix='course.'.$cdomain.'_'.$cnum.'.';
                   3829:     if (!$args->{'freshen_cache'}
                   3830: 	&& ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
                   3831: 	foreach my $key (keys(%env)) {
                   3832: 	    next if ($key !~ /^\Q$prefix\E(.*)/);
                   3833: 	    my ($setting) = $1;
                   3834: 	    $returnhash{$setting} = $env{$key};
                   3835: 	}
                   3836: 	return %returnhash;
                   3837:     }
                   3838: 
                   3839:     # get the data agin
                   3840:     if (!$args->{'one_time'}) {
                   3841: 	$envhash{'course.'.$normalid.'.last_cache'}=time;
                   3842:     }
1.811     albertel 3843: 
1.34      www      3844:     if ($chome ne 'no_host') {
1.302     albertel 3845:        %returnhash=&dump('environment',$cdomain,$cnum);
1.129     albertel 3846:        if (!exists($returnhash{'con_lost'})) {
                   3847:            $returnhash{'home'}= $chome;
                   3848: 	   $returnhash{'domain'} = $cdomain;
                   3849: 	   $returnhash{'num'} = $cnum;
1.741     raeburn  3850:            if (!defined($returnhash{'type'})) {
                   3851:                $returnhash{'type'} = 'Course';
                   3852:            }
1.130     albertel 3853:            while (my ($name,$value) = each %returnhash) {
1.53      www      3854:                $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129     albertel 3855:            }
1.270     www      3856:            $returnhash{'url'}=&clutter($returnhash{'url'});
1.34      www      3857:            $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620     albertel 3858: 	       $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60      www      3859:            $envhash{'course.'.$normalid.'.home'}=$chome;
                   3860:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
                   3861:            $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34      www      3862:        }
                   3863:     }
1.731     albertel 3864:     if (!$args->{'one_time'}) {
1.949     raeburn  3865: 	&appenv(\%envhash);
1.731     albertel 3866:     }
1.302     albertel 3867:     return %returnhash;
1.461     www      3868: }
                   3869: 
                   3870: # -------------------------------------------------See if a user is privileged
                   3871: 
                   3872: sub privileged {
                   3873:     my ($username,$domain)=@_;
                   3874:     my $rolesdump=&reply("dump:$domain:$username:roles",
                   3875: 			&homeserver($username,$domain));
1.1033    raeburn  3876:     if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 
                   3877:         ($rolesdump =~ /^error:/)) {
                   3878:         return 0;
                   3879:     }
1.461     www      3880:     my $now=time;
                   3881:     if ($rolesdump ne '') {
1.800     albertel 3882:         foreach my $entry (split(/&/,$rolesdump)) {
                   3883: 	    if ($entry!~/^rolesdef_/) {
                   3884: 		my ($area,$role)=split(/=/,$entry);
1.461     www      3885: 		$area=~s/\_\w\w$//;
                   3886: 		my ($trole,$tend,$tstart)=split(/_/,$role);
                   3887: 		if (($trole eq 'dc') || ($trole eq 'su')) {
                   3888: 		    my $active=1;
                   3889: 		    if ($tend) {
                   3890: 			if ($tend<$now) { $active=0; }
                   3891: 		    }
                   3892: 		    if ($tstart) {
                   3893: 			if ($tstart>$now) { $active=0; }
                   3894: 		    }
                   3895: 		    if ($active) { return 1; }
                   3896: 		}
                   3897: 	    }
                   3898: 	}
                   3899:     }
                   3900:     return 0;
1.9       www      3901: }
1.1       albertel 3902: 
1.103     harris41 3903: # -------------------------------------------------------- Get user privileges
1.11      www      3904: 
                   3905: sub rolesinit {
                   3906:     my ($domain,$username,$authhost)=@_;
1.1034    raeburn  3907:     my $now=time;
                   3908:     my %userroles = ('user.login.time' => $now);
1.11      www      3909:     my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033    raeburn  3910:     if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 
                   3911:         ($rolesdump =~ /^error:/)) { 
                   3912:         return \%userroles;
                   3913:     }
1.11      www      3914:     my %allroles=();
1.678     raeburn  3915:     my %allgroups=();   
                   3916:     my $group_privs;
1.11      www      3917: 
                   3918:     if ($rolesdump ne '') {
1.800     albertel 3919:         foreach my $entry (split(/&/,$rolesdump)) {
                   3920: 	  if ($entry!~/^rolesdef_/) {
                   3921:             my ($area,$role)=split(/=/,$entry);
1.587     albertel 3922: 	    $area=~s/\_\w\w$//;
1.678     raeburn  3923:             my ($trole,$tend,$tstart,$group_privs);
1.587     albertel 3924: 	    if ($role=~/^cr/) { 
1.807     albertel 3925: 		if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
                   3926: 		    ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655     albertel 3927: 		    ($tend,$tstart)=split('_',$trest);
                   3928: 		} else {
                   3929: 		    $trole=$role;
                   3930: 		}
1.678     raeburn  3931:             } elsif ($role =~ m|^gr/|) {
                   3932:                 ($trole,$tend,$tstart) = split(/_/,$role);
                   3933:                 ($trole,$group_privs) = split(/\//,$trole);
                   3934:                 $group_privs = &unescape($group_privs);
1.587     albertel 3935: 	    } else {
                   3936: 		($trole,$tend,$tstart)=split(/_/,$role);
                   3937: 	    }
1.743     albertel 3938: 	    my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
                   3939: 					 $username);
                   3940: 	    @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567     raeburn  3941:             if (($tend!=0) && ($tend<$now)) { $trole=''; }
                   3942:             if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11      www      3943:             if (($area ne '') && ($trole ne '')) {
1.347     albertel 3944: 		my $spec=$trole.'.'.$area;
                   3945: 		my ($tdummy,$tdomain,$trest)=split(/\//,$area);
                   3946: 		if ($trole =~ /^cr\//) {
1.567     raeburn  3947:                     &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678     raeburn  3948:                 } elsif ($trole eq 'gr') {
                   3949:                     &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347     albertel 3950: 		} else {
1.567     raeburn  3951:                     &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347     albertel 3952: 		}
1.12      www      3953:             }
1.662     raeburn  3954:           }
1.191     harris41 3955:         }
1.743     albertel 3956:         my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
                   3957:         $userroles{'user.adv'}    = $adv;
                   3958: 	$userroles{'user.author'} = $author;
1.620     albertel 3959:         $env{'user.adv'}=$adv;
1.11      www      3960:     }
1.743     albertel 3961:     return \%userroles;  
1.11      www      3962: }
                   3963: 
1.567     raeburn  3964: sub set_arearole {
                   3965:     my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
                   3966: # log the associated role with the area
                   3967:     &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743     albertel 3968:     return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567     raeburn  3969: }
                   3970: 
                   3971: sub custom_roleprivs {
                   3972:     my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
                   3973:     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
                   3974:     my $homsvr=homeserver($rauthor,$rdomain);
1.838     albertel 3975:     if (&hostname($homsvr) ne '') {
1.567     raeburn  3976:         my ($rdummy,$roledef)=
                   3977:             &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
                   3978:         if (($rdummy ne 'con_lost') && ($roledef ne '')) {
                   3979:             my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
                   3980:             if (defined($syspriv)) {
1.1043    raeburn  3981:                 if ($trest =~ /^$match_community$/) {
                   3982:                     $syspriv =~ s/bre\&S//; 
                   3983:                 }
1.567     raeburn  3984:                 $$allroles{'cm./'}.=':'.$syspriv;
                   3985:                 $$allroles{$spec.'./'}.=':'.$syspriv;
                   3986:             }
                   3987:             if ($tdomain ne '') {
                   3988:                 if (defined($dompriv)) {
                   3989:                     $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
                   3990:                     $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
                   3991:                 }
                   3992:                 if (($trest ne '') && (defined($coursepriv))) {
                   3993:                     $$allroles{'cm.'.$area}.=':'.$coursepriv;
                   3994:                     $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
                   3995:                 }
                   3996:             }
                   3997:         }
                   3998:     }
                   3999: }
                   4000: 
1.678     raeburn  4001: sub group_roleprivs {
                   4002:     my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
                   4003:     my $access = 1;
                   4004:     my $now = time;
                   4005:     if (($tend!=0) && ($tend<$now)) { $access = 0; }
                   4006:     if (($tstart!=0) && ($tstart>$now)) { $access=0; }
                   4007:     if ($access) {
1.811     albertel 4008:         my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678     raeburn  4009:         $$allgroups{$course}{$group} .=':'.$group_privs;
                   4010:     }
                   4011: }
1.567     raeburn  4012: 
                   4013: sub standard_roleprivs {
                   4014:     my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
                   4015:     if (defined($pr{$trole.':s'})) {
                   4016:         $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
                   4017:         $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
                   4018:     }
                   4019:     if ($tdomain ne '') {
                   4020:         if (defined($pr{$trole.':d'})) {
                   4021:             $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   4022:             $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   4023:         }
                   4024:         if (($trest ne '') && (defined($pr{$trole.':c'}))) {
                   4025:             $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
                   4026:             $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
                   4027:         }
                   4028:     }
                   4029: }
                   4030: 
                   4031: sub set_userprivs {
1.1056.2.3  raeburn  4032:     my ($userroles,$allroles,$allgroups,$groups_roles) = @_; 
1.567     raeburn  4033:     my $author=0;
                   4034:     my $adv=0;
1.678     raeburn  4035:     my %grouproles = ();
                   4036:     if (keys(%{$allgroups}) > 0) {
1.1056.2.3  raeburn  4037:         my @groupkeys;
1.1000    raeburn  4038:         foreach my $role (keys(%{$allroles})) {
1.1056.2.3  raeburn  4039:             push(@groupkeys,$role);
                   4040:         }
                   4041:         if (ref($groups_roles) eq 'HASH') {
                   4042:             foreach my $key (keys(%{$groups_roles})) {
                   4043:                 unless (grep(/^\Q$key\E$/,@groupkeys)) {
                   4044:                     push(@groupkeys,$key);
                   4045:                 }
                   4046:             }
                   4047:         }
                   4048:         if (@groupkeys > 0) {
                   4049:             foreach my $role (@groupkeys) {
                   4050:                 my ($trole,$area,$sec,$extendedarea);
                   4051:                 if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
                   4052:                     $trole = $1;
                   4053:                     $area = $2;
                   4054:                     $sec = $3;
                   4055:                     $extendedarea = $area.$sec;
                   4056:                     if (exists($$allgroups{$area})) {
                   4057:                         foreach my $group (keys(%{$$allgroups{$area}})) {
                   4058:                             my $spec = $trole.'.'.$extendedarea;
                   4059:                             $grouproles{$spec.'.'.$area.'/'.$group} = 
                   4060:                                                   $$allgroups{$area}{$group};
                   4061:                         }
1.678     raeburn  4062:                     }
                   4063:                 }
                   4064:             }
                   4065:         }
                   4066:     }
1.800     albertel 4067:     foreach my $group (keys(%grouproles)) {
                   4068:         $$allroles{$group} = $grouproles{$group};
1.678     raeburn  4069:     }
1.800     albertel 4070:     foreach my $role (keys(%{$allroles})) {
                   4071:         my %thesepriv;
1.941     raeburn  4072:         if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800     albertel 4073:         foreach my $item (split(/:/,$$allroles{$role})) {
                   4074:             if ($item ne '') {
                   4075:                 my ($privilege,$restrictions)=split(/&/,$item);
1.567     raeburn  4076:                 if ($restrictions eq '') {
                   4077:                     $thesepriv{$privilege}='F';
                   4078:                 } elsif ($thesepriv{$privilege} ne 'F') {
                   4079:                     $thesepriv{$privilege}.=$restrictions;
                   4080:                 }
                   4081:                 if ($thesepriv{'adv'} eq 'F') { $adv=1; }
                   4082:             }
                   4083:         }
                   4084:         my $thesestr='';
1.800     albertel 4085:         foreach my $priv (keys(%thesepriv)) {
                   4086: 	    $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
                   4087: 	}
                   4088:         $userroles->{'user.priv.'.$role} = $thesestr;
1.567     raeburn  4089:     }
                   4090:     return ($author,$adv);
                   4091: }
                   4092: 
1.994     raeburn  4093: sub role_status {
1.1002    raeburn  4094:     my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994     raeburn  4095:     my @pwhere = ();
                   4096:     if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
                   4097:         (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
                   4098:         unless (!defined($$role) || $$role eq '') {
                   4099:             $$where=join('.',@pwhere);
                   4100:             $$trolecode=$$role.'.'.$$where;
                   4101:             ($$tstart,$$tend)=split(/\./,$env{$rolekey});
                   4102:             $$tstatus='is';
                   4103:             if ($$tstart && $$tstart>$then) {
                   4104:                 $$tstatus='future';
1.1034    raeburn  4105:                 if ($$tstart<$now) {
                   4106:                     if ($$tstart && $$tstart>$refresh) {
1.1002    raeburn  4107:                         if (($$where ne '') && ($$role ne '')) {
1.1056.2.3  raeburn  4108:                             my (%allroles,%allgroups,$group_privs,
                   4109:                                 %groups_roles,@rolecodes);
1.1002    raeburn  4110:                             my %userroles = (
                   4111:                                 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
                   4112:                             );
1.1056.2.3  raeburn  4113:                             @rolecodes = ('cm');
1.1002    raeburn  4114:                             my $spec=$$role.'.'.$$where;
                   4115:                             my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
                   4116:                             if ($$role =~ /^cr\//) {
                   4117:                                 &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1056.2.3  raeburn  4118:                                 push(@rolecodes,'cr');
1.1002    raeburn  4119:                             } elsif ($$role eq 'gr') {
1.1056.2.3  raeburn  4120:                                 push(@rolecodes,$$role);
1.1002    raeburn  4121:                                 my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
                   4122:                                                     $env{'user.name'});
1.1056.2.3  raeburn  4123:                                 my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002    raeburn  4124:                                 (undef,my $group_privs) = split(/\//,$trole);
                   4125:                                 $group_privs = &unescape($group_privs);
                   4126:                                 &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1056.2.3  raeburn  4127:                                 my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
                   4128:                                 if (keys(%course_roles) > 0) {
                   4129:                                     my ($tnum) = ($trest =~ /^($match_courseid)/);
                   4130:                                     if ($tdomain ne '' && $tnum ne '') {
                   4131:                                         foreach my $key (keys(%course_roles)) {
                   4132:                                             if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) {
                   4133:                                                 my $crsrole = $1;
                   4134:                                                 my $crssec = $2;
                   4135:                                                 if ($crsrole =~ /^cr/) {
                   4136:                                                     unless (grep(/^cr$/,@rolecodes)) {
                   4137:                                                         push(@rolecodes,'cr');
                   4138:                                                     }
                   4139:                                                 } else {
                   4140:                                                     unless(grep(/^\Q$crsrole\E$/,@rolecodes)) {
                   4141:                                                         push(@rolecodes,$crsrole);
                   4142:                                                     }
                   4143:                                                 }
                   4144:                                                 my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum;
                   4145:                                                 if ($crssec ne '') {
                   4146:                                                     $rolekey .= '/'.$crssec;
                   4147:                                                 }
                   4148:                                                 $rolekey .= './';
                   4149:                                                 $groups_roles{$rolekey} = \@rolecodes;
                   4150:                                             }
                   4151:                                         }
                   4152:                                     }
                   4153:                                 }
1.1002    raeburn  4154:                             } else {
1.1056.2.3  raeburn  4155:                                 push(@rolecodes,$$role);
1.1002    raeburn  4156:                                 &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
                   4157:                             }
1.1056.2.3  raeburn  4158:                             my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
                   4159:                             &appenv(\%userroles,\@rolecodes);
1.1002    raeburn  4160:                             &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
                   4161:                         }
                   4162:                     }
1.1034    raeburn  4163:                     $$tstatus = 'is';
1.1002    raeburn  4164:                 }
1.994     raeburn  4165:             }
                   4166:             if ($$tend) {
                   4167:                 if ($$tend<$then) {
                   4168:                     $$tstatus='expired';
                   4169:                 } elsif ($$tend<$now) {
                   4170:                     $$tstatus='will_not';
                   4171:                 }
                   4172:             }
                   4173:         }
                   4174:     }
                   4175: }
                   4176: 
                   4177: sub check_adhoc_privs {
1.1002    raeburn  4178:     my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994     raeburn  4179:     my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
                   4180:     if ($env{$cckey}) {
                   4181:         my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002    raeburn  4182:         &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994     raeburn  4183:         unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
                   4184:             &set_adhoc_privileges($cdom,$cnum,$checkrole);
                   4185:         }
                   4186:     } else {
                   4187:         &set_adhoc_privileges($cdom,$cnum,$checkrole);
                   4188:     }
                   4189: }
                   4190: 
                   4191: sub set_adhoc_privileges {
                   4192: # role can be cc or ca
                   4193:     my ($dcdom,$pickedcourse,$role) = @_;
                   4194:     my $area = '/'.$dcdom.'/'.$pickedcourse;
                   4195:     my $spec = $role.'.'.$area;
                   4196:     my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
                   4197:                                   $env{'user.name'});
                   4198:     my %ccrole = ();
                   4199:     &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
                   4200:     my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
                   4201:     &appenv(\%userroles,[$role,'cm']);
                   4202:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
                   4203:     &appenv( {'request.role'        => $spec,
                   4204:               'request.role.domain' => $dcdom,
                   4205:               'request.course.sec'  => ''
                   4206:              }
                   4207:            );
                   4208:     my $tadv=0;
                   4209:     if (&allowed('adv') eq 'F') { $tadv=1; }
                   4210:     &appenv({'request.role.adv'    => $tadv});
                   4211: }
                   4212: 
1.12      www      4213: # --------------------------------------------------------------- get interface
                   4214: 
                   4215: sub get {
1.131     albertel 4216:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      4217:    my $items='';
1.800     albertel 4218:    foreach my $item (@$storearr) {
                   4219:        $items.=&escape($item).'&';
1.191     harris41 4220:    }
1.12      www      4221:    $items=~s/\&$//;
1.620     albertel 4222:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4223:    if (!$uname) { $uname=$env{'user.name'}; }
1.131     albertel 4224:    my $uhome=&homeserver($uname,$udomain);
                   4225: 
1.133     albertel 4226:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      4227:    my @pairs=split(/\&/,$rep);
1.273     albertel 4228:    if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   4229:      return @pairs;
                   4230:    }
1.15      www      4231:    my %returnhash=();
1.42      www      4232:    my $i=0;
1.800     albertel 4233:    foreach my $item (@$storearr) {
                   4234:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      4235:       $i++;
1.191     harris41 4236:    }
1.15      www      4237:    return %returnhash;
1.27      www      4238: }
                   4239: 
                   4240: # --------------------------------------------------------------- del interface
                   4241: 
                   4242: sub del {
1.133     albertel 4243:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.27      www      4244:    my $items='';
1.800     albertel 4245:    foreach my $item (@$storearr) {
                   4246:        $items.=&escape($item).'&';
1.191     harris41 4247:    }
1.984     neumanie 4248: 
1.27      www      4249:    $items=~s/\&$//;
1.620     albertel 4250:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4251:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 4252:    my $uhome=&homeserver($uname,$udomain);
                   4253:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      4254: }
                   4255: 
                   4256: # -------------------------------------------------------------- dump interface
                   4257: 
                   4258: sub dump {
1.755     albertel 4259:     my ($namespace,$udomain,$uname,$regexp,$range)=@_;
                   4260:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4261:     if (!$uname) { $uname=$env{'user.name'}; }
                   4262:     my $uhome=&homeserver($uname,$udomain);
                   4263:     if ($regexp) {
                   4264: 	$regexp=&escape($regexp);
                   4265:     } else {
                   4266: 	$regexp='.';
                   4267:     }
                   4268:     my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
                   4269:     my @pairs=split(/\&/,$rep);
                   4270:     my %returnhash=();
                   4271:     foreach my $item (@pairs) {
                   4272: 	my ($key,$value)=split(/=/,$item,2);
                   4273: 	$key = &unescape($key);
                   4274: 	next if ($key =~ /^error: 2 /);
                   4275: 	$returnhash{$key}=&thaw_unescape($value);
                   4276:     }
                   4277:     return %returnhash;
1.407     www      4278: }
                   4279: 
1.717     albertel 4280: # --------------------------------------------------------- dumpstore interface
                   4281: 
                   4282: sub dumpstore {
                   4283:    my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822     albertel 4284:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4285:    if (!$uname) { $uname=$env{'user.name'}; }
                   4286:    my $uhome=&homeserver($uname,$udomain);
                   4287:    if ($regexp) {
                   4288:        $regexp=&escape($regexp);
                   4289:    } else {
                   4290:        $regexp='.';
                   4291:    }
                   4292:    my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
                   4293:    my @pairs=split(/\&/,$rep);
                   4294:    my %returnhash=();
                   4295:    foreach my $item (@pairs) {
                   4296:        my ($key,$value)=split(/=/,$item,2);
                   4297:        next if ($key =~ /^error: 2 /);
                   4298:        $returnhash{$key}=&thaw_unescape($value);
                   4299:    }
                   4300:    return %returnhash;
1.717     albertel 4301: }
                   4302: 
1.407     www      4303: # -------------------------------------------------------------- keys interface
                   4304: 
                   4305: sub getkeys {
                   4306:    my ($namespace,$udomain,$uname)=@_;
1.620     albertel 4307:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4308:    if (!$uname) { $uname=$env{'user.name'}; }
1.407     www      4309:    my $uhome=&homeserver($uname,$udomain);
                   4310:    my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
                   4311:    my @keyarray=();
1.800     albertel 4312:    foreach my $key (split(/\&/,$rep)) {
1.812     raeburn  4313:       next if ($key =~ /^error: 2 /);
1.800     albertel 4314:       push(@keyarray,&unescape($key));
1.407     www      4315:    }
                   4316:    return @keyarray;
1.318     matthew  4317: }
                   4318: 
1.319     matthew  4319: # --------------------------------------------------------------- currentdump
                   4320: sub currentdump {
1.328     matthew  4321:    my ($courseid,$sdom,$sname)=@_;
1.620     albertel 4322:    $courseid = $env{'request.course.id'} if (! defined($courseid));
                   4323:    $sdom     = $env{'user.domain'}       if (! defined($sdom));
                   4324:    $sname    = $env{'user.name'}         if (! defined($sname));
1.326     matthew  4325:    my $uhome = &homeserver($sname,$sdom);
                   4326:    my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318     matthew  4327:    return if ($rep =~ /^(error:|no_such_host)/);
1.319     matthew  4328:    #
1.318     matthew  4329:    my %returnhash=();
1.319     matthew  4330:    #
                   4331:    if ($rep eq "unknown_cmd") { 
                   4332:        # an old lond will not know currentdump
                   4333:        # Do a dump and make it look like a currentdump
1.822     albertel 4334:        my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319     matthew  4335:        return if ($tmp[0] =~ /^(error:|no_such_host)/);
                   4336:        my %hash = @tmp;
                   4337:        @tmp=();
1.424     matthew  4338:        %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319     matthew  4339:    } else {
                   4340:        my @pairs=split(/\&/,$rep);
1.800     albertel 4341:        foreach my $pair (@pairs) {
                   4342:            my ($key,$value)=split(/=/,$pair,2);
1.319     matthew  4343:            my ($symb,$param) = split(/:/,$key);
                   4344:            $returnhash{&unescape($symb)}->{&unescape($param)} = 
1.557     albertel 4345:                                                         &thaw_unescape($value);
1.319     matthew  4346:        }
1.191     harris41 4347:    }
1.12      www      4348:    return %returnhash;
1.424     matthew  4349: }
                   4350: 
                   4351: sub convert_dump_to_currentdump{
                   4352:     my %hash = %{shift()};
                   4353:     my %returnhash;
                   4354:     # Code ripped from lond, essentially.  The only difference
                   4355:     # here is the unescaping done by lonnet::dump().  Conceivably
                   4356:     # we might run in to problems with parameter names =~ /^v\./
                   4357:     while (my ($key,$value) = each(%hash)) {
                   4358:         my ($v,$symb,$param) = split(/:/,$key);
1.822     albertel 4359: 	$symb  = &unescape($symb);
                   4360: 	$param = &unescape($param);
1.424     matthew  4361:         next if ($v eq 'version' || $symb eq 'keys');
                   4362:         next if (exists($returnhash{$symb}) &&
                   4363:                  exists($returnhash{$symb}->{$param}) &&
                   4364:                  $returnhash{$symb}->{'v.'.$param} > $v);
                   4365:         $returnhash{$symb}->{$param}=$value;
                   4366:         $returnhash{$symb}->{'v.'.$param}=$v;
                   4367:     }
                   4368:     #
                   4369:     # Remove all of the keys in the hashes which keep track of
                   4370:     # the version of the parameter.
                   4371:     while (my ($symb,$param_hash) = each(%returnhash)) {
                   4372:         # use a foreach because we are going to delete from the hash.
                   4373:         foreach my $key (keys(%$param_hash)) {
                   4374:             delete($param_hash->{$key}) if ($key =~ /^v\./);
                   4375:         }
                   4376:     }
                   4377:     return \%returnhash;
1.12      www      4378: }
                   4379: 
1.627     albertel 4380: # ------------------------------------------------------ critical inc interface
                   4381: 
                   4382: sub cinc {
                   4383:     return &inc(@_,'critical');
                   4384: }
                   4385: 
1.449     matthew  4386: # --------------------------------------------------------------- inc interface
                   4387: 
                   4388: sub inc {
1.627     albertel 4389:     my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620     albertel 4390:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4391:     if (!$uname) { $uname=$env{'user.name'}; }
1.449     matthew  4392:     my $uhome=&homeserver($uname,$udomain);
                   4393:     my $items='';
                   4394:     if (! ref($store)) {
                   4395:         # got a single value, so use that instead
                   4396:         $items = &escape($store).'=&';
                   4397:     } elsif (ref($store) eq 'SCALAR') {
                   4398:         $items = &escape($$store).'=&';        
                   4399:     } elsif (ref($store) eq 'ARRAY') {
                   4400:         $items = join('=&',map {&escape($_);} @{$store});
                   4401:     } elsif (ref($store) eq 'HASH') {
                   4402:         while (my($key,$value) = each(%{$store})) {
                   4403:             $items.= &escape($key).'='.&escape($value).'&';
                   4404:         }
                   4405:     }
                   4406:     $items=~s/\&$//;
1.627     albertel 4407:     if ($critical) {
                   4408: 	return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
                   4409:     } else {
                   4410: 	return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
                   4411:     }
1.449     matthew  4412: }
                   4413: 
1.12      www      4414: # --------------------------------------------------------------- put interface
                   4415: 
                   4416: sub put {
1.134     albertel 4417:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 4418:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4419:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 4420:    my $uhome=&homeserver($uname,$udomain);
1.12      www      4421:    my $items='';
1.800     albertel 4422:    foreach my $item (keys(%$storehash)) {
                   4423:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 4424:    }
1.12      www      4425:    $items=~s/\&$//;
1.134     albertel 4426:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47      www      4427: }
                   4428: 
1.631     albertel 4429: # ------------------------------------------------------------ newput interface
                   4430: 
                   4431: sub newput {
                   4432:    my ($namespace,$storehash,$udomain,$uname)=@_;
                   4433:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4434:    if (!$uname) { $uname=$env{'user.name'}; }
                   4435:    my $uhome=&homeserver($uname,$udomain);
                   4436:    my $items='';
                   4437:    foreach my $key (keys(%$storehash)) {
                   4438:        $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   4439:    }
                   4440:    $items=~s/\&$//;
                   4441:    return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
                   4442: }
                   4443: 
                   4444: # ---------------------------------------------------------  putstore interface
                   4445: 
1.524     raeburn  4446: sub putstore {
1.715     albertel 4447:    my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620     albertel 4448:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4449:    if (!$uname) { $uname=$env{'user.name'}; }
1.524     raeburn  4450:    my $uhome=&homeserver($uname,$udomain);
                   4451:    my $items='';
1.715     albertel 4452:    foreach my $key (keys(%$storehash)) {
                   4453:        $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524     raeburn  4454:    }
1.715     albertel 4455:    $items=~s/\&$//;
1.716     albertel 4456:    my $esc_symb=&escape($symb);
                   4457:    my $esc_v=&escape($version);
1.715     albertel 4458:    my $reply =
1.716     albertel 4459:        &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715     albertel 4460: 	      $uhome);
                   4461:    if ($reply eq 'unknown_cmd') {
1.716     albertel 4462:        # gfall back to way things use to be done
1.715     albertel 4463:        return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
                   4464: 			    $uname);
1.524     raeburn  4465:    }
1.715     albertel 4466:    return $reply;
                   4467: }
                   4468: 
                   4469: sub old_putstore {
1.716     albertel 4470:     my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
                   4471:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4472:     if (!$uname) { $uname=$env{'user.name'}; }
                   4473:     my $uhome=&homeserver($uname,$udomain);
                   4474:     my %newstorehash;
1.800     albertel 4475:     foreach my $item (keys(%$storehash)) {
                   4476: 	my $key = $version.':'.&escape($symb).':'.$item;
                   4477: 	$newstorehash{$key} = $storehash->{$item};
1.716     albertel 4478:     }
                   4479:     my $items='';
                   4480:     my %allitems = ();
1.800     albertel 4481:     foreach my $item (keys(%newstorehash)) {
                   4482: 	if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716     albertel 4483: 	    my $key = $1.':keys:'.$2;
                   4484: 	    $allitems{$key} .= $3.':';
                   4485: 	}
1.800     albertel 4486: 	$items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716     albertel 4487:     }
1.800     albertel 4488:     foreach my $item (keys(%allitems)) {
                   4489: 	$allitems{$item} =~ s/\:$//;
                   4490: 	$items.= $item.'='.$allitems{$item}.'&';
1.716     albertel 4491:     }
                   4492:     $items=~s/\&$//;
                   4493:     return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524     raeburn  4494: }
                   4495: 
1.47      www      4496: # ------------------------------------------------------ critical put interface
                   4497: 
                   4498: sub cput {
1.134     albertel 4499:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 4500:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4501:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 4502:    my $uhome=&homeserver($uname,$udomain);
1.47      www      4503:    my $items='';
1.800     albertel 4504:    foreach my $item (keys(%$storehash)) {
                   4505:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 4506:    }
1.47      www      4507:    $items=~s/\&$//;
1.134     albertel 4508:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      4509: }
                   4510: 
                   4511: # -------------------------------------------------------------- eget interface
                   4512: 
                   4513: sub eget {
1.133     albertel 4514:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      4515:    my $items='';
1.800     albertel 4516:    foreach my $item (@$storearr) {
                   4517:        $items.=&escape($item).'&';
1.191     harris41 4518:    }
1.12      www      4519:    $items=~s/\&$//;
1.620     albertel 4520:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   4521:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 4522:    my $uhome=&homeserver($uname,$udomain);
                   4523:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      4524:    my @pairs=split(/\&/,$rep);
                   4525:    my %returnhash=();
1.42      www      4526:    my $i=0;
1.800     albertel 4527:    foreach my $item (@$storearr) {
                   4528:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      4529:       $i++;
1.191     harris41 4530:    }
1.12      www      4531:    return %returnhash;
                   4532: }
                   4533: 
1.667     albertel 4534: # ------------------------------------------------------------ tmpput interface
                   4535: sub tmpput {
1.802     raeburn  4536:     my ($storehash,$server,$context)=@_;
1.667     albertel 4537:     my $items='';
1.800     albertel 4538:     foreach my $item (keys(%$storehash)) {
                   4539: 	$items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667     albertel 4540:     }
                   4541:     $items=~s/\&$//;
1.802     raeburn  4542:     if (defined($context)) {
                   4543:         $items .= ':'.&escape($context);
                   4544:     }
1.667     albertel 4545:     return &reply("tmpput:$items",$server);
                   4546: }
                   4547: 
                   4548: # ------------------------------------------------------------ tmpget interface
                   4549: sub tmpget {
1.688     albertel 4550:     my ($token,$server)=@_;
                   4551:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   4552:     my $rep=&reply("tmpget:$token",$server);
1.667     albertel 4553:     my %returnhash;
                   4554:     foreach my $item (split(/\&/,$rep)) {
                   4555: 	my ($key,$value)=split(/=/,$item);
1.951     raeburn  4556:         next if ($key =~ /^error: 2 /);
1.667     albertel 4557: 	$returnhash{&unescape($key)}=&thaw_unescape($value);
                   4558:     }
                   4559:     return %returnhash;
                   4560: }
                   4561: 
1.688     albertel 4562: # ------------------------------------------------------------ tmpget interface
                   4563: sub tmpdel {
                   4564:     my ($token,$server)=@_;
                   4565:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   4566:     return &reply("tmpdel:$token",$server);
                   4567: }
                   4568: 
1.765     albertel 4569: # -------------------------------------------------- portfolio access checking
                   4570: 
                   4571: sub portfolio_access {
1.766     albertel 4572:     my ($requrl) = @_;
1.765     albertel 4573:     my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
                   4574:     my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814     raeburn  4575:     if ($result) {
                   4576:         my %setters;
                   4577:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4578:             my ($startblock,$endblock) =
                   4579:                 &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
                   4580:             if ($startblock && $endblock) {
                   4581:                 return 'B';
                   4582:             }
                   4583:         } else {
                   4584:             my ($startblock,$endblock) =
                   4585:                 &Apache::loncommon::blockcheck(\%setters,'port');
                   4586:             if ($startblock && $endblock) {
                   4587:                 return 'B';
                   4588:             }
                   4589:         }
                   4590:     }
1.765     albertel 4591:     if ($result eq 'ok') {
1.766     albertel 4592:        return 'F';
1.765     albertel 4593:     } elsif ($result =~ /^[^:]+:guest_/) {
1.766     albertel 4594:        return 'A';
1.765     albertel 4595:     }
1.766     albertel 4596:     return '';
1.765     albertel 4597: }
                   4598: 
                   4599: sub get_portfolio_access {
1.767     albertel 4600:     my ($udom,$unum,$file_name,$group,$access_hash) = @_;
                   4601: 
                   4602:     if (!ref($access_hash)) {
                   4603: 	my $current_perms = &get_portfile_permissions($udom,$unum);
                   4604: 	my %access_controls = &get_access_controls($current_perms,$group,
                   4605: 						   $file_name);
                   4606: 	$access_hash = $access_controls{$file_name};
                   4607:     }
                   4608: 
1.765     albertel 4609:     my ($public,$guest,@domains,@users,@courses,@groups);
                   4610:     my $now = time;
                   4611:     if (ref($access_hash) eq 'HASH') {
                   4612:         foreach my $key (keys(%{$access_hash})) {
                   4613:             my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
                   4614:             if ($start > $now) {
                   4615:                 next;
                   4616:             }
                   4617:             if ($end && $end<$now) {
                   4618:                 next;
                   4619:             }
                   4620:             if ($scope eq 'public') {
                   4621:                 $public = $key;
                   4622:                 last;
                   4623:             } elsif ($scope eq 'guest') {
                   4624:                 $guest = $key;
                   4625:             } elsif ($scope eq 'domains') {
                   4626:                 push(@domains,$key);
                   4627:             } elsif ($scope eq 'users') {
                   4628:                 push(@users,$key);
                   4629:             } elsif ($scope eq 'course') {
                   4630:                 push(@courses,$key);
                   4631:             } elsif ($scope eq 'group') {
                   4632:                 push(@groups,$key);
                   4633:             }
                   4634:         }
                   4635:         if ($public) {
                   4636:             return 'ok';
                   4637:         }
                   4638:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4639:             if ($guest) {
                   4640:                 return $guest;
                   4641:             }
                   4642:         } else {
                   4643:             if (@domains > 0) {
                   4644:                 foreach my $domkey (@domains) {
                   4645:                     if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
                   4646:                         if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
                   4647:                             return 'ok';
                   4648:                         }
                   4649:                     }
                   4650:                 }
                   4651:             }
                   4652:             if (@users > 0) {
                   4653:                 foreach my $userkey (@users) {
1.865     raeburn  4654:                     if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
                   4655:                         foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
                   4656:                             if (ref($item) eq 'HASH') {
                   4657:                                 if (($item->{'uname'} eq $env{'user.name'}) &&
                   4658:                                     ($item->{'udom'} eq $env{'user.domain'})) {
                   4659:                                     return 'ok';
                   4660:                                 }
                   4661:                             }
                   4662:                         }
                   4663:                     } 
1.765     albertel 4664:                 }
                   4665:             }
                   4666:             my %roleshash;
                   4667:             my @courses_and_groups = @courses;
                   4668:             push(@courses_and_groups,@groups); 
                   4669:             if (@courses_and_groups > 0) {
                   4670:                 my (%allgroups,%allroles); 
                   4671:                 my ($start,$end,$role,$sec,$group);
                   4672:                 foreach my $envkey (%env) {
1.1056.2.2  raeburn  4673:                     if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 4674:                         my $cid = $2.'_'.$3; 
                   4675:                         if ($1 eq 'gr') {
                   4676:                             $group = $4;
                   4677:                             $allgroups{$cid}{$group} = $env{$envkey};
                   4678:                         } else {
                   4679:                             if ($4 eq '') {
                   4680:                                 $sec = 'none';
                   4681:                             } else {
                   4682:                                 $sec = $4;
                   4683:                             }
                   4684:                             $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   4685:                         }
1.811     albertel 4686:                     } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 4687:                         my $cid = $2.'_'.$3;
                   4688:                         if ($4 eq '') {
                   4689:                             $sec = 'none';
                   4690:                         } else {
                   4691:                             $sec = $4;
                   4692:                         }
                   4693:                         $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   4694:                     }
                   4695:                 }
                   4696:                 if (keys(%allroles) == 0) {
                   4697:                     return;
                   4698:                 }
                   4699:                 foreach my $key (@courses_and_groups) {
                   4700:                     my %content = %{$$access_hash{$key}};
                   4701:                     my $cnum = $content{'number'};
                   4702:                     my $cdom = $content{'domain'};
                   4703:                     my $cid = $cdom.'_'.$cnum;
                   4704:                     if (!exists($allroles{$cid})) {
                   4705:                         next;
                   4706:                     }    
                   4707:                     foreach my $role_id (keys(%{$content{'roles'}})) {
                   4708:                         my @sections = @{$content{'roles'}{$role_id}{'section'}};
                   4709:                         my @groups = @{$content{'roles'}{$role_id}{'group'}};
                   4710:                         my @status = @{$content{'roles'}{$role_id}{'access'}};
                   4711:                         my @roles = @{$content{'roles'}{$role_id}{'role'}};
                   4712:                         foreach my $role (keys(%{$allroles{$cid}})) {
                   4713:                             if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
                   4714:                                 foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
                   4715:                                     if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
                   4716:                                         if (grep/^all$/,@sections) {
                   4717:                                             return 'ok';
                   4718:                                         } else {
                   4719:                                             if (grep/^$sec$/,@sections) {
                   4720:                                                 return 'ok';
                   4721:                                             }
                   4722:                                         }
                   4723:                                     }
                   4724:                                 }
                   4725:                                 if (keys(%{$allgroups{$cid}}) == 0) {
                   4726:                                     if (grep/^none$/,@groups) {
                   4727:                                         return 'ok';
                   4728:                                     }
                   4729:                                 } else {
                   4730:                                     if (grep/^all$/,@groups) {
                   4731:                                         return 'ok';
                   4732:                                     } 
                   4733:                                     foreach my $group (keys(%{$allgroups{$cid}})) {
                   4734:                                         if (grep/^$group$/,@groups) {
                   4735:                                             return 'ok';
                   4736:                                         }
                   4737:                                     }
                   4738:                                 } 
                   4739:                             }
                   4740:                         }
                   4741:                     }
                   4742:                 }
                   4743:             }
                   4744:             if ($guest) {
                   4745:                 return $guest;
                   4746:             }
                   4747:         }
                   4748:     }
                   4749:     return;
                   4750: }
                   4751: 
                   4752: sub course_group_datechecker {
                   4753:     my ($dates,$now,$status) = @_;
                   4754:     my ($start,$end) = split(/\./,$dates);
                   4755:     if (!$start && !$end) {
                   4756:         return 'ok';
                   4757:     }
                   4758:     if (grep/^active$/,@{$status}) {
                   4759:         if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
                   4760:             return 'ok';
                   4761:         }
                   4762:     }
                   4763:     if (grep/^previous$/,@{$status}) {
                   4764:         if ($end > $now ) {
                   4765:             return 'ok';
                   4766:         }
                   4767:     }
                   4768:     if (grep/^future$/,@{$status}) {
                   4769:         if ($start > $now) {
                   4770:             return 'ok';
                   4771:         }
                   4772:     }
                   4773:     return; 
                   4774: }
                   4775: 
                   4776: sub parse_portfolio_url {
                   4777:     my ($url) = @_;
                   4778: 
                   4779:     my ($type,$udom,$unum,$group,$file_name);
                   4780:     
1.823     albertel 4781:     if ($url =~  m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765     albertel 4782: 	$type = 1;
                   4783:         $udom = $1;
                   4784:         $unum = $2;
                   4785:         $file_name = $3;
1.823     albertel 4786:     } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765     albertel 4787: 	$type = 2;
                   4788:         $udom = $1;
                   4789:         $unum = $2;
                   4790:         $group = $3;
                   4791:         $file_name = $3.'/'.$4;
                   4792:     }
                   4793:     if (wantarray) {
                   4794: 	return ($type,$udom,$unum,$file_name,$group);
                   4795:     }
                   4796:     return $type;
                   4797: }
                   4798: 
                   4799: sub is_portfolio_url {
                   4800:     my ($url) = @_;
                   4801:     return scalar(&parse_portfolio_url($url));
                   4802: }
                   4803: 
1.798     raeburn  4804: sub is_portfolio_file {
                   4805:     my ($file) = @_;
1.820     raeburn  4806:     if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798     raeburn  4807:         return 1;
                   4808:     }
                   4809:     return;
                   4810: }
                   4811: 
1.976     raeburn  4812: sub usertools_access {
1.985     raeburn  4813:     my ($uname,$udom,$tool,$action,$context) = @_;
                   4814:     my ($access,%tools);
                   4815:     if ($context eq '') {
                   4816:         $context = 'tools';
                   4817:     }
                   4818:     if ($context eq 'requestcourses') {
                   4819:         %tools = (
                   4820:                       official   => 1,
                   4821:                       unofficial => 1,
1.1006    raeburn  4822:                       community  => 1,
1.985     raeburn  4823:                  );
                   4824:     } else {
                   4825:         %tools = (
                   4826:                       aboutme   => 1,
                   4827:                       blog      => 1,
                   4828:                       portfolio => 1,
                   4829:                  );
                   4830:     }
1.976     raeburn  4831:     return if (!defined($tools{$tool}));
                   4832: 
                   4833:     if ((!defined($udom)) || (!defined($uname))) {
                   4834:         $udom = $env{'user.domain'};
                   4835:         $uname = $env{'user.name'};
                   4836:     }
                   4837: 
1.978     raeburn  4838:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
                   4839:         if ($action ne 'reload') {
1.985     raeburn  4840:             if ($context eq 'requestcourses') {
                   4841:                 return $env{'environment.canrequest.'.$tool};
                   4842:             } else {
                   4843:                 return $env{'environment.availabletools.'.$tool};
                   4844:             }
                   4845:         }
1.976     raeburn  4846:     }
                   4847: 
                   4848:     my ($toolstatus,$inststatus);
                   4849: 
1.985     raeburn  4850:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
                   4851:          ($action ne 'reload')) {
                   4852:         $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976     raeburn  4853:         $inststatus = $env{'environment.inststatus'};
                   4854:     } else {
1.1025    raeburn  4855:         my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985     raeburn  4856:         $toolstatus = $userenv{$context.'.'.$tool};
1.976     raeburn  4857:         $inststatus = $userenv{'inststatus'};
                   4858:     }
                   4859: 
                   4860:     if ($toolstatus ne '') {
                   4861:         if ($toolstatus) {
                   4862:             $access = 1;
                   4863:         } else {
                   4864:             $access = 0;
                   4865:         }
                   4866:         return $access;
                   4867:     }
                   4868: 
                   4869:     my $is_adv = &is_advanced_user($udom,$uname);
                   4870:     my %domdef = &get_domain_defaults($udom);
                   4871:     if (ref($domdef{$tool}) eq 'HASH') {
                   4872:         if ($is_adv) {
                   4873:             if ($domdef{$tool}{'_LC_adv'} ne '') {
                   4874:                 if ($domdef{$tool}{'_LC_adv'}) { 
                   4875:                     $access = 1;
                   4876:                 } else {
                   4877:                     $access = 0;
                   4878:                 }
                   4879:                 return $access;
                   4880:             }
                   4881:         }
                   4882:         if ($inststatus ne '') {
                   4883:             my ($hasaccess,$hasnoaccess);
                   4884:             foreach my $affiliation (split(/:/,$inststatus)) {
                   4885:                 if ($domdef{$tool}{$affiliation} ne '') { 
                   4886:                     if ($domdef{$tool}{$affiliation}) {
                   4887:                         $hasaccess = 1;
                   4888:                     } else {
                   4889:                         $hasnoaccess = 1;
                   4890:                     }
                   4891:                 }
                   4892:             }
                   4893:             if ($hasaccess || $hasnoaccess) {
                   4894:                 if ($hasaccess) {
                   4895:                     $access = 1;
                   4896:                 } elsif ($hasnoaccess) {
                   4897:                     $access = 0; 
                   4898:                 }
                   4899:                 return $access;
                   4900:             }
                   4901:         } else {
                   4902:             if ($domdef{$tool}{'default'} ne '') {
                   4903:                 if ($domdef{$tool}{'default'}) {
                   4904:                     $access = 1;
                   4905:                 } elsif ($domdef{$tool}{'default'} == 0) {
                   4906:                     $access = 0;
                   4907:                 }
                   4908:                 return $access;
                   4909:             }
                   4910:         }
                   4911:     } else {
1.985     raeburn  4912:         if ($context eq 'tools') {
                   4913:             $access = 1;
                   4914:         } else {
                   4915:             $access = 0;
                   4916:         }
1.976     raeburn  4917:         return $access;
                   4918:     }
                   4919: }
                   4920: 
1.1050    raeburn  4921: sub is_course_owner {
                   4922:     my ($cdom,$cnum,$udom,$uname) = @_;
                   4923:     if (($udom eq '') || ($uname eq '')) {
                   4924:         $udom = $env{'user.domain'};
                   4925:         $uname = $env{'user.name'};
                   4926:     }
                   4927:     unless (($udom eq '') || ($uname eq '')) {
                   4928:         if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
                   4929:             if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
                   4930:                 return 1;
                   4931:             } else {
                   4932:                 my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
                   4933:                 if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
                   4934:                     return 1;
                   4935:                 }
                   4936:             }
                   4937:         }
                   4938:     }
                   4939:     return;
                   4940: }
                   4941: 
1.976     raeburn  4942: sub is_advanced_user {
                   4943:     my ($udom,$uname) = @_;
                   4944:     my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
                   4945:     my %allroles;
                   4946:     my $is_adv;
                   4947:     foreach my $role (keys(%roleshash)) {
                   4948:         my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
                   4949:         my $area = '/'.$tdomain.'/'.$trest;
                   4950:         if ($sec ne '') {
                   4951:             $area .= '/'.$sec;
                   4952:         }
                   4953:         if (($area ne '') && ($trole ne '')) {
                   4954:             my $spec=$trole.'.'.$area;
                   4955:             if ($trole =~ /^cr\//) {
                   4956:                 &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
                   4957:             } elsif ($trole ne 'gr') {
                   4958:                 &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
                   4959:             }
                   4960:         }
                   4961:     }
                   4962:     foreach my $role (keys(%allroles)) {
                   4963:         last if ($is_adv);
                   4964:         foreach my $item (split(/:/,$allroles{$role})) {
                   4965:             if ($item ne '') {
                   4966:                 my ($privilege,$restrictions)=split(/&/,$item);
                   4967:                 if ($privilege eq 'adv') {
                   4968:                     $is_adv = 1;
                   4969:                     last;
                   4970:                 }
                   4971:             }
                   4972:         }
                   4973:     }
                   4974:     return $is_adv;
                   4975: }
1.798     raeburn  4976: 
1.1035    raeburn  4977: sub check_can_request {
1.1036    raeburn  4978:     my ($dom,$can_request,$request_domains) = @_;
1.1035    raeburn  4979:     my $canreq = 0;
                   4980:     my ($types,$typename) = &Apache::loncommon::course_types();
                   4981:     my @options = ('approval','validate','autolimit');
                   4982:     my $optregex = join('|',@options);
                   4983:     if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
                   4984:         foreach my $type (@{$types}) {
                   4985:             if (&usertools_access($env{'user.name'},
                   4986:                                   $env{'user.domain'},
                   4987:                                   $type,undef,'requestcourses')) {
                   4988:                 $canreq ++;
1.1036    raeburn  4989:                 if (ref($request_domains) eq 'HASH') {
                   4990:                     push(@{$request_domains->{$type}},$env{'user.domain'});
                   4991:                 }
1.1035    raeburn  4992:                 if ($dom eq $env{'user.domain'}) {
                   4993:                     $can_request->{$type} = 1;
                   4994:                 }
                   4995:             }
                   4996:             if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
                   4997:                 my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
                   4998:                 if (@curr > 0) {
1.1036    raeburn  4999:                     foreach my $item (@curr) {
                   5000:                         if (ref($request_domains) eq 'HASH') {
                   5001:                             my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
                   5002:                             if ($otherdom ne '') {
                   5003:                                 if (ref($request_domains->{$type}) eq 'ARRAY') {
                   5004:                                     unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
                   5005:                                         push(@{$request_domains->{$type}},$otherdom);
                   5006:                                     }
                   5007:                                 } else {
                   5008:                                     push(@{$request_domains->{$type}},$otherdom);
                   5009:                                 }
                   5010:                             }
                   5011:                         }
                   5012:                     }
                   5013:                     unless($dom eq $env{'user.domain'}) {
                   5014:                         $canreq ++;
1.1035    raeburn  5015:                         if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
                   5016:                             $can_request->{$type} = 1;
                   5017:                         }
                   5018:                     }
                   5019:                 }
                   5020:             }
                   5021:         }
                   5022:     }
                   5023:     return $canreq;
                   5024: }
                   5025: 
1.341     www      5026: # ---------------------------------------------- Custom access rule evaluation
                   5027: 
                   5028: sub customaccess {
                   5029:     my ($priv,$uri)=@_;
1.807     albertel 5030:     my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819     www      5031:     my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807     albertel 5032:     $udom = &LONCAPA::clean_domain($udom);
                   5033:     $ucrs = &LONCAPA::clean_username($ucrs);
1.341     www      5034:     my $access=0;
1.800     albertel 5035:     foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893     albertel 5036: 	my ($effect,$realm,$role,$type)=split(/\:/,$right);
                   5037: 	if ($type eq 'user') {
                   5038: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896     albertel 5039: 		my ($tdom,$tuname)=split(m{/},$scope);
1.893     albertel 5040: 		if ($tdom) {
                   5041: 		    if ($tdom ne $env{'user.domain'}) { next; }
                   5042: 		}
1.896     albertel 5043: 		if ($tuname) {
                   5044: 		    if ($tuname ne $env{'user.name'}) { next; }
1.893     albertel 5045: 		}
                   5046: 		$access=($effect eq 'allow');
                   5047: 		last;
                   5048: 	    }
                   5049: 	} else {
                   5050: 	    if ($role) {
                   5051: 		if ($role ne $urole) { next; }
                   5052: 	    }
                   5053: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
                   5054: 		my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
                   5055: 		if ($tdom) {
                   5056: 		    if ($tdom ne $udom) { next; }
                   5057: 		}
                   5058: 		if ($tcrs) {
                   5059: 		    if ($tcrs ne $ucrs) { next; }
                   5060: 		}
                   5061: 		if ($tsec) {
                   5062: 		    if ($tsec ne $usec) { next; }
                   5063: 		}
                   5064: 		$access=($effect eq 'allow');
                   5065: 		last;
                   5066: 	    }
                   5067: 	    if ($realm eq '' && $role eq '') {
                   5068: 		$access=($effect eq 'allow');
                   5069: 	    }
1.402     bowersj2 5070: 	}
1.341     www      5071:     }
                   5072:     return $access;
                   5073: }
                   5074: 
1.103     harris41 5075: # ------------------------------------------------- Check for a user privilege
1.12      www      5076: 
                   5077: sub allowed {
1.810     raeburn  5078:     my ($priv,$uri,$symb,$role)=@_;
1.705     albertel 5079:     my $ver_orguri=$uri;
1.439     www      5080:     $uri=&deversion($uri);
1.152     www      5081:     my $orguri=$uri;
1.52      www      5082:     $uri=&declutter($uri);
1.809     raeburn  5083: 
1.810     raeburn  5084:     if ($priv eq 'evb') {
                   5085: # Evade communication block restrictions for specified role in a course
                   5086:         if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
                   5087:             return $1;
                   5088:         } else {
                   5089:             return;
                   5090:         }
                   5091:     }
                   5092: 
1.620     albertel 5093:     if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54      www      5094: # Free bre access to adm and meta resources
1.775     albertel 5095:     if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$})) 
1.769     albertel 5096: 	 || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 
                   5097: 	&& ($priv eq 'bre')) {
1.14      www      5098: 	return 'F';
1.159     www      5099:     }
                   5100: 
1.545     banghart 5101: # Free bre access to user's own portfolio contents
1.714     raeburn  5102:     my ($space,$domain,$name,@dir)=split('/',$uri);
1.647     raeburn  5103:     if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 
1.714     raeburn  5104: 	($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814     raeburn  5105:         my %setters;
                   5106:         my ($startblock,$endblock) = 
                   5107:             &Apache::loncommon::blockcheck(\%setters,'port');
                   5108:         if ($startblock && $endblock) {
                   5109:             return 'B';
                   5110:         } else {
                   5111:             return 'F';
                   5112:         }
1.545     banghart 5113:     }
                   5114: 
1.762     raeburn  5115: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714     raeburn  5116:     if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 
                   5117:          && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
                   5118:         if (exists($env{'request.course.id'})) {
                   5119:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   5120:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   5121:             if (($domain eq $cdom) && ($name eq $cnum)) {
                   5122:                 my $courseprivid=$env{'request.course.id'};
                   5123:                 $courseprivid=~s/\_/\//;
                   5124:                 if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
                   5125:                     .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
                   5126:                     return $1; 
1.762     raeburn  5127:                 } else {
                   5128:                     if ($env{'request.course.sec'}) {
                   5129:                         $courseprivid.='/'.$env{'request.course.sec'};
                   5130:                     }
                   5131:                     if ($env{'user.priv.'.$env{'request.role'}.'./'.
                   5132:                         $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
                   5133:                         return $2;
                   5134:                     }
1.714     raeburn  5135:                 }
                   5136:             }
                   5137:         }
                   5138:     }
                   5139: 
1.159     www      5140: # Free bre to public access
                   5141: 
                   5142:     if ($priv eq 'bre') {
1.238     www      5143:         my $copyright=&metadata($uri,'copyright');
1.620     albertel 5144: 	if (($copyright eq 'public') && (!$env{'request.course.id'})) { 
1.301     www      5145:            return 'F'; 
                   5146:         }
1.238     www      5147:         if ($copyright eq 'priv') {
                   5148:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 5149: 	    unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238     www      5150: 		return '';
                   5151:             }
                   5152:         }
                   5153:         if ($copyright eq 'domain') {
                   5154:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 5155: 	    unless (($env{'user.domain'} eq $1) ||
                   5156:                  ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238     www      5157: 		return '';
                   5158:             }
1.262     matthew  5159:         }
1.620     albertel 5160:         if ($env{'request.role'}=~ /li\.\//) {
1.262     matthew  5161:             # Library role, so allow browsing of resources in this domain.
                   5162:             return 'F';
1.238     www      5163:         }
1.341     www      5164:         if ($copyright eq 'custom') {
                   5165: 	    unless (&customaccess($priv,$uri)) { return ''; }
                   5166:         }
1.14      www      5167:     }
1.264     matthew  5168:     # Domain coordinator is trying to create a course
1.620     albertel 5169:     if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264     matthew  5170:         # uri is the requested domain in this case.
                   5171:         # comparison to 'request.role.domain' shows if the user has selected
1.678     raeburn  5172:         # a role of dc for the domain in question.
1.620     albertel 5173:         return 'F' if ($uri eq $env{'request.role.domain'});
1.264     matthew  5174:     }
1.29      www      5175: 
1.52      www      5176:     my $thisallowed='';
                   5177:     my $statecond=0;
                   5178:     my $courseprivid='';
                   5179: 
1.1039    raeburn  5180:     my $ownaccess;
1.1043    raeburn  5181:     # Community Coordinator or Assistant Co-author browsing resource space.
1.1039    raeburn  5182:     if (($priv eq 'bro') && ($env{'user.author'})) {
                   5183:         if ($uri eq '') {
                   5184:             $ownaccess = 1;
                   5185:         } else {
                   5186:             if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   5187:                 my $udom = $env{'user.domain'};
                   5188:                 my $uname = $env{'user.name'};
                   5189:                 if ($uri =~ m{^\Q$udom\E/?$}) {
                   5190:                     $ownaccess = 1;
1.1040    raeburn  5191:                 } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039    raeburn  5192:                     unless ($uri =~ m{\.\./}) {
                   5193:                         $ownaccess = 1;
                   5194:                     }
                   5195:                 } elsif (($udom ne 'public') && ($uname ne 'public')) {
                   5196:                     my $now = time;
                   5197:                     if ($uri =~ m{^([^/]+)/?$}) {
                   5198:                         my $adom = $1;
                   5199:                         foreach my $key (keys(%env)) {
1.1042    raeburn  5200:                             if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039    raeburn  5201:                                 my ($start,$end) = split('.',$env{$key});
                   5202:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   5203:                                     $ownaccess = 1;
                   5204:                                     last;
                   5205:                                 }
                   5206:                             }
                   5207:                         }
                   5208:                     } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
                   5209:                         my $adom = $1;
                   5210:                         my $aname = $2;
1.1042    raeburn  5211:                         foreach my $role ('ca','aa') { 
                   5212:                             if ($env{"user.role.$role./$adom/$aname"}) {
                   5213:                                 my ($start,$end) =
                   5214:                                     split('.',$env{"user.role.$role./$adom/$aname"});
                   5215:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   5216:                                     $ownaccess = 1;
                   5217:                                     last;
                   5218:                                 }
1.1039    raeburn  5219:                             }
                   5220:                         }
                   5221:                     }
                   5222:                 }
                   5223:             }
                   5224:         }
                   5225:     }
                   5226: 
1.52      www      5227: # Course
                   5228: 
1.620     albertel 5229:     if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  5230:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  5231:             $thisallowed.=$1;
                   5232:         }
1.52      www      5233:     }
1.29      www      5234: 
1.52      www      5235: # Domain
                   5236: 
1.620     albertel 5237:     if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479     albertel 5238:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  5239:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  5240:             $thisallowed.=$1;
                   5241:         }
1.12      www      5242:     }
1.52      www      5243: 
                   5244: # Course: uri itself is a course
1.66      www      5245:     my $courseuri=$uri;
                   5246:     $courseuri=~s/\_(\d)/\/$1/;
1.83      www      5247:     $courseuri=~s/^([^\/])/\/$1/;
1.81      www      5248: 
1.620     albertel 5249:     if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479     albertel 5250:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  5251:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  5252:             $thisallowed.=$1;
                   5253:         }
1.12      www      5254:     }
1.29      www      5255: 
1.665     albertel 5256: # URI is an uploaded document for this course, default permissions don't matter
1.611     albertel 5257: # not allowing 'edit' access (editupload) to uploaded course docs
1.492     albertel 5258:     if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665     albertel 5259: 	$thisallowed='';
1.671     raeburn  5260:         my ($match)=&is_on_map($uri);
                   5261:         if ($match) {
                   5262:             if ($env{'user.priv.'.$env{'request.role'}.'./'}
                   5263:                   =~/\Q$priv\E\&([^\:]*)/) {
                   5264:                 $thisallowed.=$1;
                   5265:             }
                   5266:         } else {
1.705     albertel 5267:             my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671     raeburn  5268:             if ($refuri) {
                   5269:                 if ($refuri =~ m|^/adm/|) {
1.669     raeburn  5270:                     $thisallowed='F';
1.671     raeburn  5271:                 } else {
                   5272:                     $refuri=&declutter($refuri);
                   5273:                     my ($match) = &is_on_map($refuri);
                   5274:                     if ($match) {
                   5275:                         $thisallowed='F';
                   5276:                     }
1.669     raeburn  5277:                 }
1.671     raeburn  5278:             }
                   5279:         }
1.314     www      5280:     }
1.492     albertel 5281: 
1.766     albertel 5282:     if ($priv eq 'bre'
                   5283: 	&& $thisallowed ne 'F' 
                   5284: 	&& $thisallowed ne '2'
                   5285: 	&& &is_portfolio_url($uri)) {
                   5286: 	$thisallowed = &portfolio_access($uri);
                   5287:     }
                   5288:     
1.52      www      5289: # Full access at system, domain or course-wide level? Exit.
1.29      www      5290:     if ($thisallowed=~/F/) {
                   5291: 	return 'F';
                   5292:     }
                   5293: 
1.52      www      5294: # If this is generating or modifying users, exit with special codes
1.29      www      5295: 
1.643     www      5296:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
                   5297: 	if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642     albertel 5298: 	    my ($audom,$auname)=split('/',$uri);
1.643     www      5299: # no author name given, so this just checks on the general right to make a co-author in this domain
                   5300: 	    unless ($auname) { return $thisallowed; }
                   5301: # an author name is given, so we are about to actually make a co-author for a certain account
1.642     albertel 5302: 	    if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
                   5303: 		(($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
                   5304: 		 ($audom ne $env{'request.role.domain'}))) { return ''; }
                   5305: 	}
1.52      www      5306: 	return $thisallowed;
                   5307:     }
                   5308: #
1.103     harris41 5309: # Gathered so far: system, domain and course wide privileges
1.52      www      5310: #
                   5311: # Course: See if uri or referer is an individual resource that is part of 
                   5312: # the course
                   5313: 
1.620     albertel 5314:     if ($env{'request.course.id'}) {
1.232     www      5315: 
1.620     albertel 5316:        $courseprivid=$env{'request.course.id'};
                   5317:        if ($env{'request.course.sec'}) {
                   5318:           $courseprivid.='/'.$env{'request.course.sec'};
1.52      www      5319:        }
                   5320:        $courseprivid=~s/\_/\//;
                   5321:        my $checkreferer=1;
1.232     www      5322:        my ($match,$cond)=&is_on_map($uri);
                   5323:        if ($match) {
                   5324:            $statecond=$cond;
1.620     albertel 5325:            if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 5326:                =~/\Q$priv\E\&([^\:]*)/) {
1.52      www      5327:                $thisallowed.=$1;
                   5328:                $checkreferer=0;
                   5329:            }
1.29      www      5330:        }
1.83      www      5331:        
1.148     www      5332:        if ($checkreferer) {
1.620     albertel 5333: 	  my $refuri=$env{'httpref.'.$orguri};
1.148     www      5334:             unless ($refuri) {
1.800     albertel 5335:                 foreach my $key (keys(%env)) {
                   5336: 		    if ($key=~/^httpref\..*\*/) {
                   5337: 			my $pattern=$key;
1.156     www      5338:                         $pattern=~s/^httpref\.\/res\///;
1.148     www      5339:                         $pattern=~s/\*/\[\^\/\]\+/g;
                   5340:                         $pattern=~s/\//\\\//g;
1.152     www      5341:                         if ($orguri=~/$pattern/) {
1.800     albertel 5342: 			    $refuri=$env{$key};
1.148     www      5343:                         }
                   5344:                     }
1.191     harris41 5345:                 }
1.148     www      5346:             }
1.232     www      5347: 
1.148     www      5348:          if ($refuri) { 
1.152     www      5349: 	  $refuri=&declutter($refuri);
1.232     www      5350:           my ($match,$cond)=&is_on_map($refuri);
                   5351:             if ($match) {
                   5352:               my $refstatecond=$cond;
1.620     albertel 5353:               if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 5354:                   =~/\Q$priv\E\&([^\:]*)/) {
1.52      www      5355:                   $thisallowed.=$1;
1.53      www      5356:                   $uri=$refuri;
                   5357:                   $statecond=$refstatecond;
1.52      www      5358:               }
                   5359:           }
1.148     www      5360:         }
1.29      www      5361:        }
1.52      www      5362:    }
1.29      www      5363: 
1.52      www      5364: #
1.103     harris41 5365: # Gathered now: all privileges that could apply, and condition number
1.52      www      5366: # 
                   5367: #
                   5368: # Full or no access?
                   5369: #
1.29      www      5370: 
1.52      www      5371:     if ($thisallowed=~/F/) {
                   5372: 	return 'F';
                   5373:     }
1.29      www      5374: 
1.52      www      5375:     unless ($thisallowed) {
                   5376:         return '';
                   5377:     }
1.29      www      5378: 
1.52      www      5379: # Restrictions exist, deal with them
                   5380: #
                   5381: #   C:according to course preferences
                   5382: #   R:according to resource settings
                   5383: #   L:unless locked
                   5384: #   X:according to user session state
                   5385: #
                   5386: 
                   5387: # Possibly locked functionality, check all courses
1.54      www      5388: # Locks might take effect only after 10 minutes cache expiration for other
                   5389: # courses, and 2 minutes for current course
1.52      www      5390: 
                   5391:     my $envkey;
                   5392:     if ($thisallowed=~/L/) {
1.1000    raeburn  5393:         foreach $envkey (keys(%env)) {
1.54      www      5394:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
                   5395:                my $courseid=$2;
                   5396:                my $roleid=$1.'.'.$2;
1.92      www      5397:                $courseid=~s/^\///;
1.54      www      5398:                my $expiretime=600;
1.620     albertel 5399:                if ($env{'request.role'} eq $roleid) {
1.54      www      5400: 		  $expiretime=120;
                   5401:                }
                   5402: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
                   5403:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620     albertel 5404:                if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731     albertel 5405: 		   &coursedescription($courseid,{'freshen_cache' => 1});
1.54      www      5406:                }
1.620     albertel 5407:                if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   5408:                 || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
                   5409: 		   if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
                   5410:                        &log($env{'user.domain'},$env{'user.name'},
                   5411:                             $env{'user.home'},
1.57      www      5412:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52      www      5413:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 5414:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      5415: 		       return '';
                   5416:                    }
                   5417:                }
1.620     albertel 5418:                if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   5419:                 || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
                   5420: 		   if ($env{'priv.'.$priv.'.lock.expire'}>time) {
                   5421:                        &log($env{'user.domain'},$env{'user.name'},
                   5422:                             $env{'user.home'},
1.57      www      5423:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52      www      5424:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 5425:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      5426: 		       return '';
                   5427:                    }
                   5428:                }
                   5429: 	   }
1.29      www      5430:        }
1.52      www      5431:     }
                   5432:    
                   5433: #
                   5434: # Rest of the restrictions depend on selected course
                   5435: #
                   5436: 
1.620     albertel 5437:     unless ($env{'request.course.id'}) {
1.766     albertel 5438: 	if ($thisallowed eq 'A') {
                   5439: 	    return 'A';
1.814     raeburn  5440:         } elsif ($thisallowed eq 'B') {
                   5441:             return 'B';
1.766     albertel 5442: 	} else {
                   5443: 	    return '1';
                   5444: 	}
1.52      www      5445:     }
1.29      www      5446: 
1.52      www      5447: #
                   5448: # Now user is definitely in a course
                   5449: #
1.53      www      5450: 
                   5451: 
                   5452: # Course preferences
                   5453: 
                   5454:    if ($thisallowed=~/C/) {
1.620     albertel 5455:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
                   5456:        my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
                   5457:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479     albertel 5458: 	   =~/\Q$rolecode\E/) {
1.689     albertel 5459: 	   if ($priv ne 'pch') { 
                   5460: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   5461: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
                   5462: 			$env{'request.course.id'});
                   5463: 	   }
1.237     www      5464:            return '';
                   5465:        }
                   5466: 
1.620     albertel 5467:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479     albertel 5468: 	   =~/\Q$unamedom\E/) {
1.689     albertel 5469: 	   if ($priv ne 'pch') { 
                   5470: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
                   5471: 			'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
                   5472: 			$env{'request.course.id'});
                   5473: 	   }
1.54      www      5474:            return '';
                   5475:        }
1.53      www      5476:    }
                   5477: 
                   5478: # Resource preferences
                   5479: 
                   5480:    if ($thisallowed=~/R/) {
1.620     albertel 5481:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479     albertel 5482:        if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689     albertel 5483: 	   if ($priv ne 'pch') { 
                   5484: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   5485: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
                   5486: 	   }
                   5487: 	   return '';
1.54      www      5488:        }
1.53      www      5489:    }
1.30      www      5490: 
1.246     www      5491: # Restricted by state or randomout?
1.30      www      5492: 
1.52      www      5493:    if ($thisallowed=~/X/) {
1.620     albertel 5494:       if ($env{'acc.randomout'}) {
1.579     albertel 5495: 	 if (!$symb) { $symb=&symbread($uri,1); }
1.620     albertel 5496:          if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 
1.248     www      5497:             return ''; 
                   5498:          }
1.247     www      5499:       }
                   5500:       if (&condval($statecond)) {
1.52      www      5501: 	 return '2';
                   5502:       } else {
                   5503:          return '';
                   5504:       }
                   5505:    }
1.30      www      5506: 
1.766     albertel 5507:     if ($thisallowed eq 'A') {
                   5508: 	return 'A';
1.814     raeburn  5509:     } elsif ($thisallowed eq 'B') {
                   5510:         return 'B';
1.766     albertel 5511:     }
1.52      www      5512:    return 'F';
1.232     www      5513: }
                   5514: 
1.710     albertel 5515: sub split_uri_for_cond {
                   5516:     my $uri=&deversion(&declutter(shift));
                   5517:     my @uriparts=split(/\//,$uri);
                   5518:     my $filename=pop(@uriparts);
                   5519:     my $pathname=join('/',@uriparts);
                   5520:     return ($pathname,$filename);
                   5521: }
1.232     www      5522: # --------------------------------------------------- Is a resource on the map?
                   5523: 
                   5524: sub is_on_map {
1.710     albertel 5525:     my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289     bowersj2 5526:     #Trying to find the conditional for the file
1.620     albertel 5527:     my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289     bowersj2 5528: 	       /\&\Q$filename\E\:([\d\|]+)\&/);
1.232     www      5529:     if ($match) {
1.289     bowersj2 5530: 	return (1,$1);
                   5531:     } else {
1.434     www      5532: 	return (0,0);
1.289     bowersj2 5533:     }
1.12      www      5534: }
                   5535: 
1.427     www      5536: # --------------------------------------------------------- Get symb from alias
                   5537: 
                   5538: sub get_symb_from_alias {
                   5539:     my $symb=shift;
                   5540:     my ($map,$resid,$url)=&decode_symb($symb);
                   5541: # Already is a symb
                   5542:     if ($url) { return $symb; }
                   5543: # Must be an alias
                   5544:     my $aliassymb='';
                   5545:     my %bighash;
1.620     albertel 5546:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427     www      5547:                             &GDBM_READER(),0640)) {
                   5548:         my $rid=$bighash{'mapalias_'.$symb};
                   5549: 	if ($rid) {
                   5550: 	    my ($mapid,$resid)=split(/\./,$rid);
1.429     albertel 5551: 	    $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
                   5552: 				    $resid,$bighash{'src_'.$rid});
1.427     www      5553: 	}
                   5554:         untie %bighash;
                   5555:     }
                   5556:     return $aliassymb;
                   5557: }
                   5558: 
1.12      www      5559: # ----------------------------------------------------------------- Define Role
                   5560: 
                   5561: sub definerole {
                   5562:   if (allowed('mcr','/')) {
                   5563:     my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800     albertel 5564:     foreach my $role (split(':',$sysrole)) {
                   5565: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 5566:         if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
                   5567:         if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
                   5568: 	    if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      5569:                return "refused:s:$crole&$cqual"; 
                   5570:             }
                   5571:         }
1.191     harris41 5572:     }
1.800     albertel 5573:     foreach my $role (split(':',$domrole)) {
                   5574: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 5575:         if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
                   5576:         if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
                   5577: 	    if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 
1.21      www      5578:                return "refused:d:$crole&$cqual"; 
                   5579:             }
                   5580:         }
1.191     harris41 5581:     }
1.800     albertel 5582:     foreach my $role (split(':',$courole)) {
                   5583: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 5584:         if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
                   5585:         if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
                   5586: 	    if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      5587:                return "refused:c:$crole&$cqual"; 
                   5588:             }
                   5589:         }
1.191     harris41 5590:     }
1.620     albertel 5591:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
                   5592:                 "$env{'user.domain'}:$env{'user.name'}:".
1.21      www      5593: 	        "rolesdef_$rolename=".
                   5594:                 escape($sysrole.'_'.$domrole.'_'.$courole);
1.620     albertel 5595:     return reply($command,$env{'user.home'});
1.12      www      5596:   } else {
                   5597:     return 'refused';
                   5598:   }
1.105     harris41 5599: }
                   5600: 
                   5601: # ---------------- Make a metadata query against the network of library servers
                   5602: 
                   5603: sub metadata_query {
1.244     matthew  5604:     my ($query,$custom,$customshow,$server_array)=@_;
1.120     harris41 5605:     my %rhash;
1.845     albertel 5606:     my %libserv = &all_library();
1.244     matthew  5607:     my @server_list = (defined($server_array) ? @$server_array
                   5608:                                               : keys(%libserv) );
                   5609:     for my $server (@server_list) {
1.118     harris41 5610: 	unless ($custom or $customshow) {
                   5611: 	    my $reply=&reply("querysend:".&escape($query),$server);
                   5612: 	    $rhash{$server}=$reply;
                   5613: 	}
                   5614: 	else {
                   5615: 	    my $reply=&reply("querysend:".&escape($query).':'.
                   5616: 			     &escape($custom).':'.&escape($customshow),
                   5617: 			     $server);
                   5618: 	    $rhash{$server}=$reply;
                   5619: 	}
1.112     harris41 5620:     }
1.118     harris41 5621:     return \%rhash;
1.240     www      5622: }
                   5623: 
                   5624: # ----------------------------------------- Send log queries and wait for reply
                   5625: 
                   5626: sub log_query {
                   5627:     my ($uname,$udom,$query,%filters)=@_;
                   5628:     my $uhome=&homeserver($uname,$udom);
                   5629:     if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838     albertel 5630:     my $uhost=&hostname($uhome);
1.800     albertel 5631:     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240     www      5632:     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
                   5633:                        $uhome);
1.479     albertel 5634:     unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242     www      5635:     return get_query_reply($queryid);
                   5636: }
                   5637: 
1.818     raeburn  5638: # -------------------------- Update MySQL table for portfolio file
                   5639: 
                   5640: sub update_portfolio_table {
1.821     raeburn  5641:     my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970     raeburn  5642:     if ($group ne '') {
                   5643:         $file_name =~s /^\Q$group\E//;
                   5644:     }
1.818     raeburn  5645:     my $homeserver = &homeserver($uname,$udom);
                   5646:     my $queryid=
1.821     raeburn  5647:         &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
                   5648:                ':'.&escape($file_name).':'.$action,$homeserver);
1.818     raeburn  5649:     my $reply = &get_query_reply($queryid);
                   5650:     return $reply;
                   5651: }
                   5652: 
1.899     raeburn  5653: # -------------------------- Update MySQL allusers table
                   5654: 
                   5655: sub update_allusers_table {
                   5656:     my ($uname,$udom,$names) = @_;
                   5657:     my $homeserver = &homeserver($uname,$udom);
                   5658:     my $queryid=
                   5659:         &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
                   5660:                'lastname='.&escape($names->{'lastname'}).'%%'.
                   5661:                'firstname='.&escape($names->{'firstname'}).'%%'.
                   5662:                'middlename='.&escape($names->{'middlename'}).'%%'.
                   5663:                'generation='.&escape($names->{'generation'}).'%%'.
                   5664:                'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
                   5665:                'id='.&escape($names->{'id'}),$homeserver);
1.1056.2.6  raeburn  5666:     return;
1.899     raeburn  5667: }
                   5668: 
1.508     raeburn  5669: # ------- Request retrieval of institutional classlists for course(s)
1.506     raeburn  5670: 
                   5671: sub fetch_enrollment_query {
1.511     raeburn  5672:     my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508     raeburn  5673:     my $homeserver;
1.547     raeburn  5674:     my $maxtries = 1;
1.508     raeburn  5675:     if ($context eq 'automated') {
                   5676:         $homeserver = $perlvar{'lonHostID'};
1.547     raeburn  5677:         $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508     raeburn  5678:     } else {
                   5679:         $homeserver = &homeserver($cnum,$dom);
                   5680:     }
1.838     albertel 5681:     my $host=&hostname($homeserver);
1.506     raeburn  5682:     my $cmd = '';
1.1000    raeburn  5683:     foreach my $affiliate (keys(%{$affiliatesref})) {
1.800     albertel 5684:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506     raeburn  5685:     }
                   5686:     $cmd =~ s/%%$//;
                   5687:     $cmd = &escape($cmd);
                   5688:     my $query = 'fetchenrollment';
1.620     albertel 5689:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526     raeburn  5690:     unless ($queryid=~/^\Q$host\E\_/) { 
                   5691:         &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 
                   5692:         return 'error: '.$queryid;
                   5693:     }
1.506     raeburn  5694:     my $reply = &get_query_reply($queryid);
1.547     raeburn  5695:     my $tries = 1;
                   5696:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   5697:         $reply = &get_query_reply($queryid);
                   5698:         $tries ++;
                   5699:     }
1.526     raeburn  5700:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620     albertel 5701:         &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526     raeburn  5702:     } else {
1.901     albertel 5703:         my @responses = split(/:/,$reply);
1.515     raeburn  5704:         if ($homeserver eq $perlvar{'lonHostID'}) {
1.800     albertel 5705:             foreach my $line (@responses) {
                   5706:                 my ($key,$value) = split(/=/,$line,2);
1.515     raeburn  5707:                 $$replyref{$key} = $value;
                   5708:             }
                   5709:         } else {
1.506     raeburn  5710:             my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800     albertel 5711:             foreach my $line (@responses) {
                   5712:                 my ($key,$value) = split(/=/,$line);
1.506     raeburn  5713:                 $$replyref{$key} = $value;
                   5714:                 if ($value > 0) {
1.800     albertel 5715:                     foreach my $item (@{$$affiliatesref{$key}}) {
                   5716:                         my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506     raeburn  5717:                         my $destname = $pathname.'/'.$filename;
                   5718:                         my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526     raeburn  5719:                         if ($xml_classlist =~ /^error/) {
                   5720:                             &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
                   5721:                         } else {
1.506     raeburn  5722:                             if ( open(FILE,">$destname") ) {
                   5723:                                 print FILE &unescape($xml_classlist);
                   5724:                                 close(FILE);
1.526     raeburn  5725:                             } else {
                   5726:                                 &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506     raeburn  5727:                             }
                   5728:                         }
                   5729:                     }
                   5730:                 }
                   5731:             }
                   5732:         }
                   5733:         return 'ok';
                   5734:     }
                   5735:     return 'error';
                   5736: }
                   5737: 
1.242     www      5738: sub get_query_reply {
                   5739:     my $queryid=shift;
1.240     www      5740:     my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
                   5741:     my $reply='';
                   5742:     for (1..100) {
                   5743: 	sleep 2;
                   5744:         if (-e $replyfile.'.end') {
1.448     albertel 5745: 	    if (open(my $fh,$replyfile)) {
1.904     albertel 5746: 		$reply = join('',<$fh>);
                   5747: 		close($fh);
1.240     www      5748: 	   } else { return 'error: reply_file_error'; }
1.242     www      5749:            return &unescape($reply);
                   5750: 	}
1.240     www      5751:     }
1.242     www      5752:     return 'timeout:'.$queryid;
1.240     www      5753: }
                   5754: 
                   5755: sub courselog_query {
1.241     www      5756: #
                   5757: # possible filters:
                   5758: # url: url or symb
                   5759: # username
                   5760: # domain
                   5761: # action: view, submit, grade
                   5762: # start: timestamp
                   5763: # end: timestamp
                   5764: #
1.240     www      5765:     my (%filters)=@_;
1.620     albertel 5766:     unless ($env{'request.course.id'}) { return 'no_course'; }
1.241     www      5767:     if ($filters{'url'}) {
                   5768: 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
                   5769:         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
                   5770:         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
                   5771:     }
1.620     albertel 5772:     my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   5773:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240     www      5774:     return &log_query($cname,$cdom,'courselog',%filters);
                   5775: }
                   5776: 
                   5777: sub userlog_query {
1.858     raeburn  5778: #
                   5779: # possible filters:
                   5780: # action: log check role
                   5781: # start: timestamp
                   5782: # end: timestamp
                   5783: #
1.240     www      5784:     my ($uname,$udom,%filters)=@_;
                   5785:     return &log_query($uname,$udom,'userlog',%filters);
1.12      www      5786: }
                   5787: 
1.506     raeburn  5788: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 
                   5789: 
                   5790: sub auto_run {
1.508     raeburn  5791:     my ($cnum,$cdom) = @_;
1.876     raeburn  5792:     my $response = 0;
                   5793:     my $settings;
                   5794:     my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
                   5795:     if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5796:         $settings = $domconfig{'autoenroll'};
                   5797:         if ($settings->{'run'} eq '1') {
                   5798:             $response = 1;
                   5799:         }
                   5800:     } else {
1.934     raeburn  5801:         my $homeserver;
                   5802:         if (&is_course($cdom,$cnum)) {
                   5803:             $homeserver = &homeserver($cnum,$cdom);
                   5804:         } else {
                   5805:             $homeserver = &domain($cdom,'primary');
                   5806:         }
                   5807:         if ($homeserver ne 'no_host') {
                   5808:             $response = &reply('autorun:'.$cdom,$homeserver);
                   5809:         }
1.876     raeburn  5810:     }
1.506     raeburn  5811:     return $response;
                   5812: }
1.776     albertel 5813: 
1.506     raeburn  5814: sub auto_get_sections {
1.508     raeburn  5815:     my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007    raeburn  5816:     my $homeserver;
                   5817:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 
                   5818:         $homeserver = &homeserver($cnum,$cdom);
                   5819:     }
                   5820:     if (!defined($homeserver)) { 
                   5821:         if ($cdom =~ /^$match_domain$/) {
                   5822:             $homeserver = &domain($cdom,'primary');
                   5823:         }
                   5824:     }
                   5825:     my @secs;
                   5826:     if (defined($homeserver)) {
                   5827:         my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
                   5828:         unless ($response eq 'refused') {
                   5829:             @secs = split(/:/,$response);
                   5830:         }
1.506     raeburn  5831:     }
                   5832:     return @secs;
                   5833: }
1.776     albertel 5834: 
1.506     raeburn  5835: sub auto_new_course {
1.508     raeburn  5836:     my ($cnum,$cdom,$inst_course_id,$owner) = @_;
                   5837:     my $homeserver = &homeserver($cnum,$cdom);
1.515     raeburn  5838:     my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506     raeburn  5839:     return $response;
                   5840: }
1.776     albertel 5841: 
1.506     raeburn  5842: sub auto_validate_courseID {
1.508     raeburn  5843:     my ($cnum,$cdom,$inst_course_id) = @_;
                   5844:     my $homeserver = &homeserver($cnum,$cdom);
1.511     raeburn  5845:     my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506     raeburn  5846:     return $response;
                   5847: }
1.776     albertel 5848: 
1.1007    raeburn  5849: sub auto_validate_instcode {
1.1020    raeburn  5850:     my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007    raeburn  5851:     my ($homeserver,$response);
                   5852:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   5853:         $homeserver = &homeserver($cnum,$cdom);
                   5854:     }
                   5855:     if (!defined($homeserver)) {
                   5856:         if ($cdom =~ /^$match_domain$/) {
                   5857:             $homeserver = &domain($cdom,'primary');
                   5858:         }
                   5859:     }
1.1056.2.4  raeburn  5860:     $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
                   5861:                         &escape($instcode).':'.&escape($owner),$homeserver));
1.1027    raeburn  5862:     my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
                   5863:     return ($outcome,$description);
1.1007    raeburn  5864: }
                   5865: 
1.506     raeburn  5866: sub auto_create_password {
1.873     raeburn  5867:     my ($cnum,$cdom,$authparam,$udom) = @_;
                   5868:     my ($homeserver,$response);
1.506     raeburn  5869:     my $create_passwd = 0;
                   5870:     my $authchk = '';
1.873     raeburn  5871:     if ($udom =~ /^$match_domain$/) {
                   5872:         $homeserver = &domain($udom,'primary');
                   5873:     }
                   5874:     if ($homeserver eq '') {
                   5875:         if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   5876:             $homeserver = &homeserver($cnum,$cdom);
                   5877:         }
                   5878:     }
                   5879:     if ($homeserver eq '') {
                   5880:         $authchk = 'nodomain';
1.506     raeburn  5881:     } else {
1.873     raeburn  5882:         $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
                   5883:         if ($response eq 'refused') {
                   5884:             $authchk = 'refused';
                   5885:         } else {
1.901     albertel 5886:             ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873     raeburn  5887:         }
1.506     raeburn  5888:     }
                   5889:     return ($authparam,$create_passwd,$authchk);
                   5890: }
                   5891: 
1.706     raeburn  5892: sub auto_photo_permission {
                   5893:     my ($cnum,$cdom,$students) = @_;
                   5894:     my $homeserver = &homeserver($cnum,$cdom);
1.707     albertel 5895:     my ($outcome,$perm_reqd,$conditions) = 
                   5896: 	split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709     albertel 5897:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   5898: 	return (undef,undef);
                   5899:     }
1.706     raeburn  5900:     return ($outcome,$perm_reqd,$conditions);
                   5901: }
                   5902: 
                   5903: sub auto_checkphotos {
                   5904:     my ($uname,$udom,$pid) = @_;
                   5905:     my $homeserver = &homeserver($uname,$udom);
                   5906:     my ($result,$resulttype);
                   5907:     my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707     albertel 5908: 				   &escape($uname).':'.&escape($pid),
                   5909: 				   $homeserver));
1.709     albertel 5910:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   5911: 	return (undef,undef);
                   5912:     }
1.706     raeburn  5913:     if ($outcome) {
                   5914:         ($result,$resulttype) = split(/:/,$outcome);
                   5915:     } 
                   5916:     return ($result,$resulttype);
                   5917: }
                   5918: 
                   5919: sub auto_photochoice {
                   5920:     my ($cnum,$cdom) = @_;
                   5921:     my $homeserver = &homeserver($cnum,$cdom);
                   5922:     my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707     albertel 5923: 						       &escape($cdom),
                   5924: 						       $homeserver)));
1.709     albertel 5925:     if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   5926: 	return (undef,undef);
                   5927:     }
1.706     raeburn  5928:     return ($update,$comment);
                   5929: }
                   5930: 
                   5931: sub auto_photoupdate {
                   5932:     my ($affiliatesref,$dom,$cnum,$photo) = @_;
                   5933:     my $homeserver = &homeserver($cnum,$dom);
1.838     albertel 5934:     my $host=&hostname($homeserver);
1.706     raeburn  5935:     my $cmd = '';
                   5936:     my $maxtries = 1;
1.800     albertel 5937:     foreach my $affiliate (keys(%{$affiliatesref})) {
                   5938:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706     raeburn  5939:     }
                   5940:     $cmd =~ s/%%$//;
                   5941:     $cmd = &escape($cmd);
                   5942:     my $query = 'institutionalphotos';
                   5943:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
                   5944:     unless ($queryid=~/^\Q$host\E\_/) {
                   5945:         &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
                   5946:         return 'error: '.$queryid;
                   5947:     }
                   5948:     my $reply = &get_query_reply($queryid);
                   5949:     my $tries = 1;
                   5950:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   5951:         $reply = &get_query_reply($queryid);
                   5952:         $tries ++;
                   5953:     }
                   5954:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   5955:         &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
                   5956:     } else {
                   5957:         my @responses = split(/:/,$reply);
                   5958:         my $outcome = shift(@responses); 
                   5959:         foreach my $item (@responses) {
                   5960:             my ($key,$value) = split(/=/,$item);
                   5961:             $$photo{$key} = $value;
                   5962:         }
                   5963:         return $outcome;
                   5964:     }
                   5965:     return 'error';
                   5966: }
                   5967: 
1.521     raeburn  5968: sub auto_instcode_format {
1.793     albertel 5969:     my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
                   5970: 	$cat_order) = @_;
1.521     raeburn  5971:     my $courses = '';
1.772     raeburn  5972:     my @homeservers;
1.521     raeburn  5973:     if ($caller eq 'global') {
1.841     albertel 5974: 	my %servers = &get_servers($codedom,'library');
                   5975: 	foreach my $tryserver (keys(%servers)) {
                   5976: 	    if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   5977: 		push(@homeservers,$tryserver);
                   5978: 	    }
1.584     raeburn  5979:         }
1.1022    raeburn  5980:     } elsif ($caller eq 'requests') {
                   5981:         if ($codedom =~ /^$match_domain$/) {
                   5982:             my $chome = &domain($codedom,'primary');
                   5983:             unless ($chome eq 'no_host') {
                   5984:                 push(@homeservers,$chome);
                   5985:             }
                   5986:         }
1.521     raeburn  5987:     } else {
1.772     raeburn  5988:         push(@homeservers,&homeserver($caller,$codedom));
1.521     raeburn  5989:     }
1.793     albertel 5990:     foreach my $code (keys(%{$instcodes})) {
                   5991:         $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521     raeburn  5992:     }
                   5993:     chop($courses);
1.772     raeburn  5994:     my $ok_response = 0;
                   5995:     my $response;
                   5996:     while (@homeservers > 0 && $ok_response == 0) {
                   5997:         my $server = shift(@homeservers); 
                   5998:         $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
                   5999:         if ($response !~ /(con_lost|error|no_such_host|refused)/) {
                   6000:             my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 
1.901     albertel 6001: 		split(/:/,$response);
1.772     raeburn  6002:             %{$codes} = (%{$codes},&str2hash($codes_str));
                   6003:             push(@{$codetitles},&str2array($codetitles_str));
                   6004:             %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
                   6005:             %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
                   6006:             $ok_response = 1;
                   6007:         }
                   6008:     }
                   6009:     if ($ok_response) {
1.521     raeburn  6010:         return 'ok';
1.772     raeburn  6011:     } else {
                   6012:         return $response;
1.521     raeburn  6013:     }
                   6014: }
                   6015: 
1.792     raeburn  6016: sub auto_instcode_defaults {
                   6017:     my ($domain,$returnhash,$code_order) = @_;
                   6018:     my @homeservers;
1.841     albertel 6019: 
                   6020:     my %servers = &get_servers($domain,'library');
                   6021:     foreach my $tryserver (keys(%servers)) {
                   6022: 	if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   6023: 	    push(@homeservers,$tryserver);
                   6024: 	}
1.792     raeburn  6025:     }
1.841     albertel 6026: 
1.792     raeburn  6027:     my $response;
1.841     albertel 6028:     foreach my $server (@homeservers) {
1.792     raeburn  6029:         $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841     albertel 6030:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
                   6031: 	
                   6032: 	foreach my $pair (split(/\&/,$response)) {
                   6033: 	    my ($name,$value)=split(/\=/,$pair);
                   6034: 	    if ($name eq 'code_order') {
                   6035: 		@{$code_order} = split(/\&/,&unescape($value));
                   6036: 	    } else {
                   6037: 		$returnhash->{&unescape($name)}=&unescape($value);
                   6038: 	    }
                   6039: 	}
                   6040: 	return 'ok';
1.792     raeburn  6041:     }
1.841     albertel 6042: 
                   6043:     return $response;
1.1003    raeburn  6044: }
                   6045: 
                   6046: sub auto_possible_instcodes {
1.1007    raeburn  6047:     my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
                   6048:     unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 
                   6049:             (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
                   6050:         return;
                   6051:     }
1.1003    raeburn  6052:     my (@homeservers,$uhome);
                   6053:     if (defined(&domain($domain,'primary'))) {
                   6054:         $uhome=&domain($domain,'primary');
                   6055:         push(@homeservers,&domain($domain,'primary'));
                   6056:     } else {
                   6057:         my %servers = &get_servers($domain,'library');
                   6058:         foreach my $tryserver (keys(%servers)) {
                   6059:             if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   6060:                 push(@homeservers,$tryserver);
                   6061:             }
                   6062:         }
                   6063:     }
                   6064:     my $response;
                   6065:     foreach my $server (@homeservers) {
                   6066:         $response=&reply('autopossibleinstcodes:'.$domain,$server);
                   6067:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007    raeburn  6068:         my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 
                   6069:             split(':',$response);
                   6070:         @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
                   6071:         @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003    raeburn  6072:         foreach my $item (split('&',$cat_title)) {   
1.1005    raeburn  6073:             my ($name,$value)=split('=',$item);
                   6074:             $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  6075:         }
                   6076:         foreach my $item (split('&',$cat_order)) {
1.1005    raeburn  6077:             my ($name,$value)=split('=',$item);
                   6078:             $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  6079:         }
                   6080:         return 'ok';
                   6081:     }
                   6082:     return $response;
                   6083: }
1.792     raeburn  6084: 
1.1010    raeburn  6085: sub auto_courserequest_checks {
                   6086:     my ($dom) = @_;
1.1020    raeburn  6087:     my ($homeserver,%validations);
                   6088:     if ($dom =~ /^$match_domain$/) {
                   6089:         $homeserver = &domain($dom,'primary');
                   6090:     }
                   6091:     unless ($homeserver eq 'no_host') {
                   6092:         my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
                   6093:         unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
                   6094:             my @items = split(/&/,$response);
                   6095:             foreach my $item (@items) {
                   6096:                 my ($key,$value) = split('=',$item);
                   6097:                 $validations{&unescape($key)} = &thaw_unescape($value);
                   6098:             }
                   6099:         }
                   6100:     }
1.1010    raeburn  6101:     return %validations; 
                   6102: }
                   6103: 
1.1020    raeburn  6104: sub auto_courserequest_validation {
                   6105:     my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
                   6106:     my ($homeserver,$response);
                   6107:     if ($dom =~ /^$match_domain$/) {
                   6108:         $homeserver = &domain($dom,'primary');
                   6109:     }
                   6110:     unless ($homeserver eq 'no_host') {  
1.1021    raeburn  6111:           
1.1020    raeburn  6112:         $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021    raeburn  6113:                                     ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020    raeburn  6114:                                     ':'.&escape($instcode).':'.&escape($instseclist),
                   6115:                                     $homeserver));
                   6116:     }
                   6117:     return $response;
                   6118: }
                   6119: 
1.777     albertel 6120: sub auto_validate_class_sec {
1.918     raeburn  6121:     my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773     raeburn  6122:     my $homeserver = &homeserver($cnum,$cdom);
1.918     raeburn  6123:     my $ownerlist;
                   6124:     if (ref($owners) eq 'ARRAY') {
                   6125:         $ownerlist = join(',',@{$owners});
                   6126:     } else {
                   6127:         $ownerlist = $owners;
                   6128:     }
1.773     raeburn  6129:     my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918     raeburn  6130:                         &escape($ownerlist).':'.$cdom,$homeserver);
1.773     raeburn  6131:     return $response;
                   6132: }
                   6133: 
1.679     raeburn  6134: # ------------------------------------------------------- Course Group routines
                   6135: 
                   6136: sub get_coursegroups {
1.809     raeburn  6137:     my ($cdom,$cnum,$group,$namespace) = @_;
                   6138:     return(&dump($namespace,$cdom,$cnum,$group));
1.805     raeburn  6139: }
                   6140: 
1.679     raeburn  6141: sub modify_coursegroup {
                   6142:     my ($cdom,$cnum,$groupsettings) = @_;
                   6143:     return(&put('coursegroups',$groupsettings,$cdom,$cnum));
                   6144: }
                   6145: 
1.809     raeburn  6146: sub toggle_coursegroup_status {
                   6147:     my ($cdom,$cnum,$group,$action) = @_;
                   6148:     my ($from_namespace,$to_namespace);
                   6149:     if ($action eq 'delete') {
                   6150:         $from_namespace = 'coursegroups';
                   6151:         $to_namespace = 'deleted_groups';
                   6152:     } else {
                   6153:         $from_namespace = 'deleted_groups';
                   6154:         $to_namespace = 'coursegroups';
                   6155:     }
                   6156:     my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805     raeburn  6157:     if (my $tmp = &error(%curr_group)) {
                   6158:         &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
                   6159:         return ('read error',$tmp);
                   6160:     } else {
                   6161:         my %savedsettings = %curr_group; 
1.809     raeburn  6162:         my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805     raeburn  6163:         my $deloutcome;
                   6164:         if ($result eq 'ok') {
1.809     raeburn  6165:             $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805     raeburn  6166:         } else {
                   6167:             return ('write error',$result);
                   6168:         }
                   6169:         if ($deloutcome eq 'ok') {
                   6170:             return 'ok';
                   6171:         } else {
                   6172:             return ('delete error',$deloutcome);
                   6173:         }
                   6174:     }
                   6175: }
                   6176: 
1.679     raeburn  6177: sub modify_group_roles {
1.957     raeburn  6178:     my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679     raeburn  6179:     my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
                   6180:     my $role = 'gr/'.&escape($userprivs);
                   6181:     my ($uname,$udom) = split(/:/,$user);
1.957     raeburn  6182:     my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684     raeburn  6183:     if ($result eq 'ok') {
                   6184:         &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
                   6185:     }
1.679     raeburn  6186:     return $result;
                   6187: }
                   6188: 
                   6189: sub modify_coursegroup_membership {
                   6190:     my ($cdom,$cnum,$membership) = @_;
                   6191:     my $result = &put('groupmembership',$membership,$cdom,$cnum);
                   6192:     return $result;
                   6193: }
                   6194: 
1.682     raeburn  6195: sub get_active_groups {
                   6196:     my ($udom,$uname,$cdom,$cnum) = @_;
                   6197:     my $now = time;
                   6198:     my %groups = ();
                   6199:     foreach my $key (keys(%env)) {
1.811     albertel 6200:         if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682     raeburn  6201:             my ($start,$end) = split(/\./,$env{$key});
                   6202:             if (($end!=0) && ($end<$now)) { next; }
                   6203:             if (($start!=0) && ($start>$now)) { next; }
                   6204:             if ($1 eq $cdom && $2 eq $cnum) {
                   6205:                 $groups{$3} = $env{$key} ;
                   6206:             }
                   6207:         }
                   6208:     }
                   6209:     return %groups;
                   6210: }
                   6211: 
1.683     raeburn  6212: sub get_group_membership {
                   6213:     my ($cdom,$cnum,$group) = @_;
                   6214:     return(&dump('groupmembership',$cdom,$cnum,$group));
                   6215: }
                   6216: 
                   6217: sub get_users_groups {
                   6218:     my ($udom,$uname,$courseid) = @_;
1.733     raeburn  6219:     my @usersgroups;
1.683     raeburn  6220:     my $cachetime=1800;
                   6221: 
                   6222:     my $hashid="$udom:$uname:$courseid";
1.733     raeburn  6223:     my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
                   6224:     if (defined($cached)) {
1.734     albertel 6225:         @usersgroups = split(/:/,$grouplist);
1.733     raeburn  6226:     } else {  
                   6227:         $grouplist = '';
1.816     raeburn  6228:         my $courseurl = &courseid_to_courseurl($courseid);
                   6229:         my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817     raeburn  6230:         my $access_end = $env{'course.'.$courseid.
                   6231:                               '.default_enrollment_end_date'};
                   6232:         my $now = time;
                   6233:         foreach my $key (keys(%roleshash)) {
                   6234:             if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
                   6235:                 my $group = $1;
                   6236:                 if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
                   6237:                     my $start = $2;
                   6238:                     my $end = $1;
                   6239:                     if ($start == -1) { next; } # deleted from group
                   6240:                     if (($start!=0) && ($start>$now)) { next; }
                   6241:                     if (($end!=0) && ($end<$now)) {
                   6242:                         if ($access_end && $access_end < $now) {
                   6243:                             if ($access_end - $end < 86400) {
                   6244:                                 push(@usersgroups,$group);
1.733     raeburn  6245:                             }
                   6246:                         }
1.817     raeburn  6247:                         next;
1.733     raeburn  6248:                     }
1.817     raeburn  6249:                     push(@usersgroups,$group);
1.683     raeburn  6250:                 }
                   6251:             }
                   6252:         }
1.817     raeburn  6253:         @usersgroups = &sort_course_groups($courseid,@usersgroups);
                   6254:         $grouplist = join(':',@usersgroups);
                   6255:         &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683     raeburn  6256:     }
1.733     raeburn  6257:     return @usersgroups;
1.683     raeburn  6258: }
                   6259: 
                   6260: sub devalidate_getgroups_cache {
                   6261:     my ($udom,$uname,$cdom,$cnum)=@_;
                   6262:     my $courseid = $cdom.'_'.$cnum;
1.807     albertel 6263: 
1.683     raeburn  6264:     my $hashid="$udom:$uname:$courseid";
                   6265:     &devalidate_cache_new('getgroups',$hashid);
                   6266: }
                   6267: 
1.12      www      6268: # ------------------------------------------------------------------ Plain Text
                   6269: 
                   6270: sub plaintext {
1.988     raeburn  6271:     my ($short,$type,$cid,$forcedefault) = @_;
1.1046    raeburn  6272:     if ($short =~ m{^cr/}) {
1.758     albertel 6273: 	return (split('/',$short))[-1];
                   6274:     }
1.742     raeburn  6275:     if (!defined($cid)) {
                   6276:         $cid = $env{'request.course.id'};
                   6277:     }
                   6278:     my %rolenames = (
1.1008    raeburn  6279:                       Course    => 'std',
                   6280:                       Community => 'alt1',
1.742     raeburn  6281:                     );
1.1037    raeburn  6282:     if ($cid ne '') {
                   6283:         if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
                   6284:             unless ($forcedefault) {
                   6285:                 my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 
                   6286:                 &Apache::lonlocal::mt_escape(\$roletext);
                   6287:                 return &Apache::lonlocal::mt($roletext);
                   6288:             }
                   6289:         }
                   6290:     }
                   6291:     if ((defined($type)) && (defined($rolenames{$type})) &&
                   6292:         (defined($rolenames{$type})) && 
                   6293:         (defined($prp{$short}{$rolenames{$type}}))) {
1.742     raeburn  6294:         return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037    raeburn  6295:     } elsif ($cid ne '') {
                   6296:         my $crstype = $env{'course.'.$cid.'.type'};
                   6297:         if (($crstype ne '') && (defined($rolenames{$crstype})) &&
                   6298:             (defined($prp{$short}{$rolenames{$crstype}}))) {
                   6299:             return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
                   6300:         }
1.742     raeburn  6301:     }
1.1037    raeburn  6302:     return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12      www      6303: }
                   6304: 
                   6305: # ----------------------------------------------------------------- Assign Role
                   6306: 
                   6307: sub assignrole {
1.957     raeburn  6308:     my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
                   6309:         $context)=@_;
1.21      www      6310:     my $mrole;
                   6311:     if ($role =~ /^cr\//) {
1.393     www      6312:         my $cwosec=$url;
1.811     albertel 6313:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393     www      6314: 	unless (&allowed('ccr',$cwosec)) {
1.1026    raeburn  6315:            my $refused = 1;
                   6316:            if ($context eq 'requestcourses') {
                   6317:                if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
                   6318:                    if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
                   6319:                        if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
                   6320:                            my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   6321:                            my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   6322:                            if ($crsenv{'internal.courseowner'} eq
                   6323:                                $env{'user.name'}.':'.$env{'user.domain'}) {
                   6324:                                $refused = '';
                   6325:                            }
                   6326:                        }
                   6327:                    }
                   6328:                }
                   6329:            }
                   6330:            if ($refused) {
                   6331:                &logthis('Refused custom assignrole: '.
                   6332:                         $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
                   6333:                         ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
                   6334:                return 'refused';
                   6335:            }
1.104     www      6336:         }
1.21      www      6337:         $mrole='cr';
1.678     raeburn  6338:     } elsif ($role =~ /^gr\//) {
                   6339:         my $cwogrp=$url;
1.811     albertel 6340:         $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678     raeburn  6341:         unless (&allowed('mdg',$cwogrp)) {
                   6342:             &logthis('Refused group assignrole: '.
                   6343:               $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
                   6344:                     $env{'user.name'}.' at '.$env{'user.domain'});
                   6345:             return 'refused';
                   6346:         }
                   6347:         $mrole='gr';
1.21      www      6348:     } else {
1.82      www      6349:         my $cwosec=$url;
1.811     albertel 6350:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932     raeburn  6351:         if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
                   6352:             my $refused;
                   6353:             if (($env{'request.course.sec'}  ne '') && ($role eq 'st')) {
                   6354:                 if (!(&allowed('c'.$role,$url))) {
                   6355:                     $refused = 1;
                   6356:                 }
                   6357:             } else {
                   6358:                 $refused = 1;
                   6359:             }
1.947     raeburn  6360:             if ($refused) {
1.1045    raeburn  6361:                 my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   6362:                 if (!$selfenroll && $context eq 'course') {
                   6363:                     my %crsenv;
                   6364:                     if ($role eq 'cc' || $role eq 'co') {
                   6365:                         %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   6366:                         if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
                   6367:                             if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
                   6368:                                 if ($crsenv{'internal.courseowner'} eq 
                   6369:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   6370:                                     $refused = '';
                   6371:                                 }
                   6372:                             }
                   6373:                         } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 
                   6374:                             if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
                   6375:                                 if ($crsenv{'internal.courseowner'} eq 
                   6376:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   6377:                                     $refused = '';
                   6378:                                 }
                   6379:                             }
                   6380:                         }
                   6381:                     }
                   6382:                 } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947     raeburn  6383:                     $refused = '';
1.1017    raeburn  6384:                 } elsif ($context eq 'requestcourses') {
1.1041    raeburn  6385:                     my @possroles = ('st','ta','ep','in','cc','co');
1.1026    raeburn  6386:                     if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041    raeburn  6387:                         my $wrongcc;
                   6388:                         if ($cnum =~ /^$match_community$/) {
                   6389:                             $wrongcc = 1 if ($role eq 'cc');
                   6390:                         } else {
                   6391:                             $wrongcc = 1 if ($role eq 'co');
                   6392:                         }
                   6393:                         unless ($wrongcc) {
                   6394:                             my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   6395:                             if ($crsenv{'internal.courseowner'} eq 
                   6396:                                  $env{'user.name'}.':'.$env{'user.domain'}) {
                   6397:                                 $refused = '';
                   6398:                             }
1.1017    raeburn  6399:                         }
                   6400:                     }
                   6401:                 }
                   6402:                 if ($refused) {
1.947     raeburn  6403:                     &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
                   6404:                              ' '.$role.' '.$end.' '.$start.' by '.
                   6405: 	  	             $env{'user.name'}.' at '.$env{'user.domain'});
                   6406:                     return 'refused';
                   6407:                 }
1.932     raeburn  6408:             }
1.104     www      6409:         }
1.21      www      6410:         $mrole=$role;
                   6411:     }
1.620     albertel 6412:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21      www      6413:                 "$udom:$uname:$url".'_'."$mrole=$role";
1.81      www      6414:     if ($end) { $command.='_'.$end; }
1.21      www      6415:     if ($start) {
                   6416: 	if ($end) { 
1.81      www      6417:            $command.='_'.$start; 
1.21      www      6418:         } else {
1.81      www      6419:            $command.='_0_'.$start;
1.21      www      6420:         }
                   6421:     }
1.739     raeburn  6422:     my $origstart = $start;
                   6423:     my $origend = $end;
1.957     raeburn  6424:     my $delflag;
1.357     www      6425: # actually delete
                   6426:     if ($deleteflag) {
1.373     www      6427: 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357     www      6428: # modify command to delete the role
1.620     albertel 6429:            $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357     www      6430:                 "$udom:$uname:$url".'_'."$mrole";
1.620     albertel 6431: 	   &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 
1.357     www      6432: # set start and finish to negative values for userrolelog
                   6433:            $start=-1;
                   6434:            $end=-1;
1.957     raeburn  6435:            $delflag = 1;
1.357     www      6436:         }
                   6437:     }
                   6438: # send command
1.349     www      6439:     my $answer=&reply($command,&homeserver($uname,$udom));
1.357     www      6440: # log new user role if status is ok
1.349     www      6441:     if ($answer eq 'ok') {
1.663     raeburn  6442: 	&userrolelog($role,$uname,$udom,$url,$start,$end);
1.739     raeburn  6443: # for course roles, perform group memberships changes triggered by role change.
1.957     raeburn  6444:         &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739     raeburn  6445:         unless ($role =~ /^gr/) {
                   6446:             &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957     raeburn  6447:                                              $origstart,$selfenroll,$context);
1.739     raeburn  6448:         }
1.1053    raeburn  6449:         if ($role eq 'cc') {
                   6450:             &autoupdate_coowners($url,$end,$start,$uname,$udom);
                   6451:         }
1.349     www      6452:     }
                   6453:     return $answer;
1.169     harris41 6454: }
                   6455: 
1.1053    raeburn  6456: sub autoupdate_coowners {
                   6457:     my ($url,$end,$start,$uname,$udom) = @_;
                   6458:     my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
                   6459:     if (($cdom ne '') && ($cnum ne '')) {
                   6460:         my $now = time;
                   6461:         my %domdesign = &Apache::loncommon::get_domainconf($cdom);
                   6462:         if ($domdesign{$cdom.'.autoassign.co-owners'}) {
                   6463:             my %coursehash = &coursedescription($cdom.'_'.$cnum);
                   6464:             my $instcode = $coursehash{'internal.coursecode'};
                   6465:             if ($instcode ne '') {
1.1056    raeburn  6466:                 if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
                   6467:                     unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053    raeburn  6468:                         my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056    raeburn  6469:                         my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
                   6470:                         if ($result eq 'valid') {
                   6471:                             if ($coursehash{'internal.co-owners'}) {
1.1053    raeburn  6472:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   6473:                                     push(@newcoowners,$coowner);
                   6474:                                 }
                   6475:                                 unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
                   6476:                                     push(@newcoowners,$uname.':'.$udom);
                   6477:                                 }
                   6478:                                 @newcoowners = sort(@newcoowners);
                   6479:                             } else {
                   6480:                                 push(@newcoowners,$uname.':'.$udom);
                   6481:                             }
                   6482:                         } else {
                   6483:                             if ($coursehash{'internal.co-owners'}) {
                   6484:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   6485:                                     unless ($coowner eq $uname.':'.$udom) {
                   6486:                                         push(@newcoowners,$coowner);
                   6487:                                     }
                   6488:                                 }
                   6489:                                 unless (@newcoowners > 0) {
                   6490:                                     $delcoowners = 1;
                   6491:                                     $coowners = '';
                   6492:                                 }
                   6493:                             }
                   6494:                         }
                   6495:                         if (@newcoowners || $delcoowners) {
                   6496:                             &store_coowners($cdom,$cnum,$coursehash{'home'},
                   6497:                                             $delcoowners,@newcoowners);
                   6498:                         }
                   6499:                     }
                   6500:                 }
                   6501:             }
                   6502:         }
                   6503:     }
                   6504: }
                   6505: 
                   6506: sub store_coowners {
                   6507:     my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
                   6508:     my $cid = $cdom.'_'.$cnum;
                   6509:     my ($coowners,$delresult,$putresult);
                   6510:     if (@newcoowners) {
                   6511:         $coowners = join(',',@newcoowners);
                   6512:         my %coownershash = (
                   6513:                             'internal.co-owners' => $coowners,
                   6514:                            );
                   6515:         $putresult = &put('environment',\%coownershash,$cdom,$cnum);
                   6516:         if ($putresult eq 'ok') {
                   6517:             if ($env{'course.'.$cid.'.num'} eq $cnum) {
                   6518:                 &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
                   6519:             }
                   6520:         }
                   6521:     }
                   6522:     if ($delcoowners) {
                   6523:         $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
                   6524:         if ($delresult eq 'ok') {
                   6525:             if ($env{'course.'.$cid.'.internal.co-owners'}) {
                   6526:                 &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
                   6527:             }
                   6528:         }
                   6529:     }
                   6530:     if (($putresult eq 'ok') || ($delresult eq 'ok')) {
                   6531:         my %crsinfo =
                   6532:             &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
                   6533:         if (ref($crsinfo{$cid}) eq 'HASH') {
                   6534:             $crsinfo{$cid}{'co-owners'} = \@newcoowners;
                   6535:             my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
                   6536:         }
                   6537:     }
                   6538: }
                   6539: 
1.169     harris41 6540: # -------------------------------------------------- Modify user authentication
1.197     www      6541: # Overrides without validation
                   6542: 
1.169     harris41 6543: sub modifyuserauth {
                   6544:     my ($udom,$uname,$umode,$upass)=@_;
                   6545:     my $uhome=&homeserver($uname,$udom);
1.197     www      6546:     unless (&allowed('mau',$udom)) { return 'refused'; }
                   6547:     &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620     albertel 6548:              $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   6549:              ' in domain '.$env{'request.role.domain'});  
1.169     harris41 6550:     my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
                   6551: 		     &escape($upass),$uhome);
1.620     albertel 6552:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197     www      6553:         'Authentication changed for '.$udom.', '.$uname.', '.$umode.
                   6554:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
                   6555:     &log($udom,,$uname,$uhome,
1.620     albertel 6556:         'Authentication changed by '.$env{'user.domain'}.', '.
                   6557:                                      $env{'user.name'}.', '.$umode.
1.197     www      6558:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169     harris41 6559:     unless ($reply eq 'ok') {
1.197     www      6560:         &logthis('Authentication mode error: '.$reply);
1.169     harris41 6561: 	return 'error: '.$reply;
                   6562:     }   
1.170     harris41 6563:     return 'ok';
1.80      www      6564: }
                   6565: 
1.81      www      6566: # --------------------------------------------------------------- Modify a user
1.80      www      6567: 
1.81      www      6568: sub modifyuser {
1.206     matthew  6569:     my ($udom,    $uname, $uid,
                   6570:         $umode,   $upass, $first,
                   6571:         $middle,  $last,  $gene,
1.1056.2.1  raeburn  6572:         $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807     albertel 6573:     $udom= &LONCAPA::clean_domain($udom);
                   6574:     $uname=&LONCAPA::clean_username($uname);
1.1056.2.1  raeburn  6575:     my $showcandelete = 'none';
                   6576:     if (ref($candelete) eq 'ARRAY') {
                   6577:         if (@{$candelete} > 0) {
                   6578:             $showcandelete = join(', ',@{$candelete});
                   6579:         }
                   6580:     }
1.81      www      6581:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80      www      6582:              $umode.', '.$first.', '.$middle.', '.
1.1056.2.1  raeburn  6583: 	     $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206     matthew  6584:              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
                   6585:                                      ' desiredhome not specified'). 
1.620     albertel 6586:              ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   6587:              ' in domain '.$env{'request.role.domain'});
1.230     stredwic 6588:     my $uhome=&homeserver($uname,$udom,'true');
1.1056.2.6  raeburn  6589:     my $newuser;
                   6590:     if ($uhome eq 'no_host') {
                   6591:         $newuser = 1;
                   6592:     }
1.80      www      6593: # ----------------------------------------------------------------- Create User
1.406     albertel 6594:     if (($uhome eq 'no_host') && 
                   6595: 	(($umode && $upass) || ($umode eq 'localauth'))) {
1.80      www      6596:         my $unhome='';
1.844     albertel 6597:         if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 
1.209     matthew  6598:             $unhome = $desiredhome;
1.620     albertel 6599: 	} elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
                   6600: 	    $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209     matthew  6601:         } else { # load balancing routine for determining $unhome
1.81      www      6602:             my $loadm=10000000;
1.841     albertel 6603: 	    my %servers = &get_servers($udom,'library');
                   6604: 	    foreach my $tryserver (keys(%servers)) {
                   6605: 		my $answer=reply('load',$tryserver);
                   6606: 		if (($answer=~/\d+/) && ($answer<$loadm)) {
                   6607: 		    $loadm=$answer;
                   6608: 		    $unhome=$tryserver;
                   6609: 		}
1.80      www      6610: 	    }
                   6611:         }
                   6612:         if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206     matthew  6613: 	    return 'error: unable to find a home server for '.$uname.
                   6614:                    ' in domain '.$udom;
1.80      www      6615:         }
                   6616:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
                   6617:                          &escape($upass),$unhome);
                   6618: 	unless ($reply eq 'ok') {
                   6619:             return 'error: '.$reply;
                   6620:         }   
1.230     stredwic 6621:         $uhome=&homeserver($uname,$udom,'true');
1.80      www      6622:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386     matthew  6623: 	    return 'error: unable verify users home machine.';
1.80      www      6624:         }
1.209     matthew  6625:     }   # End of creation of new user
1.80      www      6626: # ---------------------------------------------------------------------- Add ID
                   6627:     if ($uid) {
                   6628:        $uid=~tr/A-Z/a-z/;
                   6629:        my %uidhash=&idrget($udom,$uname);
1.196     www      6630:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 
                   6631:          && (!$forceid)) {
1.80      www      6632: 	  unless ($uid eq $uidhash{$uname}) {
1.386     matthew  6633: 	      return 'error: user id "'.$uid.'" does not match '.
                   6634:                   'current user id "'.$uidhash{$uname}.'".';
1.80      www      6635:           }
                   6636:        } else {
                   6637: 	  &idput($udom,($uname => $uid));
                   6638:        }
                   6639:     }
                   6640: # -------------------------------------------------------------- Add names, etc
1.313     matthew  6641:     my @tmp=&get('environment',
1.899     raeburn  6642: 		   ['firstname','middlename','lastname','generation','id',
1.963     raeburn  6643:                     'permanentemail','inststatus'],
1.134     albertel 6644: 		   $udom,$uname);
1.1056.2.6  raeburn  6645:     my (%names,%oldnames);
1.313     matthew  6646:     if ($tmp[0] =~ m/^error:.*/) { 
                   6647:         %names=(); 
                   6648:     } else {
                   6649:         %names = @tmp;
1.1056.2.6  raeburn  6650:         %oldnames = %names;
1.313     matthew  6651:     }
1.388     www      6652: #
1.1056.2.1  raeburn  6653: # If name, email and/or uid are blank (e.g., because an uploaded file
                   6654: # of users did not contain them), do not overwrite existing values
                   6655: # unless field is in $candelete array ref.
                   6656: #
                   6657:     my @fields = ('firstname','middlename','lastname','generation',
                   6658:                   'permanentemail','id');
                   6659:     my %newvalues;
                   6660:     if (ref($candelete) eq 'ARRAY') {
                   6661:         foreach my $field (@fields) {
                   6662:             if (grep(/^\Q$field\E$/,@{$candelete})) {
                   6663:                 if ($field eq 'firstname') {
                   6664:                     $names{$field} = $first;
                   6665:                 } elsif ($field eq 'middlename') {
                   6666:                     $names{$field} = $middle;
                   6667:                 } elsif ($field eq 'lastname') {
                   6668:                     $names{$field} = $last;
                   6669:                 } elsif ($field eq 'generation') {
                   6670:                     $names{$field} = $gene;
                   6671:                 } elsif ($field eq 'permanentemail') {
                   6672:                     $names{$field} = $email;
                   6673:                 } elsif ($field eq 'id') {
                   6674:                     $names{$field}  = $uid;
                   6675:                 }
                   6676:             }
                   6677:         }
                   6678:     }
                   6679: 
1.388     www      6680:     if ($first)  { $names{'firstname'}  = $first; }
1.385     matthew  6681:     if (defined($middle)) { $names{'middlename'} = $middle; }
1.388     www      6682:     if ($last)   { $names{'lastname'}   = $last; }
1.385     matthew  6683:     if (defined($gene))   { $names{'generation'} = $gene; }
1.592     www      6684:     if ($email) {
                   6685:        $email=~s/[^\w\@\.\-\,]//gs;
1.963     raeburn  6686:        if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592     www      6687:     }
1.899     raeburn  6688:     if ($uid) { $names{'id'}  = $uid; }
1.989     raeburn  6689:     if (defined($inststatus)) {
                   6690:         $names{'inststatus'} = '';
                   6691:         my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
                   6692:         if (ref($usertypes) eq 'HASH') {
                   6693:             my @okstatuses; 
                   6694:             foreach my $item (split(/:/,$inststatus)) {
                   6695:                 if (defined($usertypes->{$item})) {
                   6696:                     push(@okstatuses,$item);  
                   6697:                 }
                   6698:             }
                   6699:             if (@okstatuses) {
                   6700:                 $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
                   6701:             }
                   6702:         }
                   6703:     }
1.1056.2.6  raeburn  6704:     my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963     raeburn  6705:                  $umode.', '.$first.', '.$middle.', '.
                   6706: 	         $last.', '.$gene.', '.$email.', '.$inststatus;
                   6707:     if ($env{'user.name'} ne '' && $env{'user.domain'}) {
                   6708:         $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
                   6709:     } else {
                   6710:         $logmsg .= ' during self creation';
                   6711:     }
1.1056.2.6  raeburn  6712:     my $changed;
                   6713:     if ($newuser) {
                   6714:         $changed = 1;
                   6715:     } else {
                   6716:         foreach my $field (@fields) {
                   6717:             if ($names{$field} ne $oldnames{$field}) {
                   6718:                 $changed = 1;
                   6719:                 last;
                   6720:             }
                   6721:         }
                   6722:     }
                   6723:     unless ($changed) {
                   6724:         $logmsg = 'No changes in user information needed for: '.$logmsg;
                   6725:         &logthis($logmsg);
                   6726:         return 'ok';
                   6727:     }
                   6728:     my $reply = &put('environment', \%names, $udom,$uname);
                   6729:     if ($reply ne 'ok') {
                   6730:         return 'error: '.$reply;
                   6731:     }
1.1056.2.7! raeburn  6732:     if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
        !          6733:         &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
        !          6734:     }
1.1056.2.6  raeburn  6735:     my $sqlresult = &update_allusers_table($uname,$udom,\%names);
                   6736:     &devalidate_cache_new('namescache',$uname.':'.$udom);
                   6737:     $logmsg = 'Success modifying user '.$logmsg;
1.963     raeburn  6738:     &logthis($logmsg);
1.134     albertel 6739:     return 'ok';
1.80      www      6740: }
                   6741: 
1.81      www      6742: # -------------------------------------------------------------- Modify student
1.80      www      6743: 
1.81      www      6744: sub modifystudent {
                   6745:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957     raeburn  6746:         $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990     raeburn  6747:         $selfenroll,$context,$inststatus)=@_;
1.455     albertel 6748:     if (!$cid) {
1.620     albertel 6749: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 6750: 	    return 'not_in_class';
                   6751: 	}
1.80      www      6752:     }
                   6753: # --------------------------------------------------------------- Make the user
1.81      www      6754:     my $reply=&modifyuser
1.209     matthew  6755: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990     raeburn  6756:          $desiredhome,$email,$inststatus);
1.80      www      6757:     unless ($reply eq 'ok') { return $reply; }
1.297     matthew  6758:     # This will cause &modify_student_enrollment to get the uid from the
                   6759:     # students environment
                   6760:     $uid = undef if (!$forceid);
1.455     albertel 6761:     $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957     raeburn  6762: 					$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297     matthew  6763:     return $reply;
                   6764: }
                   6765: 
                   6766: sub modify_student_enrollment {
1.957     raeburn  6767:     my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455     albertel 6768:     my ($cdom,$cnum,$chome);
                   6769:     if (!$cid) {
1.620     albertel 6770: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 6771: 	    return 'not_in_class';
                   6772: 	}
1.620     albertel 6773: 	$cdom=$env{'course.'.$cid.'.domain'};
                   6774: 	$cnum=$env{'course.'.$cid.'.num'};
1.455     albertel 6775:     } else {
                   6776: 	($cdom,$cnum)=split(/_/,$cid);
                   6777:     }
1.620     albertel 6778:     $chome=$env{'course.'.$cid.'.home'};
1.455     albertel 6779:     if (!$chome) {
1.457     raeburn  6780: 	$chome=&homeserver($cnum,$cdom);
1.297     matthew  6781:     }
1.455     albertel 6782:     if (!$chome) { return 'unknown_course'; }
1.297     matthew  6783:     # Make sure the user exists
1.81      www      6784:     my $uhome=&homeserver($uname,$udom);
                   6785:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   6786: 	return 'error: no such user';
                   6787:     }
1.297     matthew  6788:     # Get student data if we were not given enough information
                   6789:     if (!defined($first)  || $first  eq '' || 
                   6790:         !defined($last)   || $last   eq '' || 
                   6791:         !defined($uid)    || $uid    eq '' || 
                   6792:         !defined($middle) || $middle eq '' || 
                   6793:         !defined($gene)   || $gene   eq '') {
1.294     matthew  6794:         # They did not supply us with enough data to enroll the student, so
                   6795:         # we need to pick up more information.
1.297     matthew  6796:         my %tmp = &get('environment',
1.294     matthew  6797:                        ['firstname','middlename','lastname', 'generation','id']
1.297     matthew  6798:                        ,$udom,$uname);
                   6799: 
1.800     albertel 6800:         #foreach my $key (keys(%tmp)) {
                   6801:         #    &logthis("key $key = ".$tmp{$key});
1.455     albertel 6802:         #}
1.294     matthew  6803:         $first  = $tmp{'firstname'}  if (!defined($first)  || $first  eq '');
                   6804:         $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
                   6805:         $last   = $tmp{'lastname'}   if (!defined($last)   || $last eq '');
1.297     matthew  6806:         $gene   = $tmp{'generation'} if (!defined($gene)   || $gene eq '');
1.294     matthew  6807:         $uid    = $tmp{'id'}         if (!defined($uid)    || $uid  eq '');
                   6808:     }
1.556     albertel 6809:     my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487     albertel 6810:     my $reply=cput('classlist',
                   6811: 		   {"$uname:$udom" => 
1.515     raeburn  6812: 			join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487     albertel 6813: 		   $cdom,$cnum);
1.81      www      6814:     unless (($reply eq 'ok') || ($reply eq 'delayed')) {
                   6815: 	return 'error: '.$reply;
1.652     albertel 6816:     } else {
                   6817: 	&devalidate_getsection_cache($udom,$uname,$cid);
1.81      www      6818:     }
1.297     matthew  6819:     # Add student role to user
1.83      www      6820:     my $uurl='/'.$cid;
1.81      www      6821:     $uurl=~s/\_/\//g;
                   6822:     if ($usec) {
                   6823: 	$uurl.='/'.$usec;
                   6824:     }
1.957     raeburn  6825:     return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21      www      6826: }
                   6827: 
1.556     albertel 6828: sub format_name {
                   6829:     my ($firstname,$middlename,$lastname,$generation,$first)=@_;
                   6830:     my $name;
                   6831:     if ($first ne 'lastname') {
                   6832: 	$name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
                   6833:     } else {
                   6834: 	if ($lastname=~/\S/) {
                   6835: 	    $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
                   6836: 	    $name=~s/\s+,/,/;
                   6837: 	} else {
                   6838: 	    $name.= $firstname.' '.$middlename.' '.$generation;
                   6839: 	}
                   6840:     }
                   6841:     $name=~s/^\s+//;
                   6842:     $name=~s/\s+$//;
                   6843:     $name=~s/\s+/ /g;
                   6844:     return $name;
                   6845: }
                   6846: 
1.84      www      6847: # ------------------------------------------------- Write to course preferences
                   6848: 
                   6849: sub writecoursepref {
                   6850:     my ($courseid,%prefs)=@_;
                   6851:     $courseid=~s/^\///;
                   6852:     $courseid=~s/\_/\//g;
                   6853:     my ($cdomain,$cnum)=split(/\//,$courseid);
                   6854:     my $chome=homeserver($cnum,$cdomain);
                   6855:     if (($chome eq '') || ($chome eq 'no_host')) { 
                   6856: 	return 'error: no such course';
                   6857:     }
                   6858:     my $cstring='';
1.800     albertel 6859:     foreach my $pref (keys(%prefs)) {
                   6860: 	$cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191     harris41 6861:     }
1.84      www      6862:     $cstring=~s/\&$//;
                   6863:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
                   6864: }
                   6865: 
                   6866: # ---------------------------------------------------------- Make/modify course
                   6867: 
                   6868: sub createcourse {
1.741     raeburn  6869:     my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017    raeburn  6870:         $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84      www      6871:     $url=&declutter($url);
                   6872:     my $cid='';
1.1028    raeburn  6873:     if ($context eq 'requestcourses') {
                   6874:         my $can_create = 0;
                   6875:         my ($ownername,$ownerdom) = split(':',$course_owner);
                   6876:         if ($udom eq $ownerdom) {
                   6877:             if (&usertools_access($ownername,$ownerdom,$category,undef,
                   6878:                                   $context)) {
                   6879:                 $can_create = 1;
                   6880:             }
                   6881:         } else {
                   6882:             my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
                   6883:                                            $category);
                   6884:             if ($userenv{'reqcrsotherdom.'.$category} ne '') {
                   6885:                 my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
                   6886:                 if (@curr > 0) {
                   6887:                     my @options = qw(approval validate autolimit);
                   6888:                     my $optregex = join('|',@options);
                   6889:                     if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
                   6890:                         $can_create = 1;
                   6891:                     }
                   6892:                 }
                   6893:             }
                   6894:         }
                   6895:         if ($can_create) {
                   6896:             unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
                   6897:                 unless (&allowed('ccc',$udom)) {
                   6898:                     return 'refused'; 
                   6899:                 }
1.1017    raeburn  6900:             }
                   6901:         } else {
                   6902:             return 'refused';
                   6903:         }
1.1028    raeburn  6904:     } elsif (!&allowed('ccc',$udom)) {
                   6905:         return 'refused';
1.84      www      6906:     }
1.1011    raeburn  6907: # --------------------------------------------------------------- Get Unique ID
                   6908:     my $uname;
                   6909:     if ($cnum =~ /^$match_courseid$/) {
                   6910:         my $chome=&homeserver($cnum,$udom,'true');
                   6911:         if (($chome eq '') || ($chome eq 'no_host')) {
                   6912:             $uname = $cnum;
                   6913:         } else {
1.1038    raeburn  6914:             $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  6915:         }
                   6916:     } else {
1.1038    raeburn  6917:         $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  6918:     }
                   6919:     return $uname if ($uname =~ /^error/);
                   6920: # -------------------------------------------------- Check supplied server name
1.1052    raeburn  6921:     if (!defined($course_server)) {
                   6922:         if (defined(&domain($udom,'primary'))) {
                   6923:             $course_server = &domain($udom,'primary');
                   6924:         } else {
                   6925:             $course_server = $env{'user.home'}; 
                   6926:         }
                   6927:     }
                   6928:     my %host_servers =
                   6929:         &Apache::lonnet::get_servers($udom,'library');
                   6930:     unless ($host_servers{$course_server}) {
                   6931:         return 'error: invalid home server for course: '.$course_server;
1.264     matthew  6932:     }
1.84      www      6933: # ------------------------------------------------------------- Make the course
                   6934:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264     matthew  6935:                       $course_server);
1.84      www      6936:     unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011    raeburn  6937:     my $uhome=&homeserver($uname,$udom,'true');
1.84      www      6938:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   6939: 	return 'error: no such course';
                   6940:     }
1.271     www      6941: # ----------------------------------------------------------------- Course made
1.516     raeburn  6942: # log existence
1.1029    raeburn  6943:     my $now = time;
1.918     raeburn  6944:     my $newcourse = {
                   6945:                     $udom.'_'.$uname => {
1.921     raeburn  6946:                                      description => $description,
                   6947:                                      inst_code   => $inst_code,
                   6948:                                      owner       => $course_owner,
                   6949:                                      type        => $crstype,
1.1029    raeburn  6950:                                      creator     => $env{'user.name'}.':'.
                   6951:                                                     $env{'user.domain'},
                   6952:                                      created     => $now,
                   6953:                                      context     => $context,
1.918     raeburn  6954:                                                 },
                   6955:                     };
1.921     raeburn  6956:     &courseidput($udom,$newcourse,$uhome,'notime');
1.358     www      6957: # set toplevel url
1.271     www      6958:     my $topurl=$url;
                   6959:     unless ($nonstandard) {
                   6960: # ------------------------------------------ For standard courses, make top url
                   6961:         my $mapurl=&clutter($url);
1.278     www      6962:         if ($mapurl eq '/res/') { $mapurl=''; }
1.620     albertel 6963:         $env{'form.initmap'}=(<<ENDINITMAP);
1.271     www      6964: <map>
                   6965: <resource id="1" type="start"></resource>
                   6966: <resource id="2" src="$mapurl"></resource>
                   6967: <resource id="3" type="finish"></resource>
                   6968: <link index="1" from="1" to="2"></link>
                   6969: <link index="2" from="2" to="3"></link>
                   6970: </map>
                   6971: ENDINITMAP
                   6972:         $topurl=&declutter(
1.638     albertel 6973:         &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271     www      6974:                           );
                   6975:     }
                   6976: # ----------------------------------------------------------- Write preferences
1.84      www      6977:     &writecoursepref($udom.'_'.$uname,
1.1056    raeburn  6978:                      ('description'              => $description,
                   6979:                       'url'                      => $topurl,
                   6980:                       'internal.creator'         => $env{'user.name'}.':'.
                   6981:                                                     $env{'user.domain'},
                   6982:                       'internal.created'         => $now,
                   6983:                       'internal.creationcontext' => $context)
                   6984:                     );
1.84      www      6985:     return '/'.$udom.'/'.$uname;
                   6986: }
                   6987: 
1.1011    raeburn  6988: # ------------------------------------------------------------------- Create ID
                   6989: sub generate_coursenum {
1.1038    raeburn  6990:     my ($udom,$crstype) = @_;
1.1011    raeburn  6991:     my $domdesc = &domain($udom);
                   6992:     return 'error: invalid domain' if ($domdesc eq '');
1.1038    raeburn  6993:     my $first;
                   6994:     if ($crstype eq 'Community') {
                   6995:         $first = '0';
                   6996:     } else {
                   6997:         $first = int(1+rand(9)); 
                   6998:     } 
                   6999:     my $uname=$first.
1.1011    raeburn  7000:         ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   7001:         substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   7002:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   7003: # ----------------------------------------------- Make sure that does not exist
                   7004:     my $uhome=&homeserver($uname,$udom,'true');
                   7005:     unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038    raeburn  7006:         if ($crstype eq 'Community') {
                   7007:             $first = '0';
                   7008:         } else {
                   7009:             $first = int(1+rand(9));
                   7010:         }
                   7011:         $uname=$first.
1.1011    raeburn  7012:                ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   7013:                substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   7014:                unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   7015:         $uhome=&homeserver($uname,$udom,'true');
                   7016:         unless (($uhome eq '') || ($uhome eq 'no_host')) {
                   7017:             return 'error: unable to generate unique course-ID';
                   7018:         }
                   7019:     }
                   7020:     return $uname;
                   7021: }
                   7022: 
1.813     albertel 7023: sub is_course {
                   7024:     my ($cdom,$cnum) = @_;
                   7025:     my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946     raeburn  7026: 				undef,'.');
1.813     albertel 7027:     if (exists($courses{$cdom.'_'.$cnum})) {
                   7028:         return 1;
                   7029:     }
                   7030:     return 0;
                   7031: }
                   7032: 
1.1015    raeburn  7033: sub store_userdata {
                   7034:     my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013    raeburn  7035:     my $result;
1.1016    raeburn  7036:     if ($datakey ne '') {
1.1013    raeburn  7037:         if (ref($storehash) eq 'HASH') {
1.1017    raeburn  7038:             if ($udom eq '' || $uname eq '') {
                   7039:                 $udom = $env{'user.domain'};
                   7040:                 $uname = $env{'user.name'};
                   7041:             }
                   7042:             my $uhome=&homeserver($uname,$udom);
1.1013    raeburn  7043:             if (($uhome eq '') || ($uhome eq 'no_host')) {
                   7044:                 $result = 'error: no_host';
                   7045:             } else {
                   7046:                 $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
                   7047:                 $storehash->{'host'} = $perlvar{'lonHostID'};
                   7048: 
                   7049:                 my $namevalue='';
                   7050:                 foreach my $key (keys(%{$storehash})) {
                   7051:                     $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   7052:                 }
                   7053:                 $namevalue=~s/\&$//;
                   7054:                 $result =  &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015    raeburn  7055:                                   "$namespace:$datakey:$namevalue",$uhome);
1.1013    raeburn  7056:             }
                   7057:         } else {
                   7058:             $result = 'error: data to store was not a hash reference'; 
                   7059:         }
                   7060:     } else {
                   7061:         $result= 'error: invalid requestkey'; 
                   7062:     }
                   7063:     return $result;
                   7064: }
                   7065: 
1.21      www      7066: # ---------------------------------------------------------- Assign Custom Role
                   7067: 
                   7068: sub assigncustomrole {
1.957     raeburn  7069:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21      www      7070:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957     raeburn  7071:                        $end,$start,$deleteflag,$selfenroll,$context);
1.21      www      7072: }
                   7073: 
                   7074: # ----------------------------------------------------------------- Revoke Role
                   7075: 
                   7076: sub revokerole {
1.957     raeburn  7077:     my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21      www      7078:     my $now=time;
1.965     raeburn  7079:     return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21      www      7080: }
                   7081: 
                   7082: # ---------------------------------------------------------- Revoke Custom Role
                   7083: 
                   7084: sub revokecustomrole {
1.957     raeburn  7085:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21      www      7086:     my $now=time;
1.357     www      7087:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957     raeburn  7088:            $deleteflag,$selfenroll,$context);
1.17      www      7089: }
                   7090: 
1.533     banghart 7091: # ------------------------------------------------------------ Disk usage
1.535     albertel 7092: sub diskusage {
1.955     raeburn  7093:     my ($udom,$uname,$directorypath,$getpropath)=@_;
                   7094:     $directorypath =~ s/\/$//;
                   7095:     my $listing=&reply('du2:'.&escape($directorypath).':'
                   7096:                        .&escape($getpropath).':'.&escape($uname).':'
                   7097:                        .&escape($udom),homeserver($uname,$udom));
                   7098:     if ($listing eq 'unknown_cmd') {
                   7099:         if ($getpropath) {
                   7100:             $directorypath = &propath($udom,$uname).'/'.$directorypath; 
                   7101:         }
                   7102:         $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
                   7103:     }
1.514     albertel 7104:     return $listing;
1.512     banghart 7105: }
                   7106: 
1.566     banghart 7107: sub is_locked {
                   7108:     my ($file_name, $domain, $user) = @_;
                   7109:     my @check;
                   7110:     my $is_locked;
                   7111:     push @check, $file_name;
1.613     albertel 7112:     my %locked = &get('file_permissions',\@check,
1.620     albertel 7113: 		      $env{'user.domain'},$env{'user.name'});
1.615     albertel 7114:     my ($tmp)=keys(%locked);
                   7115:     if ($tmp=~/^error:/) { undef(%locked); }
1.745     raeburn  7116:     
1.566     banghart 7117:     if (ref($locked{$file_name}) eq 'ARRAY') {
1.745     raeburn  7118:         $is_locked = 'false';
                   7119:         foreach my $entry (@{$locked{$file_name}}) {
                   7120:            if (ref($entry) eq 'ARRAY') { 
1.746     raeburn  7121:                $is_locked = 'true';
                   7122:                last;
1.745     raeburn  7123:            }
                   7124:        }
1.566     banghart 7125:     } else {
                   7126:         $is_locked = 'false';
                   7127:     }
                   7128: }
                   7129: 
1.759     albertel 7130: sub declutter_portfile {
                   7131:     my ($file) = @_;
1.833     albertel 7132:     $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759     albertel 7133:     return $file;
                   7134: }
                   7135: 
1.559     banghart 7136: # ------------------------------------------------------------- Mark as Read Only
                   7137: 
                   7138: sub mark_as_readonly {
                   7139:     my ($domain,$user,$files,$what) = @_;
1.613     albertel 7140:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 7141:     my ($tmp)=keys(%current_permissions);
                   7142:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560     banghart 7143:     foreach my $file (@{$files}) {
1.759     albertel 7144: 	$file = &declutter_portfile($file);
1.561     banghart 7145:         push(@{$current_permissions{$file}},$what);
1.559     banghart 7146:     }
1.613     albertel 7147:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 7148:     return;
                   7149: }
                   7150: 
1.572     banghart 7151: # ------------------------------------------------------------Save Selected Files
                   7152: 
                   7153: sub save_selected_files {
                   7154:     my ($user, $path, @files) = @_;
                   7155:     my $filename = $user."savedfiles";
1.573     banghart 7156:     my @other_files = &files_not_in_path($user, $path);
1.871     albertel 7157:     open (OUT, '>'.$tmpdir.$filename);
1.573     banghart 7158:     foreach my $file (@files) {
1.620     albertel 7159:         print (OUT $env{'form.currentpath'}.$file."\n");
1.573     banghart 7160:     }
                   7161:     foreach my $file (@other_files) {
1.574     banghart 7162:         print (OUT $file."\n");
1.572     banghart 7163:     }
1.574     banghart 7164:     close (OUT);
1.572     banghart 7165:     return 'ok';
                   7166: }
                   7167: 
1.574     banghart 7168: sub clear_selected_files {
                   7169:     my ($user) = @_;
                   7170:     my $filename = $user."savedfiles";
                   7171:     open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
                   7172:     print (OUT undef);
                   7173:     close (OUT);
                   7174:     return ("ok");    
                   7175: }
                   7176: 
1.572     banghart 7177: sub files_in_path {
                   7178:     my ($user, $path) = @_;
                   7179:     my $filename = $user."savedfiles";
                   7180:     my %return_files;
1.574     banghart 7181:     open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573     banghart 7182:     while (my $line_in = <IN>) {
1.574     banghart 7183:         chomp ($line_in);
                   7184:         my @paths_and_file = split (m!/!, $line_in);
                   7185:         my $file_part = pop (@paths_and_file);
                   7186:         my $path_part = join ('/', @paths_and_file);
1.573     banghart 7187:         $path_part.='/';
                   7188:         my $path_and_file = $path_part.$file_part;
                   7189:         if ($path_part eq $path) {
                   7190:             $return_files{$file_part}= 'selected';
                   7191:         }
                   7192:     }
1.574     banghart 7193:     close (IN);
                   7194:     return (\%return_files);
1.572     banghart 7195: }
                   7196: 
                   7197: # called in portfolio select mode, to show files selected NOT in current directory
                   7198: sub files_not_in_path {
                   7199:     my ($user, $path) = @_;
                   7200:     my $filename = $user."savedfiles";
                   7201:     my @return_files;
                   7202:     my $path_part;
1.800     albertel 7203:     open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
                   7204:     while (my $line = <IN>) {
1.572     banghart 7205:         #ok, I know it's clunky, but I want it to work
1.800     albertel 7206:         my @paths_and_file = split(m|/|, $line);
                   7207:         my $file_part = pop(@paths_and_file);
                   7208:         chomp($file_part);
                   7209:         my $path_part = join('/', @paths_and_file);
1.572     banghart 7210:         $path_part .= '/';
                   7211:         my $path_and_file = $path_part.$file_part;
                   7212:         if ($path_part ne $path) {
1.800     albertel 7213:             push(@return_files, ($path_and_file));
1.572     banghart 7214:         }
                   7215:     }
1.800     albertel 7216:     close(OUT);
1.574     banghart 7217:     return (@return_files);
1.572     banghart 7218: }
                   7219: 
1.745     raeburn  7220: #----------------------------------------------Get portfolio file permissions
1.629     banghart 7221: 
1.745     raeburn  7222: sub get_portfile_permissions {
                   7223:     my ($domain,$user) = @_;
1.613     albertel 7224:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 7225:     my ($tmp)=keys(%current_permissions);
                   7226:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  7227:     return \%current_permissions;
                   7228: }
                   7229: 
                   7230: #---------------------------------------------Get portfolio file access controls
                   7231: 
1.749     raeburn  7232: sub get_access_controls {
1.745     raeburn  7233:     my ($current_permissions,$group,$file) = @_;
1.769     albertel 7234:     my %access;
                   7235:     my $real_file = $file;
                   7236:     $file =~ s/\.meta$//;
1.745     raeburn  7237:     if (defined($file)) {
1.749     raeburn  7238:         if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
                   7239:             foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769     albertel 7240:                 $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749     raeburn  7241:             }
                   7242:         }
1.745     raeburn  7243:     } else {
1.749     raeburn  7244:         foreach my $key (keys(%{$current_permissions})) {
                   7245:             if ($key =~ /\0accesscontrol$/) {
                   7246:                 if (defined($group)) {
                   7247:                     if ($key !~ m-^\Q$group\E/-) {
                   7248:                         next;
                   7249:                     }
                   7250:                 }
                   7251:                 my ($fullpath) = split(/\0/,$key);
                   7252:                 if (ref($$current_permissions{$key}) eq 'HASH') {
                   7253:                     foreach my $control (keys(%{$$current_permissions{$key}})) {
                   7254:                         $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
                   7255:                     }
                   7256:                 }
                   7257:             }
                   7258:         }
                   7259:     }
                   7260:     return %access;
                   7261: }
                   7262: 
                   7263: sub modify_access_controls {
                   7264:     my ($file_name,$changes,$domain,$user)=@_;
                   7265:     my ($outcome,$deloutcome);
                   7266:     my %store_permissions;
                   7267:     my %new_values;
                   7268:     my %new_control;
                   7269:     my %translation;
                   7270:     my @deletions = ();
                   7271:     my $now = time;
                   7272:     if (exists($$changes{'activate'})) {
                   7273:         if (ref($$changes{'activate'}) eq 'HASH') {
                   7274:             my @newitems = sort(keys(%{$$changes{'activate'}}));
                   7275:             my $numnew = scalar(@newitems);
                   7276:             for (my $i=0; $i<$numnew; $i++) {
                   7277:                 my $newkey = $newitems[$i];
                   7278:                 my $newid = &Apache::loncommon::get_cgi_id();
1.797     raeburn  7279:                 if ($newkey =~ /^\d+:/) { 
                   7280:                     $newkey =~ s/^(\d+)/$newid/;
                   7281:                     $translation{$1} = $newid;
                   7282:                 } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
                   7283:                     $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
                   7284:                     $translation{$1} = $newid;
                   7285:                 }
1.749     raeburn  7286:                 $new_values{$file_name."\0".$newkey} = 
                   7287:                                           $$changes{'activate'}{$newitems[$i]};
                   7288:                 $new_control{$newkey} = $now;
                   7289:             }
                   7290:         }
                   7291:     }
                   7292:     my %todelete;
                   7293:     my %changed_items;
                   7294:     foreach my $action ('delete','update') {
                   7295:         if (exists($$changes{$action})) {
                   7296:             if (ref($$changes{$action}) eq 'HASH') {
                   7297:                 foreach my $key (keys(%{$$changes{$action}})) {
                   7298:                     my ($itemnum) = ($key =~ /^([^:]+):/);
                   7299:                     if ($action eq 'delete') { 
                   7300:                         $todelete{$itemnum} = 1;
                   7301:                     } else {
                   7302:                         $changed_items{$itemnum} = $key;
                   7303:                     }
                   7304:                 }
1.745     raeburn  7305:             }
                   7306:         }
1.749     raeburn  7307:     }
                   7308:     # get lock on access controls for file.
                   7309:     my $lockhash = {
                   7310:                   $file_name."\0".'locked_access_records' => $env{'user.name'}.
                   7311:                                                        ':'.$env{'user.domain'},
                   7312:                    }; 
                   7313:     my $tries = 0;
                   7314:     my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   7315:    
                   7316:     while (($gotlock ne 'ok') && $tries <3) {
                   7317:         $tries ++;
                   7318:         sleep 1;
                   7319:         $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   7320:     }
                   7321:     if ($gotlock eq 'ok') {
                   7322:         my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
                   7323:         my ($tmp)=keys(%curr_permissions);
                   7324:         if ($tmp=~/^error:/) { undef(%curr_permissions); }
                   7325:         if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
                   7326:             my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
                   7327:             if (ref($curr_controls) eq 'HASH') {
                   7328:                 foreach my $control_item (keys(%{$curr_controls})) {
                   7329:                     my ($itemnum) = ($control_item =~ /^([^:]+):/);
                   7330:                     if (defined($todelete{$itemnum})) {
                   7331:                         push(@deletions,$file_name."\0".$control_item);
                   7332:                     } else {
                   7333:                         if (defined($changed_items{$itemnum})) {
                   7334:                             $new_control{$changed_items{$itemnum}} = $now;
                   7335:                             push(@deletions,$file_name."\0".$control_item);
                   7336:                             $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
                   7337:                         } else {
                   7338:                             $new_control{$control_item} = $$curr_controls{$control_item};
                   7339:                         }
                   7340:                     }
1.745     raeburn  7341:                 }
                   7342:             }
                   7343:         }
1.970     raeburn  7344:         my ($group);
                   7345:         if (&is_course($domain,$user)) {
                   7346:             ($group,my $file) = split(/\//,$file_name,2);
                   7347:         }
1.749     raeburn  7348:         $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
                   7349:         $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
                   7350:         $outcome = &put('file_permissions',\%new_values,$domain,$user);
                   7351:         #  remove lock
                   7352:         my @del_lock = ($file_name."\0".'locked_access_records');
                   7353:         my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818     raeburn  7354:         my $sqlresult =
1.970     raeburn  7355:             &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818     raeburn  7356:                                     $group);
1.749     raeburn  7357:     } else {
                   7358:         $outcome = "error: could not obtain lockfile\n";  
1.745     raeburn  7359:     }
1.749     raeburn  7360:     return ($outcome,$deloutcome,\%new_values,\%translation);
1.745     raeburn  7361: }
                   7362: 
1.827     raeburn  7363: sub make_public_indefinitely {
                   7364:     my ($requrl) = @_;
                   7365:     my $now = time;
                   7366:     my $action = 'activate';
                   7367:     my $aclnum = 0;
                   7368:     if (&is_portfolio_url($requrl)) {
                   7369:         my (undef,$udom,$unum,$file_name,$group) =
                   7370:             &parse_portfolio_url($requrl);
                   7371:         my $current_perms = &get_portfile_permissions($udom,$unum);
                   7372:         my %access_controls = &get_access_controls($current_perms,
                   7373:                                                    $group,$file_name);
                   7374:         foreach my $key (keys(%{$access_controls{$file_name}})) {
                   7375:             my ($num,$scope,$end,$start) = 
                   7376:                 ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
                   7377:             if ($scope eq 'public') {
                   7378:                 if ($start <= $now && $end == 0) {
                   7379:                     $action = 'none';
                   7380:                 } else {
                   7381:                     $action = 'update';
                   7382:                     $aclnum = $num;
                   7383:                 }
                   7384:                 last;
                   7385:             }
                   7386:         }
                   7387:         if ($action eq 'none') {
                   7388:              return 'ok';
                   7389:         } else {
                   7390:             my %changes;
                   7391:             my $newend = 0;
                   7392:             my $newstart = $now;
                   7393:             my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
                   7394:             $changes{$action}{$newkey} = {
                   7395:                 type => 'public',
                   7396:                 time => {
                   7397:                     start => $newstart,
                   7398:                     end   => $newend,
                   7399:                 },
                   7400:             };
                   7401:             my ($outcome,$deloutcome,$new_values,$translation) =
                   7402:                 &modify_access_controls($file_name,\%changes,$udom,$unum);
                   7403:             return $outcome;
                   7404:         }
                   7405:     } else {
                   7406:         return 'invalid';
                   7407:     }
                   7408: }
                   7409: 
1.745     raeburn  7410: #------------------------------------------------------Get Marked as Read Only
                   7411: 
                   7412: sub get_marked_as_readonly {
                   7413:     my ($domain,$user,$what,$group) = @_;
                   7414:     my $current_permissions = &get_portfile_permissions($domain,$user);
1.563     banghart 7415:     my @readonly_files;
1.629     banghart 7416:     my $cmp1=$what;
                   7417:     if (ref($what)) { $cmp1=join('',@{$what}) };
1.745     raeburn  7418:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   7419:         if (defined($group)) {
                   7420:             if ($file_name !~ m-^\Q$group\E/-) {
                   7421:                 next;
                   7422:             }
                   7423:         }
1.561     banghart 7424:         if (ref($value) eq "ARRAY"){
                   7425:             foreach my $stored_what (@{$value}) {
1.629     banghart 7426:                 my $cmp2=$stored_what;
1.759     albertel 7427:                 if (ref($stored_what) eq 'ARRAY') {
1.746     raeburn  7428:                     $cmp2=join('',@{$stored_what});
1.745     raeburn  7429:                 }
1.629     banghart 7430:                 if ($cmp1 eq $cmp2) {
1.561     banghart 7431:                     push(@readonly_files, $file_name);
1.745     raeburn  7432:                     last;
1.563     banghart 7433:                 } elsif (!defined($what)) {
                   7434:                     push(@readonly_files, $file_name);
1.745     raeburn  7435:                     last;
1.561     banghart 7436:                 }
                   7437:             }
1.745     raeburn  7438:         }
1.561     banghart 7439:     }
                   7440:     return @readonly_files;
                   7441: }
1.577     banghart 7442: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561     banghart 7443: 
1.577     banghart 7444: sub get_marked_as_readonly_hash {
1.745     raeburn  7445:     my ($current_permissions,$group,$what) = @_;
1.577     banghart 7446:     my %readonly_files;
1.745     raeburn  7447:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   7448:         if (defined($group)) {
                   7449:             if ($file_name !~ m-^\Q$group\E/-) {
                   7450:                 next;
                   7451:             }
                   7452:         }
1.577     banghart 7453:         if (ref($value) eq "ARRAY"){
                   7454:             foreach my $stored_what (@{$value}) {
1.745     raeburn  7455:                 if (ref($stored_what) eq 'ARRAY') {
1.750     banghart 7456:                     foreach my $lock_descriptor(@{$stored_what}) {
                   7457:                         if ($lock_descriptor eq 'graded') {
                   7458:                             $readonly_files{$file_name} = 'graded';
                   7459:                         } elsif ($lock_descriptor eq 'handback') {
                   7460:                             $readonly_files{$file_name} = 'handback';
                   7461:                         } else {
                   7462:                             if (!exists($readonly_files{$file_name})) {
                   7463:                                 $readonly_files{$file_name} = 'locked';
                   7464:                             }
                   7465:                         }
1.745     raeburn  7466:                     }
1.750     banghart 7467:                 } 
1.577     banghart 7468:             }
                   7469:         } 
                   7470:     }
                   7471:     return %readonly_files;
                   7472: }
1.559     banghart 7473: # ------------------------------------------------------------ Unmark as Read Only
                   7474: 
                   7475: sub unmark_as_readonly {
1.629     banghart 7476:     # unmarks $file_name (if $file_name is defined), or all files locked by $what 
                   7477:     # for portfolio submissions, $what contains [$symb,$crsid] 
1.745     raeburn  7478:     my ($domain,$user,$what,$file_name,$group) = @_;
1.759     albertel 7479:     $file_name = &declutter_portfile($file_name);
1.634     albertel 7480:     my $symb_crs = $what;
                   7481:     if (ref($what)) { $symb_crs=join('',@$what); }
1.745     raeburn  7482:     my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615     albertel 7483:     my ($tmp)=keys(%current_permissions);
                   7484:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  7485:     my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650     albertel 7486:     foreach my $file (@readonly_files) {
1.759     albertel 7487: 	my $clean_file = &declutter_portfile($file);
                   7488: 	if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650     albertel 7489: 	my $current_locks = $current_permissions{$file};
1.563     banghart 7490:         my @new_locks;
                   7491:         my @del_keys;
                   7492:         if (ref($current_locks) eq "ARRAY"){
                   7493:             foreach my $locker (@{$current_locks}) {
1.632     albertel 7494:                 my $compare=$locker;
1.749     raeburn  7495:                 if (ref($locker) eq 'ARRAY') {
1.745     raeburn  7496:                     $compare=join('',@{$locker});
1.746     raeburn  7497:                     if ($compare ne $symb_crs) {
                   7498:                         push(@new_locks, $locker);
                   7499:                     }
1.563     banghart 7500:                 }
                   7501:             }
1.650     albertel 7502:             if (scalar(@new_locks) > 0) {
1.563     banghart 7503:                 $current_permissions{$file} = \@new_locks;
                   7504:             } else {
                   7505:                 push(@del_keys, $file);
1.613     albertel 7506:                 &del('file_permissions',\@del_keys, $domain, $user);
1.650     albertel 7507:                 delete($current_permissions{$file});
1.563     banghart 7508:             }
                   7509:         }
1.561     banghart 7510:     }
1.613     albertel 7511:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 7512:     return;
                   7513: }
1.512     banghart 7514: 
1.17      www      7515: # ------------------------------------------------------------ Directory lister
                   7516: 
                   7517: sub dirlist {
1.955     raeburn  7518:     my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18      www      7519:     $uri=~s/^\///;
                   7520:     $uri=~s/\/$//;
1.253     stredwic 7521:     my ($udom, $uname);
1.955     raeburn  7522:     if ($getuserdir) {
1.253     stredwic 7523:         $udom = $userdomain;
                   7524:         $uname = $username;
1.955     raeburn  7525:     } else {
                   7526:         (undef,$udom,$uname)=split(/\//,$uri);
                   7527:         if(defined($userdomain)) {
                   7528:             $udom = $userdomain;
                   7529:         }
                   7530:         if(defined($username)) {
                   7531:             $uname = $username;
                   7532:         }
1.253     stredwic 7533:     }
1.955     raeburn  7534:     my ($dirRoot,$listing,@listing_results);
1.253     stredwic 7535: 
1.955     raeburn  7536:     $dirRoot = $perlvar{'lonDocRoot'};
                   7537:     if (defined($getpropath)) {
                   7538:         $dirRoot = &propath($udom,$uname);
1.253     stredwic 7539:         $dirRoot =~ s/\/$//;
1.955     raeburn  7540:     } elsif (defined($getuserdir)) {
                   7541:         my $subdir=$uname.'__';
                   7542:         $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   7543:         $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
                   7544:                    ."/$udom/$subdir/$uname";
                   7545:     } elsif (defined($alternateRoot)) {
                   7546:         $dirRoot = $alternateRoot;
1.751     banghart 7547:     }
1.253     stredwic 7548: 
                   7549:     if($udom) {
                   7550:         if($uname) {
1.955     raeburn  7551:             $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956     raeburn  7552:                               .$getuserdir.':'.&escape($dirRoot)
1.955     raeburn  7553:                               .':'.&escape($uname).':'.&escape($udom),
                   7554:                               &homeserver($uname,$udom));
                   7555:             if ($listing eq 'unknown_cmd') {
                   7556:                 $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
                   7557:                                   &homeserver($uname,$udom));
                   7558:             } else {
                   7559:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   7560:             }
1.605     matthew  7561:             if ($listing eq 'unknown_cmd') {
1.800     albertel 7562:                 $listing = &reply('ls:'.$dirRoot.'/'.$uri,
                   7563: 				  &homeserver($uname,$udom));
1.605     matthew  7564:                 @listing_results = split(/:/,$listing);
                   7565:             } else {
                   7566:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   7567:             }
                   7568:             return @listing_results;
1.955     raeburn  7569:         } elsif(!$alternateRoot) {
1.800     albertel 7570:             my %allusers;
1.841     albertel 7571: 	    my %servers = &get_servers($udom,'library');
1.955     raeburn  7572:  	    foreach my $tryserver (keys(%servers)) {
                   7573:                 $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
                   7574:                                   &escape($udom),$tryserver);
                   7575:                 if ($listing eq 'unknown_cmd') {
                   7576: 		    $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
                   7577: 				      $udom, $tryserver);
                   7578:                 } else {
                   7579:                     @listing_results = map { &unescape($_); } split(/:/,$listing);
                   7580:                 }
1.841     albertel 7581: 		if ($listing eq 'unknown_cmd') {
                   7582: 		    $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
                   7583: 				      $udom, $tryserver);
                   7584: 		    @listing_results = split(/:/,$listing);
                   7585: 		} else {
                   7586: 		    @listing_results =
                   7587: 			map { &unescape($_); } split(/:/,$listing);
                   7588: 		}
                   7589: 		if ($listing_results[0] ne 'no_such_dir' && 
                   7590: 		    $listing_results[0] ne 'empty'       &&
                   7591: 		    $listing_results[0] ne 'con_lost') {
                   7592: 		    foreach my $line (@listing_results) {
                   7593: 			my ($entry) = split(/&/,$line,2);
                   7594: 			$allusers{$entry} = 1;
                   7595: 		    }
                   7596: 		}
1.253     stredwic 7597:             }
                   7598:             my $alluserstr='';
1.800     albertel 7599:             foreach my $user (sort(keys(%allusers))) {
                   7600:                 $alluserstr.=$user.'&user:';
1.253     stredwic 7601:             }
                   7602:             $alluserstr=~s/:$//;
                   7603:             return split(/:/,$alluserstr);
                   7604:         } else {
1.800     albertel 7605:             return ('missing user name');
1.253     stredwic 7606:         }
1.955     raeburn  7607:     } elsif(!defined($getpropath)) {
1.841     albertel 7608:         my @all_domains = sort(&all_domains());
1.955     raeburn  7609:         foreach my $domain (@all_domains) {
                   7610:             $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
                   7611:         }
                   7612:         return @all_domains;
                   7613:     } else {
1.800     albertel 7614:         return ('missing domain');
1.275     stredwic 7615:     }
                   7616: }
                   7617: 
                   7618: # --------------------------------------------- GetFileTimestamp
                   7619: # This function utilizes dirlist and returns the date stamp for
                   7620: # when it was last modified.  It will also return an error of -1
                   7621: # if an error occurs
                   7622: 
                   7623: sub GetFileTimestamp {
1.955     raeburn  7624:     my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807     albertel 7625:     $studentDomain = &LONCAPA::clean_domain($studentDomain);
                   7626:     $studentName   = &LONCAPA::clean_username($studentName);
1.955     raeburn  7627:     my ($fileStat) = 
                   7628:         &Apache::lonnet::dirlist($filename,$studentDomain,$studentName, 
                   7629:                                  undef,$getuserdir);
1.275     stredwic 7630:     my @stats = split('&', $fileStat);
                   7631:     if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375     matthew  7632:         # @stats contains first the filename, then the stat output
                   7633:         return $stats[10]; # so this is 10 instead of 9.
1.275     stredwic 7634:     } else {
                   7635:         return -1;
1.253     stredwic 7636:     }
1.26      www      7637: }
                   7638: 
1.712     albertel 7639: sub stat_file {
                   7640:     my ($uri) = @_;
1.787     albertel 7641:     $uri = &clutter_with_no_wrapper($uri);
1.722     albertel 7642: 
1.955     raeburn  7643:     my ($udom,$uname,$file);
1.712     albertel 7644:     if ($uri =~ m-^/(uploaded|editupload)/-) {
                   7645: 	($udom,$uname,$file) =
1.811     albertel 7646: 	    ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712     albertel 7647: 	$file = 'userfiles/'.$file;
                   7648:     }
                   7649:     if ($uri =~ m-^/res/-) {
                   7650: 	($udom,$uname) = 
1.807     albertel 7651: 	    ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712     albertel 7652: 	$file = $uri;
                   7653:     }
                   7654: 
                   7655:     if (!$udom || !$uname || !$file) {
                   7656: 	# unable to handle the uri
                   7657: 	return ();
                   7658:     }
1.956     raeburn  7659:     my $getpropath;
                   7660:     if ($file =~ /^userfiles\//) {
                   7661:         $getpropath = 1;
                   7662:     }
1.955     raeburn  7663:     my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712     albertel 7664:     my @stats = split('&', $result);
1.721     banghart 7665:     
1.712     albertel 7666:     if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
                   7667: 	shift(@stats); #filename is first
                   7668: 	return @stats;
                   7669:     }
                   7670:     return ();
                   7671: }
                   7672: 
1.26      www      7673: # -------------------------------------------------------- Value of a Condition
                   7674: 
1.713     albertel 7675: # gets the value of a specific preevaluated condition
                   7676: #    stored in the string  $env{user.state.<cid>}
                   7677: # or looks up a condition reference in the bighash and if if hasn't
                   7678: # already been evaluated recurses into docondval to get the value of
                   7679: # the condition, then memoizing it to 
                   7680: #   $env{user.state.<cid>.<condition>}
1.40      www      7681: sub directcondval {
                   7682:     my $number=shift;
1.620     albertel 7683:     if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555     albertel 7684: 	&Apache::lonuserstate::evalstate();
                   7685:     }
1.713     albertel 7686:     if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
                   7687: 	return $env{'user.state.'.$env{'request.course.id'}.".$number"};
                   7688:     } elsif ($number =~ /^_/) {
                   7689: 	my $sub_condition;
                   7690: 	if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   7691: 		&GDBM_READER(),0640)) {
                   7692: 	    $sub_condition=$bighash{'conditions'.$number};
                   7693: 	    untie(%bighash);
                   7694: 	}
                   7695: 	my $value = &docondval($sub_condition);
1.949     raeburn  7696: 	&appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713     albertel 7697: 	return $value;
                   7698:     }
1.620     albertel 7699:     if ($env{'user.state.'.$env{'request.course.id'}}) {
                   7700:        return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40      www      7701:     } else {
                   7702:        return 2;
                   7703:     }
                   7704: }
                   7705: 
1.713     albertel 7706: # get the collection of conditions for this resource
1.26      www      7707: sub condval {
                   7708:     my $condidx=shift;
1.54      www      7709:     my $allpathcond='';
1.713     albertel 7710:     foreach my $cond (split(/\|/,$condidx)) {
                   7711: 	if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
                   7712: 	    $allpathcond.=
                   7713: 		'('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
                   7714: 	}
1.191     harris41 7715:     }
1.54      www      7716:     $allpathcond=~s/\|$//;
1.713     albertel 7717:     return &docondval($allpathcond);
                   7718: }
                   7719: 
                   7720: #evaluates an expression of conditions
                   7721: sub docondval {
                   7722:     my ($allpathcond) = @_;
                   7723:     my $result=0;
                   7724:     if ($env{'request.course.id'}
                   7725: 	&& defined($allpathcond)) {
                   7726: 	my $operand='|';
                   7727: 	my @stack;
                   7728: 	foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
                   7729: 	    if ($chunk eq '(') {
                   7730: 		push @stack,($operand,$result);
                   7731: 	    } elsif ($chunk eq ')') {
                   7732: 		my $before=pop @stack;
                   7733: 		if (pop @stack eq '&') {
                   7734: 		    $result=$result>$before?$before:$result;
                   7735: 		} else {
                   7736: 		    $result=$result>$before?$result:$before;
                   7737: 		}
                   7738: 	    } elsif (($chunk eq '&') || ($chunk eq '|')) {
                   7739: 		$operand=$chunk;
                   7740: 	    } else {
                   7741: 		my $new=directcondval($chunk);
                   7742: 		if ($operand eq '&') {
                   7743: 		    $result=$result>$new?$new:$result;
                   7744: 		} else {
                   7745: 		    $result=$result>$new?$result:$new;
                   7746: 		}
                   7747: 	    }
                   7748: 	}
1.26      www      7749:     }
                   7750:     return $result;
1.421     albertel 7751: }
                   7752: 
                   7753: # ---------------------------------------------------- Devalidate courseresdata
                   7754: 
                   7755: sub devalidatecourseresdata {
                   7756:     my ($coursenum,$coursedomain)=@_;
                   7757:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 7758:     &devalidate_cache_new('courseres',$hashid);
1.28      www      7759: }
                   7760: 
1.763     www      7761: 
1.200     www      7762: # --------------------------------------------------- Course Resourcedata Query
1.878     foxr     7763: #
                   7764: #  Parameters:
                   7765: #      $coursenum    - Number of the course.
                   7766: #      $coursedomain - Domain at which the course was created.
                   7767: #  Returns:
                   7768: #     A hash of the course parameters along (I think) with timestamps
                   7769: #     and version info.
1.877     foxr     7770: 
1.624     albertel 7771: sub get_courseresdata {
                   7772:     my ($coursenum,$coursedomain)=@_;
1.200     www      7773:     my $coursehom=&homeserver($coursenum,$coursedomain);
                   7774:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 7775:     my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624     albertel 7776:     my %dumpreply;
1.417     albertel 7777:     unless (defined($cached)) {
1.624     albertel 7778: 	%dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417     albertel 7779: 	$result=\%dumpreply;
1.251     albertel 7780: 	my ($tmp) = keys(%dumpreply);
                   7781: 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599     albertel 7782: 	    &do_cache_new('courseres',$hashid,$result,600);
1.306     albertel 7783: 	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
                   7784: 	    return $tmp;
1.416     albertel 7785: 	} elsif ($tmp =~ /^(error)/) {
1.417     albertel 7786: 	    $result=undef;
1.599     albertel 7787: 	    &do_cache_new('courseres',$hashid,$result,600);
1.250     albertel 7788: 	}
                   7789:     }
1.624     albertel 7790:     return $result;
                   7791: }
                   7792: 
1.633     albertel 7793: sub devalidateuserresdata {
                   7794:     my ($uname,$udom)=@_;
                   7795:     my $hashid="$udom:$uname";
                   7796:     &devalidate_cache_new('userres',$hashid);
                   7797: }
                   7798: 
1.624     albertel 7799: sub get_userresdata {
                   7800:     my ($uname,$udom)=@_;
                   7801:     #most student don\'t have any data set, check if there is some data
                   7802:     if (&EXT_cache_status($udom,$uname)) { return undef; }
                   7803: 
                   7804:     my $hashid="$udom:$uname";
                   7805:     my ($result,$cached)=&is_cached_new('userres',$hashid);
                   7806:     if (!defined($cached)) {
                   7807: 	my %resourcedata=&dump('resourcedata',$udom,$uname);
                   7808: 	$result=\%resourcedata;
                   7809: 	&do_cache_new('userres',$hashid,$result,600);
                   7810:     }
                   7811:     my ($tmp)=keys(%$result);
                   7812:     if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
                   7813: 	return $result;
                   7814:     }
                   7815:     #error 2 occurs when the .db doesn't exist
                   7816:     if ($tmp!~/error: 2 /) {
1.672     albertel 7817: 	&logthis("<font color=\"blue\">WARNING:".
1.624     albertel 7818: 		 " Trying to get resource data for ".
                   7819: 		 $uname." at ".$udom.": ".
                   7820: 		 $tmp."</font>");
                   7821:     } elsif ($tmp=~/error: 2 /) {
1.633     albertel 7822: 	#&EXT_cache_set($udom,$uname);
                   7823: 	&do_cache_new('userres',$hashid,undef,600);
1.636     albertel 7824: 	undef($tmp); # not really an error so don't send it back
1.624     albertel 7825:     }
                   7826:     return $tmp;
                   7827: }
1.879     foxr     7828: #----------------------------------------------- resdata - return resource data
                   7829: #  Purpose:
                   7830: #    Return resource data for either users or for a course.
                   7831: #  Parameters:
                   7832: #     $name      - Course/user name.
                   7833: #     $domain    - Name of the domain the user/course is registered on.
                   7834: #     $type      - Type of thing $name is (must be 'course' or 'user'
                   7835: #     @which     - Array of names of resources desired.
                   7836: #  Returns:
                   7837: #     The value of the first reasource in @which that is found in the
                   7838: #     resource hash.
                   7839: #  Exceptional Conditions:
                   7840: #     If the $type passed in is not valid (not the string 'course' or 
                   7841: #     'user', an undefined  reference is returned.
                   7842: #     If none of the resources are found, an undef is returned
1.624     albertel 7843: sub resdata {
                   7844:     my ($name,$domain,$type,@which)=@_;
                   7845:     my $result;
                   7846:     if ($type eq 'course') {
                   7847: 	$result=&get_courseresdata($name,$domain);
                   7848:     } elsif ($type eq 'user') {
                   7849: 	$result=&get_userresdata($name,$domain);
                   7850:     }
                   7851:     if (!ref($result)) { return $result; }    
1.251     albertel 7852:     foreach my $item (@which) {
1.927     albertel 7853: 	if (defined($result->{$item->[0]})) {
                   7854: 	    return [$result->{$item->[0]},$item->[1]];
1.251     albertel 7855: 	}
1.250     albertel 7856:     }
1.291     albertel 7857:     return undef;
1.200     www      7858: }
                   7859: 
1.379     matthew  7860: #
                   7861: # EXT resource caching routines
                   7862: #
                   7863: 
                   7864: sub clear_EXT_cache_status {
1.383     albertel 7865:     &delenv('cache.EXT.');
1.379     matthew  7866: }
                   7867: 
                   7868: sub EXT_cache_status {
                   7869:     my ($target_domain,$target_user) = @_;
1.383     albertel 7870:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620     albertel 7871:     if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379     matthew  7872:         # We know already the user has no data
                   7873:         return 1;
                   7874:     } else {
                   7875:         return 0;
                   7876:     }
                   7877: }
                   7878: 
                   7879: sub EXT_cache_set {
                   7880:     my ($target_domain,$target_user) = @_;
1.383     albertel 7881:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949     raeburn  7882:     #&appenv({$cachename => time});
1.379     matthew  7883: }
                   7884: 
1.28      www      7885: # --------------------------------------------------------- Value of a Variable
1.58      www      7886: sub EXT {
1.715     albertel 7887: 
1.395     albertel 7888:     my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68      www      7889:     unless ($varname) { return ''; }
1.218     albertel 7890:     #get real user name/domain, courseid and symb
                   7891:     my $courseid;
1.359     albertel 7892:     my $publicuser;
1.427     www      7893:     if ($symbparm) {
                   7894: 	$symbparm=&get_symb_from_alias($symbparm);
                   7895:     }
1.218     albertel 7896:     if (!($uname && $udom)) {
1.790     albertel 7897:       (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218     albertel 7898:       if (!$symbparm) {	$symbparm=$cursymb; }
                   7899:     } else {
1.620     albertel 7900: 	$courseid=$env{'request.course.id'};
1.218     albertel 7901:     }
1.48      www      7902:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
                   7903:     my $rest;
1.320     albertel 7904:     if (defined($therest[0])) {
1.48      www      7905:        $rest=join('.',@therest);
                   7906:     } else {
                   7907:        $rest='';
                   7908:     }
1.320     albertel 7909: 
1.57      www      7910:     my $qualifierrest=$qualifier;
                   7911:     if ($rest) { $qualifierrest.='.'.$rest; }
                   7912:     my $spacequalifierrest=$space;
                   7913:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28      www      7914:     if ($realm eq 'user') {
1.48      www      7915: # --------------------------------------------------------------- user.resource
                   7916: 	if ($space eq 'resource') {
1.651     albertel 7917: 	    if ( (defined($Apache::lonhomework::parsing_a_problem)
                   7918: 		  || defined($Apache::lonhomework::parsing_a_task))
                   7919: 		 &&
1.744     albertel 7920: 		 ($symbparm eq &symbread()) ) {	
                   7921: 		# if we are in the middle of processing the resource the
                   7922: 		# get the value we are planning on committing
                   7923:                 if (defined($Apache::lonhomework::results{$qualifierrest})) {
                   7924:                     return $Apache::lonhomework::results{$qualifierrest};
                   7925:                 } else {
                   7926:                     return $Apache::lonhomework::history{$qualifierrest};
                   7927:                 }
1.335     albertel 7928: 	    } else {
1.359     albertel 7929: 		my %restored;
1.620     albertel 7930: 		if ($publicuser || $env{'request.state'} eq 'construct') {
1.359     albertel 7931: 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
                   7932: 		} else {
                   7933: 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
                   7934: 		}
1.335     albertel 7935: 		return $restored{$qualifierrest};
                   7936: 	    }
1.48      www      7937: # ----------------------------------------------------------------- user.access
                   7938:         } elsif ($space eq 'access') {
1.218     albertel 7939: 	    # FIXME - not supporting calls for a specific user
1.48      www      7940:             return &allowed($qualifier,$rest);
                   7941: # ------------------------------------------ user.preferences, user.environment
                   7942:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620     albertel 7943: 	    if (($uname eq $env{'user.name'}) &&
                   7944: 		($udom eq $env{'user.domain'})) {
                   7945: 		return $env{join('.',('environment',$qualifierrest))};
1.218     albertel 7946: 	    } else {
1.359     albertel 7947: 		my %returnhash;
                   7948: 		if (!$publicuser) {
                   7949: 		    %returnhash=&userenvironment($udom,$uname,
                   7950: 						 $qualifierrest);
                   7951: 		}
1.218     albertel 7952: 		return $returnhash{$qualifierrest};
                   7953: 	    }
1.48      www      7954: # ----------------------------------------------------------------- user.course
                   7955:         } elsif ($space eq 'course') {
1.218     albertel 7956: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 7957:             return $env{join('.',('request.course',$qualifier))};
1.48      www      7958: # ------------------------------------------------------------------- user.role
                   7959:         } elsif ($space eq 'role') {
1.218     albertel 7960: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 7961:             my ($role,$where)=split(/\./,$env{'request.role'});
1.48      www      7962:             if ($qualifier eq 'value') {
                   7963: 		return $role;
                   7964:             } elsif ($qualifier eq 'extent') {
                   7965:                 return $where;
                   7966:             }
                   7967: # ----------------------------------------------------------------- user.domain
                   7968:         } elsif ($space eq 'domain') {
1.218     albertel 7969:             return $udom;
1.48      www      7970: # ------------------------------------------------------------------- user.name
                   7971:         } elsif ($space eq 'name') {
1.218     albertel 7972:             return $uname;
1.48      www      7973: # ---------------------------------------------------- Any other user namespace
1.29      www      7974:         } else {
1.359     albertel 7975: 	    my %reply;
                   7976: 	    if (!$publicuser) {
                   7977: 		%reply=&get($space,[$qualifierrest],$udom,$uname);
                   7978: 	    }
                   7979: 	    return $reply{$qualifierrest};
1.48      www      7980:         }
1.236     www      7981:     } elsif ($realm eq 'query') {
                   7982: # ---------------------------------------------- pull stuff out of query string
1.384     albertel 7983:         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                   7984: 						[$spacequalifierrest]);
1.620     albertel 7985: 	return $env{'form.'.$spacequalifierrest}; 
1.236     www      7986:    } elsif ($realm eq 'request') {
1.48      www      7987: # ------------------------------------------------------------- request.browser
                   7988:         if ($space eq 'browser') {
1.430     www      7989: 	    if ($qualifier eq 'textremote') {
1.676     albertel 7990: 		if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430     www      7991: 		    return 1;
                   7992: 		} else {
                   7993: 		    return 0;
                   7994: 		}
                   7995: 	    } else {
1.620     albertel 7996: 		return $env{'browser.'.$qualifier};
1.430     www      7997: 	    }
1.57      www      7998: # ------------------------------------------------------------ request.filename
                   7999:         } else {
1.620     albertel 8000:             return $env{'request.'.$spacequalifierrest};
1.29      www      8001:         }
1.28      www      8002:     } elsif ($realm eq 'course') {
1.48      www      8003: # ---------------------------------------------------------- course.description
1.620     albertel 8004:         return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57      www      8005:     } elsif ($realm eq 'resource') {
1.165     www      8006: 
1.620     albertel 8007: 	if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539     albertel 8008: 	    if (!$symbparm) { $symbparm=&symbread(); }
                   8009: 	}
1.693     albertel 8010: 
                   8011: 	if ($space eq 'title') {
                   8012: 	    if (!$symbparm) { $symbparm = $env{'request.filename'}; }
                   8013: 	    return &gettitle($symbparm);
                   8014: 	}
                   8015: 	
                   8016: 	if ($space eq 'map') {
                   8017: 	    my ($map) = &decode_symb($symbparm);
                   8018: 	    return &symbread($map);
                   8019: 	}
1.905     albertel 8020: 	if ($space eq 'filename') {
                   8021: 	    if ($symbparm) {
                   8022: 		return &clutter((&decode_symb($symbparm))[2]);
                   8023: 	    }
                   8024: 	    return &hreflocation('',$env{'request.filename'});
                   8025: 	}
1.693     albertel 8026: 
                   8027: 	my ($section, $group, @groups);
1.593     albertel 8028: 	my ($courselevelm,$courselevel);
1.539     albertel 8029: 	if ($symbparm && defined($courseid) && 
1.620     albertel 8030: 	    $courseid eq $env{'request.course.id'}) {
1.165     www      8031: 
1.218     albertel 8032: 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165     www      8033: 
1.60      www      8034: # ----------------------------------------------------- Cascading lookup scheme
1.218     albertel 8035: 	    my $symbp=$symbparm;
1.735     albertel 8036: 	    my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218     albertel 8037: 
                   8038: 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
                   8039: 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
                   8040: 
1.620     albertel 8041: 	    if (($env{'user.name'} eq $uname) &&
                   8042: 		($env{'user.domain'} eq $udom)) {
                   8043: 		$section=$env{'request.course.sec'};
1.733     raeburn  8044:                 @groups = split(/:/,$env{'request.course.groups'});  
                   8045:                 @groups=&sort_course_groups($courseid,@groups); 
1.218     albertel 8046: 	    } else {
1.539     albertel 8047: 		if (! defined($usection)) {
1.551     albertel 8048: 		    $section=&getsection($udom,$uname,$courseid);
1.539     albertel 8049: 		} else {
                   8050: 		    $section = $usection;
                   8051: 		}
1.733     raeburn  8052:                 @groups = &get_users_groups($udom,$uname,$courseid);
1.218     albertel 8053: 	    }
                   8054: 
                   8055: 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
                   8056: 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
                   8057: 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
                   8058: 
1.593     albertel 8059: 	    $courselevel=$courseid.'.'.$spacequalifierrest;
1.218     albertel 8060: 	    my $courselevelr=$courseid.'.'.$symbparm;
1.593     albertel 8061: 	    $courselevelm=$courseid.'.'.$mapparm;
1.69      www      8062: 
1.60      www      8063: # ----------------------------------------------------------- first, check user
1.624     albertel 8064: 
                   8065: 	    my $userreply=&resdata($uname,$udom,'user',
1.927     albertel 8066: 				       ([$courselevelr,'resource'],
                   8067: 					[$courselevelm,'map'     ],
                   8068: 					[$courselevel, 'course'  ]));
1.931     albertel 8069: 	    if (defined($userreply)) { return &get_reply($userreply); }
1.95      www      8070: 
1.594     albertel 8071: # ------------------------------------------------ second, check some of course
1.684     raeburn  8072:             my $coursereply;
1.691     raeburn  8073:             if (@groups > 0) {
                   8074:                 $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
                   8075:                                        $mapparm,$spacequalifierrest);
1.927     albertel 8076:                 if (defined($coursereply)) { return &get_reply($coursereply); }
1.684     raeburn  8077:             }
1.96      www      8078: 
1.684     raeburn  8079: 	    $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927     albertel 8080: 				  $env{'course.'.$courseid.'.domain'},
                   8081: 				  'course',
                   8082: 				  ([$seclevelr,   'resource'],
                   8083: 				   [$seclevelm,   'map'     ],
                   8084: 				   [$seclevel,    'course'  ],
                   8085: 				   [$courselevelr,'resource']));
                   8086: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.200     www      8087: 
1.60      www      8088: # ------------------------------------------------------ third, check map parms
1.218     albertel 8089: 	    my %parmhash=();
                   8090: 	    my $thisparm='';
                   8091: 	    if (tie(%parmhash,'GDBM_File',
1.620     albertel 8092: 		    $env{'request.course.fn'}.'_parms.db',
1.256     albertel 8093: 		    &GDBM_READER(),0640)) {
1.218     albertel 8094: 		$thisparm=$parmhash{$symbparm};
                   8095: 		untie(%parmhash);
                   8096: 	    }
1.927     albertel 8097: 	    if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218     albertel 8098: 	}
1.594     albertel 8099: # ------------------------------------------ fourth, look in resource metadata
1.71      www      8100: 
1.218     albertel 8101: 	$spacequalifierrest=~s/\./\_/;
1.282     albertel 8102: 	my $filename;
                   8103: 	if (!$symbparm) { $symbparm=&symbread(); }
                   8104: 	if ($symbparm) {
1.409     www      8105: 	    $filename=(&decode_symb($symbparm))[2];
1.282     albertel 8106: 	} else {
1.620     albertel 8107: 	    $filename=$env{'request.filename'};
1.282     albertel 8108: 	}
                   8109: 	my $metadata=&metadata($filename,$spacequalifierrest);
1.927     albertel 8110: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282     albertel 8111: 	$metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927     albertel 8112: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142     www      8113: 
1.927     albertel 8114: # ---------------------------------------------- fourth, look in rest of course
1.593     albertel 8115: 	if ($symbparm && defined($courseid) && 
1.620     albertel 8116: 	    $courseid eq $env{'request.course.id'}) {
1.624     albertel 8117: 	    my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
                   8118: 				     $env{'course.'.$courseid.'.domain'},
                   8119: 				     'course',
1.927     albertel 8120: 				     ([$courselevelm,'map'   ],
                   8121: 				      [$courselevel, 'course']));
                   8122: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.593     albertel 8123: 	}
1.145     www      8124: # ------------------------------------------------------------------ Cascade up
1.218     albertel 8125: 	unless ($space eq '0') {
1.336     albertel 8126: 	    my @parts=split(/_/,$space);
                   8127: 	    my $id=pop(@parts);
                   8128: 	    my $part=join('_',@parts);
                   8129: 	    if ($part eq '') { $part='0'; }
1.927     albertel 8130: 	    my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395     albertel 8131: 				 $symbparm,$udom,$uname,$section,1);
1.938     raeburn  8132: 	    if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218     albertel 8133: 	}
1.395     albertel 8134: 	if ($recurse) { return undef; }
                   8135: 	my $pack_def=&packages_tab_default($filename,$varname);
1.927     albertel 8136: 	if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48      www      8137: # ---------------------------------------------------- Any other user namespace
                   8138:     } elsif ($realm eq 'environment') {
                   8139: # ----------------------------------------------------------------- environment
1.620     albertel 8140: 	if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
                   8141: 	    return $env{'environment.'.$spacequalifierrest};
1.219     albertel 8142: 	} else {
1.770     albertel 8143: 	    if ($uname eq 'anonymous' && $udom eq '') {
                   8144: 		return '';
                   8145: 	    }
1.219     albertel 8146: 	    my %returnhash=&userenvironment($udom,$uname,
                   8147: 					    $spacequalifierrest);
                   8148: 	    return $returnhash{$spacequalifierrest};
                   8149: 	}
1.28      www      8150:     } elsif ($realm eq 'system') {
1.48      www      8151: # ----------------------------------------------------------------- system.time
                   8152: 	if ($space eq 'time') {
                   8153: 	    return time;
                   8154:         }
1.696     albertel 8155:     } elsif ($realm eq 'server') {
                   8156: # ----------------------------------------------------------------- system.time
                   8157: 	if ($space eq 'name') {
                   8158: 	    return $ENV{'SERVER_NAME'};
                   8159:         }
1.28      www      8160:     }
1.48      www      8161:     return '';
1.61      www      8162: }
                   8163: 
1.927     albertel 8164: sub get_reply {
                   8165:     my ($reply_value) = @_;
1.940     raeburn  8166:     if (ref($reply_value) eq 'ARRAY') {
                   8167:         if (wantarray) {
                   8168: 	    return @$reply_value;
                   8169:         }
                   8170:         return $reply_value->[0];
                   8171:     } else {
                   8172:         return $reply_value;
1.927     albertel 8173:     }
                   8174: }
                   8175: 
1.691     raeburn  8176: sub check_group_parms {
                   8177:     my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
                   8178:     my @groupitems = ();
                   8179:     my $resultitem;
1.927     albertel 8180:     my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691     raeburn  8181:     foreach my $group (@{$groups}) {
                   8182:         foreach my $level (@levels) {
1.927     albertel 8183:              my $item = $courseid.'.['.$group.'].'.$level->[0];
                   8184:              push(@groupitems,[$item,$level->[1]]);
1.691     raeburn  8185:         }
                   8186:     }
                   8187:     my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
                   8188:                             $env{'course.'.$courseid.'.domain'},
                   8189:                                      'course',@groupitems);
                   8190:     return $coursereply;
                   8191: }
                   8192: 
                   8193: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733     raeburn  8194:     my ($courseid,@groups) = @_;
                   8195:     @groups = sort(@groups);
1.691     raeburn  8196:     return @groups;
                   8197: }
                   8198: 
1.395     albertel 8199: sub packages_tab_default {
                   8200:     my ($uri,$varname)=@_;
                   8201:     my (undef,$part,$name)=split(/\./,$varname);
1.738     albertel 8202: 
                   8203:     my (@extension,@specifics,$do_default);
                   8204:     foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395     albertel 8205: 	my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738     albertel 8206: 	if ($pack_type eq 'default') {
                   8207: 	    $do_default=1;
                   8208: 	} elsif ($pack_type eq 'extension') {
                   8209: 	    push(@extension,[$package,$pack_type,$pack_part]);
1.885     albertel 8210: 	} elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848     albertel 8211: 	    # only look at packages defaults for packages that this id is
1.738     albertel 8212: 	    push(@specifics,[$package,$pack_type,$pack_part]);
                   8213: 	}
                   8214:     }
                   8215:     # first look for a package that matches the requested part id
                   8216:     foreach my $package (@specifics) {
                   8217: 	my (undef,$pack_type,$pack_part)=@{$package};
                   8218: 	next if ($pack_part ne $part);
                   8219: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   8220: 	    return $packagetab{"$pack_type&$name&default"};
                   8221: 	}
                   8222:     }
                   8223:     # look for any possible matching non extension_ package
                   8224:     foreach my $package (@specifics) {
                   8225: 	my (undef,$pack_type,$pack_part)=@{$package};
1.468     albertel 8226: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   8227: 	    return $packagetab{"$pack_type&$name&default"};
                   8228: 	}
1.585     albertel 8229: 	if ($pack_type eq 'part') { $pack_part='0'; }
1.468     albertel 8230: 	if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
                   8231: 	    return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395     albertel 8232: 	}
                   8233:     }
1.738     albertel 8234:     # look for any posible extension_ match
                   8235:     foreach my $package (@extension) {
                   8236: 	my ($package,$pack_type)=@{$package};
                   8237: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   8238: 	    return $packagetab{"$pack_type&$name&default"};
                   8239: 	}
                   8240: 	if (defined($packagetab{$package."&$name&default"})) {
                   8241: 	    return $packagetab{$package."&$name&default"};
                   8242: 	}
                   8243:     }
                   8244:     # look for a global default setting
                   8245:     if ($do_default && defined($packagetab{"default&$name&default"})) {
                   8246: 	return $packagetab{"default&$name&default"};
                   8247:     }
1.395     albertel 8248:     return undef;
                   8249: }
                   8250: 
1.334     albertel 8251: sub add_prefix_and_part {
                   8252:     my ($prefix,$part)=@_;
                   8253:     my $keyroot;
                   8254:     if (defined($prefix) && $prefix !~ /^__/) {
                   8255: 	# prefix that has a part already
                   8256: 	$keyroot=$prefix;
                   8257:     } elsif (defined($prefix)) {
                   8258: 	# prefix that is missing a part
                   8259: 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
                   8260:     } else {
                   8261: 	# no prefix at all
                   8262: 	if (defined($part)) { $keyroot='_'.$part; }
                   8263:     }
                   8264:     return $keyroot;
                   8265: }
                   8266: 
1.71      www      8267: # ---------------------------------------------------------------- Get metadata
                   8268: 
1.599     albertel 8269: my %metaentry;
1.71      www      8270: sub metadata {
1.176     www      8271:     my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71      www      8272:     $uri=&declutter($uri);
1.288     albertel 8273:     # if it is a non metadata possible uri return quickly
1.529     albertel 8274:     if (($uri eq '') || 
                   8275: 	(($uri =~ m|^/*adm/|) && 
1.698     albertel 8276: 	     ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924     albertel 8277:         ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
                   8278: 	return undef;
                   8279:     }
                   8280:     if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) 
                   8281: 	&& &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468     albertel 8282: 	return undef;
1.288     albertel 8283:     }
1.73      www      8284:     my $filename=$uri;
                   8285:     $uri=~s/\.meta$//;
1.172     www      8286: #
                   8287: # Is the metadata already cached?
1.177     www      8288: # Look at timestamp of caching
1.172     www      8289: # Everything is cached by the main uri, libraries are never directly cached
                   8290: #
1.428     albertel 8291:     if (!defined($liburi)) {
1.599     albertel 8292: 	my ($result,$cached)=&is_cached_new('meta',$uri);
1.428     albertel 8293: 	if (defined($cached)) { return $result->{':'.$what}; }
                   8294:     }
                   8295:     {
1.172     www      8296: #
                   8297: # Is this a recursive call for a library?
                   8298: #
1.599     albertel 8299: #	if (! exists($metacache{$uri})) {
                   8300: #	    $metacache{$uri}={};
                   8301: #	}
1.924     albertel 8302: 	my $cachetime = 60*60;
1.171     www      8303:         if ($liburi) {
                   8304: 	    $liburi=&declutter($liburi);
                   8305:             $filename=$liburi;
1.401     bowersj2 8306:         } else {
1.599     albertel 8307: 	    &devalidate_cache_new('meta',$uri);
                   8308: 	    undef(%metaentry);
1.401     bowersj2 8309: 	}
1.140     www      8310:         my %metathesekeys=();
1.73      www      8311:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489     albertel 8312: 	my $metastring;
1.924     albertel 8313: 	if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929     albertel 8314: 	    my $which = &hreflocation('','/'.($liburi || $uri));
1.924     albertel 8315: 	    $metastring = 
1.929     albertel 8316: 		&Apache::lonnet::ssi_body($which,
1.924     albertel 8317: 					  ('grade_target' => 'meta'));
                   8318: 	    $cachetime = 1; # only want this cached in the child not long term
                   8319: 	} elsif ($uri !~ m -^(editupload)/-) {
1.543     albertel 8320: 	    my $file=&filelocation('',&clutter($filename));
1.599     albertel 8321: 	    #push(@{$metaentry{$uri.'.file'}},$file);
1.543     albertel 8322: 	    $metastring=&getfile($file);
1.489     albertel 8323: 	}
1.208     albertel 8324:         my $parser=HTML::LCParser->new(\$metastring);
1.71      www      8325:         my $token;
1.140     www      8326:         undef %metathesekeys;
1.71      www      8327:         while ($token=$parser->get_token) {
1.339     albertel 8328: 	    if ($token->[0] eq 'S') {
                   8329: 		if (defined($token->[2]->{'package'})) {
1.172     www      8330: #
                   8331: # This is a package - get package info
                   8332: #
1.339     albertel 8333: 		    my $package=$token->[2]->{'package'};
                   8334: 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   8335: 		    if (defined($token->[2]->{'id'})) { 
                   8336: 			$keyroot.='_'.$token->[2]->{'id'}; 
                   8337: 		    }
1.599     albertel 8338: 		    if ($metaentry{':packages'}) {
                   8339: 			$metaentry{':packages'}.=','.$package.$keyroot;
1.339     albertel 8340: 		    } else {
1.599     albertel 8341: 			$metaentry{':packages'}=$package.$keyroot;
1.339     albertel 8342: 		    }
1.736     albertel 8343: 		    foreach my $pack_entry (keys(%packagetab)) {
1.432     albertel 8344: 			my $part=$keyroot;
                   8345: 			$part=~s/^\_//;
1.736     albertel 8346: 			if ($pack_entry=~/^\Q$package\E\&/ || 
                   8347: 			    $pack_entry=~/^\Q$package\E_0\&/) {
                   8348: 			    my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395     albertel 8349: 			    # ignore package.tab specified default values
                   8350:                             # here &package_tab_default() will fetch those
                   8351: 			    if ($subp eq 'default') { next; }
1.736     albertel 8352: 			    my $value=$packagetab{$pack_entry};
1.432     albertel 8353: 			    my $unikey;
                   8354: 			    if ($pack =~ /_0$/) {
                   8355: 				$unikey='parameter_0_'.$name;
                   8356: 				$part=0;
                   8357: 			    } else {
                   8358: 				$unikey='parameter'.$keyroot.'_'.$name;
                   8359: 			    }
1.339     albertel 8360: 			    if ($subp eq 'display') {
                   8361: 				$value.=' [Part: '.$part.']';
                   8362: 			    }
1.599     albertel 8363: 			    $metaentry{':'.$unikey.'.part'}=$part;
1.395     albertel 8364: 			    $metathesekeys{$unikey}=1;
1.599     albertel 8365: 			    unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   8366: 				$metaentry{':'.$unikey.'.'.$subp}=$value;
1.339     albertel 8367: 			    }
1.599     albertel 8368: 			    if (defined($metaentry{':'.$unikey.'.default'})) {
                   8369: 				$metaentry{':'.$unikey}=
                   8370: 				    $metaentry{':'.$unikey.'.default'};
1.356     albertel 8371: 			    }
1.339     albertel 8372: 			}
                   8373: 		    }
                   8374: 		} else {
1.172     www      8375: #
                   8376: # This is not a package - some other kind of start tag
1.339     albertel 8377: #
                   8378: 		    my $entry=$token->[1];
                   8379: 		    my $unikey;
                   8380: 		    if ($entry eq 'import') {
                   8381: 			$unikey='';
                   8382: 		    } else {
                   8383: 			$unikey=$entry;
                   8384: 		    }
                   8385: 		    $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   8386: 
                   8387: 		    if (defined($token->[2]->{'id'})) { 
                   8388: 			$unikey.='_'.$token->[2]->{'id'}; 
                   8389: 		    }
1.175     www      8390: 
1.339     albertel 8391: 		    if ($entry eq 'import') {
1.175     www      8392: #
                   8393: # Importing a library here
1.339     albertel 8394: #
                   8395: 			if ($depthcount<20) {
                   8396: 			    my $location=$parser->get_text('/import');
                   8397: 			    my $dir=$filename;
                   8398: 			    $dir=~s|[^/]*$||;
                   8399: 			    $location=&filelocation($dir,$location);
1.736     albertel 8400: 			    my $metadata = 
                   8401: 				&metadata($uri,'keys', $location,$unikey,
                   8402: 					  $depthcount+1);
                   8403: 			    foreach my $meta (split(',',$metadata)) {
                   8404: 				$metaentry{':'.$meta}=$metaentry{':'.$meta};
                   8405: 				$metathesekeys{$meta}=1;
1.339     albertel 8406: 			    }
                   8407: 			}
                   8408: 		    } else { 
                   8409: 			
                   8410: 			if (defined($token->[2]->{'name'})) { 
                   8411: 			    $unikey.='_'.$token->[2]->{'name'}; 
                   8412: 			}
                   8413: 			$metathesekeys{$unikey}=1;
1.736     albertel 8414: 			foreach my $param (@{$token->[3]}) {
                   8415: 			    $metaentry{':'.$unikey.'.'.$param} =
                   8416: 				$token->[2]->{$param};
1.339     albertel 8417: 			}
                   8418: 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599     albertel 8419: 			my $default=$metaentry{':'.$unikey.'.default'};
1.339     albertel 8420: 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
                   8421: 		 # only ws inside the tag, and not in default, so use default
                   8422: 		 # as value
1.599     albertel 8423: 			    $metaentry{':'.$unikey}=$default;
1.908     albertel 8424: 			} elsif ( $internaltext =~ /\S/ ) {
                   8425: 		  # something interesting inside the tag
                   8426: 			    $metaentry{':'.$unikey}=$internaltext;
1.339     albertel 8427: 			} else {
1.908     albertel 8428: 		  # no interesting values, don't set a default
1.339     albertel 8429: 			}
1.172     www      8430: # end of not-a-package not-a-library import
1.339     albertel 8431: 		    }
1.172     www      8432: # end of not-a-package start tag
1.339     albertel 8433: 		}
1.172     www      8434: # the next is the end of "start tag"
1.339     albertel 8435: 	    }
                   8436: 	}
1.483     albertel 8437: 	my ($extension) = ($uri =~ /\.(\w+)$/);
1.883     albertel 8438: 	$extension = lc($extension);
                   8439: 	if ($extension eq 'htm') { $extension='html'; }
                   8440: 
1.737     albertel 8441: 	foreach my $key (keys(%packagetab)) {
1.483     albertel 8442: 	    #no specific packages #how's our extension
                   8443: 	    if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488     albertel 8444: 	    &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483     albertel 8445: 					 \%metathesekeys);
                   8446: 	}
1.883     albertel 8447: 
                   8448: 	if (!exists($metaentry{':packages'})
                   8449: 	    || $packagetab{"import_defaults&extension_$extension"}) {
1.737     albertel 8450: 	    foreach my $key (keys(%packagetab)) {
1.483     albertel 8451: 		#no specific packages well let's get default then
                   8452: 		if ($key!~/^default&/) { next; }
1.488     albertel 8453: 		&metadata_create_package_def($uri,$key,'default',
1.483     albertel 8454: 					     \%metathesekeys);
                   8455: 	    }
                   8456: 	}
1.338     www      8457: # are there custom rights to evaluate
1.599     albertel 8458: 	if ($metaentry{':copyright'} eq 'custom') {
1.339     albertel 8459: 
1.338     www      8460:     #
                   8461:     # Importing a rights file here
1.339     albertel 8462:     #
                   8463: 	    unless ($depthcount) {
1.599     albertel 8464: 		my $location=$metaentry{':customdistributionfile'};
1.339     albertel 8465: 		my $dir=$filename;
                   8466: 		$dir=~s|[^/]*$||;
                   8467: 		$location=&filelocation($dir,$location);
1.736     albertel 8468: 		my $rights_metadata =
                   8469: 		    &metadata($uri,'keys',$location,'_rights',
                   8470: 			      $depthcount+1);
                   8471: 		foreach my $rights (split(',',$rights_metadata)) {
                   8472: 		    #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
                   8473: 		    $metathesekeys{$rights}=1;
1.339     albertel 8474: 		}
                   8475: 	    }
                   8476: 	}
1.737     albertel 8477: 	# uniqifiy package listing
                   8478: 	my %seen;
                   8479: 	my @uniq_packages =
                   8480: 	    grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
                   8481: 	$metaentry{':packages'} = join(',',@uniq_packages);
                   8482: 
                   8483: 	$metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599     albertel 8484: 	&metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
                   8485: 	$metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924     albertel 8486: 	&do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177     www      8487: # this is the end of "was not already recently cached
1.71      www      8488:     }
1.599     albertel 8489:     return $metaentry{':'.$what};
1.261     albertel 8490: }
                   8491: 
1.488     albertel 8492: sub metadata_create_package_def {
1.483     albertel 8493:     my ($uri,$key,$package,$metathesekeys)=@_;
                   8494:     my ($pack,$name,$subp)=split(/\&/,$key);
                   8495:     if ($subp eq 'default') { next; }
                   8496:     
1.599     albertel 8497:     if (defined($metaentry{':packages'})) {
                   8498: 	$metaentry{':packages'}.=','.$package;
1.483     albertel 8499:     } else {
1.599     albertel 8500: 	$metaentry{':packages'}=$package;
1.483     albertel 8501:     }
                   8502:     my $value=$packagetab{$key};
                   8503:     my $unikey;
                   8504:     $unikey='parameter_0_'.$name;
1.599     albertel 8505:     $metaentry{':'.$unikey.'.part'}=0;
1.483     albertel 8506:     $$metathesekeys{$unikey}=1;
1.599     albertel 8507:     unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   8508: 	$metaentry{':'.$unikey.'.'.$subp}=$value;
1.483     albertel 8509:     }
1.599     albertel 8510:     if (defined($metaentry{':'.$unikey.'.default'})) {
                   8511: 	$metaentry{':'.$unikey}=
                   8512: 	    $metaentry{':'.$unikey.'.default'};
1.483     albertel 8513:     }
                   8514: }
                   8515: 
1.261     albertel 8516: sub metadata_generate_part0 {
                   8517:     my ($metadata,$metacache,$uri) = @_;
                   8518:     my %allnames;
1.737     albertel 8519:     foreach my $metakey (keys(%$metadata)) {
1.261     albertel 8520: 	if ($metakey=~/^parameter\_(.*)/) {
1.428     albertel 8521: 	  my $part=$$metacache{':'.$metakey.'.part'};
                   8522: 	  my $name=$$metacache{':'.$metakey.'.name'};
1.356     albertel 8523: 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261     albertel 8524: 	    $allnames{$name}=$part;
                   8525: 	  }
                   8526: 	}
                   8527:     }
                   8528:     foreach my $name (keys(%allnames)) {
                   8529:       $$metadata{"parameter_0_$name"}=1;
1.428     albertel 8530:       my $key=":parameter_0_$name";
1.261     albertel 8531:       $$metacache{"$key.part"}='0';
                   8532:       $$metacache{"$key.name"}=$name;
1.428     albertel 8533:       $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261     albertel 8534: 					   $allnames{$name}.'_'.$name.
                   8535: 					   '.type'};
1.428     albertel 8536:       my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261     albertel 8537: 			     '.display'};
1.644     www      8538:       my $expr='[Part: '.$allnames{$name}.']';
1.479     albertel 8539:       $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261     albertel 8540:       $$metacache{"$key.display"}=$olddis;
                   8541:     }
1.71      www      8542: }
                   8543: 
1.764     albertel 8544: # ------------------------------------------------------ Devalidate title cache
                   8545: 
                   8546: sub devalidate_title_cache {
                   8547:     my ($url)=@_;
                   8548:     if (!$env{'request.course.id'}) { return; }
                   8549:     my $symb=&symbread($url);
                   8550:     if (!$symb) { return; }
                   8551:     my $key=$env{'request.course.id'}."\0".$symb;
                   8552:     &devalidate_cache_new('title',$key);
                   8553: }
                   8554: 
1.1014    droeschl 8555: # ------------------------------------------------- Get the title of a course
                   8556: 
                   8557: sub current_course_title {
                   8558:     return $env{ 'course.' . $env{'request.course.id'} . '.description' };
                   8559: }
1.301     www      8560: # ------------------------------------------------- Get the title of a resource
                   8561: 
                   8562: sub gettitle {
                   8563:     my $urlsymb=shift;
                   8564:     my $symb=&symbread($urlsymb);
1.534     albertel 8565:     if ($symb) {
1.620     albertel 8566: 	my $key=$env{'request.course.id'}."\0".$symb;
1.599     albertel 8567: 	my ($result,$cached)=&is_cached_new('title',$key);
1.575     albertel 8568: 	if (defined($cached)) { 
                   8569: 	    return $result;
                   8570: 	}
1.534     albertel 8571: 	my ($map,$resid,$url)=&decode_symb($symb);
                   8572: 	my $title='';
1.907     albertel 8573: 	if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
                   8574: 	    $title = $env{'course.'.$env{'request.course.id'}.'.description'};
                   8575: 	} else {
                   8576: 	    if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   8577: 		    &GDBM_READER(),0640)) {
                   8578: 		my $mapid=$bighash{'map_pc_'.&clutter($map)};
                   8579: 		$title=$bighash{'title_'.$mapid.'.'.$resid};
                   8580: 		untie(%bighash);
                   8581: 	    }
1.534     albertel 8582: 	}
                   8583: 	$title=~s/\&colon\;/\:/gs;
                   8584: 	if ($title) {
1.599     albertel 8585: 	    return &do_cache_new('title',$key,$title,600);
1.534     albertel 8586: 	}
                   8587: 	$urlsymb=$url;
                   8588:     }
                   8589:     my $title=&metadata($urlsymb,'title');
                   8590:     if (!$title) { $title=(split('/',$urlsymb))[-1]; }    
                   8591:     return $title;
1.301     www      8592: }
1.613     albertel 8593: 
1.614     albertel 8594: sub get_slot {
                   8595:     my ($which,$cnum,$cdom)=@_;
                   8596:     if (!$cnum || !$cdom) {
1.790     albertel 8597: 	(undef,my $courseid)=&whichuser();
1.620     albertel 8598: 	$cdom=$env{'course.'.$courseid.'.domain'};
                   8599: 	$cnum=$env{'course.'.$courseid.'.num'};
1.614     albertel 8600:     }
1.703     albertel 8601:     my $key=join("\0",'slots',$cdom,$cnum,$which);
                   8602:     my %slotinfo;
                   8603:     if (exists($remembered{$key})) {
                   8604: 	$slotinfo{$which} = $remembered{$key};
                   8605:     } else {
                   8606: 	%slotinfo=&get('slots',[$which],$cdom,$cnum);
                   8607: 	&Apache::lonhomework::showhash(%slotinfo);
                   8608: 	my ($tmp)=keys(%slotinfo);
                   8609: 	if ($tmp=~/^error:/) { return (); }
                   8610: 	$remembered{$key} = $slotinfo{$which};
                   8611:     }
1.616     albertel 8612:     if (ref($slotinfo{$which}) eq 'HASH') {
                   8613: 	return %{$slotinfo{$which}};
                   8614:     }
                   8615:     return $slotinfo{$which};
1.614     albertel 8616: }
1.31      www      8617: # ------------------------------------------------- Update symbolic store links
                   8618: 
                   8619: sub symblist {
                   8620:     my ($mapname,%newhash)=@_;
1.438     www      8621:     $mapname=&deversion(&declutter($mapname));
1.31      www      8622:     my %hash;
1.620     albertel 8623:     if (($env{'request.course.fn'}) && (%newhash)) {
                   8624:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 8625:                       &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  8626: 	    foreach my $url (keys(%newhash)) {
1.711     albertel 8627: 		next if ($url eq 'last_known'
                   8628: 			 && $env{'form.no_update_last_known'});
                   8629: 		$hash{declutter($url)}=&encode_symb($mapname,
                   8630: 						    $newhash{$url}->[1],
                   8631: 						    $newhash{$url}->[0]);
1.191     harris41 8632:             }
1.31      www      8633:             if (untie(%hash)) {
                   8634: 		return 'ok';
                   8635:             }
                   8636:         }
                   8637:     }
                   8638:     return 'error';
1.212     www      8639: }
                   8640: 
                   8641: # --------------------------------------------------------------- Verify a symb
                   8642: 
                   8643: sub symbverify {
1.510     www      8644:     my ($symb,$thisurl)=@_;
                   8645:     my $thisfn=$thisurl;
1.439     www      8646:     $thisfn=&declutter($thisfn);
1.215     www      8647: # direct jump to resource in page or to a sequence - will construct own symbs
                   8648:     if ($thisfn=~/\.(page|sequence)$/) { return 1; }
                   8649: # check URL part
1.409     www      8650:     my ($map,$resid,$url)=&decode_symb($symb);
1.439     www      8651: 
1.431     www      8652:     unless ($url eq $thisfn) { return 0; }
1.213     www      8653: 
1.216     www      8654:     $symb=&symbclean($symb);
1.510     www      8655:     $thisurl=&deversion($thisurl);
1.439     www      8656:     $thisfn=&deversion($thisfn);
1.213     www      8657: 
                   8658:     my %bighash;
                   8659:     my $okay=0;
1.431     www      8660: 
1.620     albertel 8661:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 8662:                             &GDBM_READER(),0640)) {
1.1032    raeburn  8663:         if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
                   8664:             $thisurl =~ s/\?.+$//;
                   8665:         }
1.510     www      8666:         my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216     www      8667:         unless ($ids) { 
1.510     www      8668:            $ids=$bighash{'ids_/'.$thisurl};
1.216     www      8669:         }
                   8670:         if ($ids) {
                   8671: # ------------------------------------------------------------------- Has ID(s)
1.800     albertel 8672: 	    foreach my $id (split(/\,/,$ids)) {
                   8673: 	       my ($mapid,$resid)=split(/\./,$id);
1.1032    raeburn  8674:                if ($thisfn =~ m{^/adm/wrapper/ext/}) {
                   8675:                    $symb =~ s/\?.+$//;
                   8676:                }
1.216     www      8677:                if (
                   8678:   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
                   8679:    eq $symb) { 
1.620     albertel 8680: 		   if (($env{'request.role.adv'}) ||
1.800     albertel 8681: 		       $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582     albertel 8682: 		       $okay=1; 
                   8683: 		   }
                   8684: 	       }
1.216     www      8685: 	   }
                   8686:         }
1.213     www      8687: 	untie(%bighash);
                   8688:     }
                   8689:     return $okay;
1.31      www      8690: }
                   8691: 
1.210     www      8692: # --------------------------------------------------------------- Clean-up symb
                   8693: 
                   8694: sub symbclean {
                   8695:     my $symb=shift;
1.568     albertel 8696:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210     www      8697: # remove version from map
                   8698:     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215     www      8699: 
1.210     www      8700: # remove version from URL
                   8701:     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213     www      8702: 
1.507     www      8703: # remove wrapper
                   8704: 
1.510     www      8705:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694     albertel 8706:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210     www      8707:     return $symb;
1.409     www      8708: }
                   8709: 
                   8710: # ---------------------------------------------- Split symb to find map and url
1.429     albertel 8711: 
                   8712: sub encode_symb {
                   8713:     my ($map,$resid,$url)=@_;
                   8714:     return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
                   8715: }
1.409     www      8716: 
                   8717: sub decode_symb {
1.568     albertel 8718:     my $symb=shift;
                   8719:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
                   8720:     my ($map,$resid,$url)=split(/___/,$symb);
1.413     www      8721:     return (&fixversion($map),$resid,&fixversion($url));
                   8722: }
                   8723: 
                   8724: sub fixversion {
                   8725:     my $fn=shift;
1.609     banghart 8726:     if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435     www      8727:     my %bighash;
                   8728:     my $uri=&clutter($fn);
1.620     albertel 8729:     my $key=$env{'request.course.id'}.'_'.$uri;
1.440     www      8730: # is this cached?
1.599     albertel 8731:     my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440     www      8732:     if (defined($cached)) { return $result; }
                   8733: # unfortunately not cached, or expired
1.620     albertel 8734:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440     www      8735: 	    &GDBM_READER(),0640)) {
                   8736:  	if ($bighash{'version_'.$uri}) {
                   8737:  	    my $version=$bighash{'version_'.$uri};
1.444     www      8738:  	    unless (($version eq 'mostrecent') || 
                   8739: 		    ($version==&getversion($uri))) {
1.440     www      8740:  		$uri=~s/\.(\w+)$/\.$version\.$1/;
                   8741:  	    }
                   8742:  	}
                   8743:  	untie %bighash;
1.413     www      8744:     }
1.599     albertel 8745:     return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438     www      8746: }
                   8747: 
                   8748: sub deversion {
                   8749:     my $url=shift;
                   8750:     $url=~s/\.\d+\.(\w+)$/\.$1/;
                   8751:     return $url;
1.210     www      8752: }
                   8753: 
1.31      www      8754: # ------------------------------------------------------ Return symb list entry
                   8755: 
                   8756: sub symbread {
1.249     www      8757:     my ($thisfn,$donotrecurse)=@_;
1.542     albertel 8758:     my $cache_str='request.symbread.cached.'.$thisfn;
1.620     albertel 8759:     if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242     www      8760: # no filename provided? try from environment
1.44      www      8761:     unless ($thisfn) {
1.620     albertel 8762:         if ($env{'request.symb'}) {
                   8763: 	    return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539     albertel 8764: 	}
1.620     albertel 8765: 	$thisfn=$env{'request.filename'};
1.44      www      8766:     }
1.569     albertel 8767:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242     www      8768: # is that filename actually a symb? Verify, clean, and return
                   8769:     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539     albertel 8770: 	if (&symbverify($thisfn,$1)) {
1.620     albertel 8771: 	    return $env{$cache_str}=&symbclean($thisfn);
1.539     albertel 8772: 	}
1.242     www      8773:     }
1.44      www      8774:     $thisfn=declutter($thisfn);
1.31      www      8775:     my %hash;
1.37      www      8776:     my %bighash;
                   8777:     my $syval='';
1.620     albertel 8778:     if (($env{'request.course.fn'}) && ($thisfn)) {
1.481     raeburn  8779:         my $targetfn = $thisfn;
1.609     banghart 8780:         if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481     raeburn  8781:             $targetfn = 'adm/wrapper/'.$thisfn;
                   8782:         }
1.687     albertel 8783: 	if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
                   8784: 	    $targetfn=$1;
                   8785: 	}
1.620     albertel 8786:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 8787:                       &GDBM_READER(),0640)) {
1.481     raeburn  8788: 	    $syval=$hash{$targetfn};
1.37      www      8789:             untie(%hash);
                   8790:         }
                   8791: # ---------------------------------------------------------- There was an entry
                   8792:         if ($syval) {
1.601     albertel 8793: 	    #unless ($syval=~/\_\d+$/) {
1.620     albertel 8794: 		#unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949     raeburn  8795: 		    #&appenv({'request.ambiguous' => $thisfn});
1.620     albertel 8796: 		    #return $env{$cache_str}='';
1.601     albertel 8797: 		#}    
                   8798: 		#$syval.=$1;
                   8799: 	    #}
1.37      www      8800:         } else {
                   8801: # ------------------------------------------------------- Was not in symb table
1.620     albertel 8802:            if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 8803:                             &GDBM_READER(),0640)) {
1.37      www      8804: # ---------------------------------------------- Get ID(s) for current resource
1.280     www      8805:               my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65      www      8806:               unless ($ids) { 
                   8807:                  $ids=$bighash{'ids_/'.$thisfn};
1.242     www      8808:               }
                   8809:               unless ($ids) {
                   8810: # alias?
                   8811: 		  $ids=$bighash{'mapalias_'.$thisfn};
1.65      www      8812:               }
1.37      www      8813:               if ($ids) {
                   8814: # ------------------------------------------------------------------- Has ID(s)
                   8815:                  my @possibilities=split(/\,/,$ids);
1.39      www      8816:                  if ($#possibilities==0) {
                   8817: # ----------------------------------------------- There is only one possibility
1.37      www      8818: 		     my ($mapid,$resid)=split(/\./,$ids);
1.626     albertel 8819: 		     $syval=&encode_symb($bighash{'map_id_'.$mapid},
                   8820: 						    $resid,$thisfn);
1.249     www      8821:                  } elsif (!$donotrecurse) {
1.39      www      8822: # ------------------------------------------ There is more than one possibility
                   8823:                      my $realpossible=0;
1.800     albertel 8824:                      foreach my $id (@possibilities) {
                   8825: 			 my $file=$bighash{'src_'.$id};
1.39      www      8826:                          if (&allowed('bre',$file)) {
1.800     albertel 8827:          		    my ($mapid,$resid)=split(/\./,$id);
1.39      www      8828:                             if ($bighash{'map_type_'.$mapid} ne 'page') {
                   8829: 				$realpossible++;
1.626     albertel 8830:                                 $syval=&encode_symb($bighash{'map_id_'.$mapid},
                   8831: 						    $resid,$thisfn);
1.39      www      8832:                             }
                   8833: 			 }
1.191     harris41 8834:                      }
1.39      www      8835: 		     if ($realpossible!=1) { $syval=''; }
1.249     www      8836:                  } else {
                   8837:                      $syval='';
1.37      www      8838:                  }
                   8839: 	      }
                   8840:               untie(%bighash)
1.481     raeburn  8841:            }
1.31      www      8842:         }
1.62      www      8843:         if ($syval) {
1.620     albertel 8844: 	    return $env{$cache_str}=$syval;
1.62      www      8845:         }
1.31      www      8846:     }
1.949     raeburn  8847:     &appenv({'request.ambiguous' => $thisfn});
1.620     albertel 8848:     return $env{$cache_str}='';
1.31      www      8849: }
                   8850: 
                   8851: # ---------------------------------------------------------- Return random seed
                   8852: 
1.32      www      8853: sub numval {
                   8854:     my $txt=shift;
                   8855:     $txt=~tr/A-J/0-9/;
                   8856:     $txt=~tr/a-j/0-9/;
                   8857:     $txt=~tr/K-T/0-9/;
                   8858:     $txt=~tr/k-t/0-9/;
                   8859:     $txt=~tr/U-Z/0-5/;
                   8860:     $txt=~tr/u-z/0-5/;
                   8861:     $txt=~s/\D//g;
1.564     albertel 8862:     if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32      www      8863:     return int($txt);
1.368     albertel 8864: }
                   8865: 
1.484     albertel 8866: sub numval2 {
                   8867:     my $txt=shift;
                   8868:     $txt=~tr/A-J/0-9/;
                   8869:     $txt=~tr/a-j/0-9/;
                   8870:     $txt=~tr/K-T/0-9/;
                   8871:     $txt=~tr/k-t/0-9/;
                   8872:     $txt=~tr/U-Z/0-5/;
                   8873:     $txt=~tr/u-z/0-5/;
                   8874:     $txt=~s/\D//g;
                   8875:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   8876:     my $total;
                   8877:     foreach my $val (@txts) { $total+=$val; }
1.564     albertel 8878:     if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484     albertel 8879:     return int($total);
                   8880: }
                   8881: 
1.575     albertel 8882: sub numval3 {
                   8883:     use integer;
                   8884:     my $txt=shift;
                   8885:     $txt=~tr/A-J/0-9/;
                   8886:     $txt=~tr/a-j/0-9/;
                   8887:     $txt=~tr/K-T/0-9/;
                   8888:     $txt=~tr/k-t/0-9/;
                   8889:     $txt=~tr/U-Z/0-5/;
                   8890:     $txt=~tr/u-z/0-5/;
                   8891:     $txt=~s/\D//g;
                   8892:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   8893:     my $total;
                   8894:     foreach my $val (@txts) { $total+=$val; }
                   8895:     if ($_64bit) { $total=(($total<<32)>>32); }
                   8896:     return $total;
                   8897: }
                   8898: 
1.675     albertel 8899: sub digest {
                   8900:     my ($data)=@_;
                   8901:     my $digest=&Digest::MD5::md5($data);
                   8902:     my ($a,$b,$c,$d)=unpack("iiii",$digest);
                   8903:     my ($e,$f);
                   8904:     {
                   8905:         use integer;
                   8906:         $e=($a+$b);
                   8907:         $f=($c+$d);
                   8908:         if ($_64bit) {
                   8909:             $e=(($e<<32)>>32);
                   8910:             $f=(($f<<32)>>32);
                   8911:         }
                   8912:     }
                   8913:     if (wantarray) {
                   8914: 	return ($e,$f);
                   8915:     } else {
                   8916: 	my $g;
                   8917: 	{
                   8918: 	    use integer;
                   8919: 	    $g=($e+$f);
                   8920: 	    if ($_64bit) {
                   8921: 		$g=(($g<<32)>>32);
                   8922: 	    }
                   8923: 	}
                   8924: 	return $g;
                   8925:     }
                   8926: }
                   8927: 
1.368     albertel 8928: sub latest_rnd_algorithm_id {
1.675     albertel 8929:     return '64bit5';
1.366     albertel 8930: }
1.32      www      8931: 
1.503     albertel 8932: sub get_rand_alg {
                   8933:     my ($courseid)=@_;
1.790     albertel 8934:     if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503     albertel 8935:     if ($courseid) {
1.620     albertel 8936: 	return $env{"course.$courseid.rndseed"};
1.503     albertel 8937:     }
                   8938:     return &latest_rnd_algorithm_id();
                   8939: }
                   8940: 
1.562     albertel 8941: sub validCODE {
                   8942:     my ($CODE)=@_;
                   8943:     if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
                   8944:     return 0;
                   8945: }
                   8946: 
1.491     albertel 8947: sub getCODE {
1.620     albertel 8948:     if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618     albertel 8949:     if ( (defined($Apache::lonhomework::parsing_a_problem) ||
                   8950: 	  defined($Apache::lonhomework::parsing_a_task) ) &&
                   8951: 	 &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491     albertel 8952: 	return $Apache::lonhomework::history{'resource.CODE'};
                   8953:     }
                   8954:     return undef;
                   8955: }
                   8956: 
1.31      www      8957: sub rndseed {
1.155     albertel 8958:     my ($symb,$courseid,$domain,$username)=@_;
1.790     albertel 8959:     my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896     albertel 8960:     if (!defined($symb)) {
1.366     albertel 8961: 	unless ($symb=$wsymb) { return time; }
                   8962:     }
                   8963:     if (!$courseid) { $courseid=$wcourseid; }
                   8964:     if (!$domain) { $domain=$wdomain; }
                   8965:     if (!$username) { $username=$wusername }
1.503     albertel 8966:     my $which=&get_rand_alg();
1.803     albertel 8967: 
1.491     albertel 8968:     if (defined(&getCODE())) {
1.675     albertel 8969: 	if ($which eq '64bit5') {
                   8970: 	    return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
                   8971: 	} elsif ($which eq '64bit4') {
1.575     albertel 8972: 	    return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
                   8973: 	} else {
                   8974: 	    return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
                   8975: 	}
1.675     albertel 8976:     } elsif ($which eq '64bit5') {
                   8977: 	return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575     albertel 8978:     } elsif ($which eq '64bit4') {
                   8979: 	return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501     albertel 8980:     } elsif ($which eq '64bit3') {
                   8981: 	return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443     albertel 8982:     } elsif ($which eq '64bit2') {
                   8983: 	return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366     albertel 8984:     } elsif ($which eq '64bit') {
                   8985: 	return &rndseed_64bit($symb,$courseid,$domain,$username);
                   8986:     }
                   8987:     return &rndseed_32bit($symb,$courseid,$domain,$username);
                   8988: }
                   8989: 
                   8990: sub rndseed_32bit {
                   8991:     my ($symb,$courseid,$domain,$username)=@_;
                   8992:     {
                   8993: 	use integer;
                   8994: 	my $symbchck=unpack("%32C*",$symb) << 27;
                   8995: 	my $symbseed=numval($symb) << 22;
                   8996: 	my $namechck=unpack("%32C*",$username) << 17;
                   8997: 	my $nameseed=numval($username) << 12;
                   8998: 	my $domainseed=unpack("%32C*",$domain) << 7;
                   8999: 	my $courseseed=unpack("%32C*",$courseid);
                   9000: 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790     albertel 9001: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   9002: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 9003: 	if ($_64bit) { $num=(($num<<32)>>32); }
1.366     albertel 9004: 	return $num;
                   9005:     }
                   9006: }
                   9007: 
                   9008: sub rndseed_64bit {
                   9009:     my ($symb,$courseid,$domain,$username)=@_;
                   9010:     {
                   9011: 	use integer;
                   9012: 	my $symbchck=unpack("%32S*",$symb) << 21;
                   9013: 	my $symbseed=numval($symb) << 10;
                   9014: 	my $namechck=unpack("%32S*",$username);
                   9015: 	
                   9016: 	my $nameseed=numval($username) << 21;
                   9017: 	my $domainseed=unpack("%32S*",$domain) << 10;
                   9018: 	my $courseseed=unpack("%32S*",$courseid);
                   9019: 	
                   9020: 	my $num1=$symbchck+$symbseed+$namechck;
                   9021: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 9022: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   9023: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 9024: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366     albertel 9025: 	return "$num1,$num2";
1.155     albertel 9026:     }
1.366     albertel 9027: }
                   9028: 
1.443     albertel 9029: sub rndseed_64bit2 {
                   9030:     my ($symb,$courseid,$domain,$username)=@_;
                   9031:     {
                   9032: 	use integer;
                   9033: 	# strings need to be an even # of cahracters long, it it is odd the
                   9034:         # last characters gets thrown away
                   9035: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   9036: 	my $symbseed=numval($symb) << 10;
                   9037: 	my $namechck=unpack("%32S*",$username.' ');
                   9038: 	
                   9039: 	my $nameseed=numval($username) << 21;
1.501     albertel 9040: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   9041: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   9042: 	
                   9043: 	my $num1=$symbchck+$symbseed+$namechck;
                   9044: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 9045: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   9046: 	#&logthis("rndseed :$num:$symb");
1.803     albertel 9047: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501     albertel 9048: 	return "$num1,$num2";
                   9049:     }
                   9050: }
                   9051: 
                   9052: sub rndseed_64bit3 {
                   9053:     my ($symb,$courseid,$domain,$username)=@_;
                   9054:     {
                   9055: 	use integer;
                   9056: 	# strings need to be an even # of cahracters long, it it is odd the
                   9057:         # last characters gets thrown away
                   9058: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   9059: 	my $symbseed=numval2($symb) << 10;
                   9060: 	my $namechck=unpack("%32S*",$username.' ');
                   9061: 	
                   9062: 	my $nameseed=numval2($username) << 21;
1.443     albertel 9063: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   9064: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   9065: 	
                   9066: 	my $num1=$symbchck+$symbseed+$namechck;
                   9067: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 9068: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   9069: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.564     albertel 9070: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
                   9071: 	
1.503     albertel 9072: 	return "$num1:$num2";
1.443     albertel 9073:     }
                   9074: }
                   9075: 
1.575     albertel 9076: sub rndseed_64bit4 {
                   9077:     my ($symb,$courseid,$domain,$username)=@_;
                   9078:     {
                   9079: 	use integer;
                   9080: 	# strings need to be an even # of cahracters long, it it is odd the
                   9081:         # last characters gets thrown away
                   9082: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   9083: 	my $symbseed=numval3($symb) << 10;
                   9084: 	my $namechck=unpack("%32S*",$username.' ');
                   9085: 	
                   9086: 	my $nameseed=numval3($username) << 21;
                   9087: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   9088: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   9089: 	
                   9090: 	my $num1=$symbchck+$symbseed+$namechck;
                   9091: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 9092: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   9093: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.575     albertel 9094: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
                   9095: 	
                   9096: 	return "$num1:$num2";
                   9097:     }
                   9098: }
                   9099: 
1.675     albertel 9100: sub rndseed_64bit5 {
                   9101:     my ($symb,$courseid,$domain,$username)=@_;
                   9102:     my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
                   9103:     return "$num1:$num2";
                   9104: }
                   9105: 
1.366     albertel 9106: sub rndseed_CODE_64bit {
                   9107:     my ($symb,$courseid,$domain,$username)=@_;
1.155     albertel 9108:     {
1.366     albertel 9109: 	use integer;
1.443     albertel 9110: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484     albertel 9111: 	my $symbseed=numval2($symb);
1.491     albertel 9112: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   9113: 	my $CODEseed=numval(&getCODE());
1.443     albertel 9114: 	my $courseseed=unpack("%32S*",$courseid.' ');
1.484     albertel 9115: 	my $num1=$symbseed+$CODEchck;
                   9116: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 9117: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   9118: 	#&logthis("rndseed :$num1:$num2:$symb");
1.564     albertel 9119: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   9120: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503     albertel 9121: 	return "$num1:$num2";
1.366     albertel 9122:     }
                   9123: }
                   9124: 
1.575     albertel 9125: sub rndseed_CODE_64bit4 {
                   9126:     my ($symb,$courseid,$domain,$username)=@_;
                   9127:     {
                   9128: 	use integer;
                   9129: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
                   9130: 	my $symbseed=numval3($symb);
                   9131: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   9132: 	my $CODEseed=numval3(&getCODE());
                   9133: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   9134: 	my $num1=$symbseed+$CODEchck;
                   9135: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 9136: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   9137: 	#&logthis("rndseed :$num1:$num2:$symb");
1.575     albertel 9138: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   9139: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
                   9140: 	return "$num1:$num2";
                   9141:     }
                   9142: }
                   9143: 
1.675     albertel 9144: sub rndseed_CODE_64bit5 {
                   9145:     my ($symb,$courseid,$domain,$username)=@_;
                   9146:     my $code = &getCODE();
                   9147:     my ($num1,$num2)=&digest("$symb,$courseid,$code");
                   9148:     return "$num1:$num2";
                   9149: }
                   9150: 
1.366     albertel 9151: sub setup_random_from_rndseed {
                   9152:     my ($rndseed)=@_;
1.503     albertel 9153:     if ($rndseed =~/([,:])/) {
                   9154: 	my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366     albertel 9155: 	&Math::Random::random_set_seed(abs($num1),abs($num2));
                   9156:     } else {
                   9157: 	&Math::Random::random_set_seed_from_phrase($rndseed);
1.98      albertel 9158:     }
1.36      albertel 9159: }
                   9160: 
1.474     albertel 9161: sub latest_receipt_algorithm_id {
1.835     albertel 9162:     return 'receipt3';
1.474     albertel 9163: }
                   9164: 
1.480     www      9165: sub recunique {
                   9166:     my $fucourseid=shift;
                   9167:     my $unique;
1.835     albertel 9168:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
                   9169: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 9170: 	$unique=$env{"course.$fucourseid.internal.encseed"};
1.480     www      9171:     } else {
                   9172: 	$unique=$perlvar{'lonReceipt'};
                   9173:     }
                   9174:     return unpack("%32C*",$unique);
                   9175: }
                   9176: 
                   9177: sub recprefix {
                   9178:     my $fucourseid=shift;
                   9179:     my $prefix;
1.835     albertel 9180:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
                   9181: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 9182: 	$prefix=$env{"course.$fucourseid.internal.encpref"};
1.480     www      9183:     } else {
                   9184: 	$prefix=$perlvar{'lonHostID'};
                   9185:     }
                   9186:     return unpack("%32C*",$prefix);
                   9187: }
                   9188: 
1.76      www      9189: sub ireceipt {
1.474     albertel 9190:     my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835     albertel 9191: 
                   9192:     my $return =&recprefix($fucourseid).'-';
                   9193: 
                   9194:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
                   9195: 	$env{'request.state'} eq 'construct') {
                   9196: 	$return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
                   9197: 	return $return;
                   9198:     }
                   9199: 
1.76      www      9200:     my $cuname=unpack("%32C*",$funame);
                   9201:     my $cudom=unpack("%32C*",$fudom);
                   9202:     my $cucourseid=unpack("%32C*",$fucourseid);
                   9203:     my $cusymb=unpack("%32C*",$fusymb);
1.480     www      9204:     my $cunique=&recunique($fucourseid);
1.474     albertel 9205:     my $cpart=unpack("%32S*",$part);
1.835     albertel 9206:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
                   9207: 
1.790     albertel 9208: 	#&logthis("doing receipt2  using parts $cpart, uname $cuname and udom $cudom gets  ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474     albertel 9209: 			       
                   9210: 	$return.= ($cunique%$cuname+
                   9211: 		   $cunique%$cudom+
                   9212: 		   $cusymb%$cuname+
                   9213: 		   $cusymb%$cudom+
                   9214: 		   $cucourseid%$cuname+
                   9215: 		   $cucourseid%$cudom+
                   9216: 		   $cpart%$cuname+
                   9217: 		   $cpart%$cudom);
                   9218:     } else {
                   9219: 	$return.= ($cunique%$cuname+
                   9220: 		   $cunique%$cudom+
                   9221: 		   $cusymb%$cuname+
                   9222: 		   $cusymb%$cudom+
                   9223: 		   $cucourseid%$cuname+
                   9224: 		   $cucourseid%$cudom);
                   9225:     }
                   9226:     return $return;
1.76      www      9227: }
                   9228: 
                   9229: sub receipt {
1.474     albertel 9230:     my ($part)=@_;
1.790     albertel 9231:     my ($symb,$courseid,$domain,$name) = &whichuser();
1.474     albertel 9232:     return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76      www      9233: }
1.260     ng       9234: 
1.790     albertel 9235: sub whichuser {
                   9236:     my ($passedsymb)=@_;
                   9237:     my ($symb,$courseid,$domain,$name,$publicuser);
                   9238:     if (defined($env{'form.grade_symb'})) {
                   9239: 	my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
                   9240: 	my $allowed=&allowed('vgr',$tmp_courseid);
                   9241: 	if (!$allowed &&
                   9242: 	    exists($env{'request.course.sec'}) &&
                   9243: 	    $env{'request.course.sec'} !~ /^\s*$/) {
                   9244: 	    $allowed=&allowed('vgr',$tmp_courseid.
                   9245: 			      '/'.$env{'request.course.sec'});
                   9246: 	}
                   9247: 	if ($allowed) {
                   9248: 	    ($symb)=&get_env_multiple('form.grade_symb');
                   9249: 	    $courseid=$tmp_courseid;
                   9250: 	    ($domain)=&get_env_multiple('form.grade_domain');
                   9251: 	    ($name)=&get_env_multiple('form.grade_username');
                   9252: 	    return ($symb,$courseid,$domain,$name,$publicuser);
                   9253: 	}
                   9254:     }
                   9255:     if (!$passedsymb) {
                   9256: 	$symb=&symbread();
                   9257:     } else {
                   9258: 	$symb=$passedsymb;
                   9259:     }
                   9260:     $courseid=$env{'request.course.id'};
                   9261:     $domain=$env{'user.domain'};
                   9262:     $name=$env{'user.name'};
                   9263:     if ($name eq 'public' && $domain eq 'public') {
                   9264: 	if (!defined($env{'form.username'})) {
                   9265: 	    $env{'form.username'}.=time.rand(10000000);
                   9266: 	}
                   9267: 	$name.=$env{'form.username'};
                   9268:     }
                   9269:     return ($symb,$courseid,$domain,$name,$publicuser);
                   9270: 
                   9271: }
                   9272: 
1.36      albertel 9273: # ------------------------------------------------------------ Serves up a file
1.472     albertel 9274: # returns either the contents of the file or 
                   9275: # -1 if the file doesn't exist
1.481     raeburn  9276: #
                   9277: # if the target is a file that was uploaded via DOCS, 
                   9278: # a check will be made to see if a current copy exists on the local server,
                   9279: # if it does this will be served, otherwise a copy will be retrieved from
                   9280: # the home server for the course and stored in /home/httpd/html/userfiles on
                   9281: # the local server.   
1.472     albertel 9282: 
1.36      albertel 9283: sub getfile {
1.538     albertel 9284:     my ($file) = @_;
1.609     banghart 9285:     if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538     albertel 9286:     &repcopy($file);
                   9287:     return &readfile($file);
                   9288: }
                   9289: 
                   9290: sub repcopy_userfile {
                   9291:     my ($file)=@_;
1.609     banghart 9292:     if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610     albertel 9293:     if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538     albertel 9294:     my ($cdom,$cnum,$filename) = 
1.811     albertel 9295: 	($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538     albertel 9296:     my $uri="/uploaded/$cdom/$cnum/$filename";
                   9297:     if (-e "$file") {
1.828     www      9298: # we already have a local copy, check it out
1.538     albertel 9299: 	my @fileinfo = stat($file);
1.828     www      9300: 	my $rtncode;
                   9301: 	my $info;
1.538     albertel 9302: 	my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482     albertel 9303: 	if ($lwpresp ne 'ok') {
1.828     www      9304: # there is no such file anymore, even though we had a local copy
1.482     albertel 9305: 	    if ($rtncode eq '404') {
1.538     albertel 9306: 		unlink($file);
1.482     albertel 9307: 	    }
                   9308: 	    return -1;
                   9309: 	}
                   9310: 	if ($info < $fileinfo[9]) {
1.828     www      9311: # nice, the file we have is up-to-date, just say okay
1.607     raeburn  9312: 	    return 'ok';
1.828     www      9313: 	} else {
                   9314: # the file is outdated, get rid of it
                   9315: 	    unlink($file);
1.482     albertel 9316: 	}
1.828     www      9317:     }
                   9318: # one way or the other, at this point, we don't have the file
                   9319: # construct the correct path for the file
                   9320:     my @parts = ($cdom,$cnum); 
                   9321:     if ($filename =~ m|^(.+)/[^/]+$|) {
                   9322: 	push @parts, split(/\//,$1);
                   9323:     }
                   9324:     my $path = $perlvar{'lonDocRoot'}.'/userfiles';
                   9325:     foreach my $part (@parts) {
                   9326: 	$path .= '/'.$part;
                   9327: 	if (!-e $path) {
                   9328: 	    mkdir($path,0770);
1.482     albertel 9329: 	}
                   9330:     }
1.828     www      9331: # now the path exists for sure
                   9332: # get a user agent
                   9333:     my $ua=new LWP::UserAgent;
                   9334:     my $transferfile=$file.'.in.transfer';
                   9335: # FIXME: this should flock
                   9336:     if (-e $transferfile) { return 'ok'; }
                   9337:     my $request;
                   9338:     $uri=~s/^\///;
1.980     raeburn  9339:     my $homeserver = &homeserver($cnum,$cdom);
                   9340:     my $protocol = $protocol{$homeserver};
                   9341:     $protocol = 'http' if ($protocol ne 'https');
                   9342:     $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828     www      9343:     my $response=$ua->request($request,$transferfile);
                   9344: # did it work?
                   9345:     if ($response->is_error()) {
                   9346: 	unlink($transferfile);
                   9347: 	&logthis("Userfile repcopy failed for $uri");
                   9348: 	return -1;
                   9349:     }
                   9350: # worked, rename the transfer file
                   9351:     rename($transferfile,$file);
1.607     raeburn  9352:     return 'ok';
1.481     raeburn  9353: }
                   9354: 
1.517     albertel 9355: sub tokenwrapper {
                   9356:     my $uri=shift;
1.980     raeburn  9357:     $uri=~s|^https?\://([^/]+)||;
1.552     albertel 9358:     $uri=~s|^/||;
1.620     albertel 9359:     $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517     albertel 9360:     my $token=$1;
1.552     albertel 9361:     my (undef,$udom,$uname,$file)=split('/',$uri,4);
                   9362:     if ($udom && $uname && $file) {
                   9363: 	$file=~s|(\?\.*)*$||;
1.949     raeburn  9364:         &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980     raeburn  9365:         my $homeserver = &homeserver($uname,$udom);
                   9366:         my $protocol = $protocol{$homeserver};
                   9367:         $protocol = 'http' if ($protocol ne 'https');
                   9368:         return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517     albertel 9369:                (($uri=~/\?/)?'&':'?').'token='.$token.
                   9370:                                '&tokenissued='.$perlvar{'lonHostID'};
                   9371:     } else {
                   9372:         return '/adm/notfound.html';
                   9373:     }
                   9374: }
                   9375: 
1.828     www      9376: # call with reqtype HEAD: get last modification time
                   9377: # call with reqtype GET: get the file contents
                   9378: # Do not call this with reqtype GET for large files! It loads everything into memory
                   9379: #
1.481     raeburn  9380: sub getuploaded {
                   9381:     my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
                   9382:     $uri=~s/^\///;
1.980     raeburn  9383:     my $homeserver = &homeserver($cnum,$cdom);
                   9384:     my $protocol = $protocol{$homeserver};
                   9385:     $protocol = 'http' if ($protocol ne 'https');
                   9386:     $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481     raeburn  9387:     my $ua=new LWP::UserAgent;
                   9388:     my $request=new HTTP::Request($reqtype,$uri);
                   9389:     my $response=$ua->request($request);
                   9390:     $$rtncode = $response->code;
1.482     albertel 9391:     if (! $response->is_success()) {
                   9392: 	return 'failed';
                   9393:     }      
                   9394:     if ($reqtype eq 'HEAD') {
1.486     www      9395: 	$$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482     albertel 9396:     } elsif ($reqtype eq 'GET') {
                   9397: 	$$info = $response->content;
1.472     albertel 9398:     }
1.482     albertel 9399:     return 'ok';
1.36      albertel 9400: }
                   9401: 
1.481     raeburn  9402: sub readfile {
                   9403:     my $file = shift;
                   9404:     if ( (! -e $file ) || ($file eq '') ) { return -1; };
                   9405:     my $fh;
                   9406:     open($fh,"<$file");
                   9407:     my $a='';
1.800     albertel 9408:     while (my $line = <$fh>) { $a .= $line; }
1.481     raeburn  9409:     return $a;
                   9410: }
                   9411: 
1.36      albertel 9412: sub filelocation {
1.590     banghart 9413:     my ($dir,$file) = @_;
                   9414:     my $location;
                   9415:     $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700     albertel 9416: 
                   9417:     if ($file =~ m-^/adm/-) {
                   9418: 	$file=~s-^/adm/wrapper/-/-;
                   9419: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
                   9420:     }
1.882     albertel 9421: 
1.590     banghart 9422:     if ($file=~m:^/~:) { # is a contruction space reference
                   9423:         $location = $file;
                   9424:         $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807     albertel 9425:     } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649     albertel 9426: 	# is a correct contruction space reference
                   9427:         $location = $file;
1.956     raeburn  9428:     } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
                   9429:         $location = $file;
1.609     banghart 9430:     } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590     banghart 9431:         my ($udom,$uname,$filename)=
1.811     albertel 9432:   	    ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590     banghart 9433:         my $home=&homeserver($uname,$udom);
                   9434:         my $is_me=0;
                   9435:         my @ids=&current_machine_ids();
                   9436:         foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
                   9437:         if ($is_me) {
1.955     raeburn  9438:   	    $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590     banghart 9439:         } else {
                   9440:   	  $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
                   9441:   	      $udom.'/'.$uname.'/'.$filename;
                   9442:         }
1.882     albertel 9443:     } elsif ($file =~ m-^/adm/-) {
                   9444: 	$location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590     banghart 9445:     } else {
                   9446:         $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
                   9447:         $file=~s:^/res/:/:;
                   9448:         if ( !( $file =~ m:^/:) ) {
                   9449:             $location = $dir. '/'.$file;
                   9450:         } else {
                   9451:             $location = '/home/httpd/html/res'.$file;
                   9452:         }
1.59      albertel 9453:     }
1.590     banghart 9454:     $location=~s://+:/:g; # remove duplicate /
1.930     albertel 9455:     while ($location=~m{/\.\./}) {
                   9456: 	if ($location =~ m{/[^/]+/\.\./}) {
                   9457: 	    $location=~ s{/[^/]+/\.\./}{/}g;
                   9458: 	} else {
                   9459: 	    $location=~ s{/\.\./}{/}g;
                   9460: 	}
                   9461:     } #remove dir/..
1.590     banghart 9462:     while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
                   9463:     return $location;
1.46      www      9464: }
1.36      albertel 9465: 
1.46      www      9466: sub hreflocation {
                   9467:     my ($dir,$file)=@_;
1.980     raeburn  9468:     unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666     albertel 9469: 	$file=filelocation($dir,$file);
1.700     albertel 9470:     } elsif ($file=~m-^/adm/-) {
                   9471: 	$file=~s-^/adm/wrapper/-/-;
                   9472: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
1.666     albertel 9473:     }
                   9474:     if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
                   9475: 	$file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807     albertel 9476:     } elsif ($file=~m-/home/($match_username)/public_html/-) {
                   9477: 	$file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666     albertel 9478:     } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811     albertel 9479: 	$file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666     albertel 9480: 	    -/uploaded/$1/$2/-x;
1.46      www      9481:     }
1.913     albertel 9482:     if ($file=~ m{^/userfiles/}) {
                   9483: 	$file =~ s{^/userfiles/}{/uploaded/};
                   9484:     }
1.462     albertel 9485:     return $file;
1.465     albertel 9486: }
                   9487: 
                   9488: sub current_machine_domains {
1.853     albertel 9489:     return &machine_domains(&hostname($perlvar{'lonHostID'}));
                   9490: }
                   9491: 
                   9492: sub machine_domains {
                   9493:     my ($hostname) = @_;
1.465     albertel 9494:     my @domains;
1.838     albertel 9495:     my %hostname = &all_hostnames();
1.465     albertel 9496:     while( my($id, $name) = each(%hostname)) {
1.467     matthew  9497: #	&logthis("-$id-$name-$hostname-");
1.465     albertel 9498: 	if ($hostname eq $name) {
1.844     albertel 9499: 	    push(@domains,&host_domain($id));
1.465     albertel 9500: 	}
                   9501:     }
                   9502:     return @domains;
                   9503: }
                   9504: 
                   9505: sub current_machine_ids {
1.853     albertel 9506:     return &machine_ids(&hostname($perlvar{'lonHostID'}));
                   9507: }
                   9508: 
                   9509: sub machine_ids {
                   9510:     my ($hostname) = @_;
                   9511:     $hostname ||= &hostname($perlvar{'lonHostID'});
1.465     albertel 9512:     my @ids;
1.888     albertel 9513:     my %name_to_host = &all_names();
1.889     albertel 9514:     if (ref($name_to_host{$hostname}) eq 'ARRAY') {
                   9515: 	return @{ $name_to_host{$hostname} };
                   9516:     }
                   9517:     return;
1.31      www      9518: }
                   9519: 
1.824     raeburn  9520: sub additional_machine_domains {
                   9521:     my @domains;
                   9522:     open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
                   9523:     while( my $line = <$fh>) {
                   9524:         $line =~ s/\s//g;
                   9525:         push(@domains,$line);
                   9526:     }
                   9527:     return @domains;
                   9528: }
                   9529: 
                   9530: sub default_login_domain {
                   9531:     my $domain = $perlvar{'lonDefDomain'};
                   9532:     my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
                   9533:     foreach my $posdom (&current_machine_domains(),
                   9534:                         &additional_machine_domains()) {
                   9535:         if (lc($posdom) eq lc($testdomain)) {
                   9536:             $domain=$posdom;
                   9537:             last;
                   9538:         }
                   9539:     }
                   9540:     return $domain;
                   9541: }
                   9542: 
1.31      www      9543: # ------------------------------------------------------------- Declutters URLs
                   9544: 
                   9545: sub declutter {
                   9546:     my $thisfn=shift;
1.569     albertel 9547:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479     albertel 9548:     $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31      www      9549:     $thisfn=~s/^\///;
1.697     albertel 9550:     $thisfn=~s|^adm/wrapper/||;
                   9551:     $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31      www      9552:     $thisfn=~s/^res\///;
1.1032    raeburn  9553:     unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
                   9554:         $thisfn=~s/\?.+$//;
                   9555:     }
1.268     www      9556:     return $thisfn;
                   9557: }
                   9558: 
                   9559: # ------------------------------------------------------------- Clutter up URLs
                   9560: 
                   9561: sub clutter {
                   9562:     my $thisfn='/'.&declutter(shift);
1.887     albertel 9563:     if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884     albertel 9564: 	|| $thisfn =~ m{^/adm/(includes|pages)} ) { 
1.270     www      9565:        $thisfn='/res'.$thisfn; 
                   9566:     }
1.1031    raeburn  9567:     if ($thisfn !~m|^/adm|) {
                   9568: 	if ($thisfn =~ m|^/ext/|) {
1.694     albertel 9569: 	    $thisfn='/adm/wrapper'.$thisfn;
1.695     albertel 9570: 	} else {
                   9571: 	    my ($ext) = ($thisfn =~ /\.(\w+)$/);
                   9572: 	    my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698     albertel 9573: 	    if ($embstyle eq 'ssi'
                   9574: 		|| ($embstyle eq 'hdn')
                   9575: 		|| ($embstyle eq 'rat')
                   9576: 		|| ($embstyle eq 'prv')
                   9577: 		|| ($embstyle eq 'ign')) {
                   9578: 		#do nothing with these
                   9579: 	    } elsif (($embstyle eq 'img') 
1.695     albertel 9580: 		|| ($embstyle eq 'emb')
                   9581: 		|| ($embstyle eq 'wrp')) {
                   9582: 		$thisfn='/adm/wrapper'.$thisfn;
1.698     albertel 9583: 	    } elsif ($embstyle eq 'unk'
                   9584: 		     && $thisfn!~/\.(sequence|page)$/) {
1.695     albertel 9585: 		$thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698     albertel 9586: 	    } else {
1.718     www      9587: #		&logthis("Got a blank emb style");
1.695     albertel 9588: 	    }
1.694     albertel 9589: 	}
                   9590:     }
1.31      www      9591:     return $thisfn;
1.12      www      9592: }
                   9593: 
1.787     albertel 9594: sub clutter_with_no_wrapper {
                   9595:     my $uri = &clutter(shift);
                   9596:     if ($uri =~ m-^/adm/-) {
                   9597: 	$uri =~ s-^/adm/wrapper/-/-;
                   9598: 	$uri =~ s-^/adm/coursedocs/showdoc/-/-;
                   9599:     }
                   9600:     return $uri;
                   9601: }
                   9602: 
1.557     albertel 9603: sub freeze_escape {
                   9604:     my ($value)=@_;
                   9605:     if (ref($value)) {
                   9606: 	$value=&nfreeze($value);
                   9607: 	return '__FROZEN__'.&escape($value);
                   9608:     }
                   9609:     return &escape($value);
                   9610: }
                   9611: 
1.11      www      9612: 
1.557     albertel 9613: sub thaw_unescape {
                   9614:     my ($value)=@_;
                   9615:     if ($value =~ /^__FROZEN__/) {
                   9616: 	substr($value,0,10,undef);
                   9617: 	$value=&unescape($value);
                   9618: 	return &thaw($value);
                   9619:     }
                   9620:     return &unescape($value);
                   9621: }
                   9622: 
1.436     albertel 9623: sub correct_line_ends {
                   9624:     my ($result)=@_;
                   9625:     $$result =~s/\r\n/\n/mg;
                   9626:     $$result =~s/\r/\n/mg;
1.415     albertel 9627: }
1.1       albertel 9628: # ================================================================ Main Program
                   9629: 
1.184     www      9630: sub goodbye {
1.204     albertel 9631:    &logthis("Starting Shut down");
1.443     albertel 9632: #not converted to using infrastruture and probably shouldn't be
1.870     albertel 9633:    &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443     albertel 9634: #converted
1.599     albertel 9635: #   &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870     albertel 9636:    &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
                   9637: #   &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
                   9638: #   &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425     albertel 9639: #1.1 only
1.870     albertel 9640: #   &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
                   9641: #   &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
                   9642: #   &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
                   9643: #   &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
                   9644:    &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599     albertel 9645:    &logthis(sprintf("%-20s is %s",'kicks',$kicks));
                   9646:    &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184     www      9647:    &flushcourselogs();
                   9648:    &logthis("Shutting down");
                   9649: }
                   9650: 
1.852     albertel 9651: sub get_dns {
1.869     albertel 9652:     my ($url,$func,$ignore_cache) = @_;
                   9653:     if (!$ignore_cache) {
                   9654: 	my ($content,$cached)=
                   9655: 	    &Apache::lonnet::is_cached_new('dns',$url);
                   9656: 	if ($cached) {
                   9657: 	    &$func($content);
                   9658: 	    return;
                   9659: 	}
                   9660:     }
                   9661: 
                   9662:     my %alldns;
1.852     albertel 9663:     open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
                   9664:     foreach my $dns (<$config>) {
                   9665: 	next if ($dns !~ /^\^(\S*)/x);
1.979     raeburn  9666:         my $line = $1;
                   9667:         my ($host,$protocol) = split(/:/,$line);
                   9668:         if ($protocol ne 'https') {
                   9669:             $protocol = 'http';
                   9670:         }
                   9671: 	$alldns{$host} = $protocol;
1.869     albertel 9672:     }
                   9673:     while (%alldns) {
                   9674: 	my ($dns) = keys(%alldns);
1.852     albertel 9675: 	my $ua=new LWP::UserAgent;
1.979     raeburn  9676: 	my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852     albertel 9677: 	my $response=$ua->request($request);
1.979     raeburn  9678:         delete($alldns{$dns});
1.852     albertel 9679: 	next if ($response->is_error());
                   9680: 	my @content = split("\n",$response->content);
1.869     albertel 9681: 	&Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852     albertel 9682: 	&$func(\@content);
1.869     albertel 9683: 	return;
1.852     albertel 9684:     }
                   9685:     close($config);
1.871     albertel 9686:     my $which = (split('/',$url))[3];
                   9687:     &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
                   9688:     open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869     albertel 9689:     my @content = <$config>;
                   9690:     &$func(\@content);
                   9691:     return;
1.852     albertel 9692: }
1.327     albertel 9693: # ------------------------------------------------------------ Read domain file
                   9694: {
1.852     albertel 9695:     my $loaded;
1.846     albertel 9696:     my %domain;
                   9697: 
1.852     albertel 9698:     sub parse_domain_tab {
                   9699: 	my ($lines) = @_;
                   9700: 	foreach my $line (@$lines) {
                   9701: 	    next if ($line =~ /^(\#|\s*$ )/x);
1.403     www      9702: 
1.846     albertel 9703: 	    chomp($line);
1.852     albertel 9704: 	    my ($name,@elements) = split(/:/,$line,9);
1.846     albertel 9705: 	    my %this_domain;
                   9706: 	    foreach my $field ('description', 'auth_def', 'auth_arg_def',
                   9707: 			       'lang_def', 'city', 'longi', 'lati',
                   9708: 			       'primary') {
                   9709: 		$this_domain{$field} = shift(@elements);
                   9710: 	    }
                   9711: 	    $domain{$name} = \%this_domain;
1.852     albertel 9712: 	}
                   9713:     }
1.864     albertel 9714: 
                   9715:     sub reset_domain_info {
                   9716: 	undef($loaded);
                   9717: 	undef(%domain);
                   9718:     }
                   9719: 
1.852     albertel 9720:     sub load_domain_tab {
1.869     albertel 9721: 	my ($ignore_cache) = @_;
                   9722: 	&get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852     albertel 9723: 	my $fh;
                   9724: 	if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
                   9725: 	    my @lines = <$fh>;
                   9726: 	    &parse_domain_tab(\@lines);
1.448     albertel 9727: 	}
1.852     albertel 9728: 	close($fh);
                   9729: 	$loaded = 1;
1.327     albertel 9730:     }
1.846     albertel 9731: 
                   9732:     sub domain {
1.852     albertel 9733: 	&load_domain_tab() if (!$loaded);
                   9734: 
1.846     albertel 9735: 	my ($name,$what) = @_;
                   9736: 	return if ( !exists($domain{$name}) );
                   9737: 
                   9738: 	if (!$what) {
                   9739: 	    return $domain{$name}{'description'};
                   9740: 	}
                   9741: 	return $domain{$name}{$what};
                   9742:     }
1.974     raeburn  9743: 
                   9744:     sub domain_info {
                   9745:         &load_domain_tab() if (!$loaded);
                   9746:         return %domain;
                   9747:     }
                   9748: 
1.327     albertel 9749: }
                   9750: 
                   9751: 
1.1       albertel 9752: # ------------------------------------------------------------- Read hosts file
                   9753: {
1.838     albertel 9754:     my %hostname;
1.844     albertel 9755:     my %hostdom;
1.845     albertel 9756:     my %libserv;
1.852     albertel 9757:     my $loaded;
1.888     albertel 9758:     my %name_to_host;
1.852     albertel 9759: 
                   9760:     sub parse_hosts_tab {
                   9761: 	my ($file) = @_;
                   9762: 	foreach my $configline (@$file) {
                   9763: 	    next if ($configline =~ /^(\#|\s*$ )/x);
                   9764: 	    next if ($configline =~ /^\^/);
                   9765: 	    chomp($configline);
1.968     raeburn  9766: 	    my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852     albertel 9767: 	    $name=~s/\s//g;
                   9768: 	    if ($id && $domain && $role && $name) {
                   9769: 		$hostname{$id}=$name;
1.888     albertel 9770: 		push(@{$name_to_host{$name}}, $id);
1.852     albertel 9771: 		$hostdom{$id}=$domain;
                   9772: 		if ($role eq 'library') { $libserv{$id}=$name; }
1.969     raeburn  9773:                 if (defined($protocol)) {
                   9774:                     if ($protocol eq 'https') {
                   9775:                         $protocol{$id} = $protocol;
                   9776:                     } else {
                   9777:                         $protocol{$id} = 'http'; 
                   9778:                     }
1.968     raeburn  9779:                 } else {
1.969     raeburn  9780:                     $protocol{$id} = 'http';
1.968     raeburn  9781:                 }
1.852     albertel 9782: 	    }
                   9783: 	}
                   9784:     }
1.864     albertel 9785:     
                   9786:     sub reset_hosts_info {
1.897     albertel 9787: 	&purge_remembered();
1.864     albertel 9788: 	&reset_domain_info();
                   9789: 	&reset_hosts_ip_info();
1.892     albertel 9790: 	undef(%name_to_host);
1.864     albertel 9791: 	undef(%hostname);
                   9792: 	undef(%hostdom);
                   9793: 	undef(%libserv);
                   9794: 	undef($loaded);
                   9795:     }
1.1       albertel 9796: 
1.852     albertel 9797:     sub load_hosts_tab {
1.869     albertel 9798: 	my ($ignore_cache) = @_;
                   9799: 	&get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852     albertel 9800: 	open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
                   9801: 	my @config = <$config>;
                   9802: 	&parse_hosts_tab(\@config);
                   9803: 	close($config);
                   9804: 	$loaded=1;
1.1       albertel 9805:     }
1.852     albertel 9806: 
1.838     albertel 9807:     sub hostname {
1.852     albertel 9808: 	&load_hosts_tab() if (!$loaded);
                   9809: 
1.838     albertel 9810: 	my ($lonid) = @_;
                   9811: 	return $hostname{$lonid};
                   9812:     }
1.845     albertel 9813: 
1.838     albertel 9814:     sub all_hostnames {
1.852     albertel 9815: 	&load_hosts_tab() if (!$loaded);
                   9816: 
1.838     albertel 9817: 	return %hostname;
                   9818:     }
1.845     albertel 9819: 
1.888     albertel 9820:     sub all_names {
                   9821: 	&load_hosts_tab() if (!$loaded);
                   9822: 
                   9823: 	return %name_to_host;
                   9824:     }
                   9825: 
1.974     raeburn  9826:     sub all_host_domain {
                   9827:         &load_hosts_tab() if (!$loaded);
                   9828:         return %hostdom;
                   9829:     }
                   9830: 
1.845     albertel 9831:     sub is_library {
1.852     albertel 9832: 	&load_hosts_tab() if (!$loaded);
                   9833: 
1.845     albertel 9834: 	return exists($libserv{$_[0]});
                   9835:     }
                   9836: 
                   9837:     sub all_library {
1.852     albertel 9838: 	&load_hosts_tab() if (!$loaded);
                   9839: 
1.845     albertel 9840: 	return %libserv;
                   9841:     }
                   9842: 
1.841     albertel 9843:     sub get_servers {
1.852     albertel 9844: 	&load_hosts_tab() if (!$loaded);
                   9845: 
1.841     albertel 9846: 	my ($domain,$type) = @_;
                   9847: 	my %possible_hosts = ($type eq 'library') ? %libserv
                   9848: 	                                          : %hostname;
                   9849: 	my %result;
1.842     albertel 9850: 	if (ref($domain) eq 'ARRAY') {
                   9851: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843     albertel 9852: 		if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842     albertel 9853: 		    $result{$host} = $hostname;
                   9854: 		}
                   9855: 	    }
                   9856: 	} else {
                   9857: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
                   9858: 		if ($hostdom{$host} eq $domain) {
                   9859: 		    $result{$host} = $hostname;
                   9860: 		}
1.841     albertel 9861: 	    }
                   9862: 	}
                   9863: 	return %result;
                   9864:     }
1.845     albertel 9865: 
1.844     albertel 9866:     sub host_domain {
1.852     albertel 9867: 	&load_hosts_tab() if (!$loaded);
                   9868: 
1.844     albertel 9869: 	my ($lonid) = @_;
                   9870: 	return $hostdom{$lonid};
                   9871:     }
                   9872: 
1.841     albertel 9873:     sub all_domains {
1.852     albertel 9874: 	&load_hosts_tab() if (!$loaded);
                   9875: 
1.841     albertel 9876: 	my %seen;
                   9877: 	my @uniq = grep(!$seen{$_}++, values(%hostdom));
                   9878: 	return @uniq;
                   9879:     }
1.1       albertel 9880: }
                   9881: 
1.847     albertel 9882: { 
                   9883:     my %iphost;
1.856     albertel 9884:     my %name_to_ip;
                   9885:     my %lonid_to_ip;
1.869     albertel 9886: 
1.847     albertel 9887:     sub get_hosts_from_ip {
                   9888: 	my ($ip) = @_;
                   9889: 	my %iphosts = &get_iphost();
                   9890: 	if (ref($iphosts{$ip})) {
                   9891: 	    return @{$iphosts{$ip}};
                   9892: 	}
                   9893: 	return;
1.839     albertel 9894:     }
1.864     albertel 9895:     
                   9896:     sub reset_hosts_ip_info {
                   9897: 	undef(%iphost);
                   9898: 	undef(%name_to_ip);
                   9899: 	undef(%lonid_to_ip);
                   9900:     }
1.856     albertel 9901: 
                   9902:     sub get_host_ip {
                   9903: 	my ($lonid) = @_;
                   9904: 	if (exists($lonid_to_ip{$lonid})) {
                   9905: 	    return $lonid_to_ip{$lonid};
                   9906: 	}
                   9907: 	my $name=&hostname($lonid);
                   9908:    	my $ip = gethostbyname($name);
                   9909: 	return if (!$ip || length($ip) ne 4);
                   9910: 	$ip=inet_ntoa($ip);
                   9911: 	$name_to_ip{$name}   = $ip;
                   9912: 	$lonid_to_ip{$lonid} = $ip;
                   9913: 	return $ip;
                   9914:     }
1.847     albertel 9915:     
                   9916:     sub get_iphost {
1.869     albertel 9917: 	my ($ignore_cache) = @_;
1.894     albertel 9918: 
1.869     albertel 9919: 	if (!$ignore_cache) {
                   9920: 	    if (%iphost) {
                   9921: 		return %iphost;
                   9922: 	    }
                   9923: 	    my ($ip_info,$cached)=
                   9924: 		&Apache::lonnet::is_cached_new('iphost','iphost');
                   9925: 	    if ($cached) {
                   9926: 		%iphost      = %{$ip_info->[0]};
                   9927: 		%name_to_ip  = %{$ip_info->[1]};
                   9928: 		%lonid_to_ip = %{$ip_info->[2]};
                   9929: 		return %iphost;
                   9930: 	    }
                   9931: 	}
1.894     albertel 9932: 
                   9933: 	# get yesterday's info for fallback
                   9934: 	my %old_name_to_ip;
                   9935: 	my ($ip_info,$cached)=
                   9936: 	    &Apache::lonnet::is_cached_new('iphost','iphost');
                   9937: 	if ($cached) {
                   9938: 	    %old_name_to_ip = %{$ip_info->[1]};
                   9939: 	}
                   9940: 
1.888     albertel 9941: 	my %name_to_host = &all_names();
                   9942: 	foreach my $name (keys(%name_to_host)) {
1.847     albertel 9943: 	    my $ip;
                   9944: 	    if (!exists($name_to_ip{$name})) {
                   9945: 		$ip = gethostbyname($name);
                   9946: 		if (!$ip || length($ip) ne 4) {
1.894     albertel 9947: 		    if (defined($old_name_to_ip{$name})) {
                   9948: 			$ip = $old_name_to_ip{$name};
                   9949: 			&logthis("Can't find $name defaulting to old $ip");
                   9950: 		    } else {
                   9951: 			&logthis("Name $name no IP found");
                   9952: 			next;
                   9953: 		    }
                   9954: 		} else {
                   9955: 		    $ip=inet_ntoa($ip);
1.847     albertel 9956: 		}
                   9957: 		$name_to_ip{$name} = $ip;
                   9958: 	    } else {
                   9959: 		$ip = $name_to_ip{$name};
1.653     albertel 9960: 	    }
1.888     albertel 9961: 	    foreach my $id (@{ $name_to_host{$name} }) {
                   9962: 		$lonid_to_ip{$id} = $ip;
                   9963: 	    }
                   9964: 	    push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598     albertel 9965: 	}
1.869     albertel 9966: 	&Apache::lonnet::do_cache_new('iphost','iphost',
                   9967: 				      [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894     albertel 9968: 				      48*60*60);
1.869     albertel 9969: 
1.847     albertel 9970: 	return %iphost;
1.598     albertel 9971:     }
                   9972: 
1.992     raeburn  9973:     #
                   9974:     #  Given a DNS returns the loncapa host name for that DNS 
                   9975:     # 
                   9976:     sub host_from_dns {
                   9977:         my ($dns) = @_;
                   9978:         my @hosts;
                   9979:         my $ip;
                   9980: 
1.993     raeburn  9981:         if (exists($name_to_ip{$dns})) {
1.992     raeburn  9982:             $ip = $name_to_ip{$dns};
                   9983:         }
                   9984:         if (!$ip) {
                   9985:             $ip = gethostbyname($dns); # Initial translation to IP is in net order.
                   9986:             if (length($ip) == 4) { 
                   9987: 	        $ip   = &IO::Socket::inet_ntoa($ip);
                   9988:             }
                   9989:         }
                   9990:         if ($ip) {
                   9991: 	    @hosts = get_hosts_from_ip($ip);
                   9992: 	    return $hosts[0];
                   9993:         }
                   9994:         return undef;
1.986     foxr     9995:     }
1.992     raeburn  9996: 
1.986     foxr     9997: }
                   9998: 
1.862     albertel 9999: BEGIN {
                   10000: 
                   10001: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
                   10002:     unless ($readit) {
                   10003: {
                   10004:     my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
                   10005:     %perlvar = (%perlvar,%{$configvars});
                   10006: }
                   10007: 
                   10008: 
1.1       albertel 10009: # ------------------------------------------------------ Read spare server file
                   10010: {
1.448     albertel 10011:     open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1       albertel 10012: 
                   10013:     while (my $configline=<$config>) {
                   10014:        chomp($configline);
1.284     matthew  10015:        if ($configline) {
1.784     albertel 10016: 	   my ($host,$type) = split(':',$configline,2);
1.785     albertel 10017: 	   if (!defined($type) || $type eq '') { $type = 'default' };
1.784     albertel 10018: 	   push(@{ $spareid{$type} }, $host);
1.1       albertel 10019:        }
                   10020:     }
1.448     albertel 10021:     close($config);
1.1       albertel 10022: }
1.11      www      10023: # ------------------------------------------------------------ Read permissions
                   10024: {
1.448     albertel 10025:     open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11      www      10026: 
                   10027:     while (my $configline=<$config>) {
1.448     albertel 10028: 	chomp($configline);
                   10029: 	if ($configline) {
                   10030: 	    my ($role,$perm)=split(/ /,$configline);
                   10031: 	    if ($perm ne '') { $pr{$role}=$perm; }
                   10032: 	}
1.11      www      10033:     }
1.448     albertel 10034:     close($config);
1.11      www      10035: }
                   10036: 
                   10037: # -------------------------------------------- Read plain texts for permissions
                   10038: {
1.448     albertel 10039:     open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11      www      10040: 
                   10041:     while (my $configline=<$config>) {
1.448     albertel 10042: 	chomp($configline);
                   10043: 	if ($configline) {
1.742     raeburn  10044: 	    my ($short,@plain)=split(/:/,$configline);
                   10045:             %{$prp{$short}} = ();
                   10046: 	    if (@plain > 0) {
                   10047:                 $prp{$short}{'std'} = $plain[0];
                   10048:                 for (my $i=1; $i<@plain; $i++) {
                   10049:                     $prp{$short}{'alt'.$i} = $plain[$i];  
                   10050:                 }
                   10051:             }
1.448     albertel 10052: 	}
1.135     www      10053:     }
1.448     albertel 10054:     close($config);
1.135     www      10055: }
                   10056: 
                   10057: # ---------------------------------------------------------- Read package table
                   10058: {
1.448     albertel 10059:     open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135     www      10060: 
                   10061:     while (my $configline=<$config>) {
1.483     albertel 10062: 	if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448     albertel 10063: 	chomp($configline);
                   10064: 	my ($short,$plain)=split(/:/,$configline);
                   10065: 	my ($pack,$name)=split(/\&/,$short);
                   10066: 	if ($plain ne '') {
                   10067: 	    $packagetab{$pack.'&'.$name.'&name'}=$name; 
                   10068: 	    $packagetab{$short}=$plain; 
                   10069: 	}
1.11      www      10070:     }
1.448     albertel 10071:     close($config);
1.329     matthew  10072: }
                   10073: 
                   10074: # ------------- set up temporary directory
                   10075: {
                   10076:     $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
                   10077: 
1.11      www      10078: }
                   10079: 
1.794     albertel 10080: $memcache=new Cache::Memcached({'servers'           => ['127.0.0.1:11211'],
                   10081: 				'compress_threshold'=> 20_000,
                   10082:  			        });
1.185     www      10083: 
1.281     www      10084: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186     www      10085: $dumpcount=0;
1.958     www      10086: $locknum=0;
1.22      www      10087: 
1.163     harris41 10088: &logtouch();
1.672     albertel 10089: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195     www      10090: $readit=1;
1.564     albertel 10091:     {
                   10092: 	use integer;
                   10093: 	my $test=(2**32)+1;
1.568     albertel 10094: 	if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564     albertel 10095: 	&logthis(" Detected 64bit platform ($_64bit)");
                   10096:     }
1.195     www      10097: }
1.1       albertel 10098: }
1.179     www      10099: 
1.1       albertel 10100: 1;
1.191     harris41 10101: __END__
                   10102: 
1.243     albertel 10103: =pod
                   10104: 
1.191     harris41 10105: =head1 NAME
                   10106: 
1.243     albertel 10107: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191     harris41 10108: 
                   10109: =head1 SYNOPSIS
                   10110: 
1.243     albertel 10111: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191     harris41 10112: 
                   10113:  &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
                   10114: 
1.243     albertel 10115: Common parameters:
                   10116: 
                   10117: =over 4
                   10118: 
                   10119: =item *
                   10120: 
                   10121: $uname : an internal username (if $cname expecting a course Id specifically)
                   10122: 
                   10123: =item *
                   10124: 
                   10125: $udom : a domain (if $cdom expecting a course's domain specifically)
                   10126: 
                   10127: =item *
                   10128: 
                   10129: $symb : a resource instance identifier
                   10130: 
                   10131: =item *
                   10132: 
                   10133: $namespace : the name of a .db file that contains the data needed or
                   10134: being set.
                   10135: 
                   10136: =back
                   10137: 
1.394     bowersj2 10138: =head1 OVERVIEW
1.191     harris41 10139: 
1.394     bowersj2 10140: lonnet provides subroutines which interact with the
                   10141: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
                   10142: about classes, users, and resources.
1.243     albertel 10143: 
                   10144: For many of these objects you can also use this to store data about
                   10145: them or modify them in various ways.
1.191     harris41 10146: 
1.394     bowersj2 10147: =head2 Symbs
1.191     harris41 10148: 
1.394     bowersj2 10149: To identify a specific instance of a resource, LON-CAPA uses symbols
                   10150: or "symbs"X<symb>. These identifiers are built from the URL of the
                   10151: map, the resource number of the resource in the map, and the URL of
                   10152: the resource itself. The latter is somewhat redundant, but might help
                   10153: if maps change.
                   10154: 
                   10155: An example is
                   10156: 
                   10157:  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
                   10158: 
                   10159: The respective map entry is
                   10160: 
                   10161:  <resource id="19" src="/res/msu/korte/tests/part12.problem"
                   10162:   title="Problem 2">
                   10163:  </resource>
                   10164: 
                   10165: Symbs are used by the random number generator, as well as to store and
                   10166: restore data specific to a certain instance of for example a problem.
                   10167: 
                   10168: =head2 Storing And Retrieving Data
                   10169: 
                   10170: X<store()>X<cstore()>X<restore()>Three of the most important functions
                   10171: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
                   10172: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
                   10173: is is the non-critical message twin of cstore. These functions are for
                   10174: handlers to store a perl hash to a user's permanent data space in an
                   10175: easy manner, and to retrieve it again on another call. It is expected
                   10176: that a handler would use this once at the beginning to retrieve data,
                   10177: and then again once at the end to send only the new data back.
                   10178: 
                   10179: The data is stored in the user's data directory on the user's
                   10180: homeserver under the ID of the course.
                   10181: 
                   10182: The hash that is returned by restore will have all of the previous
                   10183: value for all of the elements of the hash.
                   10184: 
                   10185: Example:
                   10186: 
                   10187:  #creating a hash
                   10188:  my %hash;
                   10189:  $hash{'foo'}='bar';
                   10190: 
                   10191:  #storing it
                   10192:  &Apache::lonnet::cstore(\%hash);
                   10193: 
                   10194:  #changing a value
                   10195:  $hash{'foo'}='notbar';
                   10196: 
                   10197:  #adding a new value
                   10198:  $hash{'bar'}='foo';
                   10199:  &Apache::lonnet::cstore(\%hash);
                   10200: 
                   10201:  #retrieving the hash
                   10202:  my %history=&Apache::lonnet::restore();
                   10203: 
                   10204:  #print the hash
                   10205:  foreach my $key (sort(keys(%history))) {
                   10206:    print("\%history{$key} = $history{$key}");
                   10207:  }
                   10208: 
                   10209: Will print out:
1.191     harris41 10210: 
1.394     bowersj2 10211:  %history{1:foo} = bar
                   10212:  %history{1:keys} = foo:timestamp
                   10213:  %history{1:timestamp} = 990455579
                   10214:  %history{2:bar} = foo
                   10215:  %history{2:foo} = notbar
                   10216:  %history{2:keys} = foo:bar:timestamp
                   10217:  %history{2:timestamp} = 990455580
                   10218:  %history{bar} = foo
                   10219:  %history{foo} = notbar
                   10220:  %history{timestamp} = 990455580
                   10221:  %history{version} = 2
                   10222: 
                   10223: Note that the special hash entries C<keys>, C<version> and
                   10224: C<timestamp> were added to the hash. C<version> will be equal to the
                   10225: total number of versions of the data that have been stored. The
                   10226: C<timestamp> attribute will be the UNIX time the hash was
                   10227: stored. C<keys> is available in every historical section to list which
                   10228: keys were added or changed at a specific historical revision of a
                   10229: hash.
                   10230: 
                   10231: B<Warning>: do not store the hash that restore returns directly. This
                   10232: will cause a mess since it will restore the historical keys as if the
                   10233: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191     harris41 10234: 
1.394     bowersj2 10235: Calling convention:
1.191     harris41 10236: 
1.394     bowersj2 10237:  my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
                   10238:  &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191     harris41 10239: 
1.394     bowersj2 10240: For more detailed information, see lonnet specific documentation.
1.191     harris41 10241: 
1.394     bowersj2 10242: =head1 RETURN MESSAGES
1.191     harris41 10243: 
1.394     bowersj2 10244: =over 4
1.191     harris41 10245: 
1.394     bowersj2 10246: =item * B<con_lost>: unable to contact remote host
1.191     harris41 10247: 
1.394     bowersj2 10248: =item * B<con_delayed>: unable to contact remote host, message will be delivered
                   10249: when the connection is brought back up
1.191     harris41 10250: 
1.394     bowersj2 10251: =item * B<con_failed>: unable to contact remote host and unable to save message
                   10252: for later delivery
1.191     harris41 10253: 
1.967     bisitz   10254: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191     harris41 10255: 
1.394     bowersj2 10256: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243     albertel 10257: that was requested
1.191     harris41 10258: 
1.243     albertel 10259: =back
1.191     harris41 10260: 
1.243     albertel 10261: =head1 PUBLIC SUBROUTINES
1.191     harris41 10262: 
1.243     albertel 10263: =head2 Session Environment Functions
1.191     harris41 10264: 
1.243     albertel 10265: =over 4
1.191     harris41 10266: 
1.394     bowersj2 10267: =item * 
                   10268: X<appenv()>
1.949     raeburn  10269: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394     bowersj2 10270: the user envirnoment file, and will be restored for each access this
1.620     albertel 10271: user makes during this session, also modifies the %env for the current
1.949     raeburn  10272: process. Optional rolesarrayref - if defined contains a reference to an array
                   10273: of roles which are exempt from the restriction on modifying user.role entries 
                   10274: in the user's environment.db and in %env.    
1.191     harris41 10275: 
                   10276: =item *
1.394     bowersj2 10277: X<delenv()>
1.987     raeburn  10278: B<delenv($delthis,$regexp)>: removes all items from the session
                   10279: environment file that begin with $delthis. If the 
                   10280: optional second arg - $regexp - is true, $delthis is treated as a 
                   10281: regular expression, otherwise \Q$delthis\E is used. 
                   10282: The values are also deleted from the current processes %env.
1.191     harris41 10283: 
1.795     albertel 10284: =item * get_env_multiple($name) 
                   10285: 
                   10286: gets $name from the %env hash, it seemlessly handles the cases where multiple
                   10287: values may be defined and end up as an array ref.
                   10288: 
                   10289: returns an array of values
                   10290: 
1.243     albertel 10291: =back
                   10292: 
                   10293: =head2 User Information
1.191     harris41 10294: 
1.243     albertel 10295: =over 4
1.191     harris41 10296: 
                   10297: =item *
1.394     bowersj2 10298: X<queryauthenticate()>
                   10299: B<queryauthenticate($uname,$udom)>: try to determine user's current 
1.191     harris41 10300: authentication scheme
                   10301: 
                   10302: =item *
1.394     bowersj2 10303: X<authenticate()>
                   10304: B<authenticate($uname,$upass,$udom)>: try to
                   10305: authenticate user from domain's lib servers (first use the current
                   10306: one). C<$upass> should be the users password.
1.191     harris41 10307: 
                   10308: =item *
1.394     bowersj2 10309: X<homeserver()>
                   10310: B<homeserver($uname,$udom)>: find the server which has
                   10311: the user's directory and files (there must be only one), this caches
                   10312: the answer, and also caches if there is a borken connection.
1.191     harris41 10313: 
                   10314: =item *
1.394     bowersj2 10315: X<idget()>
                   10316: B<idget($udom,@ids)>: find the usernames behind a list of IDs
                   10317: (IDs are a unique resource in a domain, there must be only 1 ID per
                   10318: username, and only 1 username per ID in a specific domain) (returns
                   10319: hash: id=>name,id=>name)
1.191     harris41 10320: 
                   10321: =item *
1.394     bowersj2 10322: X<idrget()>
                   10323: B<idrget($udom,@unames)>: find the IDs behind a list of
                   10324: usernames (returns hash: name=>id,name=>id)
1.191     harris41 10325: 
                   10326: =item *
1.394     bowersj2 10327: X<idput()>
                   10328: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191     harris41 10329: 
                   10330: =item *
1.394     bowersj2 10331: X<rolesinit()>
                   10332: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243     albertel 10333: 
                   10334: =item *
1.551     albertel 10335: X<getsection()>
                   10336: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243     albertel 10337: course $cname, return section name/number or '' for "not in course"
                   10338: and '-1' for "no section"
                   10339: 
                   10340: =item *
1.394     bowersj2 10341: X<userenvironment()>
                   10342: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243     albertel 10343: passed in @what from the requested user's environment, returns a hash
                   10344: 
1.858     raeburn  10345: =item * 
                   10346: X<userlog_query()>
1.859     albertel 10347: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
                   10348: activity.log file. %filters defines filters applied when parsing the
                   10349: log file. These can be start or end timestamps, or the type of action
                   10350: - log to look for Login or Logout events, check for Checkin or
                   10351: Checkout, role for role selection. The response is in the form
                   10352: timestamp1:hostid1:event1&timestamp2:hostid2:event2 where events are
                   10353: escaped strings of the action recorded in the activity.log file.
1.858     raeburn  10354: 
1.243     albertel 10355: =back
                   10356: 
                   10357: =head2 User Roles
                   10358: 
                   10359: =over 4
                   10360: 
                   10361: =item *
                   10362: 
1.810     raeburn  10363: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243     albertel 10364:  F: full access
                   10365:  U,I,K: authentication modes (cxx only)
                   10366:  '': forbidden
                   10367:  1: user needs to choose course
                   10368:  2: browse allowed
1.766     albertel 10369:  A: passphrase authentication needed
1.243     albertel 10370: 
                   10371: =item *
                   10372: 
                   10373: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
                   10374: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
                   10375: and course level
                   10376: 
                   10377: =item *
                   10378: 
1.988     raeburn  10379: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 
                   10380: (rolesplain.tab); plain text explanation of a user role term.
1.1008    raeburn  10381: $type is Course (default) or Community.
1.988     raeburn  10382: If $forcedefault evaluates to true, text returned will be default 
                   10383: text for $type. Otherwise, if this is a course, the text returned 
                   10384: will be a custom name for the role (if defined in the course's 
                   10385: environment).  If no custom name is defined the default is returned.
                   10386:    
1.832     raeburn  10387: =item *
                   10388: 
1.935     raeburn  10389: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858     raeburn  10390: All arguments are optional. Returns a hash of a roles, either for
                   10391: co-author/assistant author roles for a user's Construction Space
1.906     albertel 10392: (default), or if $context is 'userroles', roles for the user himself,
1.933     raeburn  10393: In the hash, keys are set to colon-separated $uname,$udom,$role, and
                   10394: (optionally) if $withsec is true, a fourth colon-separated item - $section.
                   10395: For each key, value is set to colon-separated start and end times for
                   10396: the role.  If no username and domain are specified, will default to
1.934     raeburn  10397: current user/domain. Types, roles, and roledoms are references to arrays
1.858     raeburn  10398: of role statuses (active, future or previous), roles 
                   10399: (e.g., cc,in, st etc.) and domains of the roles which can be used
                   10400: to restrict the list of roles reported. If no array ref is 
                   10401: provided for types, will default to return only active roles.
1.834     albertel 10402: 
1.243     albertel 10403: =back
                   10404: 
                   10405: =head2 User Modification
                   10406: 
                   10407: =over 4
                   10408: 
                   10409: =item *
                   10410: 
1.957     raeburn  10411: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243     albertel 10412: user for the level given by URL.  Optional start and end dates (leave empty
                   10413: string or zero for "no date")
1.191     harris41 10414: 
                   10415: =item *
                   10416: 
1.243     albertel 10417: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
                   10418: change a users, password, possible return values are: ok,
                   10419: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
                   10420: refused
1.191     harris41 10421: 
                   10422: =item *
                   10423: 
1.243     albertel 10424: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191     harris41 10425: 
                   10426: =item *
                   10427: 
1.1056.2.1  raeburn  10428: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
                   10429:            $forceid,$desiredhome,$email,$inststatus,$candelete) :
                   10430: 
                   10431: will update user information (firstname,middlename,lastname,generation,
                   10432: permanentemail), and if forceid is true, student/employee ID also.
                   10433: A user's institutional affiliation(s) can also be updated.
                   10434: User information fields will not be overwritten with empty entries
                   10435: unless the field is included in the $candelete array reference.
                   10436: This array is included when a single user is modified via "Manage Users",
                   10437: or when Autoupdate.pl is run by cron in a domain.
1.191     harris41 10438: 
                   10439: =item *
                   10440: 
1.286     matthew  10441: modifystudent
                   10442: 
1.957     raeburn  10443: modify a student's enrollment and identification information.
1.286     matthew  10444: The course id is resolved based on the current users environment.  
                   10445: This means the envoking user must be a course coordinator or otherwise
                   10446: associated with a course.
                   10447: 
1.297     matthew  10448: This call is essentially a wrapper for lonnet::modifyuser and
                   10449: lonnet::modify_student_enrollment
1.286     matthew  10450: 
                   10451: Inputs: 
                   10452: 
                   10453: =over 4
                   10454: 
1.957     raeburn  10455: =item B<$udom> Student's loncapa domain
1.286     matthew  10456: 
1.957     raeburn  10457: =item B<$uname> Student's loncapa login name
1.286     matthew  10458: 
1.964     bisitz   10459: =item B<$uid> Student/Employee ID
1.286     matthew  10460: 
1.957     raeburn  10461: =item B<$umode> Student's authentication mode
1.286     matthew  10462: 
1.957     raeburn  10463: =item B<$upass> Student's password
1.286     matthew  10464: 
1.957     raeburn  10465: =item B<$first> Student's first name
1.286     matthew  10466: 
1.957     raeburn  10467: =item B<$middle> Student's middle name
1.286     matthew  10468: 
1.957     raeburn  10469: =item B<$last> Student's last name
1.286     matthew  10470: 
1.957     raeburn  10471: =item B<$gene> Student's generation
1.286     matthew  10472: 
1.957     raeburn  10473: =item B<$usec> Student's section in course
1.286     matthew  10474: 
                   10475: =item B<$end> Unix time of the roles expiration
                   10476: 
                   10477: =item B<$start> Unix time of the roles start date
                   10478: 
                   10479: =item B<$forceid> If defined, allow $uid to be changed
                   10480: 
                   10481: =item B<$desiredhome> server to use as home server for student
                   10482: 
1.957     raeburn  10483: =item B<$email> Student's permanent e-mail address
                   10484: 
                   10485: =item B<$type> Type of enrollment (auto or manual)
                   10486: 
1.963     raeburn  10487: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto    
                   10488: 
                   10489: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957     raeburn  10490: 
1.963     raeburn  10491: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957     raeburn  10492: 
1.963     raeburn  10493: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957     raeburn  10494: 
1.963     raeburn  10495: =item B<$inststatus> institutional status of user - : separated string of escaped status types  
1.957     raeburn  10496: 
1.286     matthew  10497: =back
1.297     matthew  10498: 
                   10499: =item *
                   10500: 
                   10501: modify_student_enrollment
                   10502: 
                   10503: Change a students enrollment status in a class.  The environment variable
                   10504: 'role.request.course' must be defined for this function to proceed.
                   10505: 
                   10506: Inputs:
                   10507: 
                   10508: =over 4
                   10509: 
                   10510: =item $udom, students domain
                   10511: 
                   10512: =item $uname, students name
                   10513: 
                   10514: =item $uid, students user id
                   10515: 
                   10516: =item $first, students first name
                   10517: 
                   10518: =item $middle
                   10519: 
                   10520: =item $last
                   10521: 
                   10522: =item $gene
                   10523: 
                   10524: =item $usec
                   10525: 
                   10526: =item $end
                   10527: 
                   10528: =item $start
                   10529: 
1.957     raeburn  10530: =item $type
                   10531: 
                   10532: =item $locktype
                   10533: 
                   10534: =item $cid
                   10535: 
                   10536: =item $selfenroll
                   10537: 
                   10538: =item $context
                   10539: 
1.297     matthew  10540: =back
                   10541: 
1.191     harris41 10542: 
                   10543: =item *
                   10544: 
1.243     albertel 10545: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
                   10546: custom role; give a custom role to a user for the level given by URL.  Specify
                   10547: name and domain of role author, and role name
1.191     harris41 10548: 
                   10549: =item *
                   10550: 
1.243     albertel 10551: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191     harris41 10552: 
                   10553: =item *
                   10554: 
1.243     albertel 10555: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
                   10556: 
                   10557: =back
                   10558: 
                   10559: =head2 Course Infomation
                   10560: 
                   10561: =over 4
1.191     harris41 10562: 
                   10563: =item *
                   10564: 
1.631     albertel 10565: coursedescription($courseid) : returns a hash of information about the
                   10566: specified course id, including all environment settings for the
                   10567: course, the description of the course will be in the hash under the
                   10568: key 'description'
1.191     harris41 10569: 
                   10570: =item *
                   10571: 
1.624     albertel 10572: resdata($name,$domain,$type,@which) : request for current parameter
                   10573: setting for a specific $type, where $type is either 'course' or 'user',
                   10574: @what should be a list of parameters to ask about. This routine caches
                   10575: answers for 5 minutes.
1.243     albertel 10576: 
1.877     foxr     10577: =item *
                   10578: 
                   10579: get_courseresdata($courseid, $domain) : dump the entire course resource
                   10580: data base, returning a hash that is keyed by the resource name and has
                   10581: values that are the resource value.  I believe that the timestamps and
                   10582: versions are also returned.
                   10583: 
                   10584: 
1.243     albertel 10585: =back
                   10586: 
                   10587: =head2 Course Modification
                   10588: 
                   10589: =over 4
1.191     harris41 10590: 
                   10591: =item *
                   10592: 
1.243     albertel 10593: writecoursepref($courseid,%prefs) : write preferences (environment
                   10594: database) for a course
1.191     harris41 10595: 
                   10596: =item *
                   10597: 
1.1011    raeburn  10598: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
                   10599: 
                   10600: =item *
                   10601: 
1.1038    raeburn  10602: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243     albertel 10603: 
                   10604: =back
                   10605: 
                   10606: =head2 Resource Subroutines
                   10607: 
                   10608: =over 4
1.191     harris41 10609: 
                   10610: =item *
                   10611: 
1.243     albertel 10612: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191     harris41 10613: 
                   10614: =item *
                   10615: 
1.243     albertel 10616: repcopy($filename) : subscribes to the requested file, and attempts to
                   10617: replicate from the owning library server, Might return
1.607     raeburn  10618: 'unavailable', 'not_found', 'forbidden', 'ok', or
                   10619: 'bad_request', also attempts to grab the metadata for the
1.243     albertel 10620: resource. Expects the local filesystem pathname
                   10621: (/home/httpd/html/res/....)
                   10622: 
                   10623: =back
                   10624: 
                   10625: =head2 Resource Information
                   10626: 
                   10627: =over 4
1.191     harris41 10628: 
                   10629: =item *
                   10630: 
1.243     albertel 10631: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
                   10632: a vairety of different possible values, $varname should be a request
                   10633: string, and the other parameters can be used to specify who and what
                   10634: one is asking about.
                   10635: 
                   10636: Possible values for $varname are environment.lastname (or other item
                   10637: from the envirnment hash), user.name (or someother aspect about the
                   10638: user), resource.0.maxtries (or some other part and parameter of a
                   10639: resource)
1.204     albertel 10640: 
                   10641: =item *
                   10642: 
1.243     albertel 10643: directcondval($number) : get current value of a condition; reads from a state
                   10644: string
1.204     albertel 10645: 
                   10646: =item *
                   10647: 
1.243     albertel 10648: condval($condidx) : value of condition index based on state
1.204     albertel 10649: 
                   10650: =item *
                   10651: 
1.243     albertel 10652: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
                   10653: resource's metadata, $what should be either a specific key, or either
                   10654: 'keys' (to get a list of possible keys) or 'packages' to get a list of
                   10655: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
                   10656: 
                   10657: this function automatically caches all requests
1.191     harris41 10658: 
                   10659: =item *
                   10660: 
1.243     albertel 10661: metadata_query($query,$custom,$customshow) : make a metadata query against the
                   10662: network of library servers; returns file handle of where SQL and regex results
                   10663: will be stored for query
1.191     harris41 10664: 
                   10665: =item *
                   10666: 
1.243     albertel 10667: symbread($filename) : return symbolic list entry (filename argument optional);
                   10668: returns the data handle
1.191     harris41 10669: 
                   10670: =item *
                   10671: 
1.243     albertel 10672: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582     albertel 10673: a possible symb for the URL in $thisfn, and if is an encryypted
                   10674: resource that the user accessed using /enc/ returns a 1 on success, 0
                   10675: on failure, user must be in a course, as it assumes the existance of
1.620     albertel 10676: the course initial hash, and uses $env('request.course.id'}
1.243     albertel 10677: 
1.191     harris41 10678: 
                   10679: =item *
                   10680: 
1.243     albertel 10681: symbclean($symb) : removes versions numbers from a symb, returns the
                   10682: cleaned symb
1.191     harris41 10683: 
                   10684: =item *
                   10685: 
1.243     albertel 10686: is_on_map($uri) : checks if the $uri is somewhere on the current
                   10687: course map, user must be in a course for it to work.
1.191     harris41 10688: 
                   10689: =item *
                   10690: 
1.243     albertel 10691: numval($salt) : return random seed value (addend for rndseed)
1.191     harris41 10692: 
                   10693: =item *
                   10694: 
1.243     albertel 10695: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
                   10696: a random seed, all arguments are optional, if they aren't sent it uses the
                   10697: environment to derive them. Note: if symb isn't sent and it can't get one
                   10698: from &symbread it will use the current time as its return value
1.191     harris41 10699: 
                   10700: =item *
                   10701: 
1.243     albertel 10702: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
                   10703: unfakeable, receipt
1.191     harris41 10704: 
                   10705: =item *
                   10706: 
1.620     albertel 10707: receipt() : API to ireceipt working off of env values; given out to users
1.191     harris41 10708: 
                   10709: =item *
                   10710: 
1.243     albertel 10711: countacc($url) : count the number of accesses to a given URL
1.191     harris41 10712: 
                   10713: =item *
                   10714: 
1.243     albertel 10715: 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 10716: 
                   10717: =item *
                   10718: 
1.243     albertel 10719: 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 10720: 
                   10721: =item *
                   10722: 
1.243     albertel 10723: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191     harris41 10724: 
                   10725: =item *
                   10726: 
1.243     albertel 10727: devalidate($symb) : devalidate temporary spreadsheet calculations,
                   10728: forcing spreadsheet to reevaluate the resource scores next time.
                   10729: 
                   10730: =back
                   10731: 
                   10732: =head2 Storing/Retreiving Data
                   10733: 
                   10734: =over 4
1.191     harris41 10735: 
                   10736: =item *
                   10737: 
1.243     albertel 10738: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
                   10739: for this url; hashref needs to be given and should be a \%hashname; the
                   10740: remaining args aren't required and if they aren't passed or are '' they will
1.620     albertel 10741: be derived from the env
1.191     harris41 10742: 
                   10743: =item *
                   10744: 
1.243     albertel 10745: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
                   10746: uses critical subroutine
1.191     harris41 10747: 
                   10748: =item *
                   10749: 
1.243     albertel 10750: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
                   10751: all args are optional
1.191     harris41 10752: 
                   10753: =item *
                   10754: 
1.717     albertel 10755: dumpstore($namespace,$udom,$uname,$regexp,$range) : 
                   10756: dumps the complete (or key matching regexp) namespace into a hash
                   10757: ($udom, $uname, $regexp, $range are optional) for a namespace that is
                   10758: normally &store()ed into
                   10759: 
                   10760: $range should be either an integer '100' (give me the first 100
                   10761:                                            matching records)
                   10762:               or be  two integers sperated by a - with no spaces
                   10763:                  '30-50' (give me the 30th through the 50th matching
                   10764:                           records)
                   10765: 
                   10766: 
                   10767: =item *
                   10768: 
                   10769: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
                   10770: replaces a &store() version of data with a replacement set of data
                   10771: for a particular resource in a namespace passed in the $storehash hash 
                   10772: reference
                   10773: 
                   10774: =item *
                   10775: 
1.243     albertel 10776: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
                   10777: works very similar to store/cstore, but all data is stored in a
                   10778: temporary location and can be reset using tmpreset, $storehash should
                   10779: be a hash reference, returns nothing on success
1.191     harris41 10780: 
                   10781: =item *
                   10782: 
1.243     albertel 10783: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
                   10784: similar to restore, but all data is stored in a temporary location and
                   10785: can be reset using tmpreset. Returns a hash of values on success,
                   10786: error string otherwise.
1.191     harris41 10787: 
                   10788: =item *
                   10789: 
1.243     albertel 10790: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
                   10791: deltes all keys for $symb form the temporary storage hash.
1.191     harris41 10792: 
                   10793: =item *
                   10794: 
1.243     albertel 10795: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   10796: reference filled in from namesp ($udom and $uname are optional)
1.191     harris41 10797: 
                   10798: =item *
                   10799: 
1.243     albertel 10800: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
                   10801: namesp ($udom and $uname are optional)
1.191     harris41 10802: 
                   10803: =item *
                   10804: 
1.702     albertel 10805: dump($namespace,$udom,$uname,$regexp,$range) : 
1.243     albertel 10806: dumps the complete (or key matching regexp) namespace into a hash
1.702     albertel 10807: ($udom, $uname, $regexp, $range are optional)
1.449     matthew  10808: 
1.702     albertel 10809: $range should be either an integer '100' (give me the first 100
                   10810:                                            matching records)
                   10811:               or be  two integers sperated by a - with no spaces
                   10812:                  '30-50' (give me the 30th through the 50th matching
                   10813:                           records)
1.449     matthew  10814: =item *
                   10815: 
                   10816: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
                   10817: $store can be a scalar, an array reference, or if the amount to be 
                   10818: incremented is > 1, a hash reference.
                   10819: 
                   10820: ($udom and $uname are optional)
1.191     harris41 10821: 
                   10822: =item *
                   10823: 
1.243     albertel 10824: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
                   10825: ($udom and $uname are optional)
1.191     harris41 10826: 
                   10827: =item *
                   10828: 
1.243     albertel 10829: cput($namespace,$storehash,$udom,$uname) : critical put
                   10830: ($udom and $uname are optional)
1.191     harris41 10831: 
                   10832: =item *
                   10833: 
1.748     albertel 10834: newput($namespace,$storehash,$udom,$uname) :
                   10835: 
                   10836: Attempts to store the items in the $storehash, but only if they don't
                   10837: currently exist, if this succeeds you can be certain that you have 
                   10838: successfully created a new key value pair in the $namespace db.
                   10839: 
                   10840: 
                   10841: Args:
                   10842:  $namespace: name of database to store values to
                   10843:  $storehash: hashref to store to the db
                   10844:  $udom: (optional) domain of user containing the db
                   10845:  $uname: (optional) name of user caontaining the db
                   10846: 
                   10847: Returns:
                   10848:  'ok' -> succeeded in storing all keys of $storehash
                   10849:  'key_exists: <key>' -> failed to anything out of $storehash, as at
                   10850:                         least <key> already existed in the db (other
                   10851:                         requested keys may also already exist)
1.967     bisitz   10852:  'error: <msg>' -> unable to tie the DB or other error occurred
1.748     albertel 10853:  'con_lost' -> unable to contact request server
                   10854:  'refused' -> action was not allowed by remote machine
                   10855: 
                   10856: 
                   10857: =item *
                   10858: 
1.243     albertel 10859: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   10860: reference filled in from namesp (encrypts the return communication)
                   10861: ($udom and $uname are optional)
1.191     harris41 10862: 
                   10863: =item *
                   10864: 
1.243     albertel 10865: log($udom,$name,$home,$message) : write to permanent log for user; use
                   10866: critical subroutine
                   10867: 
1.806     raeburn  10868: =item *
                   10869: 
1.860     raeburn  10870: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
                   10871: array reference filled in from namespace found in domain level on either
                   10872: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806     raeburn  10873: 
                   10874: =item *
                   10875: 
1.860     raeburn  10876: put_dom($namespace,$storehash,$udom,$uhome) :  stores hash in namespace at 
                   10877: domain level either on specified domain server ($uhome) or primary domain 
                   10878: server ($udom and $uhome are optional)
1.806     raeburn  10879: 
1.943     raeburn  10880: =item * 
                   10881: 
                   10882: get_domain_defaults($target_domain) : returns hash with defaults for
                   10883: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
                   10884: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
                   10885: or localauth), initial password or a kerberos realm, language (e.g., en-us).
                   10886: Values are retrieved from cache (if current), or from domain's configuration.db
                   10887: (if available), or lastly from values in lonTabs/dns_domain,tab, 
                   10888: or lonTabs/domain.tab. 
                   10889: 
                   10890: %domdefaults = &get_auth_defaults($target_domain);
                   10891: 
1.243     albertel 10892: =back
                   10893: 
                   10894: =head2 Network Status Functions
                   10895: 
                   10896: =over 4
1.191     harris41 10897: 
                   10898: =item *
                   10899: 
                   10900: dirlist($uri) : return directory list based on URI
                   10901: 
                   10902: =item *
                   10903: 
1.243     albertel 10904: spareserver() : find server with least workload from spare.tab
                   10905: 
1.986     foxr     10906: 
                   10907: =item *
                   10908: 
                   10909: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
                   10910: if there is no corresponding loncapa host.
                   10911: 
1.243     albertel 10912: =back
                   10913: 
1.986     foxr     10914: 
1.243     albertel 10915: =head2 Apache Request
                   10916: 
                   10917: =over 4
1.191     harris41 10918: 
                   10919: =item *
                   10920: 
1.243     albertel 10921: ssi($url,%hash) : server side include, does a complete request cycle on url to
                   10922: localhost, posts hash
                   10923: 
                   10924: =back
                   10925: 
                   10926: =head2 Data to String to Data
                   10927: 
                   10928: =over 4
1.191     harris41 10929: 
                   10930: =item *
                   10931: 
1.243     albertel 10932: hash2str(%hash) : convert a hash into a string complete with escaping and '='
                   10933: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191     harris41 10934: 
                   10935: =item *
                   10936: 
1.243     albertel 10937: hashref2str($hashref) : convert a hashref into a string complete with
                   10938: escaping and '=' and '&' separators, supports elements that are
                   10939: arrayrefs and hashrefs
1.191     harris41 10940: 
                   10941: =item *
                   10942: 
1.243     albertel 10943: arrayref2str($arrayref) : convert an arrayref into a string complete
                   10944: with escaping and '&' separators, supports elements that are arrayrefs
                   10945: and hashrefs
1.191     harris41 10946: 
                   10947: =item *
                   10948: 
1.243     albertel 10949: str2hash($string) : convert string to hash using unescaping and
                   10950: splitting on '=' and '&', supports elements that are arrayrefs and
                   10951: hashrefs
1.191     harris41 10952: 
                   10953: =item *
                   10954: 
1.243     albertel 10955: str2array($string) : convert string to hash using unescaping and
                   10956: splitting on '&', supports elements that are arrayrefs and hashrefs
                   10957: 
                   10958: =back
                   10959: 
                   10960: =head2 Logging Routines
                   10961: 
                   10962: =over 4
                   10963: 
                   10964: These routines allow one to make log messages in the lonnet.log and
                   10965: lonnet.perm logfiles.
1.191     harris41 10966: 
                   10967: =item *
                   10968: 
1.243     albertel 10969: logtouch() : make sure the logfile, lonnet.log, exists
1.191     harris41 10970: 
                   10971: =item *
                   10972: 
1.243     albertel 10973: logthis() : append message to the normal lonnet.log file, it gets
                   10974: preiodically rolled over and deleted.
1.191     harris41 10975: 
                   10976: =item *
                   10977: 
1.243     albertel 10978: logperm() : append a permanent message to lonnet.perm.log, this log
                   10979: file never gets deleted by any automated portion of the system, only
                   10980: messages of critical importance should go in here.
                   10981: 
                   10982: =back
                   10983: 
                   10984: =head2 General File Helper Routines
                   10985: 
                   10986: =over 4
1.191     harris41 10987: 
                   10988: =item *
                   10989: 
1.481     raeburn  10990: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
                   10991: (a) files in /uploaded
                   10992:   (i) If a local copy of the file exists - 
                   10993:       compares modification date of local copy with last-modified date for 
                   10994:       definitive version stored on home server for course. If local copy is 
                   10995:       stale, requests a new version from the home server and stores it. 
                   10996:       If the original has been removed from the home server, then local copy 
                   10997:       is unlinked.
                   10998:   (ii) If local copy does not exist -
                   10999:       requests the file from the home server and stores it. 
                   11000:   
                   11001:   If $caller is 'uploadrep':  
                   11002:     This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
                   11003:     for request for files originally uploaded via DOCS. 
                   11004:      - returns 'ok' if fresh local copy now available, -1 otherwise.
                   11005:   
                   11006:   Otherwise:
                   11007:      This indicates a call from the content generation phase of the request.
                   11008:      -  returns the entire contents of the file or -1.
                   11009:      
                   11010: (b) files in /res
                   11011:    - returns the entire contents of a file or -1; 
                   11012:    it properly subscribes to and replicates the file if neccessary.
1.191     harris41 11013: 
1.712     albertel 11014: 
                   11015: =item *
                   11016: 
                   11017: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
                   11018:                   reference
                   11019: 
                   11020: returns either a stat() list of data about the file or an empty list
                   11021: if the file doesn't exist or couldn't find out about it (connection
                   11022: problems or user unknown)
                   11023: 
1.191     harris41 11024: =item *
                   11025: 
1.243     albertel 11026: filelocation($dir,$file) : returns file system location of a file
                   11027: based on URI; meant to be "fairly clean" absolute reference, $dir is a
                   11028: directory that relative $file lookups are to looked in ($dir of /a/dir
                   11029: and a file of ../bob will become /a/bob)
1.191     harris41 11030: 
                   11031: =item *
                   11032: 
                   11033: hreflocation($dir,$file) : returns file system location or a URL; same as
                   11034: filelocation except for hrefs
                   11035: 
                   11036: =item *
                   11037: 
                   11038: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
                   11039: 
1.243     albertel 11040: =back
                   11041: 
1.608     albertel 11042: =head2 Usererfile file routines (/uploaded*)
                   11043: 
                   11044: =over 4
                   11045: 
                   11046: =item *
                   11047: 
                   11048: userfileupload(): main rotine for putting a file in a user or course's
                   11049:                   filespace, arguments are,
                   11050: 
1.620     albertel 11051:  formname - required - this is the name of the element in $env where the
1.608     albertel 11052:            filename, and the contents of the file to create/modifed exist
1.620     albertel 11053:            the filename is in $env{'form.'.$formname.'.filename'} and the
                   11054:            contents of the file is located in $env{'form.'.$formname}
1.608     albertel 11055:  coursedoc - if true, store the file in the course of the active role
                   11056:              of the current user
                   11057:  subdir - required - subdirectory to put the file in under ../userfiles/
                   11058:          if undefined, it will be placed in "unknown"
                   11059: 
                   11060:  (This routine calls clean_filename() to remove any dangerous
                   11061:  characters from the filename, and then calls finuserfileupload() to
                   11062:  complete the transaction)
                   11063: 
                   11064:  returns either the url of the uploaded file (/uploaded/....) if successful
                   11065:  and /adm/notfound.html if unsuccessful
                   11066: 
                   11067: =item *
                   11068: 
                   11069: clean_filename(): routine for cleaing a filename up for storage in
                   11070:                  userfile space, argument is:
                   11071: 
                   11072:  filename - proposed filename
                   11073: 
                   11074: returns: the new clean filename
                   11075: 
                   11076: =item *
                   11077: 
                   11078: finishuserfileupload(): routine that creaes and sends the file to
                   11079: userspace, probably shouldn't be called directly
                   11080: 
                   11081:   docuname: username or courseid of destination for the file
                   11082:   docudom: domain of user/course of destination for the file
                   11083:   formname: same as for userfileupload()
                   11084:   fname: filename (inculding subdirectories) for the file
                   11085: 
                   11086:  returns either the url of the uploaded file (/uploaded/....) if successful
                   11087:  and /adm/notfound.html if unsuccessful
                   11088: 
                   11089: =item *
                   11090: 
                   11091: renameuserfile(): renames an existing userfile to a new name
                   11092: 
                   11093:   Args:
                   11094:    docuname: username or courseid of destination for the file
                   11095:    docudom: domain of user/course of destination for the file
                   11096:    old: current file name (including any subdirs under userfiles)
                   11097:    new: desired file name (including any subdirs under userfiles)
                   11098: 
                   11099: =item *
                   11100: 
                   11101: mkdiruserfile(): creates a directory is a userfiles dir
                   11102: 
                   11103:   Args:
                   11104:    docuname: username or courseid of destination for the file
                   11105:    docudom: domain of user/course of destination for the file
                   11106:    dir: dir to create (including any subdirs under userfiles)
                   11107: 
                   11108: =item *
                   11109: 
                   11110: removeuserfile(): removes a file that exists in userfiles
                   11111: 
                   11112:   Args:
                   11113:    docuname: username or courseid of destination for the file
                   11114:    docudom: domain of user/course of destination for the file
                   11115:    fname: filname to delete (including any subdirs under userfiles)
                   11116: 
                   11117: =item *
                   11118: 
                   11119: removeuploadedurl(): convience function for removeuserfile()
                   11120: 
                   11121:   Args:
                   11122:    url:  a full /uploaded/... url to delete
                   11123: 
1.747     albertel 11124: =item * 
                   11125: 
                   11126: get_portfile_permissions():
                   11127:   Args:
                   11128:     domain: domain of user or course contain the portfolio files
                   11129:     user: name of user or num of course contain the portfolio files
                   11130:   Returns:
                   11131:     hashref of a dump of the proper file_permissions.db
                   11132:    
                   11133: 
                   11134: =item * 
                   11135: 
                   11136: get_access_controls():
                   11137: 
                   11138: Args:
                   11139:   current_permissions: the hash ref returned from get_portfile_permissions()
                   11140:   group: (optional) the group you want the files associated with
                   11141:   file: (optional) the file you want access info on
                   11142: 
                   11143: Returns:
1.749     raeburn  11144:     a hash (keys are file names) of hashes containing
                   11145:         keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
                   11146:         values are XML containing access control settings (see below) 
1.747     albertel 11147: 
                   11148: Internal notes:
                   11149: 
1.749     raeburn  11150:  access controls are stored in file_permissions.db as key=value pairs.
                   11151:     key -> path to file/file_name\0uniqueID:scope_end_start
                   11152:         where scope -> public,guest,course,group,domains or users.
                   11153:               end -> UNIX time for end of access (0 -> no end date)
                   11154:               start -> UNIX time for start of access
                   11155: 
                   11156:     value -> XML description of access control
                   11157:            <scope type=""> (type =1 of: public,guest,course,group,domains,users">
                   11158:             <start></start>
                   11159:             <end></end>
                   11160: 
                   11161:             <password></password>  for scope type = guest
                   11162: 
                   11163:             <domain></domain>     for scope type = course or group
                   11164:             <number></number>
                   11165:             <roles id="">
                   11166:              <role></role>
                   11167:              <access></access>
                   11168:              <section></section>
                   11169:              <group></group>
                   11170:             </roles>
                   11171: 
                   11172:             <dom></dom>         for scope type = domains
                   11173: 
                   11174:             <users>             for scope type = users
                   11175:              <user>
                   11176:               <uname></uname>
                   11177:               <udom></udom>
                   11178:              </user>
                   11179:             </users>
                   11180:            </scope> 
                   11181:               
                   11182:  Access data is also aggregated for each file in an additional key=value pair:
                   11183:  key -> path to file/file_name\0accesscontrol 
                   11184:  value -> reference to hash
                   11185:           hash contains key = value pairs
                   11186:           where key = uniqueID:scope_end_start
                   11187:                 value = UNIX time record was last updated
                   11188: 
                   11189:           Used to improve speed of look-ups of access controls for each file.  
                   11190:  
                   11191:  Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
                   11192: 
                   11193: modify_access_controls():
                   11194: 
                   11195: Modifies access controls for a portfolio file
                   11196: Args
                   11197: 1. file name
                   11198: 2. reference to hash of required changes,
                   11199: 3. domain
                   11200: 4. username
                   11201:   where domain,username are the domain of the portfolio owner 
                   11202:   (either a user or a course) 
                   11203: 
                   11204: Returns:
                   11205: 1. result of additions or updates ('ok' or 'error', with error message). 
                   11206: 2. result of deletions ('ok' or 'error', with error message).
                   11207: 3. reference to hash of any new or updated access controls.
                   11208: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
                   11209:    key = integer (inbound ID)
                   11210:    value = uniqueID  
1.747     albertel 11211: 
1.608     albertel 11212: =back
                   11213: 
1.243     albertel 11214: =head2 HTTP Helper Routines
                   11215: 
                   11216: =over 4
                   11217: 
1.191     harris41 11218: =item *
                   11219: 
                   11220: escape() : unpack non-word characters into CGI-compatible hex codes
                   11221: 
                   11222: =item *
                   11223: 
                   11224: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
                   11225: 
1.243     albertel 11226: =back
                   11227: 
                   11228: =head1 PRIVATE SUBROUTINES
                   11229: 
                   11230: =head2 Underlying communication routines (Shouldn't call)
                   11231: 
                   11232: =over 4
                   11233: 
                   11234: =item *
                   11235: 
                   11236: subreply() : tries to pass a message to lonc, returns con_lost if incapable
                   11237: 
                   11238: =item *
                   11239: 
                   11240: reply() : uses subreply to send a message to remote machine, logs all failures
                   11241: 
                   11242: =item *
                   11243: 
                   11244: critical() : passes a critical message to another server; if cannot
                   11245: get through then place message in connection buffer directory and
                   11246: returns con_delayed, if incapable of saving message, returns
                   11247: con_failed
                   11248: 
                   11249: =item *
                   11250: 
                   11251: reconlonc() : tries to reconnect lonc client processes.
                   11252: 
                   11253: =back
                   11254: 
                   11255: =head2 Resource Access Logging
                   11256: 
                   11257: =over 4
                   11258: 
                   11259: =item *
                   11260: 
                   11261: flushcourselogs() : flush (save) buffer logs and access logs
                   11262: 
                   11263: =item *
                   11264: 
                   11265: courselog($what) : save message for course in hash
                   11266: 
                   11267: =item *
                   11268: 
                   11269: courseacclog($what) : save message for course using &courselog().  Perform
                   11270: special processing for specific resource types (problems, exams, quizzes, etc).
                   11271: 
1.191     harris41 11272: =item *
                   11273: 
                   11274: goodbye() : flush course logs and log shutting down; it is called in srm.conf
                   11275: as a PerlChildExitHandler
1.243     albertel 11276: 
                   11277: =back
                   11278: 
                   11279: =head2 Other
                   11280: 
                   11281: =over 4
                   11282: 
                   11283: =item *
                   11284: 
                   11285: symblist($mapname,%newhash) : update symbolic storage links
1.191     harris41 11286: 
                   11287: =back
                   11288: 
                   11289: =cut
1.877     foxr     11290: 

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