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

1.1       albertel    1: # The LearningOnline Network
                      2: # TCP networking package
1.12      www         3: #
1.1204  ! raeburn     4: # $Id: lonnet.pm,v 1.1203 2012/11/30 16:50:30 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.1182    foxr       78: 
1.1173    foxr       79: use Encode;
                     80: 
1.871     albertel   81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138    raeburn    82:             $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
                     83:             %managerstab);
1.871     albertel   84: 
                     85: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
                     86:     %userrolehash, $processmarker, $dumpcount, %coursedombuf,
                     87:     %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958     www        88:     %courseownerbuf, %coursetypebuf,$locknum);
1.403     www        89: 
1.1       albertel   90: use IO::Socket;
1.31      www        91: use GDBM_File;
1.208     albertel   92: use HTML::LCParser;
1.88      www        93: use Fcntl qw(:flock);
1.870     albertel   94: use Storable qw(thaw nfreeze);
1.539     albertel   95: use Time::HiRes qw( gettimeofday tv_interval );
1.599     albertel   96: use Cache::Memcached;
1.676     albertel   97: use Digest::MD5;
1.790     albertel   98: use Math::Random;
1.1024    raeburn    99: use File::MMagic;
1.807     albertel  100: use LONCAPA qw(:DEFAULT :match);
1.740     www       101: use LONCAPA::Configuration;
1.1160    www       102: use LONCAPA::lonmetadata;
1.1167    droeschl  103: use LONCAPA::Lond;
1.1117    foxr      104: 
1.1090    raeburn   105: use File::Copy;
1.676     albertel  106: 
1.195     www       107: my $readit;
1.550     foxr      108: my $max_connection_retries = 10;     # Or some such value.
1.1       albertel  109: 
1.619     albertel  110: require Exporter;
                    111: 
                    112: our @ISA = qw (Exporter);
                    113: our @EXPORT = qw(%env);
                    114: 
1.449     matthew   115: 
1.1187    raeburn   116: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729     www       117: {
                    118:     my $logid;
1.1187    raeburn   119:     sub write_log {
1.1188    raeburn   120: 	my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
1.1184    raeburn   121:         if ($context eq 'course') {
                    122:             if (($cnum eq '') || ($cdom eq '')) {
                    123:                 $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    124:                 $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                    125:             }
1.957     raeburn   126:         }
1.1184    raeburn   127: 	$logid ++;
1.957     raeburn   128:         my $now = time();
                    129: 	my $id=$now.'00000'.$$.'00000'.$logid;
1.1184    raeburn   130:         my $logentry = { 
                    131:                           $id => {
                    132:                                    'exe_uname' => $env{'user.name'},
                    133:                                    'exe_udom'  => $env{'user.domain'},
                    134:                                    'exe_time'  => $now,
                    135:                                    'exe_ip'    => $ENV{'REMOTE_ADDR'},
                    136:                                    'delflag'   => $delflag,
                    137:                                    'logentry'  => $storehash,
                    138:                                    'uname'     => $uname,
                    139:                                    'udom'      => $udom,
                    140:                                   }
                    141:                        };
                    142: 	return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729     www       143:     }
                    144: }
1.1       albertel  145: 
1.163     harris41  146: sub logtouch {
                    147:     my $execdir=$perlvar{'lonDaemons'};
1.448     albertel  148:     unless (-e "$execdir/logs/lonnet.log") {	
                    149: 	open(my $fh,">>$execdir/logs/lonnet.log");
1.163     harris41  150: 	close $fh;
                    151:     }
                    152:     my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
                    153:     chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
                    154: }
                    155: 
1.1       albertel  156: sub logthis {
                    157:     my $message=shift;
                    158:     my $execdir=$perlvar{'lonDaemons'};
                    159:     my $now=time;
                    160:     my $local=localtime($now);
1.448     albertel  161:     if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986     foxr      162: 	my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
                    163: 	print $fh $logstring;
1.448     albertel  164: 	close($fh);
                    165:     }
1.1       albertel  166:     return 1;
                    167: }
                    168: 
                    169: sub logperm {
                    170:     my $message=shift;
                    171:     my $execdir=$perlvar{'lonDaemons'};
                    172:     my $now=time;
                    173:     my $local=localtime($now);
1.448     albertel  174:     if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
                    175: 	print $fh "$now:$message:$local\n";
                    176: 	close($fh);
                    177:     }
1.1       albertel  178:     return 1;
                    179: }
                    180: 
1.850     albertel  181: sub create_connection {
1.853     albertel  182:     my ($hostname,$lonid) = @_;
1.851     albertel  183:     my $client=IO::Socket::UNIX->new(Peer    => $perlvar{'lonSockCreate'},
1.850     albertel  184: 				     Type    => SOCK_STREAM,
                    185: 				     Timeout => 10);
                    186:     return 0 if (!$client);
1.890     albertel  187:     print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850     albertel  188:     my $result = <$client>;
                    189:     chomp($result);
                    190:     return 1 if ($result eq 'done');
                    191:     return 0;
                    192: }
                    193: 
1.983     raeburn   194: sub get_server_timezone {
                    195:     my ($cnum,$cdom) = @_;
                    196:     my $home=&homeserver($cnum,$cdom);
                    197:     if ($home ne 'no_host') {
                    198:         my $cachetime = 24*3600;
                    199:         my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
                    200:         if (defined($cached)) {
                    201:             return $timezone;
                    202:         } else {
                    203:             my $timezone = &reply('servertimezone',$home);
                    204:             return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
                    205:         }
                    206:     }
                    207: }
1.850     albertel  208: 
1.1106    raeburn   209: sub get_server_distarch {
                    210:     my ($lonhost,$ignore_cache) = @_;
                    211:     if (defined($lonhost)) {
                    212:         if (!defined(&hostname($lonhost))) {
                    213:             return;
                    214:         }
                    215:         my $cachetime = 12*3600;
                    216:         if (!$ignore_cache) {
                    217:             my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
                    218:             if (defined($cached)) {
                    219:                 return $distarch;
                    220:             }
                    221:         }
                    222:         my $rep = &reply('serverdistarch',$lonhost);
                    223:         unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
                    224:                 $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
                    225:                 $rep eq '') {
                    226:             return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
                    227:         }
                    228:     }
                    229:     return;
                    230: }
                    231: 
1.993     raeburn   232: sub get_server_loncaparev {
1.1073    raeburn   233:     my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993     raeburn   234:     if (defined($lonhost)) {
                    235:         if (!defined(&hostname($lonhost))) {
                    236:             undef($lonhost);
                    237:         }
                    238:     }
                    239:     if (!defined($lonhost)) {
                    240:         if (defined(&domain($dom,'primary'))) {
                    241:             $lonhost=&domain($dom,'primary');
                    242:             if ($lonhost eq 'no_host') {
                    243:                 undef($lonhost);
                    244:             }
                    245:         }
                    246:     }
                    247:     if (defined($lonhost)) {
1.1073    raeburn   248:         my $cachetime = 12*3600;
                    249:         if (!$ignore_cache) {
                    250:             my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
                    251:             if (defined($cached)) {
                    252:                 return $loncaparev;
                    253:             }
                    254:         }
                    255:         my ($answer,$loncaparev);
                    256:         my @ids=&current_machine_ids();
                    257:         if (grep(/^\Q$lonhost\E$/,@ids)) {
                    258:             $answer = $perlvar{'lonVersion'};
1.1081    raeburn   259:             if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073    raeburn   260:                 $loncaparev = $1;
                    261:             }
                    262:         } else {
                    263:             $answer = &reply('serverloncaparev',$lonhost);
                    264:             if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
                    265:                 if ($caller eq 'loncron') {
                    266:                     my $ua=new LWP::UserAgent;
1.1082    raeburn   267:                     $ua->timeout(4);
1.1073    raeburn   268:                     my $protocol = $protocol{$lonhost};
                    269:                     $protocol = 'http' if ($protocol ne 'https');
                    270:                     my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
                    271:                     my $request=new HTTP::Request('GET',$url);
                    272:                     my $response=$ua->request($request);
                    273:                     unless ($response->is_error()) {
                    274:                         my $content = $response->content;
1.1081    raeburn   275:                         if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073    raeburn   276:                             $loncaparev = $1;
                    277:                         }
                    278:                     }
                    279:                 } else {
                    280:                     $loncaparev = $loncaparevs{$lonhost};
                    281:                 }
1.1081    raeburn   282:             } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073    raeburn   283:                 $loncaparev = $1;
                    284:             }
1.993     raeburn   285:         }
1.1073    raeburn   286:         return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993     raeburn   287:     }
                    288: }
                    289: 
1.1074    raeburn   290: sub get_server_homeID {
                    291:     my ($hostname,$ignore_cache,$caller) = @_;
                    292:     unless ($ignore_cache) {
                    293:         my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
                    294:         if (defined($cached)) {
                    295:             return $serverhomeID;
                    296:         }
                    297:     }
                    298:     my $cachetime = 12*3600;
                    299:     my $serverhomeID;
                    300:     if ($caller eq 'loncron') { 
                    301:         my @machine_ids = &machine_ids($hostname);
                    302:         foreach my $id (@machine_ids) {
                    303:             my $response = &reply('serverhomeID',$id);
                    304:             unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
                    305:                 $serverhomeID = $response;
                    306:                 last;
                    307:             }
                    308:         }
                    309:         if ($serverhomeID eq '') {
                    310:             $serverhomeID = $machine_ids[-1];
                    311:         }
                    312:     } else {
                    313:         $serverhomeID = $serverhomeIDs{$hostname};
                    314:     }
                    315:     return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
                    316: }
                    317: 
1.1121    raeburn   318: sub get_remote_globals {
                    319:     my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125    raeburn   320:     my ($result,%returnhash,%whatneeded);
                    321:     if (ref($whathash) eq 'HASH') {
1.1121    raeburn   322:         foreach my $what (sort(keys(%{$whathash}))) {
                    323:             my $hashid = $lonhost.'-'.$what;
1.1125    raeburn   324:             my ($response,$cached);
1.1121    raeburn   325:             unless ($ignore_cache) {
1.1125    raeburn   326:                 ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121    raeburn   327:             }
                    328:             if (defined($cached)) {
1.1125    raeburn   329:                 $returnhash{$what} = $response;
1.1121    raeburn   330:             } else {
1.1125    raeburn   331:                 $whatneeded{$what} = 1;
1.1121    raeburn   332:             }
                    333:         }
1.1125    raeburn   334:         if (keys(%whatneeded) == 0) {
                    335:             $result = 'ok';
                    336:         } else {
1.1121    raeburn   337:             my $requested = &freeze_escape(\%whatneeded);
                    338:             my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125    raeburn   339:             if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
                    340:                 ($rep eq 'unknown_cmd')) {
                    341:                 $result = $rep;
                    342:             } else {
                    343:                 $result = 'ok';
1.1121    raeburn   344:                 my @pairs=split(/\&/,$rep);
1.1125    raeburn   345:                 foreach my $item (@pairs) {
                    346:                     my ($key,$value)=split(/=/,$item,2);
                    347:                     my $what = &unescape($key);
                    348:                     my $hashid = $lonhost.'-'.$what;
                    349:                     $returnhash{$what}=&thaw_unescape($value);
                    350:                     &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121    raeburn   351:                 }
                    352:             }
                    353:         }
                    354:     }
1.1125    raeburn   355:     return ($result,\%returnhash);
1.1121    raeburn   356: }
                    357: 
1.1124    raeburn   358: sub remote_devalidate_cache {
                    359:     my ($lonhost,$name,$id) = @_;
1.1130    raeburn   360:     my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
1.1124    raeburn   361:     return $response;
                    362: }
                    363: 
1.1       albertel  364: # -------------------------------------------------- Non-critical communication
                    365: sub subreply {
                    366:     my ($cmd,$server)=@_;
1.838     albertel  367:     my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549     foxr      368:     #
                    369:     #  With loncnew process trimming, there's a timing hole between lonc server
                    370:     #  process exit and the master server picking up the listen on the AF_UNIX
                    371:     #  socket.  In that time interval, a lock file will exist:
                    372: 
                    373:     my $lockfile=$peerfile.".lock";
                    374:     while (-e $lockfile) {	# Need to wait for the lockfile to disappear.
                    375: 	sleep(1);
                    376:     }
                    377:     # At this point, either a loncnew parent is listening or an old lonc
1.550     foxr      378:     # or loncnew child is listening so we can connect or everything's dead.
1.549     foxr      379:     #
1.550     foxr      380:     #   We'll give the connection a few tries before abandoning it.  If
                    381:     #   connection is not possible, we'll con_lost back to the client.
                    382:     #   
                    383:     my $client;
                    384:     for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
                    385: 	$client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                    386: 				      Type    => SOCK_STREAM,
                    387: 				      Timeout => 10);
1.869     albertel  388: 	if ($client) {
1.550     foxr      389: 	    last;		# Connected!
1.850     albertel  390: 	} else {
1.853     albertel  391: 	    &create_connection(&hostname($server),$server);
1.550     foxr      392: 	}
1.850     albertel  393:         sleep(1);		# Try again later if failed connection.
1.550     foxr      394:     }
                    395:     my $answer;
                    396:     if ($client) {
1.704     albertel  397: 	print $client "sethost:$server:$cmd\n";
1.550     foxr      398: 	$answer=<$client>;
                    399: 	if (!$answer) { $answer="con_lost"; }
                    400: 	chomp($answer);
                    401:     } else {
                    402: 	$answer = 'con_lost';	# Failed connection.
                    403:     }
1.1       albertel  404:     return $answer;
                    405: }
                    406: 
                    407: sub reply {
                    408:     my ($cmd,$server)=@_;
1.838     albertel  409:     unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1       albertel  410:     my $answer=subreply($cmd,$server);
1.65      www       411:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672     albertel  412:        &logthis("<font color=\"blue\">WARNING:".
1.12      www       413:                 " $cmd to $server returned $answer</font>");
                    414:     }
1.1       albertel  415:     return $answer;
                    416: }
                    417: 
                    418: # ----------------------------------------------------------- Send USR1 to lonc
                    419: 
                    420: sub reconlonc {
1.891     albertel  421:     my ($lonid) = @_;
                    422:     my $hostname = &hostname($lonid);
                    423:     if ($lonid) {
                    424: 	my $peerfile="$perlvar{'lonSockDir'}/$hostname";
                    425: 	if ($hostname && -e $peerfile) {
                    426: 	    &logthis("Trying to reconnect lonc for $lonid ($hostname)");
                    427: 	    my $client=IO::Socket::UNIX->new(Peer    => $peerfile,
                    428: 					     Type    => SOCK_STREAM,
                    429: 					     Timeout => 10);
                    430: 	    if ($client) {
                    431: 		print $client ("reset_retries\n");
                    432: 		my $answer=<$client>;
                    433: 		#reset just this one.
                    434: 	    }
                    435: 	}
                    436: 	return;
                    437:     }
                    438: 
1.836     www       439:     &logthis("Trying to reconnect lonc");
1.1       albertel  440:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448     albertel  441:     if (open(my $fh,"<$loncfile")) {
1.1       albertel  442: 	my $loncpid=<$fh>;
                    443:         chomp($loncpid);
                    444:         if (kill 0 => $loncpid) {
                    445: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
                    446:             kill USR1 => $loncpid;
                    447:             sleep 1;
1.836     www       448:          } else {
1.12      www       449: 	    &logthis(
1.672     albertel  450:                "<font color=\"blue\">WARNING:".
1.12      www       451:                " lonc at pid $loncpid not responding, giving up</font>");
1.1       albertel  452:         }
                    453:     } else {
1.836     www       454: 	&logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1       albertel  455:     }
                    456: }
                    457: 
                    458: # ------------------------------------------------------ Critical communication
1.12      www       459: 
1.1       albertel  460: sub critical {
                    461:     my ($cmd,$server)=@_;
1.838     albertel  462:     unless (&hostname($server)) {
1.672     albertel  463:         &logthis("<font color=\"blue\">WARNING:".
1.89      www       464:                " Critical message to unknown server ($server)</font>");
                    465:         return 'no_such_host';
                    466:     }
1.1       albertel  467:     my $answer=reply($cmd,$server);
                    468:     if ($answer eq 'con_lost') {
                    469: 	&reconlonc("$perlvar{'lonSockDir'}/$server");
1.589     albertel  470: 	my $answer=reply($cmd,$server);
1.1       albertel  471:         if ($answer eq 'con_lost') {
                    472:             my $now=time;
                    473:             my $middlename=$cmd;
1.5       www       474:             $middlename=substr($middlename,0,16);
1.1       albertel  475:             $middlename=~s/\W//g;
                    476:             my $dfilename=
1.305     www       477:       "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
                    478:             $dumpcount++;
1.1       albertel  479:             {
1.448     albertel  480: 		my $dfh;
                    481: 		if (open($dfh,">$dfilename")) {
                    482: 		    print $dfh "$cmd\n"; 
                    483: 		    close($dfh);
                    484: 		}
1.1       albertel  485:             }
                    486:             sleep 2;
                    487:             my $wcmd='';
                    488:             {
1.448     albertel  489: 		my $dfh;
                    490: 		if (open($dfh,"<$dfilename")) {
                    491: 		    $wcmd=<$dfh>; 
                    492: 		    close($dfh);
                    493: 		}
1.1       albertel  494:             }
                    495:             chomp($wcmd);
1.7       www       496:             if ($wcmd eq $cmd) {
1.672     albertel  497: 		&logthis("<font color=\"blue\">WARNING: ".
1.12      www       498:                          "Connection buffer $dfilename: $cmd</font>");
1.1       albertel  499:                 &logperm("D:$server:$cmd");
                    500: 	        return 'con_delayed';
                    501:             } else {
1.672     albertel  502:                 &logthis("<font color=\"red\">CRITICAL:"
1.12      www       503:                         ." Critical connection failed: $server $cmd</font>");
1.1       albertel  504:                 &logperm("F:$server:$cmd");
                    505:                 return 'con_failed';
                    506:             }
                    507:         }
                    508:     }
                    509:     return $answer;
1.405     albertel  510: }
                    511: 
1.755     albertel  512: # ------------------------------------------- check if return value is an error
                    513: 
                    514: sub error {
                    515:     my ($result) = @_;
1.756     albertel  516:     if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755     albertel  517: 	if ($2 == 2) { return undef; }
                    518: 	return $1;
                    519:     }
                    520:     return undef;
                    521: }
                    522: 
1.783     albertel  523: sub convert_and_load_session_env {
                    524:     my ($lonidsdir,$handle)=@_;
                    525:     my @profile;
                    526:     {
1.917     albertel  527: 	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    528: 	if (!$opened) {
1.915     albertel  529: 	    return 0;
                    530: 	}
1.783     albertel  531: 	flock($idf,LOCK_SH);
                    532: 	@profile=<$idf>;
                    533: 	close($idf);
                    534:     }
                    535:     my %temp_env;
                    536:     foreach my $line (@profile) {
1.786     albertel  537: 	if ($line !~ m/=/) {
                    538: 	    return 0;
                    539: 	}
1.783     albertel  540: 	chomp($line);
                    541: 	my ($envname,$envvalue)=split(/=/,$line,2);
                    542: 	$temp_env{&unescape($envname)} = &unescape($envvalue);
                    543:     }
                    544:     unlink("$lonidsdir/$handle.id");
                    545:     if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
                    546: 	    0640)) {
                    547: 	%disk_env = %temp_env;
                    548: 	@env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
                    549: 	untie(%disk_env);
                    550:     }
1.786     albertel  551:     return 1;
1.783     albertel  552: }
                    553: 
1.374     www       554: # ------------------------------------------- Transfer profile into environment
1.780     albertel  555: my $env_loaded;
                    556: sub transfer_profile_to_env {
1.788     albertel  557:     my ($lonidsdir,$handle,$force_transfer) = @_;
                    558:     if (!$force_transfer && $env_loaded) { return; } 
1.374     www       559: 
1.720     albertel  560:     if (!defined($lonidsdir)) {
                    561: 	$lonidsdir = $perlvar{'lonIDsDir'};
                    562:     }
                    563:     if (!defined($handle)) {
                    564:         ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
                    565:     }
                    566: 
1.786     albertel  567:     my $convert;
                    568:     {
1.917     albertel  569:     	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    570: 	if (!$opened) {
1.915     albertel  571: 	    return;
                    572: 	}
1.786     albertel  573: 	flock($idf,LOCK_SH);
                    574: 	if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    575: 		&GDBM_READER(),0640)) {
                    576: 	    @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
                    577: 	    untie(%disk_env);
                    578: 	} else {
                    579: 	    $convert = 1;
                    580: 	}
                    581:     }
                    582:     if ($convert) {
                    583: 	if (!&convert_and_load_session_env($lonidsdir,$handle)) {
                    584: 	    &logthis("Failed to load session, or convert session.");
                    585: 	}
1.374     www       586:     }
1.783     albertel  587: 
1.786     albertel  588:     my %remove;
1.783     albertel  589:     while ( my $envname = each(%env) ) {
1.433     matthew   590:         if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
                    591:             if ($time < time-300) {
1.783     albertel  592:                 $remove{$key}++;
1.433     matthew   593:             }
                    594:         }
                    595:     }
1.783     albertel  596: 
1.619     albertel  597:     $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780     albertel  598:     $env_loaded=1;
1.783     albertel  599:     foreach my $expired_key (keys(%remove)) {
1.433     matthew   600:         &delenv($expired_key);
1.374     www       601:     }
1.1       albertel  602: }
                    603: 
1.916     albertel  604: # ---------------------------------------------------- Check for valid session 
                    605: sub check_for_valid_session {
1.1155    raeburn   606:     my ($r,$name) = @_;
1.916     albertel  607:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1155    raeburn   608:     if ($name eq '') {
                    609:         $name = 'lonID';
                    610:     }
                    611:     my $lonid=$cookies{$name};
1.916     albertel  612:     return undef if (!$lonid);
                    613: 
                    614:     my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155    raeburn   615:     my $lonidsdir;
                    616:     if ($name eq 'lonDAV') {
                    617:         $lonidsdir=$r->dir_config('lonDAVsessDir');
                    618:     } else {
                    619:         $lonidsdir=$r->dir_config('lonIDsDir');
                    620:     }
1.916     albertel  621:     return undef if (!-e "$lonidsdir/$handle.id");
                    622: 
1.917     albertel  623:     my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    624:     return undef if (!$opened);
1.916     albertel  625: 
                    626:     flock($idf,LOCK_SH);
                    627:     my %disk_env;
                    628:     if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    629: 	    &GDBM_READER(),0640)) {
                    630: 	return undef;	
                    631:     }
                    632: 
                    633:     if (!defined($disk_env{'user.name'})
                    634: 	|| !defined($disk_env{'user.domain'})) {
                    635: 	return undef;
                    636:     }
                    637:     return $handle;
                    638: }
                    639: 
1.830     albertel  640: sub timed_flock {
                    641:     my ($file,$lock_type) = @_;
                    642:     my $failed=0;
                    643:     eval {
                    644: 	local $SIG{__DIE__}='DEFAULT';
                    645: 	local $SIG{ALRM}=sub {
                    646: 	    $failed=1;
                    647: 	    die("failed lock");
                    648: 	};
                    649: 	alarm(13);
                    650: 	flock($file,$lock_type);
                    651: 	alarm(0);
                    652:     };
                    653:     if ($failed) {
                    654: 	return undef;
                    655:     } else {
                    656: 	return 1;
                    657:     }
                    658: }
                    659: 
1.5       www       660: # ---------------------------------------------------------- Append Environment
                    661: 
                    662: sub appenv {
1.949     raeburn   663:     my ($newenv,$roles) = @_;
                    664:     if (ref($newenv) eq 'HASH') {
                    665:         foreach my $key (keys(%{$newenv})) {
                    666:             my $refused = 0;
                    667: 	    if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
                    668:                 $refused = 1;
                    669:                 if (ref($roles) eq 'ARRAY') {
                    670:                     my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
                    671:                     if (grep(/^\Q$role\E$/,@{$roles})) {
                    672:                         $refused = 0;
                    673:                     }
                    674:                 }
                    675:             }
                    676:             if ($refused) {
                    677:                 &logthis("<font color=\"blue\">WARNING: ".
                    678:                          "Attempt to modify environment ".$key." to ".$newenv->{$key}
                    679:                          .'</font>');
                    680: 	        delete($newenv->{$key});
                    681:             } else {
                    682:                 $env{$key}=$newenv->{$key};
                    683:             }
                    684:         }
                    685:         my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    686:         if ($opened
                    687: 	    && &timed_flock($env_file,LOCK_EX)
                    688: 	    &&
                    689: 	    tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    690: 	        (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
                    691: 	    while (my ($key,$value) = each(%{$newenv})) {
                    692: 	        $disk_env{$key} = $value;
                    693: 	    }
                    694: 	    untie(%disk_env);
1.35      www       695:         }
1.191     harris41  696:     }
1.56      www       697:     return 'ok';
                    698: }
                    699: # ----------------------------------------------------- Delete from Environment
                    700: 
                    701: sub delenv {
1.1104    raeburn   702:     my ($delthis,$regexp,$roles) = @_;
                    703:     if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
                    704:         my $refused = 1;
                    705:         if (ref($roles) eq 'ARRAY') {
                    706:             my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
                    707:             if (grep(/^\Q$role\E$/,@{$roles})) {
                    708:                 $refused = 0;
                    709:             }
                    710:         }
                    711:         if ($refused) {
                    712:             &logthis("<font color=\"blue\">WARNING: ".
                    713:                      "Attempt to delete from environment ".$delthis);
                    714:             return 'error';
                    715:         }
1.56      www       716:     }
1.917     albertel  717:     my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    718:     if ($opened
1.915     albertel  719: 	&& &timed_flock($env_file,LOCK_EX)
1.830     albertel  720: 	&&
                    721: 	tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    722: 	    (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783     albertel  723: 	foreach my $key (keys(%disk_env)) {
1.987     raeburn   724: 	    if ($regexp) {
                    725:                 if ($key=~/^$delthis/) {
                    726:                     delete($env{$key});
                    727:                     delete($disk_env{$key});
                    728:                 } 
                    729:             } else {
                    730:                 if ($key=~/^\Q$delthis\E/) {
                    731: 		    delete($env{$key});
                    732: 		    delete($disk_env{$key});
                    733: 	        }
                    734:             }
1.448     albertel  735: 	}
1.783     albertel  736: 	untie(%disk_env);
1.5       www       737:     }
                    738:     return 'ok';
1.369     albertel  739: }
                    740: 
1.790     albertel  741: sub get_env_multiple {
                    742:     my ($name) = @_;
                    743:     my @values;
                    744:     if (defined($env{$name})) {
                    745:         # exists is it an array
                    746:         if (ref($env{$name})) {
                    747:             @values=@{ $env{$name} };
                    748:         } else {
                    749:             $values[0]=$env{$name};
                    750:         }
                    751:     }
                    752:     return(@values);
                    753: }
                    754: 
1.958     www       755: # ------------------------------------------------------------------- Locking
                    756: 
                    757: sub set_lock {
                    758:     my ($text)=@_;
                    759:     $locknum++;
                    760:     my $id=$$.'-'.$locknum;
                    761:     &appenv({'session.locks' => $env{'session.locks'}.','.$id,
                    762:              'session.lock.'.$id => $text});
                    763:     return $id;
                    764: }
                    765: 
                    766: sub get_locks {
                    767:     my $num=0;
                    768:     my %texts=();
                    769:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    770:        if ($lock=~/\w/) {
                    771:           $num++;
                    772:           $texts{$lock}=$env{'session.lock.'.$lock};
                    773:        }
                    774:    }
                    775:    return ($num,%texts);
                    776: }
                    777: 
                    778: sub remove_lock {
                    779:     my ($id)=@_;
                    780:     my $newlocks='';
                    781:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    782:        if (($lock=~/\w/) && ($lock ne $id)) {
                    783:           $newlocks.=','.$lock;
                    784:        }
                    785:     }
                    786:     &appenv({'session.locks' => $newlocks});
                    787:     &delenv('session.lock.'.$id);
                    788: }
                    789: 
                    790: sub remove_all_locks {
                    791:     my $activelocks=$env{'session.locks'};
                    792:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    793:        if ($lock=~/\w/) {
                    794:           &remove_lock($lock);
                    795:        }
                    796:     }
                    797: }
                    798: 
                    799: 
1.369     albertel  800: # ------------------------------------------ Find out current server userload
                    801: sub userload {
                    802:     my $numusers=0;
                    803:     {
                    804: 	opendir(LONIDS,$perlvar{'lonIDsDir'});
                    805: 	my $filename;
                    806: 	my $curtime=time;
                    807: 	while ($filename=readdir(LONIDS)) {
1.925     albertel  808: 	    next if ($filename eq '.' || $filename eq '..');
                    809: 	    next if ($filename =~ /publicuser_\d+\.id/);
1.404     albertel  810: 	    my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437     albertel  811: 	    if ($curtime-$mtime < 1800) { $numusers++; }
1.369     albertel  812: 	}
                    813: 	closedir(LONIDS);
                    814:     }
                    815:     my $userloadpercent=0;
                    816:     my $maxuserload=$perlvar{'lonUserLoadLim'};
                    817:     if ($maxuserload) {
1.371     albertel  818: 	$userloadpercent=100*$numusers/$maxuserload;
1.369     albertel  819:     }
1.372     albertel  820:     $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369     albertel  821:     return $userloadpercent;
1.283     www       822: }
                    823: 
1.1       albertel  824: # ------------------------------ Find server with least workload from spare.tab
1.11      www       825: 
1.1       albertel  826: sub spareserver {
1.1083    raeburn   827:     my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784     albertel  828:     my $spare_server;
1.370     albertel  829:     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784     albertel  830:     my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 
                    831:                                                      :  $userloadpercent;
1.1083    raeburn   832:     my ($uint_dom,$remotesessions);
                    833:     if (($udom ne '') && (&domain($udom) ne '')) {
                    834:         my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                    835:         $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
                    836:         my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
                    837:         $remotesessions = $udomdefaults{'remotesessions'};
                    838:     }
1.1123    raeburn   839:     my $spareshash = &this_host_spares($udom);
                    840:     if (ref($spareshash) eq 'HASH') {
                    841:         if (ref($spareshash->{'primary'}) eq 'ARRAY') {
                    842:             foreach my $try_server (@{ $spareshash->{'primary'} }) {
                    843:                 if ($uint_dom) {
                    844:                     next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
                    845:                                                  $try_server));
                    846:                 }
                    847: 	        ($spare_server, $lowest_load) =
                    848: 	            &compare_server_load($try_server, $spare_server, $lowest_load);
                    849:             }
1.1083    raeburn   850:         }
1.784     albertel  851: 
1.1123    raeburn   852:         my $found_server = ($spare_server ne '' && $lowest_load < 100);
                    853: 
                    854:         if (!$found_server) {
                    855:             if (ref($spareshash->{'default'}) eq 'ARRAY') { 
                    856: 	        foreach my $try_server (@{ $spareshash->{'default'} }) {
                    857:                     if ($uint_dom) {
                    858:                         next unless (&spare_can_host($udom,$uint_dom,
                    859:                                                      $remotesessions,$try_server));
                    860:                     }
                    861: 	            ($spare_server, $lowest_load) =
                    862: 		        &compare_server_load($try_server, $spare_server, $lowest_load);
                    863:                 }
                    864: 	    }
                    865:         }
1.784     albertel  866:     }
                    867: 
                    868:     if (!$want_server_name) {
1.968     raeburn   869:         my $protocol = 'http';
                    870:         if ($protocol{$spare_server} eq 'https') {
                    871:             $protocol = $protocol{$spare_server};
                    872:         }
1.1001    raeburn   873:         if (defined($spare_server)) {
                    874:             my $hostname = &hostname($spare_server);
1.1083    raeburn   875:             if (defined($hostname)) {
1.1001    raeburn   876: 	        $spare_server = $protocol.'://'.$hostname;
                    877:             }
                    878:         }
1.784     albertel  879:     }
                    880:     return $spare_server;
                    881: }
                    882: 
                    883: sub compare_server_load {
                    884:     my ($try_server, $spare_server, $lowest_load) = @_;
                    885: 
                    886:     my $loadans     = &reply('load',    $try_server);
                    887:     my $userloadans = &reply('userload',$try_server);
                    888: 
                    889:     if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114    raeburn   890: 	return ($spare_server, $lowest_load); #didn't get a number from the server
1.784     albertel  891:     }
                    892: 
                    893:     my $load;
                    894:     if ($loadans =~ /\d/) {
                    895: 	if ($userloadans =~ /\d/) {
                    896: 	    #both are numbers, pick the bigger one
                    897: 	    $load = ($loadans > $userloadans) ? $loadans 
                    898: 		                              : $userloadans;
1.411     albertel  899: 	} else {
1.784     albertel  900: 	    $load = $loadans;
1.411     albertel  901: 	}
1.784     albertel  902:     } else {
                    903: 	$load = $userloadans;
                    904:     }
                    905: 
                    906:     if (($load =~ /\d/) && ($load < $lowest_load)) {
                    907: 	$spare_server = $try_server;
                    908: 	$lowest_load  = $load;
1.370     albertel  909:     }
1.784     albertel  910:     return ($spare_server,$lowest_load);
1.202     matthew   911: }
1.914     albertel  912: 
                    913: # --------------------------- ask offload servers if user already has a session
                    914: sub find_existing_session {
                    915:     my ($udom,$uname) = @_;
1.1123    raeburn   916:     my $spareshash = &this_host_spares($udom);
                    917:     if (ref($spareshash) eq 'HASH') {
                    918:         if (ref($spareshash->{'primary'}) eq 'ARRAY') {
                    919:             foreach my $try_server (@{ $spareshash->{'primary'} }) {
                    920:                 return $try_server if (&has_user_session($try_server, $udom, $uname));
                    921:             }
                    922:         }
                    923:         if (ref($spareshash->{'default'}) eq 'ARRAY') {
                    924:             foreach my $try_server (@{ $spareshash->{'default'} }) {
                    925:                 return $try_server if (&has_user_session($try_server, $udom, $uname));
                    926:             }
                    927:         }
1.914     albertel  928:     }
                    929:     return;
                    930: }
                    931: 
                    932: # -------------------------------- ask if server already has a session for user
                    933: sub has_user_session {
                    934:     my ($lonid,$udom,$uname) = @_;
                    935:     my $result = &reply(join(':','userhassession',
                    936: 			     map {&escape($_)} ($udom,$uname)),$lonid);
                    937:     return 1 if ($result eq 'ok');
                    938: 
                    939:     return 0;
                    940: }
                    941: 
1.1076    raeburn   942: # --------- determine least loaded server in a user's domain which allows login
                    943: 
                    944: sub choose_server {
1.1115    raeburn   945:     my ($udom,$checkloginvia) = @_;
1.1076    raeburn   946:     my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077    raeburn   947:     my %servers = &get_servers($udom);
1.1076    raeburn   948:     my $lowest_load = 30000;
1.1151    raeburn   949:     my ($login_host,$hostname,$portal_path,$isredirect);
1.1076    raeburn   950:     foreach my $lonhost (keys(%servers)) {
1.1115    raeburn   951:         my $loginvia;
                    952:         if ($checkloginvia) {
                    953:             $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116    raeburn   954:             if ($loginvia) {
                    955:                 my ($server,$path) = split(/:/,$loginvia);
                    956:                 ($login_host, $lowest_load) =
                    957:                     &compare_server_load($server, $login_host, $lowest_load);
                    958:                 if ($login_host eq $server) {
                    959:                     $portal_path = $path;
1.1151    raeburn   960:                     $isredirect = 1;
1.1116    raeburn   961:                 }
                    962:             } else {
                    963:                 ($login_host, $lowest_load) =
                    964:                     &compare_server_load($lonhost, $login_host, $lowest_load);
                    965:                 if ($login_host eq $lonhost) {
                    966:                     $portal_path = '';
1.1151    raeburn   967:                     $isredirect = ''; 
1.1116    raeburn   968:                 }
                    969:             }
                    970:         } else {
1.1076    raeburn   971:             ($login_host, $lowest_load) =
1.1116    raeburn   972:                 &compare_server_load($lonhost, $login_host, $lowest_load);
1.1076    raeburn   973:         }
                    974:     }
                    975:     if ($login_host ne '') {
1.1116    raeburn   976:         $hostname = &hostname($login_host);
1.1076    raeburn   977:     }
1.1151    raeburn   978:     return ($login_host,$hostname,$portal_path,$isredirect);
1.1076    raeburn   979: }
                    980: 
1.202     matthew   981: # --------------------------------------------- Try to change a user's password
                    982: 
                    983: sub changepass {
1.799     raeburn   984:     my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202     matthew   985:     $currentpass = &escape($currentpass);
                    986:     $newpass     = &escape($newpass);
1.1030    raeburn   987:     my $lonhost = $perlvar{'lonHostID'};
                    988:     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202     matthew   989: 		       $server);
                    990:     if (! $answer) {
                    991: 	&logthis("No reply on password change request to $server ".
                    992: 		 "by $uname in domain $udom.");
                    993:     } elsif ($answer =~ "^ok") {
                    994:         &logthis("$uname in $udom successfully changed their password ".
                    995: 		 "on $server.");
                    996:     } elsif ($answer =~ "^pwchange_failure") {
                    997: 	&logthis("$uname in $udom was unable to change their password ".
                    998: 		 "on $server.  The action was blocked by either lcpasswd ".
                    999: 		 "or pwchange");
                   1000:     } elsif ($answer =~ "^non_authorized") {
                   1001:         &logthis("$uname in $udom did not get their password correct when ".
                   1002: 		 "attempting to change it on $server.");
                   1003:     } elsif ($answer =~ "^auth_mode_error") {
                   1004:         &logthis("$uname in $udom attempted to change their password despite ".
                   1005: 		 "not being locally or internally authenticated on $server.");
                   1006:     } elsif ($answer =~ "^unknown_user") {
                   1007:         &logthis("$uname in $udom attempted to change their password ".
                   1008: 		 "on $server but were unable to because $server is not ".
                   1009: 		 "their home server.");
                   1010:     } elsif ($answer =~ "^refused") {
                   1011: 	&logthis("$server refused to change $uname in $udom password because ".
                   1012: 		 "it was sent an unencrypted request to change the password.");
1.1030    raeburn  1013:     } elsif ($answer =~ "invalid_client") {
                   1014:         &logthis("$server refused to change $uname in $udom password because ".
                   1015:                  "it was a reset by e-mail originating from an invalid server.");
1.202     matthew  1016:     }
                   1017:     return $answer;
1.1       albertel 1018: }
                   1019: 
1.169     harris41 1020: # ----------------------- Try to determine user's current authentication scheme
                   1021: 
                   1022: sub queryauthenticate {
                   1023:     my ($uname,$udom)=@_;
1.456     albertel 1024:     my $uhome=&homeserver($uname,$udom);
                   1025:     if (!$uhome) {
                   1026: 	&logthis("User $uname at $udom is unknown when looking for authentication mechanism");
                   1027: 	return 'no_host';
                   1028:     }
                   1029:     my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
                   1030:     if ($answer =~ /^(unknown_user|refused|con_lost)/) {
                   1031: 	&logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169     harris41 1032:     }
1.456     albertel 1033:     return $answer;
1.169     harris41 1034: }
                   1035: 
1.1       albertel 1036: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11      www      1037: 
1.1       albertel 1038: sub authenticate {
1.1073    raeburn  1039:     my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807     albertel 1040:     $upass=&escape($upass);
                   1041:     $uname= &LONCAPA::clean_username($uname);
1.836     www      1042:     my $uhome=&homeserver($uname,$udom,1);
1.952     raeburn  1043:     my $newhome;
1.836     www      1044:     if ((!$uhome) || ($uhome eq 'no_host')) {
                   1045: # Maybe the machine was offline and only re-appeared again recently?
                   1046:         &reconlonc();
                   1047: # One more
1.952     raeburn  1048: 	$uhome=&homeserver($uname,$udom,1);
                   1049:         if (($uhome eq 'no_host') && $checkdefauth) {
                   1050:             if (defined(&domain($udom,'primary'))) {
                   1051:                 $newhome=&domain($udom,'primary');
                   1052:             }
                   1053:             if ($newhome ne '') {
                   1054:                 $uhome = $newhome;
                   1055:             }
                   1056:         }
1.836     www      1057: 	if ((!$uhome) || ($uhome eq 'no_host')) {
                   1058: 	    &logthis("User $uname at $udom is unknown in authenticate");
1.952     raeburn  1059: 	    return 'no_host';
                   1060:         }
1.1       albertel 1061:     }
1.1073    raeburn  1062:     my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471     albertel 1063:     if ($answer eq 'authorized') {
1.952     raeburn  1064:         if ($newhome) {
                   1065:             &logthis("User $uname at $udom authorized by $uhome, but needs account");
                   1066:             return 'no_account_on_host'; 
                   1067:         } else {
                   1068:             &logthis("User $uname at $udom authorized by $uhome");
                   1069:             return $uhome;
                   1070:         }
1.471     albertel 1071:     }
                   1072:     if ($answer eq 'non_authorized') {
                   1073: 	&logthis("User $uname at $udom rejected by $uhome");
                   1074: 	return 'no_host'; 
1.9       www      1075:     }
1.471     albertel 1076:     &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1       albertel 1077:     return 'no_host';
                   1078: }
                   1079: 
1.1073    raeburn  1080: sub can_host_session {
1.1074    raeburn  1081:     my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073    raeburn  1082:     my $canhost = 1;
1.1074    raeburn  1083:     my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073    raeburn  1084:     if (ref($remotesessions) eq 'HASH') {
                   1085:         if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074    raeburn  1086:             if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073    raeburn  1087:                 $canhost = 0;
                   1088:             } else {
                   1089:                 $canhost = 1;
                   1090:             }
                   1091:         }
                   1092:         if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074    raeburn  1093:             if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073    raeburn  1094:                 $canhost = 1;
                   1095:             } else {
                   1096:                 $canhost = 0;
                   1097:             }
                   1098:         }
                   1099:         if ($canhost) {
                   1100:             if ($remotesessions->{'version'} ne '') {
                   1101:                 my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
                   1102:                 if ($reqmajor ne '' && $reqminor ne '') {
                   1103:                     if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
                   1104:                         my $major = $1;
                   1105:                         my $minor = $2;
                   1106:                         if (($major < $reqmajor ) ||
                   1107:                             (($major == $reqmajor) && ($minor < $reqminor))) {
                   1108:                             $canhost = 0;
                   1109:                         }
                   1110:                     } else {
                   1111:                         $canhost = 0;
                   1112:                     }
                   1113:                 }
                   1114:             }
                   1115:         }
                   1116:     }
                   1117:     if ($canhost) {
                   1118:         if (ref($hostedsessions) eq 'HASH') {
1.1120    raeburn  1119:             my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                   1120:             my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073    raeburn  1121:             if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120    raeburn  1122:                 if (($uint_dom ne '') && 
                   1123:                     (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073    raeburn  1124:                     $canhost = 0;
                   1125:                 } else {
                   1126:                     $canhost = 1;
                   1127:                 }
                   1128:             }
                   1129:             if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120    raeburn  1130:                 if (($uint_dom ne '') && 
                   1131:                     (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073    raeburn  1132:                     $canhost = 1;
                   1133:                 } else {
                   1134:                     $canhost = 0;
                   1135:                 }
                   1136:             }
                   1137:         }
                   1138:     }
                   1139:     return $canhost;
                   1140: }
                   1141: 
1.1083    raeburn  1142: sub spare_can_host {
                   1143:     my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
                   1144:     my $canhost=1;
                   1145:     my @intdoms;
                   1146:     my $internet_names = &Apache::lonnet::get_internet_names($try_server);
                   1147:     if (ref($internet_names) eq 'ARRAY') {
                   1148:         @intdoms = @{$internet_names};
                   1149:     }
                   1150:     unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
                   1151:         my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
                   1152:         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   1153:         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   1154:         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
                   1155:         $canhost = &can_host_session($udom,$try_server,$remoterev,
                   1156:                                      $remotesessions,
                   1157:                                      $defdomdefaults{'hostedsessions'});
                   1158:     }
                   1159:     return $canhost;
                   1160: }
                   1161: 
1.1123    raeburn  1162: sub this_host_spares {
                   1163:     my ($dom) = @_;
1.1126    raeburn  1164:     my ($dom_in_use,$lonhost_in_use,$result);
1.1123    raeburn  1165:     my @hosts = &current_machine_ids();
                   1166:     foreach my $lonhost (@hosts) {
                   1167:         if (&host_domain($lonhost) eq $dom) {
1.1126    raeburn  1168:             $dom_in_use = $dom;
                   1169:             $lonhost_in_use = $lonhost;
1.1123    raeburn  1170:             last;
                   1171:         }
                   1172:     }
1.1126    raeburn  1173:     if ($dom_in_use ne '') {
                   1174:         $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
                   1175:     }
                   1176:     if (ref($result) ne 'HASH') {
                   1177:         $lonhost_in_use = $perlvar{'lonHostID'};
                   1178:         $dom_in_use = &host_domain($lonhost_in_use);
                   1179:         $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
                   1180:         if (ref($result) ne 'HASH') {
                   1181:             $result = \%spareid;
                   1182:         }
                   1183:     }
                   1184:     return $result;
                   1185: }
                   1186: 
                   1187: sub spares_for_offload  {
                   1188:     my ($dom_in_use,$lonhost_in_use) = @_;
                   1189:     my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123    raeburn  1190:     if (defined($cached)) {
                   1191:         return $result;
                   1192:     } else {
1.1126    raeburn  1193:         my $cachetime = 60*60*24;
                   1194:         my %domconfig =
                   1195:             &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
                   1196:         if (ref($domconfig{'usersessions'}) eq 'HASH') {
                   1197:             if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
                   1198:                 if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
                   1199:                     return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123    raeburn  1200:                 }
                   1201:             }
                   1202:         }
                   1203:     }
1.1126    raeburn  1204:     return;
1.1123    raeburn  1205: }
                   1206: 
1.1129    raeburn  1207: sub get_lonbalancer_config {
                   1208:     my ($servers) = @_;
                   1209:     my ($currbalancer,$currtargets);
                   1210:     if (ref($servers) eq 'HASH') {
                   1211:         foreach my $server (keys(%{$servers})) {
                   1212:             my %what = (
                   1213:                          spareid => 1,
                   1214:                          perlvar => 1,
                   1215:                        );
                   1216:             my ($result,$returnhash) = &get_remote_globals($server,\%what);
                   1217:             if ($result eq 'ok') {
                   1218:                 if (ref($returnhash) eq 'HASH') {
                   1219:                     if (ref($returnhash->{'perlvar'}) eq 'HASH') {
                   1220:                         if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
                   1221:                             $currbalancer = $server;
                   1222:                             $currtargets = {};
                   1223:                             if (ref($returnhash->{'spareid'}) eq 'HASH') {
                   1224:                                 if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
                   1225:                                     $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
                   1226:                                 }
                   1227:                                 if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
                   1228:                                     $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
                   1229:                                 }
                   1230:                             }
                   1231:                             last;
                   1232:                         }
                   1233:                     }
                   1234:                 }
                   1235:             }
                   1236:         }
                   1237:     }
                   1238:     return ($currbalancer,$currtargets);
                   1239: }
                   1240: 
                   1241: sub check_loadbalancing {
                   1242:     my ($uname,$udom) = @_;
1.1191    raeburn  1243:     my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
                   1244:         $rule_in_effect,$offloadto,$otherserver);
1.1129    raeburn  1245:     my $lonhost = $perlvar{'lonHostID'};
1.1175    raeburn  1246:     my @hosts = &current_machine_ids();
1.1129    raeburn  1247:     my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                   1248:     my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
                   1249:     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   1250:     my $serverhomedom = &host_domain($lonhost);
                   1251: 
                   1252:     my $cachetime = 60*60*24;
                   1253: 
                   1254:     if (($uintdom ne '') && ($uintdom eq $intdom)) {
                   1255:         $dom_in_use = $udom;
                   1256:         $homeintdom = 1;
                   1257:     } else {
                   1258:         $dom_in_use = $serverhomedom;
                   1259:     }
                   1260:     my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
                   1261:     unless (defined($cached)) {
                   1262:         my %domconfig =
                   1263:             &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
                   1264:         if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130    raeburn  1265:             $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129    raeburn  1266:         }
                   1267:     }
                   1268:     if (ref($result) eq 'HASH') {
1.1191    raeburn  1269:         ($is_balancer,$currtargets,$currrules) = 
                   1270:             &check_balancer_result($result,@hosts);
1.1129    raeburn  1271:         if ($is_balancer) {
                   1272:             if (ref($currrules) eq 'HASH') {
                   1273:                 if ($homeintdom) {
                   1274:                     if ($uname ne '') {
                   1275:                         if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
                   1276:                             my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
                   1277:                             if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
                   1278:                                 $rule_in_effect = $currrules->{'_LC_author'};
                   1279:                             } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
                   1280:                                 $rule_in_effect = $currrules->{'_LC_adv'}
                   1281:                             }
                   1282:                         }
                   1283:                         if ($rule_in_effect eq '') {
                   1284:                             my %userenv = &userenvironment($udom,$uname,'inststatus');
                   1285:                             if ($userenv{'inststatus'} ne '') {
                   1286:                                 my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
                   1287:                                 my ($othertitle,$usertypes,$types) =
                   1288:                                     &Apache::loncommon::sorted_inst_types($udom);
                   1289:                                 if (ref($types) eq 'ARRAY') {
                   1290:                                     foreach my $type (@{$types}) {
                   1291:                                         if (grep(/^\Q$type\E$/,@statuses)) {
                   1292:                                             if (exists($currrules->{$type})) {
                   1293:                                                 $rule_in_effect = $currrules->{$type};
                   1294:                                             }
                   1295:                                         }
                   1296:                                     }
                   1297:                                 }
                   1298:                             } else {
                   1299:                                 if (exists($currrules->{'default'})) {
                   1300:                                     $rule_in_effect = $currrules->{'default'};
                   1301:                                 }
                   1302:                             }
                   1303:                         }
                   1304:                     } else {
                   1305:                         if (exists($currrules->{'default'})) {
                   1306:                             $rule_in_effect = $currrules->{'default'};
                   1307:                         }
                   1308:                     }
                   1309:                 } else {
                   1310:                     if ($currrules->{'_LC_external'} ne '') {
                   1311:                         $rule_in_effect = $currrules->{'_LC_external'};
                   1312:                     }
                   1313:                 }
                   1314:                 $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
                   1315:                                                        $uname,$udom);
                   1316:             }
                   1317:         }
                   1318:     } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
                   1319:         my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
                   1320:         unless (defined($cached)) {
                   1321:             my %domconfig =
                   1322:                 &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
                   1323:             if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130    raeburn  1324:                 $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129    raeburn  1325:             }
                   1326:         }
                   1327:         if (ref($result) eq 'HASH') {
1.1191    raeburn  1328:             ($is_balancer,$currtargets,$currrules) = 
                   1329:                 &check_balancer_result($result,@hosts);
                   1330:             if ($is_balancer) {
1.1129    raeburn  1331:                 if (ref($currrules) eq 'HASH') {
                   1332:                     if ($currrules->{'_LC_internetdom'} ne '') {
                   1333:                         $rule_in_effect = $currrules->{'_LC_internetdom'};
                   1334:                     }
                   1335:                 }
                   1336:                 $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
                   1337:                                                        $uname,$udom);
                   1338:             }
                   1339:         } else {
                   1340:             if ($perlvar{'lonBalancer'} eq 'yes') {
                   1341:                 $is_balancer = 1;
                   1342:                 $offloadto = &this_host_spares($dom_in_use);
                   1343:             }
                   1344:         }
                   1345:     } else {
                   1346:         if ($perlvar{'lonBalancer'} eq 'yes') {
                   1347:             $is_balancer = 1;
                   1348:             $offloadto = &this_host_spares($dom_in_use);
                   1349:         }
                   1350:     }
1.1176    raeburn  1351:     if ($is_balancer) {
                   1352:         my $lowest_load = 30000;
                   1353:         if (ref($offloadto) eq 'HASH') {
                   1354:             if (ref($offloadto->{'primary'}) eq 'ARRAY') {
                   1355:                 foreach my $try_server (@{$offloadto->{'primary'}}) {
                   1356:                     ($otherserver,$lowest_load) =
                   1357:                         &compare_server_load($try_server,$otherserver,$lowest_load);
                   1358:                 }
1.1129    raeburn  1359:             }
1.1176    raeburn  1360:             my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129    raeburn  1361: 
1.1176    raeburn  1362:             if (!$found_server) {
                   1363:                 if (ref($offloadto->{'default'}) eq 'ARRAY') {
                   1364:                     foreach my $try_server (@{$offloadto->{'default'}}) {
                   1365:                         ($otherserver,$lowest_load) =
                   1366:                             &compare_server_load($try_server,$otherserver,$lowest_load);
                   1367:                     }
                   1368:                 }
                   1369:             }
                   1370:         } elsif (ref($offloadto) eq 'ARRAY') {
                   1371:             if (@{$offloadto} == 1) {
                   1372:                 $otherserver = $offloadto->[0];
                   1373:             } elsif (@{$offloadto} > 1) {
                   1374:                 foreach my $try_server (@{$offloadto}) {
1.1129    raeburn  1375:                     ($otherserver,$lowest_load) =
                   1376:                         &compare_server_load($try_server,$otherserver,$lowest_load);
                   1377:                 }
                   1378:             }
                   1379:         }
1.1176    raeburn  1380:         if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
                   1381:             $is_balancer = 0;
                   1382:             if ($uname ne '' && $udom ne '') {
                   1383:                 if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
                   1384:                     
                   1385:                     &appenv({'user.loadbalexempt'     => $lonhost,  
                   1386:                              'user.loadbalcheck.time' => time});
                   1387:                 }
1.1129    raeburn  1388:             }
                   1389:         }
                   1390:     }
                   1391:     return ($is_balancer,$otherserver);
                   1392: }
                   1393: 
1.1191    raeburn  1394: sub check_balancer_result {
                   1395:     my ($result,@hosts) = @_;
                   1396:     my ($is_balancer,$currtargets,$currrules);
                   1397:     if (ref($result) eq 'HASH') {
                   1398:         if ($result->{'lonhost'} ne '') {
                   1399:             my $currbalancer = $result->{'lonhost'};
                   1400:             if (grep(/^\Q$currbalancer\E$/,@hosts)) {
                   1401:                 $is_balancer = 1;
                   1402:                 $currtargets = $result->{'targets'};
                   1403:                 $currrules = $result->{'rules'};
                   1404:             }
                   1405:         } else {
                   1406:             foreach my $key (keys(%{$result})) {
                   1407:                 if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
                   1408:                     (ref($result->{$key}) eq 'HASH')) {
                   1409:                     $is_balancer = 1;
                   1410:                     $currrules = $result->{$key}{'rules'};
                   1411:                     $currtargets = $result->{$key}{'targets'};
                   1412:                     last;
                   1413:                 }
                   1414:             }
                   1415:         }
                   1416:     }
                   1417:     return ($is_balancer,$currtargets,$currrules);
                   1418: }
                   1419: 
1.1129    raeburn  1420: sub get_loadbalancer_targets {
                   1421:     my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
                   1422:     my $offloadto;
1.1175    raeburn  1423:     if ($rule_in_effect eq 'none') {
                   1424:         return [$perlvar{'lonHostID'}];
                   1425:     } elsif ($rule_in_effect eq '') {
1.1129    raeburn  1426:         $offloadto = $currtargets;
                   1427:     } else {
                   1428:         if ($rule_in_effect eq 'homeserver') {
                   1429:             my $homeserver = &homeserver($uname,$udom);
                   1430:             if ($homeserver ne 'no_host') {
                   1431:                 $offloadto = [$homeserver];
                   1432:             }
                   1433:         } elsif ($rule_in_effect eq 'externalbalancer') {
                   1434:             my %domconfig =
                   1435:                 &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
                   1436:             if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
                   1437:                 if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
                   1438:                     if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
                   1439:                         $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
                   1440:                     }
                   1441:                 }
                   1442:             } else {
1.1178    raeburn  1443:                 my %servers = &internet_dom_servers($udom);
1.1129    raeburn  1444:                 my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
                   1445:                 if (&hostname($remotebalancer) ne '') {
                   1446:                     $offloadto = [$remotebalancer];
                   1447:                 }
                   1448:             }
                   1449:         } elsif (&hostname($rule_in_effect) ne '') {
                   1450:             $offloadto = [$rule_in_effect];
                   1451:         }
                   1452:     }
                   1453:     return $offloadto;
                   1454: }
                   1455: 
1.1127    raeburn  1456: sub internet_dom_servers {
                   1457:     my ($dom) = @_;
                   1458:     my (%uniqservers,%servers);
                   1459:     my $primaryserver = &hostname(&domain($dom,'primary'));
                   1460:     my @machinedoms = &machine_domains($primaryserver);
                   1461:     foreach my $mdom (@machinedoms) {
                   1462:         my %currservers = %servers;
                   1463:         my %server = &get_servers($mdom);
                   1464:         %servers = (%currservers,%server);
                   1465:     }
                   1466:     my %by_hostname;
                   1467:     foreach my $id (keys(%servers)) {
                   1468:         push(@{$by_hostname{$servers{$id}}},$id);
                   1469:     }
                   1470:     foreach my $hostname (sort(keys(%by_hostname))) {
                   1471:         if (@{$by_hostname{$hostname}} > 1) {
                   1472:             my $match = 0;
                   1473:             foreach my $id (@{$by_hostname{$hostname}}) {
                   1474:                 if (&host_domain($id) eq $dom) {
                   1475:                     $uniqservers{$id} = $hostname;
                   1476:                     $match = 1;
                   1477:                 }
                   1478:             }
                   1479:             unless ($match) {
                   1480:                 $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
                   1481:             }
                   1482:         } else {
                   1483:             $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
                   1484:         }
                   1485:     }
                   1486:     return %uniqservers;
                   1487: }
                   1488: 
1.1       albertel 1489: # ---------------------- Find the homebase for a user from domain's lib servers
1.11      www      1490: 
1.599     albertel 1491: my %homecache;
1.1       albertel 1492: sub homeserver {
1.230     stredwic 1493:     my ($uname,$udom,$ignoreBadCache)=@_;
1.1       albertel 1494:     my $index="$uname:$udom";
1.426     albertel 1495: 
1.599     albertel 1496:     if (exists($homecache{$index})) { return $homecache{$index}; }
1.841     albertel 1497: 
                   1498:     my %servers = &get_servers($udom,'library');
                   1499:     foreach my $tryserver (keys(%servers)) {
1.230     stredwic 1500:         next if ($ignoreBadCache ne 'true' && 
1.231     stredwic 1501: 		 exists($badServerCache{$tryserver}));
1.841     albertel 1502: 
                   1503: 	my $answer=reply("home:$udom:$uname",$tryserver);
                   1504: 	if ($answer eq 'found') {
                   1505: 	    delete($badServerCache{$tryserver}); 
                   1506: 	    return $homecache{$index}=$tryserver;
                   1507: 	} elsif ($answer eq 'no_host') {
                   1508: 	    $badServerCache{$tryserver}=1;
                   1509: 	}
1.1       albertel 1510:     }    
                   1511:     return 'no_host';
1.70      www      1512: }
                   1513: 
                   1514: # ------------------------------------- Find the usernames behind a list of IDs
                   1515: 
                   1516: sub idget {
                   1517:     my ($udom,@ids)=@_;
                   1518:     my %returnhash=();
                   1519:     
1.841     albertel 1520:     my %servers = &get_servers($udom,'library');
                   1521:     foreach my $tryserver (keys(%servers)) {
                   1522: 	my $idlist=join('&',@ids);
                   1523: 	$idlist=~tr/A-Z/a-z/; 
                   1524: 	my $reply=&reply("idget:$udom:".$idlist,$tryserver);
                   1525: 	my @answer=();
                   1526: 	if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
                   1527: 	    @answer=split(/\&/,$reply);
                   1528: 	}                    ;
                   1529: 	my $i;
                   1530: 	for ($i=0;$i<=$#ids;$i++) {
                   1531: 	    if ($answer[$i]) {
                   1532: 		$returnhash{$ids[$i]}=$answer[$i];
                   1533: 	    } 
                   1534: 	}
                   1535:     } 
1.70      www      1536:     return %returnhash;
                   1537: }
                   1538: 
                   1539: # ------------------------------------- Find the IDs behind a list of usernames
                   1540: 
                   1541: sub idrget {
                   1542:     my ($udom,@unames)=@_;
                   1543:     my %returnhash=();
1.800     albertel 1544:     foreach my $uname (@unames) {
                   1545:         $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191     harris41 1546:     }
1.70      www      1547:     return %returnhash;
                   1548: }
                   1549: 
                   1550: # ------------------------------- Store away a list of names and associated IDs
                   1551: 
                   1552: sub idput {
                   1553:     my ($udom,%ids)=@_;
                   1554:     my %servers=();
1.800     albertel 1555:     foreach my $uname (keys(%ids)) {
                   1556: 	&cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
                   1557:         my $uhom=&homeserver($uname,$udom);
1.70      www      1558:         if ($uhom ne 'no_host') {
1.800     albertel 1559:             my $id=&escape($ids{$uname});
1.70      www      1560:             $id=~tr/A-Z/a-z/;
1.800     albertel 1561:             my $esc_unam=&escape($uname);
1.70      www      1562: 	    if ($servers{$uhom}) {
1.800     albertel 1563: 		$servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70      www      1564:             } else {
1.800     albertel 1565:                 $servers{$uhom}=$id.'='.$esc_unam;
1.70      www      1566:             }
                   1567:         }
1.191     harris41 1568:     }
1.800     albertel 1569:     foreach my $server (keys(%servers)) {
                   1570:         &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191     harris41 1571:     }
1.344     www      1572: }
                   1573: 
1.1023    raeburn  1574: # ------------------------------dump from db file owned by domainconfig user
1.1012    raeburn  1575: sub dump_dom {
1.1165    droeschl 1576:     my ($namespace, $udom, $regexp) = @_;
                   1577: 
                   1578:     $udom ||= $env{'user.domain'};
                   1579: 
                   1580:     return () unless $udom;
                   1581: 
                   1582:     return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012    raeburn  1583: }
                   1584: 
1.1023    raeburn  1585: # ------------------------------------------ get items from domain db files   
1.806     raeburn  1586: 
                   1587: sub get_dom {
1.860     raeburn  1588:     my ($namespace,$storearr,$udom,$uhome)=@_;
1.806     raeburn  1589:     my $items='';
                   1590:     foreach my $item (@$storearr) {
                   1591:         $items.=&escape($item).'&';
                   1592:     }
                   1593:     $items=~s/\&$//;
1.860     raeburn  1594:     if (!$udom) {
                   1595:         $udom=$env{'user.domain'};
                   1596:         if (defined(&domain($udom,'primary'))) {
                   1597:             $uhome=&domain($udom,'primary');
                   1598:         } else {
1.874     albertel 1599:             undef($uhome);
1.860     raeburn  1600:         }
                   1601:     } else {
                   1602:         if (!$uhome) {
                   1603:             if (defined(&domain($udom,'primary'))) {
                   1604:                 $uhome=&domain($udom,'primary');
                   1605:             }
                   1606:         }
                   1607:     }
                   1608:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806     raeburn  1609:         my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866     raeburn  1610:         my %returnhash;
1.875     albertel 1611:         if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866     raeburn  1612:             return %returnhash;
                   1613:         }
1.806     raeburn  1614:         my @pairs=split(/\&/,$rep);
                   1615:         if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   1616:             return @pairs;
                   1617:         }
                   1618:         my $i=0;
                   1619:         foreach my $item (@$storearr) {
                   1620:             $returnhash{$item}=&thaw_unescape($pairs[$i]);
                   1621:             $i++;
                   1622:         }
                   1623:         return %returnhash;
                   1624:     } else {
1.880     banghart 1625:         &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806     raeburn  1626:     }
                   1627: }
                   1628: 
                   1629: # -------------------------------------------- put items in domain db files 
                   1630: 
                   1631: sub put_dom {
1.860     raeburn  1632:     my ($namespace,$storehash,$udom,$uhome)=@_;
                   1633:     if (!$udom) {
                   1634:         $udom=$env{'user.domain'};
                   1635:         if (defined(&domain($udom,'primary'))) {
                   1636:             $uhome=&domain($udom,'primary');
                   1637:         } else {
1.874     albertel 1638:             undef($uhome);
1.860     raeburn  1639:         }
                   1640:     } else {
                   1641:         if (!$uhome) {
                   1642:             if (defined(&domain($udom,'primary'))) {
                   1643:                 $uhome=&domain($udom,'primary');
                   1644:             }
                   1645:         }
                   1646:     } 
                   1647:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806     raeburn  1648:         my $items='';
                   1649:         foreach my $item (keys(%$storehash)) {
                   1650:             $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
                   1651:         }
                   1652:         $items=~s/\&$//;
                   1653:         return &reply("putdom:$udom:$namespace:$items",$uhome);
                   1654:     } else {
1.860     raeburn  1655:         &logthis("put_dom failed - no homeserver and/or domain");
1.806     raeburn  1656:     }
                   1657: }
                   1658: 
1.1023    raeburn  1659: # --------------------- newput for items in db file owned by domainconfig user
1.1012    raeburn  1660: sub newput_dom {
1.1023    raeburn  1661:     my ($namespace,$storehash,$udom) = @_;
1.1012    raeburn  1662:     my $result;
                   1663:     if (!$udom) {
                   1664:         $udom=$env{'user.domain'};
                   1665:     }
1.1023    raeburn  1666:     if ($udom) {
                   1667:         my $uname = &get_domainconfiguser($udom);
                   1668:         $result = &newput($namespace,$storehash,$udom,$uname);
1.1012    raeburn  1669:     }
                   1670:     return $result;
                   1671: }
                   1672: 
1.1023    raeburn  1673: # --------------------- delete for items in db file owned by domainconfig user
1.1012    raeburn  1674: sub del_dom {
1.1023    raeburn  1675:     my ($namespace,$storearr,$udom)=@_;
1.1012    raeburn  1676:     if (ref($storearr) eq 'ARRAY') {
                   1677:         if (!$udom) {
                   1678:             $udom=$env{'user.domain'};
                   1679:         }
1.1023    raeburn  1680:         if ($udom) {
                   1681:             my $uname = &get_domainconfiguser($udom); 
                   1682:             return &del($namespace,$storearr,$udom,$uname);
1.1012    raeburn  1683:         }
                   1684:     }
                   1685: }
                   1686: 
1.1023    raeburn  1687: # ----------------------------------construct domainconfig user for a domain 
                   1688: sub get_domainconfiguser {
                   1689:     my ($udom) = @_;
                   1690:     return $udom.'-domainconfig';
                   1691: }
                   1692: 
1.837     raeburn  1693: sub retrieve_inst_usertypes {
                   1694:     my ($udom) = @_;
                   1695:     my (%returnhash,@order);
1.989     raeburn  1696:     my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
                   1697:     if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 
                   1698:         (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
                   1699:         %returnhash = %{$domdefs{'inststatustypes'}};
                   1700:         @order = @{$domdefs{'inststatusorder'}};
                   1701:     } else {
                   1702:         if (defined(&domain($udom,'primary'))) {
                   1703:             my $uhome=&domain($udom,'primary');
                   1704:             my $rep=&reply("inst_usertypes:$udom",$uhome);
                   1705:             if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
                   1706:                 &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
                   1707:                 return (\%returnhash,\@order);
                   1708:             }
                   1709:             my ($hashitems,$orderitems) = split(/:/,$rep); 
                   1710:             my @pairs=split(/\&/,$hashitems);
                   1711:             foreach my $item (@pairs) {
                   1712:                 my ($key,$value)=split(/=/,$item,2);
                   1713:                 $key = &unescape($key);
                   1714:                 next if ($key =~ /^error: 2 /);
                   1715:                 $returnhash{$key}=&thaw_unescape($value);
                   1716:             }
                   1717:             my @esc_order = split(/\&/,$orderitems);
                   1718:             foreach my $item (@esc_order) {
                   1719:                 push(@order,&unescape($item));
                   1720:             }
                   1721:         } else {
                   1722:             &logthis("get_dom failed - no primary domain server for $udom");
1.837     raeburn  1723:         }
                   1724:     }
                   1725:     return (\%returnhash,\@order);
                   1726: }
                   1727: 
1.868     raeburn  1728: sub is_domainimage {
                   1729:     my ($url) = @_;
                   1730:     if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
                   1731:         if (&domain($1) ne '') {
                   1732:             return '1';
                   1733:         }
                   1734:     }
                   1735:     return;
                   1736: }
                   1737: 
1.899     raeburn  1738: sub inst_directory_query {
                   1739:     my ($srch) = @_;
                   1740:     my $udom = $srch->{'srchdomain'};
                   1741:     my %results;
                   1742:     my $homeserver = &domain($udom,'primary');
1.909     raeburn  1743:     my $outcome;
1.899     raeburn  1744:     if ($homeserver ne '') {
1.904     albertel 1745: 	my $queryid=&reply("querysend:instdirsearch:".
                   1746: 			   &escape($srch->{'srchby'}).':'.
                   1747: 			   &escape($srch->{'srchterm'}).':'.
                   1748: 			   &escape($srch->{'srchtype'}),$homeserver);
                   1749: 	my $host=&hostname($homeserver);
                   1750: 	if ($queryid !~/^\Q$host\E\_/) {
                   1751: 	    &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
                   1752: 	    return;
                   1753: 	}
                   1754: 	my $response = &get_query_reply($queryid);
                   1755: 	my $maxtries = 5;
                   1756: 	my $tries = 1;
                   1757: 	while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   1758: 	    $response = &get_query_reply($queryid);
                   1759: 	    $tries ++;
                   1760: 	}
                   1761: 
                   1762:         if (!&error($response) && $response ne 'refused') {
1.909     raeburn  1763:             if ($response eq 'unavailable') {
                   1764:                 $outcome = $response;
                   1765:             } else {
                   1766:                 $outcome = 'ok';
                   1767:                 my @matches = split(/\n/,$response);
                   1768:                 foreach my $match (@matches) {
                   1769:                     my ($key,$value) = split(/=/,$match);
                   1770:                     $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
                   1771:                 }
1.899     raeburn  1772:             }
                   1773:         }
                   1774:     }
1.909     raeburn  1775:     return ($outcome,%results);
1.899     raeburn  1776: }
                   1777: 
                   1778: sub usersearch {
                   1779:     my ($srch) = @_;
                   1780:     my $dom = $srch->{'srchdomain'};
                   1781:     my %results;
                   1782:     my %libserv = &all_library();
                   1783:     my $query = 'usersearch';
                   1784:     foreach my $tryserver (keys(%libserv)) {
                   1785:         if (&host_domain($tryserver) eq $dom) {
                   1786:             my $host=&hostname($tryserver);
                   1787:             my $queryid=
1.911     raeburn  1788:                 &reply("querysend:".&escape($query).':'.
                   1789:                        &escape($srch->{'srchby'}).':'.
1.899     raeburn  1790:                        &escape($srch->{'srchtype'}).':'.
                   1791:                        &escape($srch->{'srchterm'}),$tryserver);
                   1792:             if ($queryid !~/^\Q$host\E\_/) {
                   1793:                 &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902     raeburn  1794:                 next;
1.899     raeburn  1795:             }
                   1796:             my $reply = &get_query_reply($queryid);
                   1797:             my $maxtries = 1;
                   1798:             my $tries = 1;
                   1799:             while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   1800:                 $reply = &get_query_reply($queryid);
                   1801:                 $tries ++;
                   1802:             }
                   1803:             if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   1804:                 &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') -  maxtries: '.$maxtries.' tries: '.$tries);
                   1805:             } else {
1.911     raeburn  1806:                 my @matches;
                   1807:                 if ($reply =~ /\n/) {
                   1808:                     @matches = split(/\n/,$reply);
                   1809:                 } else {
                   1810:                     @matches = split(/\&/,$reply);
                   1811:                 }
1.899     raeburn  1812:                 foreach my $match (@matches) {
                   1813:                     my ($uname,$udom,%userhash);
1.911     raeburn  1814:                     foreach my $entry (split(/:/,$match)) {
                   1815:                         my ($key,$value) =
                   1816:                             map {&unescape($_);} split(/=/,$entry);
1.899     raeburn  1817:                         $userhash{$key} = $value;
                   1818:                         if ($key eq 'username') {
                   1819:                             $uname = $value;
                   1820:                         } elsif ($key eq 'domain') {
                   1821:                             $udom = $value;
1.911     raeburn  1822:                         }
1.899     raeburn  1823:                     }
                   1824:                     $results{$uname.':'.$udom} = \%userhash;
                   1825:                 }
                   1826:             }
                   1827:         }
                   1828:     }
                   1829:     return %results;
                   1830: }
                   1831: 
1.912     raeburn  1832: sub get_instuser {
                   1833:     my ($udom,$uname,$id) = @_;
                   1834:     my $homeserver = &domain($udom,'primary');
                   1835:     my ($outcome,%results);
                   1836:     if ($homeserver ne '') {
                   1837:         my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
                   1838:                            &escape($id).':'.&escape($udom),$homeserver);
                   1839:         my $host=&hostname($homeserver);
                   1840:         if ($queryid !~/^\Q$host\E\_/) {
                   1841:             &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
                   1842:             return;
                   1843:         }
                   1844:         my $response = &get_query_reply($queryid);
                   1845:         my $maxtries = 5;
                   1846:         my $tries = 1;
                   1847:         while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   1848:             $response = &get_query_reply($queryid);
                   1849:             $tries ++;
                   1850:         }
                   1851:         if (!&error($response) && $response ne 'refused') {
                   1852:             if ($response eq 'unavailable') {
                   1853:                 $outcome = $response;
                   1854:             } else {
                   1855:                 $outcome = 'ok';
                   1856:                 my @matches = split(/\n/,$response);
                   1857:                 foreach my $match (@matches) {
                   1858:                     my ($key,$value) = split(/=/,$match);
                   1859:                     $results{&unescape($key)} = &thaw_unescape($value);
                   1860:                 }
                   1861:             }
                   1862:         }
                   1863:     }
                   1864:     my %userinfo;
                   1865:     if (ref($results{$uname}) eq 'HASH') {
                   1866:         %userinfo = %{$results{$uname}};
                   1867:     } 
                   1868:     return ($outcome,%userinfo);
                   1869: }
                   1870: 
                   1871: sub inst_rulecheck {
1.923     raeburn  1872:     my ($udom,$uname,$id,$item,$rules) = @_;
1.912     raeburn  1873:     my %returnhash;
                   1874:     if ($udom ne '') {
                   1875:         if (ref($rules) eq 'ARRAY') {
                   1876:             @{$rules} = map {&escape($_);} (@{$rules});
                   1877:             my $rulestr = join(':',@{$rules});
                   1878:             my $homeserver=&domain($udom,'primary');
                   1879:             if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  1880:                 my $response;
                   1881:                 if ($item eq 'username') {                
                   1882:                     $response=&unescape(&reply('instrulecheck:'.&escape($udom).
                   1883:                                               ':'.&escape($uname).':'.$rulestr,
1.912     raeburn  1884:                                               $homeserver));
1.923     raeburn  1885:                 } elsif ($item eq 'id') {
                   1886:                     $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
                   1887:                                               ':'.&escape($id).':'.$rulestr,
                   1888:                                               $homeserver));
1.945     raeburn  1889:                 } elsif ($item eq 'selfcreate') {
                   1890:                     $response=&unescape(&reply('instselfcreatecheck:'.
1.943     raeburn  1891:                                                &escape($udom).':'.&escape($uname).
                   1892:                                               ':'.$rulestr,$homeserver));
1.923     raeburn  1893:                 }
1.912     raeburn  1894:                 if ($response ne 'refused') {
                   1895:                     my @pairs=split(/\&/,$response);
                   1896:                     foreach my $item (@pairs) {
                   1897:                         my ($key,$value)=split(/=/,$item,2);
                   1898:                         $key = &unescape($key);
                   1899:                         next if ($key =~ /^error: 2 /);
                   1900:                         $returnhash{$key}=&thaw_unescape($value);
                   1901:                     }
                   1902:                 }
                   1903:             }
                   1904:         }
                   1905:     }
                   1906:     return %returnhash;
                   1907: }
                   1908: 
                   1909: sub inst_userrules {
1.923     raeburn  1910:     my ($udom,$check) = @_;
1.912     raeburn  1911:     my (%ruleshash,@ruleorder);
                   1912:     if ($udom ne '') {
                   1913:         my $homeserver=&domain($udom,'primary');
                   1914:         if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  1915:             my $response;
                   1916:             if ($check eq 'id') {
                   1917:                 $response=&reply('instidrules:'.&escape($udom),
1.912     raeburn  1918:                                  $homeserver);
1.943     raeburn  1919:             } elsif ($check eq 'email') {
                   1920:                 $response=&reply('instemailrules:'.&escape($udom),
                   1921:                                  $homeserver);
1.923     raeburn  1922:             } else {
                   1923:                 $response=&reply('instuserrules:'.&escape($udom),
                   1924:                                  $homeserver);
                   1925:             }
1.912     raeburn  1926:             if (($response ne 'refused') && ($response ne 'error') && 
1.923     raeburn  1927:                 ($response ne 'unknown_cmd') && 
1.912     raeburn  1928:                 ($response ne 'no_such_host')) {
                   1929:                 my ($hashitems,$orderitems) = split(/:/,$response);
                   1930:                 my @pairs=split(/\&/,$hashitems);
                   1931:                 foreach my $item (@pairs) {
                   1932:                     my ($key,$value)=split(/=/,$item,2);
                   1933:                     $key = &unescape($key);
                   1934:                     next if ($key =~ /^error: 2 /);
                   1935:                     $ruleshash{$key}=&thaw_unescape($value);
                   1936:                 }
                   1937:                 my @esc_order = split(/\&/,$orderitems);
                   1938:                 foreach my $item (@esc_order) {
                   1939:                     push(@ruleorder,&unescape($item));
                   1940:                 }
                   1941:             }
                   1942:         }
                   1943:     }
                   1944:     return (\%ruleshash,\@ruleorder);
                   1945: }
                   1946: 
1.976     raeburn  1947: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943     raeburn  1948: 
                   1949: sub get_domain_defaults {
                   1950:     my ($domain) = @_;
                   1951:     my $cachetime = 60*60*24;
                   1952:     my ($result,$cached)=&is_cached_new('domdefaults',$domain);
                   1953:     if (defined($cached)) {
                   1954:         if (ref($result) eq 'HASH') {
                   1955:             return %{$result};
                   1956:         }
                   1957:     }
                   1958:     my %domdefaults;
                   1959:     my %domconfig =
1.989     raeburn  1960:          &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047    raeburn  1961:                                   'requestcourses','inststatus',
1.1183    raeburn  1962:                                   'coursedefaults','usersessions',
                   1963:                                   'requestauthor'],$domain);
1.943     raeburn  1964:     if (ref($domconfig{'defaults'}) eq 'HASH') {
                   1965:         $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 
                   1966:         $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
                   1967:         $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982     raeburn  1968:         $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985     raeburn  1969:         $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147    raeburn  1970:         $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.943     raeburn  1971:     } else {
                   1972:         $domdefaults{'lang_def'} = &domain($domain,'lang_def');
                   1973:         $domdefaults{'auth_def'} = &domain($domain,'auth_def');
                   1974:         $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
                   1975:     }
1.976     raeburn  1976:     if (ref($domconfig{'quotas'}) eq 'HASH') {
                   1977:         if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
                   1978:             $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
                   1979:         } else {
                   1980:             $domdefaults{'defaultquota'} = $domconfig{'quotas'};
                   1981:         } 
1.1177    raeburn  1982:         my @usertools = ('aboutme','blog','webdav','portfolio');
1.976     raeburn  1983:         foreach my $item (@usertools) {
                   1984:             if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
                   1985:                 $domdefaults{$item} = $domconfig{'quotas'}{$item};
                   1986:             }
                   1987:         }
                   1988:     }
1.985     raeburn  1989:     if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006    raeburn  1990:         foreach my $item ('official','unofficial','community') {
1.985     raeburn  1991:             $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
                   1992:         }
                   1993:     }
1.1183    raeburn  1994:     if (ref($domconfig{'requestauthor'}) eq 'HASH') {
                   1995:         $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
                   1996:     }
1.989     raeburn  1997:     if (ref($domconfig{'inststatus'}) eq 'HASH') {
                   1998:         foreach my $item ('inststatustypes','inststatusorder') {
                   1999:             $domdefaults{$item} = $domconfig{'inststatus'}{$item};
                   2000:         }
                   2001:     }
1.1047    raeburn  2002:     if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
                   2003:         foreach my $item ('canuse_pdfforms') {
                   2004:             $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
                   2005:         }
                   2006:     }
1.1073    raeburn  2007:     if (ref($domconfig{'usersessions'}) eq 'HASH') {
                   2008:         if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
                   2009:             $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
                   2010:         }
                   2011:         if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
                   2012:             $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
                   2013:         }
                   2014:     }
1.943     raeburn  2015:     &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
                   2016:                                   $cachetime);
                   2017:     return %domdefaults;
                   2018: }
                   2019: 
1.344     www      2020: # --------------------------------------------------- Assign a key to a student
                   2021: 
                   2022: sub assign_access_key {
1.364     www      2023: #
                   2024: # a valid key looks like uname:udom#comments
                   2025: # comments are being appended
                   2026: #
1.498     www      2027:     my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
                   2028:     $kdom=
1.620     albertel 2029:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498     www      2030:     $knum=
1.620     albertel 2031:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344     www      2032:     $cdom=
1.620     albertel 2033:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2034:     $cnum=
1.620     albertel 2035:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   2036:     $udom=$env{'user.name'} unless (defined($udom));
                   2037:     $uname=$env{'user.domain'} unless (defined($uname));
1.498     www      2038:     my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364     www      2039:     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479     albertel 2040:         ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 
1.364     www      2041:                                                   # assigned to this person
                   2042:                                                   # - this should not happen,
1.345     www      2043:                                                   # unless something went wrong
                   2044:                                                   # the first time around
                   2045: # ready to assign
1.364     www      2046:         $logentry=$1.'; '.$logentry;
1.496     www      2047:         if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498     www      2048:                                                  $kdom,$knum) eq 'ok') {
1.345     www      2049: # key now belongs to user
1.346     www      2050: 	    my $envkey='key.'.$cdom.'_'.$cnum;
1.345     www      2051:             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949     raeburn  2052:                 &appenv({'environment.'.$envkey => $ckey});
1.345     www      2053:                 return 'ok';
                   2054:             } else {
                   2055:                 return 
                   2056:   'error: Count not permanently assign key, will need to be re-entered later.';
                   2057: 	    }
                   2058:         } else {
                   2059:             return 'error: Could not assign key, try again later.';
                   2060:         }
1.364     www      2061:     } elsif (!$existing{$ckey}) {
1.345     www      2062: # the key does not exist
                   2063: 	return 'error: The key does not exist';
                   2064:     } else {
                   2065: # the key is somebody else's
                   2066: 	return 'error: The key is already in use';
                   2067:     }
1.344     www      2068: }
                   2069: 
1.364     www      2070: # ------------------------------------------ put an additional comment on a key
                   2071: 
                   2072: sub comment_access_key {
                   2073: #
                   2074: # a valid key looks like uname:udom#comments
                   2075: # comments are being appended
                   2076: #
                   2077:     my ($ckey,$cdom,$cnum,$logentry)=@_;
                   2078:     $cdom=
1.620     albertel 2079:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364     www      2080:     $cnum=
1.620     albertel 2081:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364     www      2082:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
                   2083:     if ($existing{$ckey}) {
                   2084:         $existing{$ckey}.='; '.$logentry;
                   2085: # ready to assign
1.367     www      2086:         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364     www      2087:                                                  $cdom,$cnum) eq 'ok') {
                   2088: 	    return 'ok';
                   2089:         } else {
                   2090: 	    return 'error: Count not store comment.';
                   2091:         }
                   2092:     } else {
                   2093: # the key does not exist
                   2094: 	return 'error: The key does not exist';
                   2095:     }
                   2096: }
                   2097: 
1.344     www      2098: # ------------------------------------------------------ Generate a set of keys
                   2099: 
                   2100: sub generate_access_keys {
1.364     www      2101:     my ($number,$cdom,$cnum,$logentry)=@_;
1.344     www      2102:     $cdom=
1.620     albertel 2103:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2104:     $cnum=
1.620     albertel 2105:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361     www      2106:     unless (&allowed('mky',$cdom)) { return 0; }
1.344     www      2107:     unless (($cdom) && ($cnum)) { return 0; }
                   2108:     if ($number>10000) { return 0; }
                   2109:     sleep(2); # make sure don't get same seed twice
                   2110:     srand(time()^($$+($$<<15))); # from "Programming Perl"
                   2111:     my $total=0;
                   2112:     for (my $i=1;$i<=$number;$i++) {
                   2113:        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
                   2114:                   sprintf("%lx",int(100000*rand)).'-'.
                   2115:                   sprintf("%lx",int(100000*rand));
                   2116:        $newkey=~s/1/g/g; # folks mix up 1 and l
                   2117:        $newkey=~s/0/h/g; # and also 0 and O
                   2118:        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
                   2119:        if ($existing{$newkey}) {
                   2120:            $i--;
                   2121:        } else {
1.364     www      2122: 	  if (&put('accesskeys',
                   2123:               { $newkey => '# generated '.localtime().
1.620     albertel 2124:                            ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364     www      2125:                            '; '.$logentry },
                   2126: 		   $cdom,$cnum) eq 'ok') {
1.344     www      2127:               $total++;
                   2128: 	  }
                   2129:        }
                   2130:     }
1.620     albertel 2131:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344     www      2132:          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
                   2133:     return $total;
                   2134: }
                   2135: 
                   2136: # ------------------------------------------------------- Validate an accesskey
                   2137: 
                   2138: sub validate_access_key {
                   2139:     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
                   2140:     $cdom=
1.620     albertel 2141:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2142:     $cnum=
1.620     albertel 2143:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   2144:     $udom=$env{'user.domain'} unless (defined($udom));
                   2145:     $uname=$env{'user.name'} unless (defined($uname));
1.345     www      2146:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479     albertel 2147:     return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70      www      2148: }
                   2149: 
                   2150: # ------------------------------------- Find the section of student in a course
1.652     albertel 2151: sub devalidate_getsection_cache {
                   2152:     my ($udom,$unam,$courseid)=@_;
                   2153:     my $hashid="$udom:$unam:$courseid";
                   2154:     &devalidate_cache_new('getsection',$hashid);
                   2155: }
1.298     matthew  2156: 
1.815     albertel 2157: sub courseid_to_courseurl {
                   2158:     my ($courseid) = @_;
                   2159:     #already url style courseid
                   2160:     return $courseid if ($courseid =~ m{^/});
                   2161: 
                   2162:     if (exists($env{'course.'.$courseid.'.num'})) {
                   2163: 	my $cnum = $env{'course.'.$courseid.'.num'};
                   2164: 	my $cdom = $env{'course.'.$courseid.'.domain'};
                   2165: 	return "/$cdom/$cnum";
                   2166:     }
                   2167: 
                   2168:     my %courseinfo=&Apache::lonnet::coursedescription($courseid);
                   2169:     if (exists($courseinfo{'num'})) {
                   2170: 	return "/$courseinfo{'domain'}/$courseinfo{'num'}";
                   2171:     }
                   2172: 
                   2173:     return undef;
                   2174: }
                   2175: 
1.298     matthew  2176: sub getsection {
                   2177:     my ($udom,$unam,$courseid)=@_;
1.599     albertel 2178:     my $cachetime=1800;
1.551     albertel 2179: 
                   2180:     my $hashid="$udom:$unam:$courseid";
1.599     albertel 2181:     my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551     albertel 2182:     if (defined($cached)) { return $result; }
                   2183: 
1.298     matthew  2184:     my %Pending; 
                   2185:     my %Expired;
                   2186:     #
                   2187:     # Each role can either have not started yet (pending), be active, 
                   2188:     #    or have expired.
                   2189:     #
                   2190:     # If there is an active role, we are done.
                   2191:     #
                   2192:     # If there is more than one role which has not started yet, 
                   2193:     #     choose the one which will start sooner
                   2194:     # If there is one role which has not started yet, return it.
                   2195:     #
                   2196:     # If there is more than one expired role, choose the one which ended last.
                   2197:     # If there is a role which has expired, return it.
                   2198:     #
1.815     albertel 2199:     $courseid = &courseid_to_courseurl($courseid);
1.1166    raeburn  2200:     my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817     raeburn  2201:     foreach my $key (keys(%roleshash)) {
1.479     albertel 2202:         next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298     matthew  2203:         my $section=$1;
                   2204:         if ($key eq $courseid.'_st') { $section=''; }
1.817     raeburn  2205:         my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298     matthew  2206:         my $now=time;
1.548     albertel 2207:         if (defined($end) && $end && ($now > $end)) {
1.298     matthew  2208:             $Expired{$end}=$section;
                   2209:             next;
                   2210:         }
1.548     albertel 2211:         if (defined($start) && $start && ($now < $start)) {
1.298     matthew  2212:             $Pending{$start}=$section;
                   2213:             next;
                   2214:         }
1.599     albertel 2215:         return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298     matthew  2216:     }
                   2217:     #
                   2218:     # Presumedly there will be few matching roles from the above
                   2219:     # loop and the sorting time will be negligible.
                   2220:     if (scalar(keys(%Pending))) {
                   2221:         my ($time) = sort {$a <=> $b} keys(%Pending);
1.599     albertel 2222:         return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298     matthew  2223:     } 
                   2224:     if (scalar(keys(%Expired))) {
                   2225:         my @sorted = sort {$a <=> $b} keys(%Expired);
                   2226:         my $time = pop(@sorted);
1.599     albertel 2227:         return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298     matthew  2228:     }
1.599     albertel 2229:     return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298     matthew  2230: }
1.70      www      2231: 
1.599     albertel 2232: sub save_cache {
                   2233:     &purge_remembered();
1.722     albertel 2234:     #&Apache::loncommon::validate_page();
1.620     albertel 2235:     undef(%env);
1.780     albertel 2236:     undef($env_loaded);
1.599     albertel 2237: }
1.452     albertel 2238: 
1.599     albertel 2239: my $to_remember=-1;
                   2240: my %remembered;
                   2241: my %accessed;
                   2242: my $kicks=0;
                   2243: my $hits=0;
1.849     albertel 2244: sub make_key {
                   2245:     my ($name,$id) = @_;
1.872     albertel 2246:     if (length($id) > 65 
                   2247: 	&& length(&escape($id)) > 200) {
                   2248: 	$id=length($id).':'.&Digest::MD5::md5_hex($id);
                   2249:     }
1.849     albertel 2250:     return &escape($name.':'.$id);
                   2251: }
                   2252: 
1.599     albertel 2253: sub devalidate_cache_new {
                   2254:     my ($name,$id,$debug) = @_;
                   2255:     if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849     albertel 2256:     $id=&make_key($name,$id);
1.599     albertel 2257:     $memcache->delete($id);
                   2258:     delete($remembered{$id});
                   2259:     delete($accessed{$id});
                   2260: }
                   2261: 
                   2262: sub is_cached_new {
                   2263:     my ($name,$id,$debug) = @_;
1.849     albertel 2264:     $id=&make_key($name,$id);
1.599     albertel 2265:     if (exists($remembered{$id})) {
1.1133    foxr     2266: 	if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
1.599     albertel 2267: 	$accessed{$id}=[&gettimeofday()];
                   2268: 	$hits++;
                   2269: 	return ($remembered{$id},1);
                   2270:     }
                   2271:     my $value = $memcache->get($id);
                   2272:     if (!(defined($value))) {
                   2273: 	if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417     albertel 2274: 	return (undef,undef);
1.416     albertel 2275:     }
1.599     albertel 2276:     if ($value eq '__undef__') {
                   2277: 	if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
                   2278: 	$value=undef;
                   2279:     }
                   2280:     &make_room($id,$value,$debug);
                   2281:     if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
                   2282:     return ($value,1);
                   2283: }
                   2284: 
                   2285: sub do_cache_new {
                   2286:     my ($name,$id,$value,$time,$debug) = @_;
1.849     albertel 2287:     $id=&make_key($name,$id);
1.599     albertel 2288:     my $setvalue=$value;
                   2289:     if (!defined($setvalue)) {
                   2290: 	$setvalue='__undef__';
                   2291:     }
1.623     albertel 2292:     if (!defined($time) ) {
                   2293: 	$time=600;
                   2294:     }
1.599     albertel 2295:     if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910     albertel 2296:     my $result = $memcache->set($id,$setvalue,$time);
                   2297:     if (! $result) {
1.872     albertel 2298: 	&logthis("caching of id -> $id  failed");
1.910     albertel 2299: 	$memcache->disconnect_all();
1.872     albertel 2300:     }
1.600     albertel 2301:     # need to make a copy of $value
1.919     albertel 2302:     &make_room($id,$value,$debug);
1.599     albertel 2303:     return $value;
                   2304: }
                   2305: 
                   2306: sub make_room {
                   2307:     my ($id,$value,$debug)=@_;
1.919     albertel 2308: 
                   2309:     $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
                   2310:                                     : $value;
1.599     albertel 2311:     if ($to_remember<0) { return; }
                   2312:     $accessed{$id}=[&gettimeofday()];
                   2313:     if (scalar(keys(%remembered)) <= $to_remember) { return; }
                   2314:     my $to_kick;
                   2315:     my $max_time=0;
                   2316:     foreach my $other (keys(%accessed)) {
                   2317: 	if (&tv_interval($accessed{$other}) > $max_time) {
                   2318: 	    $to_kick=$other;
                   2319: 	    $max_time=&tv_interval($accessed{$other});
                   2320: 	}
                   2321:     }
                   2322:     delete($remembered{$to_kick});
                   2323:     delete($accessed{$to_kick});
                   2324:     $kicks++;
                   2325:     if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541     albertel 2326:     return;
                   2327: }
                   2328: 
1.599     albertel 2329: sub purge_remembered {
1.604     albertel 2330:     #&logthis("Tossing ".scalar(keys(%remembered)));
                   2331:     #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599     albertel 2332:     undef(%remembered);
                   2333:     undef(%accessed);
1.428     albertel 2334: }
1.70      www      2335: # ------------------------------------- Read an entry from a user's environment
                   2336: 
                   2337: sub userenvironment {
                   2338:     my ($udom,$unam,@what)=@_;
1.976     raeburn  2339:     my $items;
                   2340:     foreach my $item (@what) {
                   2341:         $items.=&escape($item).'&';
                   2342:     }
                   2343:     $items=~s/\&$//;
1.70      www      2344:     my %returnhash=();
1.1009    raeburn  2345:     my $uhome = &homeserver($unam,$udom);
                   2346:     unless ($uhome eq 'no_host') {
                   2347:         my @answer=split(/\&/, 
                   2348:             &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048    raeburn  2349:         if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
                   2350:             return %returnhash;
                   2351:         }
1.1009    raeburn  2352:         my $i;
                   2353:         for ($i=0;$i<=$#what;$i++) {
                   2354: 	    $returnhash{$what[$i]}=&unescape($answer[$i]);
                   2355:         }
1.70      www      2356:     }
                   2357:     return %returnhash;
1.1       albertel 2358: }
                   2359: 
1.617     albertel 2360: # ---------------------------------------------------------- Get a studentphoto
                   2361: sub studentphoto {
                   2362:     my ($udom,$unam,$ext) = @_;
                   2363:     my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706     raeburn  2364:     if (defined($env{'request.course.id'})) {
1.708     raeburn  2365:         if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706     raeburn  2366:             if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
                   2367:                 return(&retrievestudentphoto($udom,$unam,$ext)); 
                   2368:             } else {
                   2369:                 my ($result,$perm_reqd)=
1.707     albertel 2370: 		    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  2371:                 if ($result eq 'ok') {
                   2372:                     if (!($perm_reqd eq 'yes')) {
                   2373:                         return(&retrievestudentphoto($udom,$unam,$ext));
                   2374:                     }
                   2375:                 }
                   2376:             }
                   2377:         }
                   2378:     } else {
                   2379:         my ($result,$perm_reqd) = 
1.707     albertel 2380: 	    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  2381:         if ($result eq 'ok') {
                   2382:             if (!($perm_reqd eq 'yes')) {
                   2383:                 return(&retrievestudentphoto($udom,$unam,$ext));
                   2384:             }
                   2385:         }
                   2386:     }
                   2387:     return '/adm/lonKaputt/lonlogo_broken.gif';
                   2388: }
                   2389: 
                   2390: sub retrievestudentphoto {
                   2391:     my ($udom,$unam,$ext,$type) = @_;
                   2392:     my $home=&Apache::lonnet::homeserver($unam,$udom);
                   2393:     my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
                   2394:     if ($ret eq 'ok') {
                   2395:         my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
                   2396:         if ($type eq 'thumbnail') {
                   2397:             $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 
                   2398:         }
                   2399:         my $tokenurl=&Apache::lonnet::tokenwrapper($url);
                   2400:         return $tokenurl;
                   2401:     } else {
                   2402:         if ($type eq 'thumbnail') {
                   2403:             return '/adm/lonKaputt/genericstudent_tn.gif';
                   2404:         } else { 
                   2405:             return '/adm/lonKaputt/lonlogo_broken.gif';
                   2406:         }
1.617     albertel 2407:     }
                   2408: }
                   2409: 
1.263     www      2410: # -------------------------------------------------------------------- New chat
                   2411: 
                   2412: sub chatsend {
1.724     raeburn  2413:     my ($newentry,$anon,$group)=@_;
1.620     albertel 2414:     my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
                   2415:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   2416:     my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263     www      2417:     &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620     albertel 2418: 	   &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724     raeburn  2419: 		   &escape($newentry)).':'.$group,$chome);
1.292     www      2420: }
                   2421: 
                   2422: # ------------------------------------------ Find current version of a resource
                   2423: 
                   2424: sub getversion {
                   2425:     my $fname=&clutter(shift);
1.1189    raeburn  2426:     unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292     www      2427:     return &currentversion(&filelocation('',$fname));
                   2428: }
                   2429: 
                   2430: sub currentversion {
                   2431:     my $fname=shift;
                   2432:     my $author=$fname;
                   2433:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   2434:     my ($udom,$uname)=split(/\//,$author);
1.1112    www      2435:     my $home=&homeserver($uname,$udom);
1.292     www      2436:     if ($home eq 'no_host') { 
                   2437:         return -1; 
                   2438:     }
1.1112    www      2439:     my $answer=&reply("currentversion:$fname",$home);
1.292     www      2440:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   2441: 	return -1;
                   2442:     }
1.1112    www      2443:     return $answer;
1.263     www      2444: }
                   2445: 
1.1111    www      2446: #
                   2447: # Return special version number of resource if set by override, empty otherwise
                   2448: #
                   2449: sub usedversion {
                   2450:     my $fname=shift;
                   2451:     unless ($fname) { $fname=$env{'request.uri'}; }
                   2452:     my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
                   2453:     if ($urlversion) { return $urlversion; }
                   2454:     return '';
                   2455: }
                   2456: 
1.1       albertel 2457: # ----------------------------- Subscribe to a resource, return URL if possible
1.11      www      2458: 
1.1       albertel 2459: sub subscribe {
                   2460:     my $fname=shift;
1.761     raeburn  2461:     if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532     albertel 2462:     $fname=~s/[\n\r]//g;
1.1       albertel 2463:     my $author=$fname;
                   2464:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   2465:     my ($udom,$uname)=split(/\//,$author);
                   2466:     my $home=homeserver($uname,$udom);
1.335     albertel 2467:     if ($home eq 'no_host') {
                   2468:         return 'not_found';
1.1       albertel 2469:     }
                   2470:     my $answer=reply("sub:$fname",$home);
1.64      www      2471:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   2472: 	$answer.=' by '.$home;
                   2473:     }
1.1       albertel 2474:     return $answer;
                   2475: }
                   2476:     
1.8       www      2477: # -------------------------------------------------------------- Replicate file
                   2478: 
                   2479: sub repcopy {
                   2480:     my $filename=shift;
1.23      www      2481:     $filename=~s/\/+/\//g;
1.1142    raeburn  2482:     my $londocroot = $perlvar{'lonDocRoot'};
                   2483:     if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164    raeburn  2484:     if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142    raeburn  2485:     if ($filename=~m{^\Q$londocroot/userfiles/\E} or
                   2486: 	$filename=~m{^/*(uploaded|editupload)/}) {
1.538     albertel 2487: 	return &repcopy_userfile($filename);
                   2488:     }
1.532     albertel 2489:     $filename=~s/[\n\r]//g;
1.8       www      2490:     my $transname="$filename.in.transfer";
1.828     www      2491: # FIXME: this should flock
1.607     raeburn  2492:     if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8       www      2493:     my $remoteurl=subscribe($filename);
1.64      www      2494:     if ($remoteurl =~ /^con_lost by/) {
                   2495: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  2496:            return 'unavailable';
1.8       www      2497:     } elsif ($remoteurl eq 'not_found') {
1.441     albertel 2498: 	   #&logthis("Subscribe returned not_found: $filename");
1.607     raeburn  2499: 	   return 'not_found';
1.64      www      2500:     } elsif ($remoteurl =~ /^rejected by/) {
                   2501: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  2502:            return 'forbidden';
1.20      www      2503:     } elsif ($remoteurl eq 'directory') {
1.607     raeburn  2504:            return 'ok';
1.8       www      2505:     } else {
1.290     www      2506:         my $author=$filename;
                   2507:         $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   2508:         my ($udom,$uname)=split(/\//,$author);
                   2509:         my $home=homeserver($uname,$udom);
                   2510:         unless ($home eq $perlvar{'lonHostID'}) {
1.8       www      2511:            my @parts=split(/\//,$filename);
                   2512:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142    raeburn  2513:            if ($path ne "$londocroot/res") {
1.8       www      2514:                &logthis("Malconfiguration for replication: $filename");
1.607     raeburn  2515: 	       return 'bad_request';
1.8       www      2516:            }
                   2517:            my $count;
                   2518:            for ($count=5;$count<$#parts;$count++) {
                   2519:                $path.="/$parts[$count]";
                   2520:                if ((-e $path)!=1) {
                   2521: 		   mkdir($path,0777);
                   2522:                }
                   2523:            }
                   2524:            my $ua=new LWP::UserAgent;
                   2525:            my $request=new HTTP::Request('GET',"$remoteurl");
                   2526:            my $response=$ua->request($request,$transname);
                   2527:            if ($response->is_error()) {
                   2528: 	       unlink($transname);
                   2529:                my $message=$response->status_line;
1.672     albertel 2530:                &logthis("<font color=\"blue\">WARNING:"
1.12      www      2531:                        ." LWP get: $message: $filename</font>");
1.607     raeburn  2532:                return 'unavailable';
1.8       www      2533:            } else {
1.16      www      2534: 	       if ($remoteurl!~/\.meta$/) {
                   2535:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
                   2536:                   my $mresponse=$ua->request($mrequest,$filename.'.meta');
                   2537:                   if ($mresponse->is_error()) {
                   2538: 		      unlink($filename.'.meta');
                   2539:                       &logthis(
1.672     albertel 2540:                      "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16      www      2541:                   }
                   2542: 	       }
1.8       www      2543:                rename($transname,$filename);
1.607     raeburn  2544:                return 'ok';
1.8       www      2545:            }
1.290     www      2546:        }
1.8       www      2547:     }
1.330     www      2548: }
                   2549: 
                   2550: # ------------------------------------------------ Get server side include body
                   2551: sub ssi_body {
1.381     albertel 2552:     my ($filelink,%form)=@_;
1.606     matthew  2553:     if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
                   2554:         $form{'LONCAPA_INTERNAL_no_discussion'}='true';
                   2555:     }
1.953     www      2556:     my $output='';
                   2557:     my $response;
1.980     raeburn  2558:     if ($filelink=~/^https?\:/) {
1.954     raeburn  2559:        ($output,$response)=&externalssi($filelink);
1.953     www      2560:     } else {
1.1004    droeschl 2561:        $filelink .= $filelink=~/\?/ ? '&' : '?';
                   2562:        $filelink .= 'inhibitmenu=yes';
1.953     www      2563:        ($output,$response)=&ssi($filelink,%form);
                   2564:     }
1.778     albertel 2565:     $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451     albertel 2566:     $output=~s/^.*?\<body[^\>]*\>//si;
1.930     albertel 2567:     $output=~s/\<\/body\s*\>.*?$//si;
1.953     www      2568:     if (wantarray) {
                   2569:         return ($output, $response);
                   2570:     } else {
                   2571:         return $output;
                   2572:     }
1.8       www      2573: }
                   2574: 
1.15      www      2575: # --------------------------------------------------------- Server Side Include
                   2576: 
1.782     albertel 2577: sub absolute_url {
                   2578:     my ($host_name) = @_;
                   2579:     my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
                   2580:     if ($host_name eq '') {
                   2581: 	$host_name = $ENV{'SERVER_NAME'};
                   2582:     }
                   2583:     return $protocol.$host_name;
                   2584: }
                   2585: 
1.942     foxr     2586: #
                   2587: #   Server side include.
                   2588: # Parameters:
                   2589: #  fn     Possibly encrypted resource name/id.
                   2590: #  form   Hash that describes how the rendering should be done
                   2591: #         and other things.
1.944     foxr     2592: # Returns:
1.950     raeburn  2593: #   Scalar context: The content of the response.
                   2594: #   Array context:  2 element list of the content and the full response object.
1.942     foxr     2595: #     
1.15      www      2596: sub ssi {
                   2597: 
1.944     foxr     2598:     my ($fn,%form)=@_;
1.15      www      2599:     my $ua=new LWP::UserAgent;
1.23      www      2600:     my $request;
1.711     albertel 2601: 
                   2602:     $form{'no_update_last_known'}=1;
1.895     albertel 2603:     &Apache::lonenc::check_encrypt(\$fn);
1.23      www      2604:     if (%form) {
1.782     albertel 2605:       $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000    raeburn  2606:       $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23      www      2607:     } else {
1.782     albertel 2608:       $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23      www      2609:     }
                   2610: 
1.15      www      2611:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1173    foxr     2612:     my $response= $ua->request($request);
1.1182    foxr     2613:     my $content = $response->content;
                   2614: 
                   2615: 
1.944     foxr     2616:     if (wantarray) {
1.1173    foxr     2617: 	return ($content, $response);
1.944     foxr     2618:     } else {
1.1173    foxr     2619: 	return $content;
1.942     foxr     2620:     }
1.324     www      2621: }
                   2622: 
                   2623: sub externalssi {
                   2624:     my ($url)=@_;
                   2625:     my $ua=new LWP::UserAgent;
                   2626:     my $request=new HTTP::Request('GET',$url);
                   2627:     my $response=$ua->request($request);
1.954     raeburn  2628:     if (wantarray) {
                   2629:         return ($response->content, $response);
                   2630:     } else {
                   2631:         return $response->content;
                   2632:     }
1.15      www      2633: }
1.254     www      2634: 
1.492     albertel 2635: # -------------------------------- Allow a /uploaded/ URI to be vouched for
                   2636: 
                   2637: sub allowuploaded {
                   2638:     my ($srcurl,$url)=@_;
                   2639:     $url=&clutter(&declutter($url));
                   2640:     my $dir=$url;
                   2641:     $dir=~s/\/[^\/]+$//;
                   2642:     my %httpref=();
                   2643:     my $httpurl=&hreflocation('',$url);
                   2644:     $httpref{'httpref.'.$httpurl}=$srcurl;
1.949     raeburn  2645:     &Apache::lonnet::appenv(\%httpref);
1.254     www      2646: }
1.477     raeburn  2647: 
1.1193    raeburn  2648: #
                   2649: # Determine if the current user should be able to edit a particular resource,
                   2650: # when viewing in course context.
                   2651: # (a) When viewing resource used to determine if "Edit" item is included in 
                   2652: #     Functions.
                   2653: # (b) When displaying folder contents in course editor, used to determine if
                   2654: #     "Edit" link will be displayed alongside resource.
                   2655: #
1.1196    raeburn  2656: #  input: six args -- filename (decluttered), course number, course domain,
                   2657: #                   url, symb (if registered) and group (if this is a group
                   2658: #                   item -- e.g., bulletin board, group page etc.).
                   2659: #  output: array of five scalars -- 
1.1193    raeburn  2660: #          $cfile -- url for file editing if editable on current server
                   2661: #          $home -- homeserver of resource (i.e., for author if published,
                   2662: #                                           or course if uploaded.).
                   2663: #          $switchserver --  1 if server switch will be needed.
1.1196    raeburn  2664: #          $forceedit -- 1 if icon/link should be to go to edit mode 
                   2665: #          $forceview -- 1 if icon/link should be to go to view mode
1.1193    raeburn  2666: #
                   2667: 
                   2668: sub can_edit_resource {
1.1194    raeburn  2669:     my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
                   2670:     my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
                   2671: #
                   2672: # For aboutme pages user can only edit his/her own.
                   2673: #
1.1199    raeburn  2674:     if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194    raeburn  2675:         my ($sdom,$sname) = ($1,$2);
                   2676:         if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
                   2677:             $home = $env{'user.home'};
                   2678:             $cfile = $resurl;
                   2679:             if ($env{'form.forceedit'}) {
                   2680:                 $forceview = 1;
                   2681:             } else {
                   2682:                 $forceedit = 1;
                   2683:             }
                   2684:             return ($cfile,$home,$switchserver,$forceedit,$forceview);
                   2685:         } else {
                   2686:             return;
                   2687:         }
                   2688:     }
                   2689: 
                   2690:     if ($env{'request.course.id'}) {
                   2691:         my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
                   2692:         if ($group ne '') {
                   2693: # if this is a group homepage or group bulletin board, check group privs
                   2694:             my $allowed = 0;
1.1197    raeburn  2695:             if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
                   2696:                 if ((&allowed('mdg',$env{'request.course.id'}.
1.1198    raeburn  2697:                               ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194    raeburn  2698:                         (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
                   2699:                     $allowed = 1;
                   2700:                 }
1.1197    raeburn  2701:             } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
                   2702:                 if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
                   2703:                         (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194    raeburn  2704:                     $allowed = 1;
                   2705:                 }
                   2706:             }
                   2707:             if ($allowed) {
                   2708:                 $home=&homeserver($cnum,$cdom);
                   2709:                 if ($env{'form.forceedit'}) {
                   2710:                     $forceview = 1;
                   2711:                 } else {
                   2712:                     $forceedit = 1;
                   2713:                 }
                   2714:                 $cfile = $resurl;
                   2715:             } else {
                   2716:                 return;
                   2717:             }
                   2718:         } else {
                   2719: #
                   2720: # No edit allowed where CC has switched to student role.
                   2721: #
                   2722:             unless ($crsedit) {
                   2723:                 return;
                   2724:             }
                   2725:         }
                   2726:     }
                   2727: 
1.1193    raeburn  2728:     if ($file ne '') {
                   2729:         if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194    raeburn  2730:             if (&is_course_upload($file,$cnum,$cdom)) {
                   2731:                 $uploaded = 1;
                   2732:                 $incourse = 1;
1.1193    raeburn  2733:                 if ($file =~/\.(htm|html|css|js|txt)$/) {
                   2734:                     $cfile = &hreflocation('',$file);
1.1201    raeburn  2735:                     if ($env{'form.forceedit'}) {
                   2736:                         $forceview = 1;
                   2737:                     } else {
                   2738:                         $forceedit = 1;
                   2739:                     }
1.1194    raeburn  2740:                 }
                   2741:             } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
                   2742:                 $incourse = 1;
                   2743:                 if ($env{'form.forceedit'}) {
                   2744:                     $forceview = 1;
                   2745:                 } else {
                   2746:                     $forceedit = 1;
                   2747:                 }
                   2748:                 $cfile = $resurl;
                   2749:             } elsif (($resurl ne '') && (&is_on_map($resurl))) { 
                   2750:                 if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
                   2751:                     $incourse = 1;
                   2752:                     if ($env{'form.forceedit'}) {
                   2753:                         $forceview = 1;
                   2754:                     } else {
                   2755:                         $forceedit = 1;
                   2756:                     }
                   2757:                     $cfile = $resurl;
1.1199    raeburn  2758:                 } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194    raeburn  2759:                     $incourse = 1;
                   2760:                     $cfile = $resurl.'/smpedit';
1.1199    raeburn  2761:                 } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194    raeburn  2762:                     $incourse = 1;
1.1199    raeburn  2763:                     if ($env{'form.forceedit'}) {
                   2764:                         $forceview = 1;
                   2765:                     } else {
                   2766:                         $forceedit = 1;
                   2767:                     }
                   2768:                     $cfile = $resurl;
1.1194    raeburn  2769:                 }
                   2770:             } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
                   2771:                 my $template = '/res/lib/templates/simpleproblem.problem';
                   2772:                 if (&is_on_map($template)) { 
                   2773:                     $incourse = 1;
                   2774:                     $forceview = 1;
                   2775:                     $cfile = $template;
1.1193    raeburn  2776:                 }
1.1199    raeburn  2777:             } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
                   2778:                     $incourse = 1;
                   2779:                     if ($env{'form.forceedit'}) {
                   2780:                         $forceview = 1;
                   2781:                     } else {
                   2782:                         $forceedit = 1;
                   2783:                     }
                   2784:                     $cfile = $resurl;
                   2785:             } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
                   2786:                 $incourse = 1;
                   2787:                 $forceview = 1;
                   2788:                 if ($symb) {
                   2789:                     my ($map,$id,$res)=&decode_symb($symb);
                   2790:                     $env{'request.symb'} = $symb;
                   2791:                     $cfile = &clutter($res);
                   2792:                 } else {
                   2793:                     $cfile = $env{'form.suppurl'};
                   2794:                     $cfile =~ s{^http://}{};
                   2795:                     $cfile = '/adm/wrapper/ext/'.$cfile;
                   2796:                 }
1.1193    raeburn  2797:             }
                   2798:         }
1.1194    raeburn  2799:         if ($uploaded || $incourse) {
                   2800:             $home=&homeserver($cnum,$cdom);
                   2801:         } else {
1.1193    raeburn  2802:             $file=~s{^(priv/$match_domain/$match_username)}{/$1};
                   2803:             $file=~s{^($match_domain/$match_username)}{/priv/$1};
                   2804:             # Check that the user has permission to edit this resource
                   2805:             my $setpriv = 1;
                   2806:             my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
                   2807:             if (defined($cfudom)) {
                   2808:                 $home=&homeserver($cfuname,$cfudom);
                   2809:                 $cfile=$file;
                   2810:             }
                   2811:         }
1.1194    raeburn  2812:         if (($cfile ne '') && (!$incourse || $uploaded) && 
                   2813:             (($home ne '') && ($home ne 'no_host'))) {
1.1193    raeburn  2814:             my @ids=&current_machine_ids();
                   2815:             unless (grep(/^\Q$home\E$/,@ids)) {
                   2816:                 $switchserver=1;
                   2817:             }
                   2818:         }
                   2819:     }
1.1194    raeburn  2820:     return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193    raeburn  2821: }
                   2822: 
                   2823: sub is_course_upload {
                   2824:     my ($file,$cnum,$cdom) = @_;
                   2825:     my $uploadpath = &LONCAPA::propath($cdom,$cnum);
                   2826:     $uploadpath =~ s{^\/}{};
1.1201    raeburn  2827:     if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
                   2828:         ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193    raeburn  2829:         return 1;
                   2830:     }
                   2831:     return;
                   2832: }
                   2833: 
1.1194    raeburn  2834: sub in_course {
1.1195    raeburn  2835:     my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
                   2836:     if ($hideprivileged) {
                   2837:         my $skipuser;
                   2838:         if (&privileged($uname,$udom)) {
                   2839:             $skipuser = 1;
                   2840:             my %coursehash = &coursedescription($cdom.'_'.$cnum);
                   2841:             if ($coursehash{'nothideprivileged'}) {
                   2842:                 foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   2843:                     my $user;
                   2844:                     if ($item =~ /:/) {
                   2845:                         $user = $item;
                   2846:                     } else {
                   2847:                         $user = join(':',split(/[\@]/,$item));
                   2848:                     }
                   2849:                     if ($user eq $uname.':'.$udom) {
                   2850:                         undef($skipuser);
                   2851:                         last;
                   2852:                     }
                   2853:                 }
                   2854:             }
                   2855:             if ($skipuser) {
                   2856:                 return 0;
                   2857:             }
                   2858:         }
                   2859:     }
1.1194    raeburn  2860:     $type ||= 'any';
                   2861:     if (!defined($cdom) || !defined($cnum)) {
                   2862:         my $cid  = $env{'request.course.id'};
                   2863:         $cdom = $env{'course.'.$cid.'.domain'};
                   2864:         $cnum = $env{'course.'.$cid.'.num'};
                   2865:     }
                   2866:     my $typesref;
1.1195    raeburn  2867:     if (($type eq 'any') || ($type eq 'all')) {
1.1194    raeburn  2868:         $typesref = ['active','previous','future'];
                   2869:     } elsif ($type eq 'previous' || $type eq 'future') {
                   2870:         $typesref = [$type];
                   2871:     }
                   2872:     my %roles = &get_my_roles($uname,$udom,'userroles',
                   2873:                               $typesref,undef,[$cdom]);
                   2874:     my ($tmp) = keys(%roles);
                   2875:     return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
                   2876:     my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
                   2877:     if (@course_roles > 0) {
                   2878:         return 1;
                   2879:     }
                   2880:     return 0;
                   2881: }
                   2882: 
1.478     albertel 2883: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638     albertel 2884: # input: action, courseID, current domain, intended
1.637     raeburn  2885: #        path to file, source of file, instruction to parse file for objects,
                   2886: #        ref to hash for embedded objects,
                   2887: #        ref to hash for codebase of java objects.
1.1095    raeburn  2888: #        reference to scalar to accommodate mime type determined
                   2889: #          from File::MMagic if $parser = parse.
1.637     raeburn  2890: #
1.485     raeburn  2891: # output: url to file (if action was uploaddoc), 
                   2892: #         ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477     raeburn  2893: #
1.478     albertel 2894: # Allows directory structure to be used within lonUsers/../userfiles/ for a 
                   2895: # course.
1.477     raeburn  2896: #
1.478     albertel 2897: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2898: #          will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
                   2899: #          course's home server.
1.477     raeburn  2900: #
1.478     albertel 2901: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
                   2902: #          be copied from $source (current location) to 
                   2903: #          /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2904: #         and will then be copied to
                   2905: #          /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
                   2906: #         course's home server.
1.485     raeburn  2907: #
1.481     raeburn  2908: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620     albertel 2909: #         will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481     raeburn  2910: #         /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   2911: #         and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
                   2912: #         in course's home server.
1.637     raeburn  2913: #
1.477     raeburn  2914: 
                   2915: sub process_coursefile {
1.1095    raeburn  2916:     my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
                   2917:         $mimetype)=@_;
1.477     raeburn  2918:     my $fetchresult;
1.638     albertel 2919:     my $home=&homeserver($docuname,$docudom);
1.477     raeburn  2920:     if ($action eq 'propagate') {
1.638     albertel 2921:         $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
                   2922: 			     $home);
1.481     raeburn  2923:     } else {
1.477     raeburn  2924:         my $fpath = '';
                   2925:         my $fname = $file;
1.478     albertel 2926:         ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477     raeburn  2927:         $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637     raeburn  2928:         my $filepath = &build_filepath($fpath);
1.481     raeburn  2929:         if ($action eq 'copy') {
                   2930:             if ($source eq '') {
                   2931:                 $fetchresult = 'no source file';
                   2932:                 return $fetchresult;
                   2933:             } else {
                   2934:                 my $destination = $filepath.'/'.$fname;
                   2935:                 rename($source,$destination);
                   2936:                 $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 2937:                                  $home);
1.481     raeburn  2938:             }
                   2939:         } elsif ($action eq 'uploaddoc') {
                   2940:             open(my $fh,'>'.$filepath.'/'.$fname);
1.620     albertel 2941:             print $fh $env{'form.'.$source};
1.481     raeburn  2942:             close($fh);
1.637     raeburn  2943:             if ($parser eq 'parse') {
1.1024    raeburn  2944:                 my $mm = new File::MMagic;
1.1095    raeburn  2945:                 my $type = $mm->checktype_filename($filepath.'/'.$fname);
                   2946:                 if ($type eq 'text/html') {
1.1024    raeburn  2947:                     my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
                   2948:                     unless ($parse_result eq 'ok') {
                   2949:                         &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
                   2950:                     }
1.637     raeburn  2951:                 }
1.1095    raeburn  2952:                 if (ref($mimetype)) {
                   2953:                     $$mimetype = $type;
                   2954:                 } 
1.637     raeburn  2955:             }
1.477     raeburn  2956:             $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 2957:                                  $home);
1.481     raeburn  2958:             if ($fetchresult eq 'ok') {
                   2959:                 return '/uploaded/'.$fpath.'/'.$fname;
                   2960:             } else {
                   2961:                 &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 2962:                         ' to host '.$home.': '.$fetchresult);
1.481     raeburn  2963:                 return '/adm/notfound.html';
                   2964:             }
1.477     raeburn  2965:         }
                   2966:     }
1.485     raeburn  2967:     unless ( $fetchresult eq 'ok') {
1.477     raeburn  2968:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 2969:              ' to host '.$home.': '.$fetchresult);
1.477     raeburn  2970:     }
                   2971:     return $fetchresult;
                   2972: }
                   2973: 
1.637     raeburn  2974: sub build_filepath {
                   2975:     my ($fpath) = @_;
                   2976:     my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
                   2977:     unless ($fpath eq '') {
                   2978:         my @parts=split('/',$fpath);
                   2979:         foreach my $part (@parts) {
                   2980:             $filepath.= '/'.$part;
                   2981:             if ((-e $filepath)!=1) {
                   2982:                 mkdir($filepath,0777);
                   2983:             }
                   2984:         }
                   2985:     }
                   2986:     return $filepath;
                   2987: }
                   2988: 
                   2989: sub store_edited_file {
1.638     albertel 2990:     my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637     raeburn  2991:     my $file = $primary_url;
                   2992:     $file =~ s#^/uploaded/$docudom/$docuname/##;
                   2993:     my $fpath = '';
                   2994:     my $fname = $file;
                   2995:     ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
                   2996:     $fpath=$docudom.'/'.$docuname.'/'.$fpath;
                   2997:     my $filepath = &build_filepath($fpath);
                   2998:     open(my $fh,'>'.$filepath.'/'.$fname);
                   2999:     print $fh $content;
                   3000:     close($fh);
1.638     albertel 3001:     my $home=&homeserver($docuname,$docudom);
1.637     raeburn  3002:     $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 3003: 			  $home);
1.637     raeburn  3004:     if ($$fetchresult eq 'ok') {
                   3005:         return '/uploaded/'.$fpath.'/'.$fname;
                   3006:     } else {
1.638     albertel 3007:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
                   3008: 		 ' to host '.$home.': '.$$fetchresult);
1.637     raeburn  3009:         return '/adm/notfound.html';
                   3010:     }
                   3011: }
                   3012: 
1.531     albertel 3013: sub clean_filename {
1.831     albertel 3014:     my ($fname,$args)=@_;
1.315     www      3015: # Replace Windows backslashes by forward slashes
1.257     www      3016:     $fname=~s/\\/\//g;
1.831     albertel 3017:     if (!$args->{'keep_path'}) {
                   3018:         # Get rid of everything but the actual filename
                   3019: 	$fname=~s/^.*\/([^\/]+)$/$1/;
                   3020:     }
1.315     www      3021: # Replace spaces by underscores
                   3022:     $fname=~s/\s+/\_/g;
                   3023: # Replace all other weird characters by nothing
1.831     albertel 3024:     $fname=~s{[^/\w\.\-]}{}g;
1.540     albertel 3025: # Replace all .\d. sequences with _\d. so they no longer look like version
                   3026: # numbers
                   3027:     $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531     albertel 3028:     return $fname;
                   3029: }
1.1051    raeburn  3030: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 
                   3031: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 
                   3032: # image with the same aspect ratio as the original, but with dimensions which do 
                   3033: # not exceed $resizewidth and $resizeheight.
                   3034:  
1.984     neumanie 3035: sub resizeImage {
1.1051    raeburn  3036:     my ($img_path,$resizewidth,$resizeheight) = @_;
                   3037:     my $ima = Image::Magick->new;
                   3038:     my $resized;
                   3039:     if (-e $img_path) {
                   3040:         $ima->Read($img_path);
                   3041:         if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
                   3042:             my $width = $ima->Get('width');
                   3043:             my $height = $ima->Get('height');
                   3044:             if ($width > $resizewidth) {
                   3045: 	        my $factor = $width/$resizewidth;
                   3046:                 my $newheight = $height/$factor;
                   3047:                 $ima->Scale(width=>$resizewidth,height=>$newheight);
                   3048:                 $resized = 1;
                   3049:             }
                   3050:         }
                   3051:         if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
                   3052:             my $width = $ima->Get('width');
                   3053:             my $height = $ima->Get('height');
                   3054:             if ($height > $resizeheight) {
                   3055:                 my $factor = $height/$resizeheight;
                   3056:                 my $newwidth = $width/$factor;
                   3057:                 $ima->Scale(width=>$newwidth,height=>$resizeheight);
                   3058:                 $resized = 1;
                   3059:             }
                   3060:         }
                   3061:         if ($resized) {
                   3062:             $ima->Write($img_path);
                   3063:         }
                   3064:     }
                   3065:     return;
1.977     amueller 3066: }
                   3067: 
1.608     albertel 3068: # --------------- Take an uploaded file and put it into the userfiles directory
1.686     albertel 3069: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093    raeburn  3070: #                    the desired filename is in $env{"form.$formname.filename"}
1.1090    raeburn  3071: #        $context - possible values: coursedoc, existingfile, overwrite, 
                   3072: #                                    canceloverwrite, or ''. 
                   3073: #                   if 'coursedoc': upload to the current course
                   3074: #                   if 'existingfile': write file to tmp/overwrites directory 
                   3075: #                   if 'canceloverwrite': delete file written to tmp/overwrites directory
                   3076: #                   $context is passed as argument to &finishuserfileupload
1.686     albertel 3077: #        $subdir - directory in userfile to store the file into
1.858     raeburn  3078: #        $parser - instruction to parse file for objects ($parser = parse)    
                   3079: #        $allfiles - reference to hash for embedded objects
                   3080: #        $codebase - reference to hash for codebase of java objects
                   3081: #        $desuname - username for permanent storage of uploaded file
                   3082: #        $dsetudom - domain for permanaent storage of uploaded file
1.860     raeburn  3083: #        $thumbwidth - width (pixels) of thumbnail to make for uploaded image 
                   3084: #        $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051    raeburn  3085: #        $resizewidth - width (pixels) to which to resize uploaded image
                   3086: #        $resizeheight - height (pixels) to which to resize uploaded image
1.1095    raeburn  3087: #        $mimetype - reference to scalar to accommodate mime type determined
1.1152    raeburn  3088: #                    from File::MMagic.
1.858     raeburn  3089: # 
1.686     albertel 3090: # output: url of file in userspace, or error: <message> 
                   3091: #             or /adm/notfound.html if failure to upload occurse
1.608     albertel 3092: 
1.531     albertel 3093: sub userfileupload {
1.1090    raeburn  3094:     my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095    raeburn  3095:         $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531     albertel 3096:     if (!defined($subdir)) { $subdir='unknown'; }
1.620     albertel 3097:     my $fname=$env{'form.'.$formname.'.filename'};
1.531     albertel 3098:     $fname=&clean_filename($fname);
1.1090    raeburn  3099:     # See if there is anything left
1.257     www      3100:     unless ($fname) { return 'error: no uploaded file'; }
1.1090    raeburn  3101:     # Files uploaded to help request form, or uploaded to "create course" page are handled differently
                   3102:     if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
                   3103:         (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
                   3104:          ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523     raeburn  3105:         my $now = time;
1.1090    raeburn  3106:         my $filepath;
1.1095    raeburn  3107:         if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090    raeburn  3108:              $filepath = 'tmp/helprequests/'.$now;
                   3109:         } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
                   3110:              $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
                   3111:                          '_'.$env{'user.domain'}.'/pending';
                   3112:         } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
                   3113:             my ($docuname,$docudom);
                   3114:             if ($destudom) {
                   3115:                 $docudom = $destudom;
                   3116:             } else {
                   3117:                 $docudom = $env{'user.domain'};
                   3118:             }
                   3119:             if ($destuname) {
                   3120:                 $docuname = $destuname;
                   3121:             } else {
                   3122:                 $docuname = $env{'user.name'};
                   3123:             }
                   3124:             if (exists($env{'form.group'})) {
                   3125:                 $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3126:                 $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   3127:             }
                   3128:             $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
                   3129:             if ($context eq 'canceloverwrite') {
                   3130:                 my $tempfile =  $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
                   3131:                 if (-e  $tempfile) {
                   3132:                     my @info = stat($tempfile);
                   3133:                     if ($info[9] eq $env{'form.timestamp'}) {
                   3134:                         unlink($tempfile);
                   3135:                     }
                   3136:                 }
                   3137:                 return;
1.523     raeburn  3138:             }
                   3139:         }
1.1090    raeburn  3140:         # Create the directory if not present
1.741     raeburn  3141:         my @parts=split(/\//,$filepath);
                   3142:         my $fullpath = $perlvar{'lonDaemons'};
                   3143:         for (my $i=0;$i<@parts;$i++) {
                   3144:             $fullpath .= '/'.$parts[$i];
                   3145:             if ((-e $fullpath)!=1) {
                   3146:                 mkdir($fullpath,0777);
                   3147:             }
                   3148:         }
                   3149:         open(my $fh,'>'.$fullpath.'/'.$fname);
                   3150:         print $fh $env{'form.'.$formname};
                   3151:         close($fh);
1.1090    raeburn  3152:         if ($context eq 'existingfile') {
                   3153:             my @info = stat($fullpath.'/'.$fname);
                   3154:             return ($fullpath.'/'.$fname,$info[9]);
                   3155:         } else {
                   3156:             return $fullpath.'/'.$fname;
                   3157:         }
1.523     raeburn  3158:     }
1.995     raeburn  3159:     if ($subdir eq 'scantron') {
                   3160:         $fname = 'scantron_orig_'.$fname;
1.1093    raeburn  3161:     } else {
1.995     raeburn  3162:         $fname="$subdir/$fname";
                   3163:     }
1.1090    raeburn  3164:     if ($context eq 'coursedoc') {
1.638     albertel 3165: 	my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3166: 	my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646     raeburn  3167:         if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638     albertel 3168:             return &finishuserfileupload($docuname,$docudom,
                   3169: 					 $formname,$fname,$parser,$allfiles,
1.1051    raeburn  3170: 					 $codebase,$thumbwidth,$thumbheight,
1.1095    raeburn  3171:                                          $resizewidth,$resizeheight,$context,$mimetype);
1.481     raeburn  3172:         } else {
1.620     albertel 3173:             $fname=$env{'form.folder'}.'/'.$fname;
1.638     albertel 3174:             return &process_coursefile('uploaddoc',$docuname,$docudom,
                   3175: 				       $fname,$formname,$parser,
1.1095    raeburn  3176: 				       $allfiles,$codebase,$mimetype);
1.481     raeburn  3177:         }
1.719     banghart 3178:     } elsif (defined($destuname)) {
                   3179:         my $docuname=$destuname;
                   3180:         my $docudom=$destudom;
1.860     raeburn  3181: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   3182: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  3183:                                      $thumbwidth,$thumbheight,
1.1095    raeburn  3184:                                      $resizewidth,$resizeheight,$context,$mimetype);
1.259     www      3185:     } else {
1.638     albertel 3186:         my $docuname=$env{'user.name'};
                   3187:         my $docudom=$env{'user.domain'};
1.714     raeburn  3188:         if (exists($env{'form.group'})) {
                   3189:             $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3190:             $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   3191:         }
1.860     raeburn  3192: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   3193: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  3194:                                      $thumbwidth,$thumbheight,
1.1095    raeburn  3195:                                      $resizewidth,$resizeheight,$context,$mimetype);
1.259     www      3196:     }
1.271     www      3197: }
                   3198: 
                   3199: sub finishuserfileupload {
1.860     raeburn  3200:     my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095    raeburn  3201:         $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477     raeburn  3202:     my $path=$docudom.'/'.$docuname.'/';
1.258     www      3203:     my $filepath=$perlvar{'lonDocRoot'};
1.984     neumanie 3204:   
1.860     raeburn  3205:     my ($fnamepath,$file,$fetchthumb);
1.494     albertel 3206:     $file=$fname;
                   3207:     if ($fname=~m|/|) {
                   3208:         ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
                   3209: 	$path.=$fnamepath.'/';
                   3210:     }
1.259     www      3211:     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258     www      3212:     my $count;
                   3213:     for ($count=4;$count<=$#parts;$count++) {
                   3214:         $filepath.="/$parts[$count]";
                   3215:         if ((-e $filepath)!=1) {
                   3216: 	    mkdir($filepath,0777);
                   3217:         }
                   3218:     }
1.984     neumanie 3219: 
1.258     www      3220: # Save the file
                   3221:     {
1.701     albertel 3222: 	if (!open(FH,'>'.$filepath.'/'.$file)) {
                   3223: 	    &logthis('Failed to create '.$filepath.'/'.$file);
                   3224: 	    print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
                   3225: 	    return '/adm/notfound.html';
                   3226: 	}
1.1090    raeburn  3227:         if ($context eq 'overwrite') {
1.1117    foxr     3228:             my $source =  LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090    raeburn  3229:             my $target = $filepath.'/'.$file;
                   3230:             if (-e $source) {
                   3231:                 my @info = stat($source);
                   3232:                 if ($info[9] eq $env{'form.timestamp'}) {   
                   3233:                     unless (&File::Copy::move($source,$target)) {
                   3234:                         &logthis('Failed to overwrite '.$filepath.'/'.$file);
                   3235:                         return "Moving from $source failed";
                   3236:                     }
                   3237:                 } else {
                   3238:                     return "Temporary file: $source had unexpected date/time for last modification";
                   3239:                 }
                   3240:             } else {
                   3241:                 return "Temporary file: $source missing";
                   3242:             }
                   3243:         } elsif (!print FH ($env{'form.'.$formname})) {
1.701     albertel 3244: 	    &logthis('Failed to write to '.$filepath.'/'.$file);
                   3245: 	    print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
                   3246: 	    return '/adm/notfound.html';
                   3247: 	}
1.570     albertel 3248: 	close(FH);
1.1051    raeburn  3249:         if ($resizewidth && $resizeheight) {
                   3250:             my $mm = new File::MMagic;
                   3251:             my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
                   3252:             if ($mime_type =~ m{^image/}) {
                   3253: 	        &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
                   3254:             }  
1.977     amueller 3255: 	}
1.258     www      3256:     }
1.1152    raeburn  3257:     if (($context eq 'coursedoc') || ($parser eq 'parse')) {
                   3258:         if (ref($mimetype)) {
                   3259:             if ($$mimetype eq '') {
                   3260:                 my $mm = new File::MMagic;
                   3261:                 my $type = $mm->checktype_filename($filepath.'/'.$file);
                   3262:                 $$mimetype = $type;
                   3263:             }
                   3264:         }
                   3265:     }
1.637     raeburn  3266:     if ($parser eq 'parse') {
1.1152    raeburn  3267:         if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024    raeburn  3268:             my $parse_result = &extract_embedded_items($filepath.'/'.$file,
                   3269:                                                        $allfiles,$codebase);
                   3270:             unless ($parse_result eq 'ok') {
                   3271:                 &logthis('Failed to parse '.$filepath.$file.
                   3272: 	   	         ' for embedded media: '.$parse_result); 
                   3273:             }
1.637     raeburn  3274:         }
                   3275:     }
1.860     raeburn  3276:     if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
                   3277:         my $input = $filepath.'/'.$file;
                   3278:         my $output = $filepath.'/'.'tn-'.$file;
                   3279:         my $thumbsize = $thumbwidth.'x'.$thumbheight;
                   3280:         system("convert -sample $thumbsize $input $output");
                   3281:         if (-e $filepath.'/'.'tn-'.$file) {
                   3282:             $fetchthumb  = 1; 
                   3283:         }
                   3284:     }
1.858     raeburn  3285:  
1.259     www      3286: # Notify homeserver to grep it
                   3287: #
1.984     neumanie 3288:     my $docuhome=&homeserver($docuname,$docudom);	
1.494     albertel 3289:     my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295     www      3290:     if ($fetchresult eq 'ok') {
1.860     raeburn  3291:         if ($fetchthumb) {
                   3292:             my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
                   3293:             if ($thumbresult ne 'ok') {
                   3294:                 &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
                   3295:                          $docuhome.': '.$thumbresult);
                   3296:             }
                   3297:         }
1.259     www      3298: #
1.258     www      3299: # Return the URL to it
1.494     albertel 3300:         return '/uploaded/'.$path.$file;
1.263     www      3301:     } else {
1.494     albertel 3302:         &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
                   3303: 		 ': '.$fetchresult);
1.263     www      3304:         return '/adm/notfound.html';
1.858     raeburn  3305:     }
1.493     albertel 3306: }
                   3307: 
1.637     raeburn  3308: sub extract_embedded_items {
1.961     raeburn  3309:     my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637     raeburn  3310:     my @state = ();
1.1164    raeburn  3311:     my (%lastids,%related,%shockwave,%flashvars);
1.637     raeburn  3312:     my %javafiles = (
                   3313:                       codebase => '',
                   3314:                       code => '',
                   3315:                       archive => ''
                   3316:                     );
                   3317:     my %mediafiles = (
                   3318:                       src => '',
                   3319:                       movie => '',
                   3320:                      );
1.648     raeburn  3321:     my $p;
                   3322:     if ($content) {
                   3323:         $p = HTML::LCParser->new($content);
                   3324:     } else {
1.961     raeburn  3325:         $p = HTML::LCParser->new($fullpath);
1.648     raeburn  3326:     }
1.641     albertel 3327:     while (my $t=$p->get_token()) {
1.640     albertel 3328: 	if ($t->[0] eq 'S') {
                   3329: 	    my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886     albertel 3330: 	    push(@state, $tagname);
1.648     raeburn  3331:             if (lc($tagname) eq 'allow') {
                   3332:                 &add_filetype($allfiles,$attr->{'src'},'src');
                   3333:             }
1.640     albertel 3334: 	    if (lc($tagname) eq 'img') {
                   3335: 		&add_filetype($allfiles,$attr->{'src'},'src');
                   3336: 	    }
1.886     albertel 3337: 	    if (lc($tagname) eq 'a') {
                   3338: 		&add_filetype($allfiles,$attr->{'href'},'href');
                   3339: 	    }
1.645     raeburn  3340:             if (lc($tagname) eq 'script') {
1.1164    raeburn  3341:                 my $src;
1.645     raeburn  3342:                 if ($attr->{'archive'} =~ /\.jar$/i) {
                   3343:                     &add_filetype($allfiles,$attr->{'archive'},'archive');
                   3344:                 } else {
1.1164    raeburn  3345:                     if ($attr->{'src'} ne '') {
                   3346:                         $src = $attr->{'src'};
                   3347:                         &add_filetype($allfiles,$src,'src');
                   3348:                     }
                   3349:                 }
                   3350:                 my $text = $p->get_trimmed_text();
                   3351:                 if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
                   3352:                     my @swfargs = split(/,/,$1);
                   3353:                     foreach my $item (@swfargs) {
                   3354:                         $item =~ s/["']//g;
                   3355:                         $item =~ s/^\s+//;
                   3356:                         $item =~ s/\s+$//;
                   3357:                     }
                   3358:                     if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
                   3359:                         if (ref($related{$swfargs[0]}) eq 'ARRAY') {
                   3360:                             push(@{$related{$swfargs[0]}},$swfargs[2]);
                   3361:                         } else {
                   3362:                             $related{$swfargs[0]} = [$swfargs[2]];
                   3363:                         }
                   3364:                     }
1.645     raeburn  3365:                 }
                   3366:             }
                   3367:             if (lc($tagname) eq 'link') {
                   3368:                 if (lc($attr->{'rel'}) eq 'stylesheet') { 
                   3369:                     &add_filetype($allfiles,$attr->{'href'},'href');
                   3370:                 }
                   3371:             }
1.640     albertel 3372: 	    if (lc($tagname) eq 'object' ||
                   3373: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
                   3374: 		foreach my $item (keys(%javafiles)) {
                   3375: 		    $javafiles{$item} = '';
                   3376: 		}
1.1164    raeburn  3377:                 if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
                   3378:                     $lastids{lc($tagname)} = $attr->{'id'};
                   3379:                 }
1.640     albertel 3380: 	    }
                   3381: 	    if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
                   3382: 		my $name = lc($attr->{'name'});
                   3383: 		foreach my $item (keys(%javafiles)) {
                   3384: 		    if ($name eq $item) {
                   3385: 			$javafiles{$item} = $attr->{'value'};
                   3386: 			last;
                   3387: 		    }
                   3388: 		}
1.1164    raeburn  3389:                 my $pathfrom;
1.640     albertel 3390: 		foreach my $item (keys(%mediafiles)) {
                   3391: 		    if ($name eq $item) {
1.1164    raeburn  3392:                         $pathfrom = $attr->{'value'};
                   3393:                         $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
                   3394: 			&add_filetype($allfiles,$pathfrom,$name);
1.640     albertel 3395: 			last;
                   3396: 		    }
                   3397: 		}
1.1164    raeburn  3398:                 if ($name eq 'flashvars') {
                   3399:                     $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
                   3400:                 }
                   3401:                 if ($pathfrom ne '') {
                   3402:                     &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
                   3403:                                          $pathfrom);
                   3404:                 }
1.640     albertel 3405: 	    }
                   3406: 	    if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
                   3407: 		foreach my $item (keys(%javafiles)) {
                   3408: 		    if ($attr->{$item}) {
                   3409: 			$javafiles{$item} = $attr->{$item};
                   3410: 			last;
                   3411: 		    }
                   3412: 		}
                   3413: 		foreach my $item (keys(%mediafiles)) {
                   3414: 		    if ($attr->{$item}) {
                   3415: 			&add_filetype($allfiles,$attr->{$item},$item);
                   3416: 			last;
                   3417: 		    }
                   3418: 		}
1.1164    raeburn  3419:                 if (lc($tagname) eq 'embed') {
                   3420:                     if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
                   3421:                         &embedded_dependency($allfiles,\%related,$attr->{'name'},
                   3422:                                              $attr->{'src'});
                   3423:                     }
                   3424:                 }
1.640     albertel 3425: 	    }
1.1164    raeburn  3426:             if ($t->[4] =~ m{/>$}) {
                   3427:                 pop(@state);  
                   3428:             }
1.640     albertel 3429: 	} elsif ($t->[0] eq 'E') {
                   3430: 	    my ($tagname) = ($t->[1]);
                   3431: 	    if ($javafiles{'codebase'} ne '') {
                   3432: 		$javafiles{'codebase'} .= '/';
                   3433: 	    }  
                   3434: 	    if (lc($tagname) eq 'applet' ||
                   3435: 		lc($tagname) eq 'object' ||
                   3436: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
                   3437: 		) {
                   3438: 		foreach my $item (keys(%javafiles)) {
                   3439: 		    if ($item ne 'codebase' && $javafiles{$item} ne '') {
                   3440: 			my $file=$javafiles{'codebase'}.$javafiles{$item};
                   3441: 			&add_filetype($allfiles,$file,$item);
                   3442: 		    }
                   3443: 		}
                   3444: 	    } 
                   3445: 	    pop @state;
                   3446: 	}
                   3447:     }
1.1164    raeburn  3448:     foreach my $id (sort(keys(%flashvars))) {
                   3449:         if ($shockwave{$id} ne '') {
                   3450:             my @pairs = split(/\&/,$flashvars{$id});
                   3451:             foreach my $pair (@pairs) {
                   3452:                 my ($key,$value) = split(/\=/,$pair);
                   3453:                 if ($key eq 'thumb') {
                   3454:                     &add_filetype($allfiles,$value,$key);
                   3455:                 } elsif ($key eq 'content') {
                   3456:                     my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
                   3457:                     my ($ext) = ($value =~ /\.([^.]+)$/);
                   3458:                     if ($ext ne '') {
                   3459:                         &add_filetype($allfiles,$path.$value,$ext);
                   3460:                     }
                   3461:                 }
                   3462:             }
                   3463:         }
                   3464:     }
1.637     raeburn  3465:     return 'ok';
                   3466: }
                   3467: 
1.639     albertel 3468: sub add_filetype {
                   3469:     my ($allfiles,$file,$type)=@_;
                   3470:     if (exists($allfiles->{$file})) {
                   3471: 	unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
                   3472: 	    push(@{$allfiles->{$file}}, &escape($type));
                   3473: 	}
                   3474:     } else {
                   3475: 	@{$allfiles->{$file}} = (&escape($type));
1.637     raeburn  3476:     }
                   3477: }
                   3478: 
1.1164    raeburn  3479: sub embedded_dependency {
                   3480:     my ($allfiles,$related,$identifier,$pathfrom) = @_;
                   3481:     if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
                   3482:         if (($identifier ne '') &&
                   3483:             (ref($related->{$identifier}) eq 'ARRAY') &&
                   3484:             ($pathfrom ne '')) {
                   3485:             my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
                   3486:             foreach my $dep (@{$related->{$identifier}}) {
                   3487:                 &add_filetype($allfiles,$path.$dep,'object');
                   3488:             }
                   3489:         }
                   3490:     }
                   3491:     return;
                   3492: }
                   3493: 
1.493     albertel 3494: sub removeuploadedurl {
1.984     neumanie 3495:     my ($url)=@_;	
                   3496:     my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);    
1.613     albertel 3497:     return &removeuserfile($uname,$udom,$fname);
1.490     albertel 3498: }
                   3499: 
                   3500: sub removeuserfile {
                   3501:     my ($docuname,$docudom,$fname)=@_;
1.984     neumanie 3502:     my $home=&homeserver($docuname,$docudom);    
1.798     raeburn  3503:     my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984     neumanie 3504:     if ($result eq 'ok') {	
1.798     raeburn  3505:         if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
                   3506:             my $metafile = $fname.'.meta';
                   3507:             my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 
1.823     albertel 3508: 	    my $url = "/uploaded/$docudom/$docuname/$fname";
1.984     neumanie 3509:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];	   
1.821     raeburn  3510:             my $sqlresult = 
1.823     albertel 3511:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  3512:                                         'portfolio_metadata',$group,
                   3513:                                         'delete');
1.798     raeburn  3514:         }
                   3515:     }
                   3516:     return $result;
1.257     www      3517: }
1.15      www      3518: 
1.530     albertel 3519: sub mkdiruserfile {
                   3520:     my ($docuname,$docudom,$dir)=@_;
                   3521:     my $home=&homeserver($docuname,$docudom);
                   3522:     return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
                   3523: }
                   3524: 
1.531     albertel 3525: sub renameuserfile {
                   3526:     my ($docuname,$docudom,$old,$new)=@_;
                   3527:     my $home=&homeserver($docuname,$docudom);
1.798     raeburn  3528:     my $result = &reply("renameuserfile:$docudom:$docuname:".
                   3529:                         &escape("$old").':'.&escape("$new"),$home);
                   3530:     if ($result eq 'ok') {
                   3531:         if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
                   3532:             my $oldmeta = $old.'.meta';
                   3533:             my $newmeta = $new.'.meta';
                   3534:             my $metaresult = 
                   3535:                 &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823     albertel 3536: 	    my $url = "/uploaded/$docudom/$docuname/$old";
                   3537:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821     raeburn  3538:             my $sqlresult = 
1.823     albertel 3539:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  3540:                                         'portfolio_metadata',$group,
                   3541:                                         'delete');
1.798     raeburn  3542:         }
                   3543:     }
                   3544:     return $result;
1.531     albertel 3545: }
                   3546: 
1.14      www      3547: # ------------------------------------------------------------------------- Log
                   3548: 
                   3549: sub log {
                   3550:     my ($dom,$nam,$hom,$what)=@_;
1.47      www      3551:     return critical("log:$dom:$nam:$what",$hom);
1.157     www      3552: }
                   3553: 
                   3554: # ------------------------------------------------------------------ Course Log
1.352     www      3555: #
                   3556: # This routine flushes several buffers of non-mission-critical nature
                   3557: #
1.157     www      3558: 
                   3559: sub flushcourselogs {
1.352     www      3560:     &logthis('Flushing log buffers');
                   3561: #
                   3562: # course logs
                   3563: # This is a log of all transactions in a course, which can be used
                   3564: # for data mining purposes
                   3565: #
                   3566: # It also collects the courseid database, which lists last transaction
                   3567: # times and course titles for all courseids
                   3568: #
                   3569:     my %courseidbuffer=();
1.921     raeburn  3570:     foreach my $crsid (keys(%courselogs)) {
1.352     www      3571:         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188     www      3572: 		          &escape($courselogs{$crsid}),
                   3573: 		          $coursehombuf{$crsid}) eq 'ok') {
1.157     www      3574: 	    delete $courselogs{$crsid};
                   3575:         } else {
                   3576:             &logthis('Failed to flush log buffer for '.$crsid);
                   3577:             if (length($courselogs{$crsid})>40000) {
1.672     albertel 3578:                &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157     www      3579:                         " exceeded maximum size, deleting.</font>");
                   3580:                delete $courselogs{$crsid};
                   3581:             }
1.352     www      3582:         }
1.920     raeburn  3583:         $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936     raeburn  3584:             'description' => $coursedescrbuf{$crsid},
                   3585:             'inst_code'    => $courseinstcodebuf{$crsid},
                   3586:             'type'        => $coursetypebuf{$crsid},
                   3587:             'owner'       => $courseownerbuf{$crsid},
1.920     raeburn  3588:         };
1.191     harris41 3589:     }
1.352     www      3590: #
                   3591: # Write course id database (reverse lookup) to homeserver of courses 
                   3592: # Is used in pickcourse
                   3593: #
1.840     albertel 3594:     foreach my $crs_home (keys(%courseidbuffer)) {
1.918     raeburn  3595:         my $response = &courseidput(&host_domain($crs_home),
1.921     raeburn  3596:                                     $courseidbuffer{$crs_home},
                   3597:                                     $crs_home,'timeonly');
1.352     www      3598:     }
                   3599: #
                   3600: # File accesses
                   3601: # Writes to the dynamic metadata of resources to get hit counts, etc.
                   3602: #
1.449     matthew  3603:     foreach my $entry (keys(%accesshash)) {
1.458     matthew  3604:         if ($entry =~ /___count$/) {
                   3605:             my ($dom,$name);
1.807     albertel 3606:             ($dom,$name,undef)=
1.811     albertel 3607: 		($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458     matthew  3608:             if (! defined($dom) || $dom eq '' || 
                   3609:                 ! defined($name) || $name eq '') {
1.620     albertel 3610:                 my $cid = $env{'request.course.id'};
                   3611:                 $dom  = $env{'request.'.$cid.'.domain'};
                   3612:                 $name = $env{'request.'.$cid.'.num'};
1.458     matthew  3613:             }
1.450     matthew  3614:             my $value = $accesshash{$entry};
                   3615:             my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
                   3616:             my %temphash=($url => $value);
1.449     matthew  3617:             my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
                   3618:             if ($result eq 'ok') {
                   3619:                 delete $accesshash{$entry};
                   3620:             }
                   3621:         } else {
1.811     albertel 3622:             my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159    www      3623:             if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450     matthew  3624:             my %temphash=($entry => $accesshash{$entry});
1.449     matthew  3625:             if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
                   3626:                 delete $accesshash{$entry};
                   3627:             }
1.185     www      3628:         }
1.191     harris41 3629:     }
1.352     www      3630: #
                   3631: # Roles
                   3632: # Reverse lookup of user roles for course faculty/staff and co-authorship
                   3633: #
1.800     albertel 3634:     foreach my $entry (keys(%userrolehash)) {
1.351     www      3635:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349     www      3636: 	    split(/\:/,$entry);
                   3637:         if (&Apache::lonnet::put('nohist_userroles',
1.351     www      3638:              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349     www      3639:                 $rudom,$runame) eq 'ok') {
                   3640: 	    delete $userrolehash{$entry};
                   3641:         }
                   3642:     }
1.662     raeburn  3643: #
                   3644: # Reverse lookup of domain roles (dc, ad, li, sc, au)
                   3645: #
                   3646:     my %domrolebuffer = ();
1.1000    raeburn  3647:     foreach my $entry (keys(%domainrolehash)) {
1.901     albertel 3648:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662     raeburn  3649:         if ($domrolebuffer{$rudom}) {
                   3650:             $domrolebuffer{$rudom}.='&'.&escape($entry).
                   3651:                       '='.&escape($domainrolehash{$entry});
                   3652:         } else {
                   3653:             $domrolebuffer{$rudom}.=&escape($entry).
                   3654:                       '='.&escape($domainrolehash{$entry});
                   3655:         }
                   3656:         delete $domainrolehash{$entry};
                   3657:     }
                   3658:     foreach my $dom (keys(%domrolebuffer)) {
1.841     albertel 3659: 	my %servers = &get_servers($dom,'library');
                   3660: 	foreach my $tryserver (keys(%servers)) {
                   3661: 	    unless (&reply('domroleput:'.$dom.':'.
                   3662: 			   $domrolebuffer{$dom},$tryserver) eq 'ok') {
                   3663: 		&logthis('Put of domain roles failed for '.$dom.' and  '.$tryserver);
                   3664: 	    }
1.662     raeburn  3665:         }
                   3666:     }
1.186     www      3667:     $dumpcount++;
1.157     www      3668: }
                   3669: 
                   3670: sub courselog {
                   3671:     my $what=shift;
1.158     www      3672:     $what=time.':'.$what;
1.620     albertel 3673:     unless ($env{'request.course.id'}) { return ''; }
                   3674:     $coursedombuf{$env{'request.course.id'}}=
                   3675:        $env{'course.'.$env{'request.course.id'}.'.domain'};
                   3676:     $coursenumbuf{$env{'request.course.id'}}=
                   3677:        $env{'course.'.$env{'request.course.id'}.'.num'};
                   3678:     $coursehombuf{$env{'request.course.id'}}=
                   3679:        $env{'course.'.$env{'request.course.id'}.'.home'};
                   3680:     $coursedescrbuf{$env{'request.course.id'}}=
                   3681:        $env{'course.'.$env{'request.course.id'}.'.description'};
                   3682:     $courseinstcodebuf{$env{'request.course.id'}}=
                   3683:        $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
                   3684:     $courseownerbuf{$env{'request.course.id'}}=
                   3685:        $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741     raeburn  3686:     $coursetypebuf{$env{'request.course.id'}}=
                   3687:        $env{'course.'.$env{'request.course.id'}.'.type'};
1.620     albertel 3688:     if (defined $courselogs{$env{'request.course.id'}}) {
                   3689: 	$courselogs{$env{'request.course.id'}}.='&'.$what;
1.157     www      3690:     } else {
1.620     albertel 3691: 	$courselogs{$env{'request.course.id'}}.=$what;
1.157     www      3692:     }
1.620     albertel 3693:     if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157     www      3694: 	&flushcourselogs();
                   3695:     }
1.158     www      3696: }
                   3697: 
                   3698: sub courseacclog {
                   3699:     my $fnsymb=shift;
1.620     albertel 3700:     unless ($env{'request.course.id'}) { return ''; }
                   3701:     my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144    www      3702:     if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187     www      3703:         $what.=':POST';
1.583     matthew  3704:         # FIXME: Probably ought to escape things....
1.800     albertel 3705: 	foreach my $key (keys(%env)) {
                   3706:             if ($key=~/^form\.(.*)/) {
1.975     raeburn  3707:                 my $formitem = $1;
                   3708:                 if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
                   3709:                     $what.=':'.$formitem.'='.$env{$key};
                   3710:                 } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
                   3711:                     $what.=':'.$formitem.'='.$env{$key};
                   3712:                 }
1.158     www      3713:             }
1.191     harris41 3714:         }
1.583     matthew  3715:     } elsif ($fnsymb =~ m:^/adm/searchcat:) {
                   3716:         # FIXME: We should not be depending on a form parameter that someone
                   3717:         # editing lonsearchcat.pm might change in the future.
1.620     albertel 3718:         if ($env{'form.phase'} eq 'course_search') {
1.583     matthew  3719:             $what.= ':POST';
                   3720:             # FIXME: Probably ought to escape things....
                   3721:             foreach my $element ('courseexp','crsfulltext','crsrelated',
                   3722:                                  'crsdiscuss') {
1.620     albertel 3723:                 $what.=':'.$element.'='.$env{'form.'.$element};
1.583     matthew  3724:             }
                   3725:         }
1.158     www      3726:     }
                   3727:     &courselog($what);
1.149     www      3728: }
                   3729: 
1.185     www      3730: sub countacc {
                   3731:     my $url=&declutter(shift);
1.458     matthew  3732:     return if (! defined($url) || $url eq '');
1.620     albertel 3733:     unless ($env{'request.course.id'}) { return ''; }
1.1158    www      3734: #
                   3735: # Mark that this url was used in this course
                   3736: #
1.620     albertel 3737:     $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158    www      3738: #
                   3739: # Increase the access count for this resource in this child process
                   3740: #
1.281     www      3741:     my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450     matthew  3742:     $accesshash{$key}++;
1.185     www      3743: }
1.349     www      3744: 
1.361     www      3745: sub linklog {
                   3746:     my ($from,$to)=@_;
                   3747:     $from=&declutter($from);
                   3748:     $to=&declutter($to);
                   3749:     $accesshash{$from.'___'.$to.'___comefrom'}=1;
                   3750:     $accesshash{$to.'___'.$from.'___goto'}=1;
                   3751: }
1.1160    www      3752: 
                   3753: sub statslog {
                   3754:     my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
                   3755:     if ($users<2) { return; }
                   3756:     my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
                   3757:             'course'       => $env{'request.course.id'},
                   3758:             'sections'     => '"all"',
                   3759:             'num_students' => $users,
                   3760:             'part'         => $part,
                   3761:             'symb'         => $symb,
                   3762:             'mean_tries'   => $av_attempts,
                   3763:             'deg_of_diff'  => $degdiff});
                   3764:     foreach my $key (keys(%dynstore)) {
                   3765:         $accesshash{$key}=$dynstore{$key};
                   3766:     }
                   3767: }
1.361     www      3768:   
1.349     www      3769: sub userrolelog {
                   3770:     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169    droeschl 3771:     if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350     www      3772:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   3773:        $userrolehash
                   3774:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349     www      3775:                     =$tend.':'.$tstart;
1.662     raeburn  3776:     }
1.1169    droeschl 3777:     if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898     albertel 3778:        $userrolehash
                   3779:          {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
                   3780:                     =$tend.':'.$tstart;
                   3781:     }
1.1169    droeschl 3782:     if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
1.662     raeburn  3783:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   3784:        $domainrolehash
                   3785:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
                   3786:                     = $tend.':'.$tstart;
                   3787:     }
1.351     www      3788: }
                   3789: 
1.957     raeburn  3790: sub courserolelog {
                   3791:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184    raeburn  3792:     if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
                   3793:         my $cdom = $1;
                   3794:         my $cnum = $2;
                   3795:         my $sec = $3;
                   3796:         my $namespace = 'rolelog';
                   3797:         my %storehash = (
                   3798:                            role    => $trole,
                   3799:                            start   => $tstart,
                   3800:                            end     => $tend,
                   3801:                            selfenroll => $selfenroll,
                   3802:                            context    => $context,
                   3803:                         );
                   3804:         if ($trole eq 'gr') {
                   3805:             $namespace = 'groupslog';
                   3806:             $storehash{'group'} = $sec;
                   3807:         } else {
                   3808:             $storehash{'section'} = $sec;
                   3809:         }
1.1188    raeburn  3810:         &write_log('course',$namespace,\%storehash,$delflag,$username,
                   3811:                    $domain,$cnum,$cdom);
1.1184    raeburn  3812:         if (($trole ne 'st') || ($sec ne '')) {
                   3813:             &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957     raeburn  3814:         }
                   3815:     }
                   3816:     return;
                   3817: }
                   3818: 
1.1184    raeburn  3819: sub domainrolelog {
                   3820:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
                   3821:     if ($area =~ m{^/($match_domain)/$}) {
                   3822:         my $cdom = $1;
                   3823:         my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
                   3824:         my $namespace = 'rolelog';
                   3825:         my %storehash = (
                   3826:                            role    => $trole,
                   3827:                            start   => $tstart,
                   3828:                            end     => $tend,
                   3829:                            context => $context,
                   3830:                         );
1.1188    raeburn  3831:         &write_log('domain',$namespace,\%storehash,$delflag,$username,
                   3832:                    $domain,$domconfiguser,$cdom);
1.1184    raeburn  3833:     }
                   3834:     return;
                   3835: 
                   3836: }
                   3837: 
                   3838: sub coauthorrolelog {
                   3839:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
                   3840:     if ($area =~ m{^/($match_domain)/($match_username)$}) {
                   3841:         my $audom = $1;
                   3842:         my $auname = $2;
                   3843:         my $namespace = 'rolelog';
                   3844:         my %storehash = (
                   3845:                            role    => $trole,
                   3846:                            start   => $tstart,
                   3847:                            end     => $tend,
                   3848:                            context => $context,
                   3849:                         );
1.1188    raeburn  3850:         &write_log('author',$namespace,\%storehash,$delflag,$username,
                   3851:                    $domain,$auname,$audom);
1.1184    raeburn  3852:     }
                   3853:     return;
                   3854: }
                   3855: 
1.351     www      3856: sub get_course_adv_roles {
1.948     raeburn  3857:     my ($cid,$codes) = @_;
1.620     albertel 3858:     $cid=$env{'request.course.id'} unless (defined($cid));
1.351     www      3859:     my %coursehash=&coursedescription($cid);
1.988     raeburn  3860:     my $crstype = &Apache::loncommon::course_type($cid);
1.470     www      3861:     my %nothide=();
1.800     albertel 3862:     foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937     raeburn  3863:         if ($user !~ /:/) {
                   3864: 	    $nothide{join(':',split(/[\@]/,$user))}=1;
                   3865:         } else {
                   3866:             $nothide{$user}=1;
                   3867:         }
1.470     www      3868:     }
1.351     www      3869:     my %returnhash=();
                   3870:     my %dumphash=
                   3871:             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
                   3872:     my $now=time;
1.997     raeburn  3873:     my %privileged;
1.1000    raeburn  3874:     foreach my $entry (keys(%dumphash)) {
1.800     albertel 3875: 	my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351     www      3876:         if (($tstart) && ($tstart<0)) { next; }
                   3877:         if (($tend) && ($tend<$now)) { next; }
                   3878:         if (($tstart) && ($now<$tstart)) { next; }
1.800     albertel 3879:         my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576     albertel 3880: 	if ($username eq '' || $domain eq '') { next; }
1.997     raeburn  3881:         unless (ref($privileged{$domain}) eq 'HASH') {
                   3882:             my %dompersonnel =
1.998     raeburn  3883:                 &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997     raeburn  3884:             $privileged{$domain} = {};
                   3885:             foreach my $server (keys(%dompersonnel)) {
1.999     raeburn  3886:                 if (ref($dompersonnel{$server}) eq 'HASH') {
1.997     raeburn  3887:                     foreach my $user (keys(%{$dompersonnel{$server}})) {
                   3888:                         my ($trole,$uname,$udom) = split(/:/,$user);
                   3889:                         $privileged{$udom}{$uname} = 1;
                   3890:                     }
                   3891:                 }
                   3892:             }
                   3893:         }
                   3894:         if ((exists($privileged{$domain}{$username})) && 
                   3895:             (!$nothide{$username.':'.$domain})) { next; }
1.656     albertel 3896: 	if ($role eq 'cr') { next; }
1.948     raeburn  3897:         if ($codes) {
                   3898:             if ($section) { $role .= ':'.$section; }
                   3899:             if ($returnhash{$role}) {
                   3900:                 $returnhash{$role}.=','.$username.':'.$domain;
                   3901:             } else {
                   3902:                 $returnhash{$role}=$username.':'.$domain;
                   3903:             }
1.351     www      3904:         } else {
1.988     raeburn  3905:             my $key=&plaintext($role,$crstype);
1.973     bisitz   3906:             if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948     raeburn  3907:             if ($returnhash{$key}) {
                   3908: 	        $returnhash{$key}.=','.$username.':'.$domain;
                   3909:             } else {
                   3910:                 $returnhash{$key}=$username.':'.$domain;
                   3911:             }
1.351     www      3912:         }
1.948     raeburn  3913:     }
1.400     www      3914:     return %returnhash;
                   3915: }
                   3916: 
                   3917: sub get_my_roles {
1.937     raeburn  3918:     my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620     albertel 3919:     unless (defined($uname)) { $uname=$env{'user.name'}; }
                   3920:     unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937     raeburn  3921:     my (%dumphash,%nothide);
1.1086    raeburn  3922:     if ($context eq 'userroles') {
1.1166    raeburn  3923:         %dumphash = &dump('roles',$udom,$uname);
1.858     raeburn  3924:     } else {
                   3925:         %dumphash=
1.400     www      3926:             &dump('nohist_userroles',$udom,$uname);
1.937     raeburn  3927:         if ($hidepriv) {
                   3928:             my %coursehash=&coursedescription($udom.'_'.$uname);
                   3929:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   3930:                 if ($user !~ /:/) {
                   3931:                     $nothide{join(':',split(/[\@]/,$user))} = 1;
                   3932:                 } else {
                   3933:                     $nothide{$user} = 1;
                   3934:                 }
                   3935:             }
                   3936:         }
1.858     raeburn  3937:     }
1.400     www      3938:     my %returnhash=();
                   3939:     my $now=time;
1.999     raeburn  3940:     my %privileged;
1.800     albertel 3941:     foreach my $entry (keys(%dumphash)) {
1.867     raeburn  3942:         my ($role,$tend,$tstart);
                   3943:         if ($context eq 'userroles') {
1.1149    raeburn  3944:             next if ($entry =~ /^rolesdef/);
1.867     raeburn  3945: 	    ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
                   3946:         } else {
                   3947:             ($tend,$tstart)=split(/\:/,$dumphash{$entry});
                   3948:         }
1.400     www      3949:         if (($tstart) && ($tstart<0)) { next; }
1.832     raeburn  3950:         my $status = 'active';
1.939     raeburn  3951:         if (($tend) && ($tend<=$now)) {
1.832     raeburn  3952:             $status = 'previous';
                   3953:         } 
                   3954:         if (($tstart) && ($now<$tstart)) {
                   3955:             $status = 'future';
                   3956:         }
                   3957:         if (ref($types) eq 'ARRAY') {
                   3958:             if (!grep(/^\Q$status\E$/,@{$types})) {
                   3959:                 next;
                   3960:             } 
                   3961:         } else {
                   3962:             if ($status ne 'active') {
                   3963:                 next;
                   3964:             }
                   3965:         }
1.867     raeburn  3966:         my ($rolecode,$username,$domain,$section,$area);
                   3967:         if ($context eq 'userroles') {
1.1186    raeburn  3968:             ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867     raeburn  3969:             (undef,$domain,$username,$section) = split(/\//,$area);
                   3970:         } else {
                   3971:             ($role,$username,$domain,$section) = split(/\:/,$entry);
                   3972:         }
1.832     raeburn  3973:         if (ref($roledoms) eq 'ARRAY') {
                   3974:             if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
                   3975:                 next;
                   3976:             }
                   3977:         }
                   3978:         if (ref($roles) eq 'ARRAY') {
                   3979:             if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922     raeburn  3980:                 if ($role =~ /^cr\//) {
                   3981:                     if (!grep(/^cr$/,@{$roles})) {
                   3982:                         next;
                   3983:                     }
1.1104    raeburn  3984:                 } elsif ($role =~ /^gr\//) {
                   3985:                     if (!grep(/^gr$/,@{$roles})) {
                   3986:                         next;
                   3987:                     }
1.922     raeburn  3988:                 } else {
                   3989:                     next;
                   3990:                 }
1.832     raeburn  3991:             }
1.867     raeburn  3992:         }
1.937     raeburn  3993:         if ($hidepriv) {
1.999     raeburn  3994:             if ($context eq 'userroles') {
                   3995:                 if ((&privileged($username,$domain)) &&
                   3996:                     (!$nothide{$username.':'.$domain})) {
                   3997:                     next;
                   3998:                 }
                   3999:             } else {
                   4000:                 unless (ref($privileged{$domain}) eq 'HASH') {
                   4001:                     my %dompersonnel =
                   4002:                         &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
                   4003:                     $privileged{$domain} = {};
                   4004:                     if (keys(%dompersonnel)) {
                   4005:                         foreach my $server (keys(%dompersonnel)) {
                   4006:                             if (ref($dompersonnel{$server}) eq 'HASH') {
                   4007:                                 foreach my $user (keys(%{$dompersonnel{$server}})) {
                   4008:                                     my ($trole,$uname,$udom) = split(/:/,$user);
                   4009:                                     $privileged{$udom}{$uname} = $trole;
                   4010:                                 }
                   4011:                             }
                   4012:                         }
                   4013:                     }
                   4014:                 }
                   4015:                 if (exists($privileged{$domain}{$username})) {
                   4016:                     if (!$nothide{$username.':'.$domain}) {
                   4017:                         next;
                   4018:                     }
                   4019:                 }
1.937     raeburn  4020:             }
                   4021:         }
1.933     raeburn  4022:         if ($withsec) {
                   4023:             $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
                   4024:                 $tstart.':'.$tend;
                   4025:         } else {
                   4026:             $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
                   4027:         }
1.832     raeburn  4028:     }
1.373     www      4029:     return %returnhash;
1.399     www      4030: }
                   4031: 
                   4032: # ----------------------------------------------------- Frontpage Announcements
                   4033: #
                   4034: #
                   4035: 
                   4036: sub postannounce {
                   4037:     my ($server,$text)=@_;
1.844     albertel 4038:     unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399     www      4039:     unless ($text=~/\w/) { $text=''; }
                   4040:     return &reply('setannounce:'.&escape($text),$server);
                   4041: }
                   4042: 
                   4043: sub getannounce {
1.448     albertel 4044: 
                   4045:     if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399     www      4046: 	my $announcement='';
1.800     albertel 4047: 	while (my $line = <$fh>) { $announcement .= $line; }
1.448     albertel 4048: 	close($fh);
1.399     www      4049: 	if ($announcement=~/\w/) { 
                   4050: 	    return 
                   4051:    '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518     albertel 4052:    '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 
1.399     www      4053: 	} else {
                   4054: 	    return '';
                   4055: 	}
                   4056:     } else {
                   4057: 	return '';
                   4058:     }
1.351     www      4059: }
1.353     www      4060: 
                   4061: # ---------------------------------------------------------- Course ID routines
                   4062: # Deal with domain's nohist_courseid.db files
                   4063: #
                   4064: 
                   4065: sub courseidput {
1.921     raeburn  4066:     my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054    raeburn  4067:     return unless (ref($storehash) eq 'HASH');
1.921     raeburn  4068:     my $outcome;
                   4069:     if ($caller eq 'timeonly') {
                   4070:         my $cids = '';
                   4071:         foreach my $item (keys(%$storehash)) {
                   4072:             $cids.=&escape($item).'&';
                   4073:         }
                   4074:         $cids=~s/\&$//;
                   4075:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
                   4076:                           $coursehome);       
                   4077:     } else {
                   4078:         my $items = '';
                   4079:         foreach my $item (keys(%$storehash)) {
                   4080:             $items.= &escape($item).'='.
                   4081:                      &freeze_escape($$storehash{$item}).'&';
                   4082:         }
                   4083:         $items=~s/\&$//;
                   4084:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
                   4085:                           $coursehome);
1.918     raeburn  4086:     }
                   4087:     if ($outcome eq 'unknown_cmd') {
                   4088:         my $what;
                   4089:         foreach my $cid (keys(%$storehash)) {
                   4090:             $what .= &escape($cid).'=';
1.921     raeburn  4091:             foreach my $item ('description','inst_code','owner','type') {
1.936     raeburn  4092:                 $what .= &escape($storehash->{$cid}{$item}).':';
1.918     raeburn  4093:             }
                   4094:             $what =~ s/\:$/&/;
                   4095:         }
                   4096:         $what =~ s/\&$//;  
                   4097:         return &reply('courseidput:'.$domain.':'.$what,$coursehome);
                   4098:     } else {
                   4099:         return $outcome;
                   4100:     }
1.353     www      4101: }
                   4102: 
                   4103: sub courseiddump {
1.921     raeburn  4104:     my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947     raeburn  4105:         $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029    raeburn  4106:         $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1071    raeburn  4107:         $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
1.918     raeburn  4108:     my $as_hash = 1;
                   4109:     my %returnhash;
                   4110:     if (!$domfilter) { $domfilter=''; }
1.845     albertel 4111:     my %libserv = &all_library();
                   4112:     foreach my $tryserver (keys(%libserv)) {
                   4113:         if ( (  $hostidflag == 1 
                   4114: 	        && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 
                   4115: 	     || (!defined($hostidflag)) ) {
                   4116: 
1.918     raeburn  4117: 	    if (($domfilter eq '') ||
                   4118: 		(&host_domain($tryserver) eq $domfilter)) {
1.1180    droeschl 4119:                 my $rep;
                   4120:                 if (grep { $_ eq $tryserver } current_machine_ids()) {
                   4121:                     $rep = LONCAPA::Lond::dump_course_id_handler(
                   4122:                         join(":", (&host_domain($tryserver), $sincefilter, 
                   4123:                                 &escape($descfilter), &escape($instcodefilter), 
                   4124:                                 &escape($ownerfilter), &escape($coursefilter),
                   4125:                                 &escape($typefilter), &escape($regexp_ok), 
                   4126:                                 $as_hash, &escape($selfenrollonly), 
                   4127:                                 &escape($catfilter), $showhidden, $caller, 
                   4128:                                 &escape($cloner), &escape($cc_clone), $cloneonly, 
                   4129:                                 &escape($createdbefore), &escape($createdafter), 
                   4130:                                 &escape($creationcontext), $domcloner)));
                   4131:                 } else {
                   4132:                     $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
                   4133:                              $sincefilter.':'.&escape($descfilter).':'.
                   4134:                              &escape($instcodefilter).':'.&escape($ownerfilter).
                   4135:                              ':'.&escape($coursefilter).':'.&escape($typefilter).
                   4136:                              ':'.&escape($regexp_ok).':'.$as_hash.':'.
                   4137:                              &escape($selfenrollonly).':'.&escape($catfilter).':'.
                   4138:                              $showhidden.':'.$caller.':'.&escape($cloner).':'.
                   4139:                              &escape($cc_clone).':'.$cloneonly.':'.
                   4140:                              &escape($createdbefore).':'.&escape($createdafter).':'.
                   4141:                              &escape($creationcontext).':'.$domcloner,
                   4142:                              $tryserver);
                   4143:                 }
                   4144:                      
1.918     raeburn  4145:                 my @pairs=split(/\&/,$rep);
                   4146:                 foreach my $item (@pairs) {
                   4147:                     my ($key,$value)=split(/\=/,$item,2);
                   4148:                     $key = &unescape($key);
                   4149:                     next if ($key =~ /^error: 2 /);
                   4150:                     my $result = &thaw_unescape($value);
                   4151:                     if (ref($result) eq 'HASH') {
                   4152:                         $returnhash{$key}=$result;
                   4153:                     } else {
1.921     raeburn  4154:                         my @responses = split(/:/,$value);
                   4155:                         my @items = ('description','inst_code','owner','type');
1.918     raeburn  4156:                         for (my $i=0; $i<@responses; $i++) {
1.921     raeburn  4157:                             $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918     raeburn  4158:                         }
1.1008    raeburn  4159:                     }
1.353     www      4160:                 }
                   4161:             }
                   4162:         }
                   4163:     }
                   4164:     return %returnhash;
                   4165: }
                   4166: 
1.1055    raeburn  4167: sub courselastaccess {
                   4168:     my ($cdom,$cnum,$hostidref) = @_;
                   4169:     my %returnhash;
                   4170:     if ($cdom && $cnum) {
                   4171:         my $chome = &homeserver($cnum,$cdom);
                   4172:         if ($chome ne 'no_host') {
                   4173:             my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
                   4174:             &extract_lastaccess(\%returnhash,$rep);
                   4175:         }
                   4176:     } else {
                   4177:         if (!$cdom) { $cdom=''; }
                   4178:         my %libserv = &all_library();
                   4179:         foreach my $tryserver (keys(%libserv)) {
                   4180:             if (ref($hostidref) eq 'ARRAY') {
                   4181:                 next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
                   4182:             } 
                   4183:             if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
                   4184:                 my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
                   4185:                 &extract_lastaccess(\%returnhash,$rep);
                   4186:             }
                   4187:         }
                   4188:     }
                   4189:     return %returnhash;
                   4190: }
                   4191: 
                   4192: sub extract_lastaccess {
                   4193:     my ($returnhash,$rep) = @_;
                   4194:     if (ref($returnhash) eq 'HASH') {
                   4195:         unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 
                   4196:                 $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
                   4197:                  $rep eq '') {
                   4198:             my @pairs=split(/\&/,$rep);
                   4199:             foreach my $item (@pairs) {
                   4200:                 my ($key,$value)=split(/\=/,$item,2);
                   4201:                 $key = &unescape($key);
                   4202:                 next if ($key =~ /^error: 2 /);
                   4203:                 $returnhash->{$key} = &thaw_unescape($value);
                   4204:             }
                   4205:         }
                   4206:     }
                   4207:     return;
                   4208: }
                   4209: 
1.658     raeburn  4210: # ---------------------------------------------------------- DC e-mail
1.662     raeburn  4211: 
                   4212: sub dcmailput {
1.685     raeburn  4213:     my ($domain,$msgid,$message,$server)=@_;
1.662     raeburn  4214:     my $status = &Apache::lonnet::critical(
1.740     www      4215:        'dcmailput:'.$domain.':'.&escape($msgid).'='.
                   4216:        &escape($message),$server);
1.662     raeburn  4217:     return $status;
                   4218: }
                   4219: 
1.658     raeburn  4220: sub dcmaildump {
                   4221:     my ($dom,$startdate,$enddate,$senders) = @_;
1.685     raeburn  4222:     my %returnhash=();
1.846     albertel 4223: 
                   4224:     if (defined(&domain($dom,'primary'))) {
1.685     raeburn  4225:         my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
                   4226:                                                          &escape($enddate).':';
                   4227: 	my @esc_senders=map { &escape($_)} @$senders;
                   4228: 	$cmd.=&escape(join('&',@esc_senders));
1.846     albertel 4229: 	foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800     albertel 4230:             my ($key,$value) = split(/\=/,$line,2);
1.685     raeburn  4231:             if (($key) && ($value)) {
                   4232:                 $returnhash{&unescape($key)} = &unescape($value);
1.658     raeburn  4233:             }
                   4234:         }
                   4235:     }
                   4236:     return %returnhash;
                   4237: }
1.662     raeburn  4238: # ---------------------------------------------------------- Domain roles
                   4239: 
                   4240: sub get_domain_roles {
                   4241:     my ($dom,$roles,$startdate,$enddate)=@_;
1.1018    raeburn  4242:     if ((!defined($startdate)) || ($startdate eq '')) {
1.662     raeburn  4243:         $startdate = '.';
                   4244:     }
1.1018    raeburn  4245:     if ((!defined($enddate)) || ($enddate eq '')) {
1.662     raeburn  4246:         $enddate = '.';
                   4247:     }
1.922     raeburn  4248:     my $rolelist;
                   4249:     if (ref($roles) eq 'ARRAY') {
                   4250:         $rolelist = join(':',@{$roles});
                   4251:     }
1.662     raeburn  4252:     my %personnel = ();
1.841     albertel 4253: 
                   4254:     my %servers = &get_servers($dom,'library');
                   4255:     foreach my $tryserver (keys(%servers)) {
                   4256: 	%{$personnel{$tryserver}}=();
                   4257: 	foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
                   4258: 					    &escape($startdate).':'.
                   4259: 					    &escape($enddate).':'.
                   4260: 					    &escape($rolelist), $tryserver))) {
                   4261: 	    my ($key,$value) = split(/\=/,$line,2);
                   4262: 	    if (($key) && ($value)) {
                   4263: 		$personnel{$tryserver}{&unescape($key)} = &unescape($value);
                   4264: 	    }
                   4265: 	}
1.662     raeburn  4266:     }
                   4267:     return %personnel;
                   4268: }
1.658     raeburn  4269: 
1.1057    www      4270: # ----------------------------------------------------------- Interval timing 
1.149     www      4271: 
1.1153    www      4272: {
                   4273: # Caches needed for speedup of navmaps
                   4274: # We don't want to cache this for very long at all (5 seconds at most)
                   4275: # 
                   4276: # The user for whom we cache
                   4277: my $cachedkey='';
                   4278: # The cached times for this user
                   4279: my %cachedtimes=();
                   4280: # When this was last done
                   4281: my $cachedtime=();
                   4282: 
                   4283: sub load_all_first_access {
1.1154    raeburn  4284:     my ($uname,$udom)=@_;
1.1156    www      4285:     if (($cachedkey eq $uname.':'.$udom) &&
1.1174    raeburn  4286:         (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154    raeburn  4287:         return;
                   4288:     }
                   4289:     $cachedtime=time;
                   4290:     $cachedkey=$uname.':'.$udom;
                   4291:     %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153    www      4292: }
                   4293: 
1.504     albertel 4294: sub get_first_access {
1.1162    raeburn  4295:     my ($type,$argsymb,$argmap)=@_;
1.790     albertel 4296:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 4297:     if ($argsymb) { $symb=$argsymb; }
                   4298:     my ($map,$id,$res)=&decode_symb($symb);
1.1162    raeburn  4299:     if ($argmap) { $map = $argmap; }
1.926     albertel 4300:     if ($type eq 'course') {
                   4301: 	$res='course';
                   4302:     } elsif ($type eq 'map') {
1.588     albertel 4303: 	$res=&symbread($map);
                   4304:     } else {
                   4305: 	$res=$symb;
                   4306:     }
1.1153    www      4307:     &load_all_first_access($uname,$udom);
                   4308:     return $cachedtimes{"$courseid\0$res"};
1.504     albertel 4309: }
                   4310: 
                   4311: sub set_first_access {
1.1162    raeburn  4312:     my ($type,$interval)=@_;
1.790     albertel 4313:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 4314:     my ($map,$id,$res)=&decode_symb($symb);
1.928     albertel 4315:     if ($type eq 'course') {
                   4316: 	$res='course';
                   4317:     } elsif ($type eq 'map') {
1.588     albertel 4318: 	$res=&symbread($map);
                   4319:     } else {
                   4320: 	$res=$symb;
                   4321:     }
1.1153    www      4322:     $cachedkey='';
1.1162    raeburn  4323:     my $firstaccess=&get_first_access($type,$symb,$map);
1.505     albertel 4324:     if (!$firstaccess) {
1.1162    raeburn  4325:         my $start = time;
                   4326: 	my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
                   4327:                           $udom,$uname);
                   4328:         if ($putres eq 'ok') {
                   4329:             &put('timerinterval',{"$courseid\0$res"=>$interval},
                   4330:                  $udom,$uname); 
                   4331:             &appenv(
                   4332:                      {
                   4333:                         'course.'.$courseid.'.firstaccess.'.$res   => $start,
                   4334:                         'course.'.$courseid.'.timerinterval.'.$res => $interval,
                   4335:                      }
                   4336:                   );
                   4337:         }
                   4338:         return $putres;
1.505     albertel 4339:     }
                   4340:     return 'already_set';
1.504     albertel 4341: }
1.1153    www      4342: }
1.110     www      4343: # --------------------------------------------- Set Expire Date for Spreadsheet
                   4344: 
                   4345: sub expirespread {
                   4346:     my ($uname,$udom,$stype,$usymb)=@_;
1.620     albertel 4347:     my $cid=$env{'request.course.id'}; 
1.110     www      4348:     if ($cid) {
                   4349:        my $now=time;
                   4350:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620     albertel 4351:        return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
                   4352:                             $env{'course.'.$cid.'.num'}.
1.110     www      4353: 	        	    ':nohist_expirationdates:'.
                   4354:                             &escape($key).'='.$now,
1.620     albertel 4355:                             $env{'course.'.$cid.'.home'})
1.110     www      4356:     }
                   4357:     return 'ok';
1.14      www      4358: }
                   4359: 
1.109     www      4360: # ----------------------------------------------------- Devalidate Spreadsheets
                   4361: 
                   4362: sub devalidate {
1.325     www      4363:     my ($symb,$uname,$udom)=@_;
1.620     albertel 4364:     my $cid=$env{'request.course.id'}; 
1.109     www      4365:     if ($cid) {
1.391     matthew  4366:         # delete the stored spreadsheets for
                   4367:         # - the student level sheet of this user in course's homespace
                   4368:         # - the assessment level sheet for this resource 
                   4369:         #   for this user in user's homespace
1.553     albertel 4370: 	# - current conditional state info
1.325     www      4371: 	my $key=$uname.':'.$udom.':';
1.109     www      4372:         my $status=
1.299     matthew  4373: 	    &del('nohist_calculatedsheets',
1.391     matthew  4374: 		 [$key.'studentcalc:'],
1.620     albertel 4375: 		 $env{'course.'.$cid.'.domain'},
                   4376: 		 $env{'course.'.$cid.'.num'})
1.133     albertel 4377: 		.' '.
                   4378: 	    &del('nohist_calculatedsheets_'.$cid,
1.391     matthew  4379: 		 [$key.'assesscalc:'.$symb],$udom,$uname);
1.109     www      4380:         unless ($status eq 'ok ok') {
                   4381:            &logthis('Could not devalidate spreadsheet '.
1.325     www      4382:                     $uname.' at '.$udom.' for '.
1.109     www      4383: 		    $symb.': '.$status);
1.133     albertel 4384:         }
1.553     albertel 4385: 	&delenv('user.state.'.$cid);
1.109     www      4386:     }
                   4387: }
                   4388: 
1.265     albertel 4389: sub get_scalar {
                   4390:     my ($string,$end) = @_;
                   4391:     my $value;
                   4392:     if ($$string =~ s/^([^&]*?)($end)/$2/) {
                   4393: 	$value = $1;
                   4394:     } elsif ($$string =~ s/^([^&]*?)&//) {
                   4395: 	$value = $1;
                   4396:     }
                   4397:     return &unescape($value);
                   4398: }
                   4399: 
                   4400: sub array2str {
                   4401:   my (@array) = @_;
                   4402:   my $result=&arrayref2str(\@array);
                   4403:   $result=~s/^__ARRAY_REF__//;
                   4404:   $result=~s/__END_ARRAY_REF__$//;
                   4405:   return $result;
                   4406: }
                   4407: 
1.204     albertel 4408: sub arrayref2str {
                   4409:   my ($arrayref) = @_;
1.265     albertel 4410:   my $result='__ARRAY_REF__';
1.204     albertel 4411:   foreach my $elem (@$arrayref) {
1.265     albertel 4412:     if(ref($elem) eq 'ARRAY') {
                   4413:       $result.=&arrayref2str($elem).'&';
                   4414:     } elsif(ref($elem) eq 'HASH') {
                   4415:       $result.=&hashref2str($elem).'&';
                   4416:     } elsif(ref($elem)) {
                   4417:       #print("Got a ref of ".(ref($elem))." skipping.");
1.204     albertel 4418:     } else {
                   4419:       $result.=&escape($elem).'&';
                   4420:     }
                   4421:   }
                   4422:   $result=~s/\&$//;
1.265     albertel 4423:   $result .= '__END_ARRAY_REF__';
1.204     albertel 4424:   return $result;
                   4425: }
                   4426: 
1.168     albertel 4427: sub hash2str {
1.204     albertel 4428:   my (%hash) = @_;
                   4429:   my $result=&hashref2str(\%hash);
1.265     albertel 4430:   $result=~s/^__HASH_REF__//;
                   4431:   $result=~s/__END_HASH_REF__$//;
1.204     albertel 4432:   return $result;
                   4433: }
                   4434: 
                   4435: sub hashref2str {
                   4436:   my ($hashref)=@_;
1.265     albertel 4437:   my $result='__HASH_REF__';
1.800     albertel 4438:   foreach my $key (sort(keys(%$hashref))) {
                   4439:     if (ref($key) eq 'ARRAY') {
                   4440:       $result.=&arrayref2str($key).'=';
                   4441:     } elsif (ref($key) eq 'HASH') {
                   4442:       $result.=&hashref2str($key).'=';
                   4443:     } elsif (ref($key)) {
1.265     albertel 4444:       $result.='=';
1.800     albertel 4445:       #print("Got a ref of ".(ref($key))." skipping.");
1.204     albertel 4446:     } else {
1.1132    raeburn  4447: 	if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204     albertel 4448:     }
                   4449: 
1.800     albertel 4450:     if(ref($hashref->{$key}) eq 'ARRAY') {
                   4451:       $result.=&arrayref2str($hashref->{$key}).'&';
                   4452:     } elsif(ref($hashref->{$key}) eq 'HASH') {
                   4453:       $result.=&hashref2str($hashref->{$key}).'&';
                   4454:     } elsif(ref($hashref->{$key})) {
1.265     albertel 4455:        $result.='&';
1.800     albertel 4456:       #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204     albertel 4457:     } else {
1.800     albertel 4458:       $result.=&escape($hashref->{$key}).'&';
1.204     albertel 4459:     }
                   4460:   }
1.168     albertel 4461:   $result=~s/\&$//;
1.265     albertel 4462:   $result .= '__END_HASH_REF__';
1.168     albertel 4463:   return $result;
                   4464: }
                   4465: 
                   4466: sub str2hash {
1.265     albertel 4467:     my ($string)=@_;
                   4468:     my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
                   4469:     return %$hash;
                   4470: }
                   4471: 
                   4472: sub str2hashref {
1.168     albertel 4473:   my ($string) = @_;
1.265     albertel 4474: 
                   4475:   my %hash;
                   4476: 
                   4477:   if($string !~ /^__HASH_REF__/) {
                   4478:       if (! ($string eq '' || !defined($string))) {
                   4479: 	  $hash{'error'}='Not hash reference';
                   4480:       }
                   4481:       return (\%hash, $string);
                   4482:   }
                   4483: 
                   4484:   $string =~ s/^__HASH_REF__//;
                   4485: 
                   4486:   while($string !~ /^__END_HASH_REF__/) {
                   4487:       #key
                   4488:       my $key='';
                   4489:       if($string =~ /^__HASH_REF__/) {
                   4490:           ($key, $string)=&str2hashref($string);
                   4491:           if(defined($key->{'error'})) {
                   4492:               $hash{'error'}='Bad data';
                   4493:               return (\%hash, $string);
                   4494:           }
                   4495:       } elsif($string =~ /^__ARRAY_REF__/) {
                   4496:           ($key, $string)=&str2arrayref($string);
                   4497:           if($key->[0] eq 'Array reference error') {
                   4498:               $hash{'error'}='Bad data';
                   4499:               return (\%hash, $string);
                   4500:           }
                   4501:       } else {
                   4502:           $string =~ s/^(.*?)=//;
1.267     albertel 4503: 	  $key=&unescape($1);
1.265     albertel 4504:       }
                   4505:       $string =~ s/^=//;
                   4506: 
                   4507:       #value
                   4508:       my $value='';
                   4509:       if($string =~ /^__HASH_REF__/) {
                   4510:           ($value, $string)=&str2hashref($string);
                   4511:           if(defined($value->{'error'})) {
                   4512:               $hash{'error'}='Bad data';
                   4513:               return (\%hash, $string);
                   4514:           }
                   4515:       } elsif($string =~ /^__ARRAY_REF__/) {
                   4516:           ($value, $string)=&str2arrayref($string);
                   4517:           if($value->[0] eq 'Array reference error') {
                   4518:               $hash{'error'}='Bad data';
                   4519:               return (\%hash, $string);
                   4520:           }
                   4521:       } else {
                   4522: 	  $value=&get_scalar(\$string,'__END_HASH_REF__');
                   4523:       }
                   4524:       $string =~ s/^&//;
                   4525: 
                   4526:       $hash{$key}=$value;
1.204     albertel 4527:   }
1.265     albertel 4528: 
                   4529:   $string =~ s/^__END_HASH_REF__//;
                   4530: 
                   4531:   return (\%hash, $string);
1.204     albertel 4532: }
                   4533: 
                   4534: sub str2array {
1.265     albertel 4535:     my ($string)=@_;
                   4536:     my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
                   4537:     return @$array;
                   4538: }
                   4539: 
                   4540: sub str2arrayref {
1.204     albertel 4541:   my ($string) = @_;
1.265     albertel 4542:   my @array;
                   4543: 
                   4544:   if($string !~ /^__ARRAY_REF__/) {
                   4545:       if (! ($string eq '' || !defined($string))) {
                   4546: 	  $array[0]='Array reference error';
                   4547:       }
                   4548:       return (\@array, $string);
                   4549:   }
                   4550: 
                   4551:   $string =~ s/^__ARRAY_REF__//;
                   4552: 
                   4553:   while($string !~ /^__END_ARRAY_REF__/) {
                   4554:       my $value='';
                   4555:       if($string =~ /^__HASH_REF__/) {
                   4556:           ($value, $string)=&str2hashref($string);
                   4557:           if(defined($value->{'error'})) {
                   4558:               $array[0] ='Array reference error';
                   4559:               return (\@array, $string);
                   4560:           }
                   4561:       } elsif($string =~ /^__ARRAY_REF__/) {
                   4562:           ($value, $string)=&str2arrayref($string);
                   4563:           if($value->[0] eq 'Array reference error') {
                   4564:               $array[0] ='Array reference error';
                   4565:               return (\@array, $string);
                   4566:           }
                   4567:       } else {
                   4568: 	  $value=&get_scalar(\$string,'__END_ARRAY_REF__');
                   4569:       }
                   4570:       $string =~ s/^&//;
                   4571: 
                   4572:       push(@array, $value);
1.191     harris41 4573:   }
1.265     albertel 4574: 
                   4575:   $string =~ s/^__END_ARRAY_REF__//;
                   4576: 
                   4577:   return (\@array, $string);
1.168     albertel 4578: }
                   4579: 
1.167     albertel 4580: # -------------------------------------------------------------------Temp Store
                   4581: 
1.168     albertel 4582: sub tmpreset {
                   4583:   my ($symb,$namespace,$domain,$stuname) = @_;
                   4584:   if (!$symb) {
                   4585:     $symb=&symbread();
1.620     albertel 4586:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 4587:   }
                   4588:   $symb=escape($symb);
                   4589: 
1.620     albertel 4590:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.168     albertel 4591:   $namespace=~s/\//\_/g;
                   4592:   $namespace=~s/\W//g;
                   4593: 
1.620     albertel 4594:   if (!$domain) { $domain=$env{'user.domain'}; }
                   4595:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 4596:   if ($domain eq 'public' && $stuname eq 'public') {
                   4597:       $stuname=$ENV{'REMOTE_ADDR'};
                   4598:   }
1.1117    foxr     4599:   my $path=LONCAPA::tempdir();
1.168     albertel 4600:   my %hash;
                   4601:   if (tie(%hash,'GDBM_File',
                   4602: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 4603: 	  &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  4604:     foreach my $key (keys(%hash)) {
1.180     albertel 4605:       if ($key=~ /:$symb/) {
1.168     albertel 4606: 	delete($hash{$key});
                   4607:       }
                   4608:     }
                   4609:   }
                   4610: }
                   4611: 
1.167     albertel 4612: sub tmpstore {
1.168     albertel 4613:   my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   4614: 
                   4615:   if (!$symb) {
                   4616:     $symb=&symbread();
1.620     albertel 4617:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 4618:   }
                   4619:   $symb=escape($symb);
                   4620: 
                   4621:   if (!$namespace) {
                   4622:     # I don't think we would ever want to store this for a course.
                   4623:     # it seems this will only be used if we don't have a course.
1.620     albertel 4624:     #$namespace=$env{'request.course.id'};
1.168     albertel 4625:     #if (!$namespace) {
1.620     albertel 4626:       $namespace=$env{'request.state'};
1.168     albertel 4627:     #}
                   4628:   }
                   4629:   $namespace=~s/\//\_/g;
                   4630:   $namespace=~s/\W//g;
1.620     albertel 4631:   if (!$domain) { $domain=$env{'user.domain'}; }
                   4632:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 4633:   if ($domain eq 'public' && $stuname eq 'public') {
                   4634:       $stuname=$ENV{'REMOTE_ADDR'};
                   4635:   }
1.168     albertel 4636:   my $now=time;
                   4637:   my %hash;
1.1117    foxr     4638:   my $path=LONCAPA::tempdir();
1.168     albertel 4639:   if (tie(%hash,'GDBM_File',
                   4640: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 4641: 	  &GDBM_WRCREAT(),0640)) {
1.168     albertel 4642:     $hash{"version:$symb"}++;
                   4643:     my $version=$hash{"version:$symb"};
                   4644:     my $allkeys=''; 
                   4645:     foreach my $key (keys(%$storehash)) {
                   4646:       $allkeys.=$key.':';
1.591     albertel 4647:       $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168     albertel 4648:     }
                   4649:     $hash{"$version:$symb:timestamp"}=$now;
                   4650:     $allkeys.='timestamp';
                   4651:     $hash{"$version:keys:$symb"}=$allkeys;
                   4652:     if (untie(%hash)) {
                   4653:       return 'ok';
                   4654:     } else {
                   4655:       return "error:$!";
                   4656:     }
                   4657:   } else {
                   4658:     return "error:$!";
                   4659:   }
                   4660: }
1.167     albertel 4661: 
1.168     albertel 4662: # -----------------------------------------------------------------Temp Restore
1.167     albertel 4663: 
1.168     albertel 4664: sub tmprestore {
                   4665:   my ($symb,$namespace,$domain,$stuname) = @_;
1.167     albertel 4666: 
1.168     albertel 4667:   if (!$symb) {
                   4668:     $symb=&symbread();
1.620     albertel 4669:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 4670:   }
                   4671:   $symb=escape($symb);
                   4672: 
1.620     albertel 4673:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.591     albertel 4674: 
1.620     albertel 4675:   if (!$domain) { $domain=$env{'user.domain'}; }
                   4676:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 4677:   if ($domain eq 'public' && $stuname eq 'public') {
                   4678:       $stuname=$ENV{'REMOTE_ADDR'};
                   4679:   }
1.168     albertel 4680:   my %returnhash;
                   4681:   $namespace=~s/\//\_/g;
                   4682:   $namespace=~s/\W//g;
                   4683:   my %hash;
1.1117    foxr     4684:   my $path=LONCAPA::tempdir();
1.168     albertel 4685:   if (tie(%hash,'GDBM_File',
                   4686: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 4687: 	  &GDBM_READER(),0640)) {
1.168     albertel 4688:     my $version=$hash{"version:$symb"};
                   4689:     $returnhash{'version'}=$version;
                   4690:     my $scope;
                   4691:     for ($scope=1;$scope<=$version;$scope++) {
                   4692:       my $vkeys=$hash{"$scope:keys:$symb"};
                   4693:       my @keys=split(/:/,$vkeys);
                   4694:       my $key;
                   4695:       $returnhash{"$scope:keys"}=$vkeys;
                   4696:       foreach $key (@keys) {
1.591     albertel 4697: 	$returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
                   4698: 	$returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167     albertel 4699:       }
                   4700:     }
1.168     albertel 4701:     if (!(untie(%hash))) {
                   4702:       return "error:$!";
                   4703:     }
                   4704:   } else {
                   4705:     return "error:$!";
                   4706:   }
                   4707:   return %returnhash;
1.167     albertel 4708: }
                   4709: 
1.9       www      4710: # ----------------------------------------------------------------------- Store
                   4711: 
                   4712: sub store {
1.124     www      4713:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   4714:     my $home='';
                   4715: 
1.168     albertel 4716:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      4717: 
1.213     www      4718:     $symb=&symbclean($symb);
1.122     albertel 4719:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      4720: 
1.620     albertel 4721:     if (!$domain) { $domain=$env{'user.domain'}; }
                   4722:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      4723: 
                   4724:     &devalidate($symb,$stuname,$domain);
1.109     www      4725: 
                   4726:     $symb=escape($symb);
1.187     www      4727:     if (!$namespace) { 
1.620     albertel 4728:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      4729:           return ''; 
                   4730:        } 
                   4731:     }
1.620     albertel 4732:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      4733: 
                   4734:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   4735:     $$storehash{'host'}=$perlvar{'lonHostID'};
                   4736: 
1.12      www      4737:     my $namevalue='';
1.800     albertel 4738:     foreach my $key (keys(%$storehash)) {
                   4739:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 4740:     }
1.12      www      4741:     $namevalue=~s/\&$//;
1.187     www      4742:     &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124     www      4743:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9       www      4744: }
                   4745: 
1.47      www      4746: # -------------------------------------------------------------- Critical Store
                   4747: 
                   4748: sub cstore {
1.124     www      4749:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   4750:     my $home='';
                   4751: 
1.168     albertel 4752:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      4753: 
1.213     www      4754:     $symb=&symbclean($symb);
1.122     albertel 4755:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      4756: 
1.620     albertel 4757:     if (!$domain) { $domain=$env{'user.domain'}; }
                   4758:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      4759: 
                   4760:     &devalidate($symb,$stuname,$domain);
1.109     www      4761: 
                   4762:     $symb=escape($symb);
1.187     www      4763:     if (!$namespace) { 
1.620     albertel 4764:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      4765:           return ''; 
                   4766:        } 
                   4767:     }
1.620     albertel 4768:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      4769: 
                   4770:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   4771:     $$storehash{'host'}=$perlvar{'lonHostID'};
1.122     albertel 4772: 
1.47      www      4773:     my $namevalue='';
1.800     albertel 4774:     foreach my $key (keys(%$storehash)) {
                   4775:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 4776:     }
1.47      www      4777:     $namevalue=~s/\&$//;
1.187     www      4778:     &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188     www      4779:     return critical
                   4780:                 ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47      www      4781: }
                   4782: 
1.9       www      4783: # --------------------------------------------------------------------- Restore
                   4784: 
                   4785: sub restore {
1.124     www      4786:     my ($symb,$namespace,$domain,$stuname) = @_;
                   4787:     my $home='';
                   4788: 
1.168     albertel 4789:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      4790: 
1.122     albertel 4791:     if (!$symb) {
                   4792:       unless ($symb=escape(&symbread())) { return ''; }
                   4793:     } else {
1.213     www      4794:       $symb=&escape(&symbclean($symb));
1.122     albertel 4795:     }
1.188     www      4796:     if (!$namespace) { 
1.620     albertel 4797:        unless ($namespace=$env{'request.course.id'}) { 
1.188     www      4798:           return ''; 
                   4799:        } 
                   4800:     }
1.620     albertel 4801:     if (!$domain) { $domain=$env{'user.domain'}; }
                   4802:     if (!$stuname) { $stuname=$env{'user.name'}; }
                   4803:     if (!$home) { $home=$env{'user.home'}; }
1.122     albertel 4804:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
                   4805: 
1.12      www      4806:     my %returnhash=();
1.800     albertel 4807:     foreach my $line (split(/\&/,$answer)) {
                   4808: 	my ($name,$value)=split(/\=/,$line);
1.591     albertel 4809:         $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191     harris41 4810:     }
1.75      www      4811:     my $version;
                   4812:     for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800     albertel 4813:        foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
                   4814:           $returnhash{$item}=$returnhash{$version.':'.$item};
1.191     harris41 4815:        }
1.75      www      4816:     }
1.13      www      4817:     return %returnhash;
1.34      www      4818: }
                   4819: 
                   4820: # ---------------------------------------------------------- Course Description
1.1118    foxr     4821: #
                   4822: #  
1.34      www      4823: 
                   4824: sub coursedescription {
1.731     albertel 4825:     my ($courseid,$args)=@_;
1.34      www      4826:     $courseid=~s/^\///;
1.49      www      4827:     $courseid=~s/\_/\//g;
1.34      www      4828:     my ($cdomain,$cnum)=split(/\//,$courseid);
1.129     albertel 4829:     my $chome=&homeserver($cnum,$cdomain);
1.302     albertel 4830:     my $normalid=$cdomain.'_'.$cnum;
                   4831:     # need to always cache even if we get errors otherwise we keep 
                   4832:     # trying and trying and trying to get the course description.
                   4833:     my %envhash=();
                   4834:     my %returnhash=();
1.731     albertel 4835:     
                   4836:     my $expiretime=600;
                   4837:     if ($env{'request.course.id'} eq $normalid) {
                   4838: 	$expiretime=120;
                   4839:     }
                   4840: 
                   4841:     my $prefix='course.'.$cdomain.'_'.$cnum.'.';
                   4842:     if (!$args->{'freshen_cache'}
                   4843: 	&& ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
                   4844: 	foreach my $key (keys(%env)) {
                   4845: 	    next if ($key !~ /^\Q$prefix\E(.*)/);
                   4846: 	    my ($setting) = $1;
                   4847: 	    $returnhash{$setting} = $env{$key};
                   4848: 	}
                   4849: 	return %returnhash;
                   4850:     }
                   4851: 
1.1118    foxr     4852:     # get the data again
                   4853: 
1.731     albertel 4854:     if (!$args->{'one_time'}) {
                   4855: 	$envhash{'course.'.$normalid.'.last_cache'}=time;
                   4856:     }
1.811     albertel 4857: 
1.34      www      4858:     if ($chome ne 'no_host') {
1.302     albertel 4859:        %returnhash=&dump('environment',$cdomain,$cnum);
1.129     albertel 4860:        if (!exists($returnhash{'con_lost'})) {
1.1118    foxr     4861: 	   my $username = $env{'user.name'}; # Defult username
                   4862: 	   if(defined $args->{'user'}) {
                   4863: 	       $username = $args->{'user'};
                   4864: 	   }
1.129     albertel 4865:            $returnhash{'home'}= $chome;
                   4866: 	   $returnhash{'domain'} = $cdomain;
                   4867: 	   $returnhash{'num'} = $cnum;
1.741     raeburn  4868:            if (!defined($returnhash{'type'})) {
                   4869:                $returnhash{'type'} = 'Course';
                   4870:            }
1.130     albertel 4871:            while (my ($name,$value) = each %returnhash) {
1.53      www      4872:                $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129     albertel 4873:            }
1.270     www      4874:            $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117    foxr     4875:            $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118    foxr     4876: 	       $username.'_'.$cdomain.'_'.$cnum;
1.60      www      4877:            $envhash{'course.'.$normalid.'.home'}=$chome;
                   4878:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
                   4879:            $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34      www      4880:        }
                   4881:     }
1.731     albertel 4882:     if (!$args->{'one_time'}) {
1.949     raeburn  4883: 	&appenv(\%envhash);
1.731     albertel 4884:     }
1.302     albertel 4885:     return %returnhash;
1.461     www      4886: }
                   4887: 
1.1080    raeburn  4888: sub update_released_required {
                   4889:     my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
                   4890:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   4891:         $cid = $env{'request.course.id'};
                   4892:         $cdom = $env{'course.'.$cid.'.domain'};
                   4893:         $cnum = $env{'course.'.$cid.'.num'};
                   4894:         $chome = $env{'course.'.$cid.'.home'};
                   4895:     }
                   4896:     if ($needsrelease) {
                   4897:         my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
                   4898:         my $needsupdate;
                   4899:         if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
                   4900:             $needsupdate = 1;
                   4901:         } else {
                   4902:             my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   4903:             my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
                   4904:             if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
                   4905:                 $needsupdate = 1;
                   4906:             }
                   4907:         }
                   4908:         if ($needsupdate) {
                   4909:             my %needshash = (
                   4910:                              'internal.releaserequired' => $needsrelease,
                   4911:                             );
                   4912:             my $putresult = &put('environment',\%needshash,$cdom,$cnum);
                   4913:             if ($putresult eq 'ok') {
                   4914:                 &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
                   4915:                 my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
                   4916:                 if (ref($crsinfo{$cid}) eq 'HASH') {
                   4917:                     $crsinfo{$cid}{'releaserequired'} = $needsrelease;
                   4918:                     &courseidput($cdom,\%crsinfo,$chome,'notime');
                   4919:                 }
                   4920:             }
                   4921:         }
                   4922:     }
                   4923:     return;
                   4924: }
                   4925: 
1.461     www      4926: # -------------------------------------------------See if a user is privileged
                   4927: 
                   4928: sub privileged {
                   4929:     my ($username,$domain)=@_;
1.1170    droeschl 4930: 
                   4931:     my %rolesdump = &dump("roles", $domain, $username) or return 0;
                   4932:     my $now = time;
                   4933: 
                   4934:     for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
                   4935:             my ($trole, $tend, $tstart) = split(/_/, $role);
                   4936:             if (($trole eq 'dc') || ($trole eq 'su')) {
                   4937:                 return 1 unless ($tend && $tend < $now) 
                   4938:                     or ($tstart && $tstart > $now);
                   4939:             }
1.461     www      4940: 	}
1.1170    droeschl 4941: 
1.461     www      4942:     return 0;
1.9       www      4943: }
1.1       albertel 4944: 
1.103     harris41 4945: # -------------------------------------------------------- Get user privileges
1.11      www      4946: 
                   4947: sub rolesinit {
1.1169    droeschl 4948:     my ($domain, $username) = @_;
                   4949:     my %userroles = ('user.login.time' => time);
                   4950:     my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
                   4951: 
                   4952:     # firstaccess and timerinterval are related to timed maps/resources. 
                   4953:     # also, blocking can be triggered by an activating timer
                   4954:     # it's saved in the user's %env.
                   4955:     my %firstaccess = &dump('firstaccesstimes', $domain, $username);
                   4956:     my %timerinterval = &dump('timerinterval', $domain, $username);
                   4957:     my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
                   4958:         %timerintchk, %timerintenv);
                   4959: 
1.1162    raeburn  4960:     foreach my $key (keys(%firstaccess)) {
1.1169    droeschl 4961:         my ($cid, $rest) = split(/\0/, $key);
1.1162    raeburn  4962:         $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
                   4963:     }
1.1169    droeschl 4964: 
1.1162    raeburn  4965:     foreach my $key (keys(%timerinterval)) {
                   4966:         my ($cid,$rest) = split(/\0/,$key);
                   4967:         $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
                   4968:     }
1.1169    droeschl 4969: 
1.11      www      4970:     my %allroles=();
1.1162    raeburn  4971:     my %allgroups=();
1.11      www      4972: 
1.1169    droeschl 4973:     for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
                   4974:         my $role = $rolesdump{$area};
                   4975:         $area =~ s/\_\w\w$//;
                   4976: 
                   4977:         my ($trole, $tend, $tstart, $group_privs);
                   4978: 
                   4979:         if ($role =~ /^cr/) {
                   4980:         # Custom role, defined by a user 
                   4981:         # e.g., user.role.cr/msu/smith/mynewrole
                   4982:             if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
                   4983:                 $trole = $1;
                   4984:                 ($tend, $tstart) = split('_', $2);
                   4985:             } else {
                   4986:                 $trole = $role;
                   4987:             }
                   4988:         } elsif ($role =~ m|^gr/|) {
                   4989:         # Role of member in a group, defined within a course/community
                   4990:         # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
                   4991:             ($trole, $tend, $tstart) = split(/_/, $role);
                   4992:             next if $tstart eq '-1';
                   4993:             ($trole, $group_privs) = split(/\//, $trole);
                   4994:             $group_privs = &unescape($group_privs);
                   4995:         } else {
                   4996:         # Just a normal role, defined in roles.tab
                   4997:             ($trole, $tend, $tstart) = split(/_/,$role);
                   4998:         }
                   4999: 
                   5000:         my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
                   5001:                  $username);
                   5002:         @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
                   5003: 
                   5004:         # role expired or not available yet?
                   5005:         $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or 
                   5006:             ($tstart != 0 && $tstart > $userroles{'user.login.time'});
                   5007: 
                   5008:         next if $area eq '' or $trole eq '';
                   5009: 
                   5010:         my $spec = "$trole.$area";
                   5011:         my ($tdummy, $tdomain, $trest) = split(/\//, $area);
                   5012: 
                   5013:         if ($trole =~ /^cr\//) {
                   5014:         # Custom role, defined by a user
                   5015:             &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
                   5016:         } elsif ($trole eq 'gr') {
                   5017:         # Role of a member in a group, defined within a course/community
                   5018:             &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
                   5019:             next;
                   5020:         } else {
                   5021:         # Normal role, defined in roles.tab
                   5022:             &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
                   5023:         }
                   5024: 
                   5025:         my $cid = $tdomain.'_'.$trest;
                   5026:         unless ($firstaccchk{$cid}) {
                   5027:             if (ref($coursetimerstarts{$cid}) eq 'HASH') {
                   5028:                 foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
                   5029:                     $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} = 
                   5030:                         $coursetimerstarts{$cid}{$item}; 
                   5031:                 }
                   5032:             }
                   5033:             $firstaccchk{$cid} = 1;
                   5034:         }
                   5035:         unless ($timerintchk{$cid}) {
                   5036:             if (ref($coursetimerintervals{$cid}) eq 'HASH') {
                   5037:                 foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
                   5038:                     $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
                   5039:                        $coursetimerintervals{$cid}{$item};
1.1162    raeburn  5040:                 }
1.12      www      5041:             }
1.1169    droeschl 5042:             $timerintchk{$cid} = 1;
1.191     harris41 5043:         }
1.11      www      5044:     }
1.1169    droeschl 5045: 
                   5046:     @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
                   5047:         \%allroles, \%allgroups);
                   5048:     $env{'user.adv'} = $userroles{'user.adv'};
                   5049: 
1.1162    raeburn  5050:     return (\%userroles,\%firstaccenv,\%timerintenv);
1.11      www      5051: }
                   5052: 
1.567     raeburn  5053: sub set_arearole {
                   5054:     my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
                   5055: # log the associated role with the area
                   5056:     &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743     albertel 5057:     return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567     raeburn  5058: }
                   5059: 
                   5060: sub custom_roleprivs {
                   5061:     my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
                   5062:     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
                   5063:     my $homsvr=homeserver($rauthor,$rdomain);
1.838     albertel 5064:     if (&hostname($homsvr) ne '') {
1.567     raeburn  5065:         my ($rdummy,$roledef)=
                   5066:             &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
                   5067:         if (($rdummy ne 'con_lost') && ($roledef ne '')) {
                   5068:             my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
                   5069:             if (defined($syspriv)) {
1.1043    raeburn  5070:                 if ($trest =~ /^$match_community$/) {
                   5071:                     $syspriv =~ s/bre\&S//; 
                   5072:                 }
1.567     raeburn  5073:                 $$allroles{'cm./'}.=':'.$syspriv;
                   5074:                 $$allroles{$spec.'./'}.=':'.$syspriv;
                   5075:             }
                   5076:             if ($tdomain ne '') {
                   5077:                 if (defined($dompriv)) {
                   5078:                     $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
                   5079:                     $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
                   5080:                 }
                   5081:                 if (($trest ne '') && (defined($coursepriv))) {
                   5082:                     $$allroles{'cm.'.$area}.=':'.$coursepriv;
                   5083:                     $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
                   5084:                 }
                   5085:             }
                   5086:         }
                   5087:     }
                   5088: }
                   5089: 
1.678     raeburn  5090: sub group_roleprivs {
                   5091:     my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
                   5092:     my $access = 1;
                   5093:     my $now = time;
                   5094:     if (($tend!=0) && ($tend<$now)) { $access = 0; }
                   5095:     if (($tstart!=0) && ($tstart>$now)) { $access=0; }
                   5096:     if ($access) {
1.811     albertel 5097:         my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678     raeburn  5098:         $$allgroups{$course}{$group} .=':'.$group_privs;
                   5099:     }
                   5100: }
1.567     raeburn  5101: 
                   5102: sub standard_roleprivs {
                   5103:     my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
                   5104:     if (defined($pr{$trole.':s'})) {
                   5105:         $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
                   5106:         $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
                   5107:     }
                   5108:     if ($tdomain ne '') {
                   5109:         if (defined($pr{$trole.':d'})) {
                   5110:             $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   5111:             $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   5112:         }
                   5113:         if (($trest ne '') && (defined($pr{$trole.':c'}))) {
                   5114:             $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
                   5115:             $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
                   5116:         }
                   5117:     }
                   5118: }
                   5119: 
                   5120: sub set_userprivs {
1.1064    raeburn  5121:     my ($userroles,$allroles,$allgroups,$groups_roles) = @_; 
1.567     raeburn  5122:     my $author=0;
                   5123:     my $adv=0;
1.678     raeburn  5124:     my %grouproles = ();
                   5125:     if (keys(%{$allgroups}) > 0) {
1.1064    raeburn  5126:         my @groupkeys; 
1.1000    raeburn  5127:         foreach my $role (keys(%{$allroles})) {
1.1064    raeburn  5128:             push(@groupkeys,$role);
                   5129:         }
                   5130:         if (ref($groups_roles) eq 'HASH') {
                   5131:             foreach my $key (keys(%{$groups_roles})) {
                   5132:                 unless (grep(/^\Q$key\E$/,@groupkeys)) {
                   5133:                     push(@groupkeys,$key);
                   5134:                 }
                   5135:             }
                   5136:         }
                   5137:         if (@groupkeys > 0) {
                   5138:             foreach my $role (@groupkeys) {
                   5139:                 my ($trole,$area,$sec,$extendedarea);
                   5140:                 if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
                   5141:                     $trole = $1;
                   5142:                     $area = $2;
                   5143:                     $sec = $3;
                   5144:                     $extendedarea = $area.$sec;
                   5145:                     if (exists($$allgroups{$area})) {
                   5146:                         foreach my $group (keys(%{$$allgroups{$area}})) {
                   5147:                             my $spec = $trole.'.'.$extendedarea;
                   5148:                             $grouproles{$spec.'.'.$area.'/'.$group} = 
1.681     raeburn  5149:                                                 $$allgroups{$area}{$group};
1.1064    raeburn  5150:                         }
1.678     raeburn  5151:                     }
                   5152:                 }
                   5153:             }
                   5154:         }
                   5155:     }
1.800     albertel 5156:     foreach my $group (keys(%grouproles)) {
                   5157:         $$allroles{$group} = $grouproles{$group};
1.678     raeburn  5158:     }
1.800     albertel 5159:     foreach my $role (keys(%{$allroles})) {
                   5160:         my %thesepriv;
1.941     raeburn  5161:         if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800     albertel 5162:         foreach my $item (split(/:/,$$allroles{$role})) {
                   5163:             if ($item ne '') {
                   5164:                 my ($privilege,$restrictions)=split(/&/,$item);
1.567     raeburn  5165:                 if ($restrictions eq '') {
                   5166:                     $thesepriv{$privilege}='F';
                   5167:                 } elsif ($thesepriv{$privilege} ne 'F') {
                   5168:                     $thesepriv{$privilege}.=$restrictions;
                   5169:                 }
                   5170:                 if ($thesepriv{'adv'} eq 'F') { $adv=1; }
                   5171:             }
                   5172:         }
                   5173:         my $thesestr='';
1.1104    raeburn  5174:         foreach my $priv (sort(keys(%thesepriv))) {
1.800     albertel 5175: 	    $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
                   5176: 	}
                   5177:         $userroles->{'user.priv.'.$role} = $thesestr;
1.567     raeburn  5178:     }
                   5179:     return ($author,$adv);
                   5180: }
                   5181: 
1.994     raeburn  5182: sub role_status {
1.1104    raeburn  5183:     my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994     raeburn  5184:     my @pwhere = ();
                   5185:     if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
                   5186:         (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
                   5187:         unless (!defined($$role) || $$role eq '') {
                   5188:             $$where=join('.',@pwhere);
                   5189:             $$trolecode=$$role.'.'.$$where;
                   5190:             ($$tstart,$$tend)=split(/\./,$env{$rolekey});
                   5191:             $$tstatus='is';
1.1104    raeburn  5192:             if ($$tstart && $$tstart>$update) {
1.994     raeburn  5193:                 $$tstatus='future';
1.1034    raeburn  5194:                 if ($$tstart<$now) {
                   5195:                     if ($$tstart && $$tstart>$refresh) {
1.1002    raeburn  5196:                         if (($$where ne '') && ($$role ne '')) {
1.1064    raeburn  5197:                             my (%allroles,%allgroups,$group_privs,
                   5198:                                 %groups_roles,@rolecodes);
1.1002    raeburn  5199:                             my %userroles = (
                   5200:                                 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
                   5201:                             );
1.1064    raeburn  5202:                             @rolecodes = ('cm'); 
1.1002    raeburn  5203:                             my $spec=$$role.'.'.$$where;
                   5204:                             my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
                   5205:                             if ($$role =~ /^cr\//) {
                   5206:                                 &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064    raeburn  5207:                                 push(@rolecodes,'cr');
1.1002    raeburn  5208:                             } elsif ($$role eq 'gr') {
1.1064    raeburn  5209:                                 push(@rolecodes,$$role);
1.1002    raeburn  5210:                                 my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
                   5211:                                                     $env{'user.name'});
1.1064    raeburn  5212:                                 my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002    raeburn  5213:                                 (undef,my $group_privs) = split(/\//,$trole);
                   5214:                                 $group_privs = &unescape($group_privs);
                   5215:                                 &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064    raeburn  5216:                                 my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
1.1104    raeburn  5217:                                 &get_groups_roles($tdomain,$trest,
                   5218:                                                   \%course_roles,\@rolecodes,
                   5219:                                                   \%groups_roles);
1.1002    raeburn  5220:                             } else {
1.1064    raeburn  5221:                                 push(@rolecodes,$$role);
1.1002    raeburn  5222:                                 &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
                   5223:                             }
1.1064    raeburn  5224:                             my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
                   5225:                             &appenv(\%userroles,\@rolecodes);
1.1002    raeburn  5226:                             &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
                   5227:                         }
                   5228:                     }
1.1034    raeburn  5229:                     $$tstatus = 'is';
1.1002    raeburn  5230:                 }
1.994     raeburn  5231:             }
                   5232:             if ($$tend) {
1.1104    raeburn  5233:                 if ($$tend<$update) {
1.994     raeburn  5234:                     $$tstatus='expired';
                   5235:                 } elsif ($$tend<$now) {
                   5236:                     $$tstatus='will_not';
                   5237:                 }
                   5238:             }
                   5239:         }
                   5240:     }
                   5241: }
                   5242: 
1.1104    raeburn  5243: sub get_groups_roles {
                   5244:     my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
                   5245:     return unless((ref($cdom_courseroles) eq 'HASH') && 
                   5246:                   (ref($rolecodes) eq 'ARRAY') && 
                   5247:                   (ref($groups_roles) eq 'HASH')); 
                   5248:     if (keys(%{$cdom_courseroles}) > 0) {
                   5249:         my ($cnum) = ($rest =~ /^($match_courseid)/);
                   5250:         if ($cdom ne '' && $cnum ne '') {
                   5251:             foreach my $key (keys(%{$cdom_courseroles})) {
                   5252:                 if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
                   5253:                     my $crsrole = $1;
                   5254:                     my $crssec = $2;
                   5255:                     if ($crsrole =~ /^cr/) {
                   5256:                         unless (grep(/^cr$/,@{$rolecodes})) {
                   5257:                             push(@{$rolecodes},'cr');
                   5258:                         }
                   5259:                     } else {
                   5260:                         unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
                   5261:                             push(@{$rolecodes},$crsrole);
                   5262:                         }
                   5263:                     }
                   5264:                     my $rolekey = "$crsrole./$cdom/$cnum";
                   5265:                     if ($crssec ne '') {
                   5266:                         $rolekey .= "/$crssec";
                   5267:                     }
                   5268:                     $rolekey .= './';
                   5269:                     $groups_roles->{$rolekey} = $rolecodes;
                   5270:                 }
                   5271:             }
                   5272:         }
                   5273:     }
                   5274:     return;
                   5275: }
                   5276: 
                   5277: sub delete_env_groupprivs {
                   5278:     my ($where,$courseroles,$possroles) = @_;
                   5279:     return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
                   5280:     my ($dummy,$udom,$uname,$group) = split(/\//,$where);
                   5281:     unless (ref($courseroles->{$udom}) eq 'HASH') {
                   5282:         %{$courseroles->{$udom}} =
                   5283:             &get_my_roles('','','userroles',['active'],
                   5284:                           $possroles,[$udom],1);
                   5285:     }
                   5286:     if (ref($courseroles->{$udom}) eq 'HASH') {
                   5287:         foreach my $item (keys(%{$courseroles->{$udom}})) {
                   5288:             my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
                   5289:             my $area = '/'.$cdom.'/'.$cnum;
                   5290:             my $privkey = "user.priv.$crsrole.$area";
                   5291:             if ($crssec ne '') {
                   5292:                 $privkey .= '/'.$crssec;
                   5293:             }
                   5294:             $privkey .= ".$area/$group";
                   5295:             &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
                   5296:         }
                   5297:     }
                   5298:     return;
                   5299: }
                   5300: 
1.994     raeburn  5301: sub check_adhoc_privs {
1.1104    raeburn  5302:     my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
1.994     raeburn  5303:     my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1185    raeburn  5304:     my $setprivs;
1.994     raeburn  5305:     if ($env{$cckey}) {
                   5306:         my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104    raeburn  5307:         &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994     raeburn  5308:         unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1088    raeburn  5309:             &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185    raeburn  5310:             $setprivs = 1;
1.994     raeburn  5311:         }
                   5312:     } else {
1.1088    raeburn  5313:         &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185    raeburn  5314:         $setprivs = 1;
1.994     raeburn  5315:     }
1.1185    raeburn  5316:     return $setprivs;
1.994     raeburn  5317: }
                   5318: 
                   5319: sub set_adhoc_privileges {
                   5320: # role can be cc or ca
1.1088    raeburn  5321:     my ($dcdom,$pickedcourse,$role,$caller) = @_;
1.994     raeburn  5322:     my $area = '/'.$dcdom.'/'.$pickedcourse;
                   5323:     my $spec = $role.'.'.$area;
                   5324:     my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
                   5325:                                   $env{'user.name'});
                   5326:     my %ccrole = ();
                   5327:     &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
                   5328:     my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
                   5329:     &appenv(\%userroles,[$role,'cm']);
                   5330:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
1.1088    raeburn  5331:     unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
                   5332:         &appenv( {'request.role'        => $spec,
                   5333:                   'request.role.domain' => $dcdom,
                   5334:                   'request.course.sec'  => ''
                   5335:                  }
                   5336:                );
                   5337:         my $tadv=0;
                   5338:         if (&allowed('adv') eq 'F') { $tadv=1; }
                   5339:         &appenv({'request.role.adv'    => $tadv});
                   5340:     }
1.994     raeburn  5341: }
                   5342: 
1.12      www      5343: # --------------------------------------------------------------- get interface
                   5344: 
                   5345: sub get {
1.131     albertel 5346:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      5347:    my $items='';
1.800     albertel 5348:    foreach my $item (@$storearr) {
                   5349:        $items.=&escape($item).'&';
1.191     harris41 5350:    }
1.12      www      5351:    $items=~s/\&$//;
1.620     albertel 5352:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5353:    if (!$uname) { $uname=$env{'user.name'}; }
1.131     albertel 5354:    my $uhome=&homeserver($uname,$udomain);
                   5355: 
1.133     albertel 5356:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      5357:    my @pairs=split(/\&/,$rep);
1.273     albertel 5358:    if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   5359:      return @pairs;
                   5360:    }
1.15      www      5361:    my %returnhash=();
1.42      www      5362:    my $i=0;
1.800     albertel 5363:    foreach my $item (@$storearr) {
                   5364:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      5365:       $i++;
1.191     harris41 5366:    }
1.15      www      5367:    return %returnhash;
1.27      www      5368: }
                   5369: 
                   5370: # --------------------------------------------------------------- del interface
                   5371: 
                   5372: sub del {
1.133     albertel 5373:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.27      www      5374:    my $items='';
1.800     albertel 5375:    foreach my $item (@$storearr) {
                   5376:        $items.=&escape($item).'&';
1.191     harris41 5377:    }
1.984     neumanie 5378: 
1.27      www      5379:    $items=~s/\&$//;
1.620     albertel 5380:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5381:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 5382:    my $uhome=&homeserver($uname,$udomain);
                   5383:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      5384: }
                   5385: 
                   5386: # -------------------------------------------------------------- dump interface
                   5387: 
1.1180    droeschl 5388: sub unserialize {
                   5389:     my ($rep, $escapedkeys) = @_;
                   5390: 
                   5391:     return {} if $rep =~ /^error/;
                   5392: 
                   5393:     my %returnhash=();
                   5394: 	foreach my $item (split /\&/, $rep) {
                   5395: 	    my ($key, $value) = split(/=/, $item, 2);
                   5396: 	    $key = unescape($key) unless $escapedkeys;
                   5397: 	    next if $key =~ /^error: 2 /;
                   5398: 	    $returnhash{$key} = Apache::lonnet::thaw_unescape($value);
                   5399: 	}
                   5400:     #return %returnhash;
                   5401:     return \%returnhash;
                   5402: }        
                   5403: 
                   5404: # see Lond::dump_with_regexp
                   5405: # if $escapedkeys hash keys won't get unescaped.
1.15      www      5406: sub dump {
1.1180    droeschl 5407:     my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755     albertel 5408:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5409:     if (!$uname) { $uname=$env{'user.name'}; }
                   5410:     my $uhome=&homeserver($uname,$udomain);
1.1167    droeschl 5411: 
1.1180    droeschl 5412:     my $reply;
                   5413:     if (grep { $_ eq $uhome } current_machine_ids()) {
                   5414:         # user is hosted on this machine
                   5415:         $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
                   5416:                     $uname, $namespace, $regexp, $range)), $loncaparevs{$uhome});
                   5417:         return %{unserialize($reply, $escapedkeys)};
                   5418:     }
1.755     albertel 5419:     if ($regexp) {
                   5420: 	$regexp=&escape($regexp);
                   5421:     } else {
                   5422: 	$regexp='.';
                   5423:     }
1.1166    raeburn  5424:     my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755     albertel 5425:     my @pairs=split(/\&/,$rep);
                   5426:     my %returnhash=();
1.1098    foxr     5427:     if (!($rep =~ /^error/ )) {
                   5428: 	foreach my $item (@pairs) {
                   5429: 	    my ($key,$value)=split(/=/,$item,2);
1.1180    droeschl 5430:         $key = unescape($key) unless $escapedkeys;
                   5431:         #$key = &unescape($key);
1.1098    foxr     5432: 	    next if ($key =~ /^error: 2 /);
                   5433: 	    $returnhash{$key}=&thaw_unescape($value);
                   5434: 	}
1.755     albertel 5435:     }
                   5436:     return %returnhash;
1.407     www      5437: }
                   5438: 
1.1098    foxr     5439: 
1.717     albertel 5440: # --------------------------------------------------------- dumpstore interface
                   5441: 
                   5442: sub dumpstore {
                   5443:    my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180    droeschl 5444:    # same as dump but keys must be escaped. They may contain colon separated
                   5445:    # lists of values that may themself contain colons (e.g. symbs).
                   5446:    return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717     albertel 5447: }
                   5448: 
1.407     www      5449: # -------------------------------------------------------------- keys interface
                   5450: 
                   5451: sub getkeys {
                   5452:    my ($namespace,$udomain,$uname)=@_;
1.620     albertel 5453:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5454:    if (!$uname) { $uname=$env{'user.name'}; }
1.407     www      5455:    my $uhome=&homeserver($uname,$udomain);
                   5456:    my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
                   5457:    my @keyarray=();
1.800     albertel 5458:    foreach my $key (split(/\&/,$rep)) {
1.812     raeburn  5459:       next if ($key =~ /^error: 2 /);
1.800     albertel 5460:       push(@keyarray,&unescape($key));
1.407     www      5461:    }
                   5462:    return @keyarray;
1.318     matthew  5463: }
                   5464: 
1.319     matthew  5465: # --------------------------------------------------------------- currentdump
                   5466: sub currentdump {
1.328     matthew  5467:    my ($courseid,$sdom,$sname)=@_;
1.620     albertel 5468:    $courseid = $env{'request.course.id'} if (! defined($courseid));
                   5469:    $sdom     = $env{'user.domain'}       if (! defined($sdom));
                   5470:    $sname    = $env{'user.name'}         if (! defined($sname));
1.326     matthew  5471:    my $uhome = &homeserver($sname,$sdom);
1.1180    droeschl 5472:    my $rep;
                   5473: 
                   5474:    if (grep { $_ eq $uhome } current_machine_ids()) {
                   5475:        $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname, 
                   5476:                    $courseid)));
                   5477:    } else {
                   5478:        $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
                   5479:    }
                   5480: 
1.318     matthew  5481:    return if ($rep =~ /^(error:|no_such_host)/);
1.319     matthew  5482:    #
1.318     matthew  5483:    my %returnhash=();
1.319     matthew  5484:    #
                   5485:    if ($rep eq "unknown_cmd") { 
                   5486:        # an old lond will not know currentdump
                   5487:        # Do a dump and make it look like a currentdump
1.822     albertel 5488:        my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319     matthew  5489:        return if ($tmp[0] =~ /^(error:|no_such_host)/);
                   5490:        my %hash = @tmp;
                   5491:        @tmp=();
1.424     matthew  5492:        %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319     matthew  5493:    } else {
                   5494:        my @pairs=split(/\&/,$rep);
1.800     albertel 5495:        foreach my $pair (@pairs) {
                   5496:            my ($key,$value)=split(/=/,$pair,2);
1.319     matthew  5497:            my ($symb,$param) = split(/:/,$key);
                   5498:            $returnhash{&unescape($symb)}->{&unescape($param)} = 
1.557     albertel 5499:                                                         &thaw_unescape($value);
1.319     matthew  5500:        }
1.191     harris41 5501:    }
1.12      www      5502:    return %returnhash;
1.424     matthew  5503: }
                   5504: 
                   5505: sub convert_dump_to_currentdump{
                   5506:     my %hash = %{shift()};
                   5507:     my %returnhash;
                   5508:     # Code ripped from lond, essentially.  The only difference
                   5509:     # here is the unescaping done by lonnet::dump().  Conceivably
                   5510:     # we might run in to problems with parameter names =~ /^v\./
                   5511:     while (my ($key,$value) = each(%hash)) {
                   5512:         my ($v,$symb,$param) = split(/:/,$key);
1.822     albertel 5513: 	$symb  = &unescape($symb);
                   5514: 	$param = &unescape($param);
1.424     matthew  5515:         next if ($v eq 'version' || $symb eq 'keys');
                   5516:         next if (exists($returnhash{$symb}) &&
                   5517:                  exists($returnhash{$symb}->{$param}) &&
                   5518:                  $returnhash{$symb}->{'v.'.$param} > $v);
                   5519:         $returnhash{$symb}->{$param}=$value;
                   5520:         $returnhash{$symb}->{'v.'.$param}=$v;
                   5521:     }
                   5522:     #
                   5523:     # Remove all of the keys in the hashes which keep track of
                   5524:     # the version of the parameter.
                   5525:     while (my ($symb,$param_hash) = each(%returnhash)) {
                   5526:         # use a foreach because we are going to delete from the hash.
                   5527:         foreach my $key (keys(%$param_hash)) {
                   5528:             delete($param_hash->{$key}) if ($key =~ /^v\./);
                   5529:         }
                   5530:     }
                   5531:     return \%returnhash;
1.12      www      5532: }
                   5533: 
1.627     albertel 5534: # ------------------------------------------------------ critical inc interface
                   5535: 
                   5536: sub cinc {
                   5537:     return &inc(@_,'critical');
                   5538: }
                   5539: 
1.449     matthew  5540: # --------------------------------------------------------------- inc interface
                   5541: 
                   5542: sub inc {
1.627     albertel 5543:     my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620     albertel 5544:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5545:     if (!$uname) { $uname=$env{'user.name'}; }
1.449     matthew  5546:     my $uhome=&homeserver($uname,$udomain);
                   5547:     my $items='';
                   5548:     if (! ref($store)) {
                   5549:         # got a single value, so use that instead
                   5550:         $items = &escape($store).'=&';
                   5551:     } elsif (ref($store) eq 'SCALAR') {
                   5552:         $items = &escape($$store).'=&';        
                   5553:     } elsif (ref($store) eq 'ARRAY') {
                   5554:         $items = join('=&',map {&escape($_);} @{$store});
                   5555:     } elsif (ref($store) eq 'HASH') {
                   5556:         while (my($key,$value) = each(%{$store})) {
                   5557:             $items.= &escape($key).'='.&escape($value).'&';
                   5558:         }
                   5559:     }
                   5560:     $items=~s/\&$//;
1.627     albertel 5561:     if ($critical) {
                   5562: 	return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
                   5563:     } else {
                   5564: 	return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
                   5565:     }
1.449     matthew  5566: }
                   5567: 
1.12      www      5568: # --------------------------------------------------------------- put interface
                   5569: 
                   5570: sub put {
1.134     albertel 5571:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 5572:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5573:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 5574:    my $uhome=&homeserver($uname,$udomain);
1.12      www      5575:    my $items='';
1.800     albertel 5576:    foreach my $item (keys(%$storehash)) {
                   5577:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 5578:    }
1.12      www      5579:    $items=~s/\&$//;
1.134     albertel 5580:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47      www      5581: }
                   5582: 
1.631     albertel 5583: # ------------------------------------------------------------ newput interface
                   5584: 
                   5585: sub newput {
                   5586:    my ($namespace,$storehash,$udomain,$uname)=@_;
                   5587:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5588:    if (!$uname) { $uname=$env{'user.name'}; }
                   5589:    my $uhome=&homeserver($uname,$udomain);
                   5590:    my $items='';
                   5591:    foreach my $key (keys(%$storehash)) {
                   5592:        $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   5593:    }
                   5594:    $items=~s/\&$//;
                   5595:    return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
                   5596: }
                   5597: 
                   5598: # ---------------------------------------------------------  putstore interface
                   5599: 
1.524     raeburn  5600: sub putstore {
1.715     albertel 5601:    my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620     albertel 5602:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5603:    if (!$uname) { $uname=$env{'user.name'}; }
1.524     raeburn  5604:    my $uhome=&homeserver($uname,$udomain);
                   5605:    my $items='';
1.715     albertel 5606:    foreach my $key (keys(%$storehash)) {
                   5607:        $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524     raeburn  5608:    }
1.715     albertel 5609:    $items=~s/\&$//;
1.716     albertel 5610:    my $esc_symb=&escape($symb);
                   5611:    my $esc_v=&escape($version);
1.715     albertel 5612:    my $reply =
1.716     albertel 5613:        &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715     albertel 5614: 	      $uhome);
                   5615:    if ($reply eq 'unknown_cmd') {
1.716     albertel 5616:        # gfall back to way things use to be done
1.715     albertel 5617:        return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
                   5618: 			    $uname);
1.524     raeburn  5619:    }
1.715     albertel 5620:    return $reply;
                   5621: }
                   5622: 
                   5623: sub old_putstore {
1.716     albertel 5624:     my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
                   5625:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5626:     if (!$uname) { $uname=$env{'user.name'}; }
                   5627:     my $uhome=&homeserver($uname,$udomain);
                   5628:     my %newstorehash;
1.800     albertel 5629:     foreach my $item (keys(%$storehash)) {
                   5630: 	my $key = $version.':'.&escape($symb).':'.$item;
                   5631: 	$newstorehash{$key} = $storehash->{$item};
1.716     albertel 5632:     }
                   5633:     my $items='';
                   5634:     my %allitems = ();
1.800     albertel 5635:     foreach my $item (keys(%newstorehash)) {
                   5636: 	if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716     albertel 5637: 	    my $key = $1.':keys:'.$2;
                   5638: 	    $allitems{$key} .= $3.':';
                   5639: 	}
1.800     albertel 5640: 	$items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716     albertel 5641:     }
1.800     albertel 5642:     foreach my $item (keys(%allitems)) {
                   5643: 	$allitems{$item} =~ s/\:$//;
                   5644: 	$items.= $item.'='.$allitems{$item}.'&';
1.716     albertel 5645:     }
                   5646:     $items=~s/\&$//;
                   5647:     return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524     raeburn  5648: }
                   5649: 
1.47      www      5650: # ------------------------------------------------------ critical put interface
                   5651: 
                   5652: sub cput {
1.134     albertel 5653:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 5654:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5655:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 5656:    my $uhome=&homeserver($uname,$udomain);
1.47      www      5657:    my $items='';
1.800     albertel 5658:    foreach my $item (keys(%$storehash)) {
                   5659:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 5660:    }
1.47      www      5661:    $items=~s/\&$//;
1.134     albertel 5662:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      5663: }
                   5664: 
                   5665: # -------------------------------------------------------------- eget interface
                   5666: 
                   5667: sub eget {
1.133     albertel 5668:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      5669:    my $items='';
1.800     albertel 5670:    foreach my $item (@$storearr) {
                   5671:        $items.=&escape($item).'&';
1.191     harris41 5672:    }
1.12      www      5673:    $items=~s/\&$//;
1.620     albertel 5674:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   5675:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 5676:    my $uhome=&homeserver($uname,$udomain);
                   5677:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      5678:    my @pairs=split(/\&/,$rep);
                   5679:    my %returnhash=();
1.42      www      5680:    my $i=0;
1.800     albertel 5681:    foreach my $item (@$storearr) {
                   5682:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      5683:       $i++;
1.191     harris41 5684:    }
1.12      www      5685:    return %returnhash;
                   5686: }
                   5687: 
1.667     albertel 5688: # ------------------------------------------------------------ tmpput interface
                   5689: sub tmpput {
1.802     raeburn  5690:     my ($storehash,$server,$context)=@_;
1.667     albertel 5691:     my $items='';
1.800     albertel 5692:     foreach my $item (keys(%$storehash)) {
                   5693: 	$items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667     albertel 5694:     }
                   5695:     $items=~s/\&$//;
1.802     raeburn  5696:     if (defined($context)) {
                   5697:         $items .= ':'.&escape($context);
                   5698:     }
1.667     albertel 5699:     return &reply("tmpput:$items",$server);
                   5700: }
                   5701: 
                   5702: # ------------------------------------------------------------ tmpget interface
                   5703: sub tmpget {
1.688     albertel 5704:     my ($token,$server)=@_;
                   5705:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   5706:     my $rep=&reply("tmpget:$token",$server);
1.667     albertel 5707:     my %returnhash;
                   5708:     foreach my $item (split(/\&/,$rep)) {
                   5709: 	my ($key,$value)=split(/=/,$item);
1.951     raeburn  5710:         next if ($key =~ /^error: 2 /);
1.667     albertel 5711: 	$returnhash{&unescape($key)}=&thaw_unescape($value);
                   5712:     }
                   5713:     return %returnhash;
                   5714: }
                   5715: 
1.1113    raeburn  5716: # ------------------------------------------------------------ tmpdel interface
1.688     albertel 5717: sub tmpdel {
                   5718:     my ($token,$server)=@_;
                   5719:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   5720:     return &reply("tmpdel:$token",$server);
                   5721: }
                   5722: 
1.1198    raeburn  5723: # ------------------------------------------------------------ get_timebased_id 
                   5724: 
                   5725: sub get_timebased_id {
                   5726:     my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
                   5727:         $maxtries) = @_;
                   5728:     my ($newid,$error,$dellock);
                   5729:     unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {  
                   5730:         return ('','ok','invalid call to get suffix');
                   5731:     }
                   5732: 
                   5733: # set defaults for any optional args for which values were not supplied
                   5734:     if ($who eq '') {
                   5735:         $who = $env{'user.name'}.':'.$env{'user.domain'};
                   5736:     }
                   5737:     if (!$locktries) {
                   5738:         $locktries = 3;
                   5739:     }
                   5740:     if (!$maxtries) {
                   5741:         $maxtries = 10;
                   5742:     }
                   5743:     
                   5744:     if (($cdom eq '') || ($cnum eq '')) {
                   5745:         if ($env{'request.course.id'}) {
                   5746:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   5747:             $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   5748:         }
                   5749:         if (($cdom eq '') || ($cnum eq '')) {
                   5750:             return ('','ok','call to get suffix not in course context');
                   5751:         }
                   5752:     }
                   5753: 
                   5754: # construct locking item
                   5755:     my $lockhash = {
                   5756:                       $prefix."\0".'locked_'.$keyid => $who,
                   5757:                    };
                   5758:     my $tries = 0;
                   5759: 
                   5760: # attempt to get lock on nohist_$namespace file
                   5761:     my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
                   5762:     while (($gotlock ne 'ok') && $tries <$locktries) {
                   5763:         $tries ++;
                   5764:         sleep 1;
                   5765:         $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
                   5766:     }
                   5767: 
                   5768: # attempt to get unique identifier, based on current timestamp
                   5769:     if ($gotlock eq 'ok') {
                   5770:         my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
                   5771:         my $id = time;
                   5772:         $newid = $id;
                   5773:         my $idtries = 0;
                   5774:         while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
                   5775:             if ($idtype eq 'concat') {
                   5776:                 $newid = $id.$idtries;
                   5777:             } else {
                   5778:                 $newid ++;
                   5779:             }
                   5780:             $idtries ++;
                   5781:         }
                   5782:         if (!exists($inuse{$prefix."\0".$newid})) {
                   5783:             my %new_item =  (
                   5784:                               $prefix."\0".$newid => $who,
                   5785:                             );
                   5786:             my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
                   5787:                                                  $cdom,$cnum);
                   5788:             if ($putresult ne 'ok') {
                   5789:                 undef($newid);
                   5790:                 $error = 'error saving new item: '.$putresult;
                   5791:             }
                   5792:         } else {
                   5793:              $error = ('error: no unique suffix available for the new item ');
                   5794:         }
                   5795: #  remove lock
                   5796:         my @del_lock = ($prefix."\0".'locked_'.$keyid);
                   5797:         $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
                   5798:     } else {
                   5799:         $error = "error: could not obtain lockfile\n";
                   5800:         $dellock = 'ok';
                   5801:     }
                   5802:     return ($newid,$dellock,$error);
                   5803: }
                   5804: 
1.765     albertel 5805: # -------------------------------------------------- portfolio access checking
                   5806: 
                   5807: sub portfolio_access {
1.766     albertel 5808:     my ($requrl) = @_;
1.765     albertel 5809:     my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
                   5810:     my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814     raeburn  5811:     if ($result) {
                   5812:         my %setters;
                   5813:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   5814:             my ($startblock,$endblock) =
                   5815:                 &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
                   5816:             if ($startblock && $endblock) {
                   5817:                 return 'B';
                   5818:             }
                   5819:         } else {
                   5820:             my ($startblock,$endblock) =
                   5821:                 &Apache::loncommon::blockcheck(\%setters,'port');
                   5822:             if ($startblock && $endblock) {
                   5823:                 return 'B';
                   5824:             }
                   5825:         }
                   5826:     }
1.765     albertel 5827:     if ($result eq 'ok') {
1.766     albertel 5828:        return 'F';
1.765     albertel 5829:     } elsif ($result =~ /^[^:]+:guest_/) {
1.766     albertel 5830:        return 'A';
1.765     albertel 5831:     }
1.766     albertel 5832:     return '';
1.765     albertel 5833: }
                   5834: 
                   5835: sub get_portfolio_access {
1.767     albertel 5836:     my ($udom,$unum,$file_name,$group,$access_hash) = @_;
                   5837: 
                   5838:     if (!ref($access_hash)) {
                   5839: 	my $current_perms = &get_portfile_permissions($udom,$unum);
                   5840: 	my %access_controls = &get_access_controls($current_perms,$group,
                   5841: 						   $file_name);
                   5842: 	$access_hash = $access_controls{$file_name};
                   5843:     }
                   5844: 
1.765     albertel 5845:     my ($public,$guest,@domains,@users,@courses,@groups);
                   5846:     my $now = time;
                   5847:     if (ref($access_hash) eq 'HASH') {
                   5848:         foreach my $key (keys(%{$access_hash})) {
                   5849:             my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
                   5850:             if ($start > $now) {
                   5851:                 next;
                   5852:             }
                   5853:             if ($end && $end<$now) {
                   5854:                 next;
                   5855:             }
                   5856:             if ($scope eq 'public') {
                   5857:                 $public = $key;
                   5858:                 last;
                   5859:             } elsif ($scope eq 'guest') {
                   5860:                 $guest = $key;
                   5861:             } elsif ($scope eq 'domains') {
                   5862:                 push(@domains,$key);
                   5863:             } elsif ($scope eq 'users') {
                   5864:                 push(@users,$key);
                   5865:             } elsif ($scope eq 'course') {
                   5866:                 push(@courses,$key);
                   5867:             } elsif ($scope eq 'group') {
                   5868:                 push(@groups,$key);
                   5869:             }
                   5870:         }
                   5871:         if ($public) {
                   5872:             return 'ok';
                   5873:         }
                   5874:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   5875:             if ($guest) {
                   5876:                 return $guest;
                   5877:             }
                   5878:         } else {
                   5879:             if (@domains > 0) {
                   5880:                 foreach my $domkey (@domains) {
                   5881:                     if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
                   5882:                         if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
                   5883:                             return 'ok';
                   5884:                         }
                   5885:                     }
                   5886:                 }
                   5887:             }
                   5888:             if (@users > 0) {
                   5889:                 foreach my $userkey (@users) {
1.865     raeburn  5890:                     if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
                   5891:                         foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
                   5892:                             if (ref($item) eq 'HASH') {
                   5893:                                 if (($item->{'uname'} eq $env{'user.name'}) &&
                   5894:                                     ($item->{'udom'} eq $env{'user.domain'})) {
                   5895:                                     return 'ok';
                   5896:                                 }
                   5897:                             }
                   5898:                         }
                   5899:                     } 
1.765     albertel 5900:                 }
                   5901:             }
                   5902:             my %roleshash;
                   5903:             my @courses_and_groups = @courses;
                   5904:             push(@courses_and_groups,@groups); 
                   5905:             if (@courses_and_groups > 0) {
                   5906:                 my (%allgroups,%allroles); 
                   5907:                 my ($start,$end,$role,$sec,$group);
                   5908:                 foreach my $envkey (%env) {
1.1060    raeburn  5909:                     if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 5910:                         my $cid = $2.'_'.$3; 
                   5911:                         if ($1 eq 'gr') {
                   5912:                             $group = $4;
                   5913:                             $allgroups{$cid}{$group} = $env{$envkey};
                   5914:                         } else {
                   5915:                             if ($4 eq '') {
                   5916:                                 $sec = 'none';
                   5917:                             } else {
                   5918:                                 $sec = $4;
                   5919:                             }
                   5920:                             $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   5921:                         }
1.811     albertel 5922:                     } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 5923:                         my $cid = $2.'_'.$3;
                   5924:                         if ($4 eq '') {
                   5925:                             $sec = 'none';
                   5926:                         } else {
                   5927:                             $sec = $4;
                   5928:                         }
                   5929:                         $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   5930:                     }
                   5931:                 }
                   5932:                 if (keys(%allroles) == 0) {
                   5933:                     return;
                   5934:                 }
                   5935:                 foreach my $key (@courses_and_groups) {
                   5936:                     my %content = %{$$access_hash{$key}};
                   5937:                     my $cnum = $content{'number'};
                   5938:                     my $cdom = $content{'domain'};
                   5939:                     my $cid = $cdom.'_'.$cnum;
                   5940:                     if (!exists($allroles{$cid})) {
                   5941:                         next;
                   5942:                     }    
                   5943:                     foreach my $role_id (keys(%{$content{'roles'}})) {
                   5944:                         my @sections = @{$content{'roles'}{$role_id}{'section'}};
                   5945:                         my @groups = @{$content{'roles'}{$role_id}{'group'}};
                   5946:                         my @status = @{$content{'roles'}{$role_id}{'access'}};
                   5947:                         my @roles = @{$content{'roles'}{$role_id}{'role'}};
                   5948:                         foreach my $role (keys(%{$allroles{$cid}})) {
                   5949:                             if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
                   5950:                                 foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
                   5951:                                     if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
                   5952:                                         if (grep/^all$/,@sections) {
                   5953:                                             return 'ok';
                   5954:                                         } else {
                   5955:                                             if (grep/^$sec$/,@sections) {
                   5956:                                                 return 'ok';
                   5957:                                             }
                   5958:                                         }
                   5959:                                     }
                   5960:                                 }
                   5961:                                 if (keys(%{$allgroups{$cid}}) == 0) {
                   5962:                                     if (grep/^none$/,@groups) {
                   5963:                                         return 'ok';
                   5964:                                     }
                   5965:                                 } else {
                   5966:                                     if (grep/^all$/,@groups) {
                   5967:                                         return 'ok';
                   5968:                                     } 
                   5969:                                     foreach my $group (keys(%{$allgroups{$cid}})) {
                   5970:                                         if (grep/^$group$/,@groups) {
                   5971:                                             return 'ok';
                   5972:                                         }
                   5973:                                     }
                   5974:                                 } 
                   5975:                             }
                   5976:                         }
                   5977:                     }
                   5978:                 }
                   5979:             }
                   5980:             if ($guest) {
                   5981:                 return $guest;
                   5982:             }
                   5983:         }
                   5984:     }
                   5985:     return;
                   5986: }
                   5987: 
                   5988: sub course_group_datechecker {
                   5989:     my ($dates,$now,$status) = @_;
                   5990:     my ($start,$end) = split(/\./,$dates);
                   5991:     if (!$start && !$end) {
                   5992:         return 'ok';
                   5993:     }
                   5994:     if (grep/^active$/,@{$status}) {
                   5995:         if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
                   5996:             return 'ok';
                   5997:         }
                   5998:     }
                   5999:     if (grep/^previous$/,@{$status}) {
                   6000:         if ($end > $now ) {
                   6001:             return 'ok';
                   6002:         }
                   6003:     }
                   6004:     if (grep/^future$/,@{$status}) {
                   6005:         if ($start > $now) {
                   6006:             return 'ok';
                   6007:         }
                   6008:     }
                   6009:     return; 
                   6010: }
                   6011: 
                   6012: sub parse_portfolio_url {
                   6013:     my ($url) = @_;
                   6014: 
                   6015:     my ($type,$udom,$unum,$group,$file_name);
                   6016:     
1.823     albertel 6017:     if ($url =~  m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765     albertel 6018: 	$type = 1;
                   6019:         $udom = $1;
                   6020:         $unum = $2;
                   6021:         $file_name = $3;
1.823     albertel 6022:     } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765     albertel 6023: 	$type = 2;
                   6024:         $udom = $1;
                   6025:         $unum = $2;
                   6026:         $group = $3;
                   6027:         $file_name = $3.'/'.$4;
                   6028:     }
                   6029:     if (wantarray) {
                   6030: 	return ($type,$udom,$unum,$file_name,$group);
                   6031:     }
                   6032:     return $type;
                   6033: }
                   6034: 
                   6035: sub is_portfolio_url {
                   6036:     my ($url) = @_;
                   6037:     return scalar(&parse_portfolio_url($url));
                   6038: }
                   6039: 
1.798     raeburn  6040: sub is_portfolio_file {
                   6041:     my ($file) = @_;
1.820     raeburn  6042:     if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798     raeburn  6043:         return 1;
                   6044:     }
                   6045:     return;
                   6046: }
                   6047: 
1.976     raeburn  6048: sub usertools_access {
1.1084    raeburn  6049:     my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985     raeburn  6050:     my ($access,%tools);
                   6051:     if ($context eq '') {
                   6052:         $context = 'tools';
                   6053:     }
                   6054:     if ($context eq 'requestcourses') {
                   6055:         %tools = (
                   6056:                       official   => 1,
                   6057:                       unofficial => 1,
1.1006    raeburn  6058:                       community  => 1,
1.985     raeburn  6059:                  );
1.1183    raeburn  6060:     } elsif ($context eq 'requestauthor') {
                   6061:         %tools = (
                   6062:                       requestauthor => 1,
                   6063:                  );
1.985     raeburn  6064:     } else {
                   6065:         %tools = (
                   6066:                       aboutme   => 1,
                   6067:                       blog      => 1,
1.1177    raeburn  6068:                       webdav    => 1,
1.985     raeburn  6069:                       portfolio => 1,
                   6070:                  );
                   6071:     }
1.976     raeburn  6072:     return if (!defined($tools{$tool}));
                   6073: 
                   6074:     if ((!defined($udom)) || (!defined($uname))) {
                   6075:         $udom = $env{'user.domain'};
                   6076:         $uname = $env{'user.name'};
                   6077:     }
                   6078: 
1.978     raeburn  6079:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
                   6080:         if ($action ne 'reload') {
1.985     raeburn  6081:             if ($context eq 'requestcourses') {
                   6082:                 return $env{'environment.canrequest.'.$tool};
1.1183    raeburn  6083:             } elsif ($context eq 'requestauthor') {
                   6084:                 return $env{'environment.canrequest.author'};
1.985     raeburn  6085:             } else {
                   6086:                 return $env{'environment.availabletools.'.$tool};
                   6087:             }
                   6088:         }
1.976     raeburn  6089:     }
                   6090: 
1.1183    raeburn  6091:     my ($toolstatus,$inststatus,$envkey);
                   6092:     if ($context eq 'requestauthor') {
                   6093:         $envkey = $context; 
                   6094:     } else {
                   6095:         $envkey = $context.'.'.$tool;
                   6096:     }
1.976     raeburn  6097: 
1.985     raeburn  6098:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
                   6099:          ($action ne 'reload')) {
1.1183    raeburn  6100:         $toolstatus = $env{'environment.'.$envkey};
1.976     raeburn  6101:         $inststatus = $env{'environment.inststatus'};
                   6102:     } else {
1.1084    raeburn  6103:         if (ref($userenvref) eq 'HASH') {
1.1183    raeburn  6104:             $toolstatus = $userenvref->{$envkey};
1.1084    raeburn  6105:             $inststatus = $userenvref->{'inststatus'};
                   6106:         } else {
1.1183    raeburn  6107:             my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
                   6108:             $toolstatus = $userenv{$envkey};
1.1084    raeburn  6109:             $inststatus = $userenv{'inststatus'};
                   6110:         }
1.976     raeburn  6111:     }
                   6112: 
                   6113:     if ($toolstatus ne '') {
                   6114:         if ($toolstatus) {
                   6115:             $access = 1;
                   6116:         } else {
                   6117:             $access = 0;
                   6118:         }
                   6119:         return $access;
                   6120:     }
                   6121: 
1.1084    raeburn  6122:     my ($is_adv,%domdef);
                   6123:     if (ref($is_advref) eq 'HASH') {
                   6124:         $is_adv = $is_advref->{'is_adv'};
                   6125:     } else {
                   6126:         $is_adv = &is_advanced_user($udom,$uname);
                   6127:     }
                   6128:     if (ref($domdefref) eq 'HASH') {
                   6129:         %domdef = %{$domdefref};
                   6130:     } else {
                   6131:         %domdef = &get_domain_defaults($udom);
                   6132:     }
1.976     raeburn  6133:     if (ref($domdef{$tool}) eq 'HASH') {
                   6134:         if ($is_adv) {
                   6135:             if ($domdef{$tool}{'_LC_adv'} ne '') {
                   6136:                 if ($domdef{$tool}{'_LC_adv'}) { 
                   6137:                     $access = 1;
                   6138:                 } else {
                   6139:                     $access = 0;
                   6140:                 }
                   6141:                 return $access;
                   6142:             }
                   6143:         }
                   6144:         if ($inststatus ne '') {
                   6145:             my ($hasaccess,$hasnoaccess);
                   6146:             foreach my $affiliation (split(/:/,$inststatus)) {
                   6147:                 if ($domdef{$tool}{$affiliation} ne '') { 
                   6148:                     if ($domdef{$tool}{$affiliation}) {
                   6149:                         $hasaccess = 1;
                   6150:                     } else {
                   6151:                         $hasnoaccess = 1;
                   6152:                     }
                   6153:                 }
                   6154:             }
                   6155:             if ($hasaccess || $hasnoaccess) {
                   6156:                 if ($hasaccess) {
                   6157:                     $access = 1;
                   6158:                 } elsif ($hasnoaccess) {
                   6159:                     $access = 0; 
                   6160:                 }
                   6161:                 return $access;
                   6162:             }
                   6163:         } else {
                   6164:             if ($domdef{$tool}{'default'} ne '') {
                   6165:                 if ($domdef{$tool}{'default'}) {
                   6166:                     $access = 1;
                   6167:                 } elsif ($domdef{$tool}{'default'} == 0) {
                   6168:                     $access = 0;
                   6169:                 }
                   6170:                 return $access;
                   6171:             }
                   6172:         }
                   6173:     } else {
1.1177    raeburn  6174:         if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985     raeburn  6175:             $access = 1;
                   6176:         } else {
                   6177:             $access = 0;
                   6178:         }
1.976     raeburn  6179:         return $access;
                   6180:     }
                   6181: }
                   6182: 
1.1050    raeburn  6183: sub is_course_owner {
                   6184:     my ($cdom,$cnum,$udom,$uname) = @_;
                   6185:     if (($udom eq '') || ($uname eq '')) {
                   6186:         $udom = $env{'user.domain'};
                   6187:         $uname = $env{'user.name'};
                   6188:     }
                   6189:     unless (($udom eq '') || ($uname eq '')) {
                   6190:         if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
                   6191:             if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
                   6192:                 return 1;
                   6193:             } else {
                   6194:                 my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
                   6195:                 if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
                   6196:                     return 1;
                   6197:                 }
                   6198:             }
                   6199:         }
                   6200:     }
                   6201:     return;
                   6202: }
                   6203: 
1.976     raeburn  6204: sub is_advanced_user {
                   6205:     my ($udom,$uname) = @_;
1.1085    raeburn  6206:     if ($udom ne '' && $uname ne '') {
                   6207:         if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128    raeburn  6208:             if (wantarray) {
                   6209:                 return ($env{'user.adv'},$env{'user.author'});
                   6210:             } else {
                   6211:                 return $env{'user.adv'};
                   6212:             }
1.1085    raeburn  6213:         }
                   6214:     }
1.976     raeburn  6215:     my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
                   6216:     my %allroles;
1.1128    raeburn  6217:     my ($is_adv,$is_author);
1.976     raeburn  6218:     foreach my $role (keys(%roleshash)) {
                   6219:         my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
                   6220:         my $area = '/'.$tdomain.'/'.$trest;
                   6221:         if ($sec ne '') {
                   6222:             $area .= '/'.$sec;
                   6223:         }
                   6224:         if (($area ne '') && ($trole ne '')) {
                   6225:             my $spec=$trole.'.'.$area;
                   6226:             if ($trole =~ /^cr\//) {
                   6227:                 &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
                   6228:             } elsif ($trole ne 'gr') {
                   6229:                 &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
                   6230:             }
1.1128    raeburn  6231:             if ($trole eq 'au') {
                   6232:                 $is_author = 1;
                   6233:             }
1.976     raeburn  6234:         }
                   6235:     }
                   6236:     foreach my $role (keys(%allroles)) {
                   6237:         last if ($is_adv);
                   6238:         foreach my $item (split(/:/,$allroles{$role})) {
                   6239:             if ($item ne '') {
                   6240:                 my ($privilege,$restrictions)=split(/&/,$item);
                   6241:                 if ($privilege eq 'adv') {
                   6242:                     $is_adv = 1;
                   6243:                     last;
                   6244:                 }
                   6245:             }
                   6246:         }
                   6247:     }
1.1128    raeburn  6248:     if (wantarray) {
                   6249:         return ($is_adv,$is_author);
                   6250:     }
1.976     raeburn  6251:     return $is_adv;
                   6252: }
1.798     raeburn  6253: 
1.1035    raeburn  6254: sub check_can_request {
1.1036    raeburn  6255:     my ($dom,$can_request,$request_domains) = @_;
1.1035    raeburn  6256:     my $canreq = 0;
                   6257:     my ($types,$typename) = &Apache::loncommon::course_types();
                   6258:     my @options = ('approval','validate','autolimit');
                   6259:     my $optregex = join('|',@options);
                   6260:     if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
                   6261:         foreach my $type (@{$types}) {
                   6262:             if (&usertools_access($env{'user.name'},
                   6263:                                   $env{'user.domain'},
                   6264:                                   $type,undef,'requestcourses')) {
                   6265:                 $canreq ++;
1.1036    raeburn  6266:                 if (ref($request_domains) eq 'HASH') {
                   6267:                     push(@{$request_domains->{$type}},$env{'user.domain'});
                   6268:                 }
1.1035    raeburn  6269:                 if ($dom eq $env{'user.domain'}) {
                   6270:                     $can_request->{$type} = 1;
                   6271:                 }
                   6272:             }
                   6273:             if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
                   6274:                 my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
                   6275:                 if (@curr > 0) {
1.1036    raeburn  6276:                     foreach my $item (@curr) {
                   6277:                         if (ref($request_domains) eq 'HASH') {
                   6278:                             my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
                   6279:                             if ($otherdom ne '') {
                   6280:                                 if (ref($request_domains->{$type}) eq 'ARRAY') {
                   6281:                                     unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
                   6282:                                         push(@{$request_domains->{$type}},$otherdom);
                   6283:                                     }
                   6284:                                 } else {
                   6285:                                     push(@{$request_domains->{$type}},$otherdom);
                   6286:                                 }
                   6287:                             }
                   6288:                         }
                   6289:                     }
                   6290:                     unless($dom eq $env{'user.domain'}) {
                   6291:                         $canreq ++;
1.1035    raeburn  6292:                         if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
                   6293:                             $can_request->{$type} = 1;
                   6294:                         }
                   6295:                     }
                   6296:                 }
                   6297:             }
                   6298:         }
                   6299:     }
                   6300:     return $canreq;
                   6301: }
                   6302: 
1.341     www      6303: # ---------------------------------------------- Custom access rule evaluation
                   6304: 
                   6305: sub customaccess {
                   6306:     my ($priv,$uri)=@_;
1.807     albertel 6307:     my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819     www      6308:     my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807     albertel 6309:     $udom = &LONCAPA::clean_domain($udom);
                   6310:     $ucrs = &LONCAPA::clean_username($ucrs);
1.341     www      6311:     my $access=0;
1.800     albertel 6312:     foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893     albertel 6313: 	my ($effect,$realm,$role,$type)=split(/\:/,$right);
                   6314: 	if ($type eq 'user') {
                   6315: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896     albertel 6316: 		my ($tdom,$tuname)=split(m{/},$scope);
1.893     albertel 6317: 		if ($tdom) {
                   6318: 		    if ($tdom ne $env{'user.domain'}) { next; }
                   6319: 		}
1.896     albertel 6320: 		if ($tuname) {
                   6321: 		    if ($tuname ne $env{'user.name'}) { next; }
1.893     albertel 6322: 		}
                   6323: 		$access=($effect eq 'allow');
                   6324: 		last;
                   6325: 	    }
                   6326: 	} else {
                   6327: 	    if ($role) {
                   6328: 		if ($role ne $urole) { next; }
                   6329: 	    }
                   6330: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
                   6331: 		my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
                   6332: 		if ($tdom) {
                   6333: 		    if ($tdom ne $udom) { next; }
                   6334: 		}
                   6335: 		if ($tcrs) {
                   6336: 		    if ($tcrs ne $ucrs) { next; }
                   6337: 		}
                   6338: 		if ($tsec) {
                   6339: 		    if ($tsec ne $usec) { next; }
                   6340: 		}
                   6341: 		$access=($effect eq 'allow');
                   6342: 		last;
                   6343: 	    }
                   6344: 	    if ($realm eq '' && $role eq '') {
                   6345: 		$access=($effect eq 'allow');
                   6346: 	    }
1.402     bowersj2 6347: 	}
1.341     www      6348:     }
                   6349:     return $access;
                   6350: }
                   6351: 
1.103     harris41 6352: # ------------------------------------------------- Check for a user privilege
1.12      www      6353: 
                   6354: sub allowed {
1.810     raeburn  6355:     my ($priv,$uri,$symb,$role)=@_;
1.705     albertel 6356:     my $ver_orguri=$uri;
1.439     www      6357:     $uri=&deversion($uri);
1.152     www      6358:     my $orguri=$uri;
1.52      www      6359:     $uri=&declutter($uri);
1.809     raeburn  6360: 
1.810     raeburn  6361:     if ($priv eq 'evb') {
                   6362: # Evade communication block restrictions for specified role in a course
                   6363:         if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
                   6364:             return $1;
                   6365:         } else {
                   6366:             return;
                   6367:         }
                   6368:     }
                   6369: 
1.620     albertel 6370:     if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54      www      6371: # Free bre access to adm and meta resources
1.775     albertel 6372:     if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$})) 
1.769     albertel 6373: 	 || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 
                   6374: 	&& ($priv eq 'bre')) {
1.14      www      6375: 	return 'F';
1.159     www      6376:     }
                   6377: 
1.545     banghart 6378: # Free bre access to user's own portfolio contents
1.714     raeburn  6379:     my ($space,$domain,$name,@dir)=split('/',$uri);
1.647     raeburn  6380:     if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 
1.714     raeburn  6381: 	($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814     raeburn  6382:         my %setters;
                   6383:         my ($startblock,$endblock) = 
                   6384:             &Apache::loncommon::blockcheck(\%setters,'port');
                   6385:         if ($startblock && $endblock) {
                   6386:             return 'B';
                   6387:         } else {
                   6388:             return 'F';
                   6389:         }
1.545     banghart 6390:     }
                   6391: 
1.762     raeburn  6392: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714     raeburn  6393:     if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 
                   6394:          && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
                   6395:         if (exists($env{'request.course.id'})) {
                   6396:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   6397:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   6398:             if (($domain eq $cdom) && ($name eq $cnum)) {
                   6399:                 my $courseprivid=$env{'request.course.id'};
                   6400:                 $courseprivid=~s/\_/\//;
                   6401:                 if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
                   6402:                     .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
                   6403:                     return $1; 
1.762     raeburn  6404:                 } else {
                   6405:                     if ($env{'request.course.sec'}) {
                   6406:                         $courseprivid.='/'.$env{'request.course.sec'};
                   6407:                     }
                   6408:                     if ($env{'user.priv.'.$env{'request.role'}.'./'.
                   6409:                         $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
                   6410:                         return $2;
                   6411:                     }
1.714     raeburn  6412:                 }
                   6413:             }
                   6414:         }
                   6415:     }
                   6416: 
1.159     www      6417: # Free bre to public access
                   6418: 
                   6419:     if ($priv eq 'bre') {
1.238     www      6420:         my $copyright=&metadata($uri,'copyright');
1.620     albertel 6421: 	if (($copyright eq 'public') && (!$env{'request.course.id'})) { 
1.301     www      6422:            return 'F'; 
                   6423:         }
1.238     www      6424:         if ($copyright eq 'priv') {
                   6425:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 6426: 	    unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238     www      6427: 		return '';
                   6428:             }
                   6429:         }
                   6430:         if ($copyright eq 'domain') {
                   6431:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 6432: 	    unless (($env{'user.domain'} eq $1) ||
                   6433:                  ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238     www      6434: 		return '';
                   6435:             }
1.262     matthew  6436:         }
1.620     albertel 6437:         if ($env{'request.role'}=~ /li\.\//) {
1.262     matthew  6438:             # Library role, so allow browsing of resources in this domain.
                   6439:             return 'F';
1.238     www      6440:         }
1.341     www      6441:         if ($copyright eq 'custom') {
                   6442: 	    unless (&customaccess($priv,$uri)) { return ''; }
                   6443:         }
1.14      www      6444:     }
1.264     matthew  6445:     # Domain coordinator is trying to create a course
1.620     albertel 6446:     if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264     matthew  6447:         # uri is the requested domain in this case.
                   6448:         # comparison to 'request.role.domain' shows if the user has selected
1.678     raeburn  6449:         # a role of dc for the domain in question.
1.620     albertel 6450:         return 'F' if ($uri eq $env{'request.role.domain'});
1.264     matthew  6451:     }
1.29      www      6452: 
1.52      www      6453:     my $thisallowed='';
                   6454:     my $statecond=0;
                   6455:     my $courseprivid='';
                   6456: 
1.1039    raeburn  6457:     my $ownaccess;
1.1043    raeburn  6458:     # Community Coordinator or Assistant Co-author browsing resource space.
1.1039    raeburn  6459:     if (($priv eq 'bro') && ($env{'user.author'})) {
                   6460:         if ($uri eq '') {
                   6461:             $ownaccess = 1;
                   6462:         } else {
                   6463:             if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   6464:                 my $udom = $env{'user.domain'};
                   6465:                 my $uname = $env{'user.name'};
                   6466:                 if ($uri =~ m{^\Q$udom\E/?$}) {
                   6467:                     $ownaccess = 1;
1.1040    raeburn  6468:                 } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039    raeburn  6469:                     unless ($uri =~ m{\.\./}) {
                   6470:                         $ownaccess = 1;
                   6471:                     }
                   6472:                 } elsif (($udom ne 'public') && ($uname ne 'public')) {
                   6473:                     my $now = time;
                   6474:                     if ($uri =~ m{^([^/]+)/?$}) {
                   6475:                         my $adom = $1;
                   6476:                         foreach my $key (keys(%env)) {
1.1042    raeburn  6477:                             if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039    raeburn  6478:                                 my ($start,$end) = split('.',$env{$key});
                   6479:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   6480:                                     $ownaccess = 1;
                   6481:                                     last;
                   6482:                                 }
                   6483:                             }
                   6484:                         }
                   6485:                     } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
                   6486:                         my $adom = $1;
                   6487:                         my $aname = $2;
1.1042    raeburn  6488:                         foreach my $role ('ca','aa') { 
                   6489:                             if ($env{"user.role.$role./$adom/$aname"}) {
                   6490:                                 my ($start,$end) =
                   6491:                                     split('.',$env{"user.role.$role./$adom/$aname"});
                   6492:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   6493:                                     $ownaccess = 1;
                   6494:                                     last;
                   6495:                                 }
1.1039    raeburn  6496:                             }
                   6497:                         }
                   6498:                     }
                   6499:                 }
                   6500:             }
                   6501:         }
                   6502:     }
                   6503: 
1.52      www      6504: # Course
                   6505: 
1.620     albertel 6506:     if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  6507:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  6508:             $thisallowed.=$1;
                   6509:         }
1.52      www      6510:     }
1.29      www      6511: 
1.52      www      6512: # Domain
                   6513: 
1.620     albertel 6514:     if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479     albertel 6515:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  6516:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  6517:             $thisallowed.=$1;
                   6518:         }
1.12      www      6519:     }
1.52      www      6520: 
1.1141    raeburn  6521: # User who is not author or co-author might still be able to edit
                   6522: # resource of an author in the domain (e.g., if Domain Coordinator).
                   6523:     if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
                   6524:         (&allowed('mdc',$env{'request.course.id'}))) {
                   6525:         if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
                   6526:             $thisallowed.=$1;
                   6527:         }
                   6528:     }
                   6529: 
1.52      www      6530: # Course: uri itself is a course
1.66      www      6531:     my $courseuri=$uri;
                   6532:     $courseuri=~s/\_(\d)/\/$1/;
1.83      www      6533:     $courseuri=~s/^([^\/])/\/$1/;
1.81      www      6534: 
1.620     albertel 6535:     if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479     albertel 6536:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  6537:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  6538:             $thisallowed.=$1;
                   6539:         }
1.12      www      6540:     }
1.29      www      6541: 
1.665     albertel 6542: # URI is an uploaded document for this course, default permissions don't matter
1.611     albertel 6543: # not allowing 'edit' access (editupload) to uploaded course docs
1.492     albertel 6544:     if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665     albertel 6545: 	$thisallowed='';
1.671     raeburn  6546:         my ($match)=&is_on_map($uri);
                   6547:         if ($match) {
                   6548:             if ($env{'user.priv.'.$env{'request.role'}.'./'}
                   6549:                   =~/\Q$priv\E\&([^\:]*)/) {
1.1162    raeburn  6550:                 my @blockers = &has_comm_blocking($priv,$symb,$uri);
                   6551:                 if (@blockers > 0) {
                   6552:                     $thisallowed = 'B';
                   6553:                 } else {
                   6554:                     $thisallowed.=$1;
                   6555:                 }
1.671     raeburn  6556:             }
                   6557:         } else {
1.705     albertel 6558:             my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671     raeburn  6559:             if ($refuri) {
                   6560:                 if ($refuri =~ m|^/adm/|) {
1.669     raeburn  6561:                     $thisallowed='F';
1.671     raeburn  6562:                 } else {
                   6563:                     $refuri=&declutter($refuri);
                   6564:                     my ($match) = &is_on_map($refuri);
                   6565:                     if ($match) {
1.1162    raeburn  6566:                         my @blockers = &has_comm_blocking($priv,$symb,$refuri);
                   6567:                         if (@blockers > 0) {
                   6568:                             $thisallowed = 'B';
                   6569:                         } else {
                   6570:                             $thisallowed='F';
                   6571:                         }
1.671     raeburn  6572:                     }
1.669     raeburn  6573:                 }
1.671     raeburn  6574:             }
                   6575:         }
1.314     www      6576:     }
1.492     albertel 6577: 
1.766     albertel 6578:     if ($priv eq 'bre'
                   6579: 	&& $thisallowed ne 'F' 
                   6580: 	&& $thisallowed ne '2'
                   6581: 	&& &is_portfolio_url($uri)) {
                   6582: 	$thisallowed = &portfolio_access($uri);
                   6583:     }
                   6584:     
1.52      www      6585: # Full access at system, domain or course-wide level? Exit.
1.29      www      6586:     if ($thisallowed=~/F/) {
                   6587: 	return 'F';
                   6588:     }
                   6589: 
1.52      www      6590: # If this is generating or modifying users, exit with special codes
1.29      www      6591: 
1.643     www      6592:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
                   6593: 	if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642     albertel 6594: 	    my ($audom,$auname)=split('/',$uri);
1.643     www      6595: # no author name given, so this just checks on the general right to make a co-author in this domain
                   6596: 	    unless ($auname) { return $thisallowed; }
                   6597: # an author name is given, so we are about to actually make a co-author for a certain account
1.642     albertel 6598: 	    if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
                   6599: 		(($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
                   6600: 		 ($audom ne $env{'request.role.domain'}))) { return ''; }
                   6601: 	}
1.52      www      6602: 	return $thisallowed;
                   6603:     }
                   6604: #
1.103     harris41 6605: # Gathered so far: system, domain and course wide privileges
1.52      www      6606: #
                   6607: # Course: See if uri or referer is an individual resource that is part of 
                   6608: # the course
                   6609: 
1.620     albertel 6610:     if ($env{'request.course.id'}) {
1.232     www      6611: 
1.620     albertel 6612:        $courseprivid=$env{'request.course.id'};
                   6613:        if ($env{'request.course.sec'}) {
                   6614:           $courseprivid.='/'.$env{'request.course.sec'};
1.52      www      6615:        }
                   6616:        $courseprivid=~s/\_/\//;
                   6617:        my $checkreferer=1;
1.232     www      6618:        my ($match,$cond)=&is_on_map($uri);
                   6619:        if ($match) {
                   6620:            $statecond=$cond;
1.620     albertel 6621:            if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 6622:                =~/\Q$priv\E\&([^\:]*)/) {
1.1162    raeburn  6623:                my $value = $1;
                   6624:                if ($priv eq 'bre') {
                   6625:                    my @blockers = &has_comm_blocking($priv,$symb,$uri);
                   6626:                    if (@blockers > 0) {
                   6627:                        $thisallowed = 'B';
                   6628:                    } else {
                   6629:                        $thisallowed.=$value;
                   6630:                    }
                   6631:                } else {
                   6632:                    $thisallowed.=$value;
                   6633:                }
1.52      www      6634:                $checkreferer=0;
                   6635:            }
1.29      www      6636:        }
1.83      www      6637:        
1.148     www      6638:        if ($checkreferer) {
1.620     albertel 6639: 	  my $refuri=$env{'httpref.'.$orguri};
1.148     www      6640:             unless ($refuri) {
1.800     albertel 6641:                 foreach my $key (keys(%env)) {
                   6642: 		    if ($key=~/^httpref\..*\*/) {
                   6643: 			my $pattern=$key;
1.156     www      6644:                         $pattern=~s/^httpref\.\/res\///;
1.148     www      6645:                         $pattern=~s/\*/\[\^\/\]\+/g;
                   6646:                         $pattern=~s/\//\\\//g;
1.152     www      6647:                         if ($orguri=~/$pattern/) {
1.800     albertel 6648: 			    $refuri=$env{$key};
1.148     www      6649:                         }
                   6650:                     }
1.191     harris41 6651:                 }
1.148     www      6652:             }
1.232     www      6653: 
1.148     www      6654:          if ($refuri) { 
1.152     www      6655: 	  $refuri=&declutter($refuri);
1.232     www      6656:           my ($match,$cond)=&is_on_map($refuri);
                   6657:             if ($match) {
                   6658:               my $refstatecond=$cond;
1.620     albertel 6659:               if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 6660:                   =~/\Q$priv\E\&([^\:]*)/) {
1.1162    raeburn  6661:                   my $value = $1;
                   6662:                   if ($priv eq 'bre') {
                   6663:                       my @blockers = &has_comm_blocking($priv,$symb,$refuri);
                   6664:                       if (@blockers > 0) {
                   6665:                           $thisallowed = 'B';
                   6666:                       } else {
                   6667:                           $thisallowed.=$value;
                   6668:                       }
                   6669:                   } else {
                   6670:                       $thisallowed.=$value;
                   6671:                   }
1.53      www      6672:                   $uri=$refuri;
                   6673:                   $statecond=$refstatecond;
1.52      www      6674:               }
                   6675:           }
1.148     www      6676:         }
1.29      www      6677:        }
1.52      www      6678:    }
1.29      www      6679: 
1.52      www      6680: #
1.103     harris41 6681: # Gathered now: all privileges that could apply, and condition number
1.52      www      6682: # 
                   6683: #
                   6684: # Full or no access?
                   6685: #
1.29      www      6686: 
1.52      www      6687:     if ($thisallowed=~/F/) {
                   6688: 	return 'F';
                   6689:     }
1.29      www      6690: 
1.52      www      6691:     unless ($thisallowed) {
                   6692:         return '';
                   6693:     }
1.29      www      6694: 
1.52      www      6695: # Restrictions exist, deal with them
                   6696: #
                   6697: #   C:according to course preferences
                   6698: #   R:according to resource settings
                   6699: #   L:unless locked
                   6700: #   X:according to user session state
                   6701: #
                   6702: 
                   6703: # Possibly locked functionality, check all courses
1.54      www      6704: # Locks might take effect only after 10 minutes cache expiration for other
                   6705: # courses, and 2 minutes for current course
1.52      www      6706: 
                   6707:     my $envkey;
                   6708:     if ($thisallowed=~/L/) {
1.1000    raeburn  6709:         foreach $envkey (keys(%env)) {
1.54      www      6710:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
                   6711:                my $courseid=$2;
                   6712:                my $roleid=$1.'.'.$2;
1.92      www      6713:                $courseid=~s/^\///;
1.54      www      6714:                my $expiretime=600;
1.620     albertel 6715:                if ($env{'request.role'} eq $roleid) {
1.54      www      6716: 		  $expiretime=120;
                   6717:                }
                   6718: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
                   6719:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620     albertel 6720:                if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731     albertel 6721: 		   &coursedescription($courseid,{'freshen_cache' => 1});
1.54      www      6722:                }
1.620     albertel 6723:                if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   6724:                 || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
                   6725: 		   if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
                   6726:                        &log($env{'user.domain'},$env{'user.name'},
                   6727:                             $env{'user.home'},
1.57      www      6728:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52      www      6729:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 6730:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      6731: 		       return '';
                   6732:                    }
                   6733:                }
1.620     albertel 6734:                if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   6735:                 || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
                   6736: 		   if ($env{'priv.'.$priv.'.lock.expire'}>time) {
                   6737:                        &log($env{'user.domain'},$env{'user.name'},
                   6738:                             $env{'user.home'},
1.57      www      6739:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52      www      6740:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 6741:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      6742: 		       return '';
                   6743:                    }
                   6744:                }
                   6745: 	   }
1.29      www      6746:        }
1.52      www      6747:     }
                   6748:    
                   6749: #
                   6750: # Rest of the restrictions depend on selected course
                   6751: #
                   6752: 
1.620     albertel 6753:     unless ($env{'request.course.id'}) {
1.766     albertel 6754: 	if ($thisallowed eq 'A') {
                   6755: 	    return 'A';
1.814     raeburn  6756:         } elsif ($thisallowed eq 'B') {
                   6757:             return 'B';
1.766     albertel 6758: 	} else {
                   6759: 	    return '1';
                   6760: 	}
1.52      www      6761:     }
1.29      www      6762: 
1.52      www      6763: #
                   6764: # Now user is definitely in a course
                   6765: #
1.53      www      6766: 
                   6767: 
                   6768: # Course preferences
                   6769: 
                   6770:    if ($thisallowed=~/C/) {
1.620     albertel 6771:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
                   6772:        my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
                   6773:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479     albertel 6774: 	   =~/\Q$rolecode\E/) {
1.1103    raeburn  6775: 	   if (($priv ne 'pch') && ($priv ne 'plc')) { 
1.689     albertel 6776: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   6777: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
                   6778: 			$env{'request.course.id'});
                   6779: 	   }
1.237     www      6780:            return '';
                   6781:        }
                   6782: 
1.620     albertel 6783:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479     albertel 6784: 	   =~/\Q$unamedom\E/) {
1.1103    raeburn  6785: 	   if (($priv ne 'pch') && ($priv ne 'plc')) { 
1.689     albertel 6786: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
                   6787: 			'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
                   6788: 			$env{'request.course.id'});
                   6789: 	   }
1.54      www      6790:            return '';
                   6791:        }
1.53      www      6792:    }
                   6793: 
                   6794: # Resource preferences
                   6795: 
                   6796:    if ($thisallowed=~/R/) {
1.620     albertel 6797:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479     albertel 6798:        if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103    raeburn  6799: 	   if (($priv ne 'pch') && ($priv ne 'plc')) { 
1.689     albertel 6800: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   6801: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
                   6802: 	   }
                   6803: 	   return '';
1.54      www      6804:        }
1.53      www      6805:    }
1.30      www      6806: 
1.246     www      6807: # Restricted by state or randomout?
1.30      www      6808: 
1.52      www      6809:    if ($thisallowed=~/X/) {
1.620     albertel 6810:       if ($env{'acc.randomout'}) {
1.579     albertel 6811: 	 if (!$symb) { $symb=&symbread($uri,1); }
1.620     albertel 6812:          if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 
1.248     www      6813:             return ''; 
                   6814:          }
1.247     www      6815:       }
                   6816:       if (&condval($statecond)) {
1.52      www      6817: 	 return '2';
                   6818:       } else {
                   6819:          return '';
                   6820:       }
                   6821:    }
1.30      www      6822: 
1.766     albertel 6823:     if ($thisallowed eq 'A') {
                   6824: 	return 'A';
1.814     raeburn  6825:     } elsif ($thisallowed eq 'B') {
                   6826:         return 'B';
1.766     albertel 6827:     }
1.52      www      6828:    return 'F';
1.232     www      6829: }
1.1162    raeburn  6830: 
1.1192    raeburn  6831: # ------------------------------------------- Check construction space access
                   6832: 
                   6833: sub constructaccess {
                   6834:     my ($url,$setpriv)=@_;
                   6835: 
                   6836: # We do not allow editing of previous versions of files
                   6837:     if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
                   6838: 
                   6839: # Get username and domain from URL
                   6840:     my ($ownername,$ownerdomain,$ownerhome);
                   6841: 
                   6842:     ($ownerdomain,$ownername) =
                   6843:         ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)/});
                   6844: 
                   6845: # The URL does not really point to any authorspace, forget it
                   6846:     unless (($ownername) && ($ownerdomain)) { return ''; }
                   6847: 
                   6848: # Now we need to see if the user has access to the authorspace of
                   6849: # $ownername at $ownerdomain
                   6850: 
                   6851:     if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
                   6852: # Real author for this?
                   6853:        $ownerhome = $env{'user.home'};
                   6854:        if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
                   6855:           return ($ownername,$ownerdomain,$ownerhome);
                   6856:        }
                   6857:     } else {
                   6858: # Co-author for this?
                   6859:         if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
                   6860:             exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
                   6861:             $ownerhome = &homeserver($ownername,$ownerdomain);
                   6862:             return ($ownername,$ownerdomain,$ownerhome);
                   6863:         }
                   6864:     }
                   6865: 
                   6866: # We don't have any access right now. If we are not possibly going to do anything about this,
                   6867: # we might as well leave
                   6868:    unless ($setpriv) { return ''; }
                   6869: 
                   6870: # Backdoor access?
                   6871:     my $allowed=&allowed('eco',$ownerdomain);
                   6872: # Nope
                   6873:     unless ($allowed) { return ''; }
                   6874: # Looks like we may have access, but could be locked by the owner of the construction space
                   6875:     if ($allowed eq 'U') {
                   6876:         my %blocked=&get('environment',['domcoord.author'],
                   6877:                          $ownerdomain,$ownername);
                   6878: # Is blocked by owner
                   6879:         if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
                   6880:     }
                   6881:     if (($allowed eq 'F') || ($allowed eq 'U')) {
                   6882: # Grant temporary access
                   6883:         my $then=$env{'user.login.time'};
                   6884:         my $update==$env{'user.update.time'};
                   6885:         if (!$update) { $update = $then; }
                   6886:         my $refresh=$env{'user.refresh.time'};
                   6887:         if (!$refresh) { $refresh = $update; }
                   6888:         my $now = time;
                   6889:         &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
                   6890:                            $now,'ca','constructaccess');
                   6891:         $ownerhome = &homeserver($ownername,$ownerdomain);
                   6892:         return($ownername,$ownerdomain,$ownerhome);
                   6893:     }
                   6894: # No business here
                   6895:     return '';
                   6896: }
                   6897: 
1.1162    raeburn  6898: sub get_comm_blocks {
                   6899:     my ($cdom,$cnum) = @_;
                   6900:     if ($cdom eq '' || $cnum eq '') {
                   6901:         return unless ($env{'request.course.id'});
                   6902:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   6903:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   6904:     }
                   6905:     my %commblocks;
                   6906:     my $hashid=$cdom.'_'.$cnum;
                   6907:     my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
                   6908:     if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
                   6909:         %commblocks = %{$blocksref};
                   6910:     } else {
                   6911:         %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   6912:         my $cachetime = 600;
                   6913:         &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
                   6914:     }
                   6915:     return %commblocks;
                   6916: }
                   6917: 
                   6918: sub has_comm_blocking {
                   6919:     my ($priv,$symb,$uri,$blocks) = @_;
                   6920:     return unless ($env{'request.course.id'});
                   6921:     return unless ($priv eq 'bre');
                   6922:     return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
                   6923:     my %commblocks;
                   6924:     if (ref($blocks) eq 'HASH') {
                   6925:         %commblocks = %{$blocks};
                   6926:     } else {
                   6927:         %commblocks = &get_comm_blocks();
                   6928:     }
                   6929:     return unless (keys(%commblocks) > 0);
                   6930:     if (!$symb) { $symb=&symbread($uri,1); }
                   6931:     my ($map,$resid,undef)=&decode_symb($symb);
                   6932:     my %tocheck = (
                   6933:                     maps      => $map,
                   6934:                     resources => $symb,
                   6935:                   );
                   6936:     my @blockers;
                   6937:     my $now = time;
1.1163    raeburn  6938:     my $navmap = Apache::lonnavmaps::navmap->new();
1.1162    raeburn  6939:     foreach my $block (keys(%commblocks)) {
                   6940:         if ($block =~ /^(\d+)____(\d+)$/) {
                   6941:             my ($start,$end) = ($1,$2);
                   6942:             if ($start <= $now && $end >= $now) {
                   6943:                 if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   6944:                     if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
                   6945:                         if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
                   6946:                             if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
                   6947:                                 unless (grep(/^\Q$block\E$/,@blockers)) {
                   6948:                                     push(@blockers,$block);
                   6949:                                 }
                   6950:                             }
                   6951:                         }
                   6952:                         if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
                   6953:                             if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
                   6954:                                 unless (grep(/^\Q$block\E$/,@blockers)) {  
                   6955:                                     push(@blockers,$block);
                   6956:                                 }
                   6957:                             }
                   6958:                         }
                   6959:                     }
                   6960:                 }
                   6961:             }
                   6962:         } elsif ($block =~ /^firstaccess____(.+)$/) {
                   6963:             my $item = $1;
1.1163    raeburn  6964:             my @to_test;
1.1162    raeburn  6965:             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   6966:                 if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
                   6967:                     my $check_interval;
                   6968:                     if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
                   6969:                         my @interval;
                   6970:                         my $type = 'map';
                   6971:                         if ($item eq 'course') {
                   6972:                             $type = 'course';
                   6973:                             @interval=&EXT("resource.0.interval");
                   6974:                         } else {
                   6975:                             if ($item =~ /___\d+___/) {
                   6976:                                 $type = 'resource';
                   6977:                                 @interval=&EXT("resource.0.interval",$item);
1.1163    raeburn  6978:                                 if (ref($navmap)) {                        
                   6979:                                     my $res = $navmap->getBySymb($item); 
                   6980:                                     push(@to_test,$res);
                   6981:                                 }
1.1162    raeburn  6982:                             } else {
                   6983:                                 my $mapsymb = &symbread($item,1);
                   6984:                                 if ($mapsymb) {
                   6985:                                     if (ref($navmap)) {
                   6986:                                         my $mapres = $navmap->getBySymb($mapsymb);
1.1163    raeburn  6987:                                         @to_test = $mapres->retrieveResources($mapres,undef,0,1);
                   6988:                                         foreach my $res (@to_test) {
1.1162    raeburn  6989:                                             my $symb = $res->symb();
                   6990:                                             next if ($symb eq $mapsymb);
                   6991:                                             if ($symb ne '') {
                   6992:                                                 @interval=&EXT("resource.0.interval",$symb);
                   6993:                                                 last;
                   6994:                                             }
                   6995:                                         }
                   6996:                                     }
                   6997:                                 }
                   6998:                             }
                   6999:                         }
                   7000:                         if ($interval[0] =~ /\d+/) {
                   7001:                             my $first_access;
                   7002:                             if ($type eq 'resource') {
                   7003:                                 $first_access=&get_first_access($interval[1],$item);
                   7004:                             } elsif ($type eq 'map') {
                   7005:                                 $first_access=&get_first_access($interval[1],undef,$item);
                   7006:                             } else {
                   7007:                                 $first_access=&get_first_access($interval[1]);
                   7008:                             }
                   7009:                             if ($first_access) {
                   7010:                                 my $timesup = $first_access+$interval[0];
                   7011:                                 if ($timesup > $now) {
1.1163    raeburn  7012:                                     foreach my $res (@to_test) {
                   7013:                                         if ($res->is_problem()) {
                   7014:                                             if ($res->completable()) {
                   7015:                                                 unless (grep(/^\Q$block\E$/,@blockers)) {
                   7016:                                                     push(@blockers,$block);
                   7017:                                                 }
                   7018:                                                 last;
                   7019:                                             }
                   7020:                                         }
1.1162    raeburn  7021:                                     }
                   7022:                                 }
                   7023:                             }
                   7024:                         }
                   7025:                     }
                   7026:                 }
                   7027:             }
                   7028:         }
                   7029:     }
                   7030:     return @blockers;
                   7031: }
                   7032: 
                   7033: sub check_docs_block {
                   7034:     my ($docsblock,$tocheck) =@_;
                   7035:     if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
                   7036:         return;
                   7037:     }
                   7038:     if (ref($docsblock->{'maps'}) eq 'HASH') {
                   7039:         if ($tocheck->{'maps'}) {
                   7040:             if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
                   7041:                 return 1;
                   7042:             }
                   7043:         }
                   7044:     }
                   7045:     if (ref($docsblock->{'resources'}) eq 'HASH') {
                   7046:         if ($tocheck->{'resources'}) {
                   7047:             if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
                   7048:                 return 1;
                   7049:             }
                   7050:         }
                   7051:     }
                   7052:     return;
                   7053: }
                   7054: 
1.1133    foxr     7055: #
                   7056: #   Removes the versino from a URI and
                   7057: #   splits it in to its filename and path to the filename.
                   7058: #   Seems like File::Basename could have done this more clearly.
                   7059: #   Parameters:
                   7060: #      $uri   - input URI
                   7061: #   Returns:
                   7062: #     Two element list consisting of 
                   7063: #     $pathname  - the URI up to and excluding the trailing /
                   7064: #     $filename  - The part of the URI following the last /
                   7065: #  NOTE:
                   7066: #    Another realization of this is simply:
                   7067: #    use File::Basename;
                   7068: #    ...
                   7069: #    $uri = shift;
                   7070: #    $filename = basename($uri);
                   7071: #    $path     = dirname($uri);
                   7072: #    return ($filename, $path);
                   7073: #
                   7074: #     The implementation below is probably faster however.
                   7075: #
1.710     albertel 7076: sub split_uri_for_cond {
                   7077:     my $uri=&deversion(&declutter(shift));
                   7078:     my @uriparts=split(/\//,$uri);
                   7079:     my $filename=pop(@uriparts);
                   7080:     my $pathname=join('/',@uriparts);
                   7081:     return ($pathname,$filename);
                   7082: }
1.232     www      7083: # --------------------------------------------------- Is a resource on the map?
                   7084: 
                   7085: sub is_on_map {
1.710     albertel 7086:     my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289     bowersj2 7087:     #Trying to find the conditional for the file
1.620     albertel 7088:     my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289     bowersj2 7089: 	       /\&\Q$filename\E\:([\d\|]+)\&/);
1.232     www      7090:     if ($match) {
1.289     bowersj2 7091: 	return (1,$1);
                   7092:     } else {
1.434     www      7093: 	return (0,0);
1.289     bowersj2 7094:     }
1.12      www      7095: }
                   7096: 
1.427     www      7097: # --------------------------------------------------------- Get symb from alias
                   7098: 
                   7099: sub get_symb_from_alias {
                   7100:     my $symb=shift;
                   7101:     my ($map,$resid,$url)=&decode_symb($symb);
                   7102: # Already is a symb
                   7103:     if ($url) { return $symb; }
                   7104: # Must be an alias
                   7105:     my $aliassymb='';
                   7106:     my %bighash;
1.620     albertel 7107:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427     www      7108:                             &GDBM_READER(),0640)) {
                   7109:         my $rid=$bighash{'mapalias_'.$symb};
                   7110: 	if ($rid) {
                   7111: 	    my ($mapid,$resid)=split(/\./,$rid);
1.429     albertel 7112: 	    $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
                   7113: 				    $resid,$bighash{'src_'.$rid});
1.427     www      7114: 	}
                   7115:         untie %bighash;
                   7116:     }
                   7117:     return $aliassymb;
                   7118: }
                   7119: 
1.12      www      7120: # ----------------------------------------------------------------- Define Role
                   7121: 
                   7122: sub definerole {
                   7123:   if (allowed('mcr','/')) {
                   7124:     my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800     albertel 7125:     foreach my $role (split(':',$sysrole)) {
                   7126: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 7127:         if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
                   7128:         if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
                   7129: 	    if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      7130:                return "refused:s:$crole&$cqual"; 
                   7131:             }
                   7132:         }
1.191     harris41 7133:     }
1.800     albertel 7134:     foreach my $role (split(':',$domrole)) {
                   7135: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 7136:         if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
                   7137:         if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
                   7138: 	    if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 
1.21      www      7139:                return "refused:d:$crole&$cqual"; 
                   7140:             }
                   7141:         }
1.191     harris41 7142:     }
1.800     albertel 7143:     foreach my $role (split(':',$courole)) {
                   7144: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 7145:         if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
                   7146:         if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
                   7147: 	    if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      7148:                return "refused:c:$crole&$cqual"; 
                   7149:             }
                   7150:         }
1.191     harris41 7151:     }
1.620     albertel 7152:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
                   7153:                 "$env{'user.domain'}:$env{'user.name'}:".
1.21      www      7154: 	        "rolesdef_$rolename=".
                   7155:                 escape($sysrole.'_'.$domrole.'_'.$courole);
1.620     albertel 7156:     return reply($command,$env{'user.home'});
1.12      www      7157:   } else {
                   7158:     return 'refused';
                   7159:   }
1.105     harris41 7160: }
                   7161: 
                   7162: # ---------------- Make a metadata query against the network of library servers
                   7163: 
                   7164: sub metadata_query {
1.244     matthew  7165:     my ($query,$custom,$customshow,$server_array)=@_;
1.120     harris41 7166:     my %rhash;
1.845     albertel 7167:     my %libserv = &all_library();
1.244     matthew  7168:     my @server_list = (defined($server_array) ? @$server_array
                   7169:                                               : keys(%libserv) );
                   7170:     for my $server (@server_list) {
1.118     harris41 7171: 	unless ($custom or $customshow) {
                   7172: 	    my $reply=&reply("querysend:".&escape($query),$server);
                   7173: 	    $rhash{$server}=$reply;
                   7174: 	}
                   7175: 	else {
                   7176: 	    my $reply=&reply("querysend:".&escape($query).':'.
                   7177: 			     &escape($custom).':'.&escape($customshow),
                   7178: 			     $server);
                   7179: 	    $rhash{$server}=$reply;
                   7180: 	}
1.112     harris41 7181:     }
1.118     harris41 7182:     return \%rhash;
1.240     www      7183: }
                   7184: 
                   7185: # ----------------------------------------- Send log queries and wait for reply
                   7186: 
                   7187: sub log_query {
                   7188:     my ($uname,$udom,$query,%filters)=@_;
                   7189:     my $uhome=&homeserver($uname,$udom);
                   7190:     if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838     albertel 7191:     my $uhost=&hostname($uhome);
1.800     albertel 7192:     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240     www      7193:     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
                   7194:                        $uhome);
1.479     albertel 7195:     unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242     www      7196:     return get_query_reply($queryid);
                   7197: }
                   7198: 
1.818     raeburn  7199: # -------------------------- Update MySQL table for portfolio file
                   7200: 
                   7201: sub update_portfolio_table {
1.821     raeburn  7202:     my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970     raeburn  7203:     if ($group ne '') {
                   7204:         $file_name =~s /^\Q$group\E//;
                   7205:     }
1.818     raeburn  7206:     my $homeserver = &homeserver($uname,$udom);
                   7207:     my $queryid=
1.821     raeburn  7208:         &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
                   7209:                ':'.&escape($file_name).':'.$action,$homeserver);
1.818     raeburn  7210:     my $reply = &get_query_reply($queryid);
                   7211:     return $reply;
                   7212: }
                   7213: 
1.899     raeburn  7214: # -------------------------- Update MySQL allusers table
                   7215: 
                   7216: sub update_allusers_table {
                   7217:     my ($uname,$udom,$names) = @_;
                   7218:     my $homeserver = &homeserver($uname,$udom);
                   7219:     my $queryid=
                   7220:         &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
                   7221:                'lastname='.&escape($names->{'lastname'}).'%%'.
                   7222:                'firstname='.&escape($names->{'firstname'}).'%%'.
                   7223:                'middlename='.&escape($names->{'middlename'}).'%%'.
                   7224:                'generation='.&escape($names->{'generation'}).'%%'.
                   7225:                'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
                   7226:                'id='.&escape($names->{'id'}),$homeserver);
1.1075    raeburn  7227:     return;
1.899     raeburn  7228: }
                   7229: 
1.508     raeburn  7230: # ------- Request retrieval of institutional classlists for course(s)
1.506     raeburn  7231: 
                   7232: sub fetch_enrollment_query {
1.511     raeburn  7233:     my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508     raeburn  7234:     my $homeserver;
1.547     raeburn  7235:     my $maxtries = 1;
1.508     raeburn  7236:     if ($context eq 'automated') {
                   7237:         $homeserver = $perlvar{'lonHostID'};
1.547     raeburn  7238:         $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508     raeburn  7239:     } else {
                   7240:         $homeserver = &homeserver($cnum,$dom);
                   7241:     }
1.838     albertel 7242:     my $host=&hostname($homeserver);
1.506     raeburn  7243:     my $cmd = '';
1.1000    raeburn  7244:     foreach my $affiliate (keys(%{$affiliatesref})) {
1.800     albertel 7245:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506     raeburn  7246:     }
                   7247:     $cmd =~ s/%%$//;
                   7248:     $cmd = &escape($cmd);
                   7249:     my $query = 'fetchenrollment';
1.620     albertel 7250:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526     raeburn  7251:     unless ($queryid=~/^\Q$host\E\_/) { 
                   7252:         &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 
                   7253:         return 'error: '.$queryid;
                   7254:     }
1.506     raeburn  7255:     my $reply = &get_query_reply($queryid);
1.547     raeburn  7256:     my $tries = 1;
                   7257:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   7258:         $reply = &get_query_reply($queryid);
                   7259:         $tries ++;
                   7260:     }
1.526     raeburn  7261:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620     albertel 7262:         &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526     raeburn  7263:     } else {
1.901     albertel 7264:         my @responses = split(/:/,$reply);
1.515     raeburn  7265:         if ($homeserver eq $perlvar{'lonHostID'}) {
1.800     albertel 7266:             foreach my $line (@responses) {
                   7267:                 my ($key,$value) = split(/=/,$line,2);
1.515     raeburn  7268:                 $$replyref{$key} = $value;
                   7269:             }
                   7270:         } else {
1.1117    foxr     7271:             my $pathname = LONCAPA::tempdir();
1.800     albertel 7272:             foreach my $line (@responses) {
                   7273:                 my ($key,$value) = split(/=/,$line);
1.506     raeburn  7274:                 $$replyref{$key} = $value;
                   7275:                 if ($value > 0) {
1.800     albertel 7276:                     foreach my $item (@{$$affiliatesref{$key}}) {
                   7277:                         my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506     raeburn  7278:                         my $destname = $pathname.'/'.$filename;
                   7279:                         my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526     raeburn  7280:                         if ($xml_classlist =~ /^error/) {
                   7281:                             &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
                   7282:                         } else {
1.506     raeburn  7283:                             if ( open(FILE,">$destname") ) {
                   7284:                                 print FILE &unescape($xml_classlist);
                   7285:                                 close(FILE);
1.526     raeburn  7286:                             } else {
                   7287:                                 &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506     raeburn  7288:                             }
                   7289:                         }
                   7290:                     }
                   7291:                 }
                   7292:             }
                   7293:         }
                   7294:         return 'ok';
                   7295:     }
                   7296:     return 'error';
                   7297: }
                   7298: 
1.242     www      7299: sub get_query_reply {
                   7300:     my $queryid=shift;
1.1117    foxr     7301:     my $replyfile=LONCAPA::tempdir().$queryid;
1.240     www      7302:     my $reply='';
                   7303:     for (1..100) {
                   7304: 	sleep 2;
                   7305:         if (-e $replyfile.'.end') {
1.448     albertel 7306: 	    if (open(my $fh,$replyfile)) {
1.904     albertel 7307: 		$reply = join('',<$fh>);
                   7308: 		close($fh);
1.240     www      7309: 	   } else { return 'error: reply_file_error'; }
1.242     www      7310:            return &unescape($reply);
                   7311: 	}
1.240     www      7312:     }
1.242     www      7313:     return 'timeout:'.$queryid;
1.240     www      7314: }
                   7315: 
                   7316: sub courselog_query {
1.241     www      7317: #
                   7318: # possible filters:
                   7319: # url: url or symb
                   7320: # username
                   7321: # domain
                   7322: # action: view, submit, grade
                   7323: # start: timestamp
                   7324: # end: timestamp
                   7325: #
1.240     www      7326:     my (%filters)=@_;
1.620     albertel 7327:     unless ($env{'request.course.id'}) { return 'no_course'; }
1.241     www      7328:     if ($filters{'url'}) {
                   7329: 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
                   7330:         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
                   7331:         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
                   7332:     }
1.620     albertel 7333:     my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   7334:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240     www      7335:     return &log_query($cname,$cdom,'courselog',%filters);
                   7336: }
                   7337: 
                   7338: sub userlog_query {
1.858     raeburn  7339: #
                   7340: # possible filters:
                   7341: # action: log check role
                   7342: # start: timestamp
                   7343: # end: timestamp
                   7344: #
1.240     www      7345:     my ($uname,$udom,%filters)=@_;
                   7346:     return &log_query($uname,$udom,'userlog',%filters);
1.12      www      7347: }
                   7348: 
1.506     raeburn  7349: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 
                   7350: 
                   7351: sub auto_run {
1.508     raeburn  7352:     my ($cnum,$cdom) = @_;
1.876     raeburn  7353:     my $response = 0;
                   7354:     my $settings;
                   7355:     my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
                   7356:     if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   7357:         $settings = $domconfig{'autoenroll'};
                   7358:         if ($settings->{'run'} eq '1') {
                   7359:             $response = 1;
                   7360:         }
                   7361:     } else {
1.934     raeburn  7362:         my $homeserver;
                   7363:         if (&is_course($cdom,$cnum)) {
                   7364:             $homeserver = &homeserver($cnum,$cdom);
                   7365:         } else {
                   7366:             $homeserver = &domain($cdom,'primary');
                   7367:         }
                   7368:         if ($homeserver ne 'no_host') {
                   7369:             $response = &reply('autorun:'.$cdom,$homeserver);
                   7370:         }
1.876     raeburn  7371:     }
1.506     raeburn  7372:     return $response;
                   7373: }
1.776     albertel 7374: 
1.506     raeburn  7375: sub auto_get_sections {
1.508     raeburn  7376:     my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007    raeburn  7377:     my $homeserver;
                   7378:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 
                   7379:         $homeserver = &homeserver($cnum,$cdom);
                   7380:     }
                   7381:     if (!defined($homeserver)) { 
                   7382:         if ($cdom =~ /^$match_domain$/) {
                   7383:             $homeserver = &domain($cdom,'primary');
                   7384:         }
                   7385:     }
                   7386:     my @secs;
                   7387:     if (defined($homeserver)) {
                   7388:         my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
                   7389:         unless ($response eq 'refused') {
                   7390:             @secs = split(/:/,$response);
                   7391:         }
1.506     raeburn  7392:     }
                   7393:     return @secs;
                   7394: }
1.776     albertel 7395: 
1.506     raeburn  7396: sub auto_new_course {
1.1099    raeburn  7397:     my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508     raeburn  7398:     my $homeserver = &homeserver($cnum,$cdom);
1.1099    raeburn  7399:     my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506     raeburn  7400:     return $response;
                   7401: }
1.776     albertel 7402: 
1.506     raeburn  7403: sub auto_validate_courseID {
1.508     raeburn  7404:     my ($cnum,$cdom,$inst_course_id) = @_;
                   7405:     my $homeserver = &homeserver($cnum,$cdom);
1.511     raeburn  7406:     my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506     raeburn  7407:     return $response;
                   7408: }
1.776     albertel 7409: 
1.1007    raeburn  7410: sub auto_validate_instcode {
1.1020    raeburn  7411:     my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007    raeburn  7412:     my ($homeserver,$response);
                   7413:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   7414:         $homeserver = &homeserver($cnum,$cdom);
                   7415:     }
                   7416:     if (!defined($homeserver)) {
                   7417:         if ($cdom =~ /^$match_domain$/) {
                   7418:             $homeserver = &domain($cdom,'primary');
                   7419:         }
                   7420:     }
1.1065    raeburn  7421:     $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
                   7422:                         &escape($instcode).':'.&escape($owner),$homeserver));
1.1027    raeburn  7423:     my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
                   7424:     return ($outcome,$description);
1.1007    raeburn  7425: }
                   7426: 
1.506     raeburn  7427: sub auto_create_password {
1.873     raeburn  7428:     my ($cnum,$cdom,$authparam,$udom) = @_;
                   7429:     my ($homeserver,$response);
1.506     raeburn  7430:     my $create_passwd = 0;
                   7431:     my $authchk = '';
1.873     raeburn  7432:     if ($udom =~ /^$match_domain$/) {
                   7433:         $homeserver = &domain($udom,'primary');
                   7434:     }
                   7435:     if ($homeserver eq '') {
                   7436:         if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   7437:             $homeserver = &homeserver($cnum,$cdom);
                   7438:         }
                   7439:     }
                   7440:     if ($homeserver eq '') {
                   7441:         $authchk = 'nodomain';
1.506     raeburn  7442:     } else {
1.873     raeburn  7443:         $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
                   7444:         if ($response eq 'refused') {
                   7445:             $authchk = 'refused';
                   7446:         } else {
1.901     albertel 7447:             ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873     raeburn  7448:         }
1.506     raeburn  7449:     }
                   7450:     return ($authparam,$create_passwd,$authchk);
                   7451: }
                   7452: 
1.706     raeburn  7453: sub auto_photo_permission {
                   7454:     my ($cnum,$cdom,$students) = @_;
                   7455:     my $homeserver = &homeserver($cnum,$cdom);
1.707     albertel 7456:     my ($outcome,$perm_reqd,$conditions) = 
                   7457: 	split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709     albertel 7458:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   7459: 	return (undef,undef);
                   7460:     }
1.706     raeburn  7461:     return ($outcome,$perm_reqd,$conditions);
                   7462: }
                   7463: 
                   7464: sub auto_checkphotos {
                   7465:     my ($uname,$udom,$pid) = @_;
                   7466:     my $homeserver = &homeserver($uname,$udom);
                   7467:     my ($result,$resulttype);
                   7468:     my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707     albertel 7469: 				   &escape($uname).':'.&escape($pid),
                   7470: 				   $homeserver));
1.709     albertel 7471:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   7472: 	return (undef,undef);
                   7473:     }
1.706     raeburn  7474:     if ($outcome) {
                   7475:         ($result,$resulttype) = split(/:/,$outcome);
                   7476:     } 
                   7477:     return ($result,$resulttype);
                   7478: }
                   7479: 
                   7480: sub auto_photochoice {
                   7481:     my ($cnum,$cdom) = @_;
                   7482:     my $homeserver = &homeserver($cnum,$cdom);
                   7483:     my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707     albertel 7484: 						       &escape($cdom),
                   7485: 						       $homeserver)));
1.709     albertel 7486:     if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   7487: 	return (undef,undef);
                   7488:     }
1.706     raeburn  7489:     return ($update,$comment);
                   7490: }
                   7491: 
                   7492: sub auto_photoupdate {
                   7493:     my ($affiliatesref,$dom,$cnum,$photo) = @_;
                   7494:     my $homeserver = &homeserver($cnum,$dom);
1.838     albertel 7495:     my $host=&hostname($homeserver);
1.706     raeburn  7496:     my $cmd = '';
                   7497:     my $maxtries = 1;
1.800     albertel 7498:     foreach my $affiliate (keys(%{$affiliatesref})) {
                   7499:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706     raeburn  7500:     }
                   7501:     $cmd =~ s/%%$//;
                   7502:     $cmd = &escape($cmd);
                   7503:     my $query = 'institutionalphotos';
                   7504:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
                   7505:     unless ($queryid=~/^\Q$host\E\_/) {
                   7506:         &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
                   7507:         return 'error: '.$queryid;
                   7508:     }
                   7509:     my $reply = &get_query_reply($queryid);
                   7510:     my $tries = 1;
                   7511:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   7512:         $reply = &get_query_reply($queryid);
                   7513:         $tries ++;
                   7514:     }
                   7515:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   7516:         &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
                   7517:     } else {
                   7518:         my @responses = split(/:/,$reply);
                   7519:         my $outcome = shift(@responses); 
                   7520:         foreach my $item (@responses) {
                   7521:             my ($key,$value) = split(/=/,$item);
                   7522:             $$photo{$key} = $value;
                   7523:         }
                   7524:         return $outcome;
                   7525:     }
                   7526:     return 'error';
                   7527: }
                   7528: 
1.521     raeburn  7529: sub auto_instcode_format {
1.793     albertel 7530:     my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
                   7531: 	$cat_order) = @_;
1.521     raeburn  7532:     my $courses = '';
1.772     raeburn  7533:     my @homeservers;
1.521     raeburn  7534:     if ($caller eq 'global') {
1.841     albertel 7535: 	my %servers = &get_servers($codedom,'library');
                   7536: 	foreach my $tryserver (keys(%servers)) {
                   7537: 	    if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   7538: 		push(@homeservers,$tryserver);
                   7539: 	    }
1.584     raeburn  7540:         }
1.1022    raeburn  7541:     } elsif ($caller eq 'requests') {
                   7542:         if ($codedom =~ /^$match_domain$/) {
                   7543:             my $chome = &domain($codedom,'primary');
                   7544:             unless ($chome eq 'no_host') {
                   7545:                 push(@homeservers,$chome);
                   7546:             }
                   7547:         }
1.521     raeburn  7548:     } else {
1.772     raeburn  7549:         push(@homeservers,&homeserver($caller,$codedom));
1.521     raeburn  7550:     }
1.793     albertel 7551:     foreach my $code (keys(%{$instcodes})) {
                   7552:         $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521     raeburn  7553:     }
                   7554:     chop($courses);
1.772     raeburn  7555:     my $ok_response = 0;
                   7556:     my $response;
                   7557:     while (@homeservers > 0 && $ok_response == 0) {
                   7558:         my $server = shift(@homeservers); 
                   7559:         $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
                   7560:         if ($response !~ /(con_lost|error|no_such_host|refused)/) {
                   7561:             my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 
1.901     albertel 7562: 		split(/:/,$response);
1.772     raeburn  7563:             %{$codes} = (%{$codes},&str2hash($codes_str));
                   7564:             push(@{$codetitles},&str2array($codetitles_str));
                   7565:             %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
                   7566:             %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
                   7567:             $ok_response = 1;
                   7568:         }
                   7569:     }
                   7570:     if ($ok_response) {
1.521     raeburn  7571:         return 'ok';
1.772     raeburn  7572:     } else {
                   7573:         return $response;
1.521     raeburn  7574:     }
                   7575: }
                   7576: 
1.792     raeburn  7577: sub auto_instcode_defaults {
                   7578:     my ($domain,$returnhash,$code_order) = @_;
                   7579:     my @homeservers;
1.841     albertel 7580: 
                   7581:     my %servers = &get_servers($domain,'library');
                   7582:     foreach my $tryserver (keys(%servers)) {
                   7583: 	if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   7584: 	    push(@homeservers,$tryserver);
                   7585: 	}
1.792     raeburn  7586:     }
1.841     albertel 7587: 
1.792     raeburn  7588:     my $response;
1.841     albertel 7589:     foreach my $server (@homeservers) {
1.792     raeburn  7590:         $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841     albertel 7591:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
                   7592: 	
                   7593: 	foreach my $pair (split(/\&/,$response)) {
                   7594: 	    my ($name,$value)=split(/\=/,$pair);
                   7595: 	    if ($name eq 'code_order') {
                   7596: 		@{$code_order} = split(/\&/,&unescape($value));
                   7597: 	    } else {
                   7598: 		$returnhash->{&unescape($name)}=&unescape($value);
                   7599: 	    }
                   7600: 	}
                   7601: 	return 'ok';
1.792     raeburn  7602:     }
1.841     albertel 7603: 
                   7604:     return $response;
1.1003    raeburn  7605: }
                   7606: 
                   7607: sub auto_possible_instcodes {
1.1007    raeburn  7608:     my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
                   7609:     unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 
                   7610:             (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
                   7611:         return;
                   7612:     }
1.1003    raeburn  7613:     my (@homeservers,$uhome);
                   7614:     if (defined(&domain($domain,'primary'))) {
                   7615:         $uhome=&domain($domain,'primary');
                   7616:         push(@homeservers,&domain($domain,'primary'));
                   7617:     } else {
                   7618:         my %servers = &get_servers($domain,'library');
                   7619:         foreach my $tryserver (keys(%servers)) {
                   7620:             if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   7621:                 push(@homeservers,$tryserver);
                   7622:             }
                   7623:         }
                   7624:     }
                   7625:     my $response;
                   7626:     foreach my $server (@homeservers) {
                   7627:         $response=&reply('autopossibleinstcodes:'.$domain,$server);
                   7628:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007    raeburn  7629:         my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 
                   7630:             split(':',$response);
                   7631:         @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
                   7632:         @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003    raeburn  7633:         foreach my $item (split('&',$cat_title)) {   
1.1005    raeburn  7634:             my ($name,$value)=split('=',$item);
                   7635:             $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  7636:         }
                   7637:         foreach my $item (split('&',$cat_order)) {
1.1005    raeburn  7638:             my ($name,$value)=split('=',$item);
                   7639:             $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  7640:         }
                   7641:         return 'ok';
                   7642:     }
                   7643:     return $response;
                   7644: }
1.792     raeburn  7645: 
1.1010    raeburn  7646: sub auto_courserequest_checks {
                   7647:     my ($dom) = @_;
1.1020    raeburn  7648:     my ($homeserver,%validations);
                   7649:     if ($dom =~ /^$match_domain$/) {
                   7650:         $homeserver = &domain($dom,'primary');
                   7651:     }
                   7652:     unless ($homeserver eq 'no_host') {
                   7653:         my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
                   7654:         unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
                   7655:             my @items = split(/&/,$response);
                   7656:             foreach my $item (@items) {
                   7657:                 my ($key,$value) = split('=',$item);
                   7658:                 $validations{&unescape($key)} = &thaw_unescape($value);
                   7659:             }
                   7660:         }
                   7661:     }
1.1010    raeburn  7662:     return %validations; 
                   7663: }
                   7664: 
1.1020    raeburn  7665: sub auto_courserequest_validation {
                   7666:     my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
                   7667:     my ($homeserver,$response);
                   7668:     if ($dom =~ /^$match_domain$/) {
                   7669:         $homeserver = &domain($dom,'primary');
                   7670:     }
                   7671:     unless ($homeserver eq 'no_host') {  
1.1021    raeburn  7672:           
1.1020    raeburn  7673:         $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021    raeburn  7674:                                     ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020    raeburn  7675:                                     ':'.&escape($instcode).':'.&escape($instseclist),
                   7676:                                     $homeserver));
                   7677:     }
                   7678:     return $response;
                   7679: }
                   7680: 
1.777     albertel 7681: sub auto_validate_class_sec {
1.918     raeburn  7682:     my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773     raeburn  7683:     my $homeserver = &homeserver($cnum,$cdom);
1.918     raeburn  7684:     my $ownerlist;
                   7685:     if (ref($owners) eq 'ARRAY') {
                   7686:         $ownerlist = join(',',@{$owners});
                   7687:     } else {
                   7688:         $ownerlist = $owners;
                   7689:     }
1.773     raeburn  7690:     my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918     raeburn  7691:                         &escape($ownerlist).':'.$cdom,$homeserver);
1.773     raeburn  7692:     return $response;
                   7693: }
                   7694: 
1.679     raeburn  7695: # ------------------------------------------------------- Course Group routines
                   7696: 
                   7697: sub get_coursegroups {
1.809     raeburn  7698:     my ($cdom,$cnum,$group,$namespace) = @_;
                   7699:     return(&dump($namespace,$cdom,$cnum,$group));
1.805     raeburn  7700: }
                   7701: 
1.679     raeburn  7702: sub modify_coursegroup {
                   7703:     my ($cdom,$cnum,$groupsettings) = @_;
                   7704:     return(&put('coursegroups',$groupsettings,$cdom,$cnum));
                   7705: }
                   7706: 
1.809     raeburn  7707: sub toggle_coursegroup_status {
                   7708:     my ($cdom,$cnum,$group,$action) = @_;
                   7709:     my ($from_namespace,$to_namespace);
                   7710:     if ($action eq 'delete') {
                   7711:         $from_namespace = 'coursegroups';
                   7712:         $to_namespace = 'deleted_groups';
                   7713:     } else {
                   7714:         $from_namespace = 'deleted_groups';
                   7715:         $to_namespace = 'coursegroups';
                   7716:     }
                   7717:     my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805     raeburn  7718:     if (my $tmp = &error(%curr_group)) {
                   7719:         &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
                   7720:         return ('read error',$tmp);
                   7721:     } else {
                   7722:         my %savedsettings = %curr_group; 
1.809     raeburn  7723:         my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805     raeburn  7724:         my $deloutcome;
                   7725:         if ($result eq 'ok') {
1.809     raeburn  7726:             $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805     raeburn  7727:         } else {
                   7728:             return ('write error',$result);
                   7729:         }
                   7730:         if ($deloutcome eq 'ok') {
                   7731:             return 'ok';
                   7732:         } else {
                   7733:             return ('delete error',$deloutcome);
                   7734:         }
                   7735:     }
                   7736: }
                   7737: 
1.679     raeburn  7738: sub modify_group_roles {
1.957     raeburn  7739:     my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679     raeburn  7740:     my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
                   7741:     my $role = 'gr/'.&escape($userprivs);
                   7742:     my ($uname,$udom) = split(/:/,$user);
1.957     raeburn  7743:     my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684     raeburn  7744:     if ($result eq 'ok') {
                   7745:         &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
                   7746:     }
1.679     raeburn  7747:     return $result;
                   7748: }
                   7749: 
                   7750: sub modify_coursegroup_membership {
                   7751:     my ($cdom,$cnum,$membership) = @_;
                   7752:     my $result = &put('groupmembership',$membership,$cdom,$cnum);
                   7753:     return $result;
                   7754: }
                   7755: 
1.682     raeburn  7756: sub get_active_groups {
                   7757:     my ($udom,$uname,$cdom,$cnum) = @_;
                   7758:     my $now = time;
                   7759:     my %groups = ();
                   7760:     foreach my $key (keys(%env)) {
1.811     albertel 7761:         if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682     raeburn  7762:             my ($start,$end) = split(/\./,$env{$key});
                   7763:             if (($end!=0) && ($end<$now)) { next; }
                   7764:             if (($start!=0) && ($start>$now)) { next; }
                   7765:             if ($1 eq $cdom && $2 eq $cnum) {
                   7766:                 $groups{$3} = $env{$key} ;
                   7767:             }
                   7768:         }
                   7769:     }
                   7770:     return %groups;
                   7771: }
                   7772: 
1.683     raeburn  7773: sub get_group_membership {
                   7774:     my ($cdom,$cnum,$group) = @_;
                   7775:     return(&dump('groupmembership',$cdom,$cnum,$group));
                   7776: }
                   7777: 
                   7778: sub get_users_groups {
                   7779:     my ($udom,$uname,$courseid) = @_;
1.733     raeburn  7780:     my @usersgroups;
1.683     raeburn  7781:     my $cachetime=1800;
                   7782: 
                   7783:     my $hashid="$udom:$uname:$courseid";
1.733     raeburn  7784:     my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
                   7785:     if (defined($cached)) {
1.734     albertel 7786:         @usersgroups = split(/:/,$grouplist);
1.733     raeburn  7787:     } else {  
                   7788:         $grouplist = '';
1.816     raeburn  7789:         my $courseurl = &courseid_to_courseurl($courseid);
1.1166    raeburn  7790:         my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817     raeburn  7791:         my $access_end = $env{'course.'.$courseid.
                   7792:                               '.default_enrollment_end_date'};
                   7793:         my $now = time;
                   7794:         foreach my $key (keys(%roleshash)) {
                   7795:             if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
                   7796:                 my $group = $1;
                   7797:                 if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
                   7798:                     my $start = $2;
                   7799:                     my $end = $1;
                   7800:                     if ($start == -1) { next; } # deleted from group
                   7801:                     if (($start!=0) && ($start>$now)) { next; }
                   7802:                     if (($end!=0) && ($end<$now)) {
                   7803:                         if ($access_end && $access_end < $now) {
                   7804:                             if ($access_end - $end < 86400) {
                   7805:                                 push(@usersgroups,$group);
1.733     raeburn  7806:                             }
                   7807:                         }
1.817     raeburn  7808:                         next;
1.733     raeburn  7809:                     }
1.817     raeburn  7810:                     push(@usersgroups,$group);
1.683     raeburn  7811:                 }
                   7812:             }
                   7813:         }
1.817     raeburn  7814:         @usersgroups = &sort_course_groups($courseid,@usersgroups);
                   7815:         $grouplist = join(':',@usersgroups);
                   7816:         &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683     raeburn  7817:     }
1.733     raeburn  7818:     return @usersgroups;
1.683     raeburn  7819: }
                   7820: 
                   7821: sub devalidate_getgroups_cache {
                   7822:     my ($udom,$uname,$cdom,$cnum)=@_;
                   7823:     my $courseid = $cdom.'_'.$cnum;
1.807     albertel 7824: 
1.683     raeburn  7825:     my $hashid="$udom:$uname:$courseid";
                   7826:     &devalidate_cache_new('getgroups',$hashid);
                   7827: }
                   7828: 
1.12      www      7829: # ------------------------------------------------------------------ Plain Text
                   7830: 
                   7831: sub plaintext {
1.988     raeburn  7832:     my ($short,$type,$cid,$forcedefault) = @_;
1.1046    raeburn  7833:     if ($short =~ m{^cr/}) {
1.758     albertel 7834: 	return (split('/',$short))[-1];
                   7835:     }
1.742     raeburn  7836:     if (!defined($cid)) {
                   7837:         $cid = $env{'request.course.id'};
                   7838:     }
                   7839:     my %rolenames = (
1.1008    raeburn  7840:                       Course    => 'std',
                   7841:                       Community => 'alt1',
1.742     raeburn  7842:                     );
1.1037    raeburn  7843:     if ($cid ne '') {
                   7844:         if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
                   7845:             unless ($forcedefault) {
                   7846:                 my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 
                   7847:                 &Apache::lonlocal::mt_escape(\$roletext);
                   7848:                 return &Apache::lonlocal::mt($roletext);
                   7849:             }
                   7850:         }
                   7851:     }
                   7852:     if ((defined($type)) && (defined($rolenames{$type})) &&
                   7853:         (defined($rolenames{$type})) && 
                   7854:         (defined($prp{$short}{$rolenames{$type}}))) {
1.742     raeburn  7855:         return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037    raeburn  7856:     } elsif ($cid ne '') {
                   7857:         my $crstype = $env{'course.'.$cid.'.type'};
                   7858:         if (($crstype ne '') && (defined($rolenames{$crstype})) &&
                   7859:             (defined($prp{$short}{$rolenames{$crstype}}))) {
                   7860:             return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
                   7861:         }
1.742     raeburn  7862:     }
1.1037    raeburn  7863:     return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12      www      7864: }
                   7865: 
                   7866: # ----------------------------------------------------------------- Assign Role
                   7867: 
                   7868: sub assignrole {
1.957     raeburn  7869:     my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
                   7870:         $context)=@_;
1.21      www      7871:     my $mrole;
                   7872:     if ($role =~ /^cr\//) {
1.393     www      7873:         my $cwosec=$url;
1.811     albertel 7874:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393     www      7875: 	unless (&allowed('ccr',$cwosec)) {
1.1026    raeburn  7876:            my $refused = 1;
                   7877:            if ($context eq 'requestcourses') {
                   7878:                if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
                   7879:                    if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
                   7880:                        if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
                   7881:                            my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   7882:                            my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   7883:                            if ($crsenv{'internal.courseowner'} eq
                   7884:                                $env{'user.name'}.':'.$env{'user.domain'}) {
                   7885:                                $refused = '';
                   7886:                            }
                   7887:                        }
                   7888:                    }
                   7889:                }
                   7890:            }
                   7891:            if ($refused) {
                   7892:                &logthis('Refused custom assignrole: '.
                   7893:                         $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
                   7894:                         ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
                   7895:                return 'refused';
                   7896:            }
1.104     www      7897:         }
1.21      www      7898:         $mrole='cr';
1.678     raeburn  7899:     } elsif ($role =~ /^gr\//) {
                   7900:         my $cwogrp=$url;
1.811     albertel 7901:         $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678     raeburn  7902:         unless (&allowed('mdg',$cwogrp)) {
                   7903:             &logthis('Refused group assignrole: '.
                   7904:               $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
                   7905:                     $env{'user.name'}.' at '.$env{'user.domain'});
                   7906:             return 'refused';
                   7907:         }
                   7908:         $mrole='gr';
1.21      www      7909:     } else {
1.82      www      7910:         my $cwosec=$url;
1.811     albertel 7911:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932     raeburn  7912:         if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
                   7913:             my $refused;
                   7914:             if (($env{'request.course.sec'}  ne '') && ($role eq 'st')) {
                   7915:                 if (!(&allowed('c'.$role,$url))) {
                   7916:                     $refused = 1;
                   7917:                 }
                   7918:             } else {
                   7919:                 $refused = 1;
                   7920:             }
1.947     raeburn  7921:             if ($refused) {
1.1045    raeburn  7922:                 my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   7923:                 if (!$selfenroll && $context eq 'course') {
                   7924:                     my %crsenv;
                   7925:                     if ($role eq 'cc' || $role eq 'co') {
                   7926:                         %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   7927:                         if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
                   7928:                             if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
                   7929:                                 if ($crsenv{'internal.courseowner'} eq 
                   7930:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   7931:                                     $refused = '';
                   7932:                                 }
                   7933:                             }
                   7934:                         } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 
                   7935:                             if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
                   7936:                                 if ($crsenv{'internal.courseowner'} eq 
                   7937:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   7938:                                     $refused = '';
                   7939:                                 }
                   7940:                             }
                   7941:                         }
                   7942:                     }
                   7943:                 } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947     raeburn  7944:                     $refused = '';
1.1017    raeburn  7945:                 } elsif ($context eq 'requestcourses') {
1.1041    raeburn  7946:                     my @possroles = ('st','ta','ep','in','cc','co');
1.1026    raeburn  7947:                     if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041    raeburn  7948:                         my $wrongcc;
                   7949:                         if ($cnum =~ /^$match_community$/) {
                   7950:                             $wrongcc = 1 if ($role eq 'cc');
                   7951:                         } else {
                   7952:                             $wrongcc = 1 if ($role eq 'co');
                   7953:                         }
                   7954:                         unless ($wrongcc) {
                   7955:                             my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   7956:                             if ($crsenv{'internal.courseowner'} eq 
                   7957:                                  $env{'user.name'}.':'.$env{'user.domain'}) {
                   7958:                                 $refused = '';
                   7959:                             }
1.1017    raeburn  7960:                         }
                   7961:                     }
1.1183    raeburn  7962:                 } elsif ($context eq 'requestauthor') {
                   7963:                     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) && 
                   7964:                         ($url eq '/'.$udom.'/') && ($role eq 'au')) {
                   7965:                         if ($env{'environment.requestauthor'} eq 'automatic') {
                   7966:                             $refused = '';
                   7967:                         } else {
                   7968:                             my %domdefaults = &get_domain_defaults($udom);
                   7969:                             if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
                   7970:                                 my $checkbystatus;
                   7971:                                 if ($env{'user.adv'}) { 
                   7972:                                     my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
                   7973:                                     if ($disposition eq 'automatic') {
                   7974:                                         $refused = '';
                   7975:                                     } elsif ($disposition eq '') {
                   7976:                                         $checkbystatus = 1;
                   7977:                                     } 
                   7978:                                 } else {
                   7979:                                     $checkbystatus = 1;
                   7980:                                 }
                   7981:                                 if ($checkbystatus) {
                   7982:                                     if ($env{'environment.inststatus'}) {
                   7983:                                         my @inststatuses = split(/,/,$env{'environment.inststatus'});
                   7984:                                         foreach my $type (@inststatuses) {
                   7985:                                             if (($type ne '') &&
                   7986:                                                 ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
                   7987:                                                 $refused = '';
                   7988:                                             }
                   7989:                                         }
                   7990:                                     } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
                   7991:                                         $refused = '';
                   7992:                                     }
                   7993:                                 }
                   7994:                             }
                   7995:                         }
                   7996:                     }
1.1017    raeburn  7997:                 }
                   7998:                 if ($refused) {
1.947     raeburn  7999:                     &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
                   8000:                              ' '.$role.' '.$end.' '.$start.' by '.
                   8001: 	  	             $env{'user.name'}.' at '.$env{'user.domain'});
                   8002:                     return 'refused';
                   8003:                 }
1.932     raeburn  8004:             }
1.1131    raeburn  8005:         } elsif ($role eq 'au') {
                   8006:             if ($url ne '/'.$udom.'/') {
                   8007:                 &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
                   8008:                          ' to assign author role for '.$uname.':'.$udom.
                   8009:                          ' in domain: '.$url.' refused (wrong domain).');
                   8010:                 return 'refused';
                   8011:             }
1.104     www      8012:         }
1.21      www      8013:         $mrole=$role;
                   8014:     }
1.620     albertel 8015:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21      www      8016:                 "$udom:$uname:$url".'_'."$mrole=$role";
1.81      www      8017:     if ($end) { $command.='_'.$end; }
1.21      www      8018:     if ($start) {
                   8019: 	if ($end) { 
1.81      www      8020:            $command.='_'.$start; 
1.21      www      8021:         } else {
1.81      www      8022:            $command.='_0_'.$start;
1.21      www      8023:         }
                   8024:     }
1.739     raeburn  8025:     my $origstart = $start;
                   8026:     my $origend = $end;
1.957     raeburn  8027:     my $delflag;
1.357     www      8028: # actually delete
                   8029:     if ($deleteflag) {
1.373     www      8030: 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357     www      8031: # modify command to delete the role
1.620     albertel 8032:            $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357     www      8033:                 "$udom:$uname:$url".'_'."$mrole";
1.620     albertel 8034: 	   &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 
1.357     www      8035: # set start and finish to negative values for userrolelog
                   8036:            $start=-1;
                   8037:            $end=-1;
1.957     raeburn  8038:            $delflag = 1;
1.357     www      8039:         }
                   8040:     }
                   8041: # send command
1.349     www      8042:     my $answer=&reply($command,&homeserver($uname,$udom));
1.357     www      8043: # log new user role if status is ok
1.349     www      8044:     if ($answer eq 'ok') {
1.663     raeburn  8045: 	&userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184    raeburn  8046:         if (($role eq 'cc') || ($role eq 'in') ||
                   8047:             ($role eq 'ep') || ($role eq 'ad') ||
                   8048:             ($role eq 'ta') || ($role eq 'st') ||
                   8049:             ($role=~/^cr/) || ($role eq 'gr') ||
                   8050:             ($role eq 'co')) {
1.1200    raeburn  8051: # for course roles, perform group memberships changes triggered by role change.
                   8052:             unless ($role =~ /^gr/) {
                   8053:                 &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
                   8054:                                                  $origstart,$selfenroll,$context);
                   8055:             }
1.1184    raeburn  8056:             &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   8057:                            $selfenroll,$context);
                   8058:         } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
                   8059:                  ($role eq 'au') || ($role eq 'dc')) {
                   8060:             &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   8061:                            $context);
                   8062:         } elsif (($role eq 'ca') || ($role eq 'aa')) {
                   8063:             &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   8064:                              $context); 
                   8065:         }
1.1053    raeburn  8066:         if ($role eq 'cc') {
                   8067:             &autoupdate_coowners($url,$end,$start,$uname,$udom);
                   8068:         }
1.349     www      8069:     }
                   8070:     return $answer;
1.169     harris41 8071: }
                   8072: 
1.1053    raeburn  8073: sub autoupdate_coowners {
                   8074:     my ($url,$end,$start,$uname,$udom) = @_;
                   8075:     my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
                   8076:     if (($cdom ne '') && ($cnum ne '')) {
                   8077:         my $now = time;
                   8078:         my %domdesign = &Apache::loncommon::get_domainconf($cdom);
                   8079:         if ($domdesign{$cdom.'.autoassign.co-owners'}) {
                   8080:             my %coursehash = &coursedescription($cdom.'_'.$cnum);
                   8081:             my $instcode = $coursehash{'internal.coursecode'};
                   8082:             if ($instcode ne '') {
1.1056    raeburn  8083:                 if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
                   8084:                     unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053    raeburn  8085:                         my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056    raeburn  8086:                         my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
                   8087:                         if ($result eq 'valid') {
                   8088:                             if ($coursehash{'internal.co-owners'}) {
1.1053    raeburn  8089:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   8090:                                     push(@newcoowners,$coowner);
                   8091:                                 }
                   8092:                                 unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
                   8093:                                     push(@newcoowners,$uname.':'.$udom);
                   8094:                                 }
                   8095:                                 @newcoowners = sort(@newcoowners);
                   8096:                             } else {
                   8097:                                 push(@newcoowners,$uname.':'.$udom);
                   8098:                             }
                   8099:                         } else {
                   8100:                             if ($coursehash{'internal.co-owners'}) {
                   8101:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   8102:                                     unless ($coowner eq $uname.':'.$udom) {
                   8103:                                         push(@newcoowners,$coowner);
                   8104:                                     }
                   8105:                                 }
                   8106:                                 unless (@newcoowners > 0) {
                   8107:                                     $delcoowners = 1;
                   8108:                                     $coowners = '';
                   8109:                                 }
                   8110:                             }
                   8111:                         }
                   8112:                         if (@newcoowners || $delcoowners) {
                   8113:                             &store_coowners($cdom,$cnum,$coursehash{'home'},
                   8114:                                             $delcoowners,@newcoowners);
                   8115:                         }
                   8116:                     }
                   8117:                 }
                   8118:             }
                   8119:         }
                   8120:     }
                   8121: }
                   8122: 
                   8123: sub store_coowners {
                   8124:     my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
                   8125:     my $cid = $cdom.'_'.$cnum;
                   8126:     my ($coowners,$delresult,$putresult);
                   8127:     if (@newcoowners) {
                   8128:         $coowners = join(',',@newcoowners);
                   8129:         my %coownershash = (
                   8130:                             'internal.co-owners' => $coowners,
                   8131:                            );
                   8132:         $putresult = &put('environment',\%coownershash,$cdom,$cnum);
                   8133:         if ($putresult eq 'ok') {
                   8134:             if ($env{'course.'.$cid.'.num'} eq $cnum) {
                   8135:                 &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
                   8136:             }
                   8137:         }
                   8138:     }
                   8139:     if ($delcoowners) {
                   8140:         $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
                   8141:         if ($delresult eq 'ok') {
                   8142:             if ($env{'course.'.$cid.'.internal.co-owners'}) {
                   8143:                 &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
                   8144:             }
                   8145:         }
                   8146:     }
                   8147:     if (($putresult eq 'ok') || ($delresult eq 'ok')) {
                   8148:         my %crsinfo =
                   8149:             &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
                   8150:         if (ref($crsinfo{$cid}) eq 'HASH') {
                   8151:             $crsinfo{$cid}{'co-owners'} = \@newcoowners;
                   8152:             my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
                   8153:         }
                   8154:     }
                   8155: }
                   8156: 
1.169     harris41 8157: # -------------------------------------------------- Modify user authentication
1.197     www      8158: # Overrides without validation
                   8159: 
1.169     harris41 8160: sub modifyuserauth {
                   8161:     my ($udom,$uname,$umode,$upass)=@_;
                   8162:     my $uhome=&homeserver($uname,$udom);
1.197     www      8163:     unless (&allowed('mau',$udom)) { return 'refused'; }
                   8164:     &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620     albertel 8165:              $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   8166:              ' in domain '.$env{'request.role.domain'});  
1.169     harris41 8167:     my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
                   8168: 		     &escape($upass),$uhome);
1.620     albertel 8169:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197     www      8170:         'Authentication changed for '.$udom.', '.$uname.', '.$umode.
                   8171:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
                   8172:     &log($udom,,$uname,$uhome,
1.620     albertel 8173:         'Authentication changed by '.$env{'user.domain'}.', '.
                   8174:                                      $env{'user.name'}.', '.$umode.
1.197     www      8175:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169     harris41 8176:     unless ($reply eq 'ok') {
1.197     www      8177:         &logthis('Authentication mode error: '.$reply);
1.169     harris41 8178: 	return 'error: '.$reply;
                   8179:     }   
1.170     harris41 8180:     return 'ok';
1.80      www      8181: }
                   8182: 
1.81      www      8183: # --------------------------------------------------------------- Modify a user
1.80      www      8184: 
1.81      www      8185: sub modifyuser {
1.206     matthew  8186:     my ($udom,    $uname, $uid,
                   8187:         $umode,   $upass, $first,
                   8188:         $middle,  $last,  $gene,
1.1058    raeburn  8189:         $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807     albertel 8190:     $udom= &LONCAPA::clean_domain($udom);
                   8191:     $uname=&LONCAPA::clean_username($uname);
1.1059    raeburn  8192:     my $showcandelete = 'none';
                   8193:     if (ref($candelete) eq 'ARRAY') {
                   8194:         if (@{$candelete} > 0) {
                   8195:             $showcandelete = join(', ',@{$candelete});
                   8196:         }
                   8197:     }
1.81      www      8198:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80      www      8199:              $umode.', '.$first.', '.$middle.', '.
1.1059    raeburn  8200: 	     $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206     matthew  8201:              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
                   8202:                                      ' desiredhome not specified'). 
1.620     albertel 8203:              ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   8204:              ' in domain '.$env{'request.role.domain'});
1.230     stredwic 8205:     my $uhome=&homeserver($uname,$udom,'true');
1.1075    raeburn  8206:     my $newuser;
                   8207:     if ($uhome eq 'no_host') {
                   8208:         $newuser = 1;
                   8209:     }
1.80      www      8210: # ----------------------------------------------------------------- Create User
1.406     albertel 8211:     if (($uhome eq 'no_host') && 
                   8212: 	(($umode && $upass) || ($umode eq 'localauth'))) {
1.80      www      8213:         my $unhome='';
1.844     albertel 8214:         if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 
1.209     matthew  8215:             $unhome = $desiredhome;
1.620     albertel 8216: 	} elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
                   8217: 	    $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209     matthew  8218:         } else { # load balancing routine for determining $unhome
1.81      www      8219:             my $loadm=10000000;
1.841     albertel 8220: 	    my %servers = &get_servers($udom,'library');
                   8221: 	    foreach my $tryserver (keys(%servers)) {
                   8222: 		my $answer=reply('load',$tryserver);
                   8223: 		if (($answer=~/\d+/) && ($answer<$loadm)) {
                   8224: 		    $loadm=$answer;
                   8225: 		    $unhome=$tryserver;
                   8226: 		}
1.80      www      8227: 	    }
                   8228:         }
                   8229:         if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206     matthew  8230: 	    return 'error: unable to find a home server for '.$uname.
                   8231:                    ' in domain '.$udom;
1.80      www      8232:         }
                   8233:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
                   8234:                          &escape($upass),$unhome);
                   8235: 	unless ($reply eq 'ok') {
                   8236:             return 'error: '.$reply;
                   8237:         }   
1.230     stredwic 8238:         $uhome=&homeserver($uname,$udom,'true');
1.80      www      8239:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386     matthew  8240: 	    return 'error: unable verify users home machine.';
1.80      www      8241:         }
1.209     matthew  8242:     }   # End of creation of new user
1.80      www      8243: # ---------------------------------------------------------------------- Add ID
                   8244:     if ($uid) {
                   8245:        $uid=~tr/A-Z/a-z/;
                   8246:        my %uidhash=&idrget($udom,$uname);
1.196     www      8247:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 
                   8248:          && (!$forceid)) {
1.80      www      8249: 	  unless ($uid eq $uidhash{$uname}) {
1.386     matthew  8250: 	      return 'error: user id "'.$uid.'" does not match '.
                   8251:                   'current user id "'.$uidhash{$uname}.'".';
1.80      www      8252:           }
                   8253:        } else {
                   8254: 	  &idput($udom,($uname => $uid));
                   8255:        }
                   8256:     }
                   8257: # -------------------------------------------------------------- Add names, etc
1.313     matthew  8258:     my @tmp=&get('environment',
1.899     raeburn  8259: 		   ['firstname','middlename','lastname','generation','id',
1.963     raeburn  8260:                     'permanentemail','inststatus'],
1.134     albertel 8261: 		   $udom,$uname);
1.1075    raeburn  8262:     my (%names,%oldnames);
1.313     matthew  8263:     if ($tmp[0] =~ m/^error:.*/) { 
                   8264:         %names=(); 
                   8265:     } else {
                   8266:         %names = @tmp;
1.1075    raeburn  8267:         %oldnames = %names;
1.313     matthew  8268:     }
1.388     www      8269: #
1.1058    raeburn  8270: # If name, email and/or uid are blank (e.g., because an uploaded file
                   8271: # of users did not contain them), do not overwrite existing values
                   8272: # unless field is in $candelete array ref.  
                   8273: #
                   8274: 
                   8275:     my @fields = ('firstname','middlename','lastname','generation',
                   8276:                   'permanentemail','id');
                   8277:     my %newvalues;
                   8278:     if (ref($candelete) eq 'ARRAY') {
                   8279:         foreach my $field (@fields) {
                   8280:             if (grep(/^\Q$field\E$/,@{$candelete})) {
                   8281:                 if ($field eq 'firstname') {
                   8282:                     $names{$field} = $first;
                   8283:                 } elsif ($field eq 'middlename') {
                   8284:                     $names{$field} = $middle;
                   8285:                 } elsif ($field eq 'lastname') {
                   8286:                     $names{$field} = $last;
                   8287:                 } elsif ($field eq 'generation') { 
                   8288:                     $names{$field} = $gene;
                   8289:                 } elsif ($field eq 'permanentemail') {
                   8290:                     $names{$field} = $email;
                   8291:                 } elsif ($field eq 'id') {
                   8292:                     $names{$field}  = $uid;
                   8293:                 }
                   8294:             }
                   8295:         }
                   8296:     }
1.388     www      8297:     if ($first)  { $names{'firstname'}  = $first; }
1.385     matthew  8298:     if (defined($middle)) { $names{'middlename'} = $middle; }
1.388     www      8299:     if ($last)   { $names{'lastname'}   = $last; }
1.385     matthew  8300:     if (defined($gene))   { $names{'generation'} = $gene; }
1.592     www      8301:     if ($email) {
                   8302:        $email=~s/[^\w\@\.\-\,]//gs;
1.963     raeburn  8303:        if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592     www      8304:     }
1.899     raeburn  8305:     if ($uid) { $names{'id'}  = $uid; }
1.989     raeburn  8306:     if (defined($inststatus)) {
                   8307:         $names{'inststatus'} = '';
                   8308:         my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
                   8309:         if (ref($usertypes) eq 'HASH') {
                   8310:             my @okstatuses; 
                   8311:             foreach my $item (split(/:/,$inststatus)) {
                   8312:                 if (defined($usertypes->{$item})) {
                   8313:                     push(@okstatuses,$item);  
                   8314:                 }
                   8315:             }
                   8316:             if (@okstatuses) {
                   8317:                 $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
                   8318:             }
                   8319:         }
                   8320:     }
1.1075    raeburn  8321:     my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963     raeburn  8322:                  $umode.', '.$first.', '.$middle.', '.
1.1075    raeburn  8323:                  $last.', '.$gene.', '.$email.', '.$inststatus;
1.963     raeburn  8324:     if ($env{'user.name'} ne '' && $env{'user.domain'}) {
                   8325:         $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
                   8326:     } else {
                   8327:         $logmsg .= ' during self creation';
                   8328:     }
1.1075    raeburn  8329:     my $changed;
                   8330:     if ($newuser) {
                   8331:         $changed = 1;
                   8332:     } else {
                   8333:         foreach my $field (@fields) {
                   8334:             if ($names{$field} ne $oldnames{$field}) {
                   8335:                 $changed = 1;
                   8336:                 last;
                   8337:             }
                   8338:         }
                   8339:     }
                   8340:     unless ($changed) {
                   8341:         $logmsg = 'No changes in user information needed for: '.$logmsg;
                   8342:         &logthis($logmsg);
                   8343:         return 'ok';
                   8344:     }
                   8345:     my $reply = &put('environment', \%names, $udom,$uname);
                   8346:     if ($reply ne 'ok') { 
                   8347:         return 'error: '.$reply;
                   8348:     }
1.1087    raeburn  8349:     if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
                   8350:         &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
                   8351:     }
1.1075    raeburn  8352:     my $sqlresult = &update_allusers_table($uname,$udom,\%names);
                   8353:     &devalidate_cache_new('namescache',$uname.':'.$udom);
                   8354:     $logmsg = 'Success modifying user '.$logmsg;
1.963     raeburn  8355:     &logthis($logmsg);
1.134     albertel 8356:     return 'ok';
1.80      www      8357: }
                   8358: 
1.81      www      8359: # -------------------------------------------------------------- Modify student
1.80      www      8360: 
1.81      www      8361: sub modifystudent {
                   8362:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957     raeburn  8363:         $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990     raeburn  8364:         $selfenroll,$context,$inststatus)=@_;
1.455     albertel 8365:     if (!$cid) {
1.620     albertel 8366: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 8367: 	    return 'not_in_class';
                   8368: 	}
1.80      www      8369:     }
                   8370: # --------------------------------------------------------------- Make the user
1.81      www      8371:     my $reply=&modifyuser
1.209     matthew  8372: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990     raeburn  8373:          $desiredhome,$email,$inststatus);
1.80      www      8374:     unless ($reply eq 'ok') { return $reply; }
1.297     matthew  8375:     # This will cause &modify_student_enrollment to get the uid from the
                   8376:     # students environment
                   8377:     $uid = undef if (!$forceid);
1.455     albertel 8378:     $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957     raeburn  8379: 					$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297     matthew  8380:     return $reply;
                   8381: }
                   8382: 
                   8383: sub modify_student_enrollment {
1.957     raeburn  8384:     my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455     albertel 8385:     my ($cdom,$cnum,$chome);
                   8386:     if (!$cid) {
1.620     albertel 8387: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 8388: 	    return 'not_in_class';
                   8389: 	}
1.620     albertel 8390: 	$cdom=$env{'course.'.$cid.'.domain'};
                   8391: 	$cnum=$env{'course.'.$cid.'.num'};
1.455     albertel 8392:     } else {
                   8393: 	($cdom,$cnum)=split(/_/,$cid);
                   8394:     }
1.620     albertel 8395:     $chome=$env{'course.'.$cid.'.home'};
1.455     albertel 8396:     if (!$chome) {
1.457     raeburn  8397: 	$chome=&homeserver($cnum,$cdom);
1.297     matthew  8398:     }
1.455     albertel 8399:     if (!$chome) { return 'unknown_course'; }
1.297     matthew  8400:     # Make sure the user exists
1.81      www      8401:     my $uhome=&homeserver($uname,$udom);
                   8402:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   8403: 	return 'error: no such user';
                   8404:     }
1.297     matthew  8405:     # Get student data if we were not given enough information
                   8406:     if (!defined($first)  || $first  eq '' || 
                   8407:         !defined($last)   || $last   eq '' || 
                   8408:         !defined($uid)    || $uid    eq '' || 
                   8409:         !defined($middle) || $middle eq '' || 
                   8410:         !defined($gene)   || $gene   eq '') {
1.294     matthew  8411:         # They did not supply us with enough data to enroll the student, so
                   8412:         # we need to pick up more information.
1.297     matthew  8413:         my %tmp = &get('environment',
1.294     matthew  8414:                        ['firstname','middlename','lastname', 'generation','id']
1.297     matthew  8415:                        ,$udom,$uname);
                   8416: 
1.800     albertel 8417:         #foreach my $key (keys(%tmp)) {
                   8418:         #    &logthis("key $key = ".$tmp{$key});
1.455     albertel 8419:         #}
1.294     matthew  8420:         $first  = $tmp{'firstname'}  if (!defined($first)  || $first  eq '');
                   8421:         $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
                   8422:         $last   = $tmp{'lastname'}   if (!defined($last)   || $last eq '');
1.297     matthew  8423:         $gene   = $tmp{'generation'} if (!defined($gene)   || $gene eq '');
1.294     matthew  8424:         $uid    = $tmp{'id'}         if (!defined($uid)    || $uid  eq '');
                   8425:     }
1.556     albertel 8426:     my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148    raeburn  8427:     my $user = "$uname:$udom";
                   8428:     my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487     albertel 8429:     my $reply=cput('classlist',
1.1148    raeburn  8430: 		   {$user => 
1.515     raeburn  8431: 			join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487     albertel 8432: 		   $cdom,$cnum);
1.1148    raeburn  8433:     if (($reply eq 'ok') || ($reply eq 'delayed')) {
                   8434:         &devalidate_getsection_cache($udom,$uname,$cid);
                   8435:     } else { 
1.81      www      8436: 	return 'error: '.$reply;
                   8437:     }
1.297     matthew  8438:     # Add student role to user
1.83      www      8439:     my $uurl='/'.$cid;
1.81      www      8440:     $uurl=~s/\_/\//g;
                   8441:     if ($usec) {
                   8442: 	$uurl.='/'.$usec;
                   8443:     }
1.1148    raeburn  8444:     my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
                   8445:                              $selfenroll,$context);
                   8446:     if ($result ne 'ok') {
                   8447:         if ($old_entry{$user} ne '') {
                   8448:             $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
                   8449:         } else {
                   8450:             $reply = &del('classlist',[$user],$cdom,$cnum);
                   8451:         }
                   8452:     }
                   8453:     return $result; 
1.21      www      8454: }
                   8455: 
1.556     albertel 8456: sub format_name {
                   8457:     my ($firstname,$middlename,$lastname,$generation,$first)=@_;
                   8458:     my $name;
                   8459:     if ($first ne 'lastname') {
                   8460: 	$name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
                   8461:     } else {
                   8462: 	if ($lastname=~/\S/) {
                   8463: 	    $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
                   8464: 	    $name=~s/\s+,/,/;
                   8465: 	} else {
                   8466: 	    $name.= $firstname.' '.$middlename.' '.$generation;
                   8467: 	}
                   8468:     }
                   8469:     $name=~s/^\s+//;
                   8470:     $name=~s/\s+$//;
                   8471:     $name=~s/\s+/ /g;
                   8472:     return $name;
                   8473: }
                   8474: 
1.84      www      8475: # ------------------------------------------------- Write to course preferences
                   8476: 
                   8477: sub writecoursepref {
                   8478:     my ($courseid,%prefs)=@_;
                   8479:     $courseid=~s/^\///;
                   8480:     $courseid=~s/\_/\//g;
                   8481:     my ($cdomain,$cnum)=split(/\//,$courseid);
                   8482:     my $chome=homeserver($cnum,$cdomain);
                   8483:     if (($chome eq '') || ($chome eq 'no_host')) { 
                   8484: 	return 'error: no such course';
                   8485:     }
                   8486:     my $cstring='';
1.800     albertel 8487:     foreach my $pref (keys(%prefs)) {
                   8488: 	$cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191     harris41 8489:     }
1.84      www      8490:     $cstring=~s/\&$//;
                   8491:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
                   8492: }
                   8493: 
                   8494: # ---------------------------------------------------------- Make/modify course
                   8495: 
                   8496: sub createcourse {
1.741     raeburn  8497:     my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017    raeburn  8498:         $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84      www      8499:     $url=&declutter($url);
                   8500:     my $cid='';
1.1028    raeburn  8501:     if ($context eq 'requestcourses') {
                   8502:         my $can_create = 0;
                   8503:         my ($ownername,$ownerdom) = split(':',$course_owner);
                   8504:         if ($udom eq $ownerdom) {
                   8505:             if (&usertools_access($ownername,$ownerdom,$category,undef,
                   8506:                                   $context)) {
                   8507:                 $can_create = 1;
                   8508:             }
                   8509:         } else {
                   8510:             my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
                   8511:                                            $category);
                   8512:             if ($userenv{'reqcrsotherdom.'.$category} ne '') {
                   8513:                 my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
                   8514:                 if (@curr > 0) {
                   8515:                     my @options = qw(approval validate autolimit);
                   8516:                     my $optregex = join('|',@options);
                   8517:                     if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
                   8518:                         $can_create = 1;
                   8519:                     }
                   8520:                 }
                   8521:             }
                   8522:         }
                   8523:         if ($can_create) {
                   8524:             unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
                   8525:                 unless (&allowed('ccc',$udom)) {
                   8526:                     return 'refused'; 
                   8527:                 }
1.1017    raeburn  8528:             }
                   8529:         } else {
                   8530:             return 'refused';
                   8531:         }
1.1028    raeburn  8532:     } elsif (!&allowed('ccc',$udom)) {
                   8533:         return 'refused';
1.84      www      8534:     }
1.1011    raeburn  8535: # --------------------------------------------------------------- Get Unique ID
                   8536:     my $uname;
                   8537:     if ($cnum =~ /^$match_courseid$/) {
                   8538:         my $chome=&homeserver($cnum,$udom,'true');
                   8539:         if (($chome eq '') || ($chome eq 'no_host')) {
                   8540:             $uname = $cnum;
                   8541:         } else {
1.1038    raeburn  8542:             $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  8543:         }
                   8544:     } else {
1.1038    raeburn  8545:         $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  8546:     }
                   8547:     return $uname if ($uname =~ /^error/);
                   8548: # -------------------------------------------------- Check supplied server name
1.1052    raeburn  8549:     if (!defined($course_server)) {
                   8550:         if (defined(&domain($udom,'primary'))) {
                   8551:             $course_server = &domain($udom,'primary');
                   8552:         } else {
                   8553:             $course_server = $env{'user.home'}; 
                   8554:         }
                   8555:     }
                   8556:     my %host_servers =
                   8557:         &Apache::lonnet::get_servers($udom,'library');
                   8558:     unless ($host_servers{$course_server}) {
                   8559:         return 'error: invalid home server for course: '.$course_server;
1.264     matthew  8560:     }
1.84      www      8561: # ------------------------------------------------------------- Make the course
                   8562:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264     matthew  8563:                       $course_server);
1.84      www      8564:     unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011    raeburn  8565:     my $uhome=&homeserver($uname,$udom,'true');
1.84      www      8566:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   8567: 	return 'error: no such course';
                   8568:     }
1.271     www      8569: # ----------------------------------------------------------------- Course made
1.516     raeburn  8570: # log existence
1.1029    raeburn  8571:     my $now = time;
1.918     raeburn  8572:     my $newcourse = {
                   8573:                     $udom.'_'.$uname => {
1.921     raeburn  8574:                                      description => $description,
                   8575:                                      inst_code   => $inst_code,
                   8576:                                      owner       => $course_owner,
                   8577:                                      type        => $crstype,
1.1029    raeburn  8578:                                      creator     => $env{'user.name'}.':'.
                   8579:                                                     $env{'user.domain'},
                   8580:                                      created     => $now,
                   8581:                                      context     => $context,
1.918     raeburn  8582:                                                 },
                   8583:                     };
1.921     raeburn  8584:     &courseidput($udom,$newcourse,$uhome,'notime');
1.358     www      8585: # set toplevel url
1.271     www      8586:     my $topurl=$url;
                   8587:     unless ($nonstandard) {
                   8588: # ------------------------------------------ For standard courses, make top url
                   8589:         my $mapurl=&clutter($url);
1.278     www      8590:         if ($mapurl eq '/res/') { $mapurl=''; }
1.620     albertel 8591:         $env{'form.initmap'}=(<<ENDINITMAP);
1.271     www      8592: <map>
                   8593: <resource id="1" type="start"></resource>
                   8594: <resource id="2" src="$mapurl"></resource>
                   8595: <resource id="3" type="finish"></resource>
                   8596: <link index="1" from="1" to="2"></link>
                   8597: <link index="2" from="2" to="3"></link>
                   8598: </map>
                   8599: ENDINITMAP
                   8600:         $topurl=&declutter(
1.638     albertel 8601:         &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271     www      8602:                           );
                   8603:     }
                   8604: # ----------------------------------------------------------- Write preferences
1.84      www      8605:     &writecoursepref($udom.'_'.$uname,
1.1056    raeburn  8606:                      ('description'              => $description,
                   8607:                       'url'                      => $topurl,
                   8608:                       'internal.creator'         => $env{'user.name'}.':'.
                   8609:                                                     $env{'user.domain'},
                   8610:                       'internal.created'         => $now,
                   8611:                       'internal.creationcontext' => $context)
                   8612:                     );
1.84      www      8613:     return '/'.$udom.'/'.$uname;
                   8614: }
                   8615: 
1.1011    raeburn  8616: # ------------------------------------------------------------------- Create ID
                   8617: sub generate_coursenum {
1.1038    raeburn  8618:     my ($udom,$crstype) = @_;
1.1011    raeburn  8619:     my $domdesc = &domain($udom);
                   8620:     return 'error: invalid domain' if ($domdesc eq '');
1.1038    raeburn  8621:     my $first;
                   8622:     if ($crstype eq 'Community') {
                   8623:         $first = '0';
                   8624:     } else {
                   8625:         $first = int(1+rand(9)); 
                   8626:     } 
                   8627:     my $uname=$first.
1.1011    raeburn  8628:         ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   8629:         substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   8630:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   8631: # ----------------------------------------------- Make sure that does not exist
                   8632:     my $uhome=&homeserver($uname,$udom,'true');
                   8633:     unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038    raeburn  8634:         if ($crstype eq 'Community') {
                   8635:             $first = '0';
                   8636:         } else {
                   8637:             $first = int(1+rand(9));
                   8638:         }
                   8639:         $uname=$first.
1.1011    raeburn  8640:                ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   8641:                substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   8642:                unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   8643:         $uhome=&homeserver($uname,$udom,'true');
                   8644:         unless (($uhome eq '') || ($uhome eq 'no_host')) {
                   8645:             return 'error: unable to generate unique course-ID';
                   8646:         }
                   8647:     }
                   8648:     return $uname;
                   8649: }
                   8650: 
1.813     albertel 8651: sub is_course {
1.1167    droeschl 8652:     my ($cdom, $cnum) = scalar(@_) == 1 ? 
                   8653:          ($_[0] =~ /^($match_domain)_($match_courseid)$/)  :  @_;
                   8654: 
                   8655:     return unless $cdom and $cnum;
                   8656: 
                   8657:     my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
                   8658:         '.');
                   8659: 
                   8660:     return unless exists($courses{$cdom.'_'.$cnum});
                   8661:     return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813     albertel 8662: }
                   8663: 
1.1015    raeburn  8664: sub store_userdata {
                   8665:     my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013    raeburn  8666:     my $result;
1.1016    raeburn  8667:     if ($datakey ne '') {
1.1013    raeburn  8668:         if (ref($storehash) eq 'HASH') {
1.1017    raeburn  8669:             if ($udom eq '' || $uname eq '') {
                   8670:                 $udom = $env{'user.domain'};
                   8671:                 $uname = $env{'user.name'};
                   8672:             }
                   8673:             my $uhome=&homeserver($uname,$udom);
1.1013    raeburn  8674:             if (($uhome eq '') || ($uhome eq 'no_host')) {
                   8675:                 $result = 'error: no_host';
                   8676:             } else {
                   8677:                 $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
                   8678:                 $storehash->{'host'} = $perlvar{'lonHostID'};
                   8679: 
                   8680:                 my $namevalue='';
                   8681:                 foreach my $key (keys(%{$storehash})) {
                   8682:                     $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   8683:                 }
                   8684:                 $namevalue=~s/\&$//;
1.1105    raeburn  8685:                 $result =  &reply("store:$udom:$uname:$namespace:$datakey:".
                   8686:                                   $namevalue,$uhome);
1.1013    raeburn  8687:             }
                   8688:         } else {
                   8689:             $result = 'error: data to store was not a hash reference'; 
                   8690:         }
                   8691:     } else {
                   8692:         $result= 'error: invalid requestkey'; 
                   8693:     }
                   8694:     return $result;
                   8695: }
                   8696: 
1.21      www      8697: # ---------------------------------------------------------- Assign Custom Role
                   8698: 
                   8699: sub assigncustomrole {
1.957     raeburn  8700:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21      www      8701:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957     raeburn  8702:                        $end,$start,$deleteflag,$selfenroll,$context);
1.21      www      8703: }
                   8704: 
                   8705: # ----------------------------------------------------------------- Revoke Role
                   8706: 
                   8707: sub revokerole {
1.957     raeburn  8708:     my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21      www      8709:     my $now=time;
1.965     raeburn  8710:     return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21      www      8711: }
                   8712: 
                   8713: # ---------------------------------------------------------- Revoke Custom Role
                   8714: 
                   8715: sub revokecustomrole {
1.957     raeburn  8716:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21      www      8717:     my $now=time;
1.357     www      8718:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957     raeburn  8719:            $deleteflag,$selfenroll,$context);
1.17      www      8720: }
                   8721: 
1.533     banghart 8722: # ------------------------------------------------------------ Disk usage
1.535     albertel 8723: sub diskusage {
1.955     raeburn  8724:     my ($udom,$uname,$directorypath,$getpropath)=@_;
                   8725:     $directorypath =~ s/\/$//;
                   8726:     my $listing=&reply('du2:'.&escape($directorypath).':'
                   8727:                        .&escape($getpropath).':'.&escape($uname).':'
                   8728:                        .&escape($udom),homeserver($uname,$udom));
                   8729:     if ($listing eq 'unknown_cmd') {
                   8730:         if ($getpropath) {
                   8731:             $directorypath = &propath($udom,$uname).'/'.$directorypath; 
                   8732:         }
                   8733:         $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
                   8734:     }
1.514     albertel 8735:     return $listing;
1.512     banghart 8736: }
                   8737: 
1.566     banghart 8738: sub is_locked {
1.1096    raeburn  8739:     my ($file_name, $domain, $user, $which) = @_;
1.566     banghart 8740:     my @check;
                   8741:     my $is_locked;
1.1093    raeburn  8742:     push (@check,$file_name);
1.613     albertel 8743:     my %locked = &get('file_permissions',\@check,
1.620     albertel 8744: 		      $env{'user.domain'},$env{'user.name'});
1.615     albertel 8745:     my ($tmp)=keys(%locked);
                   8746:     if ($tmp=~/^error:/) { undef(%locked); }
1.745     raeburn  8747:     
1.566     banghart 8748:     if (ref($locked{$file_name}) eq 'ARRAY') {
1.745     raeburn  8749:         $is_locked = 'false';
                   8750:         foreach my $entry (@{$locked{$file_name}}) {
1.1096    raeburn  8751:            if (ref($entry) eq 'ARRAY') {
1.746     raeburn  8752:                $is_locked = 'true';
1.1096    raeburn  8753:                if (ref($which) eq 'ARRAY') {
                   8754:                    push(@{$which},$entry);
                   8755:                } else {
                   8756:                    last;
                   8757:                }
1.745     raeburn  8758:            }
                   8759:        }
1.566     banghart 8760:     } else {
                   8761:         $is_locked = 'false';
                   8762:     }
1.1093    raeburn  8763:     return $is_locked;
1.566     banghart 8764: }
                   8765: 
1.759     albertel 8766: sub declutter_portfile {
                   8767:     my ($file) = @_;
1.833     albertel 8768:     $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759     albertel 8769:     return $file;
                   8770: }
                   8771: 
1.559     banghart 8772: # ------------------------------------------------------------- Mark as Read Only
                   8773: 
                   8774: sub mark_as_readonly {
                   8775:     my ($domain,$user,$files,$what) = @_;
1.613     albertel 8776:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 8777:     my ($tmp)=keys(%current_permissions);
                   8778:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560     banghart 8779:     foreach my $file (@{$files}) {
1.759     albertel 8780: 	$file = &declutter_portfile($file);
1.561     banghart 8781:         push(@{$current_permissions{$file}},$what);
1.559     banghart 8782:     }
1.613     albertel 8783:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 8784:     return;
                   8785: }
                   8786: 
1.572     banghart 8787: # ------------------------------------------------------------Save Selected Files
                   8788: 
                   8789: sub save_selected_files {
                   8790:     my ($user, $path, @files) = @_;
                   8791:     my $filename = $user."savedfiles";
1.573     banghart 8792:     my @other_files = &files_not_in_path($user, $path);
1.871     albertel 8793:     open (OUT, '>'.$tmpdir.$filename);
1.573     banghart 8794:     foreach my $file (@files) {
1.620     albertel 8795:         print (OUT $env{'form.currentpath'}.$file."\n");
1.573     banghart 8796:     }
                   8797:     foreach my $file (@other_files) {
1.574     banghart 8798:         print (OUT $file."\n");
1.572     banghart 8799:     }
1.574     banghart 8800:     close (OUT);
1.572     banghart 8801:     return 'ok';
                   8802: }
                   8803: 
1.574     banghart 8804: sub clear_selected_files {
                   8805:     my ($user) = @_;
                   8806:     my $filename = $user."savedfiles";
1.1117    foxr     8807:     open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574     banghart 8808:     print (OUT undef);
                   8809:     close (OUT);
                   8810:     return ("ok");    
                   8811: }
                   8812: 
1.572     banghart 8813: sub files_in_path {
                   8814:     my ($user, $path) = @_;
                   8815:     my $filename = $user."savedfiles";
                   8816:     my %return_files;
1.1117    foxr     8817:     open (IN, '<'.LONCAPA::tempdir().$filename);
1.573     banghart 8818:     while (my $line_in = <IN>) {
1.574     banghart 8819:         chomp ($line_in);
                   8820:         my @paths_and_file = split (m!/!, $line_in);
                   8821:         my $file_part = pop (@paths_and_file);
                   8822:         my $path_part = join ('/', @paths_and_file);
1.573     banghart 8823:         $path_part.='/';
                   8824:         my $path_and_file = $path_part.$file_part;
                   8825:         if ($path_part eq $path) {
                   8826:             $return_files{$file_part}= 'selected';
                   8827:         }
                   8828:     }
1.574     banghart 8829:     close (IN);
                   8830:     return (\%return_files);
1.572     banghart 8831: }
                   8832: 
                   8833: # called in portfolio select mode, to show files selected NOT in current directory
                   8834: sub files_not_in_path {
                   8835:     my ($user, $path) = @_;
                   8836:     my $filename = $user."savedfiles";
                   8837:     my @return_files;
                   8838:     my $path_part;
1.1117    foxr     8839:     open(IN, '<'.LONCAPA::.$filename);
1.800     albertel 8840:     while (my $line = <IN>) {
1.572     banghart 8841:         #ok, I know it's clunky, but I want it to work
1.800     albertel 8842:         my @paths_and_file = split(m|/|, $line);
                   8843:         my $file_part = pop(@paths_and_file);
                   8844:         chomp($file_part);
                   8845:         my $path_part = join('/', @paths_and_file);
1.572     banghart 8846:         $path_part .= '/';
                   8847:         my $path_and_file = $path_part.$file_part;
                   8848:         if ($path_part ne $path) {
1.800     albertel 8849:             push(@return_files, ($path_and_file));
1.572     banghart 8850:         }
                   8851:     }
1.800     albertel 8852:     close(OUT);
1.574     banghart 8853:     return (@return_files);
1.572     banghart 8854: }
                   8855: 
1.745     raeburn  8856: #----------------------------------------------Get portfolio file permissions
1.629     banghart 8857: 
1.745     raeburn  8858: sub get_portfile_permissions {
                   8859:     my ($domain,$user) = @_;
1.613     albertel 8860:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 8861:     my ($tmp)=keys(%current_permissions);
                   8862:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  8863:     return \%current_permissions;
                   8864: }
                   8865: 
                   8866: #---------------------------------------------Get portfolio file access controls
                   8867: 
1.749     raeburn  8868: sub get_access_controls {
1.745     raeburn  8869:     my ($current_permissions,$group,$file) = @_;
1.769     albertel 8870:     my %access;
                   8871:     my $real_file = $file;
                   8872:     $file =~ s/\.meta$//;
1.745     raeburn  8873:     if (defined($file)) {
1.749     raeburn  8874:         if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
                   8875:             foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769     albertel 8876:                 $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749     raeburn  8877:             }
                   8878:         }
1.745     raeburn  8879:     } else {
1.749     raeburn  8880:         foreach my $key (keys(%{$current_permissions})) {
                   8881:             if ($key =~ /\0accesscontrol$/) {
                   8882:                 if (defined($group)) {
                   8883:                     if ($key !~ m-^\Q$group\E/-) {
                   8884:                         next;
                   8885:                     }
                   8886:                 }
                   8887:                 my ($fullpath) = split(/\0/,$key);
                   8888:                 if (ref($$current_permissions{$key}) eq 'HASH') {
                   8889:                     foreach my $control (keys(%{$$current_permissions{$key}})) {
                   8890:                         $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
                   8891:                     }
                   8892:                 }
                   8893:             }
                   8894:         }
                   8895:     }
                   8896:     return %access;
                   8897: }
                   8898: 
                   8899: sub modify_access_controls {
                   8900:     my ($file_name,$changes,$domain,$user)=@_;
                   8901:     my ($outcome,$deloutcome);
                   8902:     my %store_permissions;
                   8903:     my %new_values;
                   8904:     my %new_control;
                   8905:     my %translation;
                   8906:     my @deletions = ();
                   8907:     my $now = time;
                   8908:     if (exists($$changes{'activate'})) {
                   8909:         if (ref($$changes{'activate'}) eq 'HASH') {
                   8910:             my @newitems = sort(keys(%{$$changes{'activate'}}));
                   8911:             my $numnew = scalar(@newitems);
                   8912:             for (my $i=0; $i<$numnew; $i++) {
                   8913:                 my $newkey = $newitems[$i];
                   8914:                 my $newid = &Apache::loncommon::get_cgi_id();
1.797     raeburn  8915:                 if ($newkey =~ /^\d+:/) { 
                   8916:                     $newkey =~ s/^(\d+)/$newid/;
                   8917:                     $translation{$1} = $newid;
                   8918:                 } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
                   8919:                     $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
                   8920:                     $translation{$1} = $newid;
                   8921:                 }
1.749     raeburn  8922:                 $new_values{$file_name."\0".$newkey} = 
                   8923:                                           $$changes{'activate'}{$newitems[$i]};
                   8924:                 $new_control{$newkey} = $now;
                   8925:             }
                   8926:         }
                   8927:     }
                   8928:     my %todelete;
                   8929:     my %changed_items;
                   8930:     foreach my $action ('delete','update') {
                   8931:         if (exists($$changes{$action})) {
                   8932:             if (ref($$changes{$action}) eq 'HASH') {
                   8933:                 foreach my $key (keys(%{$$changes{$action}})) {
                   8934:                     my ($itemnum) = ($key =~ /^([^:]+):/);
                   8935:                     if ($action eq 'delete') { 
                   8936:                         $todelete{$itemnum} = 1;
                   8937:                     } else {
                   8938:                         $changed_items{$itemnum} = $key;
                   8939:                     }
                   8940:                 }
1.745     raeburn  8941:             }
                   8942:         }
1.749     raeburn  8943:     }
                   8944:     # get lock on access controls for file.
                   8945:     my $lockhash = {
                   8946:                   $file_name."\0".'locked_access_records' => $env{'user.name'}.
                   8947:                                                        ':'.$env{'user.domain'},
                   8948:                    }; 
                   8949:     my $tries = 0;
                   8950:     my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   8951:    
                   8952:     while (($gotlock ne 'ok') && $tries <3) {
                   8953:         $tries ++;
                   8954:         sleep 1;
                   8955:         $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   8956:     }
                   8957:     if ($gotlock eq 'ok') {
                   8958:         my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
                   8959:         my ($tmp)=keys(%curr_permissions);
                   8960:         if ($tmp=~/^error:/) { undef(%curr_permissions); }
                   8961:         if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
                   8962:             my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
                   8963:             if (ref($curr_controls) eq 'HASH') {
                   8964:                 foreach my $control_item (keys(%{$curr_controls})) {
                   8965:                     my ($itemnum) = ($control_item =~ /^([^:]+):/);
                   8966:                     if (defined($todelete{$itemnum})) {
                   8967:                         push(@deletions,$file_name."\0".$control_item);
                   8968:                     } else {
                   8969:                         if (defined($changed_items{$itemnum})) {
                   8970:                             $new_control{$changed_items{$itemnum}} = $now;
                   8971:                             push(@deletions,$file_name."\0".$control_item);
                   8972:                             $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
                   8973:                         } else {
                   8974:                             $new_control{$control_item} = $$curr_controls{$control_item};
                   8975:                         }
                   8976:                     }
1.745     raeburn  8977:                 }
                   8978:             }
                   8979:         }
1.970     raeburn  8980:         my ($group);
                   8981:         if (&is_course($domain,$user)) {
                   8982:             ($group,my $file) = split(/\//,$file_name,2);
                   8983:         }
1.749     raeburn  8984:         $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
                   8985:         $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
                   8986:         $outcome = &put('file_permissions',\%new_values,$domain,$user);
                   8987:         #  remove lock
                   8988:         my @del_lock = ($file_name."\0".'locked_access_records');
                   8989:         my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818     raeburn  8990:         my $sqlresult =
1.970     raeburn  8991:             &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818     raeburn  8992:                                     $group);
1.749     raeburn  8993:     } else {
                   8994:         $outcome = "error: could not obtain lockfile\n";  
1.745     raeburn  8995:     }
1.749     raeburn  8996:     return ($outcome,$deloutcome,\%new_values,\%translation);
1.745     raeburn  8997: }
                   8998: 
1.827     raeburn  8999: sub make_public_indefinitely {
                   9000:     my ($requrl) = @_;
                   9001:     my $now = time;
                   9002:     my $action = 'activate';
                   9003:     my $aclnum = 0;
                   9004:     if (&is_portfolio_url($requrl)) {
                   9005:         my (undef,$udom,$unum,$file_name,$group) =
                   9006:             &parse_portfolio_url($requrl);
                   9007:         my $current_perms = &get_portfile_permissions($udom,$unum);
                   9008:         my %access_controls = &get_access_controls($current_perms,
                   9009:                                                    $group,$file_name);
                   9010:         foreach my $key (keys(%{$access_controls{$file_name}})) {
                   9011:             my ($num,$scope,$end,$start) = 
                   9012:                 ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
                   9013:             if ($scope eq 'public') {
                   9014:                 if ($start <= $now && $end == 0) {
                   9015:                     $action = 'none';
                   9016:                 } else {
                   9017:                     $action = 'update';
                   9018:                     $aclnum = $num;
                   9019:                 }
                   9020:                 last;
                   9021:             }
                   9022:         }
                   9023:         if ($action eq 'none') {
                   9024:              return 'ok';
                   9025:         } else {
                   9026:             my %changes;
                   9027:             my $newend = 0;
                   9028:             my $newstart = $now;
                   9029:             my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
                   9030:             $changes{$action}{$newkey} = {
                   9031:                 type => 'public',
                   9032:                 time => {
                   9033:                     start => $newstart,
                   9034:                     end   => $newend,
                   9035:                 },
                   9036:             };
                   9037:             my ($outcome,$deloutcome,$new_values,$translation) =
                   9038:                 &modify_access_controls($file_name,\%changes,$udom,$unum);
                   9039:             return $outcome;
                   9040:         }
                   9041:     } else {
                   9042:         return 'invalid';
                   9043:     }
                   9044: }
                   9045: 
1.745     raeburn  9046: #------------------------------------------------------Get Marked as Read Only
                   9047: 
                   9048: sub get_marked_as_readonly {
                   9049:     my ($domain,$user,$what,$group) = @_;
                   9050:     my $current_permissions = &get_portfile_permissions($domain,$user);
1.563     banghart 9051:     my @readonly_files;
1.629     banghart 9052:     my $cmp1=$what;
                   9053:     if (ref($what)) { $cmp1=join('',@{$what}) };
1.745     raeburn  9054:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   9055:         if (defined($group)) {
                   9056:             if ($file_name !~ m-^\Q$group\E/-) {
                   9057:                 next;
                   9058:             }
                   9059:         }
1.561     banghart 9060:         if (ref($value) eq "ARRAY"){
                   9061:             foreach my $stored_what (@{$value}) {
1.629     banghart 9062:                 my $cmp2=$stored_what;
1.759     albertel 9063:                 if (ref($stored_what) eq 'ARRAY') {
1.746     raeburn  9064:                     $cmp2=join('',@{$stored_what});
1.745     raeburn  9065:                 }
1.629     banghart 9066:                 if ($cmp1 eq $cmp2) {
1.561     banghart 9067:                     push(@readonly_files, $file_name);
1.745     raeburn  9068:                     last;
1.563     banghart 9069:                 } elsif (!defined($what)) {
                   9070:                     push(@readonly_files, $file_name);
1.745     raeburn  9071:                     last;
1.561     banghart 9072:                 }
                   9073:             }
1.745     raeburn  9074:         }
1.561     banghart 9075:     }
                   9076:     return @readonly_files;
                   9077: }
1.577     banghart 9078: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561     banghart 9079: 
1.577     banghart 9080: sub get_marked_as_readonly_hash {
1.745     raeburn  9081:     my ($current_permissions,$group,$what) = @_;
1.577     banghart 9082:     my %readonly_files;
1.745     raeburn  9083:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   9084:         if (defined($group)) {
                   9085:             if ($file_name !~ m-^\Q$group\E/-) {
                   9086:                 next;
                   9087:             }
                   9088:         }
1.577     banghart 9089:         if (ref($value) eq "ARRAY"){
                   9090:             foreach my $stored_what (@{$value}) {
1.745     raeburn  9091:                 if (ref($stored_what) eq 'ARRAY') {
1.750     banghart 9092:                     foreach my $lock_descriptor(@{$stored_what}) {
                   9093:                         if ($lock_descriptor eq 'graded') {
                   9094:                             $readonly_files{$file_name} = 'graded';
                   9095:                         } elsif ($lock_descriptor eq 'handback') {
                   9096:                             $readonly_files{$file_name} = 'handback';
                   9097:                         } else {
                   9098:                             if (!exists($readonly_files{$file_name})) {
                   9099:                                 $readonly_files{$file_name} = 'locked';
                   9100:                             }
                   9101:                         }
1.745     raeburn  9102:                     }
1.750     banghart 9103:                 } 
1.577     banghart 9104:             }
                   9105:         } 
                   9106:     }
                   9107:     return %readonly_files;
                   9108: }
1.559     banghart 9109: # ------------------------------------------------------------ Unmark as Read Only
                   9110: 
                   9111: sub unmark_as_readonly {
1.629     banghart 9112:     # unmarks $file_name (if $file_name is defined), or all files locked by $what 
                   9113:     # for portfolio submissions, $what contains [$symb,$crsid] 
1.745     raeburn  9114:     my ($domain,$user,$what,$file_name,$group) = @_;
1.759     albertel 9115:     $file_name = &declutter_portfile($file_name);
1.634     albertel 9116:     my $symb_crs = $what;
                   9117:     if (ref($what)) { $symb_crs=join('',@$what); }
1.745     raeburn  9118:     my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615     albertel 9119:     my ($tmp)=keys(%current_permissions);
                   9120:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  9121:     my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650     albertel 9122:     foreach my $file (@readonly_files) {
1.759     albertel 9123: 	my $clean_file = &declutter_portfile($file);
                   9124: 	if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650     albertel 9125: 	my $current_locks = $current_permissions{$file};
1.563     banghart 9126:         my @new_locks;
                   9127:         my @del_keys;
                   9128:         if (ref($current_locks) eq "ARRAY"){
                   9129:             foreach my $locker (@{$current_locks}) {
1.632     albertel 9130:                 my $compare=$locker;
1.749     raeburn  9131:                 if (ref($locker) eq 'ARRAY') {
1.745     raeburn  9132:                     $compare=join('',@{$locker});
1.746     raeburn  9133:                     if ($compare ne $symb_crs) {
                   9134:                         push(@new_locks, $locker);
                   9135:                     }
1.563     banghart 9136:                 }
                   9137:             }
1.650     albertel 9138:             if (scalar(@new_locks) > 0) {
1.563     banghart 9139:                 $current_permissions{$file} = \@new_locks;
                   9140:             } else {
                   9141:                 push(@del_keys, $file);
1.613     albertel 9142:                 &del('file_permissions',\@del_keys, $domain, $user);
1.650     albertel 9143:                 delete($current_permissions{$file});
1.563     banghart 9144:             }
                   9145:         }
1.561     banghart 9146:     }
1.613     albertel 9147:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 9148:     return;
                   9149: }
1.512     banghart 9150: 
1.17      www      9151: # ------------------------------------------------------------ Directory lister
                   9152: 
                   9153: sub dirlist {
1.955     raeburn  9154:     my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18      www      9155:     $uri=~s/^\///;
                   9156:     $uri=~s/\/$//;
1.253     stredwic 9157:     my ($udom, $uname);
1.955     raeburn  9158:     if ($getuserdir) {
1.253     stredwic 9159:         $udom = $userdomain;
                   9160:         $uname = $username;
1.955     raeburn  9161:     } else {
                   9162:         (undef,$udom,$uname)=split(/\//,$uri);
                   9163:         if(defined($userdomain)) {
                   9164:             $udom = $userdomain;
                   9165:         }
                   9166:         if(defined($username)) {
                   9167:             $uname = $username;
                   9168:         }
1.253     stredwic 9169:     }
1.955     raeburn  9170:     my ($dirRoot,$listing,@listing_results);
1.253     stredwic 9171: 
1.955     raeburn  9172:     $dirRoot = $perlvar{'lonDocRoot'};
                   9173:     if (defined($getpropath)) {
                   9174:         $dirRoot = &propath($udom,$uname);
1.253     stredwic 9175:         $dirRoot =~ s/\/$//;
1.955     raeburn  9176:     } elsif (defined($getuserdir)) {
                   9177:         my $subdir=$uname.'__';
                   9178:         $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   9179:         $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
                   9180:                    ."/$udom/$subdir/$uname";
                   9181:     } elsif (defined($alternateRoot)) {
                   9182:         $dirRoot = $alternateRoot;
1.751     banghart 9183:     }
1.253     stredwic 9184: 
                   9185:     if($udom) {
                   9186:         if($uname) {
1.1135    raeburn  9187:             my $uhome = &homeserver($uname,$udom);
1.1136    raeburn  9188:             if ($uhome eq 'no_host') {
                   9189:                 return ([],'no_host');
                   9190:             }
1.955     raeburn  9191:             $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956     raeburn  9192:                               .$getuserdir.':'.&escape($dirRoot)
1.1135    raeburn  9193:                               .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955     raeburn  9194:             if ($listing eq 'unknown_cmd') {
1.1135    raeburn  9195:                 $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955     raeburn  9196:             } else {
                   9197:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   9198:             }
1.605     matthew  9199:             if ($listing eq 'unknown_cmd') {
1.1135    raeburn  9200:                 $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605     matthew  9201:                 @listing_results = split(/:/,$listing);
                   9202:             } else {
                   9203:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   9204:             }
1.1135    raeburn  9205:             if (($listing eq 'no_such_host') || ($listing eq 'con_lost') || 
1.1136    raeburn  9206:                 ($listing eq 'rejected') || ($listing eq 'refused') ||
                   9207:                 ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
                   9208:                 return ([],$listing);
                   9209:             } else {
                   9210:                 return (\@listing_results);
1.1135    raeburn  9211:             }
1.955     raeburn  9212:         } elsif(!$alternateRoot) {
1.1136    raeburn  9213:             my (%allusers,%listerror);
1.841     albertel 9214: 	    my %servers = &get_servers($udom,'library');
1.955     raeburn  9215:  	    foreach my $tryserver (keys(%servers)) {
                   9216:                 $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
                   9217:                                   &escape($udom),$tryserver);
                   9218:                 if ($listing eq 'unknown_cmd') {
                   9219: 		    $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
                   9220: 				      $udom, $tryserver);
                   9221:                 } else {
                   9222:                     @listing_results = map { &unescape($_); } split(/:/,$listing);
                   9223:                 }
1.841     albertel 9224: 		if ($listing eq 'unknown_cmd') {
                   9225: 		    $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
                   9226: 				      $udom, $tryserver);
                   9227: 		    @listing_results = split(/:/,$listing);
                   9228: 		} else {
                   9229: 		    @listing_results =
                   9230: 			map { &unescape($_); } split(/:/,$listing);
                   9231: 		}
1.1136    raeburn  9232:                 if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
                   9233:                     ($listing eq 'rejected') || ($listing eq 'refused') ||
                   9234:                     ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
                   9235:                     $listerror{$tryserver} = $listing;
                   9236:                 } else {
1.841     albertel 9237: 		    foreach my $line (@listing_results) {
                   9238: 			my ($entry) = split(/&/,$line,2);
                   9239: 			$allusers{$entry} = 1;
                   9240: 		    }
                   9241: 		}
1.253     stredwic 9242:             }
1.1136    raeburn  9243:             my @alluserslist=();
1.800     albertel 9244:             foreach my $user (sort(keys(%allusers))) {
1.1136    raeburn  9245:                 push(@alluserslist,$user.'&user');
1.253     stredwic 9246:             }
1.1136    raeburn  9247:             return (\@alluserslist);
1.253     stredwic 9248:         } else {
1.1136    raeburn  9249:             return ([],'missing username');
1.253     stredwic 9250:         }
1.955     raeburn  9251:     } elsif(!defined($getpropath)) {
1.1136    raeburn  9252:         my $path = $perlvar{'lonDocRoot'}.'/res/'; 
                   9253:         my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
                   9254:         return (\@all_domains);
1.955     raeburn  9255:     } else {
1.1136    raeburn  9256:         return ([],'missing domain');
1.275     stredwic 9257:     }
                   9258: }
                   9259: 
                   9260: # --------------------------------------------- GetFileTimestamp
                   9261: # This function utilizes dirlist and returns the date stamp for
                   9262: # when it was last modified.  It will also return an error of -1
                   9263: # if an error occurs
                   9264: 
                   9265: sub GetFileTimestamp {
1.955     raeburn  9266:     my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807     albertel 9267:     $studentDomain = &LONCAPA::clean_domain($studentDomain);
                   9268:     $studentName   = &LONCAPA::clean_username($studentName);
1.1136    raeburn  9269:     my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
                   9270:                                     undef,$getuserdir);
                   9271:     if (($error eq 'empty') || ($error eq 'no_such_dir')) {
                   9272:         return -1;
                   9273:     }
                   9274:     if (ref($fileref) eq 'ARRAY') {
                   9275:         my @stats = split('&',$fileref->[0]);
1.375     matthew  9276:         # @stats contains first the filename, then the stat output
                   9277:         return $stats[10]; # so this is 10 instead of 9.
1.275     stredwic 9278:     } else {
                   9279:         return -1;
1.253     stredwic 9280:     }
1.26      www      9281: }
                   9282: 
1.712     albertel 9283: sub stat_file {
                   9284:     my ($uri) = @_;
1.787     albertel 9285:     $uri = &clutter_with_no_wrapper($uri);
1.722     albertel 9286: 
1.955     raeburn  9287:     my ($udom,$uname,$file);
1.712     albertel 9288:     if ($uri =~ m-^/(uploaded|editupload)/-) {
                   9289: 	($udom,$uname,$file) =
1.811     albertel 9290: 	    ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712     albertel 9291: 	$file = 'userfiles/'.$file;
                   9292:     }
                   9293:     if ($uri =~ m-^/res/-) {
                   9294: 	($udom,$uname) = 
1.807     albertel 9295: 	    ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712     albertel 9296: 	$file = $uri;
                   9297:     }
                   9298: 
                   9299:     if (!$udom || !$uname || !$file) {
                   9300: 	# unable to handle the uri
                   9301: 	return ();
                   9302:     }
1.956     raeburn  9303:     my $getpropath;
                   9304:     if ($file =~ /^userfiles\//) {
                   9305:         $getpropath = 1;
                   9306:     }
1.1136    raeburn  9307:     my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
                   9308:     if (($error eq 'empty') || ($error eq 'no_such_dir')) {
                   9309:         return ();
                   9310:     } else {
                   9311:         if (ref($listref) eq 'ARRAY') {
                   9312:             my @stats = split('&',$listref->[0]);
                   9313: 	    shift(@stats); #filename is first
                   9314: 	    return @stats;
                   9315:         }
1.712     albertel 9316:     }
                   9317:     return ();
                   9318: }
                   9319: 
1.26      www      9320: # -------------------------------------------------------- Value of a Condition
                   9321: 
1.713     albertel 9322: # gets the value of a specific preevaluated condition
                   9323: #    stored in the string  $env{user.state.<cid>}
                   9324: # or looks up a condition reference in the bighash and if if hasn't
                   9325: # already been evaluated recurses into docondval to get the value of
                   9326: # the condition, then memoizing it to 
                   9327: #   $env{user.state.<cid>.<condition>}
1.40      www      9328: sub directcondval {
                   9329:     my $number=shift;
1.620     albertel 9330:     if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555     albertel 9331: 	&Apache::lonuserstate::evalstate();
                   9332:     }
1.713     albertel 9333:     if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
                   9334: 	return $env{'user.state.'.$env{'request.course.id'}.".$number"};
                   9335:     } elsif ($number =~ /^_/) {
                   9336: 	my $sub_condition;
                   9337: 	if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   9338: 		&GDBM_READER(),0640)) {
                   9339: 	    $sub_condition=$bighash{'conditions'.$number};
                   9340: 	    untie(%bighash);
                   9341: 	}
                   9342: 	my $value = &docondval($sub_condition);
1.949     raeburn  9343: 	&appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713     albertel 9344: 	return $value;
                   9345:     }
1.620     albertel 9346:     if ($env{'user.state.'.$env{'request.course.id'}}) {
                   9347:        return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40      www      9348:     } else {
                   9349:        return 2;
                   9350:     }
                   9351: }
                   9352: 
1.713     albertel 9353: # get the collection of conditions for this resource
1.26      www      9354: sub condval {
                   9355:     my $condidx=shift;
1.54      www      9356:     my $allpathcond='';
1.713     albertel 9357:     foreach my $cond (split(/\|/,$condidx)) {
                   9358: 	if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
                   9359: 	    $allpathcond.=
                   9360: 		'('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
                   9361: 	}
1.191     harris41 9362:     }
1.54      www      9363:     $allpathcond=~s/\|$//;
1.713     albertel 9364:     return &docondval($allpathcond);
                   9365: }
                   9366: 
                   9367: #evaluates an expression of conditions
                   9368: sub docondval {
                   9369:     my ($allpathcond) = @_;
                   9370:     my $result=0;
                   9371:     if ($env{'request.course.id'}
                   9372: 	&& defined($allpathcond)) {
                   9373: 	my $operand='|';
                   9374: 	my @stack;
                   9375: 	foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
                   9376: 	    if ($chunk eq '(') {
                   9377: 		push @stack,($operand,$result);
                   9378: 	    } elsif ($chunk eq ')') {
                   9379: 		my $before=pop @stack;
                   9380: 		if (pop @stack eq '&') {
                   9381: 		    $result=$result>$before?$before:$result;
                   9382: 		} else {
                   9383: 		    $result=$result>$before?$result:$before;
                   9384: 		}
                   9385: 	    } elsif (($chunk eq '&') || ($chunk eq '|')) {
                   9386: 		$operand=$chunk;
                   9387: 	    } else {
                   9388: 		my $new=directcondval($chunk);
                   9389: 		if ($operand eq '&') {
                   9390: 		    $result=$result>$new?$new:$result;
                   9391: 		} else {
                   9392: 		    $result=$result>$new?$result:$new;
                   9393: 		}
                   9394: 	    }
                   9395: 	}
1.26      www      9396:     }
                   9397:     return $result;
1.421     albertel 9398: }
                   9399: 
                   9400: # ---------------------------------------------------- Devalidate courseresdata
                   9401: 
                   9402: sub devalidatecourseresdata {
                   9403:     my ($coursenum,$coursedomain)=@_;
                   9404:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 9405:     &devalidate_cache_new('courseres',$hashid);
1.28      www      9406: }
                   9407: 
1.763     www      9408: 
1.200     www      9409: # --------------------------------------------------- Course Resourcedata Query
1.878     foxr     9410: #
                   9411: #  Parameters:
                   9412: #      $coursenum    - Number of the course.
                   9413: #      $coursedomain - Domain at which the course was created.
                   9414: #  Returns:
                   9415: #     A hash of the course parameters along (I think) with timestamps
                   9416: #     and version info.
1.877     foxr     9417: 
1.624     albertel 9418: sub get_courseresdata {
                   9419:     my ($coursenum,$coursedomain)=@_;
1.200     www      9420:     my $coursehom=&homeserver($coursenum,$coursedomain);
                   9421:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 9422:     my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624     albertel 9423:     my %dumpreply;
1.417     albertel 9424:     unless (defined($cached)) {
1.624     albertel 9425: 	%dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417     albertel 9426: 	$result=\%dumpreply;
1.251     albertel 9427: 	my ($tmp) = keys(%dumpreply);
                   9428: 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599     albertel 9429: 	    &do_cache_new('courseres',$hashid,$result,600);
1.306     albertel 9430: 	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
                   9431: 	    return $tmp;
1.416     albertel 9432: 	} elsif ($tmp =~ /^(error)/) {
1.417     albertel 9433: 	    $result=undef;
1.599     albertel 9434: 	    &do_cache_new('courseres',$hashid,$result,600);
1.250     albertel 9435: 	}
                   9436:     }
1.624     albertel 9437:     return $result;
                   9438: }
                   9439: 
1.633     albertel 9440: sub devalidateuserresdata {
                   9441:     my ($uname,$udom)=@_;
                   9442:     my $hashid="$udom:$uname";
                   9443:     &devalidate_cache_new('userres',$hashid);
                   9444: }
                   9445: 
1.624     albertel 9446: sub get_userresdata {
                   9447:     my ($uname,$udom)=@_;
                   9448:     #most student don\'t have any data set, check if there is some data
                   9449:     if (&EXT_cache_status($udom,$uname)) { return undef; }
                   9450: 
                   9451:     my $hashid="$udom:$uname";
                   9452:     my ($result,$cached)=&is_cached_new('userres',$hashid);
                   9453:     if (!defined($cached)) {
                   9454: 	my %resourcedata=&dump('resourcedata',$udom,$uname);
                   9455: 	$result=\%resourcedata;
                   9456: 	&do_cache_new('userres',$hashid,$result,600);
                   9457:     }
                   9458:     my ($tmp)=keys(%$result);
                   9459:     if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
                   9460: 	return $result;
                   9461:     }
                   9462:     #error 2 occurs when the .db doesn't exist
                   9463:     if ($tmp!~/error: 2 /) {
1.672     albertel 9464: 	&logthis("<font color=\"blue\">WARNING:".
1.624     albertel 9465: 		 " Trying to get resource data for ".
                   9466: 		 $uname." at ".$udom.": ".
                   9467: 		 $tmp."</font>");
                   9468:     } elsif ($tmp=~/error: 2 /) {
1.633     albertel 9469: 	#&EXT_cache_set($udom,$uname);
                   9470: 	&do_cache_new('userres',$hashid,undef,600);
1.636     albertel 9471: 	undef($tmp); # not really an error so don't send it back
1.624     albertel 9472:     }
                   9473:     return $tmp;
                   9474: }
1.879     foxr     9475: #----------------------------------------------- resdata - return resource data
                   9476: #  Purpose:
                   9477: #    Return resource data for either users or for a course.
                   9478: #  Parameters:
                   9479: #     $name      - Course/user name.
                   9480: #     $domain    - Name of the domain the user/course is registered on.
                   9481: #     $type      - Type of thing $name is (must be 'course' or 'user'
                   9482: #     @which     - Array of names of resources desired.
                   9483: #  Returns:
                   9484: #     The value of the first reasource in @which that is found in the
                   9485: #     resource hash.
                   9486: #  Exceptional Conditions:
                   9487: #     If the $type passed in is not valid (not the string 'course' or 
                   9488: #     'user', an undefined  reference is returned.
                   9489: #     If none of the resources are found, an undef is returned
1.624     albertel 9490: sub resdata {
                   9491:     my ($name,$domain,$type,@which)=@_;
                   9492:     my $result;
                   9493:     if ($type eq 'course') {
                   9494: 	$result=&get_courseresdata($name,$domain);
                   9495:     } elsif ($type eq 'user') {
                   9496: 	$result=&get_userresdata($name,$domain);
                   9497:     }
                   9498:     if (!ref($result)) { return $result; }    
1.251     albertel 9499:     foreach my $item (@which) {
1.927     albertel 9500: 	if (defined($result->{$item->[0]})) {
                   9501: 	    return [$result->{$item->[0]},$item->[1]];
1.251     albertel 9502: 	}
1.250     albertel 9503:     }
1.291     albertel 9504:     return undef;
1.200     www      9505: }
                   9506: 
1.379     matthew  9507: #
                   9508: # EXT resource caching routines
                   9509: #
                   9510: 
                   9511: sub clear_EXT_cache_status {
1.383     albertel 9512:     &delenv('cache.EXT.');
1.379     matthew  9513: }
                   9514: 
                   9515: sub EXT_cache_status {
                   9516:     my ($target_domain,$target_user) = @_;
1.383     albertel 9517:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620     albertel 9518:     if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379     matthew  9519:         # We know already the user has no data
                   9520:         return 1;
                   9521:     } else {
                   9522:         return 0;
                   9523:     }
                   9524: }
                   9525: 
                   9526: sub EXT_cache_set {
                   9527:     my ($target_domain,$target_user) = @_;
1.383     albertel 9528:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949     raeburn  9529:     #&appenv({$cachename => time});
1.379     matthew  9530: }
                   9531: 
1.28      www      9532: # --------------------------------------------------------- Value of a Variable
1.58      www      9533: sub EXT {
1.715     albertel 9534: 
1.395     albertel 9535:     my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68      www      9536:     unless ($varname) { return ''; }
1.218     albertel 9537:     #get real user name/domain, courseid and symb
                   9538:     my $courseid;
1.359     albertel 9539:     my $publicuser;
1.427     www      9540:     if ($symbparm) {
                   9541: 	$symbparm=&get_symb_from_alias($symbparm);
                   9542:     }
1.218     albertel 9543:     if (!($uname && $udom)) {
1.790     albertel 9544:       (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218     albertel 9545:       if (!$symbparm) {	$symbparm=$cursymb; }
                   9546:     } else {
1.620     albertel 9547: 	$courseid=$env{'request.course.id'};
1.218     albertel 9548:     }
1.48      www      9549:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
                   9550:     my $rest;
1.320     albertel 9551:     if (defined($therest[0])) {
1.48      www      9552:        $rest=join('.',@therest);
                   9553:     } else {
                   9554:        $rest='';
                   9555:     }
1.320     albertel 9556: 
1.57      www      9557:     my $qualifierrest=$qualifier;
                   9558:     if ($rest) { $qualifierrest.='.'.$rest; }
                   9559:     my $spacequalifierrest=$space;
                   9560:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28      www      9561:     if ($realm eq 'user') {
1.48      www      9562: # --------------------------------------------------------------- user.resource
                   9563: 	if ($space eq 'resource') {
1.651     albertel 9564: 	    if ( (defined($Apache::lonhomework::parsing_a_problem)
                   9565: 		  || defined($Apache::lonhomework::parsing_a_task))
                   9566: 		 &&
1.744     albertel 9567: 		 ($symbparm eq &symbread()) ) {	
                   9568: 		# if we are in the middle of processing the resource the
                   9569: 		# get the value we are planning on committing
                   9570:                 if (defined($Apache::lonhomework::results{$qualifierrest})) {
                   9571:                     return $Apache::lonhomework::results{$qualifierrest};
                   9572:                 } else {
                   9573:                     return $Apache::lonhomework::history{$qualifierrest};
                   9574:                 }
1.335     albertel 9575: 	    } else {
1.359     albertel 9576: 		my %restored;
1.620     albertel 9577: 		if ($publicuser || $env{'request.state'} eq 'construct') {
1.359     albertel 9578: 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
                   9579: 		} else {
                   9580: 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
                   9581: 		}
1.335     albertel 9582: 		return $restored{$qualifierrest};
                   9583: 	    }
1.48      www      9584: # ----------------------------------------------------------------- user.access
                   9585:         } elsif ($space eq 'access') {
1.218     albertel 9586: 	    # FIXME - not supporting calls for a specific user
1.48      www      9587:             return &allowed($qualifier,$rest);
                   9588: # ------------------------------------------ user.preferences, user.environment
                   9589:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620     albertel 9590: 	    if (($uname eq $env{'user.name'}) &&
                   9591: 		($udom eq $env{'user.domain'})) {
                   9592: 		return $env{join('.',('environment',$qualifierrest))};
1.218     albertel 9593: 	    } else {
1.359     albertel 9594: 		my %returnhash;
                   9595: 		if (!$publicuser) {
                   9596: 		    %returnhash=&userenvironment($udom,$uname,
                   9597: 						 $qualifierrest);
                   9598: 		}
1.218     albertel 9599: 		return $returnhash{$qualifierrest};
                   9600: 	    }
1.48      www      9601: # ----------------------------------------------------------------- user.course
                   9602:         } elsif ($space eq 'course') {
1.218     albertel 9603: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 9604:             return $env{join('.',('request.course',$qualifier))};
1.48      www      9605: # ------------------------------------------------------------------- user.role
                   9606:         } elsif ($space eq 'role') {
1.218     albertel 9607: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 9608:             my ($role,$where)=split(/\./,$env{'request.role'});
1.48      www      9609:             if ($qualifier eq 'value') {
                   9610: 		return $role;
                   9611:             } elsif ($qualifier eq 'extent') {
                   9612:                 return $where;
                   9613:             }
                   9614: # ----------------------------------------------------------------- user.domain
                   9615:         } elsif ($space eq 'domain') {
1.218     albertel 9616:             return $udom;
1.48      www      9617: # ------------------------------------------------------------------- user.name
                   9618:         } elsif ($space eq 'name') {
1.218     albertel 9619:             return $uname;
1.48      www      9620: # ---------------------------------------------------- Any other user namespace
1.29      www      9621:         } else {
1.359     albertel 9622: 	    my %reply;
                   9623: 	    if (!$publicuser) {
                   9624: 		%reply=&get($space,[$qualifierrest],$udom,$uname);
                   9625: 	    }
                   9626: 	    return $reply{$qualifierrest};
1.48      www      9627:         }
1.236     www      9628:     } elsif ($realm eq 'query') {
                   9629: # ---------------------------------------------- pull stuff out of query string
1.384     albertel 9630:         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                   9631: 						[$spacequalifierrest]);
1.620     albertel 9632: 	return $env{'form.'.$spacequalifierrest}; 
1.236     www      9633:    } elsif ($realm eq 'request') {
1.48      www      9634: # ------------------------------------------------------------- request.browser
                   9635:         if ($space eq 'browser') {
1.1145    bisitz   9636:             return $env{'browser.'.$qualifier};
1.57      www      9637: # ------------------------------------------------------------ request.filename
                   9638:         } else {
1.620     albertel 9639:             return $env{'request.'.$spacequalifierrest};
1.29      www      9640:         }
1.28      www      9641:     } elsif ($realm eq 'course') {
1.48      www      9642: # ---------------------------------------------------------- course.description
1.620     albertel 9643:         return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57      www      9644:     } elsif ($realm eq 'resource') {
1.165     www      9645: 
1.620     albertel 9646: 	if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539     albertel 9647: 	    if (!$symbparm) { $symbparm=&symbread(); }
                   9648: 	}
1.693     albertel 9649: 
                   9650: 	if ($space eq 'title') {
                   9651: 	    if (!$symbparm) { $symbparm = $env{'request.filename'}; }
                   9652: 	    return &gettitle($symbparm);
                   9653: 	}
                   9654: 	
                   9655: 	if ($space eq 'map') {
                   9656: 	    my ($map) = &decode_symb($symbparm);
                   9657: 	    return &symbread($map);
                   9658: 	}
1.905     albertel 9659: 	if ($space eq 'filename') {
                   9660: 	    if ($symbparm) {
                   9661: 		return &clutter((&decode_symb($symbparm))[2]);
                   9662: 	    }
                   9663: 	    return &hreflocation('',$env{'request.filename'});
                   9664: 	}
1.693     albertel 9665: 
                   9666: 	my ($section, $group, @groups);
1.593     albertel 9667: 	my ($courselevelm,$courselevel);
1.539     albertel 9668: 	if ($symbparm && defined($courseid) && 
1.620     albertel 9669: 	    $courseid eq $env{'request.course.id'}) {
1.165     www      9670: 
1.218     albertel 9671: 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165     www      9672: 
1.60      www      9673: # ----------------------------------------------------- Cascading lookup scheme
1.218     albertel 9674: 	    my $symbp=$symbparm;
1.735     albertel 9675: 	    my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218     albertel 9676: 
                   9677: 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
                   9678: 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
                   9679: 
1.620     albertel 9680: 	    if (($env{'user.name'} eq $uname) &&
                   9681: 		($env{'user.domain'} eq $udom)) {
                   9682: 		$section=$env{'request.course.sec'};
1.733     raeburn  9683:                 @groups = split(/:/,$env{'request.course.groups'});  
                   9684:                 @groups=&sort_course_groups($courseid,@groups); 
1.218     albertel 9685: 	    } else {
1.539     albertel 9686: 		if (! defined($usection)) {
1.551     albertel 9687: 		    $section=&getsection($udom,$uname,$courseid);
1.539     albertel 9688: 		} else {
                   9689: 		    $section = $usection;
                   9690: 		}
1.733     raeburn  9691:                 @groups = &get_users_groups($udom,$uname,$courseid);
1.218     albertel 9692: 	    }
                   9693: 
                   9694: 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
                   9695: 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
                   9696: 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
                   9697: 
1.593     albertel 9698: 	    $courselevel=$courseid.'.'.$spacequalifierrest;
1.218     albertel 9699: 	    my $courselevelr=$courseid.'.'.$symbparm;
1.593     albertel 9700: 	    $courselevelm=$courseid.'.'.$mapparm;
1.69      www      9701: 
1.60      www      9702: # ----------------------------------------------------------- first, check user
1.624     albertel 9703: 
                   9704: 	    my $userreply=&resdata($uname,$udom,'user',
1.927     albertel 9705: 				       ([$courselevelr,'resource'],
                   9706: 					[$courselevelm,'map'     ],
                   9707: 					[$courselevel, 'course'  ]));
1.931     albertel 9708: 	    if (defined($userreply)) { return &get_reply($userreply); }
1.95      www      9709: 
1.594     albertel 9710: # ------------------------------------------------ second, check some of course
1.684     raeburn  9711:             my $coursereply;
1.691     raeburn  9712:             if (@groups > 0) {
                   9713:                 $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
                   9714:                                        $mapparm,$spacequalifierrest);
1.927     albertel 9715:                 if (defined($coursereply)) { return &get_reply($coursereply); }
1.684     raeburn  9716:             }
1.96      www      9717: 
1.684     raeburn  9718: 	    $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927     albertel 9719: 				  $env{'course.'.$courseid.'.domain'},
                   9720: 				  'course',
                   9721: 				  ([$seclevelr,   'resource'],
                   9722: 				   [$seclevelm,   'map'     ],
                   9723: 				   [$seclevel,    'course'  ],
                   9724: 				   [$courselevelr,'resource']));
                   9725: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.200     www      9726: 
1.60      www      9727: # ------------------------------------------------------ third, check map parms
1.218     albertel 9728: 	    my %parmhash=();
                   9729: 	    my $thisparm='';
                   9730: 	    if (tie(%parmhash,'GDBM_File',
1.620     albertel 9731: 		    $env{'request.course.fn'}.'_parms.db',
1.256     albertel 9732: 		    &GDBM_READER(),0640)) {
1.218     albertel 9733: 		$thisparm=$parmhash{$symbparm};
                   9734: 		untie(%parmhash);
                   9735: 	    }
1.927     albertel 9736: 	    if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218     albertel 9737: 	}
1.594     albertel 9738: # ------------------------------------------ fourth, look in resource metadata
1.71      www      9739: 
1.218     albertel 9740: 	$spacequalifierrest=~s/\./\_/;
1.282     albertel 9741: 	my $filename;
                   9742: 	if (!$symbparm) { $symbparm=&symbread(); }
                   9743: 	if ($symbparm) {
1.409     www      9744: 	    $filename=(&decode_symb($symbparm))[2];
1.282     albertel 9745: 	} else {
1.620     albertel 9746: 	    $filename=$env{'request.filename'};
1.282     albertel 9747: 	}
                   9748: 	my $metadata=&metadata($filename,$spacequalifierrest);
1.927     albertel 9749: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282     albertel 9750: 	$metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927     albertel 9751: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142     www      9752: 
1.927     albertel 9753: # ---------------------------------------------- fourth, look in rest of course
1.593     albertel 9754: 	if ($symbparm && defined($courseid) && 
1.620     albertel 9755: 	    $courseid eq $env{'request.course.id'}) {
1.624     albertel 9756: 	    my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
                   9757: 				     $env{'course.'.$courseid.'.domain'},
                   9758: 				     'course',
1.927     albertel 9759: 				     ([$courselevelm,'map'   ],
                   9760: 				      [$courselevel, 'course']));
                   9761: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.593     albertel 9762: 	}
1.145     www      9763: # ------------------------------------------------------------------ Cascade up
1.218     albertel 9764: 	unless ($space eq '0') {
1.336     albertel 9765: 	    my @parts=split(/_/,$space);
                   9766: 	    my $id=pop(@parts);
                   9767: 	    my $part=join('_',@parts);
                   9768: 	    if ($part eq '') { $part='0'; }
1.927     albertel 9769: 	    my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395     albertel 9770: 				 $symbparm,$udom,$uname,$section,1);
1.938     raeburn  9771: 	    if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218     albertel 9772: 	}
1.395     albertel 9773: 	if ($recurse) { return undef; }
                   9774: 	my $pack_def=&packages_tab_default($filename,$varname);
1.927     albertel 9775: 	if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48      www      9776: # ---------------------------------------------------- Any other user namespace
                   9777:     } elsif ($realm eq 'environment') {
                   9778: # ----------------------------------------------------------------- environment
1.620     albertel 9779: 	if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
                   9780: 	    return $env{'environment.'.$spacequalifierrest};
1.219     albertel 9781: 	} else {
1.770     albertel 9782: 	    if ($uname eq 'anonymous' && $udom eq '') {
                   9783: 		return '';
                   9784: 	    }
1.219     albertel 9785: 	    my %returnhash=&userenvironment($udom,$uname,
                   9786: 					    $spacequalifierrest);
                   9787: 	    return $returnhash{$spacequalifierrest};
                   9788: 	}
1.28      www      9789:     } elsif ($realm eq 'system') {
1.48      www      9790: # ----------------------------------------------------------------- system.time
                   9791: 	if ($space eq 'time') {
                   9792: 	    return time;
                   9793:         }
1.696     albertel 9794:     } elsif ($realm eq 'server') {
                   9795: # ----------------------------------------------------------------- system.time
                   9796: 	if ($space eq 'name') {
                   9797: 	    return $ENV{'SERVER_NAME'};
                   9798:         }
1.28      www      9799:     }
1.48      www      9800:     return '';
1.61      www      9801: }
                   9802: 
1.927     albertel 9803: sub get_reply {
                   9804:     my ($reply_value) = @_;
1.940     raeburn  9805:     if (ref($reply_value) eq 'ARRAY') {
                   9806:         if (wantarray) {
                   9807: 	    return @$reply_value;
                   9808:         }
                   9809:         return $reply_value->[0];
                   9810:     } else {
                   9811:         return $reply_value;
1.927     albertel 9812:     }
                   9813: }
                   9814: 
1.691     raeburn  9815: sub check_group_parms {
                   9816:     my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
                   9817:     my @groupitems = ();
                   9818:     my $resultitem;
1.927     albertel 9819:     my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691     raeburn  9820:     foreach my $group (@{$groups}) {
                   9821:         foreach my $level (@levels) {
1.927     albertel 9822:              my $item = $courseid.'.['.$group.'].'.$level->[0];
                   9823:              push(@groupitems,[$item,$level->[1]]);
1.691     raeburn  9824:         }
                   9825:     }
                   9826:     my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
                   9827:                             $env{'course.'.$courseid.'.domain'},
                   9828:                                      'course',@groupitems);
                   9829:     return $coursereply;
                   9830: }
                   9831: 
                   9832: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733     raeburn  9833:     my ($courseid,@groups) = @_;
                   9834:     @groups = sort(@groups);
1.691     raeburn  9835:     return @groups;
                   9836: }
                   9837: 
1.395     albertel 9838: sub packages_tab_default {
                   9839:     my ($uri,$varname)=@_;
                   9840:     my (undef,$part,$name)=split(/\./,$varname);
1.738     albertel 9841: 
                   9842:     my (@extension,@specifics,$do_default);
                   9843:     foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395     albertel 9844: 	my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738     albertel 9845: 	if ($pack_type eq 'default') {
                   9846: 	    $do_default=1;
                   9847: 	} elsif ($pack_type eq 'extension') {
                   9848: 	    push(@extension,[$package,$pack_type,$pack_part]);
1.885     albertel 9849: 	} elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848     albertel 9850: 	    # only look at packages defaults for packages that this id is
1.738     albertel 9851: 	    push(@specifics,[$package,$pack_type,$pack_part]);
                   9852: 	}
                   9853:     }
                   9854:     # first look for a package that matches the requested part id
                   9855:     foreach my $package (@specifics) {
                   9856: 	my (undef,$pack_type,$pack_part)=@{$package};
                   9857: 	next if ($pack_part ne $part);
                   9858: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   9859: 	    return $packagetab{"$pack_type&$name&default"};
                   9860: 	}
                   9861:     }
                   9862:     # look for any possible matching non extension_ package
                   9863:     foreach my $package (@specifics) {
                   9864: 	my (undef,$pack_type,$pack_part)=@{$package};
1.468     albertel 9865: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   9866: 	    return $packagetab{"$pack_type&$name&default"};
                   9867: 	}
1.585     albertel 9868: 	if ($pack_type eq 'part') { $pack_part='0'; }
1.468     albertel 9869: 	if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
                   9870: 	    return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395     albertel 9871: 	}
                   9872:     }
1.738     albertel 9873:     # look for any posible extension_ match
                   9874:     foreach my $package (@extension) {
                   9875: 	my ($package,$pack_type)=@{$package};
                   9876: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   9877: 	    return $packagetab{"$pack_type&$name&default"};
                   9878: 	}
                   9879: 	if (defined($packagetab{$package."&$name&default"})) {
                   9880: 	    return $packagetab{$package."&$name&default"};
                   9881: 	}
                   9882:     }
                   9883:     # look for a global default setting
                   9884:     if ($do_default && defined($packagetab{"default&$name&default"})) {
                   9885: 	return $packagetab{"default&$name&default"};
                   9886:     }
1.395     albertel 9887:     return undef;
                   9888: }
                   9889: 
1.334     albertel 9890: sub add_prefix_and_part {
                   9891:     my ($prefix,$part)=@_;
                   9892:     my $keyroot;
                   9893:     if (defined($prefix) && $prefix !~ /^__/) {
                   9894: 	# prefix that has a part already
                   9895: 	$keyroot=$prefix;
                   9896:     } elsif (defined($prefix)) {
                   9897: 	# prefix that is missing a part
                   9898: 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
                   9899:     } else {
                   9900: 	# no prefix at all
                   9901: 	if (defined($part)) { $keyroot='_'.$part; }
                   9902:     }
                   9903:     return $keyroot;
                   9904: }
                   9905: 
1.71      www      9906: # ---------------------------------------------------------------- Get metadata
                   9907: 
1.599     albertel 9908: my %metaentry;
1.1070    www      9909: my %importedpartids;
1.71      www      9910: sub metadata {
1.176     www      9911:     my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71      www      9912:     $uri=&declutter($uri);
1.288     albertel 9913:     # if it is a non metadata possible uri return quickly
1.529     albertel 9914:     if (($uri eq '') || 
                   9915: 	(($uri =~ m|^/*adm/|) && 
1.698     albertel 9916: 	     ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.1108    raeburn  9917:         ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924     albertel 9918: 	return undef;
                   9919:     }
1.1140    www      9920:     if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) 
1.924     albertel 9921: 	&& &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468     albertel 9922: 	return undef;
1.288     albertel 9923:     }
1.73      www      9924:     my $filename=$uri;
                   9925:     $uri=~s/\.meta$//;
1.172     www      9926: #
                   9927: # Is the metadata already cached?
1.177     www      9928: # Look at timestamp of caching
1.172     www      9929: # Everything is cached by the main uri, libraries are never directly cached
                   9930: #
1.428     albertel 9931:     if (!defined($liburi)) {
1.599     albertel 9932: 	my ($result,$cached)=&is_cached_new('meta',$uri);
1.428     albertel 9933: 	if (defined($cached)) { return $result->{':'.$what}; }
                   9934:     }
                   9935:     {
1.1069    www      9936: # Imported parts would go here
1.1070    www      9937:         my %importedids=();
                   9938:         my @origfileimportpartids=();
1.1069    www      9939:         my $importedparts=0;
1.172     www      9940: #
                   9941: # Is this a recursive call for a library?
                   9942: #
1.599     albertel 9943: #	if (! exists($metacache{$uri})) {
                   9944: #	    $metacache{$uri}={};
                   9945: #	}
1.924     albertel 9946: 	my $cachetime = 60*60;
1.171     www      9947:         if ($liburi) {
                   9948: 	    $liburi=&declutter($liburi);
                   9949:             $filename=$liburi;
1.401     bowersj2 9950:         } else {
1.599     albertel 9951: 	    &devalidate_cache_new('meta',$uri);
                   9952: 	    undef(%metaentry);
1.401     bowersj2 9953: 	}
1.140     www      9954:         my %metathesekeys=();
1.73      www      9955:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489     albertel 9956: 	my $metastring;
1.1140    www      9957: 	if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929     albertel 9958: 	    my $which = &hreflocation('','/'.($liburi || $uri));
1.924     albertel 9959: 	    $metastring = 
1.929     albertel 9960: 		&Apache::lonnet::ssi_body($which,
1.924     albertel 9961: 					  ('grade_target' => 'meta'));
                   9962: 	    $cachetime = 1; # only want this cached in the child not long term
1.1108    raeburn  9963: 	} elsif (($uri !~ m -^(editupload)/-) && 
                   9964:                  ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543     albertel 9965: 	    my $file=&filelocation('',&clutter($filename));
1.599     albertel 9966: 	    #push(@{$metaentry{$uri.'.file'}},$file);
1.543     albertel 9967: 	    $metastring=&getfile($file);
1.489     albertel 9968: 	}
1.208     albertel 9969:         my $parser=HTML::LCParser->new(\$metastring);
1.71      www      9970:         my $token;
1.140     www      9971:         undef %metathesekeys;
1.71      www      9972:         while ($token=$parser->get_token) {
1.339     albertel 9973: 	    if ($token->[0] eq 'S') {
                   9974: 		if (defined($token->[2]->{'package'})) {
1.172     www      9975: #
                   9976: # This is a package - get package info
                   9977: #
1.339     albertel 9978: 		    my $package=$token->[2]->{'package'};
                   9979: 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   9980: 		    if (defined($token->[2]->{'id'})) { 
                   9981: 			$keyroot.='_'.$token->[2]->{'id'}; 
                   9982: 		    }
1.599     albertel 9983: 		    if ($metaentry{':packages'}) {
                   9984: 			$metaentry{':packages'}.=','.$package.$keyroot;
1.339     albertel 9985: 		    } else {
1.599     albertel 9986: 			$metaentry{':packages'}=$package.$keyroot;
1.339     albertel 9987: 		    }
1.736     albertel 9988: 		    foreach my $pack_entry (keys(%packagetab)) {
1.432     albertel 9989: 			my $part=$keyroot;
                   9990: 			$part=~s/^\_//;
1.736     albertel 9991: 			if ($pack_entry=~/^\Q$package\E\&/ || 
                   9992: 			    $pack_entry=~/^\Q$package\E_0\&/) {
                   9993: 			    my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395     albertel 9994: 			    # ignore package.tab specified default values
                   9995:                             # here &package_tab_default() will fetch those
                   9996: 			    if ($subp eq 'default') { next; }
1.736     albertel 9997: 			    my $value=$packagetab{$pack_entry};
1.432     albertel 9998: 			    my $unikey;
                   9999: 			    if ($pack =~ /_0$/) {
                   10000: 				$unikey='parameter_0_'.$name;
                   10001: 				$part=0;
                   10002: 			    } else {
                   10003: 				$unikey='parameter'.$keyroot.'_'.$name;
                   10004: 			    }
1.339     albertel 10005: 			    if ($subp eq 'display') {
                   10006: 				$value.=' [Part: '.$part.']';
                   10007: 			    }
1.599     albertel 10008: 			    $metaentry{':'.$unikey.'.part'}=$part;
1.395     albertel 10009: 			    $metathesekeys{$unikey}=1;
1.599     albertel 10010: 			    unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   10011: 				$metaentry{':'.$unikey.'.'.$subp}=$value;
1.339     albertel 10012: 			    }
1.599     albertel 10013: 			    if (defined($metaentry{':'.$unikey.'.default'})) {
                   10014: 				$metaentry{':'.$unikey}=
                   10015: 				    $metaentry{':'.$unikey.'.default'};
1.356     albertel 10016: 			    }
1.339     albertel 10017: 			}
                   10018: 		    }
                   10019: 		} else {
1.172     www      10020: #
                   10021: # This is not a package - some other kind of start tag
1.339     albertel 10022: #
                   10023: 		    my $entry=$token->[1];
1.1068    www      10024: 		    my $unikey='';
1.175     www      10025: 
1.339     albertel 10026: 		    if ($entry eq 'import') {
1.175     www      10027: #
                   10028: # Importing a library here
1.339     albertel 10029: #
1.1067    www      10030:                         my $location=$parser->get_text('/import');
                   10031:                         my $dir=$filename;
                   10032:                         $dir=~s|[^/]*$||;
                   10033:                         $location=&filelocation($dir,$location);
1.1069    www      10034:                        
1.1068    www      10035:                         my $importmode=$token->[2]->{'importmode'};
                   10036:                         if ($importmode eq 'problem') {
1.1069    www      10037: # Import as problem/response
1.1068    www      10038:                            $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   10039:                         } elsif ($importmode eq 'part') {
                   10040: # Import as part(s)
1.1069    www      10041:                            $importedparts=1;
                   10042: # We need to get the original file and the imported file to get the part order correct
                   10043: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
                   10044: # Load and inspect original file
1.1070    www      10045:                            if ($#origfileimportpartids<0) {
                   10046:                               undef(%importedpartids);
                   10047:                               my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
                   10048:                               my $origfile=&getfile($origfilelocation);
                   10049:                               @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
                   10050:                            }
                   10051: 
1.1069    www      10052: # Load and inspect imported file
                   10053:                            my $impfile=&getfile($location);
                   10054:                            my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
                   10055:                            if ($#impfilepartids>=0) {
                   10056: # This problem had parts
1.1070    www      10057:                                $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069    www      10058:                            } else {
                   10059: # Importing by turning a single problem into a problem part
                   10060: # It gets the import-tags ID as part-ID
                   10061:                                $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070    www      10062:                                $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069    www      10063:                            }
1.1068    www      10064:                         } else {
                   10065: # Normal import
                   10066:                            $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   10067:                            if (defined($token->[2]->{'id'})) {
                   10068:                               $unikey.='_'.$token->[2]->{'id'};
                   10069:                            }
1.1067    www      10070:                         }
                   10071: 
1.339     albertel 10072: 			if ($depthcount<20) {
1.736     albertel 10073: 			    my $metadata = 
                   10074: 				&metadata($uri,'keys', $location,$unikey,
                   10075: 					  $depthcount+1);
                   10076: 			    foreach my $meta (split(',',$metadata)) {
                   10077: 				$metaentry{':'.$meta}=$metaentry{':'.$meta};
                   10078: 				$metathesekeys{$meta}=1;
1.339     albertel 10079: 			    }
1.1068    www      10080: 			
                   10081:                         }
1.1067    www      10082: 		    } else {
                   10083: #
                   10084: # Not importing, some other kind of non-package, non-library start tag
                   10085: # 
                   10086:                         $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   10087:                         if (defined($token->[2]->{'id'})) {
                   10088:                             $unikey.='_'.$token->[2]->{'id'};
                   10089:                         }
1.339     albertel 10090: 			if (defined($token->[2]->{'name'})) { 
                   10091: 			    $unikey.='_'.$token->[2]->{'name'}; 
                   10092: 			}
                   10093: 			$metathesekeys{$unikey}=1;
1.736     albertel 10094: 			foreach my $param (@{$token->[3]}) {
                   10095: 			    $metaentry{':'.$unikey.'.'.$param} =
                   10096: 				$token->[2]->{$param};
1.339     albertel 10097: 			}
                   10098: 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599     albertel 10099: 			my $default=$metaentry{':'.$unikey.'.default'};
1.339     albertel 10100: 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
                   10101: 		 # only ws inside the tag, and not in default, so use default
                   10102: 		 # as value
1.599     albertel 10103: 			    $metaentry{':'.$unikey}=$default;
1.908     albertel 10104: 			} elsif ( $internaltext =~ /\S/ ) {
                   10105: 		  # something interesting inside the tag
                   10106: 			    $metaentry{':'.$unikey}=$internaltext;
1.339     albertel 10107: 			} else {
1.908     albertel 10108: 		  # no interesting values, don't set a default
1.339     albertel 10109: 			}
1.172     www      10110: # end of not-a-package not-a-library import
1.339     albertel 10111: 		    }
1.172     www      10112: # end of not-a-package start tag
1.339     albertel 10113: 		}
1.172     www      10114: # the next is the end of "start tag"
1.339     albertel 10115: 	    }
                   10116: 	}
1.483     albertel 10117: 	my ($extension) = ($uri =~ /\.(\w+)$/);
1.883     albertel 10118: 	$extension = lc($extension);
                   10119: 	if ($extension eq 'htm') { $extension='html'; }
                   10120: 
1.737     albertel 10121: 	foreach my $key (keys(%packagetab)) {
1.483     albertel 10122: 	    #no specific packages #how's our extension
                   10123: 	    if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488     albertel 10124: 	    &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483     albertel 10125: 					 \%metathesekeys);
                   10126: 	}
1.883     albertel 10127: 
                   10128: 	if (!exists($metaentry{':packages'})
                   10129: 	    || $packagetab{"import_defaults&extension_$extension"}) {
1.737     albertel 10130: 	    foreach my $key (keys(%packagetab)) {
1.483     albertel 10131: 		#no specific packages well let's get default then
                   10132: 		if ($key!~/^default&/) { next; }
1.488     albertel 10133: 		&metadata_create_package_def($uri,$key,'default',
1.483     albertel 10134: 					     \%metathesekeys);
                   10135: 	    }
                   10136: 	}
1.338     www      10137: # are there custom rights to evaluate
1.599     albertel 10138: 	if ($metaentry{':copyright'} eq 'custom') {
1.339     albertel 10139: 
1.338     www      10140:     #
                   10141:     # Importing a rights file here
1.339     albertel 10142:     #
                   10143: 	    unless ($depthcount) {
1.599     albertel 10144: 		my $location=$metaentry{':customdistributionfile'};
1.339     albertel 10145: 		my $dir=$filename;
                   10146: 		$dir=~s|[^/]*$||;
                   10147: 		$location=&filelocation($dir,$location);
1.736     albertel 10148: 		my $rights_metadata =
                   10149: 		    &metadata($uri,'keys',$location,'_rights',
                   10150: 			      $depthcount+1);
                   10151: 		foreach my $rights (split(',',$rights_metadata)) {
                   10152: 		    #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
                   10153: 		    $metathesekeys{$rights}=1;
1.339     albertel 10154: 		}
                   10155: 	    }
                   10156: 	}
1.737     albertel 10157: 	# uniqifiy package listing
                   10158: 	my %seen;
                   10159: 	my @uniq_packages =
                   10160: 	    grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
                   10161: 	$metaentry{':packages'} = join(',',@uniq_packages);
                   10162: 
1.1070    www      10163:         if ($importedparts) {
                   10164: # We had imported parts and need to rebuild partorder
                   10165:            $metaentry{':partorder'}='';
                   10166:            $metathesekeys{'partorder'}=1;
                   10167:            for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
                   10168:                if ($origfileimportpartids[$index] eq 'part') {
                   10169: # original part, part of the problem
                   10170:                   $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
                   10171:                } else {
                   10172: # we have imported parts at this position
                   10173:                   $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
                   10174:                }
                   10175:            }
                   10176:            $metaentry{':partorder'}=~s/^\,//;
                   10177:         }
                   10178: 
1.737     albertel 10179: 	$metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599     albertel 10180: 	&metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
                   10181: 	$metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924     albertel 10182: 	&do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177     www      10183: # this is the end of "was not already recently cached
1.71      www      10184:     }
1.599     albertel 10185:     return $metaentry{':'.$what};
1.261     albertel 10186: }
                   10187: 
1.488     albertel 10188: sub metadata_create_package_def {
1.483     albertel 10189:     my ($uri,$key,$package,$metathesekeys)=@_;
                   10190:     my ($pack,$name,$subp)=split(/\&/,$key);
                   10191:     if ($subp eq 'default') { next; }
                   10192:     
1.599     albertel 10193:     if (defined($metaentry{':packages'})) {
                   10194: 	$metaentry{':packages'}.=','.$package;
1.483     albertel 10195:     } else {
1.599     albertel 10196: 	$metaentry{':packages'}=$package;
1.483     albertel 10197:     }
                   10198:     my $value=$packagetab{$key};
                   10199:     my $unikey;
                   10200:     $unikey='parameter_0_'.$name;
1.599     albertel 10201:     $metaentry{':'.$unikey.'.part'}=0;
1.483     albertel 10202:     $$metathesekeys{$unikey}=1;
1.599     albertel 10203:     unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   10204: 	$metaentry{':'.$unikey.'.'.$subp}=$value;
1.483     albertel 10205:     }
1.599     albertel 10206:     if (defined($metaentry{':'.$unikey.'.default'})) {
                   10207: 	$metaentry{':'.$unikey}=
                   10208: 	    $metaentry{':'.$unikey.'.default'};
1.483     albertel 10209:     }
                   10210: }
                   10211: 
1.261     albertel 10212: sub metadata_generate_part0 {
                   10213:     my ($metadata,$metacache,$uri) = @_;
                   10214:     my %allnames;
1.737     albertel 10215:     foreach my $metakey (keys(%$metadata)) {
1.261     albertel 10216: 	if ($metakey=~/^parameter\_(.*)/) {
1.428     albertel 10217: 	  my $part=$$metacache{':'.$metakey.'.part'};
                   10218: 	  my $name=$$metacache{':'.$metakey.'.name'};
1.356     albertel 10219: 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261     albertel 10220: 	    $allnames{$name}=$part;
                   10221: 	  }
                   10222: 	}
                   10223:     }
                   10224:     foreach my $name (keys(%allnames)) {
                   10225:       $$metadata{"parameter_0_$name"}=1;
1.428     albertel 10226:       my $key=":parameter_0_$name";
1.261     albertel 10227:       $$metacache{"$key.part"}='0';
                   10228:       $$metacache{"$key.name"}=$name;
1.428     albertel 10229:       $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261     albertel 10230: 					   $allnames{$name}.'_'.$name.
                   10231: 					   '.type'};
1.428     albertel 10232:       my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261     albertel 10233: 			     '.display'};
1.644     www      10234:       my $expr='[Part: '.$allnames{$name}.']';
1.479     albertel 10235:       $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261     albertel 10236:       $$metacache{"$key.display"}=$olddis;
                   10237:     }
1.71      www      10238: }
                   10239: 
1.764     albertel 10240: # ------------------------------------------------------ Devalidate title cache
                   10241: 
                   10242: sub devalidate_title_cache {
                   10243:     my ($url)=@_;
                   10244:     if (!$env{'request.course.id'}) { return; }
                   10245:     my $symb=&symbread($url);
                   10246:     if (!$symb) { return; }
                   10247:     my $key=$env{'request.course.id'}."\0".$symb;
                   10248:     &devalidate_cache_new('title',$key);
                   10249: }
                   10250: 
1.1014    droeschl 10251: # ------------------------------------------------- Get the title of a course
                   10252: 
                   10253: sub current_course_title {
                   10254:     return $env{ 'course.' . $env{'request.course.id'} . '.description' };
                   10255: }
1.301     www      10256: # ------------------------------------------------- Get the title of a resource
                   10257: 
                   10258: sub gettitle {
                   10259:     my $urlsymb=shift;
                   10260:     my $symb=&symbread($urlsymb);
1.534     albertel 10261:     if ($symb) {
1.620     albertel 10262: 	my $key=$env{'request.course.id'}."\0".$symb;
1.599     albertel 10263: 	my ($result,$cached)=&is_cached_new('title',$key);
1.575     albertel 10264: 	if (defined($cached)) { 
                   10265: 	    return $result;
                   10266: 	}
1.534     albertel 10267: 	my ($map,$resid,$url)=&decode_symb($symb);
                   10268: 	my $title='';
1.907     albertel 10269: 	if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
                   10270: 	    $title = $env{'course.'.$env{'request.course.id'}.'.description'};
                   10271: 	} else {
                   10272: 	    if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   10273: 		    &GDBM_READER(),0640)) {
                   10274: 		my $mapid=$bighash{'map_pc_'.&clutter($map)};
                   10275: 		$title=$bighash{'title_'.$mapid.'.'.$resid};
                   10276: 		untie(%bighash);
                   10277: 	    }
1.534     albertel 10278: 	}
                   10279: 	$title=~s/\&colon\;/\:/gs;
                   10280: 	if ($title) {
1.1159    www      10281: # Remember both $symb and $title for dynamic metadata
                   10282:             $accesshash{$symb.'___crstitle'}=$title;
1.1161    www      10283:             $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159    www      10284: # Cache this title and then return it
1.599     albertel 10285: 	    return &do_cache_new('title',$key,$title,600);
1.534     albertel 10286: 	}
                   10287: 	$urlsymb=$url;
                   10288:     }
                   10289:     my $title=&metadata($urlsymb,'title');
                   10290:     if (!$title) { $title=(split('/',$urlsymb))[-1]; }    
                   10291:     return $title;
1.301     www      10292: }
1.613     albertel 10293: 
1.1199    raeburn  10294: sub getdocspath {
                   10295:     my ($symb) = @_;
                   10296:     my $path;
                   10297:     if ($symb) {
                   10298:         my ($mapurl,$id,$resurl) = &decode_symb($symb);
                   10299:         if ($resurl=~/\.(sequence|page)$/) {
                   10300:             $mapurl=$resurl;
                   10301:         } elsif ($resurl eq 'adm/navmaps') {
                   10302:             $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   10303:         }
                   10304:         my $mapresobj;
                   10305:         my $navmap = Apache::lonnavmaps::navmap->new();
                   10306:         if (ref($navmap)) {
                   10307:             $mapresobj = $navmap->getResourceByUrl($mapurl);
                   10308:         }
                   10309:         $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   10310:         my $type=$2;
                   10311:         if (ref($mapresobj)) {
                   10312:             my $pcslist = $mapresobj->map_hierarchy();
                   10313:             if ($pcslist ne '') {
                   10314:                 foreach my $pc (split(/,/,$pcslist)) {
                   10315:                     next if ($pc <= 1);
                   10316:                     my $res = $navmap->getByMapPc($pc);
                   10317:                     if (ref($res)) {
                   10318:                         my $thisurl = $res->src();
                   10319:                         $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   10320:                         my $thistitle = $res->title();
                   10321:                         $path .= '&'.
                   10322:                                  &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
                   10323:                                  &Apache::lonhtmlcommon::entity_encode($thistitle).
                   10324:                                  ':'.$res->randompick().
                   10325:                                  ':'.$res->randomout().
                   10326:                                  ':'.$res->encrypted().
                   10327:                                  ':'.$res->randomorder();
                   10328:                     }
                   10329:                 }
                   10330:             }
                   10331:             $path =~ s/^\&//;
                   10332:             my $maptitle = $mapresobj->title();
                   10333:             if ($mapurl eq 'default') {
                   10334:                 $maptitle = 'Main Course Documents';
                   10335:             }
                   10336:             $path .= ($path ne '')? '&' : ''.
                   10337:                     &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
                   10338:                     &Apache::lonhtmlcommon::entity_encode($maptitle).
                   10339:                     ':'.$mapresobj->randompick().
                   10340:                     ':'.$mapresobj->randomout().
                   10341:                     ':'.$mapresobj->encrypted().
                   10342:                     ':'.$mapresobj->randomorder();
                   10343:         } else {
                   10344:             my $maptitle = &gettitle($mapurl);
                   10345:             if ($mapurl eq 'default') {
                   10346:                 $maptitle = 'Main Course Documents';
                   10347:             }
                   10348:             $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
                   10349:                     &Apache::lonhtmlcommon::entity_encode($maptitle).'::::';
                   10350:         }
                   10351:         unless ($mapurl eq 'default') {
                   10352:             $path = 'default&'.
                   10353:                     &Apache::lonhtmlcommon::entity_encode('Main Course Documents').
                   10354:                     '::::&'.$path;
                   10355:         }
                   10356:     }
                   10357:     return $path;
                   10358: }
                   10359: 
1.614     albertel 10360: sub get_slot {
                   10361:     my ($which,$cnum,$cdom)=@_;
                   10362:     if (!$cnum || !$cdom) {
1.790     albertel 10363: 	(undef,my $courseid)=&whichuser();
1.620     albertel 10364: 	$cdom=$env{'course.'.$courseid.'.domain'};
                   10365: 	$cnum=$env{'course.'.$courseid.'.num'};
1.614     albertel 10366:     }
1.703     albertel 10367:     my $key=join("\0",'slots',$cdom,$cnum,$which);
                   10368:     my %slotinfo;
                   10369:     if (exists($remembered{$key})) {
                   10370: 	$slotinfo{$which} = $remembered{$key};
                   10371:     } else {
                   10372: 	%slotinfo=&get('slots',[$which],$cdom,$cnum);
                   10373: 	&Apache::lonhomework::showhash(%slotinfo);
                   10374: 	my ($tmp)=keys(%slotinfo);
                   10375: 	if ($tmp=~/^error:/) { return (); }
                   10376: 	$remembered{$key} = $slotinfo{$which};
                   10377:     }
1.616     albertel 10378:     if (ref($slotinfo{$which}) eq 'HASH') {
                   10379: 	return %{$slotinfo{$which}};
                   10380:     }
                   10381:     return $slotinfo{$which};
1.614     albertel 10382: }
1.1150    raeburn  10383: 
                   10384: sub get_reservable_slots {
                   10385:     my ($cnum,$cdom,$uname,$udom) = @_;
                   10386:     my $now = time;
                   10387:     my $reservable_info;
                   10388:     my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
                   10389:     if (exists($remembered{$key})) {
                   10390:         $reservable_info = $remembered{$key};
                   10391:     } else {
                   10392:         my %resv;
                   10393:         ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
                   10394:         &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
                   10395:         $reservable_info = \%resv;
                   10396:         $remembered{$key} = $reservable_info;
                   10397:     }
                   10398:     return $reservable_info;
                   10399: }
                   10400: 
                   10401: sub get_course_slots {
                   10402:     my ($cnum,$cdom) = @_;
                   10403:     my $hashid=$cnum.':'.$cdom;
                   10404:     my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
                   10405:     if (defined($cached)) {
                   10406:         if (ref($result) eq 'HASH') {
                   10407:             return %{$result};
                   10408:         }
                   10409:     } else {
                   10410:         my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
                   10411:         my ($tmp) = keys(%slots);
                   10412:         if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10413:             &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
                   10414:             return %slots;
                   10415:         }
                   10416:     }
                   10417:     return;
                   10418: }
                   10419: 
                   10420: sub devalidate_slots_cache {
                   10421:     my ($cnum,$cdom)=@_;
                   10422:     my $hashid=$cnum.':'.$cdom;
                   10423:     &devalidate_cache_new('allslots',$hashid);
                   10424: }
                   10425: 
1.1181    raeburn  10426: sub get_coursechange {
                   10427:     my ($cdom,$cnum) = @_;
                   10428:     if ($cdom eq '' || $cnum eq '') {
                   10429:         return unless ($env{'request.course.id'});
                   10430:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10431:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10432:     }
                   10433:     my $hashid=$cdom.'_'.$cnum;
                   10434:     my ($change,$cached)=&is_cached_new('crschange',$hashid);
                   10435:     if ((defined($cached)) && ($change ne '')) {
                   10436:         return $change;
                   10437:     } else {
                   10438:         my %crshash;
                   10439:         %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
                   10440:         if ($crshash{'internal.contentchange'} eq '') {
                   10441:             $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
                   10442:             if ($change eq '') {
                   10443:                 %crshash = &get('environment',['internal.created'],$cdom,$cnum);
                   10444:                 $change = $crshash{'internal.created'};
                   10445:             }
                   10446:         } else {
                   10447:             $change = $crshash{'internal.contentchange'};
                   10448:         }
                   10449:         my $cachetime = 600;
                   10450:         &do_cache_new('crschange',$hashid,$change,$cachetime);
                   10451:     }
                   10452:     return $change;
                   10453: }
                   10454: 
                   10455: sub devalidate_coursechange_cache {
                   10456:     my ($cnum,$cdom)=@_;
                   10457:     my $hashid=$cnum.':'.$cdom;
                   10458:     &devalidate_cache_new('crschange',$hashid);
                   10459: }
                   10460: 
1.31      www      10461: # ------------------------------------------------- Update symbolic store links
                   10462: 
                   10463: sub symblist {
                   10464:     my ($mapname,%newhash)=@_;
1.438     www      10465:     $mapname=&deversion(&declutter($mapname));
1.31      www      10466:     my %hash;
1.620     albertel 10467:     if (($env{'request.course.fn'}) && (%newhash)) {
                   10468:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 10469:                       &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  10470: 	    foreach my $url (keys(%newhash)) {
1.711     albertel 10471: 		next if ($url eq 'last_known'
                   10472: 			 && $env{'form.no_update_last_known'});
                   10473: 		$hash{declutter($url)}=&encode_symb($mapname,
                   10474: 						    $newhash{$url}->[1],
                   10475: 						    $newhash{$url}->[0]);
1.191     harris41 10476:             }
1.31      www      10477:             if (untie(%hash)) {
                   10478: 		return 'ok';
                   10479:             }
                   10480:         }
                   10481:     }
                   10482:     return 'error';
1.212     www      10483: }
                   10484: 
                   10485: # --------------------------------------------------------------- Verify a symb
                   10486: 
                   10487: sub symbverify {
1.1190    raeburn  10488:     my ($symb,$thisurl,$encstate)=@_;
1.510     www      10489:     my $thisfn=$thisurl;
1.439     www      10490:     $thisfn=&declutter($thisfn);
1.215     www      10491: # direct jump to resource in page or to a sequence - will construct own symbs
                   10492:     if ($thisfn=~/\.(page|sequence)$/) { return 1; }
                   10493: # check URL part
1.409     www      10494:     my ($map,$resid,$url)=&decode_symb($symb);
1.439     www      10495: 
1.431     www      10496:     unless ($url eq $thisfn) { return 0; }
1.213     www      10497: 
1.216     www      10498:     $symb=&symbclean($symb);
1.510     www      10499:     $thisurl=&deversion($thisurl);
1.439     www      10500:     $thisfn=&deversion($thisfn);
1.213     www      10501: 
                   10502:     my %bighash;
                   10503:     my $okay=0;
1.431     www      10504: 
1.620     albertel 10505:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 10506:                             &GDBM_READER(),0640)) {
1.1204  ! raeburn  10507:         my $noclutter;
1.1032    raeburn  10508:         if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
                   10509:             $thisurl =~ s/\?.+$//;
1.1204  ! raeburn  10510:             if ($map =~ m{^uploaded/.+\.page$}) {
        !          10511:                 $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
        !          10512:                 $thisurl =~ s{^\Qhttp://https://\E}{https://};
        !          10513:                 $noclutter = 1;
        !          10514:             }
        !          10515:         }
        !          10516:         my $ids;
        !          10517:         if ($noclutter) {
        !          10518:             $ids=$bighash{'ids_'.$thisurl};
        !          10519:         } else {
        !          10520:             $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032    raeburn  10521:         }
1.1102    raeburn  10522:         unless ($ids) {
                   10523:             my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;  
                   10524:             $ids=$bighash{$idkey};
1.216     www      10525:         }
                   10526:         if ($ids) {
                   10527: # ------------------------------------------------------------------- Has ID(s)
1.1202    raeburn  10528:             if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203    raeburn  10529:                 $symb =~ s/\?.+$//;
1.1202    raeburn  10530:             }
1.800     albertel 10531: 	    foreach my $id (split(/\,/,$ids)) {
                   10532: 	       my ($mapid,$resid)=split(/\./,$id);
1.216     www      10533:                if (
                   10534:   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190    raeburn  10535:    eq $symb) {
                   10536:                    if (ref($encstate)) {
                   10537:                        $$encstate = $bighash{'encrypted_'.$id};
                   10538:                    }
1.620     albertel 10539: 		   if (($env{'request.role.adv'}) ||
1.1101    raeburn  10540: 		       ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
                   10541:                        ($thisurl eq '/adm/navmaps')) {
1.1190    raeburn  10542: 		       $okay=1;
1.1202    raeburn  10543:                        last;
1.582     albertel 10544: 		   }
                   10545: 	       }
1.216     www      10546: 	   }
                   10547:         }
1.213     www      10548: 	untie(%bighash);
                   10549:     }
                   10550:     return $okay;
1.31      www      10551: }
                   10552: 
1.210     www      10553: # --------------------------------------------------------------- Clean-up symb
                   10554: 
                   10555: sub symbclean {
                   10556:     my $symb=shift;
1.568     albertel 10557:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210     www      10558: # remove version from map
                   10559:     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215     www      10560: 
1.210     www      10561: # remove version from URL
                   10562:     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213     www      10563: 
1.507     www      10564: # remove wrapper
                   10565: 
1.510     www      10566:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694     albertel 10567:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210     www      10568:     return $symb;
1.409     www      10569: }
                   10570: 
                   10571: # ---------------------------------------------- Split symb to find map and url
1.429     albertel 10572: 
                   10573: sub encode_symb {
                   10574:     my ($map,$resid,$url)=@_;
                   10575:     return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
                   10576: }
1.409     www      10577: 
                   10578: sub decode_symb {
1.568     albertel 10579:     my $symb=shift;
                   10580:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
                   10581:     my ($map,$resid,$url)=split(/___/,$symb);
1.413     www      10582:     return (&fixversion($map),$resid,&fixversion($url));
                   10583: }
                   10584: 
                   10585: sub fixversion {
                   10586:     my $fn=shift;
1.609     banghart 10587:     if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435     www      10588:     my %bighash;
                   10589:     my $uri=&clutter($fn);
1.620     albertel 10590:     my $key=$env{'request.course.id'}.'_'.$uri;
1.440     www      10591: # is this cached?
1.599     albertel 10592:     my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440     www      10593:     if (defined($cached)) { return $result; }
                   10594: # unfortunately not cached, or expired
1.620     albertel 10595:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440     www      10596: 	    &GDBM_READER(),0640)) {
                   10597:  	if ($bighash{'version_'.$uri}) {
                   10598:  	    my $version=$bighash{'version_'.$uri};
1.444     www      10599:  	    unless (($version eq 'mostrecent') || 
                   10600: 		    ($version==&getversion($uri))) {
1.440     www      10601:  		$uri=~s/\.(\w+)$/\.$version\.$1/;
                   10602:  	    }
                   10603:  	}
                   10604:  	untie %bighash;
1.413     www      10605:     }
1.599     albertel 10606:     return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438     www      10607: }
                   10608: 
                   10609: sub deversion {
                   10610:     my $url=shift;
                   10611:     $url=~s/\.\d+\.(\w+)$/\.$1/;
                   10612:     return $url;
1.210     www      10613: }
                   10614: 
1.31      www      10615: # ------------------------------------------------------ Return symb list entry
                   10616: 
                   10617: sub symbread {
1.249     www      10618:     my ($thisfn,$donotrecurse)=@_;
1.542     albertel 10619:     my $cache_str='request.symbread.cached.'.$thisfn;
1.1179    raeburn  10620:     if (defined($env{$cache_str})) {
                   10621:         if (($thisfn) || ($env{$cache_str} ne '')) {
                   10622:             return $env{$cache_str};
                   10623:         }
                   10624:     }
1.242     www      10625: # no filename provided? try from environment
1.44      www      10626:     unless ($thisfn) {
1.620     albertel 10627:         if ($env{'request.symb'}) {
                   10628: 	    return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539     albertel 10629: 	}
1.620     albertel 10630: 	$thisfn=$env{'request.filename'};
1.44      www      10631:     }
1.569     albertel 10632:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242     www      10633: # is that filename actually a symb? Verify, clean, and return
                   10634:     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539     albertel 10635: 	if (&symbverify($thisfn,$1)) {
1.620     albertel 10636: 	    return $env{$cache_str}=&symbclean($thisfn);
1.539     albertel 10637: 	}
1.242     www      10638:     }
1.44      www      10639:     $thisfn=declutter($thisfn);
1.31      www      10640:     my %hash;
1.37      www      10641:     my %bighash;
                   10642:     my $syval='';
1.620     albertel 10643:     if (($env{'request.course.fn'}) && ($thisfn)) {
1.481     raeburn  10644:         my $targetfn = $thisfn;
1.609     banghart 10645:         if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481     raeburn  10646:             $targetfn = 'adm/wrapper/'.$thisfn;
                   10647:         }
1.687     albertel 10648: 	if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
                   10649: 	    $targetfn=$1;
                   10650: 	}
1.620     albertel 10651:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 10652:                       &GDBM_READER(),0640)) {
1.481     raeburn  10653: 	    $syval=$hash{$targetfn};
1.37      www      10654:             untie(%hash);
                   10655:         }
                   10656: # ---------------------------------------------------------- There was an entry
                   10657:         if ($syval) {
1.601     albertel 10658: 	    #unless ($syval=~/\_\d+$/) {
1.620     albertel 10659: 		#unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949     raeburn  10660: 		    #&appenv({'request.ambiguous' => $thisfn});
1.620     albertel 10661: 		    #return $env{$cache_str}='';
1.601     albertel 10662: 		#}    
                   10663: 		#$syval.=$1;
                   10664: 	    #}
1.37      www      10665:         } else {
                   10666: # ------------------------------------------------------- Was not in symb table
1.620     albertel 10667:            if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 10668:                             &GDBM_READER(),0640)) {
1.37      www      10669: # ---------------------------------------------- Get ID(s) for current resource
1.280     www      10670:               my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65      www      10671:               unless ($ids) { 
                   10672:                  $ids=$bighash{'ids_/'.$thisfn};
1.242     www      10673:               }
                   10674:               unless ($ids) {
                   10675: # alias?
                   10676: 		  $ids=$bighash{'mapalias_'.$thisfn};
1.65      www      10677:               }
1.37      www      10678:               if ($ids) {
                   10679: # ------------------------------------------------------------------- Has ID(s)
                   10680:                  my @possibilities=split(/\,/,$ids);
1.39      www      10681:                  if ($#possibilities==0) {
                   10682: # ----------------------------------------------- There is only one possibility
1.37      www      10683: 		     my ($mapid,$resid)=split(/\./,$ids);
1.626     albertel 10684: 		     $syval=&encode_symb($bighash{'map_id_'.$mapid},
                   10685: 						    $resid,$thisfn);
1.249     www      10686:                  } elsif (!$donotrecurse) {
1.39      www      10687: # ------------------------------------------ There is more than one possibility
                   10688:                      my $realpossible=0;
1.800     albertel 10689:                      foreach my $id (@possibilities) {
                   10690: 			 my $file=$bighash{'src_'.$id};
1.39      www      10691:                          if (&allowed('bre',$file)) {
1.800     albertel 10692:          		    my ($mapid,$resid)=split(/\./,$id);
1.39      www      10693:                             if ($bighash{'map_type_'.$mapid} ne 'page') {
                   10694: 				$realpossible++;
1.626     albertel 10695:                                 $syval=&encode_symb($bighash{'map_id_'.$mapid},
                   10696: 						    $resid,$thisfn);
1.39      www      10697:                             }
                   10698: 			 }
1.191     harris41 10699:                      }
1.39      www      10700: 		     if ($realpossible!=1) { $syval=''; }
1.249     www      10701:                  } else {
                   10702:                      $syval='';
1.37      www      10703:                  }
                   10704: 	      }
                   10705:               untie(%bighash)
1.481     raeburn  10706:            }
1.31      www      10707:         }
1.62      www      10708:         if ($syval) {
1.620     albertel 10709: 	    return $env{$cache_str}=$syval;
1.62      www      10710:         }
1.31      www      10711:     }
1.949     raeburn  10712:     &appenv({'request.ambiguous' => $thisfn});
1.620     albertel 10713:     return $env{$cache_str}='';
1.31      www      10714: }
                   10715: 
                   10716: # ---------------------------------------------------------- Return random seed
                   10717: 
1.32      www      10718: sub numval {
                   10719:     my $txt=shift;
                   10720:     $txt=~tr/A-J/0-9/;
                   10721:     $txt=~tr/a-j/0-9/;
                   10722:     $txt=~tr/K-T/0-9/;
                   10723:     $txt=~tr/k-t/0-9/;
                   10724:     $txt=~tr/U-Z/0-5/;
                   10725:     $txt=~tr/u-z/0-5/;
                   10726:     $txt=~s/\D//g;
1.564     albertel 10727:     if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32      www      10728:     return int($txt);
1.368     albertel 10729: }
                   10730: 
1.484     albertel 10731: sub numval2 {
                   10732:     my $txt=shift;
                   10733:     $txt=~tr/A-J/0-9/;
                   10734:     $txt=~tr/a-j/0-9/;
                   10735:     $txt=~tr/K-T/0-9/;
                   10736:     $txt=~tr/k-t/0-9/;
                   10737:     $txt=~tr/U-Z/0-5/;
                   10738:     $txt=~tr/u-z/0-5/;
                   10739:     $txt=~s/\D//g;
                   10740:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   10741:     my $total;
                   10742:     foreach my $val (@txts) { $total+=$val; }
1.564     albertel 10743:     if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484     albertel 10744:     return int($total);
                   10745: }
                   10746: 
1.575     albertel 10747: sub numval3 {
                   10748:     use integer;
                   10749:     my $txt=shift;
                   10750:     $txt=~tr/A-J/0-9/;
                   10751:     $txt=~tr/a-j/0-9/;
                   10752:     $txt=~tr/K-T/0-9/;
                   10753:     $txt=~tr/k-t/0-9/;
                   10754:     $txt=~tr/U-Z/0-5/;
                   10755:     $txt=~tr/u-z/0-5/;
                   10756:     $txt=~s/\D//g;
                   10757:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   10758:     my $total;
                   10759:     foreach my $val (@txts) { $total+=$val; }
                   10760:     if ($_64bit) { $total=(($total<<32)>>32); }
                   10761:     return $total;
                   10762: }
                   10763: 
1.675     albertel 10764: sub digest {
                   10765:     my ($data)=@_;
                   10766:     my $digest=&Digest::MD5::md5($data);
                   10767:     my ($a,$b,$c,$d)=unpack("iiii",$digest);
                   10768:     my ($e,$f);
                   10769:     {
                   10770:         use integer;
                   10771:         $e=($a+$b);
                   10772:         $f=($c+$d);
                   10773:         if ($_64bit) {
                   10774:             $e=(($e<<32)>>32);
                   10775:             $f=(($f<<32)>>32);
                   10776:         }
                   10777:     }
                   10778:     if (wantarray) {
                   10779: 	return ($e,$f);
                   10780:     } else {
                   10781: 	my $g;
                   10782: 	{
                   10783: 	    use integer;
                   10784: 	    $g=($e+$f);
                   10785: 	    if ($_64bit) {
                   10786: 		$g=(($g<<32)>>32);
                   10787: 	    }
                   10788: 	}
                   10789: 	return $g;
                   10790:     }
                   10791: }
                   10792: 
1.368     albertel 10793: sub latest_rnd_algorithm_id {
1.675     albertel 10794:     return '64bit5';
1.366     albertel 10795: }
1.32      www      10796: 
1.503     albertel 10797: sub get_rand_alg {
                   10798:     my ($courseid)=@_;
1.790     albertel 10799:     if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503     albertel 10800:     if ($courseid) {
1.620     albertel 10801: 	return $env{"course.$courseid.rndseed"};
1.503     albertel 10802:     }
                   10803:     return &latest_rnd_algorithm_id();
                   10804: }
                   10805: 
1.562     albertel 10806: sub validCODE {
                   10807:     my ($CODE)=@_;
                   10808:     if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
                   10809:     return 0;
                   10810: }
                   10811: 
1.491     albertel 10812: sub getCODE {
1.620     albertel 10813:     if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618     albertel 10814:     if ( (defined($Apache::lonhomework::parsing_a_problem) ||
                   10815: 	  defined($Apache::lonhomework::parsing_a_task) ) &&
                   10816: 	 &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491     albertel 10817: 	return $Apache::lonhomework::history{'resource.CODE'};
                   10818:     }
                   10819:     return undef;
                   10820: }
1.1133    foxr     10821: #
                   10822: #  Determines the random seed for a specific context:
                   10823: #
                   10824: # parameters:
                   10825: #   symb      - in course context the symb for the seed.
                   10826: #   course_id - The course id of the form domain_coursenum.
                   10827: #   domain    - Domain for the user.
                   10828: #   course    - Course for the user.
                   10829: #   cenv      - environment of the course.
                   10830: #
                   10831: # NOTE:
                   10832: #   All parameters are picked out of the environment if missing
                   10833: #   or not defined.
                   10834: #   If a symb cannot be determined the current time is used instead.
                   10835: #
                   10836: #  For a given well defined symb, courside, domain, username,
                   10837: #  and course environment, the seed is reproducible.
                   10838: #
1.31      www      10839: sub rndseed {
1.1133    foxr     10840:     my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790     albertel 10841:     my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896     albertel 10842:     if (!defined($symb)) {
1.366     albertel 10843: 	unless ($symb=$wsymb) { return time; }
                   10844:     }
1.1146    foxr     10845:     if (!defined $courseid) { 
                   10846: 	$courseid=$wcourseid; 
                   10847:     }
                   10848:     if (!defined $domain) { $domain=$wdomain; }
                   10849:     if (!defined $username) { $username=$wusername }
1.1133    foxr     10850: 
                   10851:     my $which;
                   10852:     if (defined($cenv->{'rndseed'})) {
                   10853: 	$which = $cenv->{'rndseed'};
                   10854:     } else {
                   10855: 	$which =&get_rand_alg($courseid);
                   10856:     }
1.491     albertel 10857:     if (defined(&getCODE())) {
1.1133    foxr     10858: 
1.675     albertel 10859: 	if ($which eq '64bit5') {
                   10860: 	    return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
                   10861: 	} elsif ($which eq '64bit4') {
1.575     albertel 10862: 	    return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
                   10863: 	} else {
                   10864: 	    return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
                   10865: 	}
1.675     albertel 10866:     } elsif ($which eq '64bit5') {
                   10867: 	return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575     albertel 10868:     } elsif ($which eq '64bit4') {
                   10869: 	return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501     albertel 10870:     } elsif ($which eq '64bit3') {
                   10871: 	return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443     albertel 10872:     } elsif ($which eq '64bit2') {
                   10873: 	return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366     albertel 10874:     } elsif ($which eq '64bit') {
                   10875: 	return &rndseed_64bit($symb,$courseid,$domain,$username);
                   10876:     }
                   10877:     return &rndseed_32bit($symb,$courseid,$domain,$username);
                   10878: }
                   10879: 
                   10880: sub rndseed_32bit {
                   10881:     my ($symb,$courseid,$domain,$username)=@_;
                   10882:     {
                   10883: 	use integer;
                   10884: 	my $symbchck=unpack("%32C*",$symb) << 27;
                   10885: 	my $symbseed=numval($symb) << 22;
                   10886: 	my $namechck=unpack("%32C*",$username) << 17;
                   10887: 	my $nameseed=numval($username) << 12;
                   10888: 	my $domainseed=unpack("%32C*",$domain) << 7;
                   10889: 	my $courseseed=unpack("%32C*",$courseid);
                   10890: 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790     albertel 10891: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   10892: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 10893: 	if ($_64bit) { $num=(($num<<32)>>32); }
1.366     albertel 10894: 	return $num;
                   10895:     }
                   10896: }
                   10897: 
                   10898: sub rndseed_64bit {
                   10899:     my ($symb,$courseid,$domain,$username)=@_;
                   10900:     {
                   10901: 	use integer;
                   10902: 	my $symbchck=unpack("%32S*",$symb) << 21;
                   10903: 	my $symbseed=numval($symb) << 10;
                   10904: 	my $namechck=unpack("%32S*",$username);
                   10905: 	
                   10906: 	my $nameseed=numval($username) << 21;
                   10907: 	my $domainseed=unpack("%32S*",$domain) << 10;
                   10908: 	my $courseseed=unpack("%32S*",$courseid);
                   10909: 	
                   10910: 	my $num1=$symbchck+$symbseed+$namechck;
                   10911: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 10912: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   10913: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 10914: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366     albertel 10915: 	return "$num1,$num2";
1.155     albertel 10916:     }
1.366     albertel 10917: }
                   10918: 
1.443     albertel 10919: sub rndseed_64bit2 {
                   10920:     my ($symb,$courseid,$domain,$username)=@_;
                   10921:     {
                   10922: 	use integer;
                   10923: 	# strings need to be an even # of cahracters long, it it is odd the
                   10924:         # last characters gets thrown away
                   10925: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   10926: 	my $symbseed=numval($symb) << 10;
                   10927: 	my $namechck=unpack("%32S*",$username.' ');
                   10928: 	
                   10929: 	my $nameseed=numval($username) << 21;
1.501     albertel 10930: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   10931: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   10932: 	
                   10933: 	my $num1=$symbchck+$symbseed+$namechck;
                   10934: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 10935: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   10936: 	#&logthis("rndseed :$num:$symb");
1.803     albertel 10937: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501     albertel 10938: 	return "$num1,$num2";
                   10939:     }
                   10940: }
                   10941: 
                   10942: sub rndseed_64bit3 {
                   10943:     my ($symb,$courseid,$domain,$username)=@_;
                   10944:     {
                   10945: 	use integer;
                   10946: 	# strings need to be an even # of cahracters long, it it is odd the
                   10947:         # last characters gets thrown away
                   10948: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   10949: 	my $symbseed=numval2($symb) << 10;
                   10950: 	my $namechck=unpack("%32S*",$username.' ');
                   10951: 	
                   10952: 	my $nameseed=numval2($username) << 21;
1.443     albertel 10953: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   10954: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   10955: 	
                   10956: 	my $num1=$symbchck+$symbseed+$namechck;
                   10957: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 10958: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   10959: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.564     albertel 10960: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110    www      10961: 	
1.503     albertel 10962: 	return "$num1:$num2";
1.443     albertel 10963:     }
                   10964: }
                   10965: 
1.575     albertel 10966: sub rndseed_64bit4 {
                   10967:     my ($symb,$courseid,$domain,$username)=@_;
                   10968:     {
                   10969: 	use integer;
                   10970: 	# strings need to be an even # of cahracters long, it it is odd the
                   10971:         # last characters gets thrown away
                   10972: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   10973: 	my $symbseed=numval3($symb) << 10;
                   10974: 	my $namechck=unpack("%32S*",$username.' ');
                   10975: 	
                   10976: 	my $nameseed=numval3($username) << 21;
                   10977: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   10978: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   10979: 	
                   10980: 	my $num1=$symbchck+$symbseed+$namechck;
                   10981: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 10982: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   10983: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.575     albertel 10984: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110    www      10985: 	
1.575     albertel 10986: 	return "$num1:$num2";
                   10987:     }
                   10988: }
                   10989: 
1.675     albertel 10990: sub rndseed_64bit5 {
                   10991:     my ($symb,$courseid,$domain,$username)=@_;
                   10992:     my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
                   10993:     return "$num1:$num2";
                   10994: }
                   10995: 
1.366     albertel 10996: sub rndseed_CODE_64bit {
                   10997:     my ($symb,$courseid,$domain,$username)=@_;
1.155     albertel 10998:     {
1.366     albertel 10999: 	use integer;
1.443     albertel 11000: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484     albertel 11001: 	my $symbseed=numval2($symb);
1.491     albertel 11002: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   11003: 	my $CODEseed=numval(&getCODE());
1.443     albertel 11004: 	my $courseseed=unpack("%32S*",$courseid.' ');
1.484     albertel 11005: 	my $num1=$symbseed+$CODEchck;
                   11006: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 11007: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   11008: 	#&logthis("rndseed :$num1:$num2:$symb");
1.564     albertel 11009: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   11010: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503     albertel 11011: 	return "$num1:$num2";
1.366     albertel 11012:     }
                   11013: }
                   11014: 
1.575     albertel 11015: sub rndseed_CODE_64bit4 {
                   11016:     my ($symb,$courseid,$domain,$username)=@_;
                   11017:     {
                   11018: 	use integer;
                   11019: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
                   11020: 	my $symbseed=numval3($symb);
                   11021: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   11022: 	my $CODEseed=numval3(&getCODE());
                   11023: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   11024: 	my $num1=$symbseed+$CODEchck;
                   11025: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 11026: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   11027: 	#&logthis("rndseed :$num1:$num2:$symb");
1.575     albertel 11028: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   11029: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
                   11030: 	return "$num1:$num2";
                   11031:     }
                   11032: }
                   11033: 
1.675     albertel 11034: sub rndseed_CODE_64bit5 {
                   11035:     my ($symb,$courseid,$domain,$username)=@_;
                   11036:     my $code = &getCODE();
                   11037:     my ($num1,$num2)=&digest("$symb,$courseid,$code");
                   11038:     return "$num1:$num2";
                   11039: }
                   11040: 
1.366     albertel 11041: sub setup_random_from_rndseed {
                   11042:     my ($rndseed)=@_;
1.503     albertel 11043:     if ($rndseed =~/([,:])/) {
                   11044: 	my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366     albertel 11045: 	&Math::Random::random_set_seed(abs($num1),abs($num2));
                   11046:     } else {
                   11047: 	&Math::Random::random_set_seed_from_phrase($rndseed);
1.98      albertel 11048:     }
1.36      albertel 11049: }
                   11050: 
1.474     albertel 11051: sub latest_receipt_algorithm_id {
1.835     albertel 11052:     return 'receipt3';
1.474     albertel 11053: }
                   11054: 
1.480     www      11055: sub recunique {
                   11056:     my $fucourseid=shift;
                   11057:     my $unique;
1.835     albertel 11058:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
                   11059: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 11060: 	$unique=$env{"course.$fucourseid.internal.encseed"};
1.480     www      11061:     } else {
                   11062: 	$unique=$perlvar{'lonReceipt'};
                   11063:     }
                   11064:     return unpack("%32C*",$unique);
                   11065: }
                   11066: 
                   11067: sub recprefix {
                   11068:     my $fucourseid=shift;
                   11069:     my $prefix;
1.835     albertel 11070:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
                   11071: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 11072: 	$prefix=$env{"course.$fucourseid.internal.encpref"};
1.480     www      11073:     } else {
                   11074: 	$prefix=$perlvar{'lonHostID'};
                   11075:     }
                   11076:     return unpack("%32C*",$prefix);
                   11077: }
                   11078: 
1.76      www      11079: sub ireceipt {
1.474     albertel 11080:     my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835     albertel 11081: 
                   11082:     my $return =&recprefix($fucourseid).'-';
                   11083: 
                   11084:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
                   11085: 	$env{'request.state'} eq 'construct') {
                   11086: 	$return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
                   11087: 	return $return;
                   11088:     }
                   11089: 
1.76      www      11090:     my $cuname=unpack("%32C*",$funame);
                   11091:     my $cudom=unpack("%32C*",$fudom);
                   11092:     my $cucourseid=unpack("%32C*",$fucourseid);
                   11093:     my $cusymb=unpack("%32C*",$fusymb);
1.480     www      11094:     my $cunique=&recunique($fucourseid);
1.474     albertel 11095:     my $cpart=unpack("%32S*",$part);
1.835     albertel 11096:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
                   11097: 
1.790     albertel 11098: 	#&logthis("doing receipt2  using parts $cpart, uname $cuname and udom $cudom gets  ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474     albertel 11099: 			       
                   11100: 	$return.= ($cunique%$cuname+
                   11101: 		   $cunique%$cudom+
                   11102: 		   $cusymb%$cuname+
                   11103: 		   $cusymb%$cudom+
                   11104: 		   $cucourseid%$cuname+
                   11105: 		   $cucourseid%$cudom+
                   11106: 		   $cpart%$cuname+
                   11107: 		   $cpart%$cudom);
                   11108:     } else {
                   11109: 	$return.= ($cunique%$cuname+
                   11110: 		   $cunique%$cudom+
                   11111: 		   $cusymb%$cuname+
                   11112: 		   $cusymb%$cudom+
                   11113: 		   $cucourseid%$cuname+
                   11114: 		   $cucourseid%$cudom);
                   11115:     }
                   11116:     return $return;
1.76      www      11117: }
                   11118: 
                   11119: sub receipt {
1.474     albertel 11120:     my ($part)=@_;
1.790     albertel 11121:     my ($symb,$courseid,$domain,$name) = &whichuser();
1.474     albertel 11122:     return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76      www      11123: }
1.260     ng       11124: 
1.790     albertel 11125: sub whichuser {
                   11126:     my ($passedsymb)=@_;
                   11127:     my ($symb,$courseid,$domain,$name,$publicuser);
                   11128:     if (defined($env{'form.grade_symb'})) {
                   11129: 	my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
                   11130: 	my $allowed=&allowed('vgr',$tmp_courseid);
                   11131: 	if (!$allowed &&
                   11132: 	    exists($env{'request.course.sec'}) &&
                   11133: 	    $env{'request.course.sec'} !~ /^\s*$/) {
                   11134: 	    $allowed=&allowed('vgr',$tmp_courseid.
                   11135: 			      '/'.$env{'request.course.sec'});
                   11136: 	}
                   11137: 	if ($allowed) {
                   11138: 	    ($symb)=&get_env_multiple('form.grade_symb');
                   11139: 	    $courseid=$tmp_courseid;
                   11140: 	    ($domain)=&get_env_multiple('form.grade_domain');
                   11141: 	    ($name)=&get_env_multiple('form.grade_username');
                   11142: 	    return ($symb,$courseid,$domain,$name,$publicuser);
                   11143: 	}
                   11144:     }
                   11145:     if (!$passedsymb) {
                   11146: 	$symb=&symbread();
                   11147:     } else {
                   11148: 	$symb=$passedsymb;
                   11149:     }
                   11150:     $courseid=$env{'request.course.id'};
                   11151:     $domain=$env{'user.domain'};
                   11152:     $name=$env{'user.name'};
                   11153:     if ($name eq 'public' && $domain eq 'public') {
                   11154: 	if (!defined($env{'form.username'})) {
                   11155: 	    $env{'form.username'}.=time.rand(10000000);
                   11156: 	}
                   11157: 	$name.=$env{'form.username'};
                   11158:     }
                   11159:     return ($symb,$courseid,$domain,$name,$publicuser);
                   11160: 
                   11161: }
                   11162: 
1.36      albertel 11163: # ------------------------------------------------------------ Serves up a file
1.472     albertel 11164: # returns either the contents of the file or 
                   11165: # -1 if the file doesn't exist
1.481     raeburn  11166: #
                   11167: # if the target is a file that was uploaded via DOCS, 
                   11168: # a check will be made to see if a current copy exists on the local server,
                   11169: # if it does this will be served, otherwise a copy will be retrieved from
                   11170: # the home server for the course and stored in /home/httpd/html/userfiles on
                   11171: # the local server.   
1.472     albertel 11172: 
1.36      albertel 11173: sub getfile {
1.538     albertel 11174:     my ($file) = @_;
1.609     banghart 11175:     if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538     albertel 11176:     &repcopy($file);
                   11177:     return &readfile($file);
                   11178: }
                   11179: 
                   11180: sub repcopy_userfile {
                   11181:     my ($file)=@_;
1.1142    raeburn  11182:     my $londocroot = $perlvar{'lonDocRoot'};
                   11183:     if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164    raeburn  11184:     if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538     albertel 11185:     my ($cdom,$cnum,$filename) = 
1.811     albertel 11186: 	($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538     albertel 11187:     my $uri="/uploaded/$cdom/$cnum/$filename";
                   11188:     if (-e "$file") {
1.828     www      11189: # we already have a local copy, check it out
1.538     albertel 11190: 	my @fileinfo = stat($file);
1.828     www      11191: 	my $rtncode;
                   11192: 	my $info;
1.538     albertel 11193: 	my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482     albertel 11194: 	if ($lwpresp ne 'ok') {
1.828     www      11195: # there is no such file anymore, even though we had a local copy
1.482     albertel 11196: 	    if ($rtncode eq '404') {
1.538     albertel 11197: 		unlink($file);
1.482     albertel 11198: 	    }
                   11199: 	    return -1;
                   11200: 	}
                   11201: 	if ($info < $fileinfo[9]) {
1.828     www      11202: # nice, the file we have is up-to-date, just say okay
1.607     raeburn  11203: 	    return 'ok';
1.828     www      11204: 	} else {
                   11205: # the file is outdated, get rid of it
                   11206: 	    unlink($file);
1.482     albertel 11207: 	}
1.828     www      11208:     }
                   11209: # one way or the other, at this point, we don't have the file
                   11210: # construct the correct path for the file
                   11211:     my @parts = ($cdom,$cnum); 
                   11212:     if ($filename =~ m|^(.+)/[^/]+$|) {
                   11213: 	push @parts, split(/\//,$1);
                   11214:     }
                   11215:     my $path = $perlvar{'lonDocRoot'}.'/userfiles';
                   11216:     foreach my $part (@parts) {
                   11217: 	$path .= '/'.$part;
                   11218: 	if (!-e $path) {
                   11219: 	    mkdir($path,0770);
1.482     albertel 11220: 	}
                   11221:     }
1.828     www      11222: # now the path exists for sure
                   11223: # get a user agent
                   11224:     my $ua=new LWP::UserAgent;
                   11225:     my $transferfile=$file.'.in.transfer';
                   11226: # FIXME: this should flock
                   11227:     if (-e $transferfile) { return 'ok'; }
                   11228:     my $request;
                   11229:     $uri=~s/^\///;
1.980     raeburn  11230:     my $homeserver = &homeserver($cnum,$cdom);
                   11231:     my $protocol = $protocol{$homeserver};
                   11232:     $protocol = 'http' if ($protocol ne 'https');
                   11233:     $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828     www      11234:     my $response=$ua->request($request,$transferfile);
                   11235: # did it work?
                   11236:     if ($response->is_error()) {
                   11237: 	unlink($transferfile);
                   11238: 	&logthis("Userfile repcopy failed for $uri");
                   11239: 	return -1;
                   11240:     }
                   11241: # worked, rename the transfer file
                   11242:     rename($transferfile,$file);
1.607     raeburn  11243:     return 'ok';
1.481     raeburn  11244: }
                   11245: 
1.517     albertel 11246: sub tokenwrapper {
                   11247:     my $uri=shift;
1.980     raeburn  11248:     $uri=~s|^https?\://([^/]+)||;
1.552     albertel 11249:     $uri=~s|^/||;
1.620     albertel 11250:     $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517     albertel 11251:     my $token=$1;
1.552     albertel 11252:     my (undef,$udom,$uname,$file)=split('/',$uri,4);
                   11253:     if ($udom && $uname && $file) {
                   11254: 	$file=~s|(\?\.*)*$||;
1.949     raeburn  11255:         &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980     raeburn  11256:         my $homeserver = &homeserver($uname,$udom);
                   11257:         my $protocol = $protocol{$homeserver};
                   11258:         $protocol = 'http' if ($protocol ne 'https');
                   11259:         return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517     albertel 11260:                (($uri=~/\?/)?'&':'?').'token='.$token.
                   11261:                                '&tokenissued='.$perlvar{'lonHostID'};
                   11262:     } else {
                   11263:         return '/adm/notfound.html';
                   11264:     }
                   11265: }
                   11266: 
1.828     www      11267: # call with reqtype HEAD: get last modification time
                   11268: # call with reqtype GET: get the file contents
                   11269: # Do not call this with reqtype GET for large files! It loads everything into memory
                   11270: #
1.481     raeburn  11271: sub getuploaded {
                   11272:     my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
                   11273:     $uri=~s/^\///;
1.980     raeburn  11274:     my $homeserver = &homeserver($cnum,$cdom);
                   11275:     my $protocol = $protocol{$homeserver};
                   11276:     $protocol = 'http' if ($protocol ne 'https');
                   11277:     $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481     raeburn  11278:     my $ua=new LWP::UserAgent;
                   11279:     my $request=new HTTP::Request($reqtype,$uri);
                   11280:     my $response=$ua->request($request);
                   11281:     $$rtncode = $response->code;
1.482     albertel 11282:     if (! $response->is_success()) {
                   11283: 	return 'failed';
                   11284:     }      
                   11285:     if ($reqtype eq 'HEAD') {
1.486     www      11286: 	$$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482     albertel 11287:     } elsif ($reqtype eq 'GET') {
                   11288: 	$$info = $response->content;
1.472     albertel 11289:     }
1.482     albertel 11290:     return 'ok';
1.36      albertel 11291: }
                   11292: 
1.481     raeburn  11293: sub readfile {
                   11294:     my $file = shift;
                   11295:     if ( (! -e $file ) || ($file eq '') ) { return -1; };
                   11296:     my $fh;
                   11297:     open($fh,"<$file");
                   11298:     my $a='';
1.800     albertel 11299:     while (my $line = <$fh>) { $a .= $line; }
1.481     raeburn  11300:     return $a;
                   11301: }
                   11302: 
1.36      albertel 11303: sub filelocation {
1.590     banghart 11304:     my ($dir,$file) = @_;
                   11305:     my $location;
                   11306:     $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700     albertel 11307: 
                   11308:     if ($file =~ m-^/adm/-) {
                   11309: 	$file=~s-^/adm/wrapper/-/-;
                   11310: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
                   11311:     }
1.882     albertel 11312: 
1.1139    www      11313:     if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956     raeburn  11314:         $location = $file;
1.609     banghart 11315:     } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590     banghart 11316:         my ($udom,$uname,$filename)=
1.811     albertel 11317:   	    ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590     banghart 11318:         my $home=&homeserver($uname,$udom);
                   11319:         my $is_me=0;
                   11320:         my @ids=&current_machine_ids();
                   11321:         foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
                   11322:         if ($is_me) {
1.1117    foxr     11323:   	    $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590     banghart 11324:         } else {
                   11325:   	  $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
                   11326:   	      $udom.'/'.$uname.'/'.$filename;
                   11327:         }
1.882     albertel 11328:     } elsif ($file =~ m-^/adm/-) {
                   11329: 	$location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590     banghart 11330:     } else {
                   11331:         $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139    www      11332:         $file=~s:^/(res|priv)/:/:;
                   11333:         my $space=$1;
1.590     banghart 11334:         if ( !( $file =~ m:^/:) ) {
                   11335:             $location = $dir. '/'.$file;
                   11336:         } else {
1.1142    raeburn  11337:             $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590     banghart 11338:         }
1.59      albertel 11339:     }
1.590     banghart 11340:     $location=~s://+:/:g; # remove duplicate /
1.930     albertel 11341:     while ($location=~m{/\.\./}) {
                   11342: 	if ($location =~ m{/[^/]+/\.\./}) {
                   11343: 	    $location=~ s{/[^/]+/\.\./}{/}g;
                   11344: 	} else {
                   11345: 	    $location=~ s{/\.\./}{/}g;
                   11346: 	}
                   11347:     } #remove dir/..
1.590     banghart 11348:     while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
                   11349:     return $location;
1.46      www      11350: }
1.36      albertel 11351: 
1.46      www      11352: sub hreflocation {
                   11353:     my ($dir,$file)=@_;
1.980     raeburn  11354:     unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666     albertel 11355: 	$file=filelocation($dir,$file);
1.700     albertel 11356:     } elsif ($file=~m-^/adm/-) {
                   11357: 	$file=~s-^/adm/wrapper/-/-;
                   11358: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
1.666     albertel 11359:     }
                   11360:     if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
                   11361: 	$file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
                   11362:     } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143    raeburn  11363: 	$file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
                   11364: 	        {/uploaded/$1/$2/}x;
1.46      www      11365:     }
1.913     albertel 11366:     if ($file=~ m{^/userfiles/}) {
                   11367: 	$file =~ s{^/userfiles/}{/uploaded/};
                   11368:     }
1.462     albertel 11369:     return $file;
1.465     albertel 11370: }
                   11371: 
1.1139    www      11372: 
                   11373: 
                   11374: 
                   11375: 
1.465     albertel 11376: sub current_machine_domains {
1.853     albertel 11377:     return &machine_domains(&hostname($perlvar{'lonHostID'}));
                   11378: }
                   11379: 
                   11380: sub machine_domains {
                   11381:     my ($hostname) = @_;
1.465     albertel 11382:     my @domains;
1.838     albertel 11383:     my %hostname = &all_hostnames();
1.465     albertel 11384:     while( my($id, $name) = each(%hostname)) {
1.467     matthew  11385: #	&logthis("-$id-$name-$hostname-");
1.465     albertel 11386: 	if ($hostname eq $name) {
1.844     albertel 11387: 	    push(@domains,&host_domain($id));
1.465     albertel 11388: 	}
                   11389:     }
                   11390:     return @domains;
                   11391: }
                   11392: 
                   11393: sub current_machine_ids {
1.853     albertel 11394:     return &machine_ids(&hostname($perlvar{'lonHostID'}));
                   11395: }
                   11396: 
                   11397: sub machine_ids {
                   11398:     my ($hostname) = @_;
                   11399:     $hostname ||= &hostname($perlvar{'lonHostID'});
1.465     albertel 11400:     my @ids;
1.888     albertel 11401:     my %name_to_host = &all_names();
1.889     albertel 11402:     if (ref($name_to_host{$hostname}) eq 'ARRAY') {
                   11403: 	return @{ $name_to_host{$hostname} };
                   11404:     }
                   11405:     return;
1.31      www      11406: }
                   11407: 
1.824     raeburn  11408: sub additional_machine_domains {
                   11409:     my @domains;
                   11410:     open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
                   11411:     while( my $line = <$fh>) {
                   11412:         $line =~ s/\s//g;
                   11413:         push(@domains,$line);
                   11414:     }
                   11415:     return @domains;
                   11416: }
                   11417: 
                   11418: sub default_login_domain {
                   11419:     my $domain = $perlvar{'lonDefDomain'};
                   11420:     my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
                   11421:     foreach my $posdom (&current_machine_domains(),
                   11422:                         &additional_machine_domains()) {
                   11423:         if (lc($posdom) eq lc($testdomain)) {
                   11424:             $domain=$posdom;
                   11425:             last;
                   11426:         }
                   11427:     }
                   11428:     return $domain;
                   11429: }
                   11430: 
1.31      www      11431: # ------------------------------------------------------------- Declutters URLs
                   11432: 
                   11433: sub declutter {
                   11434:     my $thisfn=shift;
1.569     albertel 11435:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479     albertel 11436:     $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31      www      11437:     $thisfn=~s/^\///;
1.697     albertel 11438:     $thisfn=~s|^adm/wrapper/||;
                   11439:     $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31      www      11440:     $thisfn=~s/^res\///;
1.1172    bisitz   11441:     $thisfn=~s/^priv\///;
1.1032    raeburn  11442:     unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
                   11443:         $thisfn=~s/\?.+$//;
                   11444:     }
1.268     www      11445:     return $thisfn;
                   11446: }
                   11447: 
                   11448: # ------------------------------------------------------------- Clutter up URLs
                   11449: 
                   11450: sub clutter {
                   11451:     my $thisfn='/'.&declutter(shift);
1.887     albertel 11452:     if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884     albertel 11453: 	|| $thisfn =~ m{^/adm/(includes|pages)} ) { 
1.270     www      11454:        $thisfn='/res'.$thisfn; 
                   11455:     }
1.1031    raeburn  11456:     if ($thisfn !~m|^/adm|) {
                   11457: 	if ($thisfn =~ m|^/ext/|) {
1.694     albertel 11458: 	    $thisfn='/adm/wrapper'.$thisfn;
1.695     albertel 11459: 	} else {
                   11460: 	    my ($ext) = ($thisfn =~ /\.(\w+)$/);
                   11461: 	    my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698     albertel 11462: 	    if ($embstyle eq 'ssi'
                   11463: 		|| ($embstyle eq 'hdn')
                   11464: 		|| ($embstyle eq 'rat')
                   11465: 		|| ($embstyle eq 'prv')
                   11466: 		|| ($embstyle eq 'ign')) {
                   11467: 		#do nothing with these
                   11468: 	    } elsif (($embstyle eq 'img') 
1.695     albertel 11469: 		|| ($embstyle eq 'emb')
                   11470: 		|| ($embstyle eq 'wrp')) {
                   11471: 		$thisfn='/adm/wrapper'.$thisfn;
1.698     albertel 11472: 	    } elsif ($embstyle eq 'unk'
                   11473: 		     && $thisfn!~/\.(sequence|page)$/) {
1.695     albertel 11474: 		$thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698     albertel 11475: 	    } else {
1.718     www      11476: #		&logthis("Got a blank emb style");
1.695     albertel 11477: 	    }
1.694     albertel 11478: 	}
                   11479:     }
1.31      www      11480:     return $thisfn;
1.12      www      11481: }
                   11482: 
1.787     albertel 11483: sub clutter_with_no_wrapper {
                   11484:     my $uri = &clutter(shift);
                   11485:     if ($uri =~ m-^/adm/-) {
                   11486: 	$uri =~ s-^/adm/wrapper/-/-;
                   11487: 	$uri =~ s-^/adm/coursedocs/showdoc/-/-;
                   11488:     }
                   11489:     return $uri;
                   11490: }
                   11491: 
1.557     albertel 11492: sub freeze_escape {
                   11493:     my ($value)=@_;
                   11494:     if (ref($value)) {
                   11495: 	$value=&nfreeze($value);
                   11496: 	return '__FROZEN__'.&escape($value);
                   11497:     }
                   11498:     return &escape($value);
                   11499: }
                   11500: 
1.11      www      11501: 
1.557     albertel 11502: sub thaw_unescape {
                   11503:     my ($value)=@_;
                   11504:     if ($value =~ /^__FROZEN__/) {
                   11505: 	substr($value,0,10,undef);
                   11506: 	$value=&unescape($value);
                   11507: 	return &thaw($value);
                   11508:     }
                   11509:     return &unescape($value);
                   11510: }
                   11511: 
1.436     albertel 11512: sub correct_line_ends {
                   11513:     my ($result)=@_;
                   11514:     $$result =~s/\r\n/\n/mg;
                   11515:     $$result =~s/\r/\n/mg;
1.415     albertel 11516: }
1.1       albertel 11517: # ================================================================ Main Program
                   11518: 
1.184     www      11519: sub goodbye {
1.204     albertel 11520:    &logthis("Starting Shut down");
1.443     albertel 11521: #not converted to using infrastruture and probably shouldn't be
1.870     albertel 11522:    &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443     albertel 11523: #converted
1.599     albertel 11524: #   &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870     albertel 11525:    &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
                   11526: #   &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
                   11527: #   &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425     albertel 11528: #1.1 only
1.870     albertel 11529: #   &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
                   11530: #   &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
                   11531: #   &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
                   11532: #   &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
                   11533:    &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599     albertel 11534:    &logthis(sprintf("%-20s is %s",'kicks',$kicks));
                   11535:    &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184     www      11536:    &flushcourselogs();
                   11537:    &logthis("Shutting down");
                   11538: }
                   11539: 
1.852     albertel 11540: sub get_dns {
1.869     albertel 11541:     my ($url,$func,$ignore_cache) = @_;
                   11542:     if (!$ignore_cache) {
                   11543: 	my ($content,$cached)=
                   11544: 	    &Apache::lonnet::is_cached_new('dns',$url);
                   11545: 	if ($cached) {
                   11546: 	    &$func($content);
                   11547: 	    return;
                   11548: 	}
                   11549:     }
                   11550: 
                   11551:     my %alldns;
1.852     albertel 11552:     open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
                   11553:     foreach my $dns (<$config>) {
                   11554: 	next if ($dns !~ /^\^(\S*)/x);
1.979     raeburn  11555:         my $line = $1;
                   11556:         my ($host,$protocol) = split(/:/,$line);
                   11557:         if ($protocol ne 'https') {
                   11558:             $protocol = 'http';
                   11559:         }
                   11560: 	$alldns{$host} = $protocol;
1.869     albertel 11561:     }
                   11562:     while (%alldns) {
                   11563: 	my ($dns) = keys(%alldns);
1.852     albertel 11564: 	my $ua=new LWP::UserAgent;
1.1134    raeburn  11565:         $ua->timeout(30);
1.979     raeburn  11566: 	my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852     albertel 11567: 	my $response=$ua->request($request);
1.979     raeburn  11568:         delete($alldns{$dns});
1.852     albertel 11569: 	next if ($response->is_error());
                   11570: 	my @content = split("\n",$response->content);
1.869     albertel 11571: 	&Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852     albertel 11572: 	&$func(\@content);
1.869     albertel 11573: 	return;
1.852     albertel 11574:     }
                   11575:     close($config);
1.871     albertel 11576:     my $which = (split('/',$url))[3];
                   11577:     &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
                   11578:     open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869     albertel 11579:     my @content = <$config>;
                   11580:     &$func(\@content);
                   11581:     return;
1.852     albertel 11582: }
1.327     albertel 11583: # ------------------------------------------------------------ Read domain file
                   11584: {
1.852     albertel 11585:     my $loaded;
1.846     albertel 11586:     my %domain;
                   11587: 
1.852     albertel 11588:     sub parse_domain_tab {
                   11589: 	my ($lines) = @_;
                   11590: 	foreach my $line (@$lines) {
                   11591: 	    next if ($line =~ /^(\#|\s*$ )/x);
1.403     www      11592: 
1.846     albertel 11593: 	    chomp($line);
1.852     albertel 11594: 	    my ($name,@elements) = split(/:/,$line,9);
1.846     albertel 11595: 	    my %this_domain;
                   11596: 	    foreach my $field ('description', 'auth_def', 'auth_arg_def',
                   11597: 			       'lang_def', 'city', 'longi', 'lati',
                   11598: 			       'primary') {
                   11599: 		$this_domain{$field} = shift(@elements);
                   11600: 	    }
                   11601: 	    $domain{$name} = \%this_domain;
1.852     albertel 11602: 	}
                   11603:     }
1.864     albertel 11604: 
                   11605:     sub reset_domain_info {
                   11606: 	undef($loaded);
                   11607: 	undef(%domain);
                   11608:     }
                   11609: 
1.852     albertel 11610:     sub load_domain_tab {
1.869     albertel 11611: 	my ($ignore_cache) = @_;
                   11612: 	&get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852     albertel 11613: 	my $fh;
                   11614: 	if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
                   11615: 	    my @lines = <$fh>;
                   11616: 	    &parse_domain_tab(\@lines);
1.448     albertel 11617: 	}
1.852     albertel 11618: 	close($fh);
                   11619: 	$loaded = 1;
1.327     albertel 11620:     }
1.846     albertel 11621: 
                   11622:     sub domain {
1.852     albertel 11623: 	&load_domain_tab() if (!$loaded);
                   11624: 
1.846     albertel 11625: 	my ($name,$what) = @_;
                   11626: 	return if ( !exists($domain{$name}) );
                   11627: 
                   11628: 	if (!$what) {
                   11629: 	    return $domain{$name}{'description'};
                   11630: 	}
                   11631: 	return $domain{$name}{$what};
                   11632:     }
1.974     raeburn  11633: 
                   11634:     sub domain_info {
                   11635:         &load_domain_tab() if (!$loaded);
                   11636:         return %domain;
                   11637:     }
                   11638: 
1.327     albertel 11639: }
                   11640: 
                   11641: 
1.1       albertel 11642: # ------------------------------------------------------------- Read hosts file
                   11643: {
1.838     albertel 11644:     my %hostname;
1.844     albertel 11645:     my %hostdom;
1.845     albertel 11646:     my %libserv;
1.852     albertel 11647:     my $loaded;
1.888     albertel 11648:     my %name_to_host;
1.1074    raeburn  11649:     my %internetdom;
1.1107    raeburn  11650:     my %LC_dns_serv;
1.852     albertel 11651: 
                   11652:     sub parse_hosts_tab {
                   11653: 	my ($file) = @_;
                   11654: 	foreach my $configline (@$file) {
                   11655: 	    next if ($configline =~ /^(\#|\s*$ )/x);
1.1107    raeburn  11656:             chomp($configline);
                   11657: 	    if ($configline =~ /^\^/) {
                   11658:                 if ($configline =~ /^\^([\w.\-]+)/) {
                   11659:                     $LC_dns_serv{$1} = 1;
                   11660:                 }
                   11661:                 next;
                   11662:             }
1.1074    raeburn  11663: 	    my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852     albertel 11664: 	    $name=~s/\s//g;
                   11665: 	    if ($id && $domain && $role && $name) {
                   11666: 		$hostname{$id}=$name;
1.888     albertel 11667: 		push(@{$name_to_host{$name}}, $id);
1.852     albertel 11668: 		$hostdom{$id}=$domain;
                   11669: 		if ($role eq 'library') { $libserv{$id}=$name; }
1.969     raeburn  11670:                 if (defined($protocol)) {
                   11671:                     if ($protocol eq 'https') {
                   11672:                         $protocol{$id} = $protocol;
                   11673:                     } else {
                   11674:                         $protocol{$id} = 'http'; 
                   11675:                     }
1.968     raeburn  11676:                 } else {
1.969     raeburn  11677:                     $protocol{$id} = 'http';
1.968     raeburn  11678:                 }
1.1074    raeburn  11679:                 if (defined($intdom)) {
                   11680:                     $internetdom{$id} = $intdom;
                   11681:                 }
1.852     albertel 11682: 	    }
                   11683: 	}
                   11684:     }
1.864     albertel 11685:     
                   11686:     sub reset_hosts_info {
1.897     albertel 11687: 	&purge_remembered();
1.864     albertel 11688: 	&reset_domain_info();
                   11689: 	&reset_hosts_ip_info();
1.892     albertel 11690: 	undef(%name_to_host);
1.864     albertel 11691: 	undef(%hostname);
                   11692: 	undef(%hostdom);
                   11693: 	undef(%libserv);
                   11694: 	undef($loaded);
                   11695:     }
1.1       albertel 11696: 
1.852     albertel 11697:     sub load_hosts_tab {
1.869     albertel 11698: 	my ($ignore_cache) = @_;
                   11699: 	&get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852     albertel 11700: 	open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
                   11701: 	my @config = <$config>;
                   11702: 	&parse_hosts_tab(\@config);
                   11703: 	close($config);
                   11704: 	$loaded=1;
1.1       albertel 11705:     }
1.852     albertel 11706: 
1.838     albertel 11707:     sub hostname {
1.852     albertel 11708: 	&load_hosts_tab() if (!$loaded);
                   11709: 
1.838     albertel 11710: 	my ($lonid) = @_;
                   11711: 	return $hostname{$lonid};
                   11712:     }
1.845     albertel 11713: 
1.838     albertel 11714:     sub all_hostnames {
1.852     albertel 11715: 	&load_hosts_tab() if (!$loaded);
                   11716: 
1.838     albertel 11717: 	return %hostname;
                   11718:     }
1.845     albertel 11719: 
1.888     albertel 11720:     sub all_names {
                   11721: 	&load_hosts_tab() if (!$loaded);
                   11722: 
                   11723: 	return %name_to_host;
                   11724:     }
                   11725: 
1.974     raeburn  11726:     sub all_host_domain {
                   11727:         &load_hosts_tab() if (!$loaded);
                   11728:         return %hostdom;
                   11729:     }
                   11730: 
1.845     albertel 11731:     sub is_library {
1.852     albertel 11732: 	&load_hosts_tab() if (!$loaded);
                   11733: 
1.845     albertel 11734: 	return exists($libserv{$_[0]});
                   11735:     }
                   11736: 
                   11737:     sub all_library {
1.852     albertel 11738: 	&load_hosts_tab() if (!$loaded);
                   11739: 
1.845     albertel 11740: 	return %libserv;
                   11741:     }
                   11742: 
1.1062    droeschl 11743:     sub unique_library {
                   11744: 	#2x reverse removes all hostnames that appear more than once
                   11745:         my %unique = reverse &all_library();
                   11746:         return reverse %unique;
                   11747:     }
                   11748: 
1.841     albertel 11749:     sub get_servers {
1.852     albertel 11750: 	&load_hosts_tab() if (!$loaded);
                   11751: 
1.841     albertel 11752: 	my ($domain,$type) = @_;
                   11753: 	my %possible_hosts = ($type eq 'library') ? %libserv
                   11754: 	                                          : %hostname;
                   11755: 	my %result;
1.842     albertel 11756: 	if (ref($domain) eq 'ARRAY') {
                   11757: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843     albertel 11758: 		if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842     albertel 11759: 		    $result{$host} = $hostname;
                   11760: 		}
                   11761: 	    }
                   11762: 	} else {
                   11763: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
                   11764: 		if ($hostdom{$host} eq $domain) {
                   11765: 		    $result{$host} = $hostname;
                   11766: 		}
1.841     albertel 11767: 	    }
                   11768: 	}
                   11769: 	return %result;
                   11770:     }
1.845     albertel 11771: 
1.1062    droeschl 11772:     sub get_unique_servers {
                   11773:         my %unique = reverse &get_servers(@_);
                   11774: 	return reverse %unique;
                   11775:     }
                   11776: 
1.844     albertel 11777:     sub host_domain {
1.852     albertel 11778: 	&load_hosts_tab() if (!$loaded);
                   11779: 
1.844     albertel 11780: 	my ($lonid) = @_;
                   11781: 	return $hostdom{$lonid};
                   11782:     }
                   11783: 
1.841     albertel 11784:     sub all_domains {
1.852     albertel 11785: 	&load_hosts_tab() if (!$loaded);
                   11786: 
1.841     albertel 11787: 	my %seen;
                   11788: 	my @uniq = grep(!$seen{$_}++, values(%hostdom));
                   11789: 	return @uniq;
                   11790:     }
1.1074    raeburn  11791: 
                   11792:     sub internet_dom {
                   11793:         &load_hosts_tab() if (!$loaded);
                   11794: 
                   11795:         my ($lonid) = @_;
                   11796:         return $internetdom{$lonid};
                   11797:     }
1.1107    raeburn  11798: 
                   11799:     sub is_LC_dns {
                   11800:         &load_hosts_tab() if (!$loaded);
                   11801: 
                   11802:         my ($hostname) = @_;
                   11803:         return exists($LC_dns_serv{$hostname});
                   11804:     }
                   11805: 
1.1       albertel 11806: }
                   11807: 
1.847     albertel 11808: { 
                   11809:     my %iphost;
1.856     albertel 11810:     my %name_to_ip;
                   11811:     my %lonid_to_ip;
1.869     albertel 11812: 
1.847     albertel 11813:     sub get_hosts_from_ip {
                   11814: 	my ($ip) = @_;
                   11815: 	my %iphosts = &get_iphost();
                   11816: 	if (ref($iphosts{$ip})) {
                   11817: 	    return @{$iphosts{$ip}};
                   11818: 	}
                   11819: 	return;
1.839     albertel 11820:     }
1.864     albertel 11821:     
                   11822:     sub reset_hosts_ip_info {
                   11823: 	undef(%iphost);
                   11824: 	undef(%name_to_ip);
                   11825: 	undef(%lonid_to_ip);
                   11826:     }
1.856     albertel 11827: 
                   11828:     sub get_host_ip {
                   11829: 	my ($lonid) = @_;
                   11830: 	if (exists($lonid_to_ip{$lonid})) {
                   11831: 	    return $lonid_to_ip{$lonid};
                   11832: 	}
                   11833: 	my $name=&hostname($lonid);
                   11834:    	my $ip = gethostbyname($name);
                   11835: 	return if (!$ip || length($ip) ne 4);
                   11836: 	$ip=inet_ntoa($ip);
                   11837: 	$name_to_ip{$name}   = $ip;
                   11838: 	$lonid_to_ip{$lonid} = $ip;
                   11839: 	return $ip;
                   11840:     }
1.847     albertel 11841:     
                   11842:     sub get_iphost {
1.869     albertel 11843: 	my ($ignore_cache) = @_;
1.894     albertel 11844: 
1.869     albertel 11845: 	if (!$ignore_cache) {
                   11846: 	    if (%iphost) {
                   11847: 		return %iphost;
                   11848: 	    }
                   11849: 	    my ($ip_info,$cached)=
                   11850: 		&Apache::lonnet::is_cached_new('iphost','iphost');
                   11851: 	    if ($cached) {
                   11852: 		%iphost      = %{$ip_info->[0]};
                   11853: 		%name_to_ip  = %{$ip_info->[1]};
                   11854: 		%lonid_to_ip = %{$ip_info->[2]};
                   11855: 		return %iphost;
                   11856: 	    }
                   11857: 	}
1.894     albertel 11858: 
                   11859: 	# get yesterday's info for fallback
                   11860: 	my %old_name_to_ip;
                   11861: 	my ($ip_info,$cached)=
                   11862: 	    &Apache::lonnet::is_cached_new('iphost','iphost');
                   11863: 	if ($cached) {
                   11864: 	    %old_name_to_ip = %{$ip_info->[1]};
                   11865: 	}
                   11866: 
1.888     albertel 11867: 	my %name_to_host = &all_names();
                   11868: 	foreach my $name (keys(%name_to_host)) {
1.847     albertel 11869: 	    my $ip;
                   11870: 	    if (!exists($name_to_ip{$name})) {
                   11871: 		$ip = gethostbyname($name);
                   11872: 		if (!$ip || length($ip) ne 4) {
1.894     albertel 11873: 		    if (defined($old_name_to_ip{$name})) {
                   11874: 			$ip = $old_name_to_ip{$name};
                   11875: 			&logthis("Can't find $name defaulting to old $ip");
                   11876: 		    } else {
                   11877: 			&logthis("Name $name no IP found");
                   11878: 			next;
                   11879: 		    }
                   11880: 		} else {
                   11881: 		    $ip=inet_ntoa($ip);
1.847     albertel 11882: 		}
                   11883: 		$name_to_ip{$name} = $ip;
                   11884: 	    } else {
                   11885: 		$ip = $name_to_ip{$name};
1.653     albertel 11886: 	    }
1.888     albertel 11887: 	    foreach my $id (@{ $name_to_host{$name} }) {
                   11888: 		$lonid_to_ip{$id} = $ip;
                   11889: 	    }
                   11890: 	    push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598     albertel 11891: 	}
1.869     albertel 11892: 	&Apache::lonnet::do_cache_new('iphost','iphost',
                   11893: 				      [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894     albertel 11894: 				      48*60*60);
1.869     albertel 11895: 
1.847     albertel 11896: 	return %iphost;
1.598     albertel 11897:     }
                   11898: 
1.992     raeburn  11899:     #
                   11900:     #  Given a DNS returns the loncapa host name for that DNS 
                   11901:     # 
                   11902:     sub host_from_dns {
                   11903:         my ($dns) = @_;
                   11904:         my @hosts;
                   11905:         my $ip;
                   11906: 
1.993     raeburn  11907:         if (exists($name_to_ip{$dns})) {
1.992     raeburn  11908:             $ip = $name_to_ip{$dns};
                   11909:         }
                   11910:         if (!$ip) {
                   11911:             $ip = gethostbyname($dns); # Initial translation to IP is in net order.
                   11912:             if (length($ip) == 4) { 
                   11913: 	        $ip   = &IO::Socket::inet_ntoa($ip);
                   11914:             }
                   11915:         }
                   11916:         if ($ip) {
                   11917: 	    @hosts = get_hosts_from_ip($ip);
                   11918: 	    return $hosts[0];
                   11919:         }
                   11920:         return undef;
1.986     foxr     11921:     }
1.992     raeburn  11922: 
1.1074    raeburn  11923:     sub get_internet_names {
                   11924:         my ($lonid) = @_;
                   11925:         return if ($lonid eq '');
                   11926:         my ($idnref,$cached)=
                   11927:             &Apache::lonnet::is_cached_new('internetnames',$lonid);
                   11928:         if ($cached) {
                   11929:             return $idnref;
                   11930:         }
                   11931:         my $ip = &get_host_ip($lonid);
                   11932:         my @hosts = &get_hosts_from_ip($ip);
                   11933:         my %iphost = &get_iphost();
                   11934:         my (@idns,%seen);
                   11935:         foreach my $id (@hosts) {
                   11936:             my $dom = &host_domain($id);
                   11937:             my $prim_id = &domain($dom,'primary');
                   11938:             my $prim_ip = &get_host_ip($prim_id);
                   11939:             next if ($seen{$prim_ip});
                   11940:             if (ref($iphost{$prim_ip}) eq 'ARRAY') {
                   11941:                 foreach my $id (@{$iphost{$prim_ip}}) {
                   11942:                     my $intdom = &internet_dom($id);
                   11943:                     unless (grep(/^\Q$intdom\E$/,@idns)) {
                   11944:                         push(@idns,$intdom);
                   11945:                     }
                   11946:                 }
                   11947:             }
                   11948:             $seen{$prim_ip} = 1;
                   11949:         }
                   11950:         return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
                   11951:     }
                   11952: 
1.986     foxr     11953: }
                   11954: 
1.1079    raeburn  11955: sub all_loncaparevs {
                   11956:     return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10);
                   11957: }
                   11958: 
1.862     albertel 11959: BEGIN {
                   11960: 
                   11961: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
                   11962:     unless ($readit) {
                   11963: {
                   11964:     my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
                   11965:     %perlvar = (%perlvar,%{$configvars});
                   11966: }
                   11967: 
                   11968: 
1.1       albertel 11969: # ------------------------------------------------------ Read spare server file
                   11970: {
1.448     albertel 11971:     open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1       albertel 11972: 
                   11973:     while (my $configline=<$config>) {
                   11974:        chomp($configline);
1.284     matthew  11975:        if ($configline) {
1.784     albertel 11976: 	   my ($host,$type) = split(':',$configline,2);
1.785     albertel 11977: 	   if (!defined($type) || $type eq '') { $type = 'default' };
1.784     albertel 11978: 	   push(@{ $spareid{$type} }, $host);
1.1       albertel 11979:        }
                   11980:     }
1.448     albertel 11981:     close($config);
1.1       albertel 11982: }
1.11      www      11983: # ------------------------------------------------------------ Read permissions
                   11984: {
1.448     albertel 11985:     open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11      www      11986: 
                   11987:     while (my $configline=<$config>) {
1.448     albertel 11988: 	chomp($configline);
                   11989: 	if ($configline) {
                   11990: 	    my ($role,$perm)=split(/ /,$configline);
                   11991: 	    if ($perm ne '') { $pr{$role}=$perm; }
                   11992: 	}
1.11      www      11993:     }
1.448     albertel 11994:     close($config);
1.11      www      11995: }
                   11996: 
                   11997: # -------------------------------------------- Read plain texts for permissions
                   11998: {
1.448     albertel 11999:     open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11      www      12000: 
                   12001:     while (my $configline=<$config>) {
1.448     albertel 12002: 	chomp($configline);
                   12003: 	if ($configline) {
1.742     raeburn  12004: 	    my ($short,@plain)=split(/:/,$configline);
                   12005:             %{$prp{$short}} = ();
                   12006: 	    if (@plain > 0) {
                   12007:                 $prp{$short}{'std'} = $plain[0];
                   12008:                 for (my $i=1; $i<@plain; $i++) {
                   12009:                     $prp{$short}{'alt'.$i} = $plain[$i];  
                   12010:                 }
                   12011:             }
1.448     albertel 12012: 	}
1.135     www      12013:     }
1.448     albertel 12014:     close($config);
1.135     www      12015: }
                   12016: 
                   12017: # ---------------------------------------------------------- Read package table
                   12018: {
1.448     albertel 12019:     open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135     www      12020: 
                   12021:     while (my $configline=<$config>) {
1.483     albertel 12022: 	if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448     albertel 12023: 	chomp($configline);
                   12024: 	my ($short,$plain)=split(/:/,$configline);
                   12025: 	my ($pack,$name)=split(/\&/,$short);
                   12026: 	if ($plain ne '') {
                   12027: 	    $packagetab{$pack.'&'.$name.'&name'}=$name; 
                   12028: 	    $packagetab{$short}=$plain; 
                   12029: 	}
1.11      www      12030:     }
1.448     albertel 12031:     close($config);
1.329     matthew  12032: }
                   12033: 
1.1073    raeburn  12034: # ---------------------------------------------------------- Read loncaparev table
                   12035: {
                   12036:     if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
                   12037:         if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
                   12038:             while (my $configline=<$config>) {
                   12039:                 chomp($configline);
                   12040:                 my ($hostid,$loncaparev)=split(/:/,$configline);
                   12041:                 $loncaparevs{$hostid}=$loncaparev;
                   12042:             }
                   12043:             close($config);
                   12044:         }
                   12045:     }
                   12046: }
                   12047: 
1.1074    raeburn  12048: # ---------------------------------------------------------- Read serverhostID table
                   12049: {
                   12050:     if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
                   12051:         if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
                   12052:             while (my $configline=<$config>) {
                   12053:                 chomp($configline);
                   12054:                 my ($name,$id)=split(/:/,$configline);
                   12055:                 $serverhomeIDs{$name}=$id;
                   12056:             }
                   12057:             close($config);
                   12058:         }
                   12059:     }
                   12060: }
                   12061: 
1.1079    raeburn  12062: {
                   12063:     my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
                   12064:     if (-e $file) {
                   12065:         my $parser = HTML::LCParser->new($file);
                   12066:         while (my $token = $parser->get_token()) {
                   12067:             if ($token->[0] eq 'S') {
                   12068:                 my $item = $token->[1];
                   12069:                 my $name = $token->[2]{'name'};
                   12070:                 my $value = $token->[2]{'value'};
                   12071:                 if ($item ne '' && $name ne '' && $value ne '') {
                   12072:                     my $release = $parser->get_text();
                   12073:                     $release =~ s/(^\s*|\s*$ )//gx;
                   12074:                     $needsrelease{$item.':'.$name.':'.$value} = $release;
                   12075:                 }
                   12076:             }
                   12077:         }
                   12078:     }
1.1073    raeburn  12079: }
                   12080: 
1.1138    raeburn  12081: # ---------------------------------------------------------- Read managers table
                   12082: {
                   12083:     if (-e "$perlvar{'lonTabDir'}/managers.tab") {
                   12084:         if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
                   12085:             while (my $configline=<$config>) {
                   12086:                 chomp($configline);
                   12087:                 next if ($configline =~ /^\#/);
                   12088:                 if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
                   12089:                     $managerstab{$configline} = 1;
                   12090:                 }
                   12091:             }
                   12092:             close($config);
                   12093:         }
                   12094:     }
                   12095: }
                   12096: 
1.329     matthew  12097: # ------------- set up temporary directory
                   12098: {
1.1117    foxr     12099:     $tmpdir = LONCAPA::tempdir();
1.329     matthew  12100: 
1.11      www      12101: }
                   12102: 
1.794     albertel 12103: $memcache=new Cache::Memcached({'servers'           => ['127.0.0.1:11211'],
                   12104: 				'compress_threshold'=> 20_000,
                   12105:  			        });
1.185     www      12106: 
1.281     www      12107: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186     www      12108: $dumpcount=0;
1.958     www      12109: $locknum=0;
1.22      www      12110: 
1.163     harris41 12111: &logtouch();
1.672     albertel 12112: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195     www      12113: $readit=1;
1.564     albertel 12114:     {
                   12115: 	use integer;
                   12116: 	my $test=(2**32)+1;
1.568     albertel 12117: 	if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564     albertel 12118: 	&logthis(" Detected 64bit platform ($_64bit)");
                   12119:     }
1.195     www      12120: }
1.1       albertel 12121: }
1.179     www      12122: 
1.1       albertel 12123: 1;
1.191     harris41 12124: __END__
                   12125: 
1.243     albertel 12126: =pod
                   12127: 
1.191     harris41 12128: =head1 NAME
                   12129: 
1.243     albertel 12130: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191     harris41 12131: 
                   12132: =head1 SYNOPSIS
                   12133: 
1.243     albertel 12134: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191     harris41 12135: 
                   12136:  &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
                   12137: 
1.243     albertel 12138: Common parameters:
                   12139: 
                   12140: =over 4
                   12141: 
                   12142: =item *
                   12143: 
                   12144: $uname : an internal username (if $cname expecting a course Id specifically)
                   12145: 
                   12146: =item *
                   12147: 
                   12148: $udom : a domain (if $cdom expecting a course's domain specifically)
                   12149: 
                   12150: =item *
                   12151: 
                   12152: $symb : a resource instance identifier
                   12153: 
                   12154: =item *
                   12155: 
                   12156: $namespace : the name of a .db file that contains the data needed or
                   12157: being set.
                   12158: 
                   12159: =back
                   12160: 
1.394     bowersj2 12161: =head1 OVERVIEW
1.191     harris41 12162: 
1.394     bowersj2 12163: lonnet provides subroutines which interact with the
                   12164: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
                   12165: about classes, users, and resources.
1.243     albertel 12166: 
                   12167: For many of these objects you can also use this to store data about
                   12168: them or modify them in various ways.
1.191     harris41 12169: 
1.394     bowersj2 12170: =head2 Symbs
1.191     harris41 12171: 
1.394     bowersj2 12172: To identify a specific instance of a resource, LON-CAPA uses symbols
                   12173: or "symbs"X<symb>. These identifiers are built from the URL of the
                   12174: map, the resource number of the resource in the map, and the URL of
                   12175: the resource itself. The latter is somewhat redundant, but might help
                   12176: if maps change.
                   12177: 
                   12178: An example is
                   12179: 
                   12180:  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
                   12181: 
                   12182: The respective map entry is
                   12183: 
                   12184:  <resource id="19" src="/res/msu/korte/tests/part12.problem"
                   12185:   title="Problem 2">
                   12186:  </resource>
                   12187: 
                   12188: Symbs are used by the random number generator, as well as to store and
                   12189: restore data specific to a certain instance of for example a problem.
                   12190: 
                   12191: =head2 Storing And Retrieving Data
                   12192: 
                   12193: X<store()>X<cstore()>X<restore()>Three of the most important functions
                   12194: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
                   12195: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
                   12196: is is the non-critical message twin of cstore. These functions are for
                   12197: handlers to store a perl hash to a user's permanent data space in an
                   12198: easy manner, and to retrieve it again on another call. It is expected
                   12199: that a handler would use this once at the beginning to retrieve data,
                   12200: and then again once at the end to send only the new data back.
                   12201: 
                   12202: The data is stored in the user's data directory on the user's
                   12203: homeserver under the ID of the course.
                   12204: 
                   12205: The hash that is returned by restore will have all of the previous
                   12206: value for all of the elements of the hash.
                   12207: 
                   12208: Example:
                   12209: 
                   12210:  #creating a hash
                   12211:  my %hash;
                   12212:  $hash{'foo'}='bar';
                   12213: 
                   12214:  #storing it
                   12215:  &Apache::lonnet::cstore(\%hash);
                   12216: 
                   12217:  #changing a value
                   12218:  $hash{'foo'}='notbar';
                   12219: 
                   12220:  #adding a new value
                   12221:  $hash{'bar'}='foo';
                   12222:  &Apache::lonnet::cstore(\%hash);
                   12223: 
                   12224:  #retrieving the hash
                   12225:  my %history=&Apache::lonnet::restore();
                   12226: 
                   12227:  #print the hash
                   12228:  foreach my $key (sort(keys(%history))) {
                   12229:    print("\%history{$key} = $history{$key}");
                   12230:  }
                   12231: 
                   12232: Will print out:
1.191     harris41 12233: 
1.394     bowersj2 12234:  %history{1:foo} = bar
                   12235:  %history{1:keys} = foo:timestamp
                   12236:  %history{1:timestamp} = 990455579
                   12237:  %history{2:bar} = foo
                   12238:  %history{2:foo} = notbar
                   12239:  %history{2:keys} = foo:bar:timestamp
                   12240:  %history{2:timestamp} = 990455580
                   12241:  %history{bar} = foo
                   12242:  %history{foo} = notbar
                   12243:  %history{timestamp} = 990455580
                   12244:  %history{version} = 2
                   12245: 
                   12246: Note that the special hash entries C<keys>, C<version> and
                   12247: C<timestamp> were added to the hash. C<version> will be equal to the
                   12248: total number of versions of the data that have been stored. The
                   12249: C<timestamp> attribute will be the UNIX time the hash was
                   12250: stored. C<keys> is available in every historical section to list which
                   12251: keys were added or changed at a specific historical revision of a
                   12252: hash.
                   12253: 
                   12254: B<Warning>: do not store the hash that restore returns directly. This
                   12255: will cause a mess since it will restore the historical keys as if the
                   12256: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191     harris41 12257: 
1.394     bowersj2 12258: Calling convention:
1.191     harris41 12259: 
1.394     bowersj2 12260:  my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
                   12261:  &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191     harris41 12262: 
1.394     bowersj2 12263: For more detailed information, see lonnet specific documentation.
1.191     harris41 12264: 
1.394     bowersj2 12265: =head1 RETURN MESSAGES
1.191     harris41 12266: 
1.394     bowersj2 12267: =over 4
1.191     harris41 12268: 
1.394     bowersj2 12269: =item * B<con_lost>: unable to contact remote host
1.191     harris41 12270: 
1.394     bowersj2 12271: =item * B<con_delayed>: unable to contact remote host, message will be delivered
                   12272: when the connection is brought back up
1.191     harris41 12273: 
1.394     bowersj2 12274: =item * B<con_failed>: unable to contact remote host and unable to save message
                   12275: for later delivery
1.191     harris41 12276: 
1.967     bisitz   12277: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191     harris41 12278: 
1.394     bowersj2 12279: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243     albertel 12280: that was requested
1.191     harris41 12281: 
1.243     albertel 12282: =back
1.191     harris41 12283: 
1.243     albertel 12284: =head1 PUBLIC SUBROUTINES
1.191     harris41 12285: 
1.243     albertel 12286: =head2 Session Environment Functions
1.191     harris41 12287: 
1.243     albertel 12288: =over 4
1.191     harris41 12289: 
1.394     bowersj2 12290: =item * 
                   12291: X<appenv()>
1.949     raeburn  12292: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394     bowersj2 12293: the user envirnoment file, and will be restored for each access this
1.620     albertel 12294: user makes during this session, also modifies the %env for the current
1.949     raeburn  12295: process. Optional rolesarrayref - if defined contains a reference to an array
                   12296: of roles which are exempt from the restriction on modifying user.role entries 
                   12297: in the user's environment.db and in %env.    
1.191     harris41 12298: 
                   12299: =item *
1.394     bowersj2 12300: X<delenv()>
1.987     raeburn  12301: B<delenv($delthis,$regexp)>: removes all items from the session
                   12302: environment file that begin with $delthis. If the 
                   12303: optional second arg - $regexp - is true, $delthis is treated as a 
                   12304: regular expression, otherwise \Q$delthis\E is used. 
                   12305: The values are also deleted from the current processes %env.
1.191     harris41 12306: 
1.795     albertel 12307: =item * get_env_multiple($name) 
                   12308: 
                   12309: gets $name from the %env hash, it seemlessly handles the cases where multiple
                   12310: values may be defined and end up as an array ref.
                   12311: 
                   12312: returns an array of values
                   12313: 
1.243     albertel 12314: =back
                   12315: 
                   12316: =head2 User Information
1.191     harris41 12317: 
1.243     albertel 12318: =over 4
1.191     harris41 12319: 
                   12320: =item *
1.394     bowersj2 12321: X<queryauthenticate()>
                   12322: B<queryauthenticate($uname,$udom)>: try to determine user's current 
1.191     harris41 12323: authentication scheme
                   12324: 
                   12325: =item *
1.394     bowersj2 12326: X<authenticate()>
1.1073    raeburn  12327: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394     bowersj2 12328: authenticate user from domain's lib servers (first use the current
                   12329: one). C<$upass> should be the users password.
1.1073    raeburn  12330: $checkdefauth is optional (value is 1 if a check should be made to
                   12331:    authenticate user using default authentication method, and allow
                   12332:    account creation if username does not have account in the domain).
                   12333: $clientcancheckhost is optional (value is 1 if checking whether the
                   12334:    server can host will occur on the client side in lonauth.pm).   
1.191     harris41 12335: 
                   12336: =item *
1.394     bowersj2 12337: X<homeserver()>
                   12338: B<homeserver($uname,$udom)>: find the server which has
                   12339: the user's directory and files (there must be only one), this caches
                   12340: the answer, and also caches if there is a borken connection.
1.191     harris41 12341: 
                   12342: =item *
1.394     bowersj2 12343: X<idget()>
                   12344: B<idget($udom,@ids)>: find the usernames behind a list of IDs
                   12345: (IDs are a unique resource in a domain, there must be only 1 ID per
                   12346: username, and only 1 username per ID in a specific domain) (returns
                   12347: hash: id=>name,id=>name)
1.191     harris41 12348: 
                   12349: =item *
1.394     bowersj2 12350: X<idrget()>
                   12351: B<idrget($udom,@unames)>: find the IDs behind a list of
                   12352: usernames (returns hash: name=>id,name=>id)
1.191     harris41 12353: 
                   12354: =item *
1.394     bowersj2 12355: X<idput()>
                   12356: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191     harris41 12357: 
                   12358: =item *
1.394     bowersj2 12359: X<rolesinit()>
1.1169    droeschl 12360: B<rolesinit($udom,$username)>: get user privileges.
                   12361: returns user role, first access and timer interval hashes
1.243     albertel 12362: 
                   12363: =item *
1.1171    droeschl 12364: X<privileged()>
                   12365: B<privileged($username,$domain)>: returns a true if user has a
                   12366: privileged and active role (i.e. su or dc), false otherwise.
                   12367: 
                   12368: =item *
1.551     albertel 12369: X<getsection()>
                   12370: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243     albertel 12371: course $cname, return section name/number or '' for "not in course"
                   12372: and '-1' for "no section"
                   12373: 
                   12374: =item *
1.394     bowersj2 12375: X<userenvironment()>
                   12376: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243     albertel 12377: passed in @what from the requested user's environment, returns a hash
                   12378: 
1.858     raeburn  12379: =item * 
                   12380: X<userlog_query()>
1.859     albertel 12381: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
                   12382: activity.log file. %filters defines filters applied when parsing the
                   12383: log file. These can be start or end timestamps, or the type of action
                   12384: - log to look for Login or Logout events, check for Checkin or
                   12385: Checkout, role for role selection. The response is in the form
                   12386: timestamp1:hostid1:event1&timestamp2:hostid2:event2 where events are
                   12387: escaped strings of the action recorded in the activity.log file.
1.858     raeburn  12388: 
1.243     albertel 12389: =back
                   12390: 
                   12391: =head2 User Roles
                   12392: 
                   12393: =over 4
                   12394: 
                   12395: =item *
                   12396: 
1.810     raeburn  12397: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243     albertel 12398:  F: full access
                   12399:  U,I,K: authentication modes (cxx only)
                   12400:  '': forbidden
                   12401:  1: user needs to choose course
                   12402:  2: browse allowed
1.766     albertel 12403:  A: passphrase authentication needed
1.243     albertel 12404: 
                   12405: =item *
                   12406: 
1.1192    raeburn  12407: constructaccess($url,$setpriv) : check for access to construction space URL
                   12408: 
                   12409: See if the owner domain and name in the URL match those in the
                   12410: expected environment.  If so, return three element list
                   12411: ($ownername,$ownerdomain,$ownerhome).
                   12412: 
                   12413: Otherwise return the null string.
                   12414: 
                   12415: If second argument 'setpriv' is true, it assigns the privileges,
                   12416: and returns the same three element list, unless the owner has
                   12417: blocked "ad hoc" Domain Coordinator access to the Author Space,
                   12418: in which case the null string is returned.
                   12419: 
                   12420: =item *
                   12421: 
1.243     albertel 12422: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
                   12423: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
                   12424: and course level
                   12425: 
                   12426: =item *
                   12427: 
1.988     raeburn  12428: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 
                   12429: (rolesplain.tab); plain text explanation of a user role term.
1.1008    raeburn  12430: $type is Course (default) or Community.
1.988     raeburn  12431: If $forcedefault evaluates to true, text returned will be default 
                   12432: text for $type. Otherwise, if this is a course, the text returned 
                   12433: will be a custom name for the role (if defined in the course's 
                   12434: environment).  If no custom name is defined the default is returned.
                   12435:    
1.832     raeburn  12436: =item *
                   12437: 
1.935     raeburn  12438: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858     raeburn  12439: All arguments are optional. Returns a hash of a roles, either for
                   12440: co-author/assistant author roles for a user's Construction Space
1.906     albertel 12441: (default), or if $context is 'userroles', roles for the user himself,
1.933     raeburn  12442: In the hash, keys are set to colon-separated $uname,$udom,$role, and
                   12443: (optionally) if $withsec is true, a fourth colon-separated item - $section.
                   12444: For each key, value is set to colon-separated start and end times for
                   12445: the role.  If no username and domain are specified, will default to
1.934     raeburn  12446: current user/domain. Types, roles, and roledoms are references to arrays
1.858     raeburn  12447: of role statuses (active, future or previous), roles 
                   12448: (e.g., cc,in, st etc.) and domains of the roles which can be used
                   12449: to restrict the list of roles reported. If no array ref is 
                   12450: provided for types, will default to return only active roles.
1.834     albertel 12451: 
1.1195    raeburn  12452: =item *
                   12453: 
                   12454: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196    raeburn  12455: user: $uname:$udom has a role in the course: $cdom_$cnum. 
                   12456: 
                   12457: Additional optional arguments are: $type (if role checking is to be restricted 
                   12458: to certain user status types -- previous (expired roles), active (currently
1.1195    raeburn  12459: available roles) or future (roles available in the future), and
                   12460: $hideprivileged -- if true will not report course roles for users who
                   12461: have active Domain Coordinator or Super User roles.
                   12462: 
1.243     albertel 12463: =back
                   12464: 
                   12465: =head2 User Modification
                   12466: 
                   12467: =over 4
                   12468: 
                   12469: =item *
                   12470: 
1.957     raeburn  12471: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243     albertel 12472: user for the level given by URL.  Optional start and end dates (leave empty
                   12473: string or zero for "no date")
1.191     harris41 12474: 
                   12475: =item *
                   12476: 
1.243     albertel 12477: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
                   12478: change a users, password, possible return values are: ok,
                   12479: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
                   12480: refused
1.191     harris41 12481: 
                   12482: =item *
                   12483: 
1.243     albertel 12484: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191     harris41 12485: 
                   12486: =item *
                   12487: 
1.1058    raeburn  12488: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
                   12489:            $forceid,$desiredhome,$email,$inststatus,$candelete) :
                   12490: 
                   12491: will update user information (firstname,middlename,lastname,generation,
                   12492: permanentemail), and if forceid is true, student/employee ID also.
                   12493: A user's institutional affiliation(s) can also be updated.
                   12494: User information fields will not be overwritten with empty entries 
                   12495: unless the field is included in the $candelete array reference.
                   12496: This array is included when a single user is modified via "Manage Users",
                   12497: or when Autoupdate.pl is run by cron in a domain.
1.191     harris41 12498: 
                   12499: =item *
                   12500: 
1.286     matthew  12501: modifystudent
                   12502: 
1.957     raeburn  12503: modify a student's enrollment and identification information.
1.286     matthew  12504: The course id is resolved based on the current users environment.  
                   12505: This means the envoking user must be a course coordinator or otherwise
                   12506: associated with a course.
                   12507: 
1.297     matthew  12508: This call is essentially a wrapper for lonnet::modifyuser and
                   12509: lonnet::modify_student_enrollment
1.286     matthew  12510: 
                   12511: Inputs: 
                   12512: 
                   12513: =over 4
                   12514: 
1.957     raeburn  12515: =item B<$udom> Student's loncapa domain
1.286     matthew  12516: 
1.957     raeburn  12517: =item B<$uname> Student's loncapa login name
1.286     matthew  12518: 
1.964     bisitz   12519: =item B<$uid> Student/Employee ID
1.286     matthew  12520: 
1.957     raeburn  12521: =item B<$umode> Student's authentication mode
1.286     matthew  12522: 
1.957     raeburn  12523: =item B<$upass> Student's password
1.286     matthew  12524: 
1.957     raeburn  12525: =item B<$first> Student's first name
1.286     matthew  12526: 
1.957     raeburn  12527: =item B<$middle> Student's middle name
1.286     matthew  12528: 
1.957     raeburn  12529: =item B<$last> Student's last name
1.286     matthew  12530: 
1.957     raeburn  12531: =item B<$gene> Student's generation
1.286     matthew  12532: 
1.957     raeburn  12533: =item B<$usec> Student's section in course
1.286     matthew  12534: 
                   12535: =item B<$end> Unix time of the roles expiration
                   12536: 
                   12537: =item B<$start> Unix time of the roles start date
                   12538: 
                   12539: =item B<$forceid> If defined, allow $uid to be changed
                   12540: 
                   12541: =item B<$desiredhome> server to use as home server for student
                   12542: 
1.957     raeburn  12543: =item B<$email> Student's permanent e-mail address
                   12544: 
                   12545: =item B<$type> Type of enrollment (auto or manual)
                   12546: 
1.963     raeburn  12547: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto    
                   12548: 
                   12549: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957     raeburn  12550: 
1.963     raeburn  12551: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957     raeburn  12552: 
1.963     raeburn  12553: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957     raeburn  12554: 
1.963     raeburn  12555: =item B<$inststatus> institutional status of user - : separated string of escaped status types  
1.957     raeburn  12556: 
1.286     matthew  12557: =back
1.297     matthew  12558: 
                   12559: =item *
                   12560: 
                   12561: modify_student_enrollment
                   12562: 
                   12563: Change a students enrollment status in a class.  The environment variable
                   12564: 'role.request.course' must be defined for this function to proceed.
                   12565: 
                   12566: Inputs:
                   12567: 
                   12568: =over 4
                   12569: 
                   12570: =item $udom, students domain
                   12571: 
                   12572: =item $uname, students name
                   12573: 
                   12574: =item $uid, students user id
                   12575: 
                   12576: =item $first, students first name
                   12577: 
                   12578: =item $middle
                   12579: 
                   12580: =item $last
                   12581: 
                   12582: =item $gene
                   12583: 
                   12584: =item $usec
                   12585: 
                   12586: =item $end
                   12587: 
                   12588: =item $start
                   12589: 
1.957     raeburn  12590: =item $type
                   12591: 
                   12592: =item $locktype
                   12593: 
                   12594: =item $cid
                   12595: 
                   12596: =item $selfenroll
                   12597: 
                   12598: =item $context
                   12599: 
1.297     matthew  12600: =back
                   12601: 
1.191     harris41 12602: 
                   12603: =item *
                   12604: 
1.243     albertel 12605: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
                   12606: custom role; give a custom role to a user for the level given by URL.  Specify
                   12607: name and domain of role author, and role name
1.191     harris41 12608: 
                   12609: =item *
                   12610: 
1.243     albertel 12611: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191     harris41 12612: 
                   12613: =item *
                   12614: 
1.243     albertel 12615: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
                   12616: 
                   12617: =back
                   12618: 
                   12619: =head2 Course Infomation
                   12620: 
                   12621: =over 4
1.191     harris41 12622: 
                   12623: =item *
                   12624: 
1.1118    foxr     12625: coursedescription($courseid,$options) : returns a hash of information about the
1.631     albertel 12626: specified course id, including all environment settings for the
                   12627: course, the description of the course will be in the hash under the
                   12628: key 'description'
1.191     harris41 12629: 
1.1118    foxr     12630: $options is an optional parameter that if supplied is a hash reference that controls
                   12631: what how this function works.  It has the following key/values:
                   12632: 
                   12633: =over 4
                   12634: 
                   12635: =item freshen_cache
                   12636: 
                   12637: If defined, and the environment cache for the course is valid, it is 
                   12638: returned in the returned hash.
                   12639: 
                   12640: =item one_time
                   12641: 
                   12642: If defined, the last cache time is set to _now_
                   12643: 
                   12644: =item user
                   12645: 
                   12646: If defined, the supplied username is used instead of the current user.
                   12647: 
                   12648: 
                   12649: =back
                   12650: 
1.191     harris41 12651: =item *
                   12652: 
1.624     albertel 12653: resdata($name,$domain,$type,@which) : request for current parameter
                   12654: setting for a specific $type, where $type is either 'course' or 'user',
                   12655: @what should be a list of parameters to ask about. This routine caches
                   12656: answers for 5 minutes.
1.243     albertel 12657: 
1.877     foxr     12658: =item *
                   12659: 
                   12660: get_courseresdata($courseid, $domain) : dump the entire course resource
                   12661: data base, returning a hash that is keyed by the resource name and has
                   12662: values that are the resource value.  I believe that the timestamps and
                   12663: versions are also returned.
                   12664: 
1.243     albertel 12665: =back
                   12666: 
                   12667: =head2 Course Modification
                   12668: 
                   12669: =over 4
1.191     harris41 12670: 
                   12671: =item *
                   12672: 
1.243     albertel 12673: writecoursepref($courseid,%prefs) : write preferences (environment
                   12674: database) for a course
1.191     harris41 12675: 
                   12676: =item *
                   12677: 
1.1011    raeburn  12678: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
                   12679: 
                   12680: =item *
                   12681: 
1.1038    raeburn  12682: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243     albertel 12683: 
1.1167    droeschl 12684: =item *
                   12685: 
                   12686: is_course($courseid), is_course($cdom, $cnum)
                   12687: 
                   12688: Accepts either a combined $courseid (in the form of domain_courseid) or the
                   12689: two component version $cdom, $cnum. It checks if the specified course exists.
                   12690: 
                   12691: Returns:
                   12692:     undef if the course doesn't exist, otherwise
                   12693:     in scalar context the combined courseid.
                   12694:     in list context the two components of the course identifier, domain and 
                   12695:     courseid.    
                   12696: 
1.243     albertel 12697: =back
                   12698: 
                   12699: =head2 Resource Subroutines
                   12700: 
                   12701: =over 4
1.191     harris41 12702: 
                   12703: =item *
                   12704: 
1.243     albertel 12705: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191     harris41 12706: 
                   12707: =item *
                   12708: 
1.243     albertel 12709: repcopy($filename) : subscribes to the requested file, and attempts to
                   12710: replicate from the owning library server, Might return
1.607     raeburn  12711: 'unavailable', 'not_found', 'forbidden', 'ok', or
                   12712: 'bad_request', also attempts to grab the metadata for the
1.243     albertel 12713: resource. Expects the local filesystem pathname
                   12714: (/home/httpd/html/res/....)
                   12715: 
                   12716: =back
                   12717: 
                   12718: =head2 Resource Information
                   12719: 
                   12720: =over 4
1.191     harris41 12721: 
                   12722: =item *
                   12723: 
1.243     albertel 12724: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
                   12725: a vairety of different possible values, $varname should be a request
                   12726: string, and the other parameters can be used to specify who and what
                   12727: one is asking about.
                   12728: 
                   12729: Possible values for $varname are environment.lastname (or other item
                   12730: from the envirnment hash), user.name (or someother aspect about the
                   12731: user), resource.0.maxtries (or some other part and parameter of a
                   12732: resource)
1.204     albertel 12733: 
                   12734: =item *
                   12735: 
1.243     albertel 12736: directcondval($number) : get current value of a condition; reads from a state
                   12737: string
1.204     albertel 12738: 
                   12739: =item *
                   12740: 
1.243     albertel 12741: condval($condidx) : value of condition index based on state
1.204     albertel 12742: 
                   12743: =item *
                   12744: 
1.243     albertel 12745: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
                   12746: resource's metadata, $what should be either a specific key, or either
                   12747: 'keys' (to get a list of possible keys) or 'packages' to get a list of
                   12748: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
                   12749: 
                   12750: this function automatically caches all requests
1.191     harris41 12751: 
                   12752: =item *
                   12753: 
1.243     albertel 12754: metadata_query($query,$custom,$customshow) : make a metadata query against the
                   12755: network of library servers; returns file handle of where SQL and regex results
                   12756: will be stored for query
1.191     harris41 12757: 
                   12758: =item *
                   12759: 
1.243     albertel 12760: symbread($filename) : return symbolic list entry (filename argument optional);
                   12761: returns the data handle
1.191     harris41 12762: 
                   12763: =item *
                   12764: 
1.1190    raeburn  12765: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
                   12766: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582     albertel 12767: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190    raeburn  12768: on failure, user must be in a course, as it assumes the existence of
                   12769: the course initial hash, and uses $env('request.course.id'}.  The third
                   12770: arg is an optional reference to a scalar.  If this arg is passed in the 
                   12771: call to symbverify, it will be set to 1 if the symb has been set to be 
                   12772: encrypted; otherwise it will be null.  
1.191     harris41 12773: 
                   12774: =item *
                   12775: 
1.243     albertel 12776: symbclean($symb) : removes versions numbers from a symb, returns the
                   12777: cleaned symb
1.191     harris41 12778: 
                   12779: =item *
                   12780: 
1.243     albertel 12781: is_on_map($uri) : checks if the $uri is somewhere on the current
                   12782: course map, user must be in a course for it to work.
1.191     harris41 12783: 
                   12784: =item *
                   12785: 
1.243     albertel 12786: numval($salt) : return random seed value (addend for rndseed)
1.191     harris41 12787: 
                   12788: =item *
                   12789: 
1.243     albertel 12790: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
                   12791: a random seed, all arguments are optional, if they aren't sent it uses the
                   12792: environment to derive them. Note: if symb isn't sent and it can't get one
                   12793: from &symbread it will use the current time as its return value
1.191     harris41 12794: 
                   12795: =item *
                   12796: 
1.243     albertel 12797: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
                   12798: unfakeable, receipt
1.191     harris41 12799: 
                   12800: =item *
                   12801: 
1.620     albertel 12802: receipt() : API to ireceipt working off of env values; given out to users
1.191     harris41 12803: 
                   12804: =item *
                   12805: 
1.243     albertel 12806: countacc($url) : count the number of accesses to a given URL
1.191     harris41 12807: 
                   12808: =item *
                   12809: 
1.243     albertel 12810: 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 12811: 
                   12812: =item *
                   12813: 
1.243     albertel 12814: 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 12815: 
                   12816: =item *
                   12817: 
1.243     albertel 12818: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191     harris41 12819: 
                   12820: =item *
                   12821: 
1.243     albertel 12822: devalidate($symb) : devalidate temporary spreadsheet calculations,
                   12823: forcing spreadsheet to reevaluate the resource scores next time.
                   12824: 
1.1195    raeburn  12825: =item * 
                   12826: 
1.1196    raeburn  12827: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
                   12828: when viewing in course context.
1.1195    raeburn  12829: 
1.1196    raeburn  12830:  input: six args -- filename (decluttered), course number, course domain,
                   12831:                     url, symb (if registered) and group (if this is a 
                   12832:                     group item -- e.g., bulletin board, group page etc.).
1.1195    raeburn  12833: 
1.1196    raeburn  12834:  output: array of five scalars --
1.1195    raeburn  12835:          $cfile -- url for file editing if editable on current server
                   12836:          $home -- homeserver of resource (i.e., for author if published,
                   12837:                                           or course if uploaded.).
                   12838:          $switchserver --  1 if server switch will be needed.
1.1196    raeburn  12839:          $forceedit -- 1 if icon/link should be to go to edit mode 
                   12840:          $forceview -- 1 if icon/link should be to go to view mode
1.1195    raeburn  12841: 
                   12842: =item *
                   12843: 
                   12844: is_course_upload($file,$cnum,$cdom)
                   12845: 
                   12846: Used in course context to determine if current file was uploaded to 
                   12847: the course (i.e., would be found in /userfiles/docs on the course's 
                   12848: homeserver.
                   12849: 
                   12850:   input: 3 args -- filename (decluttered), course number and course domain.
                   12851:   output: boolean -- 1 if file was uploaded.
                   12852: 
1.243     albertel 12853: =back
                   12854: 
                   12855: =head2 Storing/Retreiving Data
                   12856: 
                   12857: =over 4
1.191     harris41 12858: 
                   12859: =item *
                   12860: 
1.243     albertel 12861: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
                   12862: for this url; hashref needs to be given and should be a \%hashname; the
                   12863: remaining args aren't required and if they aren't passed or are '' they will
1.620     albertel 12864: be derived from the env
1.191     harris41 12865: 
                   12866: =item *
                   12867: 
1.243     albertel 12868: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
                   12869: uses critical subroutine
1.191     harris41 12870: 
                   12871: =item *
                   12872: 
1.243     albertel 12873: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
                   12874: all args are optional
1.191     harris41 12875: 
                   12876: =item *
                   12877: 
1.717     albertel 12878: dumpstore($namespace,$udom,$uname,$regexp,$range) : 
                   12879: dumps the complete (or key matching regexp) namespace into a hash
                   12880: ($udom, $uname, $regexp, $range are optional) for a namespace that is
                   12881: normally &store()ed into
                   12882: 
                   12883: $range should be either an integer '100' (give me the first 100
                   12884:                                            matching records)
                   12885:               or be  two integers sperated by a - with no spaces
                   12886:                  '30-50' (give me the 30th through the 50th matching
                   12887:                           records)
                   12888: 
                   12889: 
                   12890: =item *
                   12891: 
                   12892: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
                   12893: replaces a &store() version of data with a replacement set of data
                   12894: for a particular resource in a namespace passed in the $storehash hash 
                   12895: reference
                   12896: 
                   12897: =item *
                   12898: 
1.243     albertel 12899: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
                   12900: works very similar to store/cstore, but all data is stored in a
                   12901: temporary location and can be reset using tmpreset, $storehash should
                   12902: be a hash reference, returns nothing on success
1.191     harris41 12903: 
                   12904: =item *
                   12905: 
1.243     albertel 12906: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
                   12907: similar to restore, but all data is stored in a temporary location and
                   12908: can be reset using tmpreset. Returns a hash of values on success,
                   12909: error string otherwise.
1.191     harris41 12910: 
                   12911: =item *
                   12912: 
1.243     albertel 12913: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
                   12914: deltes all keys for $symb form the temporary storage hash.
1.191     harris41 12915: 
                   12916: =item *
                   12917: 
1.243     albertel 12918: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   12919: reference filled in from namesp ($udom and $uname are optional)
1.191     harris41 12920: 
                   12921: =item *
                   12922: 
1.243     albertel 12923: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
                   12924: namesp ($udom and $uname are optional)
1.191     harris41 12925: 
                   12926: =item *
                   12927: 
1.702     albertel 12928: dump($namespace,$udom,$uname,$regexp,$range) : 
1.243     albertel 12929: dumps the complete (or key matching regexp) namespace into a hash
1.702     albertel 12930: ($udom, $uname, $regexp, $range are optional)
1.449     matthew  12931: 
1.702     albertel 12932: $range should be either an integer '100' (give me the first 100
                   12933:                                            matching records)
                   12934:               or be  two integers sperated by a - with no spaces
                   12935:                  '30-50' (give me the 30th through the 50th matching
                   12936:                           records)
1.449     matthew  12937: =item *
                   12938: 
                   12939: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
                   12940: $store can be a scalar, an array reference, or if the amount to be 
                   12941: incremented is > 1, a hash reference.
                   12942: 
                   12943: ($udom and $uname are optional)
1.191     harris41 12944: 
                   12945: =item *
                   12946: 
1.243     albertel 12947: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
                   12948: ($udom and $uname are optional)
1.191     harris41 12949: 
                   12950: =item *
                   12951: 
1.243     albertel 12952: cput($namespace,$storehash,$udom,$uname) : critical put
                   12953: ($udom and $uname are optional)
1.191     harris41 12954: 
                   12955: =item *
                   12956: 
1.748     albertel 12957: newput($namespace,$storehash,$udom,$uname) :
                   12958: 
                   12959: Attempts to store the items in the $storehash, but only if they don't
                   12960: currently exist, if this succeeds you can be certain that you have 
                   12961: successfully created a new key value pair in the $namespace db.
                   12962: 
                   12963: 
                   12964: Args:
                   12965:  $namespace: name of database to store values to
                   12966:  $storehash: hashref to store to the db
                   12967:  $udom: (optional) domain of user containing the db
                   12968:  $uname: (optional) name of user caontaining the db
                   12969: 
                   12970: Returns:
                   12971:  'ok' -> succeeded in storing all keys of $storehash
                   12972:  'key_exists: <key>' -> failed to anything out of $storehash, as at
                   12973:                         least <key> already existed in the db (other
                   12974:                         requested keys may also already exist)
1.967     bisitz   12975:  'error: <msg>' -> unable to tie the DB or other error occurred
1.748     albertel 12976:  'con_lost' -> unable to contact request server
                   12977:  'refused' -> action was not allowed by remote machine
                   12978: 
                   12979: 
                   12980: =item *
                   12981: 
1.243     albertel 12982: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   12983: reference filled in from namesp (encrypts the return communication)
                   12984: ($udom and $uname are optional)
1.191     harris41 12985: 
                   12986: =item *
                   12987: 
1.243     albertel 12988: log($udom,$name,$home,$message) : write to permanent log for user; use
                   12989: critical subroutine
                   12990: 
1.806     raeburn  12991: =item *
                   12992: 
1.860     raeburn  12993: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
                   12994: array reference filled in from namespace found in domain level on either
                   12995: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806     raeburn  12996: 
                   12997: =item *
                   12998: 
1.860     raeburn  12999: put_dom($namespace,$storehash,$udom,$uhome) :  stores hash in namespace at 
                   13000: domain level either on specified domain server ($uhome) or primary domain 
                   13001: server ($udom and $uhome are optional)
1.806     raeburn  13002: 
1.943     raeburn  13003: =item * 
                   13004: 
                   13005: get_domain_defaults($target_domain) : returns hash with defaults for
                   13006: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
                   13007: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
                   13008: or localauth), initial password or a kerberos realm, language (e.g., en-us).
                   13009: Values are retrieved from cache (if current), or from domain's configuration.db
                   13010: (if available), or lastly from values in lonTabs/dns_domain,tab, 
                   13011: or lonTabs/domain.tab. 
                   13012: 
                   13013: %domdefaults = &get_auth_defaults($target_domain);
                   13014: 
1.243     albertel 13015: =back
                   13016: 
                   13017: =head2 Network Status Functions
                   13018: 
                   13019: =over 4
1.191     harris41 13020: 
                   13021: =item *
                   13022: 
1.1137    raeburn  13023: dirlist() : return directory list based on URI (first arg).
                   13024: 
                   13025: Inputs: 1 required, 5 optional.
                   13026: 
                   13027: =over
                   13028: 
                   13029: =item 
                   13030: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
                   13031: 
                   13032: =item
                   13033: $userdomain - domain of user/course to be listed. Extracted from $uri if absent. 
                   13034: 
                   13035: =item
                   13036: $username -  username of user/course to be listed. Extracted from $uri if absent. 
                   13037: 
                   13038: =item
                   13039: $getpropath - boolean: 1 if prepend path using &propath(). 
                   13040: 
                   13041: =item
                   13042: $getuserdir - boolean: 1 if prepend path for "userfiles".
                   13043: 
                   13044: =item 
                   13045: $alternateRoot - path to prepend in place of path from $uri.
                   13046: 
                   13047: =back
                   13048: 
                   13049: Returns: Array of up to two items.
                   13050: 
                   13051: =over
                   13052: 
                   13053: a reference to an array of files/subdirectories
                   13054: 
                   13055: =over
                   13056: 
                   13057: Each element in the array of files/subdirectories is a & separated list of
                   13058: item name and the result of running stat on the item.  If dirlist was requested
                   13059: for a file instead of a directory, the item name will be ''. For a directory 
                   13060: listing, if the item is a metadata file, the element will end &N&M 
                   13061: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
                   13062: default copyright set (1).  
                   13063: 
                   13064: =back
                   13065: 
                   13066: a scalar containing error condition (if encountered).
                   13067: 
                   13068: =over
                   13069: 
                   13070: =item 
                   13071: no_host (no homeserver identified for $username:$domain).
                   13072: 
                   13073: =item 
                   13074: no_such_host (server contacted for listing not identified as valid host).
                   13075: 
                   13076: =item 
                   13077: con_lost (connection to remote server failed).
                   13078: 
                   13079: =item 
                   13080: refused (invalid $username:$domain received on lond side).
                   13081: 
                   13082: =item 
                   13083: no_such_dir (directory at specified path on lond side does not exist). 
                   13084: 
                   13085: =item 
                   13086: empty (directory at specified path on lond side is empty).
                   13087: 
                   13088: =over
                   13089: 
                   13090: This is currently not encountered because the &ls3, &ls2, 
                   13091: &ls (_handler) routines on the lond side do not filter out
                   13092: . and .. from a directory listing. 
                   13093: 
                   13094: =back
                   13095: 
                   13096: =back
                   13097: 
                   13098: =back
1.191     harris41 13099: 
                   13100: =item *
                   13101: 
1.243     albertel 13102: spareserver() : find server with least workload from spare.tab
                   13103: 
1.986     foxr     13104: 
                   13105: =item *
                   13106: 
                   13107: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
                   13108: if there is no corresponding loncapa host.
                   13109: 
1.243     albertel 13110: =back
                   13111: 
1.986     foxr     13112: 
1.243     albertel 13113: =head2 Apache Request
                   13114: 
                   13115: =over 4
1.191     harris41 13116: 
                   13117: =item *
                   13118: 
1.243     albertel 13119: ssi($url,%hash) : server side include, does a complete request cycle on url to
                   13120: localhost, posts hash
                   13121: 
                   13122: =back
                   13123: 
                   13124: =head2 Data to String to Data
                   13125: 
                   13126: =over 4
1.191     harris41 13127: 
                   13128: =item *
                   13129: 
1.243     albertel 13130: hash2str(%hash) : convert a hash into a string complete with escaping and '='
                   13131: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191     harris41 13132: 
                   13133: =item *
                   13134: 
1.243     albertel 13135: hashref2str($hashref) : convert a hashref into a string complete with
                   13136: escaping and '=' and '&' separators, supports elements that are
                   13137: arrayrefs and hashrefs
1.191     harris41 13138: 
                   13139: =item *
                   13140: 
1.243     albertel 13141: arrayref2str($arrayref) : convert an arrayref into a string complete
                   13142: with escaping and '&' separators, supports elements that are arrayrefs
                   13143: and hashrefs
1.191     harris41 13144: 
                   13145: =item *
                   13146: 
1.243     albertel 13147: str2hash($string) : convert string to hash using unescaping and
                   13148: splitting on '=' and '&', supports elements that are arrayrefs and
                   13149: hashrefs
1.191     harris41 13150: 
                   13151: =item *
                   13152: 
1.243     albertel 13153: str2array($string) : convert string to hash using unescaping and
                   13154: splitting on '&', supports elements that are arrayrefs and hashrefs
                   13155: 
                   13156: =back
                   13157: 
                   13158: =head2 Logging Routines
                   13159: 
                   13160: 
                   13161: These routines allow one to make log messages in the lonnet.log and
                   13162: lonnet.perm logfiles.
1.191     harris41 13163: 
1.1119    foxr     13164: =over 4
                   13165: 
1.191     harris41 13166: =item *
                   13167: 
1.243     albertel 13168: logtouch() : make sure the logfile, lonnet.log, exists
1.191     harris41 13169: 
                   13170: =item *
                   13171: 
1.243     albertel 13172: logthis() : append message to the normal lonnet.log file, it gets
                   13173: preiodically rolled over and deleted.
1.191     harris41 13174: 
                   13175: =item *
                   13176: 
1.243     albertel 13177: logperm() : append a permanent message to lonnet.perm.log, this log
                   13178: file never gets deleted by any automated portion of the system, only
                   13179: messages of critical importance should go in here.
                   13180: 
1.1119    foxr     13181: 
1.243     albertel 13182: =back
                   13183: 
                   13184: =head2 General File Helper Routines
                   13185: 
                   13186: =over 4
1.191     harris41 13187: 
                   13188: =item *
                   13189: 
1.481     raeburn  13190: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
                   13191: (a) files in /uploaded
                   13192:   (i) If a local copy of the file exists - 
                   13193:       compares modification date of local copy with last-modified date for 
                   13194:       definitive version stored on home server for course. If local copy is 
                   13195:       stale, requests a new version from the home server and stores it. 
                   13196:       If the original has been removed from the home server, then local copy 
                   13197:       is unlinked.
                   13198:   (ii) If local copy does not exist -
                   13199:       requests the file from the home server and stores it. 
                   13200:   
                   13201:   If $caller is 'uploadrep':  
                   13202:     This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
                   13203:     for request for files originally uploaded via DOCS. 
                   13204:      - returns 'ok' if fresh local copy now available, -1 otherwise.
                   13205:   
                   13206:   Otherwise:
                   13207:      This indicates a call from the content generation phase of the request.
                   13208:      -  returns the entire contents of the file or -1.
                   13209:      
                   13210: (b) files in /res
                   13211:    - returns the entire contents of a file or -1; 
                   13212:    it properly subscribes to and replicates the file if neccessary.
1.191     harris41 13213: 
1.712     albertel 13214: 
                   13215: =item *
                   13216: 
                   13217: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
                   13218:                   reference
                   13219: 
                   13220: returns either a stat() list of data about the file or an empty list
                   13221: if the file doesn't exist or couldn't find out about it (connection
                   13222: problems or user unknown)
                   13223: 
1.191     harris41 13224: =item *
                   13225: 
1.243     albertel 13226: filelocation($dir,$file) : returns file system location of a file
                   13227: based on URI; meant to be "fairly clean" absolute reference, $dir is a
                   13228: directory that relative $file lookups are to looked in ($dir of /a/dir
                   13229: and a file of ../bob will become /a/bob)
1.191     harris41 13230: 
                   13231: =item *
                   13232: 
                   13233: hreflocation($dir,$file) : returns file system location or a URL; same as
                   13234: filelocation except for hrefs
                   13235: 
                   13236: =item *
                   13237: 
                   13238: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
                   13239: 
1.243     albertel 13240: =back
                   13241: 
1.608     albertel 13242: =head2 Usererfile file routines (/uploaded*)
                   13243: 
                   13244: =over 4
                   13245: 
                   13246: =item *
                   13247: 
                   13248: userfileupload(): main rotine for putting a file in a user or course's
                   13249:                   filespace, arguments are,
                   13250: 
1.620     albertel 13251:  formname - required - this is the name of the element in $env where the
1.608     albertel 13252:            filename, and the contents of the file to create/modifed exist
1.620     albertel 13253:            the filename is in $env{'form.'.$formname.'.filename'} and the
                   13254:            contents of the file is located in $env{'form.'.$formname}
1.1090    raeburn  13255:  context - if coursedoc, store the file in the course of the active role
                   13256:              of the current user; 
                   13257:            if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
                   13258:            if 'canceloverwrite': delete file in tmp/overwrites directory
1.608     albertel 13259:  subdir - required - subdirectory to put the file in under ../userfiles/
                   13260:          if undefined, it will be placed in "unknown"
                   13261: 
                   13262:  (This routine calls clean_filename() to remove any dangerous
                   13263:  characters from the filename, and then calls finuserfileupload() to
                   13264:  complete the transaction)
                   13265: 
                   13266:  returns either the url of the uploaded file (/uploaded/....) if successful
                   13267:  and /adm/notfound.html if unsuccessful
                   13268: 
                   13269: =item *
                   13270: 
                   13271: clean_filename(): routine for cleaing a filename up for storage in
                   13272:                  userfile space, argument is:
                   13273: 
                   13274:  filename - proposed filename
                   13275: 
                   13276: returns: the new clean filename
                   13277: 
                   13278: =item *
                   13279: 
1.1090    raeburn  13280: finishuserfileupload(): routine that creates and sends the file to
1.608     albertel 13281: userspace, probably shouldn't be called directly
                   13282: 
                   13283:   docuname: username or courseid of destination for the file
                   13284:   docudom: domain of user/course of destination for the file
                   13285:   formname: same as for userfileupload()
1.1090    raeburn  13286:   fname: filename (including subdirectories) for the file
                   13287:   parser: if 'parse', will parse (html) file to extract references to objects, links etc.
                   13288:   allfiles: reference to hash used to store objects found by parser
                   13289:   codebase: reference to hash used for codebases of java objects found by parser
                   13290:   thumbwidth: width (pixels) of thumbnail to be created for uploaded image
                   13291:   thumbheight: height (pixels) of thumbnail to be created for uploaded image
                   13292:   resizewidth: width to be used to resize image using resizeImage from ImageMagick
                   13293:   resizeheight: height to be used to resize image using resizeImage from ImageMagick
                   13294:   context: if 'overwrite', will move the uploaded file from its temporary location to
                   13295:             userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095    raeburn  13296:   mimetype: reference to scalar to accommodate mime type determined
                   13297:             from File::MMagic if $parser = parse.
1.608     albertel 13298: 
                   13299:  returns either the url of the uploaded file (/uploaded/....) if successful
1.1090    raeburn  13300:  and /adm/notfound.html if unsuccessful (or an error message if context 
                   13301:  was 'overwrite').
                   13302:  
1.608     albertel 13303: 
                   13304: =item *
                   13305: 
                   13306: renameuserfile(): renames an existing userfile to a new name
                   13307: 
                   13308:   Args:
                   13309:    docuname: username or courseid of destination for the file
                   13310:    docudom: domain of user/course of destination for the file
                   13311:    old: current file name (including any subdirs under userfiles)
                   13312:    new: desired file name (including any subdirs under userfiles)
                   13313: 
                   13314: =item *
                   13315: 
                   13316: mkdiruserfile(): creates a directory is a userfiles dir
                   13317: 
                   13318:   Args:
                   13319:    docuname: username or courseid of destination for the file
                   13320:    docudom: domain of user/course of destination for the file
                   13321:    dir: dir to create (including any subdirs under userfiles)
                   13322: 
                   13323: =item *
                   13324: 
                   13325: removeuserfile(): removes a file that exists in userfiles
                   13326: 
                   13327:   Args:
                   13328:    docuname: username or courseid of destination for the file
                   13329:    docudom: domain of user/course of destination for the file
                   13330:    fname: filname to delete (including any subdirs under userfiles)
                   13331: 
                   13332: =item *
                   13333: 
                   13334: removeuploadedurl(): convience function for removeuserfile()
                   13335: 
                   13336:   Args:
                   13337:    url:  a full /uploaded/... url to delete
                   13338: 
1.747     albertel 13339: =item * 
                   13340: 
                   13341: get_portfile_permissions():
                   13342:   Args:
                   13343:     domain: domain of user or course contain the portfolio files
                   13344:     user: name of user or num of course contain the portfolio files
                   13345:   Returns:
                   13346:     hashref of a dump of the proper file_permissions.db
                   13347:    
                   13348: 
                   13349: =item * 
                   13350: 
                   13351: get_access_controls():
                   13352: 
                   13353: Args:
                   13354:   current_permissions: the hash ref returned from get_portfile_permissions()
                   13355:   group: (optional) the group you want the files associated with
                   13356:   file: (optional) the file you want access info on
                   13357: 
                   13358: Returns:
1.749     raeburn  13359:     a hash (keys are file names) of hashes containing
                   13360:         keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
                   13361:         values are XML containing access control settings (see below) 
1.747     albertel 13362: 
                   13363: Internal notes:
                   13364: 
1.749     raeburn  13365:  access controls are stored in file_permissions.db as key=value pairs.
                   13366:     key -> path to file/file_name\0uniqueID:scope_end_start
                   13367:         where scope -> public,guest,course,group,domains or users.
                   13368:               end -> UNIX time for end of access (0 -> no end date)
                   13369:               start -> UNIX time for start of access
                   13370: 
                   13371:     value -> XML description of access control
                   13372:            <scope type=""> (type =1 of: public,guest,course,group,domains,users">
                   13373:             <start></start>
                   13374:             <end></end>
                   13375: 
                   13376:             <password></password>  for scope type = guest
                   13377: 
                   13378:             <domain></domain>     for scope type = course or group
                   13379:             <number></number>
                   13380:             <roles id="">
                   13381:              <role></role>
                   13382:              <access></access>
                   13383:              <section></section>
                   13384:              <group></group>
                   13385:             </roles>
                   13386: 
                   13387:             <dom></dom>         for scope type = domains
                   13388: 
                   13389:             <users>             for scope type = users
                   13390:              <user>
                   13391:               <uname></uname>
                   13392:               <udom></udom>
                   13393:              </user>
                   13394:             </users>
                   13395:            </scope> 
                   13396:               
                   13397:  Access data is also aggregated for each file in an additional key=value pair:
                   13398:  key -> path to file/file_name\0accesscontrol 
                   13399:  value -> reference to hash
                   13400:           hash contains key = value pairs
                   13401:           where key = uniqueID:scope_end_start
                   13402:                 value = UNIX time record was last updated
                   13403: 
                   13404:           Used to improve speed of look-ups of access controls for each file.  
                   13405:  
                   13406:  Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
                   13407: 
1.1198    raeburn  13408: =item *
                   13409: 
1.749     raeburn  13410: modify_access_controls():
                   13411: 
                   13412: Modifies access controls for a portfolio file
                   13413: Args
                   13414: 1. file name
                   13415: 2. reference to hash of required changes,
                   13416: 3. domain
                   13417: 4. username
                   13418:   where domain,username are the domain of the portfolio owner 
                   13419:   (either a user or a course) 
                   13420: 
                   13421: Returns:
                   13422: 1. result of additions or updates ('ok' or 'error', with error message). 
                   13423: 2. result of deletions ('ok' or 'error', with error message).
                   13424: 3. reference to hash of any new or updated access controls.
                   13425: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
                   13426:    key = integer (inbound ID)
1.1198    raeburn  13427:    value = uniqueID
                   13428: 
                   13429: =item *
                   13430: 
                   13431: get_timebased_id():
                   13432: 
                   13433: Attempts to get a unique timestamp-based suffix for use with items added to a 
                   13434: course via the Course Editor (e.g., folders, composite pages, 
                   13435: group bulletin boards).
                   13436: 
                   13437: Args: (first three required; six others optional)
                   13438: 
                   13439: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
                   13440:    docssequence, or name of group
                   13441: 
                   13442: 2. keyid (alphanumeric): name of temporary locking key in hash,
                   13443:    e.g., num, boardids
                   13444: 
                   13445: 3. namespace: name of gdbm file used to store suffixes already assigned;  
                   13446:    file will be named nohist_namespace.db
                   13447: 
                   13448: 4. cdom: domain of course; default is current course domain from %env
                   13449: 
                   13450: 5. cnum: course number; default is current course number from %env
                   13451: 
                   13452: 6. idtype: set to concat if an additional digit is to be appended to the 
                   13453:    unix timestamp to form the suffix, if the plain timestamp is already
                   13454:    in use.  Default is to not do this, but simply increment the unix 
                   13455:    timestamp by 1 until a unique key is obtained.
                   13456: 
                   13457: 7. who: holder of locking key; defaults to user:domain for user.
                   13458: 
                   13459: 8. locktries: number of attempts to obtain a lock (sleep of 1s before 
                   13460:    retrying); default is 3.
                   13461: 
                   13462: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.  
                   13463: 
                   13464: Returns:
                   13465: 
                   13466: 1. suffix obtained (numeric)
                   13467: 
                   13468: 2. result of deleting locking key (ok if deleted, or lock never obtained)
                   13469: 
                   13470: 3. error: contains (localized) error message if an error occurred.
                   13471: 
1.747     albertel 13472: 
1.608     albertel 13473: =back
                   13474: 
1.243     albertel 13475: =head2 HTTP Helper Routines
                   13476: 
                   13477: =over 4
                   13478: 
1.191     harris41 13479: =item *
                   13480: 
                   13481: escape() : unpack non-word characters into CGI-compatible hex codes
                   13482: 
                   13483: =item *
                   13484: 
                   13485: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
                   13486: 
1.243     albertel 13487: =back
                   13488: 
                   13489: =head1 PRIVATE SUBROUTINES
                   13490: 
                   13491: =head2 Underlying communication routines (Shouldn't call)
                   13492: 
                   13493: =over 4
                   13494: 
                   13495: =item *
                   13496: 
                   13497: subreply() : tries to pass a message to lonc, returns con_lost if incapable
                   13498: 
                   13499: =item *
                   13500: 
                   13501: reply() : uses subreply to send a message to remote machine, logs all failures
                   13502: 
                   13503: =item *
                   13504: 
                   13505: critical() : passes a critical message to another server; if cannot
                   13506: get through then place message in connection buffer directory and
                   13507: returns con_delayed, if incapable of saving message, returns
                   13508: con_failed
                   13509: 
                   13510: =item *
                   13511: 
                   13512: reconlonc() : tries to reconnect lonc client processes.
                   13513: 
                   13514: =back
                   13515: 
                   13516: =head2 Resource Access Logging
                   13517: 
                   13518: =over 4
                   13519: 
                   13520: =item *
                   13521: 
                   13522: flushcourselogs() : flush (save) buffer logs and access logs
                   13523: 
                   13524: =item *
                   13525: 
                   13526: courselog($what) : save message for course in hash
                   13527: 
                   13528: =item *
                   13529: 
                   13530: courseacclog($what) : save message for course using &courselog().  Perform
                   13531: special processing for specific resource types (problems, exams, quizzes, etc).
                   13532: 
1.191     harris41 13533: =item *
                   13534: 
                   13535: goodbye() : flush course logs and log shutting down; it is called in srm.conf
                   13536: as a PerlChildExitHandler
1.243     albertel 13537: 
                   13538: =back
                   13539: 
                   13540: =head2 Other
                   13541: 
                   13542: =over 4
                   13543: 
                   13544: =item *
                   13545: 
                   13546: symblist($mapname,%newhash) : update symbolic storage links
1.191     harris41 13547: 
                   13548: =back
                   13549: 
                   13550: =cut
1.877     foxr     13551: 

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