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

1.1       albertel    1: # The LearningOnline Network
                      2: # TCP networking package
1.12      www         3: #
1.1367  ! raeburn     4: # $Id: lonnet.pm,v 1.1366 2018/01/03 04:21:02 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.486     www        74: use HTTP::Date;
1.977     amueller   75: use Image::Magick;
                     76: 
1.1182    foxr       77: 
1.1173    foxr       78: use Encode;
                     79: 
1.1245    raeburn    80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138    raeburn    81:             $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
                     82:             %managerstab);
1.871     albertel   83: 
                     84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
                     85:     %userrolehash, $processmarker, $dumpcount, %coursedombuf,
                     86:     %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958     www        87:     %courseownerbuf, %coursetypebuf,$locknum);
1.403     www        88: 
1.1       albertel   89: use IO::Socket;
1.31      www        90: use GDBM_File;
1.208     albertel   91: use HTML::LCParser;
1.88      www        92: use Fcntl qw(:flock);
1.870     albertel   93: use Storable qw(thaw nfreeze);
1.1289    damieng    94: use Time::HiRes qw( sleep gettimeofday tv_interval );
1.599     albertel   95: use Cache::Memcached;
1.676     albertel   96: use Digest::MD5;
1.790     albertel   97: use Math::Random;
1.1024    raeburn    98: use File::MMagic;
1.807     albertel   99: use LONCAPA qw(:DEFAULT :match);
1.740     www       100: use LONCAPA::Configuration;
1.1160    www       101: use LONCAPA::lonmetadata;
1.1167    droeschl  102: use LONCAPA::Lond;
1.1345    raeburn   103: use LONCAPA::LWPReq;
1.1117    foxr      104: 
1.1090    raeburn   105: use File::Copy;
1.676     albertel  106: 
1.195     www       107: my $readit;
1.1288    damieng   108: my $max_connection_retries = 20;     # 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") {	
1.1359    raeburn   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.1359    raeburn   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.1359    raeburn   174:     if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
1.448     albertel  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.1315    raeburn   232: sub get_servercerts_info {
                    233:     my ($lonhost,$context) = @_;
                    234:     my ($rep,$uselocal);
                    235:     if (grep { $_ eq $lonhost } &current_machine_ids()) {
                    236:         $uselocal = 1;
                    237:     }
1.1316    raeburn   238:     if (($context ne 'cgi') && ($uselocal)) {
1.1315    raeburn   239:         my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
1.1323    raeburn   240:         if ($distro eq '') {
                    241:             $uselocal = 0;
                    242:         } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
1.1315    raeburn   243:             if ($1 < 6) {
                    244:                 $uselocal = 0;
                    245:             }
1.1346    raeburn   246:         }  elsif ($distro =~ /^(?:sles)(\d+)$/) {
                    247:             if ($1 < 12) {
                    248:                 $uselocal = 0;
                    249:             }
1.1315    raeburn   250:         }
                    251:     }
                    252:     if ($uselocal) {
                    253:         $rep = LONCAPA::Lond::server_certs(\%perlvar);
                    254:     } else {
                    255:         $rep=&reply('servercerts',$lonhost);
                    256:     }
                    257:     my ($result,%returnhash);
                    258:     if (defined($lonhost)) {
                    259:         if (!defined(&hostname($lonhost))) {
                    260:             return;
                    261:         }
                    262:     }
                    263:     if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
                    264:         ($rep eq 'unknown_cmd')) {
                    265:         $result = $rep;
                    266:     } else {
                    267:         $result = 'ok';
                    268:         my @pairs=split(/\&/,$rep);
                    269:         foreach my $item (@pairs) {
                    270:             my ($key,$value)=split(/=/,$item,2);
                    271:             my $what = &unescape($key);
                    272:             $returnhash{$what}=&thaw_unescape($value);
                    273:         }
                    274:     }
                    275:     return ($result,\%returnhash);
                    276: }
                    277: 
1.993     raeburn   278: sub get_server_loncaparev {
1.1073    raeburn   279:     my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993     raeburn   280:     if (defined($lonhost)) {
                    281:         if (!defined(&hostname($lonhost))) {
                    282:             undef($lonhost);
                    283:         }
                    284:     }
                    285:     if (!defined($lonhost)) {
                    286:         if (defined(&domain($dom,'primary'))) {
                    287:             $lonhost=&domain($dom,'primary');
                    288:             if ($lonhost eq 'no_host') {
                    289:                 undef($lonhost);
                    290:             }
                    291:         }
                    292:     }
                    293:     if (defined($lonhost)) {
1.1073    raeburn   294:         my $cachetime = 12*3600;
                    295:         if (!$ignore_cache) {
                    296:             my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
                    297:             if (defined($cached)) {
                    298:                 return $loncaparev;
                    299:             }
                    300:         }
                    301:         my ($answer,$loncaparev);
                    302:         my @ids=&current_machine_ids();
                    303:         if (grep(/^\Q$lonhost\E$/,@ids)) {
                    304:             $answer = $perlvar{'lonVersion'};
1.1081    raeburn   305:             if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073    raeburn   306:                 $loncaparev = $1;
                    307:             }
                    308:         } else {
                    309:             $answer = &reply('serverloncaparev',$lonhost);
                    310:             if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
                    311:                 if ($caller eq 'loncron') {
                    312:                     my $protocol = $protocol{$lonhost};
                    313:                     $protocol = 'http' if ($protocol ne 'https');
                    314:                     my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
                    315:                     my $request=new HTTP::Request('GET',$url);
1.1345    raeburn   316:                     my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
1.1073    raeburn   317:                     unless ($response->is_error()) {
                    318:                         my $content = $response->content;
1.1081    raeburn   319:                         if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073    raeburn   320:                             $loncaparev = $1;
                    321:                         }
                    322:                     }
                    323:                 } else {
                    324:                     $loncaparev = $loncaparevs{$lonhost};
                    325:                 }
1.1081    raeburn   326:             } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073    raeburn   327:                 $loncaparev = $1;
                    328:             }
1.993     raeburn   329:         }
1.1073    raeburn   330:         return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993     raeburn   331:     }
                    332: }
                    333: 
1.1074    raeburn   334: sub get_server_homeID {
                    335:     my ($hostname,$ignore_cache,$caller) = @_;
                    336:     unless ($ignore_cache) {
                    337:         my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
                    338:         if (defined($cached)) {
                    339:             return $serverhomeID;
                    340:         }
                    341:     }
                    342:     my $cachetime = 12*3600;
                    343:     my $serverhomeID;
                    344:     if ($caller eq 'loncron') { 
                    345:         my @machine_ids = &machine_ids($hostname);
                    346:         foreach my $id (@machine_ids) {
                    347:             my $response = &reply('serverhomeID',$id);
                    348:             unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
                    349:                 $serverhomeID = $response;
                    350:                 last;
                    351:             }
                    352:         }
                    353:         if ($serverhomeID eq '') {
                    354:             $serverhomeID = $machine_ids[-1];
                    355:         }
                    356:     } else {
                    357:         $serverhomeID = $serverhomeIDs{$hostname};
                    358:     }
                    359:     return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
                    360: }
                    361: 
1.1121    raeburn   362: sub get_remote_globals {
                    363:     my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125    raeburn   364:     my ($result,%returnhash,%whatneeded);
                    365:     if (ref($whathash) eq 'HASH') {
1.1121    raeburn   366:         foreach my $what (sort(keys(%{$whathash}))) {
                    367:             my $hashid = $lonhost.'-'.$what;
1.1125    raeburn   368:             my ($response,$cached);
1.1121    raeburn   369:             unless ($ignore_cache) {
1.1125    raeburn   370:                 ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121    raeburn   371:             }
                    372:             if (defined($cached)) {
1.1125    raeburn   373:                 $returnhash{$what} = $response;
1.1121    raeburn   374:             } else {
1.1125    raeburn   375:                 $whatneeded{$what} = 1;
1.1121    raeburn   376:             }
                    377:         }
1.1125    raeburn   378:         if (keys(%whatneeded) == 0) {
                    379:             $result = 'ok';
                    380:         } else {
1.1121    raeburn   381:             my $requested = &freeze_escape(\%whatneeded);
                    382:             my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125    raeburn   383:             if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
                    384:                 ($rep eq 'unknown_cmd')) {
                    385:                 $result = $rep;
                    386:             } else {
                    387:                 $result = 'ok';
1.1121    raeburn   388:                 my @pairs=split(/\&/,$rep);
1.1125    raeburn   389:                 foreach my $item (@pairs) {
                    390:                     my ($key,$value)=split(/=/,$item,2);
                    391:                     my $what = &unescape($key);
                    392:                     my $hashid = $lonhost.'-'.$what;
                    393:                     $returnhash{$what}=&thaw_unescape($value);
                    394:                     &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121    raeburn   395:                 }
                    396:             }
                    397:         }
                    398:     }
1.1125    raeburn   399:     return ($result,\%returnhash);
1.1121    raeburn   400: }
                    401: 
1.1124    raeburn   402: sub remote_devalidate_cache {
1.1241    raeburn   403:     my ($lonhost,$cachekeys) = @_;
                    404:     my $items;
                    405:     return unless (ref($cachekeys) eq 'ARRAY');
                    406:     my $cachestr = join('&',@{$cachekeys});
                    407:     my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
1.1124    raeburn   408:     return $response;
                    409: }
                    410: 
1.1       albertel  411: # -------------------------------------------------- Non-critical communication
                    412: sub subreply {
                    413:     my ($cmd,$server)=@_;
1.838     albertel  414:     my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549     foxr      415:     #
                    416:     #  With loncnew process trimming, there's a timing hole between lonc server
                    417:     #  process exit and the master server picking up the listen on the AF_UNIX
                    418:     #  socket.  In that time interval, a lock file will exist:
                    419: 
                    420:     my $lockfile=$peerfile.".lock";
                    421:     while (-e $lockfile) {	# Need to wait for the lockfile to disappear.
1.1289    damieng   422: 	sleep(0.1);
1.549     foxr      423:     }
                    424:     # At this point, either a loncnew parent is listening or an old lonc
1.550     foxr      425:     # or loncnew child is listening so we can connect or everything's dead.
1.549     foxr      426:     #
1.550     foxr      427:     #   We'll give the connection a few tries before abandoning it.  If
                    428:     #   connection is not possible, we'll con_lost back to the client.
                    429:     #   
                    430:     my $client;
                    431:     for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
                    432: 	$client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                    433: 				      Type    => SOCK_STREAM,
                    434: 				      Timeout => 10);
1.869     albertel  435: 	if ($client) {
1.550     foxr      436: 	    last;		# Connected!
1.850     albertel  437: 	} else {
1.853     albertel  438: 	    &create_connection(&hostname($server),$server);
1.550     foxr      439: 	}
1.1289    damieng   440:         sleep(0.1);	# Try again later if failed connection.
1.550     foxr      441:     }
                    442:     my $answer;
                    443:     if ($client) {
1.704     albertel  444: 	print $client "sethost:$server:$cmd\n";
1.550     foxr      445: 	$answer=<$client>;
                    446: 	if (!$answer) { $answer="con_lost"; }
                    447: 	chomp($answer);
                    448:     } else {
                    449: 	$answer = 'con_lost';	# Failed connection.
                    450:     }
1.1       albertel  451:     return $answer;
                    452: }
                    453: 
                    454: sub reply {
                    455:     my ($cmd,$server)=@_;
1.838     albertel  456:     unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1       albertel  457:     my $answer=subreply($cmd,$server);
1.65      www       458:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672     albertel  459:        &logthis("<font color=\"blue\">WARNING:".
1.12      www       460:                 " $cmd to $server returned $answer</font>");
                    461:     }
1.1       albertel  462:     return $answer;
                    463: }
                    464: 
                    465: # ----------------------------------------------------------- Send USR1 to lonc
                    466: 
                    467: sub reconlonc {
1.891     albertel  468:     my ($lonid) = @_;
                    469:     if ($lonid) {
1.1295    raeburn   470:         my $hostname = &hostname($lonid);
1.891     albertel  471: 	my $peerfile="$perlvar{'lonSockDir'}/$hostname";
                    472: 	if ($hostname && -e $peerfile) {
                    473: 	    &logthis("Trying to reconnect lonc for $lonid ($hostname)");
                    474: 	    my $client=IO::Socket::UNIX->new(Peer    => $peerfile,
                    475: 					     Type    => SOCK_STREAM,
                    476: 					     Timeout => 10);
                    477: 	    if ($client) {
                    478: 		print $client ("reset_retries\n");
                    479: 		my $answer=<$client>;
                    480: 		#reset just this one.
                    481: 	    }
                    482: 	}
                    483: 	return;
                    484:     }
                    485: 
1.836     www       486:     &logthis("Trying to reconnect lonc");
1.1       albertel  487:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.1359    raeburn   488:     if (open(my $fh,"<",$loncfile)) {
1.1       albertel  489: 	my $loncpid=<$fh>;
                    490:         chomp($loncpid);
                    491:         if (kill 0 => $loncpid) {
                    492: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
                    493:             kill USR1 => $loncpid;
                    494:             sleep 1;
1.1295    raeburn   495:         } else {
1.12      www       496: 	    &logthis(
1.672     albertel  497:                "<font color=\"blue\">WARNING:".
1.12      www       498:                " lonc at pid $loncpid not responding, giving up</font>");
1.1       albertel  499:         }
                    500:     } else {
1.836     www       501: 	&logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1       albertel  502:     }
                    503: }
                    504: 
                    505: # ------------------------------------------------------ Critical communication
1.12      www       506: 
1.1       albertel  507: sub critical {
                    508:     my ($cmd,$server)=@_;
1.838     albertel  509:     unless (&hostname($server)) {
1.672     albertel  510:         &logthis("<font color=\"blue\">WARNING:".
1.89      www       511:                " Critical message to unknown server ($server)</font>");
                    512:         return 'no_such_host';
                    513:     }
1.1       albertel  514:     my $answer=reply($cmd,$server);
                    515:     if ($answer eq 'con_lost') {
1.1295    raeburn   516: 	&reconlonc($server);
1.589     albertel  517: 	my $answer=reply($cmd,$server);
1.1       albertel  518:         if ($answer eq 'con_lost') {
                    519:             my $now=time;
                    520:             my $middlename=$cmd;
1.5       www       521:             $middlename=substr($middlename,0,16);
1.1       albertel  522:             $middlename=~s/\W//g;
                    523:             my $dfilename=
1.305     www       524:       "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
                    525:             $dumpcount++;
1.1       albertel  526:             {
1.448     albertel  527: 		my $dfh;
1.1359    raeburn   528: 		if (open($dfh,">",$dfilename)) {
1.448     albertel  529: 		    print $dfh "$cmd\n"; 
                    530: 		    close($dfh);
                    531: 		}
1.1       albertel  532:             }
1.1288    damieng   533:             sleep 1;
1.1       albertel  534:             my $wcmd='';
                    535:             {
1.448     albertel  536: 		my $dfh;
1.1359    raeburn   537: 		if (open($dfh,"<",$dfilename)) {
1.448     albertel  538: 		    $wcmd=<$dfh>; 
                    539: 		    close($dfh);
                    540: 		}
1.1       albertel  541:             }
                    542:             chomp($wcmd);
1.7       www       543:             if ($wcmd eq $cmd) {
1.672     albertel  544: 		&logthis("<font color=\"blue\">WARNING: ".
1.12      www       545:                          "Connection buffer $dfilename: $cmd</font>");
1.1       albertel  546:                 &logperm("D:$server:$cmd");
                    547: 	        return 'con_delayed';
                    548:             } else {
1.672     albertel  549:                 &logthis("<font color=\"red\">CRITICAL:"
1.12      www       550:                         ." Critical connection failed: $server $cmd</font>");
1.1       albertel  551:                 &logperm("F:$server:$cmd");
                    552:                 return 'con_failed';
                    553:             }
                    554:         }
                    555:     }
                    556:     return $answer;
1.405     albertel  557: }
                    558: 
1.755     albertel  559: # ------------------------------------------- check if return value is an error
                    560: 
                    561: sub error {
                    562:     my ($result) = @_;
1.756     albertel  563:     if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755     albertel  564: 	if ($2 == 2) { return undef; }
                    565: 	return $1;
                    566:     }
                    567:     return undef;
                    568: }
                    569: 
1.783     albertel  570: sub convert_and_load_session_env {
                    571:     my ($lonidsdir,$handle)=@_;
                    572:     my @profile;
                    573:     {
1.917     albertel  574: 	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    575: 	if (!$opened) {
1.915     albertel  576: 	    return 0;
                    577: 	}
1.783     albertel  578: 	flock($idf,LOCK_SH);
                    579: 	@profile=<$idf>;
                    580: 	close($idf);
                    581:     }
                    582:     my %temp_env;
                    583:     foreach my $line (@profile) {
1.786     albertel  584: 	if ($line !~ m/=/) {
                    585: 	    return 0;
                    586: 	}
1.783     albertel  587: 	chomp($line);
                    588: 	my ($envname,$envvalue)=split(/=/,$line,2);
                    589: 	$temp_env{&unescape($envname)} = &unescape($envvalue);
                    590:     }
                    591:     unlink("$lonidsdir/$handle.id");
                    592:     if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
                    593: 	    0640)) {
                    594: 	%disk_env = %temp_env;
                    595: 	@env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
                    596: 	untie(%disk_env);
                    597:     }
1.786     albertel  598:     return 1;
1.783     albertel  599: }
                    600: 
1.374     www       601: # ------------------------------------------- Transfer profile into environment
1.780     albertel  602: my $env_loaded;
                    603: sub transfer_profile_to_env {
1.788     albertel  604:     my ($lonidsdir,$handle,$force_transfer) = @_;
                    605:     if (!$force_transfer && $env_loaded) { return; } 
1.374     www       606: 
1.720     albertel  607:     if (!defined($lonidsdir)) {
                    608: 	$lonidsdir = $perlvar{'lonIDsDir'};
                    609:     }
                    610:     if (!defined($handle)) {
                    611:         ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
                    612:     }
                    613: 
1.786     albertel  614:     my $convert;
                    615:     {
1.917     albertel  616:     	my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    617: 	if (!$opened) {
1.915     albertel  618: 	    return;
                    619: 	}
1.786     albertel  620: 	flock($idf,LOCK_SH);
                    621: 	if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    622: 		&GDBM_READER(),0640)) {
                    623: 	    @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
                    624: 	    untie(%disk_env);
                    625: 	} else {
                    626: 	    $convert = 1;
                    627: 	}
                    628:     }
                    629:     if ($convert) {
                    630: 	if (!&convert_and_load_session_env($lonidsdir,$handle)) {
                    631: 	    &logthis("Failed to load session, or convert session.");
                    632: 	}
1.374     www       633:     }
1.783     albertel  634: 
1.786     albertel  635:     my %remove;
1.783     albertel  636:     while ( my $envname = each(%env) ) {
1.433     matthew   637:         if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
                    638:             if ($time < time-300) {
1.783     albertel  639:                 $remove{$key}++;
1.433     matthew   640:             }
                    641:         }
                    642:     }
1.783     albertel  643: 
1.619     albertel  644:     $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780     albertel  645:     $env_loaded=1;
1.783     albertel  646:     foreach my $expired_key (keys(%remove)) {
1.433     matthew   647:         &delenv($expired_key);
1.374     www       648:     }
1.1       albertel  649: }
                    650: 
1.916     albertel  651: # ---------------------------------------------------- Check for valid session 
                    652: sub check_for_valid_session {
1.1355    raeburn   653:     my ($r,$name,$userhashref,$domref) = @_;
1.916     albertel  654:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1337    raeburn   655:     my ($linkname,$pubname);
1.1155    raeburn   656:     if ($name eq '') {
                    657:         $name = 'lonID';
1.1337    raeburn   658:         $linkname = 'lonLinkID';
                    659:         $pubname = 'lonPubID';
1.1155    raeburn   660:     }
                    661:     my $lonid=$cookies{$name};
1.1337    raeburn   662:     if (!$lonid) {
                    663:         if (($name eq 'lonID') && ($ENV{'SERVER_PORT'} != 443) && ($linkname)) {
                    664:             $lonid=$cookies{$linkname};
                    665:         }
                    666:         if (!$lonid) {
                    667:             if (($name eq 'lonID') && ($pubname)) {
                    668:                 $lonid=$cookies{$pubname};
                    669:             }
                    670:         }
                    671:     }
1.916     albertel  672:     return undef if (!$lonid);
                    673: 
                    674:     my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155    raeburn   675:     my $lonidsdir;
                    676:     if ($name eq 'lonDAV') {
                    677:         $lonidsdir=$r->dir_config('lonDAVsessDir');
                    678:     } else {
                    679:         $lonidsdir=$r->dir_config('lonIDsDir');
                    680:     }
1.1355    raeburn   681:     if (!-e "$lonidsdir/$handle.id") {
                    682:         if ((ref($domref)) && ($name eq 'lonID') && 
                    683:             ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
                    684:             my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
                    685:             if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
                    686:                 $$domref = $possudom;
                    687:             }
                    688:         }
                    689:         return undef;
                    690:     }
1.916     albertel  691: 
1.917     albertel  692:     my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
                    693:     return undef if (!$opened);
1.916     albertel  694: 
                    695:     flock($idf,LOCK_SH);
                    696:     my %disk_env;
                    697:     if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
                    698: 	    &GDBM_READER(),0640)) {
                    699: 	return undef;	
                    700:     }
                    701: 
                    702:     if (!defined($disk_env{'user.name'})
                    703: 	|| !defined($disk_env{'user.domain'})) {
                    704: 	return undef;
                    705:     }
1.1245    raeburn   706: 
                    707:     if (ref($userhashref) eq 'HASH') {
                    708:         $userhashref->{'name'} = $disk_env{'user.name'};
                    709:         $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1361    raeburn   710:         $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1212    raeburn   711:     }
1.1245    raeburn   712: 
1.916     albertel  713:     return $handle;
                    714: }
                    715: 
1.830     albertel  716: sub timed_flock {
                    717:     my ($file,$lock_type) = @_;
                    718:     my $failed=0;
                    719:     eval {
                    720: 	local $SIG{__DIE__}='DEFAULT';
                    721: 	local $SIG{ALRM}=sub {
                    722: 	    $failed=1;
                    723: 	    die("failed lock");
                    724: 	};
                    725: 	alarm(13);
                    726: 	flock($file,$lock_type);
                    727: 	alarm(0);
                    728:     };
                    729:     if ($failed) {
                    730: 	return undef;
                    731:     } else {
                    732: 	return 1;
                    733:     }
                    734: }
                    735: 
1.5       www       736: # ---------------------------------------------------------- Append Environment
                    737: 
                    738: sub appenv {
1.949     raeburn   739:     my ($newenv,$roles) = @_;
                    740:     if (ref($newenv) eq 'HASH') {
                    741:         foreach my $key (keys(%{$newenv})) {
                    742:             my $refused = 0;
                    743: 	    if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
                    744:                 $refused = 1;
                    745:                 if (ref($roles) eq 'ARRAY') {
1.1250    raeburn   746:                     my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949     raeburn   747:                     if (grep(/^\Q$role\E$/,@{$roles})) {
                    748:                         $refused = 0;
                    749:                     }
                    750:                 }
                    751:             }
                    752:             if ($refused) {
                    753:                 &logthis("<font color=\"blue\">WARNING: ".
                    754:                          "Attempt to modify environment ".$key." to ".$newenv->{$key}
                    755:                          .'</font>');
                    756: 	        delete($newenv->{$key});
                    757:             } else {
                    758:                 $env{$key}=$newenv->{$key};
                    759:             }
                    760:         }
                    761:         my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    762:         if ($opened
                    763: 	    && &timed_flock($env_file,LOCK_EX)
                    764: 	    &&
                    765: 	    tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    766: 	        (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
                    767: 	    while (my ($key,$value) = each(%{$newenv})) {
                    768: 	        $disk_env{$key} = $value;
                    769: 	    }
                    770: 	    untie(%disk_env);
1.35      www       771:         }
1.191     harris41  772:     }
1.56      www       773:     return 'ok';
                    774: }
                    775: # ----------------------------------------------------- Delete from Environment
                    776: 
                    777: sub delenv {
1.1104    raeburn   778:     my ($delthis,$regexp,$roles) = @_;
                    779:     if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
                    780:         my $refused = 1;
                    781:         if (ref($roles) eq 'ARRAY') {
                    782:             my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
                    783:             if (grep(/^\Q$role\E$/,@{$roles})) {
                    784:                 $refused = 0;
                    785:             }
                    786:         }
                    787:         if ($refused) {
                    788:             &logthis("<font color=\"blue\">WARNING: ".
                    789:                      "Attempt to delete from environment ".$delthis);
                    790:             return 'error';
                    791:         }
1.56      www       792:     }
1.917     albertel  793:     my $opened = open(my $env_file,'+<',$env{'user.environment'});
                    794:     if ($opened
1.915     albertel  795: 	&& &timed_flock($env_file,LOCK_EX)
1.830     albertel  796: 	&&
                    797: 	tie(my %disk_env,'GDBM_File',$env{'user.environment'},
                    798: 	    (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783     albertel  799: 	foreach my $key (keys(%disk_env)) {
1.987     raeburn   800: 	    if ($regexp) {
                    801:                 if ($key=~/^$delthis/) {
                    802:                     delete($env{$key});
                    803:                     delete($disk_env{$key});
                    804:                 } 
                    805:             } else {
                    806:                 if ($key=~/^\Q$delthis\E/) {
                    807: 		    delete($env{$key});
                    808: 		    delete($disk_env{$key});
                    809: 	        }
                    810:             }
1.448     albertel  811: 	}
1.783     albertel  812: 	untie(%disk_env);
1.5       www       813:     }
                    814:     return 'ok';
1.369     albertel  815: }
                    816: 
1.790     albertel  817: sub get_env_multiple {
                    818:     my ($name) = @_;
                    819:     my @values;
                    820:     if (defined($env{$name})) {
                    821:         # exists is it an array
                    822:         if (ref($env{$name})) {
                    823:             @values=@{ $env{$name} };
                    824:         } else {
                    825:             $values[0]=$env{$name};
                    826:         }
                    827:     }
                    828:     return(@values);
                    829: }
                    830: 
1.958     www       831: # ------------------------------------------------------------------- Locking
                    832: 
                    833: sub set_lock {
                    834:     my ($text)=@_;
                    835:     $locknum++;
                    836:     my $id=$$.'-'.$locknum;
                    837:     &appenv({'session.locks' => $env{'session.locks'}.','.$id,
                    838:              'session.lock.'.$id => $text});
                    839:     return $id;
                    840: }
                    841: 
                    842: sub get_locks {
                    843:     my $num=0;
                    844:     my %texts=();
                    845:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    846:        if ($lock=~/\w/) {
                    847:           $num++;
                    848:           $texts{$lock}=$env{'session.lock.'.$lock};
                    849:        }
                    850:    }
                    851:    return ($num,%texts);
                    852: }
                    853: 
                    854: sub remove_lock {
                    855:     my ($id)=@_;
                    856:     my $newlocks='';
                    857:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    858:        if (($lock=~/\w/) && ($lock ne $id)) {
                    859:           $newlocks.=','.$lock;
                    860:        }
                    861:     }
                    862:     &appenv({'session.locks' => $newlocks});
                    863:     &delenv('session.lock.'.$id);
                    864: }
                    865: 
                    866: sub remove_all_locks {
                    867:     my $activelocks=$env{'session.locks'};
                    868:     foreach my $lock (split(/\,/,$env{'session.locks'})) {
                    869:        if ($lock=~/\w/) {
                    870:           &remove_lock($lock);
                    871:        }
                    872:     }
                    873: }
                    874: 
                    875: 
1.369     albertel  876: # ------------------------------------------ Find out current server userload
                    877: sub userload {
                    878:     my $numusers=0;
                    879:     {
                    880: 	opendir(LONIDS,$perlvar{'lonIDsDir'});
                    881: 	my $filename;
                    882: 	my $curtime=time;
                    883: 	while ($filename=readdir(LONIDS)) {
1.925     albertel  884: 	    next if ($filename eq '.' || $filename eq '..');
                    885: 	    next if ($filename =~ /publicuser_\d+\.id/);
1.404     albertel  886: 	    my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437     albertel  887: 	    if ($curtime-$mtime < 1800) { $numusers++; }
1.369     albertel  888: 	}
                    889: 	closedir(LONIDS);
                    890:     }
                    891:     my $userloadpercent=0;
                    892:     my $maxuserload=$perlvar{'lonUserLoadLim'};
                    893:     if ($maxuserload) {
1.371     albertel  894: 	$userloadpercent=100*$numusers/$maxuserload;
1.369     albertel  895:     }
1.372     albertel  896:     $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369     albertel  897:     return $userloadpercent;
1.283     www       898: }
                    899: 
1.1       albertel  900: # ------------------------------ Find server with least workload from spare.tab
1.11      www       901: 
1.1       albertel  902: sub spareserver {
1.1083    raeburn   903:     my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784     albertel  904:     my $spare_server;
1.370     albertel  905:     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784     albertel  906:     my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 
                    907:                                                      :  $userloadpercent;
1.1083    raeburn   908:     my ($uint_dom,$remotesessions);
                    909:     if (($udom ne '') && (&domain($udom) ne '')) {
                    910:         my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                    911:         $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
                    912:         my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
                    913:         $remotesessions = $udomdefaults{'remotesessions'};
                    914:     }
1.1123    raeburn   915:     my $spareshash = &this_host_spares($udom);
                    916:     if (ref($spareshash) eq 'HASH') {
                    917:         if (ref($spareshash->{'primary'}) eq 'ARRAY') {
                    918:             foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279    raeburn   919:                 next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
                    920:                                              $try_server));
1.1123    raeburn   921: 	        ($spare_server, $lowest_load) =
                    922: 	            &compare_server_load($try_server, $spare_server, $lowest_load);
                    923:             }
1.1083    raeburn   924:         }
1.784     albertel  925: 
1.1123    raeburn   926:         my $found_server = ($spare_server ne '' && $lowest_load < 100);
                    927: 
                    928:         if (!$found_server) {
                    929:             if (ref($spareshash->{'default'}) eq 'ARRAY') { 
                    930: 	        foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279    raeburn   931:                     next unless (&spare_can_host($udom,$uint_dom,
                    932:                                                  $remotesessions,$try_server));
1.1123    raeburn   933: 	            ($spare_server, $lowest_load) =
                    934: 		        &compare_server_load($try_server, $spare_server, $lowest_load);
                    935:                 }
                    936: 	    }
                    937:         }
1.784     albertel  938:     }
                    939: 
                    940:     if (!$want_server_name) {
1.968     raeburn   941:         my $protocol = 'http';
                    942:         if ($protocol{$spare_server} eq 'https') {
                    943:             $protocol = $protocol{$spare_server};
                    944:         }
1.1001    raeburn   945:         if (defined($spare_server)) {
                    946:             my $hostname = &hostname($spare_server);
1.1083    raeburn   947:             if (defined($hostname)) {
1.1001    raeburn   948: 	        $spare_server = $protocol.'://'.$hostname;
                    949:             }
                    950:         }
1.784     albertel  951:     }
                    952:     return $spare_server;
                    953: }
                    954: 
                    955: sub compare_server_load {
1.1253    raeburn   956:     my ($try_server, $spare_server, $lowest_load, $required) = @_;
                    957: 
                    958:     if ($required) {
                    959:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                    960:         my $remoterev = &get_server_loncaparev(undef,$try_server);
                    961:         my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                    962:         if (($major eq '' && $minor eq '') ||
                    963:             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                    964:             return ($spare_server,$lowest_load);
                    965:         }
                    966:     }
1.784     albertel  967: 
                    968:     my $loadans     = &reply('load',    $try_server);
                    969:     my $userloadans = &reply('userload',$try_server);
                    970: 
                    971:     if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114    raeburn   972: 	return ($spare_server, $lowest_load); #didn't get a number from the server
1.784     albertel  973:     }
                    974: 
                    975:     my $load;
                    976:     if ($loadans =~ /\d/) {
                    977: 	if ($userloadans =~ /\d/) {
                    978: 	    #both are numbers, pick the bigger one
                    979: 	    $load = ($loadans > $userloadans) ? $loadans 
                    980: 		                              : $userloadans;
1.411     albertel  981: 	} else {
1.784     albertel  982: 	    $load = $loadans;
1.411     albertel  983: 	}
1.784     albertel  984:     } else {
                    985: 	$load = $userloadans;
                    986:     }
                    987: 
                    988:     if (($load =~ /\d/) && ($load < $lowest_load)) {
                    989: 	$spare_server = $try_server;
                    990: 	$lowest_load  = $load;
1.370     albertel  991:     }
1.784     albertel  992:     return ($spare_server,$lowest_load);
1.202     matthew   993: }
1.914     albertel  994: 
                    995: # --------------------------- ask offload servers if user already has a session
                    996: sub find_existing_session {
                    997:     my ($udom,$uname) = @_;
1.1123    raeburn   998:     my $spareshash = &this_host_spares($udom);
                    999:     if (ref($spareshash) eq 'HASH') {
                   1000:         if (ref($spareshash->{'primary'}) eq 'ARRAY') {
                   1001:             foreach my $try_server (@{ $spareshash->{'primary'} }) {
                   1002:                 return $try_server if (&has_user_session($try_server, $udom, $uname));
                   1003:             }
                   1004:         }
                   1005:         if (ref($spareshash->{'default'}) eq 'ARRAY') {
                   1006:             foreach my $try_server (@{ $spareshash->{'default'} }) {
                   1007:                 return $try_server if (&has_user_session($try_server, $udom, $uname));
                   1008:             }
                   1009:         }
1.914     albertel 1010:     }
                   1011:     return;
                   1012: }
                   1013: 
                   1014: # -------------------------------- ask if server already has a session for user
                   1015: sub has_user_session {
                   1016:     my ($lonid,$udom,$uname) = @_;
                   1017:     my $result = &reply(join(':','userhassession',
                   1018: 			     map {&escape($_)} ($udom,$uname)),$lonid);
                   1019:     return 1 if ($result eq 'ok');
                   1020: 
                   1021:     return 0;
                   1022: }
                   1023: 
1.1076    raeburn  1024: # --------- determine least loaded server in a user's domain which allows login
                   1025: 
                   1026: sub choose_server {
1.1259    raeburn  1027:     my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076    raeburn  1028:     my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077    raeburn  1029:     my %servers = &get_servers($udom);
1.1076    raeburn  1030:     my $lowest_load = 30000;
1.1259    raeburn  1031:     my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
                   1032:     if ($skiploadbal) {
                   1033:         ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
                   1034:         unless (defined($cached)) {
                   1035:             my $cachetime = 60*60*24;
                   1036:             my %domconfig =
                   1037:                 &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
                   1038:             if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
                   1039:                 $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
                   1040:                                            $cachetime);
                   1041:             }
                   1042:         }
                   1043:     }
1.1076    raeburn  1044:     foreach my $lonhost (keys(%servers)) {
1.1259    raeburn  1045:         if ($skiploadbal) {
                   1046:             if (ref($balancers) eq 'HASH') {
                   1047:                 next if (exists($balancers->{$lonhost}));
                   1048:             }
                   1049:         }   
1.1115    raeburn  1050:         my $loginvia;
                   1051:         if ($checkloginvia) {
                   1052:             $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116    raeburn  1053:             if ($loginvia) {
                   1054:                 my ($server,$path) = split(/:/,$loginvia);
                   1055:                 ($login_host, $lowest_load) =
1.1253    raeburn  1056:                     &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116    raeburn  1057:                 if ($login_host eq $server) {
                   1058:                     $portal_path = $path;
1.1151    raeburn  1059:                     $isredirect = 1;
1.1116    raeburn  1060:                 }
                   1061:             } else {
                   1062:                 ($login_host, $lowest_load) =
1.1253    raeburn  1063:                     &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116    raeburn  1064:                 if ($login_host eq $lonhost) {
                   1065:                     $portal_path = '';
1.1151    raeburn  1066:                     $isredirect = ''; 
1.1116    raeburn  1067:                 }
                   1068:             }
                   1069:         } else {
1.1076    raeburn  1070:             ($login_host, $lowest_load) =
1.1253    raeburn  1071:                 &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076    raeburn  1072:         }
                   1073:     }
                   1074:     if ($login_host ne '') {
1.1116    raeburn  1075:         $hostname = &hostname($login_host);
1.1076    raeburn  1076:     }
1.1331    raeburn  1077:     return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076    raeburn  1078: }
                   1079: 
1.202     matthew  1080: # --------------------------------------------- Try to change a user's password
                   1081: 
                   1082: sub changepass {
1.799     raeburn  1083:     my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202     matthew  1084:     $currentpass = &escape($currentpass);
                   1085:     $newpass     = &escape($newpass);
1.1030    raeburn  1086:     my $lonhost = $perlvar{'lonHostID'};
                   1087:     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202     matthew  1088: 		       $server);
                   1089:     if (! $answer) {
                   1090: 	&logthis("No reply on password change request to $server ".
                   1091: 		 "by $uname in domain $udom.");
                   1092:     } elsif ($answer =~ "^ok") {
                   1093:         &logthis("$uname in $udom successfully changed their password ".
                   1094: 		 "on $server.");
                   1095:     } elsif ($answer =~ "^pwchange_failure") {
                   1096: 	&logthis("$uname in $udom was unable to change their password ".
                   1097: 		 "on $server.  The action was blocked by either lcpasswd ".
                   1098: 		 "or pwchange");
                   1099:     } elsif ($answer =~ "^non_authorized") {
                   1100:         &logthis("$uname in $udom did not get their password correct when ".
                   1101: 		 "attempting to change it on $server.");
                   1102:     } elsif ($answer =~ "^auth_mode_error") {
                   1103:         &logthis("$uname in $udom attempted to change their password despite ".
                   1104: 		 "not being locally or internally authenticated on $server.");
                   1105:     } elsif ($answer =~ "^unknown_user") {
                   1106:         &logthis("$uname in $udom attempted to change their password ".
                   1107: 		 "on $server but were unable to because $server is not ".
                   1108: 		 "their home server.");
                   1109:     } elsif ($answer =~ "^refused") {
                   1110: 	&logthis("$server refused to change $uname in $udom password because ".
                   1111: 		 "it was sent an unencrypted request to change the password.");
1.1030    raeburn  1112:     } elsif ($answer =~ "invalid_client") {
                   1113:         &logthis("$server refused to change $uname in $udom password because ".
                   1114:                  "it was a reset by e-mail originating from an invalid server.");
1.202     matthew  1115:     }
                   1116:     return $answer;
1.1       albertel 1117: }
                   1118: 
1.169     harris41 1119: # ----------------------- Try to determine user's current authentication scheme
                   1120: 
                   1121: sub queryauthenticate {
                   1122:     my ($uname,$udom)=@_;
1.456     albertel 1123:     my $uhome=&homeserver($uname,$udom);
                   1124:     if (!$uhome) {
                   1125: 	&logthis("User $uname at $udom is unknown when looking for authentication mechanism");
                   1126: 	return 'no_host';
                   1127:     }
                   1128:     my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
                   1129:     if ($answer =~ /^(unknown_user|refused|con_lost)/) {
                   1130: 	&logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169     harris41 1131:     }
1.456     albertel 1132:     return $answer;
1.169     harris41 1133: }
                   1134: 
1.1       albertel 1135: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11      www      1136: 
1.1       albertel 1137: sub authenticate {
1.1073    raeburn  1138:     my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807     albertel 1139:     $upass=&escape($upass);
                   1140:     $uname= &LONCAPA::clean_username($uname);
1.836     www      1141:     my $uhome=&homeserver($uname,$udom,1);
1.952     raeburn  1142:     my $newhome;
1.836     www      1143:     if ((!$uhome) || ($uhome eq 'no_host')) {
                   1144: # Maybe the machine was offline and only re-appeared again recently?
                   1145:         &reconlonc();
                   1146: # One more
1.952     raeburn  1147: 	$uhome=&homeserver($uname,$udom,1);
                   1148:         if (($uhome eq 'no_host') && $checkdefauth) {
                   1149:             if (defined(&domain($udom,'primary'))) {
                   1150:                 $newhome=&domain($udom,'primary');
                   1151:             }
                   1152:             if ($newhome ne '') {
                   1153:                 $uhome = $newhome;
                   1154:             }
                   1155:         }
1.836     www      1156: 	if ((!$uhome) || ($uhome eq 'no_host')) {
                   1157: 	    &logthis("User $uname at $udom is unknown in authenticate");
1.952     raeburn  1158: 	    return 'no_host';
                   1159:         }
1.1       albertel 1160:     }
1.1073    raeburn  1161:     my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471     albertel 1162:     if ($answer eq 'authorized') {
1.952     raeburn  1163:         if ($newhome) {
                   1164:             &logthis("User $uname at $udom authorized by $uhome, but needs account");
                   1165:             return 'no_account_on_host'; 
                   1166:         } else {
                   1167:             &logthis("User $uname at $udom authorized by $uhome");
                   1168:             return $uhome;
                   1169:         }
1.471     albertel 1170:     }
                   1171:     if ($answer eq 'non_authorized') {
                   1172: 	&logthis("User $uname at $udom rejected by $uhome");
                   1173: 	return 'no_host'; 
1.9       www      1174:     }
1.471     albertel 1175:     &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1       albertel 1176:     return 'no_host';
                   1177: }
                   1178: 
1.1073    raeburn  1179: sub can_host_session {
1.1074    raeburn  1180:     my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073    raeburn  1181:     my $canhost = 1;
1.1074    raeburn  1182:     my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073    raeburn  1183:     if (ref($remotesessions) eq 'HASH') {
                   1184:         if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074    raeburn  1185:             if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073    raeburn  1186:                 $canhost = 0;
                   1187:             } else {
                   1188:                 $canhost = 1;
                   1189:             }
                   1190:         }
                   1191:         if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074    raeburn  1192:             if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073    raeburn  1193:                 $canhost = 1;
                   1194:             } else {
                   1195:                 $canhost = 0;
                   1196:             }
                   1197:         }
                   1198:         if ($canhost) {
                   1199:             if ($remotesessions->{'version'} ne '') {
                   1200:                 my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
                   1201:                 if ($reqmajor ne '' && $reqminor ne '') {
                   1202:                     if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
                   1203:                         my $major = $1;
                   1204:                         my $minor = $2;
                   1205:                         if (($major < $reqmajor ) ||
                   1206:                             (($major == $reqmajor) && ($minor < $reqminor))) {
                   1207:                             $canhost = 0;
                   1208:                         }
                   1209:                     } else {
                   1210:                         $canhost = 0;
                   1211:                     }
                   1212:                 }
                   1213:             }
                   1214:         }
                   1215:     }
                   1216:     if ($canhost) {
                   1217:         if (ref($hostedsessions) eq 'HASH') {
1.1120    raeburn  1218:             my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                   1219:             my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073    raeburn  1220:             if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120    raeburn  1221:                 if (($uint_dom ne '') && 
                   1222:                     (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073    raeburn  1223:                     $canhost = 0;
                   1224:                 } else {
                   1225:                     $canhost = 1;
                   1226:                 }
                   1227:             }
                   1228:             if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120    raeburn  1229:                 if (($uint_dom ne '') && 
                   1230:                     (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073    raeburn  1231:                     $canhost = 1;
                   1232:                 } else {
                   1233:                     $canhost = 0;
                   1234:                 }
                   1235:             }
                   1236:         }
                   1237:     }
                   1238:     return $canhost;
                   1239: }
                   1240: 
1.1083    raeburn  1241: sub spare_can_host {
                   1242:     my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
                   1243:     my $canhost=1;
1.1279    raeburn  1244:     my $try_server_hostname = &hostname($try_server);
                   1245:     my $serverhomeID = &get_server_homeID($try_server_hostname);
                   1246:     my $serverhomedom = &host_domain($serverhomeID);
                   1247:     my %defdomdefaults = &get_domain_defaults($serverhomedom);
                   1248:     if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
                   1249:         if ($defdomdefaults{'offloadnow'}{$try_server}) {
                   1250:             $canhost = 0;
                   1251:         }
                   1252:     }
                   1253:     if (($canhost) && ($uint_dom)) {
                   1254:         my @intdoms;
                   1255:         my $internet_names = &get_internet_names($try_server);
                   1256:         if (ref($internet_names) eq 'ARRAY') {
                   1257:             @intdoms = @{$internet_names};
                   1258:         }
                   1259:         unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
                   1260:             my $remoterev = &get_server_loncaparev(undef,$try_server);
                   1261:             $canhost = &can_host_session($udom,$try_server,$remoterev,
                   1262:                                          $remotesessions,
                   1263:                                          $defdomdefaults{'hostedsessions'});
                   1264:         }
1.1083    raeburn  1265:     }
                   1266:     return $canhost;
                   1267: }
                   1268: 
1.1123    raeburn  1269: sub this_host_spares {
                   1270:     my ($dom) = @_;
1.1126    raeburn  1271:     my ($dom_in_use,$lonhost_in_use,$result);
1.1123    raeburn  1272:     my @hosts = &current_machine_ids();
                   1273:     foreach my $lonhost (@hosts) {
                   1274:         if (&host_domain($lonhost) eq $dom) {
1.1126    raeburn  1275:             $dom_in_use = $dom;
                   1276:             $lonhost_in_use = $lonhost;
1.1123    raeburn  1277:             last;
                   1278:         }
                   1279:     }
1.1126    raeburn  1280:     if ($dom_in_use ne '') {
                   1281:         $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
                   1282:     }
                   1283:     if (ref($result) ne 'HASH') {
                   1284:         $lonhost_in_use = $perlvar{'lonHostID'};
                   1285:         $dom_in_use = &host_domain($lonhost_in_use);
                   1286:         $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
                   1287:         if (ref($result) ne 'HASH') {
                   1288:             $result = \%spareid;
                   1289:         }
                   1290:     }
                   1291:     return $result;
                   1292: }
                   1293: 
                   1294: sub spares_for_offload  {
                   1295:     my ($dom_in_use,$lonhost_in_use) = @_;
                   1296:     my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123    raeburn  1297:     if (defined($cached)) {
                   1298:         return $result;
                   1299:     } else {
1.1126    raeburn  1300:         my $cachetime = 60*60*24;
                   1301:         my %domconfig =
                   1302:             &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
                   1303:         if (ref($domconfig{'usersessions'}) eq 'HASH') {
                   1304:             if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
                   1305:                 if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
                   1306:                     return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123    raeburn  1307:                 }
                   1308:             }
                   1309:         }
                   1310:     }
1.1126    raeburn  1311:     return;
1.1123    raeburn  1312: }
                   1313: 
1.1129    raeburn  1314: sub get_lonbalancer_config {
                   1315:     my ($servers) = @_;
                   1316:     my ($currbalancer,$currtargets);
                   1317:     if (ref($servers) eq 'HASH') {
                   1318:         foreach my $server (keys(%{$servers})) {
                   1319:             my %what = (
                   1320:                          spareid => 1,
                   1321:                          perlvar => 1,
                   1322:                        );
                   1323:             my ($result,$returnhash) = &get_remote_globals($server,\%what);
                   1324:             if ($result eq 'ok') {
                   1325:                 if (ref($returnhash) eq 'HASH') {
                   1326:                     if (ref($returnhash->{'perlvar'}) eq 'HASH') {
                   1327:                         if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
                   1328:                             $currbalancer = $server;
                   1329:                             $currtargets = {};
                   1330:                             if (ref($returnhash->{'spareid'}) eq 'HASH') {
                   1331:                                 if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
                   1332:                                     $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
                   1333:                                 }
                   1334:                                 if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
                   1335:                                     $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
                   1336:                                 }
                   1337:                             }
                   1338:                             last;
                   1339:                         }
                   1340:                     }
                   1341:                 }
                   1342:             }
                   1343:         }
                   1344:     }
                   1345:     return ($currbalancer,$currtargets);
                   1346: }
                   1347: 
                   1348: sub check_loadbalancing {
1.1331    raeburn  1349:     my ($uname,$udom,$caller) = @_;
1.1191    raeburn  1350:     my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
                   1351:         $rule_in_effect,$offloadto,$otherserver);
1.1129    raeburn  1352:     my $lonhost = $perlvar{'lonHostID'};
1.1175    raeburn  1353:     my @hosts = &current_machine_ids();
1.1129    raeburn  1354:     my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                   1355:     my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
                   1356:     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   1357:     my $serverhomedom = &host_domain($lonhost);
1.1307    raeburn  1358:     my $domneedscache;
1.1129    raeburn  1359:     my $cachetime = 60*60*24;
                   1360: 
                   1361:     if (($uintdom ne '') && ($uintdom eq $intdom)) {
                   1362:         $dom_in_use = $udom;
                   1363:         $homeintdom = 1;
                   1364:     } else {
                   1365:         $dom_in_use = $serverhomedom;
                   1366:     }
                   1367:     my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
                   1368:     unless (defined($cached)) {
                   1369:         my %domconfig =
                   1370:             &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
                   1371:         if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130    raeburn  1372:             $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307    raeburn  1373:         } else {
                   1374:             $domneedscache = $dom_in_use;
1.1129    raeburn  1375:         }
                   1376:     }
                   1377:     if (ref($result) eq 'HASH') {
1.1191    raeburn  1378:         ($is_balancer,$currtargets,$currrules) = 
                   1379:             &check_balancer_result($result,@hosts);
1.1129    raeburn  1380:         if ($is_balancer) {
                   1381:             if (ref($currrules) eq 'HASH') {
                   1382:                 if ($homeintdom) {
                   1383:                     if ($uname ne '') {
                   1384:                         if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
                   1385:                             my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
                   1386:                             if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
                   1387:                                 $rule_in_effect = $currrules->{'_LC_author'};
                   1388:                             } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
                   1389:                                 $rule_in_effect = $currrules->{'_LC_adv'}
                   1390:                             }
                   1391:                         }
                   1392:                         if ($rule_in_effect eq '') {
                   1393:                             my %userenv = &userenvironment($udom,$uname,'inststatus');
                   1394:                             if ($userenv{'inststatus'} ne '') {
                   1395:                                 my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
                   1396:                                 my ($othertitle,$usertypes,$types) =
                   1397:                                     &Apache::loncommon::sorted_inst_types($udom);
                   1398:                                 if (ref($types) eq 'ARRAY') {
                   1399:                                     foreach my $type (@{$types}) {
                   1400:                                         if (grep(/^\Q$type\E$/,@statuses)) {
                   1401:                                             if (exists($currrules->{$type})) {
                   1402:                                                 $rule_in_effect = $currrules->{$type};
                   1403:                                             }
                   1404:                                         }
                   1405:                                     }
                   1406:                                 }
                   1407:                             } else {
                   1408:                                 if (exists($currrules->{'default'})) {
                   1409:                                     $rule_in_effect = $currrules->{'default'};
                   1410:                                 }
                   1411:                             }
                   1412:                         }
                   1413:                     } else {
                   1414:                         if (exists($currrules->{'default'})) {
                   1415:                             $rule_in_effect = $currrules->{'default'};
                   1416:                         }
                   1417:                     }
                   1418:                 } else {
                   1419:                     if ($currrules->{'_LC_external'} ne '') {
                   1420:                         $rule_in_effect = $currrules->{'_LC_external'};
                   1421:                     }
                   1422:                 }
                   1423:                 $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
                   1424:                                                        $uname,$udom);
                   1425:             }
                   1426:         }
                   1427:     } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239    raeburn  1428:         ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129    raeburn  1429:         unless (defined($cached)) {
                   1430:             my %domconfig =
                   1431:                 &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
                   1432:             if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307    raeburn  1433:                 $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
                   1434:             } else {
                   1435:                 $domneedscache = $serverhomedom;
1.1129    raeburn  1436:             }
                   1437:         }
                   1438:         if (ref($result) eq 'HASH') {
1.1191    raeburn  1439:             ($is_balancer,$currtargets,$currrules) = 
                   1440:                 &check_balancer_result($result,@hosts);
                   1441:             if ($is_balancer) {
1.1129    raeburn  1442:                 if (ref($currrules) eq 'HASH') {
                   1443:                     if ($currrules->{'_LC_internetdom'} ne '') {
                   1444:                         $rule_in_effect = $currrules->{'_LC_internetdom'};
                   1445:                     }
                   1446:                 }
                   1447:                 $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
                   1448:                                                        $uname,$udom);
                   1449:             }
                   1450:         } else {
                   1451:             if ($perlvar{'lonBalancer'} eq 'yes') {
                   1452:                 $is_balancer = 1;
                   1453:                 $offloadto = &this_host_spares($dom_in_use);
                   1454:             }
1.1307    raeburn  1455:             unless (defined($cached)) {
                   1456:                 $domneedscache = $serverhomedom;
                   1457:             }
1.1129    raeburn  1458:         }
                   1459:     } else {
                   1460:         if ($perlvar{'lonBalancer'} eq 'yes') {
                   1461:             $is_balancer = 1;
                   1462:             $offloadto = &this_host_spares($dom_in_use);
                   1463:         }
1.1307    raeburn  1464:         unless (defined($cached)) {
                   1465:             $domneedscache = $serverhomedom;
                   1466:         }
                   1467:     }
                   1468:     if ($domneedscache) {
                   1469:         &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129    raeburn  1470:     }
1.1176    raeburn  1471:     if ($is_balancer) {
                   1472:         my $lowest_load = 30000;
                   1473:         if (ref($offloadto) eq 'HASH') {
                   1474:             if (ref($offloadto->{'primary'}) eq 'ARRAY') {
                   1475:                 foreach my $try_server (@{$offloadto->{'primary'}}) {
                   1476:                     ($otherserver,$lowest_load) =
                   1477:                         &compare_server_load($try_server,$otherserver,$lowest_load);
                   1478:                 }
1.1129    raeburn  1479:             }
1.1176    raeburn  1480:             my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129    raeburn  1481: 
1.1176    raeburn  1482:             if (!$found_server) {
                   1483:                 if (ref($offloadto->{'default'}) eq 'ARRAY') {
                   1484:                     foreach my $try_server (@{$offloadto->{'default'}}) {
                   1485:                         ($otherserver,$lowest_load) =
                   1486:                             &compare_server_load($try_server,$otherserver,$lowest_load);
                   1487:                     }
                   1488:                 }
                   1489:             }
                   1490:         } elsif (ref($offloadto) eq 'ARRAY') {
                   1491:             if (@{$offloadto} == 1) {
                   1492:                 $otherserver = $offloadto->[0];
                   1493:             } elsif (@{$offloadto} > 1) {
                   1494:                 foreach my $try_server (@{$offloadto}) {
1.1129    raeburn  1495:                     ($otherserver,$lowest_load) =
                   1496:                         &compare_server_load($try_server,$otherserver,$lowest_load);
                   1497:                 }
                   1498:             }
                   1499:         }
1.1331    raeburn  1500:         unless ($caller eq 'login') {
                   1501:             if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
                   1502:                 $is_balancer = 0;
                   1503:                 if ($uname ne '' && $udom ne '') {
                   1504:                     if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1176    raeburn  1505:                     
1.1331    raeburn  1506:                         &appenv({'user.loadbalexempt'     => $lonhost,  
                   1507:                                  'user.loadbalcheck.time' => time});
                   1508:                     }
1.1176    raeburn  1509:                 }
1.1129    raeburn  1510:             }
                   1511:         }
                   1512:     }
                   1513:     return ($is_balancer,$otherserver);
                   1514: }
                   1515: 
1.1191    raeburn  1516: sub check_balancer_result {
                   1517:     my ($result,@hosts) = @_;
                   1518:     my ($is_balancer,$currtargets,$currrules);
                   1519:     if (ref($result) eq 'HASH') {
                   1520:         if ($result->{'lonhost'} ne '') {
                   1521:             my $currbalancer = $result->{'lonhost'};
                   1522:             if (grep(/^\Q$currbalancer\E$/,@hosts)) {
                   1523:                 $is_balancer = 1;
                   1524:                 $currtargets = $result->{'targets'};
                   1525:                 $currrules = $result->{'rules'};
                   1526:             }
                   1527:         } else {
                   1528:             foreach my $key (keys(%{$result})) {
                   1529:                 if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
                   1530:                     (ref($result->{$key}) eq 'HASH')) {
                   1531:                     $is_balancer = 1;
                   1532:                     $currrules = $result->{$key}{'rules'};
                   1533:                     $currtargets = $result->{$key}{'targets'};
                   1534:                     last;
                   1535:                 }
                   1536:             }
                   1537:         }
                   1538:     }
                   1539:     return ($is_balancer,$currtargets,$currrules);
                   1540: }
                   1541: 
1.1129    raeburn  1542: sub get_loadbalancer_targets {
                   1543:     my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
                   1544:     my $offloadto;
1.1175    raeburn  1545:     if ($rule_in_effect eq 'none') {
                   1546:         return [$perlvar{'lonHostID'}];
                   1547:     } elsif ($rule_in_effect eq '') {
1.1129    raeburn  1548:         $offloadto = $currtargets;
                   1549:     } else {
                   1550:         if ($rule_in_effect eq 'homeserver') {
                   1551:             my $homeserver = &homeserver($uname,$udom);
                   1552:             if ($homeserver ne 'no_host') {
                   1553:                 $offloadto = [$homeserver];
                   1554:             }
                   1555:         } elsif ($rule_in_effect eq 'externalbalancer') {
                   1556:             my %domconfig =
                   1557:                 &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
                   1558:             if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
                   1559:                 if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
                   1560:                     if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
                   1561:                         $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
                   1562:                     }
                   1563:                 }
                   1564:             } else {
1.1178    raeburn  1565:                 my %servers = &internet_dom_servers($udom);
1.1129    raeburn  1566:                 my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
                   1567:                 if (&hostname($remotebalancer) ne '') {
                   1568:                     $offloadto = [$remotebalancer];
                   1569:                 }
                   1570:             }
                   1571:         } elsif (&hostname($rule_in_effect) ne '') {
                   1572:             $offloadto = [$rule_in_effect];
                   1573:         }
                   1574:     }
                   1575:     return $offloadto;
                   1576: }
                   1577: 
1.1127    raeburn  1578: sub internet_dom_servers {
                   1579:     my ($dom) = @_;
                   1580:     my (%uniqservers,%servers);
                   1581:     my $primaryserver = &hostname(&domain($dom,'primary'));
                   1582:     my @machinedoms = &machine_domains($primaryserver);
                   1583:     foreach my $mdom (@machinedoms) {
                   1584:         my %currservers = %servers;
                   1585:         my %server = &get_servers($mdom);
                   1586:         %servers = (%currservers,%server);
                   1587:     }
                   1588:     my %by_hostname;
                   1589:     foreach my $id (keys(%servers)) {
                   1590:         push(@{$by_hostname{$servers{$id}}},$id);
                   1591:     }
                   1592:     foreach my $hostname (sort(keys(%by_hostname))) {
                   1593:         if (@{$by_hostname{$hostname}} > 1) {
                   1594:             my $match = 0;
                   1595:             foreach my $id (@{$by_hostname{$hostname}}) {
                   1596:                 if (&host_domain($id) eq $dom) {
                   1597:                     $uniqservers{$id} = $hostname;
                   1598:                     $match = 1;
                   1599:                 }
                   1600:             }
                   1601:             unless ($match) {
                   1602:                 $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
                   1603:             }
                   1604:         } else {
                   1605:             $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
                   1606:         }
                   1607:     }
                   1608:     return %uniqservers;
                   1609: }
                   1610: 
1.1347    raeburn  1611: sub trusted_domains {
                   1612:     my ($cmdtype,$calldom) = @_;
1.1349    raeburn  1613:     my ($trusted,$untrusted);
1.1347    raeburn  1614:     if (&domain($calldom) eq '') {
1.1349    raeburn  1615:         return ($trusted,$untrusted);
1.1347    raeburn  1616:     }
                   1617:     unless ($cmdtype =~ /^(content|shared|enroll|coaurem|domroles|catalog|reqcrs|msg)$/) {
1.1349    raeburn  1618:         return ($trusted,$untrusted);
1.1347    raeburn  1619:     }
                   1620:     my $callprimary = &domain($calldom,'primary');
                   1621:     my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
                   1622:     if ($intcalldom eq '') {
1.1349    raeburn  1623:         return ($trusted,$untrusted);
1.1347    raeburn  1624:     }
                   1625: 
                   1626:     my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
                   1627:     unless (defined($cached)) {
                   1628:         my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
                   1629:         &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
                   1630:         $trustconfig = $domconfig{'trust'};
                   1631:     }
                   1632:     if (ref($trustconfig)) {
                   1633:         my (%possexc,%possinc,@allexc,@allinc); 
                   1634:         if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
                   1635:             if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
                   1636:                 map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}}; 
                   1637:             }
                   1638:             if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
                   1639:                 map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
                   1640:             }
                   1641:         }
                   1642:         if (keys(%possexc)) {
                   1643:             if (keys(%possinc)) {
                   1644:                 foreach my $key (sort(keys(%possexc))) {
                   1645:                     next if ($key eq $intcalldom);
                   1646:                     unless ($possinc{$key}) {
                   1647:                         push(@allexc,$key);
                   1648:                     }
                   1649:                 }
                   1650:             } else {
                   1651:                 @allexc = sort(keys(%possexc));
                   1652:             }
                   1653:         }
                   1654:         if (keys(%possinc)) {
                   1655:             $possinc{$intcalldom} = 1;
                   1656:             @allinc = sort(keys(%possinc));
                   1657:         }
                   1658:         if ((@allexc > 0) || (@allinc > 0)) {
                   1659:             my %doms_by_intdom;
                   1660:             my %allintdoms = &all_host_intdom();
                   1661:             my %alldoms = &all_host_domain();
                   1662:             foreach my $key (%allintdoms) {
                   1663:                 if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
                   1664:                     unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
                   1665:                         push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
                   1666:                     }
                   1667:                 } else {
                   1668:                     $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}]; 
                   1669:                 }
                   1670:             }
                   1671:             foreach my $exc (@allexc) {
                   1672:                 if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1349    raeburn  1673:                     $untrusted = $doms_by_intdom{$exc};
1.1347    raeburn  1674:                 }
                   1675:             }
                   1676:             foreach my $inc (@allinc) {
                   1677:                 if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1349    raeburn  1678:                     $trusted = $doms_by_intdom{$inc};
1.1347    raeburn  1679:                 }
                   1680:             }
                   1681:         }
                   1682:     }
1.1349    raeburn  1683:     return ($trusted,$untrusted);
1.1347    raeburn  1684: }
                   1685: 
                   1686: sub will_trust {
                   1687:     my ($cmdtype,$domain,$possdom) = @_;
                   1688:     return 1 if ($domain eq $possdom);
                   1689:     my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
                   1690:     my $willtrust; 
                   1691:     if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
                   1692:         if (grep(/^\Q$domain\E$/,@{$trustedref})) {
                   1693:             $willtrust = 1;
                   1694:         }
                   1695:     } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
                   1696:         unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
                   1697:             $willtrust = 1;
                   1698:         }
                   1699:     } else {
                   1700:         $willtrust = 1;
                   1701:     }
                   1702:     return $willtrust;
                   1703: }
                   1704: 
1.1       albertel 1705: # ---------------------- Find the homebase for a user from domain's lib servers
1.11      www      1706: 
1.599     albertel 1707: my %homecache;
1.1       albertel 1708: sub homeserver {
1.230     stredwic 1709:     my ($uname,$udom,$ignoreBadCache)=@_;
1.1       albertel 1710:     my $index="$uname:$udom";
1.426     albertel 1711: 
1.599     albertel 1712:     if (exists($homecache{$index})) { return $homecache{$index}; }
1.841     albertel 1713: 
                   1714:     my %servers = &get_servers($udom,'library');
                   1715:     foreach my $tryserver (keys(%servers)) {
1.230     stredwic 1716:         next if ($ignoreBadCache ne 'true' && 
1.231     stredwic 1717: 		 exists($badServerCache{$tryserver}));
1.841     albertel 1718: 
                   1719: 	my $answer=reply("home:$udom:$uname",$tryserver);
                   1720: 	if ($answer eq 'found') {
                   1721: 	    delete($badServerCache{$tryserver}); 
                   1722: 	    return $homecache{$index}=$tryserver;
                   1723: 	} elsif ($answer eq 'no_host') {
                   1724: 	    $badServerCache{$tryserver}=1;
                   1725: 	}
1.1       albertel 1726:     }    
                   1727:     return 'no_host';
1.70      www      1728: }
                   1729: 
1.1300    raeburn  1730: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70      www      1731: 
                   1732: sub idget {
1.1300    raeburn  1733:     my ($udom,$idsref,$namespace)=@_;
1.70      www      1734:     my %returnhash=();
1.1300    raeburn  1735:     my @ids=(); 
                   1736:     if (ref($idsref) eq 'ARRAY') {
                   1737:         @ids = @{$idsref};
                   1738:     } else {
                   1739:         return %returnhash; 
                   1740:     }
                   1741:     if ($namespace eq '') {
                   1742:         $namespace = 'ids';
                   1743:     }
1.70      www      1744:     
1.841     albertel 1745:     my %servers = &get_servers($udom,'library');
                   1746:     foreach my $tryserver (keys(%servers)) {
1.1299    raeburn  1747: 	my $idlist=join('&', map { &escape($_); } @ids);
1.1300    raeburn  1748: 	if ($namespace eq 'ids') {
                   1749: 	    $idlist=~tr/A-Z/a-z/;
                   1750: 	}
                   1751: 	my $reply;
                   1752: 	if ($namespace eq 'ids') {
                   1753: 	    $reply=&reply("idget:$udom:".$idlist,$tryserver);
                   1754: 	} else {
                   1755: 	    $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
                   1756: 	}
1.841     albertel 1757: 	my @answer=();
                   1758: 	if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
                   1759: 	    @answer=split(/\&/,$reply);
                   1760: 	}                    ;
                   1761: 	my $i;
                   1762: 	for ($i=0;$i<=$#ids;$i++) {
                   1763: 	    if ($answer[$i]) {
1.1299    raeburn  1764: 		$returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300    raeburn  1765: 	    }
1.841     albertel 1766: 	}
1.1300    raeburn  1767:     }
1.70      www      1768:     return %returnhash;
                   1769: }
                   1770: 
                   1771: # ------------------------------------- Find the IDs behind a list of usernames
                   1772: 
                   1773: sub idrget {
                   1774:     my ($udom,@unames)=@_;
                   1775:     my %returnhash=();
1.800     albertel 1776:     foreach my $uname (@unames) {
                   1777:         $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191     harris41 1778:     }
1.70      www      1779:     return %returnhash;
                   1780: }
                   1781: 
1.1300    raeburn  1782: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70      www      1783: 
                   1784: sub idput {
1.1300    raeburn  1785:     my ($udom,$idsref,$uhom,$namespace)=@_;
1.70      www      1786:     my %servers=();
1.1300    raeburn  1787:     my %ids=();
                   1788:     my %byid = ();
                   1789:     if (ref($idsref) eq 'HASH') {
                   1790:         %ids=%{$idsref};
                   1791:     }
                   1792:     if ($namespace eq '') {
                   1793:         $namespace = 'ids'; 
                   1794:     }
1.800     albertel 1795:     foreach my $uname (keys(%ids)) {
                   1796: 	&cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300    raeburn  1797:         if ($uhom eq '') {
                   1798:             $uhom=&homeserver($uname,$udom);
                   1799:         }
1.70      www      1800:         if ($uhom ne 'no_host') {
1.800     albertel 1801:             my $esc_unam=&escape($uname);
1.1300    raeburn  1802:             if ($namespace eq 'ids') {
                   1803:                 my $id=&escape($ids{$uname});
                   1804:                 $id=~tr/A-Z/a-z/;
                   1805:                 my $esc_unam=&escape($uname);
                   1806:                 $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70      www      1807:             } else {
1.1300    raeburn  1808:                 my @currids = split(/,/,$ids{$uname});
                   1809:                 foreach my $id (@currids) {
                   1810:                     $byid{$uhom}{$id} .= $uname.',';
                   1811:                 }
                   1812:             }
                   1813:         }
                   1814:     }
                   1815:     if ($namespace eq 'clickers') {
                   1816:         foreach my $server (keys(%byid)) {
                   1817:             if (ref($byid{$server}) eq 'HASH') {
                   1818:                 foreach my $id (keys(%{$byid{$server}})) {
                   1819:                     $byid{$server} =~ s/,$//;
                   1820:                     $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&'; 
                   1821:                 }
1.70      www      1822:             }
                   1823:         }
1.191     harris41 1824:     }
1.800     albertel 1825:     foreach my $server (keys(%servers)) {
1.1300    raeburn  1826:         $servers{$server} =~ s/\&$//;
                   1827:         if ($namespace eq 'ids') {     
                   1828:             &critical('idput:'.$udom.':'.$servers{$server},$server);
                   1829:         } else {
                   1830:             &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
                   1831:         }
1.191     harris41 1832:     }
1.344     www      1833: }
                   1834: 
1.1300    raeburn  1835: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231    raeburn  1836: 
                   1837: sub iddel {
1.1300    raeburn  1838:     my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231    raeburn  1839:     my %result=();
1.1300    raeburn  1840:     my %ids=();
                   1841:     my %byid = ();
                   1842:     if (ref($idshashref) eq 'HASH') {
                   1843:         %ids=%{$idshashref};
                   1844:     } else {
1.1231    raeburn  1845:         return %result;
                   1846:     }
1.1300    raeburn  1847:     if ($namespace eq '') {
                   1848:         $namespace = 'ids';
                   1849:     }
1.1231    raeburn  1850:     my %servers=();
1.1300    raeburn  1851:     while (my ($id,$unamestr) = each(%ids)) {
                   1852:         if ($namespace eq 'ids') {
                   1853:             my $uhom = $uhome;
                   1854:             if ($uhom eq '') { 
                   1855:                 $uhom=&homeserver($unamestr,$udom);
                   1856:             }
                   1857:             if ($uhom ne 'no_host') {
                   1858:                 $servers{$uhom}.='&'.&escape($id);
                   1859:             }
                   1860:          } else {
                   1861:             my @curritems = split(/,/,$ids{$id});
                   1862:             foreach my $uname (@curritems) {
                   1863:                 my $uhom = $uhome;
                   1864:                 if ($uhom eq '') {
                   1865:                     $uhom=&homeserver($uname,$udom);
                   1866:                 }
                   1867:                 if ($uhom ne 'no_host') { 
                   1868:                     $byid{$uhom}{$id} .= $uname.',';
                   1869:                 }
                   1870:             }
1.1231    raeburn  1871:         }
1.1300    raeburn  1872:     }
                   1873:     if ($namespace eq 'clickers') {
                   1874:         foreach my $server (keys(%byid)) {
                   1875:             if (ref($byid{$server}) eq 'HASH') {
                   1876:                 foreach my $id (keys(%{$byid{$server}})) {
                   1877:                     $byid{$server}{$id} =~ s/,$//;
                   1878:                     $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
                   1879:                 }
1.1231    raeburn  1880:             }
                   1881:         }
                   1882:     }
                   1883:     foreach my $server (keys(%servers)) {
1.1300    raeburn  1884:         $servers{$server} =~ s/\&$//;
                   1885:         if ($namespace eq 'ids') {
                   1886:             $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
                   1887:         } elsif ($namespace eq 'clickers') {
                   1888:             $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
                   1889:         }
1.1231    raeburn  1890:     }
                   1891:     return %result;
                   1892: }
                   1893: 
1.1300    raeburn  1894: # ----- Update clicker ID-to-username look-ups in clickers.db on library server 
                   1895: 
                   1896: sub updateclickers {
                   1897:     my ($udom,$action,$idshashref,$uhome,$critical) = @_;
                   1898:     my %clickers;
                   1899:     if (ref($idshashref) eq 'HASH') {
                   1900:         %clickers=%{$idshashref};
                   1901:     } else {
                   1902:         return;
                   1903:     }
                   1904:     my $items='';
                   1905:     foreach my $item (keys(%clickers)) {
                   1906:         $items.=&escape($item).'='.&escape($clickers{$item}).'&';
                   1907:     }
                   1908:     $items=~s/\&$//;
                   1909:     my $request = "updateclickers:$udom:$action:$items";
                   1910:     if ($critical) {
                   1911:         return &critical($request,$uhome);
                   1912:     } else {
                   1913:         return &reply($request,$uhome);
                   1914:     }
                   1915: }
                   1916: 
1.1023    raeburn  1917: # ------------------------------dump from db file owned by domainconfig user
1.1012    raeburn  1918: sub dump_dom {
1.1165    droeschl 1919:     my ($namespace, $udom, $regexp) = @_;
                   1920: 
                   1921:     $udom ||= $env{'user.domain'};
                   1922: 
                   1923:     return () unless $udom;
                   1924: 
                   1925:     return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012    raeburn  1926: }
                   1927: 
1.1023    raeburn  1928: # ------------------------------------------ get items from domain db files   
1.806     raeburn  1929: 
                   1930: sub get_dom {
1.860     raeburn  1931:     my ($namespace,$storearr,$udom,$uhome)=@_;
1.1267    raeburn  1932:     return if ($udom eq 'public');
1.806     raeburn  1933:     my $items='';
                   1934:     foreach my $item (@$storearr) {
                   1935:         $items.=&escape($item).'&';
                   1936:     }
                   1937:     $items=~s/\&$//;
1.860     raeburn  1938:     if (!$udom) {
                   1939:         $udom=$env{'user.domain'};
1.1267    raeburn  1940:         return if ($udom eq 'public');
1.860     raeburn  1941:         if (defined(&domain($udom,'primary'))) {
                   1942:             $uhome=&domain($udom,'primary');
                   1943:         } else {
1.874     albertel 1944:             undef($uhome);
1.860     raeburn  1945:         }
                   1946:     } else {
                   1947:         if (!$uhome) {
                   1948:             if (defined(&domain($udom,'primary'))) {
                   1949:                 $uhome=&domain($udom,'primary');
                   1950:             }
                   1951:         }
                   1952:     }
                   1953:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344    raeburn  1954:         my $rep;
                   1955:         if ($namespace =~ /^enc/) {
                   1956:             $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
                   1957:         } else {
                   1958:             $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
                   1959:         }
1.866     raeburn  1960:         my %returnhash;
1.875     albertel 1961:         if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866     raeburn  1962:             return %returnhash;
                   1963:         }
1.806     raeburn  1964:         my @pairs=split(/\&/,$rep);
                   1965:         if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   1966:             return @pairs;
                   1967:         }
                   1968:         my $i=0;
                   1969:         foreach my $item (@$storearr) {
                   1970:             $returnhash{$item}=&thaw_unescape($pairs[$i]);
                   1971:             $i++;
                   1972:         }
                   1973:         return %returnhash;
                   1974:     } else {
1.880     banghart 1975:         &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806     raeburn  1976:     }
                   1977: }
                   1978: 
                   1979: # -------------------------------------------- put items in domain db files 
                   1980: 
                   1981: sub put_dom {
1.860     raeburn  1982:     my ($namespace,$storehash,$udom,$uhome)=@_;
                   1983:     if (!$udom) {
                   1984:         $udom=$env{'user.domain'};
                   1985:         if (defined(&domain($udom,'primary'))) {
                   1986:             $uhome=&domain($udom,'primary');
                   1987:         } else {
1.874     albertel 1988:             undef($uhome);
1.860     raeburn  1989:         }
                   1990:     } else {
                   1991:         if (!$uhome) {
                   1992:             if (defined(&domain($udom,'primary'))) {
                   1993:                 $uhome=&domain($udom,'primary');
                   1994:             }
                   1995:         }
                   1996:     } 
                   1997:     if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806     raeburn  1998:         my $items='';
                   1999:         foreach my $item (keys(%$storehash)) {
                   2000:             $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
                   2001:         }
                   2002:         $items=~s/\&$//;
1.1344    raeburn  2003:         if ($namespace =~ /^enc/) {
                   2004:             return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
                   2005:         } else {
                   2006:             return &reply("putdom:$udom:$namespace:$items",$uhome);
                   2007:         }
1.806     raeburn  2008:     } else {
1.860     raeburn  2009:         &logthis("put_dom failed - no homeserver and/or domain");
1.806     raeburn  2010:     }
                   2011: }
                   2012: 
1.1023    raeburn  2013: # --------------------- newput for items in db file owned by domainconfig user
1.1012    raeburn  2014: sub newput_dom {
1.1023    raeburn  2015:     my ($namespace,$storehash,$udom) = @_;
1.1012    raeburn  2016:     my $result;
                   2017:     if (!$udom) {
                   2018:         $udom=$env{'user.domain'};
                   2019:     }
1.1023    raeburn  2020:     if ($udom) {
                   2021:         my $uname = &get_domainconfiguser($udom);
                   2022:         $result = &newput($namespace,$storehash,$udom,$uname);
1.1012    raeburn  2023:     }
                   2024:     return $result;
                   2025: }
                   2026: 
1.1023    raeburn  2027: # --------------------- delete for items in db file owned by domainconfig user
1.1012    raeburn  2028: sub del_dom {
1.1023    raeburn  2029:     my ($namespace,$storearr,$udom)=@_;
1.1012    raeburn  2030:     if (ref($storearr) eq 'ARRAY') {
                   2031:         if (!$udom) {
                   2032:             $udom=$env{'user.domain'};
                   2033:         }
1.1023    raeburn  2034:         if ($udom) {
                   2035:             my $uname = &get_domainconfiguser($udom); 
                   2036:             return &del($namespace,$storearr,$udom,$uname);
1.1012    raeburn  2037:         }
                   2038:     }
                   2039: }
                   2040: 
1.1023    raeburn  2041: # ----------------------------------construct domainconfig user for a domain 
                   2042: sub get_domainconfiguser {
                   2043:     my ($udom) = @_;
                   2044:     return $udom.'-domainconfig';
                   2045: }
                   2046: 
1.837     raeburn  2047: sub retrieve_inst_usertypes {
                   2048:     my ($udom) = @_;
                   2049:     my (%returnhash,@order);
1.989     raeburn  2050:     my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
                   2051:     if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 
                   2052:         (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256    raeburn  2053:         return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989     raeburn  2054:     } else {
                   2055:         if (defined(&domain($udom,'primary'))) {
                   2056:             my $uhome=&domain($udom,'primary');
                   2057:             my $rep=&reply("inst_usertypes:$udom",$uhome);
                   2058:             if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256    raeburn  2059:                 &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989     raeburn  2060:                 return (\%returnhash,\@order);
                   2061:             }
                   2062:             my ($hashitems,$orderitems) = split(/:/,$rep); 
                   2063:             my @pairs=split(/\&/,$hashitems);
                   2064:             foreach my $item (@pairs) {
                   2065:                 my ($key,$value)=split(/=/,$item,2);
                   2066:                 $key = &unescape($key);
                   2067:                 next if ($key =~ /^error: 2 /);
                   2068:                 $returnhash{$key}=&thaw_unescape($value);
                   2069:             }
                   2070:             my @esc_order = split(/\&/,$orderitems);
                   2071:             foreach my $item (@esc_order) {
                   2072:                 push(@order,&unescape($item));
                   2073:             }
                   2074:         } else {
1.1256    raeburn  2075:             &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837     raeburn  2076:         }
1.1256    raeburn  2077:         return (\%returnhash,\@order);
1.837     raeburn  2078:     }
                   2079: }
                   2080: 
1.868     raeburn  2081: sub is_domainimage {
                   2082:     my ($url) = @_;
1.1306    raeburn  2083:     if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1.868     raeburn  2084:         if (&domain($1) ne '') {
                   2085:             return '1';
                   2086:         }
                   2087:     }
                   2088:     return;
                   2089: }
                   2090: 
1.899     raeburn  2091: sub inst_directory_query {
                   2092:     my ($srch) = @_;
                   2093:     my $udom = $srch->{'srchdomain'};
                   2094:     my %results;
                   2095:     my $homeserver = &domain($udom,'primary');
1.909     raeburn  2096:     my $outcome;
1.899     raeburn  2097:     if ($homeserver ne '') {
1.1357    raeburn  2098:         unless ($homeserver eq $perlvar{'lonHostID'}) {
                   2099:             if ($srch->{'srchby'} eq 'email') {
                   2100:                 my $lcrev = &get_server_loncaparev(undef,$homeserver);
                   2101:                 my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   2102:                 if (($major eq '' && $minor eq '') || ($major < 2) ||
                   2103:                     (($major == 2) && ($minor < 12))) {
                   2104:                     return;
                   2105:                 }
                   2106:             }
                   2107:         }
1.904     albertel 2108: 	my $queryid=&reply("querysend:instdirsearch:".
                   2109: 			   &escape($srch->{'srchby'}).':'.
                   2110: 			   &escape($srch->{'srchterm'}).':'.
                   2111: 			   &escape($srch->{'srchtype'}),$homeserver);
                   2112: 	my $host=&hostname($homeserver);
                   2113: 	if ($queryid !~/^\Q$host\E\_/) {
1.1343    raeburn  2114: 	    &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904     albertel 2115: 	    return;
                   2116: 	}
                   2117: 	my $response = &get_query_reply($queryid);
                   2118: 	my $maxtries = 5;
                   2119: 	my $tries = 1;
                   2120: 	while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   2121: 	    $response = &get_query_reply($queryid);
                   2122: 	    $tries ++;
                   2123: 	}
                   2124: 
                   2125:         if (!&error($response) && $response ne 'refused') {
1.909     raeburn  2126:             if ($response eq 'unavailable') {
                   2127:                 $outcome = $response;
                   2128:             } else {
                   2129:                 $outcome = 'ok';
                   2130:                 my @matches = split(/\n/,$response);
                   2131:                 foreach my $match (@matches) {
                   2132:                     my ($key,$value) = split(/=/,$match);
                   2133:                     $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
                   2134:                 }
1.899     raeburn  2135:             }
                   2136:         }
                   2137:     }
1.909     raeburn  2138:     return ($outcome,%results);
1.899     raeburn  2139: }
                   2140: 
                   2141: sub usersearch {
                   2142:     my ($srch) = @_;
                   2143:     my $dom = $srch->{'srchdomain'};
                   2144:     my %results;
                   2145:     my %libserv = &all_library();
                   2146:     my $query = 'usersearch';
                   2147:     foreach my $tryserver (keys(%libserv)) {
                   2148:         if (&host_domain($tryserver) eq $dom) {
1.1357    raeburn  2149:             unless ($tryserver eq $perlvar{'lonHostID'}) {
                   2150:                 if ($srch->{'srchby'} eq 'email') {
                   2151:                     my $lcrev = &get_server_loncaparev(undef,$tryserver);
                   2152:                     my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   2153:                     next if (($major eq '' && $minor eq '') || ($major < 2) ||
                   2154:                              (($major == 2) && ($minor < 12)));
                   2155:                 }
                   2156:             }
1.899     raeburn  2157:             my $host=&hostname($tryserver);
                   2158:             my $queryid=
1.911     raeburn  2159:                 &reply("querysend:".&escape($query).':'.
                   2160:                        &escape($srch->{'srchby'}).':'.
1.899     raeburn  2161:                        &escape($srch->{'srchtype'}).':'.
                   2162:                        &escape($srch->{'srchterm'}),$tryserver);
                   2163:             if ($queryid !~/^\Q$host\E\_/) {
                   2164:                 &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902     raeburn  2165:                 next;
1.899     raeburn  2166:             }
                   2167:             my $reply = &get_query_reply($queryid);
                   2168:             my $maxtries = 1;
                   2169:             my $tries = 1;
                   2170:             while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   2171:                 $reply = &get_query_reply($queryid);
                   2172:                 $tries ++;
                   2173:             }
                   2174:             if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   2175:                 &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') -  maxtries: '.$maxtries.' tries: '.$tries);
                   2176:             } else {
1.911     raeburn  2177:                 my @matches;
                   2178:                 if ($reply =~ /\n/) {
                   2179:                     @matches = split(/\n/,$reply);
                   2180:                 } else {
                   2181:                     @matches = split(/\&/,$reply);
                   2182:                 }
1.899     raeburn  2183:                 foreach my $match (@matches) {
                   2184:                     my ($uname,$udom,%userhash);
1.911     raeburn  2185:                     foreach my $entry (split(/:/,$match)) {
                   2186:                         my ($key,$value) =
                   2187:                             map {&unescape($_);} split(/=/,$entry);
1.899     raeburn  2188:                         $userhash{$key} = $value;
                   2189:                         if ($key eq 'username') {
                   2190:                             $uname = $value;
                   2191:                         } elsif ($key eq 'domain') {
                   2192:                             $udom = $value;
1.911     raeburn  2193:                         }
1.899     raeburn  2194:                     }
                   2195:                     $results{$uname.':'.$udom} = \%userhash;
                   2196:                 }
                   2197:             }
                   2198:         }
                   2199:     }
                   2200:     return %results;
                   2201: }
                   2202: 
1.912     raeburn  2203: sub get_instuser {
                   2204:     my ($udom,$uname,$id) = @_;
                   2205:     my $homeserver = &domain($udom,'primary');
                   2206:     my ($outcome,%results);
                   2207:     if ($homeserver ne '') {
                   2208:         my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
                   2209:                            &escape($id).':'.&escape($udom),$homeserver);
                   2210:         my $host=&hostname($homeserver);
                   2211:         if ($queryid !~/^\Q$host\E\_/) {
                   2212:             &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
                   2213:             return;
                   2214:         }
                   2215:         my $response = &get_query_reply($queryid);
                   2216:         my $maxtries = 5;
                   2217:         my $tries = 1;
                   2218:         while (($response=~/^timeout/) && ($tries < $maxtries)) {
                   2219:             $response = &get_query_reply($queryid);
                   2220:             $tries ++;
                   2221:         }
                   2222:         if (!&error($response) && $response ne 'refused') {
                   2223:             if ($response eq 'unavailable') {
                   2224:                 $outcome = $response;
                   2225:             } else {
                   2226:                 $outcome = 'ok';
                   2227:                 my @matches = split(/\n/,$response);
                   2228:                 foreach my $match (@matches) {
                   2229:                     my ($key,$value) = split(/=/,$match);
                   2230:                     $results{&unescape($key)} = &thaw_unescape($value);
                   2231:                 }
                   2232:             }
                   2233:         }
                   2234:     }
                   2235:     my %userinfo;
                   2236:     if (ref($results{$uname}) eq 'HASH') {
                   2237:         %userinfo = %{$results{$uname}};
                   2238:     } 
                   2239:     return ($outcome,%userinfo);
                   2240: }
                   2241: 
1.1290    raeburn  2242: sub get_multiple_instusers {
                   2243:     my ($udom,$users,$caller) = @_;
                   2244:     my ($outcome,$results);
                   2245:     if (ref($users) eq 'HASH') {
                   2246:         my $count = keys(%{$users}); 
                   2247:         my $requested = &freeze_escape($users);
                   2248:         my $homeserver = &domain($udom,'primary');
                   2249:         if ($homeserver ne '') {
                   2250:             my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
                   2251:             my $host=&hostname($homeserver);
                   2252:             if ($queryid !~/^\Q$host\E\_/) {
                   2253:                 &logthis('get_multiple_instusers invalid queryid: '.$queryid.
                   2254:                          ' for host: '.$homeserver.'in domain '.$udom);
                   2255:                 return ($outcome,$results);
                   2256:             }
                   2257:             my $response = &get_query_reply($queryid);
                   2258:             my $maxtries = 5;
                   2259:             if ($count > 100) {
                   2260:                 $maxtries = 1+int($count/20);
                   2261:             }
                   2262:             my $tries = 1;
                   2263:             while (($response=~/^timeout/) && ($tries <= $maxtries)) {
                   2264:                 $response = &get_query_reply($queryid);
                   2265:                 $tries ++;
                   2266:             }
                   2267:             if ($response eq '') {
                   2268:                 $results = {};
                   2269:                 foreach my $key (keys(%{$users})) {
                   2270:                     my ($uname,$id);
                   2271:                     if ($caller eq 'id') {
                   2272:                         $id = $key;
                   2273:                     } else {
                   2274:                         $uname = $key;
                   2275:                     }
                   2276:                     my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291    raeburn  2277:                     $outcome = $resp;
1.1290    raeburn  2278:                     if ($resp eq 'ok') {
                   2279:                         %{$results} = (%{$results}, %info);
                   2280:                     } else {
                   2281:                         last;
                   2282:                     }
                   2283:                 }
                   2284:             } elsif(!&error($response) && ($response ne 'refused')) {
                   2285:                 if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
                   2286:                     $outcome = $response;
                   2287:                 } else {
1.1291    raeburn  2288:                     ($outcome,my $userdata) = split(/=/,$response,2);
1.1290    raeburn  2289:                     if ($outcome eq 'ok') {
                   2290:                         $results = &thaw_unescape($userdata); 
                   2291:                     }
                   2292:                 }
                   2293:             }
                   2294:         }
                   2295:     }
                   2296:     return ($outcome,$results);
                   2297: }
                   2298: 
1.912     raeburn  2299: sub inst_rulecheck {
1.923     raeburn  2300:     my ($udom,$uname,$id,$item,$rules) = @_;
1.912     raeburn  2301:     my %returnhash;
                   2302:     if ($udom ne '') {
                   2303:         if (ref($rules) eq 'ARRAY') {
                   2304:             @{$rules} = map {&escape($_);} (@{$rules});
                   2305:             my $rulestr = join(':',@{$rules});
                   2306:             my $homeserver=&domain($udom,'primary');
                   2307:             if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  2308:                 my $response;
                   2309:                 if ($item eq 'username') {                
                   2310:                     $response=&unescape(&reply('instrulecheck:'.&escape($udom).
                   2311:                                               ':'.&escape($uname).':'.$rulestr,
1.912     raeburn  2312:                                               $homeserver));
1.923     raeburn  2313:                 } elsif ($item eq 'id') {
                   2314:                     $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
                   2315:                                               ':'.&escape($id).':'.$rulestr,
                   2316:                                               $homeserver));
1.945     raeburn  2317:                 } elsif ($item eq 'selfcreate') {
                   2318:                     $response=&unescape(&reply('instselfcreatecheck:'.
1.943     raeburn  2319:                                                &escape($udom).':'.&escape($uname).
                   2320:                                               ':'.$rulestr,$homeserver));
1.923     raeburn  2321:                 }
1.912     raeburn  2322:                 if ($response ne 'refused') {
                   2323:                     my @pairs=split(/\&/,$response);
                   2324:                     foreach my $item (@pairs) {
                   2325:                         my ($key,$value)=split(/=/,$item,2);
                   2326:                         $key = &unescape($key);
                   2327:                         next if ($key =~ /^error: 2 /);
                   2328:                         $returnhash{$key}=&thaw_unescape($value);
                   2329:                     }
                   2330:                 }
                   2331:             }
                   2332:         }
                   2333:     }
                   2334:     return %returnhash;
                   2335: }
                   2336: 
                   2337: sub inst_userrules {
1.923     raeburn  2338:     my ($udom,$check) = @_;
1.912     raeburn  2339:     my (%ruleshash,@ruleorder);
                   2340:     if ($udom ne '') {
                   2341:         my $homeserver=&domain($udom,'primary');
                   2342:         if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923     raeburn  2343:             my $response;
                   2344:             if ($check eq 'id') {
                   2345:                 $response=&reply('instidrules:'.&escape($udom),
1.912     raeburn  2346:                                  $homeserver);
1.943     raeburn  2347:             } elsif ($check eq 'email') {
                   2348:                 $response=&reply('instemailrules:'.&escape($udom),
                   2349:                                  $homeserver);
1.923     raeburn  2350:             } else {
                   2351:                 $response=&reply('instuserrules:'.&escape($udom),
                   2352:                                  $homeserver);
                   2353:             }
1.912     raeburn  2354:             if (($response ne 'refused') && ($response ne 'error') && 
1.923     raeburn  2355:                 ($response ne 'unknown_cmd') && 
1.912     raeburn  2356:                 ($response ne 'no_such_host')) {
                   2357:                 my ($hashitems,$orderitems) = split(/:/,$response);
                   2358:                 my @pairs=split(/\&/,$hashitems);
                   2359:                 foreach my $item (@pairs) {
                   2360:                     my ($key,$value)=split(/=/,$item,2);
                   2361:                     $key = &unescape($key);
                   2362:                     next if ($key =~ /^error: 2 /);
                   2363:                     $ruleshash{$key}=&thaw_unescape($value);
                   2364:                 }
                   2365:                 my @esc_order = split(/\&/,$orderitems);
                   2366:                 foreach my $item (@esc_order) {
                   2367:                     push(@ruleorder,&unescape($item));
                   2368:                 }
                   2369:             }
                   2370:         }
                   2371:     }
                   2372:     return (\%ruleshash,\@ruleorder);
                   2373: }
                   2374: 
1.976     raeburn  2375: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943     raeburn  2376: 
                   2377: sub get_domain_defaults {
1.1240    raeburn  2378:     my ($domain,$ignore_cache) = @_;
1.1242    raeburn  2379:     return if (($domain eq '') || ($domain eq 'public'));
1.943     raeburn  2380:     my $cachetime = 60*60*24;
1.1240    raeburn  2381:     unless ($ignore_cache) {
                   2382:         my ($result,$cached)=&is_cached_new('domdefaults',$domain);
                   2383:         if (defined($cached)) {
                   2384:             if (ref($result) eq 'HASH') {
                   2385:                 return %{$result};
                   2386:             }
1.943     raeburn  2387:         }
                   2388:     }
                   2389:     my %domdefaults;
                   2390:     my %domconfig =
1.989     raeburn  2391:          &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047    raeburn  2392:                                   'requestcourses','inststatus',
1.1183    raeburn  2393:                                   'coursedefaults','usersessions',
1.1258    raeburn  2394:                                   'requestauthor','selfenrollment',
1.1320    raeburn  2395:                                   'coursecategories','ssl','autoenroll',
1.1332    raeburn  2396:                                   'trust','helpsettings'],$domain);
1.1305    raeburn  2397:     my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943     raeburn  2398:     if (ref($domconfig{'defaults'}) eq 'HASH') {
                   2399:         $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 
                   2400:         $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
                   2401:         $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982     raeburn  2402:         $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985     raeburn  2403:         $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147    raeburn  2404:         $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1340    raeburn  2405:         $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
                   2406:         $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
                   2407:         $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943     raeburn  2408:     } else {
                   2409:         $domdefaults{'lang_def'} = &domain($domain,'lang_def');
                   2410:         $domdefaults{'auth_def'} = &domain($domain,'auth_def');
                   2411:         $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
                   2412:     }
1.976     raeburn  2413:     if (ref($domconfig{'quotas'}) eq 'HASH') {
                   2414:         if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
                   2415:             $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
                   2416:         } else {
                   2417:             $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229    raeburn  2418:         }
1.1177    raeburn  2419:         my @usertools = ('aboutme','blog','webdav','portfolio');
1.976     raeburn  2420:         foreach my $item (@usertools) {
                   2421:             if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
                   2422:                 $domdefaults{$item} = $domconfig{'quotas'}{$item};
                   2423:             }
                   2424:         }
1.1229    raeburn  2425:         if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
                   2426:             $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
                   2427:         }
1.976     raeburn  2428:     }
1.985     raeburn  2429:     if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305    raeburn  2430:         foreach my $item ('official','unofficial','community','textbook','placement') {
1.985     raeburn  2431:             $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
                   2432:         }
                   2433:     }
1.1183    raeburn  2434:     if (ref($domconfig{'requestauthor'}) eq 'HASH') {
                   2435:         $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
                   2436:     }
1.989     raeburn  2437:     if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256    raeburn  2438:         foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989     raeburn  2439:             $domdefaults{$item} = $domconfig{'inststatus'}{$item};
                   2440:         }
                   2441:     }
1.1047    raeburn  2442:     if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230    raeburn  2443:         $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277    raeburn  2444:         $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
                   2445:         $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
                   2446:         if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
                   2447:             $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
                   2448:         }
1.1254    raeburn  2449:         foreach my $type (@coursetypes) {
                   2450:             if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
                   2451:                 unless ($type eq 'community') {
                   2452:                     $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
                   2453:                 }
                   2454:             }
                   2455:             if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
                   2456:                 $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
                   2457:             }
1.1277    raeburn  2458:             if ($domdefaults{'postsubmit'} eq 'on') {
                   2459:                 if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
                   2460:                     $domdefaults{$type.'postsubtimeout'} = 
                   2461:                         $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type}; 
                   2462:                 }
                   2463:             }
1.1230    raeburn  2464:         }
1.1286    raeburn  2465:         if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
                   2466:             if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
                   2467:                 my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
                   2468:                 if (@clonecodes) {
                   2469:                     $domdefaults{'canclone'} = join('+',@clonecodes);
                   2470:                 }
                   2471:             }
                   2472:         } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
                   2473:             $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
                   2474:         }
1.1356    raeburn  2475:         if ($domconfig{'coursedefaults'}{'texengine'}) {
                   2476:             $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
                   2477:         } 
1.1047    raeburn  2478:     }
1.1073    raeburn  2479:     if (ref($domconfig{'usersessions'}) eq 'HASH') {
                   2480:         if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
                   2481:             $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
                   2482:         }
                   2483:         if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
                   2484:             $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
                   2485:         }
1.1279    raeburn  2486:         if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
                   2487:             $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
                   2488:         }
1.1073    raeburn  2489:     }
1.1254    raeburn  2490:     if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
                   2491:         if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
                   2492:             my @settings = ('types','registered','enroll_dates','access_dates','section',
                   2493:                             'approval','limit');
                   2494:             foreach my $type (@coursetypes) {
                   2495:                 if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
                   2496:                     my @mgrdc = ();
                   2497:                     foreach my $item (@settings) {
                   2498:                         if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
                   2499:                             push(@mgrdc,$item);
                   2500:                         }
                   2501:                     }
                   2502:                     if (@mgrdc) {
                   2503:                         $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
                   2504:                     }
                   2505:                 }
                   2506:             }
                   2507:         }
                   2508:         if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
                   2509:             foreach my $type (@coursetypes) {
                   2510:                 if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
                   2511:                     foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
                   2512:                         $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
                   2513:                     }
                   2514:                 }
                   2515:             }
                   2516:         }
                   2517:     }
1.1258    raeburn  2518:     if (ref($domconfig{'coursecategories'}) eq 'HASH') {
                   2519:         $domdefaults{'catauth'} = 'std';
                   2520:         $domdefaults{'catunauth'} = 'std';
                   2521:         if ($domconfig{'coursecategories'}{'auth'}) { 
                   2522:             $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
                   2523:         }
                   2524:         if ($domconfig{'coursecategories'}{'unauth'}) {
                   2525:             $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
                   2526:         }
                   2527:     }
1.1315    raeburn  2528:     if (ref($domconfig{'ssl'}) eq 'HASH') {
                   2529:         if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
                   2530:             $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
                   2531:         }
1.1338    raeburn  2532:         if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
                   2533:             $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
                   2534:         }
                   2535:         if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
                   2536:             $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315    raeburn  2537:         }
                   2538:     }
1.1320    raeburn  2539:     if (ref($domconfig{'trust'}) eq 'HASH') {
                   2540:         my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
                   2541:         foreach my $prefix (@prefixes) {
                   2542:             if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
                   2543:                 $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
                   2544:             }
                   2545:         }
                   2546:     }
1.1314    raeburn  2547:     if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   2548:         $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
                   2549:     }
1.1332    raeburn  2550:     if (ref($domconfig{'helpsettings'}) eq 'HASH') {
                   2551:         $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
                   2552:         if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
                   2553:             $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
                   2554:         }
                   2555:     }
1.1219    raeburn  2556:     &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943     raeburn  2557:     return %domdefaults;
                   2558: }
                   2559: 
1.1311    raeburn  2560: sub course_portal_url {
                   2561:     my ($cnum,$cdom) = @_;
                   2562:     my $chome = &homeserver($cnum,$cdom);
                   2563:     my $hostname = &hostname($chome);
                   2564:     my $protocol = $protocol{$chome};
                   2565:     $protocol = 'http' if ($protocol ne 'https');
                   2566:     my %domdefaults = &get_domain_defaults($cdom);
                   2567:     my $firsturl;
                   2568:     if ($domdefaults{'portal_def'}) {
                   2569:         $firsturl = $domdefaults{'portal_def'};
                   2570:     } else {
                   2571:         $firsturl = $protocol.'://'.$hostname;
                   2572:     }
                   2573:     return $firsturl;
                   2574: }
                   2575: 
1.344     www      2576: # --------------------------------------------------- Assign a key to a student
                   2577: 
                   2578: sub assign_access_key {
1.364     www      2579: #
                   2580: # a valid key looks like uname:udom#comments
                   2581: # comments are being appended
                   2582: #
1.498     www      2583:     my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
                   2584:     $kdom=
1.620     albertel 2585:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498     www      2586:     $knum=
1.620     albertel 2587:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344     www      2588:     $cdom=
1.620     albertel 2589:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2590:     $cnum=
1.620     albertel 2591:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   2592:     $udom=$env{'user.name'} unless (defined($udom));
                   2593:     $uname=$env{'user.domain'} unless (defined($uname));
1.498     www      2594:     my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364     www      2595:     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479     albertel 2596:         ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 
1.364     www      2597:                                                   # assigned to this person
                   2598:                                                   # - this should not happen,
1.345     www      2599:                                                   # unless something went wrong
                   2600:                                                   # the first time around
                   2601: # ready to assign
1.364     www      2602:         $logentry=$1.'; '.$logentry;
1.496     www      2603:         if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498     www      2604:                                                  $kdom,$knum) eq 'ok') {
1.345     www      2605: # key now belongs to user
1.346     www      2606: 	    my $envkey='key.'.$cdom.'_'.$cnum;
1.345     www      2607:             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949     raeburn  2608:                 &appenv({'environment.'.$envkey => $ckey});
1.345     www      2609:                 return 'ok';
                   2610:             } else {
                   2611:                 return 
                   2612:   'error: Count not permanently assign key, will need to be re-entered later.';
                   2613: 	    }
                   2614:         } else {
                   2615:             return 'error: Could not assign key, try again later.';
                   2616:         }
1.364     www      2617:     } elsif (!$existing{$ckey}) {
1.345     www      2618: # the key does not exist
                   2619: 	return 'error: The key does not exist';
                   2620:     } else {
                   2621: # the key is somebody else's
                   2622: 	return 'error: The key is already in use';
                   2623:     }
1.344     www      2624: }
                   2625: 
1.364     www      2626: # ------------------------------------------ put an additional comment on a key
                   2627: 
                   2628: sub comment_access_key {
                   2629: #
                   2630: # a valid key looks like uname:udom#comments
                   2631: # comments are being appended
                   2632: #
                   2633:     my ($ckey,$cdom,$cnum,$logentry)=@_;
                   2634:     $cdom=
1.620     albertel 2635:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364     www      2636:     $cnum=
1.620     albertel 2637:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364     www      2638:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
                   2639:     if ($existing{$ckey}) {
                   2640:         $existing{$ckey}.='; '.$logentry;
                   2641: # ready to assign
1.367     www      2642:         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364     www      2643:                                                  $cdom,$cnum) eq 'ok') {
                   2644: 	    return 'ok';
                   2645:         } else {
                   2646: 	    return 'error: Count not store comment.';
                   2647:         }
                   2648:     } else {
                   2649: # the key does not exist
                   2650: 	return 'error: The key does not exist';
                   2651:     }
                   2652: }
                   2653: 
1.344     www      2654: # ------------------------------------------------------ Generate a set of keys
                   2655: 
                   2656: sub generate_access_keys {
1.364     www      2657:     my ($number,$cdom,$cnum,$logentry)=@_;
1.344     www      2658:     $cdom=
1.620     albertel 2659:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2660:     $cnum=
1.620     albertel 2661:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361     www      2662:     unless (&allowed('mky',$cdom)) { return 0; }
1.344     www      2663:     unless (($cdom) && ($cnum)) { return 0; }
                   2664:     if ($number>10000) { return 0; }
                   2665:     sleep(2); # make sure don't get same seed twice
                   2666:     srand(time()^($$+($$<<15))); # from "Programming Perl"
                   2667:     my $total=0;
                   2668:     for (my $i=1;$i<=$number;$i++) {
                   2669:        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
                   2670:                   sprintf("%lx",int(100000*rand)).'-'.
                   2671:                   sprintf("%lx",int(100000*rand));
                   2672:        $newkey=~s/1/g/g; # folks mix up 1 and l
                   2673:        $newkey=~s/0/h/g; # and also 0 and O
                   2674:        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
                   2675:        if ($existing{$newkey}) {
                   2676:            $i--;
                   2677:        } else {
1.364     www      2678: 	  if (&put('accesskeys',
                   2679:               { $newkey => '# generated '.localtime().
1.620     albertel 2680:                            ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364     www      2681:                            '; '.$logentry },
                   2682: 		   $cdom,$cnum) eq 'ok') {
1.344     www      2683:               $total++;
                   2684: 	  }
                   2685:        }
                   2686:     }
1.620     albertel 2687:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344     www      2688:          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
                   2689:     return $total;
                   2690: }
                   2691: 
                   2692: # ------------------------------------------------------- Validate an accesskey
                   2693: 
                   2694: sub validate_access_key {
                   2695:     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
                   2696:     $cdom=
1.620     albertel 2697:    $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344     www      2698:     $cnum=
1.620     albertel 2699:    $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
                   2700:     $udom=$env{'user.domain'} unless (defined($udom));
                   2701:     $uname=$env{'user.name'} unless (defined($uname));
1.345     www      2702:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479     albertel 2703:     return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70      www      2704: }
                   2705: 
                   2706: # ------------------------------------- Find the section of student in a course
1.652     albertel 2707: sub devalidate_getsection_cache {
                   2708:     my ($udom,$unam,$courseid)=@_;
                   2709:     my $hashid="$udom:$unam:$courseid";
                   2710:     &devalidate_cache_new('getsection',$hashid);
                   2711: }
1.298     matthew  2712: 
1.815     albertel 2713: sub courseid_to_courseurl {
                   2714:     my ($courseid) = @_;
                   2715:     #already url style courseid
                   2716:     return $courseid if ($courseid =~ m{^/});
                   2717: 
                   2718:     if (exists($env{'course.'.$courseid.'.num'})) {
                   2719: 	my $cnum = $env{'course.'.$courseid.'.num'};
                   2720: 	my $cdom = $env{'course.'.$courseid.'.domain'};
                   2721: 	return "/$cdom/$cnum";
                   2722:     }
                   2723: 
                   2724:     my %courseinfo=&Apache::lonnet::coursedescription($courseid);
                   2725:     if (exists($courseinfo{'num'})) {
                   2726: 	return "/$courseinfo{'domain'}/$courseinfo{'num'}";
                   2727:     }
                   2728: 
                   2729:     return undef;
                   2730: }
                   2731: 
1.298     matthew  2732: sub getsection {
                   2733:     my ($udom,$unam,$courseid)=@_;
1.599     albertel 2734:     my $cachetime=1800;
1.551     albertel 2735: 
                   2736:     my $hashid="$udom:$unam:$courseid";
1.599     albertel 2737:     my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551     albertel 2738:     if (defined($cached)) { return $result; }
                   2739: 
1.298     matthew  2740:     my %Pending; 
                   2741:     my %Expired;
                   2742:     #
                   2743:     # Each role can either have not started yet (pending), be active, 
                   2744:     #    or have expired.
                   2745:     #
                   2746:     # If there is an active role, we are done.
                   2747:     #
                   2748:     # If there is more than one role which has not started yet, 
                   2749:     #     choose the one which will start sooner
                   2750:     # If there is one role which has not started yet, return it.
                   2751:     #
                   2752:     # If there is more than one expired role, choose the one which ended last.
                   2753:     # If there is a role which has expired, return it.
                   2754:     #
1.815     albertel 2755:     $courseid = &courseid_to_courseurl($courseid);
1.1166    raeburn  2756:     my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817     raeburn  2757:     foreach my $key (keys(%roleshash)) {
1.479     albertel 2758:         next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298     matthew  2759:         my $section=$1;
                   2760:         if ($key eq $courseid.'_st') { $section=''; }
1.817     raeburn  2761:         my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298     matthew  2762:         my $now=time;
1.548     albertel 2763:         if (defined($end) && $end && ($now > $end)) {
1.298     matthew  2764:             $Expired{$end}=$section;
                   2765:             next;
                   2766:         }
1.548     albertel 2767:         if (defined($start) && $start && ($now < $start)) {
1.298     matthew  2768:             $Pending{$start}=$section;
                   2769:             next;
                   2770:         }
1.599     albertel 2771:         return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298     matthew  2772:     }
                   2773:     #
                   2774:     # Presumedly there will be few matching roles from the above
                   2775:     # loop and the sorting time will be negligible.
                   2776:     if (scalar(keys(%Pending))) {
                   2777:         my ($time) = sort {$a <=> $b} keys(%Pending);
1.599     albertel 2778:         return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298     matthew  2779:     } 
                   2780:     if (scalar(keys(%Expired))) {
                   2781:         my @sorted = sort {$a <=> $b} keys(%Expired);
                   2782:         my $time = pop(@sorted);
1.599     albertel 2783:         return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298     matthew  2784:     }
1.599     albertel 2785:     return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298     matthew  2786: }
1.70      www      2787: 
1.599     albertel 2788: sub save_cache {
                   2789:     &purge_remembered();
1.722     albertel 2790:     #&Apache::loncommon::validate_page();
1.620     albertel 2791:     undef(%env);
1.780     albertel 2792:     undef($env_loaded);
1.599     albertel 2793: }
1.452     albertel 2794: 
1.599     albertel 2795: my $to_remember=-1;
                   2796: my %remembered;
                   2797: my %accessed;
                   2798: my $kicks=0;
                   2799: my $hits=0;
1.849     albertel 2800: sub make_key {
                   2801:     my ($name,$id) = @_;
1.872     albertel 2802:     if (length($id) > 65 
                   2803: 	&& length(&escape($id)) > 200) {
                   2804: 	$id=length($id).':'.&Digest::MD5::md5_hex($id);
                   2805:     }
1.849     albertel 2806:     return &escape($name.':'.$id);
                   2807: }
                   2808: 
1.599     albertel 2809: sub devalidate_cache_new {
                   2810:     my ($name,$id,$debug) = @_;
                   2811:     if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319    damieng  2812:     my $remembered_id=$name.':'.$id;
1.849     albertel 2813:     $id=&make_key($name,$id);
1.599     albertel 2814:     $memcache->delete($id);
1.1319    damieng  2815:     delete($remembered{$remembered_id});
                   2816:     delete($accessed{$remembered_id});
1.599     albertel 2817: }
                   2818: 
                   2819: sub is_cached_new {
                   2820:     my ($name,$id,$debug) = @_;
1.1319    damieng  2821:     my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
                   2822:     if (exists($remembered{$remembered_id})) {
                   2823: 	if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
                   2824: 	$accessed{$remembered_id}=[&gettimeofday()];
1.599     albertel 2825: 	$hits++;
1.1319    damieng  2826: 	return ($remembered{$remembered_id},1);
1.599     albertel 2827:     }
1.1319    damieng  2828:     $id=&make_key($name,$id);
1.599     albertel 2829:     my $value = $memcache->get($id);
                   2830:     if (!(defined($value))) {
                   2831: 	if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417     albertel 2832: 	return (undef,undef);
1.416     albertel 2833:     }
1.599     albertel 2834:     if ($value eq '__undef__') {
                   2835: 	if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
                   2836: 	$value=undef;
                   2837:     }
1.1319    damieng  2838:     &make_room($remembered_id,$value,$debug);
1.599     albertel 2839:     if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
                   2840:     return ($value,1);
                   2841: }
                   2842: 
                   2843: sub do_cache_new {
                   2844:     my ($name,$id,$value,$time,$debug) = @_;
1.1319    damieng  2845:     my $remembered_id=$name.':'.$id;
1.849     albertel 2846:     $id=&make_key($name,$id);
1.599     albertel 2847:     my $setvalue=$value;
                   2848:     if (!defined($setvalue)) {
                   2849: 	$setvalue='__undef__';
                   2850:     }
1.623     albertel 2851:     if (!defined($time) ) {
                   2852: 	$time=600;
                   2853:     }
1.599     albertel 2854:     if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910     albertel 2855:     my $result = $memcache->set($id,$setvalue,$time);
                   2856:     if (! $result) {
1.872     albertel 2857: 	&logthis("caching of id -> $id  failed");
1.910     albertel 2858: 	$memcache->disconnect_all();
1.872     albertel 2859:     }
1.600     albertel 2860:     # need to make a copy of $value
1.1319    damieng  2861:     &make_room($remembered_id,$value,$debug);
1.599     albertel 2862:     return $value;
                   2863: }
                   2864: 
                   2865: sub make_room {
1.1319    damieng  2866:     my ($remembered_id,$value,$debug)=@_;
1.919     albertel 2867: 
1.1319    damieng  2868:     $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919     albertel 2869:                                     : $value;
1.599     albertel 2870:     if ($to_remember<0) { return; }
1.1319    damieng  2871:     $accessed{$remembered_id}=[&gettimeofday()];
1.599     albertel 2872:     if (scalar(keys(%remembered)) <= $to_remember) { return; }
                   2873:     my $to_kick;
                   2874:     my $max_time=0;
                   2875:     foreach my $other (keys(%accessed)) {
                   2876: 	if (&tv_interval($accessed{$other}) > $max_time) {
                   2877: 	    $to_kick=$other;
                   2878: 	    $max_time=&tv_interval($accessed{$other});
                   2879: 	}
                   2880:     }
                   2881:     delete($remembered{$to_kick});
                   2882:     delete($accessed{$to_kick});
                   2883:     $kicks++;
                   2884:     if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541     albertel 2885:     return;
                   2886: }
                   2887: 
1.599     albertel 2888: sub purge_remembered {
1.604     albertel 2889:     #&logthis("Tossing ".scalar(keys(%remembered)));
                   2890:     #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599     albertel 2891:     undef(%remembered);
                   2892:     undef(%accessed);
1.428     albertel 2893: }
1.70      www      2894: # ------------------------------------- Read an entry from a user's environment
                   2895: 
                   2896: sub userenvironment {
                   2897:     my ($udom,$unam,@what)=@_;
1.976     raeburn  2898:     my $items;
                   2899:     foreach my $item (@what) {
                   2900:         $items.=&escape($item).'&';
                   2901:     }
                   2902:     $items=~s/\&$//;
1.70      www      2903:     my %returnhash=();
1.1009    raeburn  2904:     my $uhome = &homeserver($unam,$udom);
                   2905:     unless ($uhome eq 'no_host') {
                   2906:         my @answer=split(/\&/, 
                   2907:             &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048    raeburn  2908:         if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
                   2909:             return %returnhash;
                   2910:         }
1.1009    raeburn  2911:         my $i;
                   2912:         for ($i=0;$i<=$#what;$i++) {
                   2913: 	    $returnhash{$what[$i]}=&unescape($answer[$i]);
                   2914:         }
1.70      www      2915:     }
                   2916:     return %returnhash;
1.1       albertel 2917: }
                   2918: 
1.617     albertel 2919: # ---------------------------------------------------------- Get a studentphoto
                   2920: sub studentphoto {
                   2921:     my ($udom,$unam,$ext) = @_;
                   2922:     my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706     raeburn  2923:     if (defined($env{'request.course.id'})) {
1.708     raeburn  2924:         if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706     raeburn  2925:             if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
                   2926:                 return(&retrievestudentphoto($udom,$unam,$ext)); 
                   2927:             } else {
                   2928:                 my ($result,$perm_reqd)=
1.707     albertel 2929: 		    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  2930:                 if ($result eq 'ok') {
                   2931:                     if (!($perm_reqd eq 'yes')) {
                   2932:                         return(&retrievestudentphoto($udom,$unam,$ext));
                   2933:                     }
                   2934:                 }
                   2935:             }
                   2936:         }
                   2937:     } else {
                   2938:         my ($result,$perm_reqd) = 
1.707     albertel 2939: 	    &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706     raeburn  2940:         if ($result eq 'ok') {
                   2941:             if (!($perm_reqd eq 'yes')) {
                   2942:                 return(&retrievestudentphoto($udom,$unam,$ext));
                   2943:             }
                   2944:         }
                   2945:     }
                   2946:     return '/adm/lonKaputt/lonlogo_broken.gif';
                   2947: }
                   2948: 
                   2949: sub retrievestudentphoto {
                   2950:     my ($udom,$unam,$ext,$type) = @_;
                   2951:     my $home=&Apache::lonnet::homeserver($unam,$udom);
                   2952:     my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
                   2953:     if ($ret eq 'ok') {
                   2954:         my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
                   2955:         if ($type eq 'thumbnail') {
                   2956:             $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 
                   2957:         }
                   2958:         my $tokenurl=&Apache::lonnet::tokenwrapper($url);
                   2959:         return $tokenurl;
                   2960:     } else {
                   2961:         if ($type eq 'thumbnail') {
                   2962:             return '/adm/lonKaputt/genericstudent_tn.gif';
                   2963:         } else { 
                   2964:             return '/adm/lonKaputt/lonlogo_broken.gif';
                   2965:         }
1.617     albertel 2966:     }
                   2967: }
                   2968: 
1.263     www      2969: # -------------------------------------------------------------------- New chat
                   2970: 
                   2971: sub chatsend {
1.724     raeburn  2972:     my ($newentry,$anon,$group)=@_;
1.620     albertel 2973:     my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
                   2974:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   2975:     my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263     www      2976:     &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620     albertel 2977: 	   &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724     raeburn  2978: 		   &escape($newentry)).':'.$group,$chome);
1.292     www      2979: }
                   2980: 
                   2981: # ------------------------------------------ Find current version of a resource
                   2982: 
                   2983: sub getversion {
                   2984:     my $fname=&clutter(shift);
1.1189    raeburn  2985:     unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292     www      2986:     return &currentversion(&filelocation('',$fname));
                   2987: }
                   2988: 
                   2989: sub currentversion {
                   2990:     my $fname=shift;
                   2991:     my $author=$fname;
                   2992:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   2993:     my ($udom,$uname)=split(/\//,$author);
1.1112    www      2994:     my $home=&homeserver($uname,$udom);
1.292     www      2995:     if ($home eq 'no_host') { 
                   2996:         return -1; 
                   2997:     }
1.1112    www      2998:     my $answer=&reply("currentversion:$fname",$home);
1.292     www      2999:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   3000: 	return -1;
                   3001:     }
1.1112    www      3002:     return $answer;
1.263     www      3003: }
                   3004: 
1.1111    www      3005: #
                   3006: # Return special version number of resource if set by override, empty otherwise
                   3007: #
                   3008: sub usedversion {
                   3009:     my $fname=shift;
                   3010:     unless ($fname) { $fname=$env{'request.uri'}; }
                   3011:     my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
                   3012:     if ($urlversion) { return $urlversion; }
                   3013:     return '';
                   3014: }
                   3015: 
1.1       albertel 3016: # ----------------------------- Subscribe to a resource, return URL if possible
1.11      www      3017: 
1.1       albertel 3018: sub subscribe {
                   3019:     my $fname=shift;
1.761     raeburn  3020:     if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532     albertel 3021:     $fname=~s/[\n\r]//g;
1.1       albertel 3022:     my $author=$fname;
                   3023:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   3024:     my ($udom,$uname)=split(/\//,$author);
                   3025:     my $home=homeserver($uname,$udom);
1.335     albertel 3026:     if ($home eq 'no_host') {
                   3027:         return 'not_found';
1.1       albertel 3028:     }
                   3029:     my $answer=reply("sub:$fname",$home);
1.64      www      3030:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                   3031: 	$answer.=' by '.$home;
                   3032:     }
1.1       albertel 3033:     return $answer;
                   3034: }
                   3035:     
1.8       www      3036: # -------------------------------------------------------------- Replicate file
                   3037: 
                   3038: sub repcopy {
                   3039:     my $filename=shift;
1.23      www      3040:     $filename=~s/\/+/\//g;
1.1142    raeburn  3041:     my $londocroot = $perlvar{'lonDocRoot'};
                   3042:     if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164    raeburn  3043:     if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142    raeburn  3044:     if ($filename=~m{^\Q$londocroot/userfiles/\E} or
                   3045: 	$filename=~m{^/*(uploaded|editupload)/}) {
1.538     albertel 3046: 	return &repcopy_userfile($filename);
                   3047:     }
1.532     albertel 3048:     $filename=~s/[\n\r]//g;
1.8       www      3049:     my $transname="$filename.in.transfer";
1.828     www      3050: # FIXME: this should flock
1.607     raeburn  3051:     if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8       www      3052:     my $remoteurl=subscribe($filename);
1.64      www      3053:     if ($remoteurl =~ /^con_lost by/) {
                   3054: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  3055:            return 'unavailable';
1.8       www      3056:     } elsif ($remoteurl eq 'not_found') {
1.441     albertel 3057: 	   #&logthis("Subscribe returned not_found: $filename");
1.607     raeburn  3058: 	   return 'not_found';
1.64      www      3059:     } elsif ($remoteurl =~ /^rejected by/) {
                   3060: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.607     raeburn  3061:            return 'forbidden';
1.20      www      3062:     } elsif ($remoteurl eq 'directory') {
1.607     raeburn  3063:            return 'ok';
1.8       www      3064:     } else {
1.290     www      3065:         my $author=$filename;
                   3066:         $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                   3067:         my ($udom,$uname)=split(/\//,$author);
                   3068:         my $home=homeserver($uname,$udom);
                   3069:         unless ($home eq $perlvar{'lonHostID'}) {
1.8       www      3070:            my @parts=split(/\//,$filename);
                   3071:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142    raeburn  3072:            if ($path ne "$londocroot/res") {
1.8       www      3073:                &logthis("Malconfiguration for replication: $filename");
1.607     raeburn  3074: 	       return 'bad_request';
1.8       www      3075:            }
                   3076:            my $count;
                   3077:            for ($count=5;$count<$#parts;$count++) {
                   3078:                $path.="/$parts[$count]";
                   3079:                if ((-e $path)!=1) {
                   3080: 		   mkdir($path,0777);
                   3081:                }
                   3082:            }
                   3083:            my $request=new HTTP::Request('GET',"$remoteurl");
1.1345    raeburn  3084:            my $response;
                   3085:            if ($remoteurl =~ m{/raw/}) {
                   3086:                $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
                   3087:            } else {
                   3088:                $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
                   3089:            }
1.8       www      3090:            if ($response->is_error()) {
                   3091: 	       unlink($transname);
                   3092:                my $message=$response->status_line;
1.672     albertel 3093:                &logthis("<font color=\"blue\">WARNING:"
1.12      www      3094:                        ." LWP get: $message: $filename</font>");
1.607     raeburn  3095:                return 'unavailable';
1.8       www      3096:            } else {
1.16      www      3097: 	       if ($remoteurl!~/\.meta$/) {
                   3098:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345    raeburn  3099:                   my $mresponse;
                   3100:                   if ($remoteurl =~ m{/raw/}) {
                   3101:                       $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
                   3102:                   } else {
                   3103:                       $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
                   3104:                   }
1.16      www      3105:                   if ($mresponse->is_error()) {
                   3106: 		      unlink($filename.'.meta');
                   3107:                       &logthis(
1.672     albertel 3108:                      "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16      www      3109:                   }
                   3110: 	       }
1.8       www      3111:                rename($transname,$filename);
1.607     raeburn  3112:                return 'ok';
1.8       www      3113:            }
1.290     www      3114:        }
1.8       www      3115:     }
1.330     www      3116: }
                   3117: 
                   3118: # ------------------------------------------------ Get server side include body
                   3119: sub ssi_body {
1.381     albertel 3120:     my ($filelink,%form)=@_;
1.606     matthew  3121:     if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
                   3122:         $form{'LONCAPA_INTERNAL_no_discussion'}='true';
                   3123:     }
1.953     www      3124:     my $output='';
                   3125:     my $response;
1.980     raeburn  3126:     if ($filelink=~/^https?\:/) {
1.954     raeburn  3127:        ($output,$response)=&externalssi($filelink);
1.953     www      3128:     } else {
1.1004    droeschl 3129:        $filelink .= $filelink=~/\?/ ? '&' : '?';
                   3130:        $filelink .= 'inhibitmenu=yes';
1.953     www      3131:        ($output,$response)=&ssi($filelink,%form);
                   3132:     }
1.778     albertel 3133:     $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451     albertel 3134:     $output=~s/^.*?\<body[^\>]*\>//si;
1.930     albertel 3135:     $output=~s/\<\/body\s*\>.*?$//si;
1.953     www      3136:     if (wantarray) {
                   3137:         return ($output, $response);
                   3138:     } else {
                   3139:         return $output;
                   3140:     }
1.8       www      3141: }
                   3142: 
1.15      www      3143: # --------------------------------------------------------- Server Side Include
                   3144: 
1.782     albertel 3145: sub absolute_url {
                   3146:     my ($host_name) = @_;
                   3147:     my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
                   3148:     if ($host_name eq '') {
                   3149: 	$host_name = $ENV{'SERVER_NAME'};
                   3150:     }
                   3151:     return $protocol.$host_name;
                   3152: }
                   3153: 
1.942     foxr     3154: #
                   3155: #   Server side include.
                   3156: # Parameters:
                   3157: #  fn     Possibly encrypted resource name/id.
                   3158: #  form   Hash that describes how the rendering should be done
                   3159: #         and other things.
1.944     foxr     3160: # Returns:
1.950     raeburn  3161: #   Scalar context: The content of the response.
                   3162: #   Array context:  2 element list of the content and the full response object.
1.942     foxr     3163: #     
1.15      www      3164: sub ssi {
                   3165: 
1.944     foxr     3166:     my ($fn,%form)=@_;
1.23      www      3167:     my $request;
1.711     albertel 3168: 
                   3169:     $form{'no_update_last_known'}=1;
1.895     albertel 3170:     &Apache::lonenc::check_encrypt(\$fn);
1.23      www      3171:     if (%form) {
1.782     albertel 3172:       $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1272    droeschl 3173:       $request->content(join('&',map { 
                   3174:             my $name = escape($_);
                   3175:             "$name=" . ( ref($form{$_}) eq 'ARRAY' 
                   3176:             ? join("&$name=", map {escape($_) } @{$form{$_}}) 
                   3177:             : &escape($form{$_}) );    
                   3178:         } keys(%form)));
1.23      www      3179:     } else {
1.782     albertel 3180:       $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23      www      3181:     }
                   3182: 
1.15      www      3183:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345    raeburn  3184:     my $lonhost = $perlvar{'lonHostID'};
                   3185:     my $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar);
1.1182    foxr     3186: 
1.944     foxr     3187:     if (wantarray) {
1.1345    raeburn  3188: 	return ($response->content, $response);
1.944     foxr     3189:     } else {
1.1345    raeburn  3190: 	return $response->content;
1.942     foxr     3191:     }
1.324     www      3192: }
                   3193: 
                   3194: sub externalssi {
                   3195:     my ($url)=@_;
                   3196:     my $request=new HTTP::Request('GET',$url);
1.1345    raeburn  3197:     my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954     raeburn  3198:     if (wantarray) {
                   3199:         return ($response->content, $response);
                   3200:     } else {
                   3201:         return $response->content;
                   3202:     }
1.15      www      3203: }
1.254     www      3204: 
1.1354    raeburn  3205: 
                   3206: # If the local copy of a replicated resource is outdated, trigger a  
                   3207: # connection from the homeserver to flush the delayed queue. If no update 
                   3208: # happens, remove local copies of outdated resource (and corresponding
                   3209: # metadata file).
                   3210: 
1.1352    raeburn  3211: sub remove_stale_resfile {
                   3212:     my ($url) = @_;
1.1354    raeburn  3213:     my $removed;
1.1352    raeburn  3214:     if ($url=~m{^/res/($match_domain)/($match_username)/}) {
                   3215:         my $audom = $1;
                   3216:         my $auname = $2;
1.1353    raeburn  3217:         unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352    raeburn  3218:             my $homeserver = &homeserver($auname,$audom);
                   3219:             unless (($homeserver eq 'no_host') ||
                   3220:                     (grep { $_ eq $homeserver } &current_machine_ids())) {
                   3221:                 my $fname = &filelocation('',$url);
                   3222:                 if (-e $fname) {
                   3223:                     my $protocol = $protocol{$homeserver};
                   3224:                     $protocol = 'http' if ($protocol ne 'https');
                   3225:                     my $hostname = &hostname($homeserver);
                   3226:                     if ($hostname) {
                   3227:                         my $uri = &declutter($url);
                   3228:                         my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
                   3229:                         my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
                   3230:                         if ($response->is_success()) {
                   3231:                             my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
                   3232:                             my $locmodtime = (stat($fname))[9];
                   3233:                             if ($locmodtime < $remmodtime) {
1.1354    raeburn  3234:                                 my $stale;
                   3235:                                 my $answer = &reply('pong',$homeserver);
                   3236:                                 if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
                   3237:                                     sleep(0.2);
                   3238:                                     $locmodtime = (stat($fname))[9];
                   3239:                                     if ($locmodtime < $remmodtime) {
                   3240:                                         my $posstransfer = $fname.'.in.transfer';
                   3241:                                         if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
                   3242:                                             $removed = 1;
                   3243:                                         } else {
                   3244:                                             $stale = 1;
                   3245:                                         }
                   3246:                                     } else {
                   3247:                                         $removed = 1;
                   3248:                                     }
                   3249:                                 } else {
                   3250:                                     $stale = 1;
                   3251:                                 }
                   3252:                                 if ($stale) {
                   3253:                                     unlink($fname);
                   3254:                                     if ($uri!~/\.meta$/) {
                   3255:                                         unlink($fname.'.meta');
                   3256:                                     }
                   3257:                                     &reply("unsub:$fname",$homeserver);
                   3258:                                     $removed = 1;
1.1352    raeburn  3259:                                 }
                   3260:                             }
                   3261:                         }
                   3262:                     }
                   3263:                 }
                   3264:             }
                   3265:         }
                   3266:     }
1.1354    raeburn  3267:     return $removed;
1.1352    raeburn  3268: }
                   3269: 
1.492     albertel 3270: # -------------------------------- Allow a /uploaded/ URI to be vouched for
                   3271: 
                   3272: sub allowuploaded {
                   3273:     my ($srcurl,$url)=@_;
                   3274:     $url=&clutter(&declutter($url));
                   3275:     my $dir=$url;
                   3276:     $dir=~s/\/[^\/]+$//;
                   3277:     my %httpref=();
                   3278:     my $httpurl=&hreflocation('',$url);
                   3279:     $httpref{'httpref.'.$httpurl}=$srcurl;
1.949     raeburn  3280:     &Apache::lonnet::appenv(\%httpref);
1.254     www      3281: }
1.477     raeburn  3282: 
1.1193    raeburn  3283: #
                   3284: # Determine if the current user should be able to edit a particular resource,
                   3285: # when viewing in course context.
                   3286: # (a) When viewing resource used to determine if "Edit" item is included in 
                   3287: #     Functions.
                   3288: # (b) When displaying folder contents in course editor, used to determine if
                   3289: #     "Edit" link will be displayed alongside resource.
                   3290: #
1.1196    raeburn  3291: #  input: six args -- filename (decluttered), course number, course domain,
                   3292: #                   url, symb (if registered) and group (if this is a group
                   3293: #                   item -- e.g., bulletin board, group page etc.).
                   3294: #  output: array of five scalars -- 
1.1193    raeburn  3295: #          $cfile -- url for file editing if editable on current server
                   3296: #          $home -- homeserver of resource (i.e., for author if published,
                   3297: #                                           or course if uploaded.).
                   3298: #          $switchserver --  1 if server switch will be needed.
1.1196    raeburn  3299: #          $forceedit -- 1 if icon/link should be to go to edit mode 
                   3300: #          $forceview -- 1 if icon/link should be to go to view mode
1.1193    raeburn  3301: #
                   3302: 
                   3303: sub can_edit_resource {
1.1194    raeburn  3304:     my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
                   3305:     my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
                   3306: #
                   3307: # For aboutme pages user can only edit his/her own.
                   3308: #
1.1199    raeburn  3309:     if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194    raeburn  3310:         my ($sdom,$sname) = ($1,$2);
                   3311:         if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
                   3312:             $home = $env{'user.home'};
                   3313:             $cfile = $resurl;
                   3314:             if ($env{'form.forceedit'}) {
                   3315:                 $forceview = 1;
                   3316:             } else {
                   3317:                 $forceedit = 1;
                   3318:             }
                   3319:             return ($cfile,$home,$switchserver,$forceedit,$forceview);
                   3320:         } else {
                   3321:             return;
                   3322:         }
                   3323:     }
                   3324: 
                   3325:     if ($env{'request.course.id'}) {
                   3326:         my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
                   3327:         if ($group ne '') {
                   3328: # if this is a group homepage or group bulletin board, check group privs
                   3329:             my $allowed = 0;
1.1197    raeburn  3330:             if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
                   3331:                 if ((&allowed('mdg',$env{'request.course.id'}.
1.1198    raeburn  3332:                               ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194    raeburn  3333:                         (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
                   3334:                     $allowed = 1;
                   3335:                 }
1.1197    raeburn  3336:             } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
                   3337:                 if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
                   3338:                         (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194    raeburn  3339:                     $allowed = 1;
                   3340:                 }
                   3341:             }
                   3342:             if ($allowed) {
                   3343:                 $home=&homeserver($cnum,$cdom);
                   3344:                 if ($env{'form.forceedit'}) {
                   3345:                     $forceview = 1;
                   3346:                 } else {
                   3347:                     $forceedit = 1;
                   3348:                 }
                   3349:                 $cfile = $resurl;
                   3350:             } else {
                   3351:                 return;
                   3352:             }
                   3353:         } else {
1.1208    raeburn  3354:             if ($resurl =~ m{^/?adm/viewclasslist$}) {
                   3355:                 unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
                   3356:                     return;
                   3357:                 }
                   3358:             } elsif (!$crsedit) {
1.1194    raeburn  3359: #
                   3360: # No edit allowed where CC has switched to student role.
                   3361: #
                   3362:                 return;
                   3363:             }
                   3364:         }
                   3365:     }
                   3366: 
1.1193    raeburn  3367:     if ($file ne '') {
                   3368:         if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194    raeburn  3369:             if (&is_course_upload($file,$cnum,$cdom)) {
                   3370:                 $uploaded = 1;
                   3371:                 $incourse = 1;
1.1193    raeburn  3372:                 if ($file =~/\.(htm|html|css|js|txt)$/) {
                   3373:                     $cfile = &hreflocation('',$file);
1.1201    raeburn  3374:                     if ($env{'form.forceedit'}) {
                   3375:                         $forceview = 1;
                   3376:                     } else {
                   3377:                         $forceedit = 1;
                   3378:                     }
1.1194    raeburn  3379:                 }
                   3380:             } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
                   3381:                 $incourse = 1;
                   3382:                 if ($env{'form.forceedit'}) {
                   3383:                     $forceview = 1;
                   3384:                 } else {
                   3385:                     $forceedit = 1;
                   3386:                 }
                   3387:                 $cfile = $resurl;
                   3388:             } elsif (($resurl ne '') && (&is_on_map($resurl))) { 
                   3389:                 if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
                   3390:                     $incourse = 1;
                   3391:                     if ($env{'form.forceedit'}) {
                   3392:                         $forceview = 1;
                   3393:                     } else {
                   3394:                         $forceedit = 1;
                   3395:                     }
                   3396:                     $cfile = $resurl;
1.1199    raeburn  3397:                 } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194    raeburn  3398:                     $incourse = 1;
                   3399:                     $cfile = $resurl.'/smpedit';
1.1199    raeburn  3400:                 } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194    raeburn  3401:                     $incourse = 1;
1.1199    raeburn  3402:                     if ($env{'form.forceedit'}) {
                   3403:                         $forceview = 1;
                   3404:                     } else {
                   3405:                         $forceedit = 1;
                   3406:                     }
                   3407:                     $cfile = $resurl;
1.1343    raeburn  3408:                 } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298    raeburn  3409:                     $incourse = 1;
                   3410:                     if ($env{'form.forceedit'}) {
                   3411:                         $forceview = 1;
                   3412:                     } else {
                   3413:                         $forceedit = 1;
                   3414:                     }
                   3415:                     $cfile = $resurl;
1.1208    raeburn  3416:                 } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
                   3417:                     $incourse = 1;
                   3418:                     if ($env{'form.forceedit'}) {
                   3419:                         $forceview = 1;
                   3420:                     } else {
                   3421:                         $forceedit = 1;
                   3422:                     }
                   3423:                     $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194    raeburn  3424:                 }
                   3425:             } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
                   3426:                 my $template = '/res/lib/templates/simpleproblem.problem';
                   3427:                 if (&is_on_map($template)) { 
                   3428:                     $incourse = 1;
                   3429:                     $forceview = 1;
                   3430:                     $cfile = $template;
1.1193    raeburn  3431:                 }
1.1199    raeburn  3432:             } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
                   3433:                     $incourse = 1;
                   3434:                     if ($env{'form.forceedit'}) {
                   3435:                         $forceview = 1;
                   3436:                     } else {
                   3437:                         $forceedit = 1;
                   3438:                     }
                   3439:                     $cfile = $resurl;
1.1343    raeburn  3440:             } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298    raeburn  3441:                 $incourse = 1;
                   3442:                 if ($env{'form.forceedit'}) {
                   3443:                     $forceview = 1;
                   3444:                 } else {
                   3445:                     $forceedit = 1;
                   3446:                 }
                   3447:                 $cfile = $resurl;
1.1199    raeburn  3448:             } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
                   3449:                 $incourse = 1;
                   3450:                 $forceview = 1;
                   3451:                 if ($symb) {
                   3452:                     my ($map,$id,$res)=&decode_symb($symb);
                   3453:                     $env{'request.symb'} = $symb;
                   3454:                     $cfile = &clutter($res);
                   3455:                 } else {
                   3456:                     $cfile = $env{'form.suppurl'};
1.1298    raeburn  3457:                     my $escfile = &unescape($cfile);
1.1343    raeburn  3458:                     if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298    raeburn  3459:                         $cfile = '/adm/wrapper'.$escfile;
                   3460:                     } else {
                   3461:                         $escfile =~ s{^http://}{};
                   3462:                         $cfile = &escape("/adm/wrapper/ext/$escfile");
                   3463:                     }
1.1199    raeburn  3464:                 }
1.1234    raeburn  3465:             } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
                   3466:                 if ($env{'form.forceedit'}) {
                   3467:                     $forceview = 1;
                   3468:                 } else {
                   3469:                     $forceedit = 1;
                   3470:                 }
                   3471:                 $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193    raeburn  3472:             }
                   3473:         }
1.1194    raeburn  3474:         if ($uploaded || $incourse) {
                   3475:             $home=&homeserver($cnum,$cdom);
1.1207    raeburn  3476:         } elsif ($file !~ m{/$}) {
1.1193    raeburn  3477:             $file=~s{^(priv/$match_domain/$match_username)}{/$1};
                   3478:             $file=~s{^($match_domain/$match_username)}{/priv/$1};
                   3479:             # Check that the user has permission to edit this resource
                   3480:             my $setpriv = 1;
                   3481:             my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
                   3482:             if (defined($cfudom)) {
                   3483:                 $home=&homeserver($cfuname,$cfudom);
                   3484:                 $cfile=$file;
                   3485:             }
                   3486:         }
1.1194    raeburn  3487:         if (($cfile ne '') && (!$incourse || $uploaded) && 
                   3488:             (($home ne '') && ($home ne 'no_host'))) {
1.1193    raeburn  3489:             my @ids=&current_machine_ids();
                   3490:             unless (grep(/^\Q$home\E$/,@ids)) {
                   3491:                 $switchserver=1;
                   3492:             }
                   3493:         }
                   3494:     }
1.1194    raeburn  3495:     return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193    raeburn  3496: }
                   3497: 
                   3498: sub is_course_upload {
                   3499:     my ($file,$cnum,$cdom) = @_;
                   3500:     my $uploadpath = &LONCAPA::propath($cdom,$cnum);
                   3501:     $uploadpath =~ s{^\/}{};
1.1201    raeburn  3502:     if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
                   3503:         ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193    raeburn  3504:         return 1;
                   3505:     }
                   3506:     return;
                   3507: }
                   3508: 
1.1194    raeburn  3509: sub in_course {
1.1195    raeburn  3510:     my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
                   3511:     if ($hideprivileged) {
                   3512:         my $skipuser;
1.1219    raeburn  3513:         my %coursehash = &coursedescription($cdom.'_'.$cnum);
                   3514:         my @possdoms = ($cdom);  
                   3515:         if ($coursehash{'checkforpriv'}) { 
                   3516:             push(@possdoms,split(/,/,$coursehash{'checkforpriv'})); 
                   3517:         }
                   3518:         if (&privileged($uname,$udom,\@possdoms)) {
1.1195    raeburn  3519:             $skipuser = 1;
                   3520:             if ($coursehash{'nothideprivileged'}) {
                   3521:                 foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   3522:                     my $user;
                   3523:                     if ($item =~ /:/) {
                   3524:                         $user = $item;
                   3525:                     } else {
                   3526:                         $user = join(':',split(/[\@]/,$item));
                   3527:                     }
                   3528:                     if ($user eq $uname.':'.$udom) {
                   3529:                         undef($skipuser);
                   3530:                         last;
                   3531:                     }
                   3532:                 }
                   3533:             }
                   3534:             if ($skipuser) {
                   3535:                 return 0;
                   3536:             }
                   3537:         }
                   3538:     }
1.1194    raeburn  3539:     $type ||= 'any';
                   3540:     if (!defined($cdom) || !defined($cnum)) {
                   3541:         my $cid  = $env{'request.course.id'};
                   3542:         $cdom = $env{'course.'.$cid.'.domain'};
                   3543:         $cnum = $env{'course.'.$cid.'.num'};
                   3544:     }
                   3545:     my $typesref;
1.1195    raeburn  3546:     if (($type eq 'any') || ($type eq 'all')) {
1.1194    raeburn  3547:         $typesref = ['active','previous','future'];
                   3548:     } elsif ($type eq 'previous' || $type eq 'future') {
                   3549:         $typesref = [$type];
                   3550:     }
                   3551:     my %roles = &get_my_roles($uname,$udom,'userroles',
                   3552:                               $typesref,undef,[$cdom]);
                   3553:     my ($tmp) = keys(%roles);
                   3554:     return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
                   3555:     my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
                   3556:     if (@course_roles > 0) {
                   3557:         return 1;
                   3558:     }
                   3559:     return 0;
                   3560: }
                   3561: 
1.478     albertel 3562: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638     albertel 3563: # input: action, courseID, current domain, intended
1.637     raeburn  3564: #        path to file, source of file, instruction to parse file for objects,
                   3565: #        ref to hash for embedded objects,
                   3566: #        ref to hash for codebase of java objects.
1.1095    raeburn  3567: #        reference to scalar to accommodate mime type determined
                   3568: #          from File::MMagic if $parser = parse.
1.637     raeburn  3569: #
1.485     raeburn  3570: # output: url to file (if action was uploaddoc), 
                   3571: #         ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477     raeburn  3572: #
1.478     albertel 3573: # Allows directory structure to be used within lonUsers/../userfiles/ for a 
                   3574: # course.
1.477     raeburn  3575: #
1.478     albertel 3576: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   3577: #          will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
                   3578: #          course's home server.
1.477     raeburn  3579: #
1.478     albertel 3580: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
                   3581: #          be copied from $source (current location) to 
                   3582: #          /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   3583: #         and will then be copied to
                   3584: #          /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
                   3585: #         course's home server.
1.485     raeburn  3586: #
1.481     raeburn  3587: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620     albertel 3588: #         will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481     raeburn  3589: #         /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
                   3590: #         and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
                   3591: #         in course's home server.
1.637     raeburn  3592: #
1.477     raeburn  3593: 
                   3594: sub process_coursefile {
1.1095    raeburn  3595:     my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
                   3596:         $mimetype)=@_;
1.477     raeburn  3597:     my $fetchresult;
1.638     albertel 3598:     my $home=&homeserver($docuname,$docudom);
1.477     raeburn  3599:     if ($action eq 'propagate') {
1.638     albertel 3600:         $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
                   3601: 			     $home);
1.481     raeburn  3602:     } else {
1.477     raeburn  3603:         my $fpath = '';
                   3604:         my $fname = $file;
1.478     albertel 3605:         ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477     raeburn  3606:         $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637     raeburn  3607:         my $filepath = &build_filepath($fpath);
1.481     raeburn  3608:         if ($action eq 'copy') {
                   3609:             if ($source eq '') {
                   3610:                 $fetchresult = 'no source file';
                   3611:                 return $fetchresult;
                   3612:             } else {
                   3613:                 my $destination = $filepath.'/'.$fname;
                   3614:                 rename($source,$destination);
                   3615:                 $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 3616:                                  $home);
1.481     raeburn  3617:             }
                   3618:         } elsif ($action eq 'uploaddoc') {
1.1359    raeburn  3619:             open(my $fh,'>',$filepath.'/'.$fname);
1.620     albertel 3620:             print $fh $env{'form.'.$source};
1.481     raeburn  3621:             close($fh);
1.637     raeburn  3622:             if ($parser eq 'parse') {
1.1024    raeburn  3623:                 my $mm = new File::MMagic;
1.1095    raeburn  3624:                 my $type = $mm->checktype_filename($filepath.'/'.$fname);
                   3625:                 if ($type eq 'text/html') {
1.1024    raeburn  3626:                     my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
                   3627:                     unless ($parse_result eq 'ok') {
                   3628:                         &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
                   3629:                     }
1.637     raeburn  3630:                 }
1.1095    raeburn  3631:                 if (ref($mimetype)) {
                   3632:                     $$mimetype = $type;
                   3633:                 } 
1.637     raeburn  3634:             }
1.477     raeburn  3635:             $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 3636:                                  $home);
1.481     raeburn  3637:             if ($fetchresult eq 'ok') {
                   3638:                 return '/uploaded/'.$fpath.'/'.$fname;
                   3639:             } else {
                   3640:                 &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 3641:                         ' to host '.$home.': '.$fetchresult);
1.481     raeburn  3642:                 return '/adm/notfound.html';
                   3643:             }
1.477     raeburn  3644:         }
                   3645:     }
1.485     raeburn  3646:     unless ( $fetchresult eq 'ok') {
1.477     raeburn  3647:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638     albertel 3648:              ' to host '.$home.': '.$fetchresult);
1.477     raeburn  3649:     }
                   3650:     return $fetchresult;
                   3651: }
                   3652: 
1.637     raeburn  3653: sub build_filepath {
                   3654:     my ($fpath) = @_;
                   3655:     my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
                   3656:     unless ($fpath eq '') {
                   3657:         my @parts=split('/',$fpath);
                   3658:         foreach my $part (@parts) {
                   3659:             $filepath.= '/'.$part;
                   3660:             if ((-e $filepath)!=1) {
                   3661:                 mkdir($filepath,0777);
                   3662:             }
                   3663:         }
                   3664:     }
                   3665:     return $filepath;
                   3666: }
                   3667: 
                   3668: sub store_edited_file {
1.638     albertel 3669:     my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637     raeburn  3670:     my $file = $primary_url;
                   3671:     $file =~ s#^/uploaded/$docudom/$docuname/##;
                   3672:     my $fpath = '';
                   3673:     my $fname = $file;
                   3674:     ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
                   3675:     $fpath=$docudom.'/'.$docuname.'/'.$fpath;
                   3676:     my $filepath = &build_filepath($fpath);
1.1359    raeburn  3677:     open(my $fh,'>',$filepath.'/'.$fname);
1.637     raeburn  3678:     print $fh $content;
                   3679:     close($fh);
1.638     albertel 3680:     my $home=&homeserver($docuname,$docudom);
1.637     raeburn  3681:     $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638     albertel 3682: 			  $home);
1.637     raeburn  3683:     if ($$fetchresult eq 'ok') {
                   3684:         return '/uploaded/'.$fpath.'/'.$fname;
                   3685:     } else {
1.638     albertel 3686:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
                   3687: 		 ' to host '.$home.': '.$$fetchresult);
1.637     raeburn  3688:         return '/adm/notfound.html';
                   3689:     }
                   3690: }
                   3691: 
1.531     albertel 3692: sub clean_filename {
1.831     albertel 3693:     my ($fname,$args)=@_;
1.315     www      3694: # Replace Windows backslashes by forward slashes
1.257     www      3695:     $fname=~s/\\/\//g;
1.831     albertel 3696:     if (!$args->{'keep_path'}) {
                   3697:         # Get rid of everything but the actual filename
                   3698: 	$fname=~s/^.*\/([^\/]+)$/$1/;
                   3699:     }
1.315     www      3700: # Replace spaces by underscores
                   3701:     $fname=~s/\s+/\_/g;
                   3702: # Replace all other weird characters by nothing
1.831     albertel 3703:     $fname=~s{[^/\w\.\-]}{}g;
1.540     albertel 3704: # Replace all .\d. sequences with _\d. so they no longer look like version
                   3705: # numbers
                   3706:     $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531     albertel 3707:     return $fname;
                   3708: }
1.1051    raeburn  3709: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 
                   3710: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 
                   3711: # image with the same aspect ratio as the original, but with dimensions which do 
                   3712: # not exceed $resizewidth and $resizeheight.
                   3713:  
1.984     neumanie 3714: sub resizeImage {
1.1051    raeburn  3715:     my ($img_path,$resizewidth,$resizeheight) = @_;
                   3716:     my $ima = Image::Magick->new;
                   3717:     my $resized;
                   3718:     if (-e $img_path) {
                   3719:         $ima->Read($img_path);
                   3720:         if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
                   3721:             my $width = $ima->Get('width');
                   3722:             my $height = $ima->Get('height');
                   3723:             if ($width > $resizewidth) {
                   3724: 	        my $factor = $width/$resizewidth;
                   3725:                 my $newheight = $height/$factor;
                   3726:                 $ima->Scale(width=>$resizewidth,height=>$newheight);
                   3727:                 $resized = 1;
                   3728:             }
                   3729:         }
                   3730:         if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
                   3731:             my $width = $ima->Get('width');
                   3732:             my $height = $ima->Get('height');
                   3733:             if ($height > $resizeheight) {
                   3734:                 my $factor = $height/$resizeheight;
                   3735:                 my $newwidth = $width/$factor;
                   3736:                 $ima->Scale(width=>$newwidth,height=>$resizeheight);
                   3737:                 $resized = 1;
                   3738:             }
                   3739:         }
                   3740:         if ($resized) {
                   3741:             $ima->Write($img_path);
                   3742:         }
                   3743:     }
                   3744:     return;
1.977     amueller 3745: }
                   3746: 
1.608     albertel 3747: # --------------- Take an uploaded file and put it into the userfiles directory
1.686     albertel 3748: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093    raeburn  3749: #                    the desired filename is in $env{"form.$formname.filename"}
1.1090    raeburn  3750: #        $context - possible values: coursedoc, existingfile, overwrite, 
                   3751: #                                    canceloverwrite, or ''. 
                   3752: #                   if 'coursedoc': upload to the current course
                   3753: #                   if 'existingfile': write file to tmp/overwrites directory 
                   3754: #                   if 'canceloverwrite': delete file written to tmp/overwrites directory
                   3755: #                   $context is passed as argument to &finishuserfileupload
1.686     albertel 3756: #        $subdir - directory in userfile to store the file into
1.858     raeburn  3757: #        $parser - instruction to parse file for objects ($parser = parse)    
                   3758: #        $allfiles - reference to hash for embedded objects
                   3759: #        $codebase - reference to hash for codebase of java objects
                   3760: #        $desuname - username for permanent storage of uploaded file
                   3761: #        $dsetudom - domain for permanaent storage of uploaded file
1.860     raeburn  3762: #        $thumbwidth - width (pixels) of thumbnail to make for uploaded image 
                   3763: #        $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051    raeburn  3764: #        $resizewidth - width (pixels) to which to resize uploaded image
                   3765: #        $resizeheight - height (pixels) to which to resize uploaded image
1.1095    raeburn  3766: #        $mimetype - reference to scalar to accommodate mime type determined
1.1152    raeburn  3767: #                    from File::MMagic.
1.858     raeburn  3768: # 
1.686     albertel 3769: # output: url of file in userspace, or error: <message> 
                   3770: #             or /adm/notfound.html if failure to upload occurse
1.608     albertel 3771: 
1.531     albertel 3772: sub userfileupload {
1.1090    raeburn  3773:     my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095    raeburn  3774:         $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531     albertel 3775:     if (!defined($subdir)) { $subdir='unknown'; }
1.620     albertel 3776:     my $fname=$env{'form.'.$formname.'.filename'};
1.531     albertel 3777:     $fname=&clean_filename($fname);
1.1090    raeburn  3778:     # See if there is anything left
1.257     www      3779:     unless ($fname) { return 'error: no uploaded file'; }
1.1090    raeburn  3780:     # Files uploaded to help request form, or uploaded to "create course" page are handled differently
                   3781:     if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
                   3782:         (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
                   3783:          ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523     raeburn  3784:         my $now = time;
1.1090    raeburn  3785:         my $filepath;
1.1095    raeburn  3786:         if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090    raeburn  3787:              $filepath = 'tmp/helprequests/'.$now;
                   3788:         } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
                   3789:              $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
                   3790:                          '_'.$env{'user.domain'}.'/pending';
                   3791:         } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
                   3792:             my ($docuname,$docudom);
1.1350    raeburn  3793:             if ($destudom =~ /^$match_domain$/) {
1.1090    raeburn  3794:                 $docudom = $destudom;
                   3795:             } else {
                   3796:                 $docudom = $env{'user.domain'};
                   3797:             }
1.1350    raeburn  3798:             if ($destuname =~ /^$match_username$/) {
1.1090    raeburn  3799:                 $docuname = $destuname;
                   3800:             } else {
                   3801:                 $docuname = $env{'user.name'};
                   3802:             }
                   3803:             if (exists($env{'form.group'})) {
                   3804:                 $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3805:                 $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   3806:             }
                   3807:             $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
                   3808:             if ($context eq 'canceloverwrite') {
                   3809:                 my $tempfile =  $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
                   3810:                 if (-e  $tempfile) {
                   3811:                     my @info = stat($tempfile);
                   3812:                     if ($info[9] eq $env{'form.timestamp'}) {
                   3813:                         unlink($tempfile);
                   3814:                     }
                   3815:                 }
                   3816:                 return;
1.523     raeburn  3817:             }
                   3818:         }
1.1090    raeburn  3819:         # Create the directory if not present
1.741     raeburn  3820:         my @parts=split(/\//,$filepath);
                   3821:         my $fullpath = $perlvar{'lonDaemons'};
                   3822:         for (my $i=0;$i<@parts;$i++) {
                   3823:             $fullpath .= '/'.$parts[$i];
                   3824:             if ((-e $fullpath)!=1) {
                   3825:                 mkdir($fullpath,0777);
                   3826:             }
                   3827:         }
1.1359    raeburn  3828:         open(my $fh,'>',$fullpath.'/'.$fname);
1.741     raeburn  3829:         print $fh $env{'form.'.$formname};
                   3830:         close($fh);
1.1090    raeburn  3831:         if ($context eq 'existingfile') {
                   3832:             my @info = stat($fullpath.'/'.$fname);
                   3833:             return ($fullpath.'/'.$fname,$info[9]);
                   3834:         } else {
                   3835:             return $fullpath.'/'.$fname;
                   3836:         }
1.523     raeburn  3837:     }
1.995     raeburn  3838:     if ($subdir eq 'scantron') {
                   3839:         $fname = 'scantron_orig_'.$fname;
1.1093    raeburn  3840:     } else {
1.995     raeburn  3841:         $fname="$subdir/$fname";
                   3842:     }
1.1090    raeburn  3843:     if ($context eq 'coursedoc') {
1.638     albertel 3844: 	my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3845: 	my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646     raeburn  3846:         if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638     albertel 3847:             return &finishuserfileupload($docuname,$docudom,
                   3848: 					 $formname,$fname,$parser,$allfiles,
1.1051    raeburn  3849: 					 $codebase,$thumbwidth,$thumbheight,
1.1095    raeburn  3850:                                          $resizewidth,$resizeheight,$context,$mimetype);
1.481     raeburn  3851:         } else {
1.1218    raeburn  3852:             if ($env{'form.folder'}) {
                   3853:                 $fname=$env{'form.folder'}.'/'.$fname;
                   3854:             }
1.638     albertel 3855:             return &process_coursefile('uploaddoc',$docuname,$docudom,
                   3856: 				       $fname,$formname,$parser,
1.1095    raeburn  3857: 				       $allfiles,$codebase,$mimetype);
1.481     raeburn  3858:         }
1.719     banghart 3859:     } elsif (defined($destuname)) {
                   3860:         my $docuname=$destuname;
                   3861:         my $docudom=$destudom;
1.860     raeburn  3862: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   3863: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  3864:                                      $thumbwidth,$thumbheight,
1.1095    raeburn  3865:                                      $resizewidth,$resizeheight,$context,$mimetype);
1.259     www      3866:     } else {
1.638     albertel 3867:         my $docuname=$env{'user.name'};
                   3868:         my $docudom=$env{'user.domain'};
1.1220    raeburn  3869:         if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714     raeburn  3870:             $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   3871:             $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
                   3872:         }
1.860     raeburn  3873: 	return &finishuserfileupload($docuname,$docudom,$formname,$fname,
                   3874: 				     $parser,$allfiles,$codebase,
1.1051    raeburn  3875:                                      $thumbwidth,$thumbheight,
1.1095    raeburn  3876:                                      $resizewidth,$resizeheight,$context,$mimetype);
1.259     www      3877:     }
1.271     www      3878: }
                   3879: 
                   3880: sub finishuserfileupload {
1.860     raeburn  3881:     my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095    raeburn  3882:         $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477     raeburn  3883:     my $path=$docudom.'/'.$docuname.'/';
1.258     www      3884:     my $filepath=$perlvar{'lonDocRoot'};
1.984     neumanie 3885:   
1.860     raeburn  3886:     my ($fnamepath,$file,$fetchthumb);
1.494     albertel 3887:     $file=$fname;
                   3888:     if ($fname=~m|/|) {
                   3889:         ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
                   3890: 	$path.=$fnamepath.'/';
                   3891:     }
1.259     www      3892:     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258     www      3893:     my $count;
                   3894:     for ($count=4;$count<=$#parts;$count++) {
                   3895:         $filepath.="/$parts[$count]";
                   3896:         if ((-e $filepath)!=1) {
                   3897: 	    mkdir($filepath,0777);
                   3898:         }
                   3899:     }
1.984     neumanie 3900: 
1.258     www      3901: # Save the file
                   3902:     {
1.1359    raeburn  3903: 	if (!open(FH,'>',$filepath.'/'.$file)) {
1.701     albertel 3904: 	    &logthis('Failed to create '.$filepath.'/'.$file);
                   3905: 	    print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
                   3906: 	    return '/adm/notfound.html';
                   3907: 	}
1.1090    raeburn  3908:         if ($context eq 'overwrite') {
1.1117    foxr     3909:             my $source =  LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090    raeburn  3910:             my $target = $filepath.'/'.$file;
                   3911:             if (-e $source) {
                   3912:                 my @info = stat($source);
                   3913:                 if ($info[9] eq $env{'form.timestamp'}) {   
                   3914:                     unless (&File::Copy::move($source,$target)) {
                   3915:                         &logthis('Failed to overwrite '.$filepath.'/'.$file);
                   3916:                         return "Moving from $source failed";
                   3917:                     }
                   3918:                 } else {
                   3919:                     return "Temporary file: $source had unexpected date/time for last modification";
                   3920:                 }
                   3921:             } else {
                   3922:                 return "Temporary file: $source missing";
                   3923:             }
                   3924:         } elsif (!print FH ($env{'form.'.$formname})) {
1.701     albertel 3925: 	    &logthis('Failed to write to '.$filepath.'/'.$file);
                   3926: 	    print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
                   3927: 	    return '/adm/notfound.html';
                   3928: 	}
1.570     albertel 3929: 	close(FH);
1.1051    raeburn  3930:         if ($resizewidth && $resizeheight) {
                   3931:             my $mm = new File::MMagic;
                   3932:             my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
                   3933:             if ($mime_type =~ m{^image/}) {
                   3934: 	        &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
                   3935:             }  
1.977     amueller 3936: 	}
1.258     www      3937:     }
1.1152    raeburn  3938:     if (($context eq 'coursedoc') || ($parser eq 'parse')) {
                   3939:         if (ref($mimetype)) {
                   3940:             if ($$mimetype eq '') {
                   3941:                 my $mm = new File::MMagic;
                   3942:                 my $type = $mm->checktype_filename($filepath.'/'.$file);
                   3943:                 $$mimetype = $type;
                   3944:             }
                   3945:         }
                   3946:     }
1.637     raeburn  3947:     if ($parser eq 'parse') {
1.1152    raeburn  3948:         if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024    raeburn  3949:             my $parse_result = &extract_embedded_items($filepath.'/'.$file,
                   3950:                                                        $allfiles,$codebase);
                   3951:             unless ($parse_result eq 'ok') {
                   3952:                 &logthis('Failed to parse '.$filepath.$file.
                   3953: 	   	         ' for embedded media: '.$parse_result); 
                   3954:             }
1.637     raeburn  3955:         }
                   3956:     }
1.860     raeburn  3957:     if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
                   3958:         my $input = $filepath.'/'.$file;
                   3959:         my $output = $filepath.'/'.'tn-'.$file;
                   3960:         my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1359    raeburn  3961:         my @args = ('convert','-sample',$thumbsize,$input,$output);
                   3962:         system({$args[0]} @args);
1.860     raeburn  3963:         if (-e $filepath.'/'.'tn-'.$file) {
                   3964:             $fetchthumb  = 1; 
                   3965:         }
                   3966:     }
1.858     raeburn  3967:  
1.259     www      3968: # Notify homeserver to grep it
                   3969: #
1.984     neumanie 3970:     my $docuhome=&homeserver($docuname,$docudom);	
1.494     albertel 3971:     my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295     www      3972:     if ($fetchresult eq 'ok') {
1.860     raeburn  3973:         if ($fetchthumb) {
                   3974:             my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
                   3975:             if ($thumbresult ne 'ok') {
                   3976:                 &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
                   3977:                          $docuhome.': '.$thumbresult);
                   3978:             }
                   3979:         }
1.259     www      3980: #
1.258     www      3981: # Return the URL to it
1.494     albertel 3982:         return '/uploaded/'.$path.$file;
1.263     www      3983:     } else {
1.494     albertel 3984:         &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
                   3985: 		 ': '.$fetchresult);
1.263     www      3986:         return '/adm/notfound.html';
1.858     raeburn  3987:     }
1.493     albertel 3988: }
                   3989: 
1.637     raeburn  3990: sub extract_embedded_items {
1.961     raeburn  3991:     my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637     raeburn  3992:     my @state = ();
1.1164    raeburn  3993:     my (%lastids,%related,%shockwave,%flashvars);
1.637     raeburn  3994:     my %javafiles = (
                   3995:                       codebase => '',
                   3996:                       code => '',
                   3997:                       archive => ''
                   3998:                     );
                   3999:     my %mediafiles = (
                   4000:                       src => '',
                   4001:                       movie => '',
                   4002:                      );
1.648     raeburn  4003:     my $p;
                   4004:     if ($content) {
                   4005:         $p = HTML::LCParser->new($content);
                   4006:     } else {
1.961     raeburn  4007:         $p = HTML::LCParser->new($fullpath);
1.648     raeburn  4008:     }
1.641     albertel 4009:     while (my $t=$p->get_token()) {
1.640     albertel 4010: 	if ($t->[0] eq 'S') {
                   4011: 	    my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886     albertel 4012: 	    push(@state, $tagname);
1.648     raeburn  4013:             if (lc($tagname) eq 'allow') {
                   4014:                 &add_filetype($allfiles,$attr->{'src'},'src');
                   4015:             }
1.640     albertel 4016: 	    if (lc($tagname) eq 'img') {
                   4017: 		&add_filetype($allfiles,$attr->{'src'},'src');
                   4018: 	    }
1.886     albertel 4019: 	    if (lc($tagname) eq 'a') {
1.1222    raeburn  4020:                 unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221    raeburn  4021:                     &add_filetype($allfiles,$attr->{'href'},'href');
                   4022:                 }
1.886     albertel 4023: 	    }
1.645     raeburn  4024:             if (lc($tagname) eq 'script') {
1.1164    raeburn  4025:                 my $src;
1.645     raeburn  4026:                 if ($attr->{'archive'} =~ /\.jar$/i) {
                   4027:                     &add_filetype($allfiles,$attr->{'archive'},'archive');
                   4028:                 } else {
1.1164    raeburn  4029:                     if ($attr->{'src'} ne '') {
                   4030:                         $src = $attr->{'src'};
                   4031:                         &add_filetype($allfiles,$src,'src');
                   4032:                     }
                   4033:                 }
                   4034:                 my $text = $p->get_trimmed_text();
                   4035:                 if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
                   4036:                     my @swfargs = split(/,/,$1);
                   4037:                     foreach my $item (@swfargs) {
                   4038:                         $item =~ s/["']//g;
                   4039:                         $item =~ s/^\s+//;
                   4040:                         $item =~ s/\s+$//;
                   4041:                     }
                   4042:                     if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
                   4043:                         if (ref($related{$swfargs[0]}) eq 'ARRAY') {
                   4044:                             push(@{$related{$swfargs[0]}},$swfargs[2]);
                   4045:                         } else {
                   4046:                             $related{$swfargs[0]} = [$swfargs[2]];
                   4047:                         }
                   4048:                     }
1.645     raeburn  4049:                 }
                   4050:             }
                   4051:             if (lc($tagname) eq 'link') {
                   4052:                 if (lc($attr->{'rel'}) eq 'stylesheet') { 
                   4053:                     &add_filetype($allfiles,$attr->{'href'},'href');
                   4054:                 }
                   4055:             }
1.640     albertel 4056: 	    if (lc($tagname) eq 'object' ||
                   4057: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
                   4058: 		foreach my $item (keys(%javafiles)) {
                   4059: 		    $javafiles{$item} = '';
                   4060: 		}
1.1164    raeburn  4061:                 if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
                   4062:                     $lastids{lc($tagname)} = $attr->{'id'};
                   4063:                 }
1.640     albertel 4064: 	    }
                   4065: 	    if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
                   4066: 		my $name = lc($attr->{'name'});
                   4067: 		foreach my $item (keys(%javafiles)) {
                   4068: 		    if ($name eq $item) {
                   4069: 			$javafiles{$item} = $attr->{'value'};
                   4070: 			last;
                   4071: 		    }
                   4072: 		}
1.1164    raeburn  4073:                 my $pathfrom;
1.640     albertel 4074: 		foreach my $item (keys(%mediafiles)) {
                   4075: 		    if ($name eq $item) {
1.1164    raeburn  4076:                         $pathfrom = $attr->{'value'};
                   4077:                         $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
                   4078: 			&add_filetype($allfiles,$pathfrom,$name);
1.640     albertel 4079: 			last;
                   4080: 		    }
                   4081: 		}
1.1164    raeburn  4082:                 if ($name eq 'flashvars') {
                   4083:                     $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
                   4084:                 }
                   4085:                 if ($pathfrom ne '') {
                   4086:                     &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
                   4087:                                          $pathfrom);
                   4088:                 }
1.640     albertel 4089: 	    }
                   4090: 	    if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
                   4091: 		foreach my $item (keys(%javafiles)) {
                   4092: 		    if ($attr->{$item}) {
                   4093: 			$javafiles{$item} = $attr->{$item};
                   4094: 			last;
                   4095: 		    }
                   4096: 		}
                   4097: 		foreach my $item (keys(%mediafiles)) {
                   4098: 		    if ($attr->{$item}) {
                   4099: 			&add_filetype($allfiles,$attr->{$item},$item);
                   4100: 			last;
                   4101: 		    }
                   4102: 		}
1.1164    raeburn  4103:                 if (lc($tagname) eq 'embed') {
                   4104:                     if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
                   4105:                         &embedded_dependency($allfiles,\%related,$attr->{'name'},
                   4106:                                              $attr->{'src'});
                   4107:                     }
                   4108:                 }
1.640     albertel 4109: 	    }
1.1243    raeburn  4110:             if (lc($tagname) eq 'iframe') {
                   4111:                 my $src = $attr->{'src'} ;
                   4112:                 if (($src ne '') && ($src !~ m{^(/|https?://)})) {
                   4113:                     &add_filetype($allfiles,$src,'src');
                   4114:                 } elsif ($src =~ m{^/}) {
                   4115:                     if ($env{'request.course.id'}) {
                   4116:                         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   4117:                         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   4118:                         my $url = &hreflocation('',$fullpath);
                   4119:                         if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
                   4120:                             my $relpath = $1;
                   4121:                             if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
                   4122:                                 &add_filetype($allfiles,$1,'src');
                   4123:                             }
                   4124:                         }
                   4125:                     }
                   4126:                 }
                   4127:             }
1.1164    raeburn  4128:             if ($t->[4] =~ m{/>$}) {
1.1243    raeburn  4129:                 pop(@state);
1.1164    raeburn  4130:             }
1.640     albertel 4131: 	} elsif ($t->[0] eq 'E') {
                   4132: 	    my ($tagname) = ($t->[1]);
                   4133: 	    if ($javafiles{'codebase'} ne '') {
                   4134: 		$javafiles{'codebase'} .= '/';
                   4135: 	    }  
                   4136: 	    if (lc($tagname) eq 'applet' ||
                   4137: 		lc($tagname) eq 'object' ||
                   4138: 		(lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
                   4139: 		) {
                   4140: 		foreach my $item (keys(%javafiles)) {
                   4141: 		    if ($item ne 'codebase' && $javafiles{$item} ne '') {
                   4142: 			my $file=$javafiles{'codebase'}.$javafiles{$item};
                   4143: 			&add_filetype($allfiles,$file,$item);
                   4144: 		    }
                   4145: 		}
                   4146: 	    } 
                   4147: 	    pop @state;
                   4148: 	}
                   4149:     }
1.1164    raeburn  4150:     foreach my $id (sort(keys(%flashvars))) {
                   4151:         if ($shockwave{$id} ne '') {
                   4152:             my @pairs = split(/\&/,$flashvars{$id});
                   4153:             foreach my $pair (@pairs) {
                   4154:                 my ($key,$value) = split(/\=/,$pair);
                   4155:                 if ($key eq 'thumb') {
                   4156:                     &add_filetype($allfiles,$value,$key);
                   4157:                 } elsif ($key eq 'content') {
                   4158:                     my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
                   4159:                     my ($ext) = ($value =~ /\.([^.]+)$/);
                   4160:                     if ($ext ne '') {
                   4161:                         &add_filetype($allfiles,$path.$value,$ext);
                   4162:                     }
                   4163:                 }
                   4164:             }
                   4165:         }
                   4166:     }
1.637     raeburn  4167:     return 'ok';
                   4168: }
                   4169: 
1.639     albertel 4170: sub add_filetype {
                   4171:     my ($allfiles,$file,$type)=@_;
                   4172:     if (exists($allfiles->{$file})) {
                   4173: 	unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
                   4174: 	    push(@{$allfiles->{$file}}, &escape($type));
                   4175: 	}
                   4176:     } else {
                   4177: 	@{$allfiles->{$file}} = (&escape($type));
1.637     raeburn  4178:     }
                   4179: }
                   4180: 
1.1164    raeburn  4181: sub embedded_dependency {
                   4182:     my ($allfiles,$related,$identifier,$pathfrom) = @_;
                   4183:     if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
                   4184:         if (($identifier ne '') &&
                   4185:             (ref($related->{$identifier}) eq 'ARRAY') &&
                   4186:             ($pathfrom ne '')) {
                   4187:             my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
                   4188:             foreach my $dep (@{$related->{$identifier}}) {
                   4189:                 &add_filetype($allfiles,$path.$dep,'object');
                   4190:             }
                   4191:         }
                   4192:     }
                   4193:     return;
                   4194: }
                   4195: 
1.493     albertel 4196: sub removeuploadedurl {
1.984     neumanie 4197:     my ($url)=@_;	
                   4198:     my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);    
1.613     albertel 4199:     return &removeuserfile($uname,$udom,$fname);
1.490     albertel 4200: }
                   4201: 
                   4202: sub removeuserfile {
                   4203:     my ($docuname,$docudom,$fname)=@_;
1.984     neumanie 4204:     my $home=&homeserver($docuname,$docudom);    
1.798     raeburn  4205:     my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984     neumanie 4206:     if ($result eq 'ok') {	
1.798     raeburn  4207:         if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
                   4208:             my $metafile = $fname.'.meta';
                   4209:             my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 
1.823     albertel 4210: 	    my $url = "/uploaded/$docudom/$docuname/$fname";
1.984     neumanie 4211:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];	   
1.821     raeburn  4212:             my $sqlresult = 
1.823     albertel 4213:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  4214:                                         'portfolio_metadata',$group,
                   4215:                                         'delete');
1.798     raeburn  4216:         }
                   4217:     }
                   4218:     return $result;
1.257     www      4219: }
1.15      www      4220: 
1.530     albertel 4221: sub mkdiruserfile {
                   4222:     my ($docuname,$docudom,$dir)=@_;
                   4223:     my $home=&homeserver($docuname,$docudom);
                   4224:     return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
                   4225: }
                   4226: 
1.531     albertel 4227: sub renameuserfile {
                   4228:     my ($docuname,$docudom,$old,$new)=@_;
                   4229:     my $home=&homeserver($docuname,$docudom);
1.798     raeburn  4230:     my $result = &reply("renameuserfile:$docudom:$docuname:".
                   4231:                         &escape("$old").':'.&escape("$new"),$home);
                   4232:     if ($result eq 'ok') {
                   4233:         if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
                   4234:             my $oldmeta = $old.'.meta';
                   4235:             my $newmeta = $new.'.meta';
                   4236:             my $metaresult = 
                   4237:                 &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823     albertel 4238: 	    my $url = "/uploaded/$docudom/$docuname/$old";
                   4239:             my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821     raeburn  4240:             my $sqlresult = 
1.823     albertel 4241:                 &update_portfolio_table($docuname,$docudom,$file,
1.821     raeburn  4242:                                         'portfolio_metadata',$group,
                   4243:                                         'delete');
1.798     raeburn  4244:         }
                   4245:     }
                   4246:     return $result;
1.531     albertel 4247: }
                   4248: 
1.14      www      4249: # ------------------------------------------------------------------------- Log
                   4250: 
                   4251: sub log {
                   4252:     my ($dom,$nam,$hom,$what)=@_;
1.47      www      4253:     return critical("log:$dom:$nam:$what",$hom);
1.157     www      4254: }
                   4255: 
                   4256: # ------------------------------------------------------------------ Course Log
1.352     www      4257: #
                   4258: # This routine flushes several buffers of non-mission-critical nature
                   4259: #
1.157     www      4260: 
                   4261: sub flushcourselogs {
1.352     www      4262:     &logthis('Flushing log buffers');
                   4263: #
                   4264: # course logs
                   4265: # This is a log of all transactions in a course, which can be used
                   4266: # for data mining purposes
                   4267: #
                   4268: # It also collects the courseid database, which lists last transaction
                   4269: # times and course titles for all courseids
                   4270: #
                   4271:     my %courseidbuffer=();
1.921     raeburn  4272:     foreach my $crsid (keys(%courselogs)) {
1.352     www      4273:         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188     www      4274: 		          &escape($courselogs{$crsid}),
                   4275: 		          $coursehombuf{$crsid}) eq 'ok') {
1.157     www      4276: 	    delete $courselogs{$crsid};
                   4277:         } else {
                   4278:             &logthis('Failed to flush log buffer for '.$crsid);
                   4279:             if (length($courselogs{$crsid})>40000) {
1.672     albertel 4280:                &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157     www      4281:                         " exceeded maximum size, deleting.</font>");
                   4282:                delete $courselogs{$crsid};
                   4283:             }
1.352     www      4284:         }
1.920     raeburn  4285:         $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936     raeburn  4286:             'description' => $coursedescrbuf{$crsid},
                   4287:             'inst_code'    => $courseinstcodebuf{$crsid},
                   4288:             'type'        => $coursetypebuf{$crsid},
                   4289:             'owner'       => $courseownerbuf{$crsid},
1.920     raeburn  4290:         };
1.191     harris41 4291:     }
1.352     www      4292: #
                   4293: # Write course id database (reverse lookup) to homeserver of courses 
                   4294: # Is used in pickcourse
                   4295: #
1.840     albertel 4296:     foreach my $crs_home (keys(%courseidbuffer)) {
1.918     raeburn  4297:         my $response = &courseidput(&host_domain($crs_home),
1.921     raeburn  4298:                                     $courseidbuffer{$crs_home},
                   4299:                                     $crs_home,'timeonly');
1.352     www      4300:     }
                   4301: #
                   4302: # File accesses
                   4303: # Writes to the dynamic metadata of resources to get hit counts, etc.
                   4304: #
1.449     matthew  4305:     foreach my $entry (keys(%accesshash)) {
1.458     matthew  4306:         if ($entry =~ /___count$/) {
                   4307:             my ($dom,$name);
1.807     albertel 4308:             ($dom,$name,undef)=
1.811     albertel 4309: 		($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458     matthew  4310:             if (! defined($dom) || $dom eq '' || 
                   4311:                 ! defined($name) || $name eq '') {
1.620     albertel 4312:                 my $cid = $env{'request.course.id'};
                   4313:                 $dom  = $env{'request.'.$cid.'.domain'};
                   4314:                 $name = $env{'request.'.$cid.'.num'};
1.458     matthew  4315:             }
1.450     matthew  4316:             my $value = $accesshash{$entry};
                   4317:             my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
                   4318:             my %temphash=($url => $value);
1.449     matthew  4319:             my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
                   4320:             if ($result eq 'ok') {
                   4321:                 delete $accesshash{$entry};
                   4322:             }
                   4323:         } else {
1.811     albertel 4324:             my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159    www      4325:             if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450     matthew  4326:             my %temphash=($entry => $accesshash{$entry});
1.449     matthew  4327:             if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
                   4328:                 delete $accesshash{$entry};
                   4329:             }
1.185     www      4330:         }
1.191     harris41 4331:     }
1.352     www      4332: #
                   4333: # Roles
                   4334: # Reverse lookup of user roles for course faculty/staff and co-authorship
                   4335: #
1.800     albertel 4336:     foreach my $entry (keys(%userrolehash)) {
1.351     www      4337:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349     www      4338: 	    split(/\:/,$entry);
                   4339:         if (&Apache::lonnet::put('nohist_userroles',
1.351     www      4340:              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349     www      4341:                 $rudom,$runame) eq 'ok') {
                   4342: 	    delete $userrolehash{$entry};
                   4343:         }
                   4344:     }
1.662     raeburn  4345: #
1.1334    raeburn  4346: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662     raeburn  4347: #
                   4348:     my %domrolebuffer = ();
1.1000    raeburn  4349:     foreach my $entry (keys(%domainrolehash)) {
1.901     albertel 4350:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662     raeburn  4351:         if ($domrolebuffer{$rudom}) {
                   4352:             $domrolebuffer{$rudom}.='&'.&escape($entry).
                   4353:                       '='.&escape($domainrolehash{$entry});
                   4354:         } else {
                   4355:             $domrolebuffer{$rudom}.=&escape($entry).
                   4356:                       '='.&escape($domainrolehash{$entry});
                   4357:         }
                   4358:         delete $domainrolehash{$entry};
                   4359:     }
                   4360:     foreach my $dom (keys(%domrolebuffer)) {
1.1324    raeburn  4361: 	my %servers;
                   4362: 	if (defined(&domain($dom,'primary'))) {
                   4363: 	    my $primary=&domain($dom,'primary');
                   4364: 	    my $hostname=&hostname($primary);
                   4365: 	    $servers{$primary} = $hostname;
                   4366: 	} else { 
                   4367: 	    %servers = &get_servers($dom,'library');
                   4368: 	}
1.841     albertel 4369: 	foreach my $tryserver (keys(%servers)) {
1.1324    raeburn  4370: 	    if (&reply('domroleput:'.$dom.':'.
                   4371: 		       $domrolebuffer{$dom},$tryserver) eq 'ok') {
                   4372: 		last;
                   4373: 	    } else {  
1.841     albertel 4374: 		&logthis('Put of domain roles failed for '.$dom.' and  '.$tryserver);
                   4375: 	    }
1.662     raeburn  4376:         }
                   4377:     }
1.186     www      4378:     $dumpcount++;
1.157     www      4379: }
                   4380: 
                   4381: sub courselog {
                   4382:     my $what=shift;
1.158     www      4383:     $what=time.':'.$what;
1.620     albertel 4384:     unless ($env{'request.course.id'}) { return ''; }
                   4385:     $coursedombuf{$env{'request.course.id'}}=
                   4386:        $env{'course.'.$env{'request.course.id'}.'.domain'};
                   4387:     $coursenumbuf{$env{'request.course.id'}}=
                   4388:        $env{'course.'.$env{'request.course.id'}.'.num'};
                   4389:     $coursehombuf{$env{'request.course.id'}}=
                   4390:        $env{'course.'.$env{'request.course.id'}.'.home'};
                   4391:     $coursedescrbuf{$env{'request.course.id'}}=
                   4392:        $env{'course.'.$env{'request.course.id'}.'.description'};
                   4393:     $courseinstcodebuf{$env{'request.course.id'}}=
                   4394:        $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
                   4395:     $courseownerbuf{$env{'request.course.id'}}=
                   4396:        $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741     raeburn  4397:     $coursetypebuf{$env{'request.course.id'}}=
                   4398:        $env{'course.'.$env{'request.course.id'}.'.type'};
1.620     albertel 4399:     if (defined $courselogs{$env{'request.course.id'}}) {
                   4400: 	$courselogs{$env{'request.course.id'}}.='&'.$what;
1.157     www      4401:     } else {
1.620     albertel 4402: 	$courselogs{$env{'request.course.id'}}.=$what;
1.157     www      4403:     }
1.620     albertel 4404:     if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157     www      4405: 	&flushcourselogs();
                   4406:     }
1.158     www      4407: }
                   4408: 
                   4409: sub courseacclog {
                   4410:     my $fnsymb=shift;
1.620     albertel 4411:     unless ($env{'request.course.id'}) { return ''; }
                   4412:     my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144    www      4413:     if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187     www      4414:         $what.=':POST';
1.583     matthew  4415:         # FIXME: Probably ought to escape things....
1.800     albertel 4416: 	foreach my $key (keys(%env)) {
                   4417:             if ($key=~/^form\.(.*)/) {
1.975     raeburn  4418:                 my $formitem = $1;
                   4419:                 if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
                   4420:                     $what.=':'.$formitem.'='.$env{$key};
                   4421:                 } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
                   4422:                     $what.=':'.$formitem.'='.$env{$key};
                   4423:                 }
1.158     www      4424:             }
1.191     harris41 4425:         }
1.583     matthew  4426:     } elsif ($fnsymb =~ m:^/adm/searchcat:) {
                   4427:         # FIXME: We should not be depending on a form parameter that someone
                   4428:         # editing lonsearchcat.pm might change in the future.
1.620     albertel 4429:         if ($env{'form.phase'} eq 'course_search') {
1.583     matthew  4430:             $what.= ':POST';
                   4431:             # FIXME: Probably ought to escape things....
                   4432:             foreach my $element ('courseexp','crsfulltext','crsrelated',
                   4433:                                  'crsdiscuss') {
1.620     albertel 4434:                 $what.=':'.$element.'='.$env{'form.'.$element};
1.583     matthew  4435:             }
                   4436:         }
1.158     www      4437:     }
                   4438:     &courselog($what);
1.149     www      4439: }
                   4440: 
1.185     www      4441: sub countacc {
                   4442:     my $url=&declutter(shift);
1.458     matthew  4443:     return if (! defined($url) || $url eq '');
1.620     albertel 4444:     unless ($env{'request.course.id'}) { return ''; }
1.1158    www      4445: #
                   4446: # Mark that this url was used in this course
                   4447: #
1.620     albertel 4448:     $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158    www      4449: #
                   4450: # Increase the access count for this resource in this child process
                   4451: #
1.281     www      4452:     my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450     matthew  4453:     $accesshash{$key}++;
1.185     www      4454: }
1.349     www      4455: 
1.361     www      4456: sub linklog {
                   4457:     my ($from,$to)=@_;
                   4458:     $from=&declutter($from);
                   4459:     $to=&declutter($to);
                   4460:     $accesshash{$from.'___'.$to.'___comefrom'}=1;
                   4461:     $accesshash{$to.'___'.$from.'___goto'}=1;
                   4462: }
1.1160    www      4463: 
                   4464: sub statslog {
                   4465:     my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
                   4466:     if ($users<2) { return; }
                   4467:     my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
                   4468:             'course'       => $env{'request.course.id'},
                   4469:             'sections'     => '"all"',
                   4470:             'num_students' => $users,
                   4471:             'part'         => $part,
                   4472:             'symb'         => $symb,
                   4473:             'mean_tries'   => $av_attempts,
                   4474:             'deg_of_diff'  => $degdiff});
                   4475:     foreach my $key (keys(%dynstore)) {
                   4476:         $accesshash{$key}=$dynstore{$key};
                   4477:     }
                   4478: }
1.361     www      4479:   
1.349     www      4480: sub userrolelog {
                   4481:     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169    droeschl 4482:     if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350     www      4483:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   4484:        $userrolehash
                   4485:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349     www      4486:                     =$tend.':'.$tstart;
1.662     raeburn  4487:     }
1.1169    droeschl 4488:     if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898     albertel 4489:        $userrolehash
                   4490:          {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
                   4491:                     =$tend.':'.$tstart;
                   4492:     }
1.1334    raeburn  4493:     if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662     raeburn  4494:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   4495:        $domainrolehash
                   4496:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
                   4497:                     = $tend.':'.$tstart;
                   4498:     }
1.351     www      4499: }
                   4500: 
1.957     raeburn  4501: sub courserolelog {
                   4502:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184    raeburn  4503:     if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
                   4504:         my $cdom = $1;
                   4505:         my $cnum = $2;
                   4506:         my $sec = $3;
                   4507:         my $namespace = 'rolelog';
                   4508:         my %storehash = (
                   4509:                            role    => $trole,
                   4510:                            start   => $tstart,
                   4511:                            end     => $tend,
                   4512:                            selfenroll => $selfenroll,
                   4513:                            context    => $context,
                   4514:                         );
                   4515:         if ($trole eq 'gr') {
                   4516:             $namespace = 'groupslog';
                   4517:             $storehash{'group'} = $sec;
                   4518:         } else {
                   4519:             $storehash{'section'} = $sec;
                   4520:         }
1.1188    raeburn  4521:         &write_log('course',$namespace,\%storehash,$delflag,$username,
                   4522:                    $domain,$cnum,$cdom);
1.1184    raeburn  4523:         if (($trole ne 'st') || ($sec ne '')) {
                   4524:             &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957     raeburn  4525:         }
                   4526:     }
                   4527:     return;
                   4528: }
                   4529: 
1.1184    raeburn  4530: sub domainrolelog {
                   4531:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
                   4532:     if ($area =~ m{^/($match_domain)/$}) {
                   4533:         my $cdom = $1;
                   4534:         my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
                   4535:         my $namespace = 'rolelog';
                   4536:         my %storehash = (
                   4537:                            role    => $trole,
                   4538:                            start   => $tstart,
                   4539:                            end     => $tend,
                   4540:                            context => $context,
                   4541:                         );
1.1188    raeburn  4542:         &write_log('domain',$namespace,\%storehash,$delflag,$username,
                   4543:                    $domain,$domconfiguser,$cdom);
1.1184    raeburn  4544:     }
                   4545:     return;
                   4546: 
                   4547: }
                   4548: 
                   4549: sub coauthorrolelog {
                   4550:     my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
                   4551:     if ($area =~ m{^/($match_domain)/($match_username)$}) {
                   4552:         my $audom = $1;
                   4553:         my $auname = $2;
                   4554:         my $namespace = 'rolelog';
                   4555:         my %storehash = (
                   4556:                            role    => $trole,
                   4557:                            start   => $tstart,
                   4558:                            end     => $tend,
                   4559:                            context => $context,
                   4560:                         );
1.1188    raeburn  4561:         &write_log('author',$namespace,\%storehash,$delflag,$username,
                   4562:                    $domain,$auname,$audom);
1.1184    raeburn  4563:     }
                   4564:     return;
                   4565: }
                   4566: 
1.351     www      4567: sub get_course_adv_roles {
1.948     raeburn  4568:     my ($cid,$codes) = @_;
1.620     albertel 4569:     $cid=$env{'request.course.id'} unless (defined($cid));
1.351     www      4570:     my %coursehash=&coursedescription($cid);
1.988     raeburn  4571:     my $crstype = &Apache::loncommon::course_type($cid);
1.470     www      4572:     my %nothide=();
1.800     albertel 4573:     foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937     raeburn  4574:         if ($user !~ /:/) {
                   4575: 	    $nothide{join(':',split(/[\@]/,$user))}=1;
                   4576:         } else {
                   4577:             $nothide{$user}=1;
                   4578:         }
1.470     www      4579:     }
1.1219    raeburn  4580:     my @possdoms = ($coursehash{'domain'});
                   4581:     if ($coursehash{'checkforpriv'}) {
                   4582:         push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   4583:     }
1.351     www      4584:     my %returnhash=();
                   4585:     my %dumphash=
                   4586:             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
                   4587:     my $now=time;
1.997     raeburn  4588:     my %privileged;
1.1000    raeburn  4589:     foreach my $entry (keys(%dumphash)) {
1.800     albertel 4590: 	my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351     www      4591:         if (($tstart) && ($tstart<0)) { next; }
                   4592:         if (($tend) && ($tend<$now)) { next; }
                   4593:         if (($tstart) && ($now<$tstart)) { next; }
1.800     albertel 4594:         my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576     albertel 4595: 	if ($username eq '' || $domain eq '') { next; }
1.1219    raeburn  4596:         if ((&privileged($username,$domain,\@possdoms)) &&
1.997     raeburn  4597:             (!$nothide{$username.':'.$domain})) { next; }
1.656     albertel 4598: 	if ($role eq 'cr') { next; }
1.948     raeburn  4599:         if ($codes) {
                   4600:             if ($section) { $role .= ':'.$section; }
                   4601:             if ($returnhash{$role}) {
                   4602:                 $returnhash{$role}.=','.$username.':'.$domain;
                   4603:             } else {
                   4604:                 $returnhash{$role}=$username.':'.$domain;
                   4605:             }
1.351     www      4606:         } else {
1.988     raeburn  4607:             my $key=&plaintext($role,$crstype);
1.973     bisitz   4608:             if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948     raeburn  4609:             if ($returnhash{$key}) {
                   4610: 	        $returnhash{$key}.=','.$username.':'.$domain;
                   4611:             } else {
                   4612:                 $returnhash{$key}=$username.':'.$domain;
                   4613:             }
1.351     www      4614:         }
1.948     raeburn  4615:     }
1.400     www      4616:     return %returnhash;
                   4617: }
                   4618: 
                   4619: sub get_my_roles {
1.937     raeburn  4620:     my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620     albertel 4621:     unless (defined($uname)) { $uname=$env{'user.name'}; }
                   4622:     unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937     raeburn  4623:     my (%dumphash,%nothide);
1.1086    raeburn  4624:     if ($context eq 'userroles') {
1.1166    raeburn  4625:         %dumphash = &dump('roles',$udom,$uname);
1.858     raeburn  4626:     } else {
1.1219    raeburn  4627:         %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937     raeburn  4628:         if ($hidepriv) {
                   4629:             my %coursehash=&coursedescription($udom.'_'.$uname);
                   4630:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   4631:                 if ($user !~ /:/) {
                   4632:                     $nothide{join(':',split(/[\@]/,$user))} = 1;
                   4633:                 } else {
                   4634:                     $nothide{$user} = 1;
                   4635:                 }
                   4636:             }
                   4637:         }
1.858     raeburn  4638:     }
1.400     www      4639:     my %returnhash=();
                   4640:     my $now=time;
1.999     raeburn  4641:     my %privileged;
1.800     albertel 4642:     foreach my $entry (keys(%dumphash)) {
1.867     raeburn  4643:         my ($role,$tend,$tstart);
                   4644:         if ($context eq 'userroles') {
1.1149    raeburn  4645:             next if ($entry =~ /^rolesdef/);
1.867     raeburn  4646: 	    ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
                   4647:         } else {
                   4648:             ($tend,$tstart)=split(/\:/,$dumphash{$entry});
                   4649:         }
1.400     www      4650:         if (($tstart) && ($tstart<0)) { next; }
1.832     raeburn  4651:         my $status = 'active';
1.939     raeburn  4652:         if (($tend) && ($tend<=$now)) {
1.832     raeburn  4653:             $status = 'previous';
                   4654:         } 
                   4655:         if (($tstart) && ($now<$tstart)) {
                   4656:             $status = 'future';
                   4657:         }
                   4658:         if (ref($types) eq 'ARRAY') {
                   4659:             if (!grep(/^\Q$status\E$/,@{$types})) {
                   4660:                 next;
                   4661:             } 
                   4662:         } else {
                   4663:             if ($status ne 'active') {
                   4664:                 next;
                   4665:             }
                   4666:         }
1.867     raeburn  4667:         my ($rolecode,$username,$domain,$section,$area);
                   4668:         if ($context eq 'userroles') {
1.1186    raeburn  4669:             ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867     raeburn  4670:             (undef,$domain,$username,$section) = split(/\//,$area);
                   4671:         } else {
                   4672:             ($role,$username,$domain,$section) = split(/\:/,$entry);
                   4673:         }
1.832     raeburn  4674:         if (ref($roledoms) eq 'ARRAY') {
                   4675:             if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
                   4676:                 next;
                   4677:             }
                   4678:         }
                   4679:         if (ref($roles) eq 'ARRAY') {
                   4680:             if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922     raeburn  4681:                 if ($role =~ /^cr\//) {
                   4682:                     if (!grep(/^cr$/,@{$roles})) {
                   4683:                         next;
                   4684:                     }
1.1104    raeburn  4685:                 } elsif ($role =~ /^gr\//) {
                   4686:                     if (!grep(/^gr$/,@{$roles})) {
                   4687:                         next;
                   4688:                     }
1.922     raeburn  4689:                 } else {
                   4690:                     next;
                   4691:                 }
1.832     raeburn  4692:             }
1.867     raeburn  4693:         }
1.937     raeburn  4694:         if ($hidepriv) {
1.1219    raeburn  4695:             my @privroles = ('dc','su');
1.999     raeburn  4696:             if ($context eq 'userroles') {
1.1219    raeburn  4697:                 next if (grep(/^\Q$role\E$/,@privroles));
1.999     raeburn  4698:             } else {
1.1219    raeburn  4699:                 my $possdoms = [$domain];
                   4700:                 if (ref($roledoms) eq 'ARRAY') {
                   4701:                    push(@{$possdoms},@{$roledoms}); 
1.999     raeburn  4702:                 }
1.1219    raeburn  4703:                 if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999     raeburn  4704:                     if (!$nothide{$username.':'.$domain}) {
                   4705:                         next;
                   4706:                     }
                   4707:                 }
1.937     raeburn  4708:             }
                   4709:         }
1.933     raeburn  4710:         if ($withsec) {
                   4711:             $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
                   4712:                 $tstart.':'.$tend;
                   4713:         } else {
                   4714:             $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
                   4715:         }
1.832     raeburn  4716:     }
1.373     www      4717:     return %returnhash;
1.399     www      4718: }
                   4719: 
1.1333    raeburn  4720: sub get_all_adhocroles {
                   4721:     my ($dom) = @_;
                   4722:     my @roles_by_num = ();
                   4723:     my %domdefaults = &get_domain_defaults($dom);
                   4724:     my (%description,%access_in_dom,%access_info);
                   4725:     if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
                   4726:         my $count = 0;
                   4727:         my %domcurrent = %{$domdefaults{'adhocroles'}};
                   4728:         my %ordered;
                   4729:         foreach my $role (sort(keys(%domcurrent))) {
                   4730:             my ($order,$desc,$access_in_dom);
                   4731:             if (ref($domcurrent{$role}) eq 'HASH') {
                   4732:                 $order = $domcurrent{$role}{'order'};
                   4733:                 $desc = $domcurrent{$role}{'desc'};
                   4734:                 $access_in_dom{$role} = $domcurrent{$role}{'access'};
                   4735:                 $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
                   4736:             }
                   4737:             if ($order eq '') {
                   4738:                 $order = $count;
                   4739:             }
                   4740:             $ordered{$order} = $role;
                   4741:             if ($desc ne '') {
                   4742:                 $description{$role} = $desc;
                   4743:             } else {
                   4744:                 $description{$role}= $role;
                   4745:             }
                   4746:             $count++;
                   4747:         }
                   4748:         foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
                   4749:             push(@roles_by_num,$ordered{$item});
                   4750:         }
                   4751:     }
                   4752:     return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
                   4753: }
                   4754: 
1.1332    raeburn  4755: sub get_my_adhocroles {
1.1333    raeburn  4756:     my ($cid,$checkreg) = @_;
                   4757:     my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
                   4758:     if ($env{'request.course.id'} eq $cid) {
                   4759:         $cdom = $env{'course.'.$cid.'.domain'};
                   4760:         $cnum = $env{'course.'.$cid.'.num'};
                   4761:         $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
                   4762:     } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
                   4763:         $cdom = $1;
                   4764:         $cnum = $2;
                   4765:         %info = &Apache::lonnet::get('environment',['internal.coursecode'],
                   4766:                                      $cdom,$cnum);
                   4767:     }
                   4768:     if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
                   4769:         my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   4770:         my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
                   4771:         if ($rosterhash{$user} ne '') {
                   4772:             my $type = (split(/:/,$rosterhash{$user}))[5];
                   4773:             return ([],{}) if ($type eq 'auto');
                   4774:         }
                   4775:     }
                   4776:     if (($cdom ne '') && ($cnum ne ''))  {
1.1334    raeburn  4777:         if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332    raeburn  4778:             my $then=$env{'user.login.time'};
                   4779:             my $update=$env{'user.update.time'};
1.1335    raeburn  4780:             if (!$update) {
                   4781:                 $update = $then;
                   4782:             }
                   4783:             my @liveroles;
1.1334    raeburn  4784:             foreach my $role ('dh','da') {
                   4785:                 if ($env{"user.role.$role./$cdom/"}) {
1.1335    raeburn  4786:                     my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334    raeburn  4787:                     my $limit = $update;
                   4788:                     if ($env{'request.role'} eq "$role./$cdom/") {
                   4789:                         $limit = $then;
                   4790:                     }
1.1335    raeburn  4791:                     my $activerole = 1;
                   4792:                     if ($tstart && $tstart>$limit) { $activerole = 0; }
                   4793:                     if ($tend   && $tend  <$limit) { $activerole = 0; }
                   4794:                     if ($activerole) {
                   4795:                         push(@liveroles,$role);
                   4796:                     }
1.1334    raeburn  4797:                 }
1.1332    raeburn  4798:             }
1.1335    raeburn  4799:             if (@liveroles) {
1.1332    raeburn  4800:                 if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333    raeburn  4801:                     my ($accessref,$accessinfo,%access_in_dom);
                   4802:                     ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
                   4803:                     if (ref($roles_by_num) eq 'ARRAY') {
                   4804:                         if (@{$roles_by_num}) {
1.1332    raeburn  4805:                             my %settings;
                   4806:                             if ($env{'request.course.id'} eq $cid) {
                   4807:                                 foreach my $envkey (keys(%env)) {
                   4808:                                     if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
                   4809:                                         $settings{$1} = $env{$envkey};
                   4810:                                     }
                   4811:                                 }
                   4812:                             } else {
                   4813:                                 %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
                   4814:                             }
                   4815:                             my %setincrs;
                   4816:                             if ($settings{'internal.adhocaccess'}) {
                   4817:                                 map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
                   4818:                             }
                   4819:                             my @statuses;
                   4820:                             if ($env{'environment.inststatus'}) {
                   4821:                                 @statuses = split(/,/,$env{'environment.inststatus'});
                   4822:                             }
                   4823:                             my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333    raeburn  4824:                             if (ref($accessref) eq 'HASH') {
                   4825:                                 %access_in_dom = %{$accessref};
                   4826:                             }
                   4827:                             foreach my $role (@{$roles_by_num}) {
1.1332    raeburn  4828:                                 my ($curraccess,@okstatus,@personnel);
                   4829:                                 if ($setincrs{$role}) {
                   4830:                                     ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
                   4831:                                     if ($curraccess eq 'status') {
                   4832:                                         @okstatus = split(/\&/,$rest);
                   4833:                                     } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
                   4834:                                         @personnel = split(/\&/,$rest);
                   4835:                                     }
                   4836:                                 } else {
                   4837:                                     $curraccess = $access_in_dom{$role};
1.1333    raeburn  4838:                                     if (ref($accessinfo) eq 'HASH') {
                   4839:                                         if ($curraccess eq 'status') {
                   4840:                                             if (ref($accessinfo->{$role}) eq 'ARRAY') {
                   4841:                                                 @okstatus = @{$accessinfo->{$role}};
                   4842:                                             }
                   4843:                                         } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
                   4844:                                             if (ref($accessinfo->{$role}) eq 'ARRAY') {
                   4845:                                                 @personnel = @{$accessinfo->{$role}};
                   4846:                                             }
1.1332    raeburn  4847:                                         }
                   4848:                                     }
                   4849:                                 }
                   4850:                                 if ($curraccess eq 'none') {
                   4851:                                     next;
                   4852:                                 } elsif ($curraccess eq 'all') {
                   4853:                                     push(@possroles,$role);
1.1336    raeburn  4854:                                 } elsif ($curraccess eq 'dh') {
1.1335    raeburn  4855:                                     if (grep(/^dh$/,@liveroles)) {
                   4856:                                         push(@possroles,$role);
                   4857:                                     } else {
                   4858:                                         next;
                   4859:                                     }
1.1336    raeburn  4860:                                 } elsif ($curraccess eq 'da') {
1.1335    raeburn  4861:                                     if (grep(/^da$/,@liveroles)) {
                   4862:                                         push(@possroles,$role);
                   4863:                                     } else {
                   4864:                                         next;
                   4865:                                     }
1.1332    raeburn  4866:                                 } elsif ($curraccess eq 'status') {
                   4867:                                     if (@okstatus) {
                   4868:                                         if (!@statuses) {
                   4869:                                             if (grep(/^default$/,@okstatus)) {
                   4870:                                                 push(@possroles,$role);
                   4871:                                             }
                   4872:                                         } else {
                   4873:                                             foreach my $status (@okstatus) {
                   4874:                                                 if (grep(/^\Q$status\E$/,@statuses)) {
                   4875:                                                     push(@possroles,$role);
                   4876:                                                     last;
                   4877:                                                 }
                   4878:                                             }
                   4879:                                         }
                   4880:                                     }
                   4881:                                 } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
                   4882:                                     if (grep(/^\Q$user\E$/,@personnel)) {
                   4883:                                         if ($curraccess eq 'exc') {
                   4884:                                             push(@possroles,$role);
                   4885:                                         }
                   4886:                                     } elsif ($curraccess eq 'inc') {
                   4887:                                         push(@possroles,$role);
                   4888:                                     }
                   4889:                                 }
                   4890:                             }
                   4891:                         }
                   4892:                     }
                   4893:                 }
                   4894:             }
                   4895:         }
                   4896:     }
1.1333    raeburn  4897:     unless (ref($description) eq 'HASH') {
                   4898:         if (ref($roles_by_num) eq 'ARRAY') {
                   4899:             my %desc;
                   4900:             map { $desc{$_} = $_; } (@{$roles_by_num});
                   4901:             $description = \%desc;
                   4902:         } else {
                   4903:             $description = {};
                   4904:         }
                   4905:     }
                   4906:     return (\@possroles,$description);
1.1332    raeburn  4907: }
                   4908: 
1.399     www      4909: # ----------------------------------------------------- Frontpage Announcements
                   4910: #
                   4911: #
                   4912: 
                   4913: sub postannounce {
                   4914:     my ($server,$text)=@_;
1.844     albertel 4915:     unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399     www      4916:     unless ($text=~/\w/) { $text=''; }
                   4917:     return &reply('setannounce:'.&escape($text),$server);
                   4918: }
                   4919: 
                   4920: sub getannounce {
1.448     albertel 4921: 
1.1359    raeburn  4922:     if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399     www      4923: 	my $announcement='';
1.800     albertel 4924: 	while (my $line = <$fh>) { $announcement .= $line; }
1.448     albertel 4925: 	close($fh);
1.399     www      4926: 	if ($announcement=~/\w/) { 
                   4927: 	    return 
                   4928:    '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518     albertel 4929:    '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 
1.399     www      4930: 	} else {
                   4931: 	    return '';
                   4932: 	}
                   4933:     } else {
                   4934: 	return '';
                   4935:     }
1.351     www      4936: }
1.353     www      4937: 
                   4938: # ---------------------------------------------------------- Course ID routines
                   4939: # Deal with domain's nohist_courseid.db files
                   4940: #
                   4941: 
                   4942: sub courseidput {
1.921     raeburn  4943:     my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054    raeburn  4944:     return unless (ref($storehash) eq 'HASH');
1.921     raeburn  4945:     my $outcome;
                   4946:     if ($caller eq 'timeonly') {
                   4947:         my $cids = '';
                   4948:         foreach my $item (keys(%$storehash)) {
                   4949:             $cids.=&escape($item).'&';
                   4950:         }
                   4951:         $cids=~s/\&$//;
                   4952:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
                   4953:                           $coursehome);       
                   4954:     } else {
                   4955:         my $items = '';
                   4956:         foreach my $item (keys(%$storehash)) {
                   4957:             $items.= &escape($item).'='.
                   4958:                      &freeze_escape($$storehash{$item}).'&';
                   4959:         }
                   4960:         $items=~s/\&$//;
                   4961:         $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
                   4962:                           $coursehome);
1.918     raeburn  4963:     }
                   4964:     if ($outcome eq 'unknown_cmd') {
                   4965:         my $what;
                   4966:         foreach my $cid (keys(%$storehash)) {
                   4967:             $what .= &escape($cid).'=';
1.921     raeburn  4968:             foreach my $item ('description','inst_code','owner','type') {
1.936     raeburn  4969:                 $what .= &escape($storehash->{$cid}{$item}).':';
1.918     raeburn  4970:             }
                   4971:             $what =~ s/\:$/&/;
                   4972:         }
                   4973:         $what =~ s/\&$//;  
                   4974:         return &reply('courseidput:'.$domain.':'.$what,$coursehome);
                   4975:     } else {
                   4976:         return $outcome;
                   4977:     }
1.353     www      4978: }
                   4979: 
                   4980: sub courseiddump {
1.921     raeburn  4981:     my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947     raeburn  4982:         $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029    raeburn  4983:         $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247    raeburn  4984:         $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287    raeburn  4985:         $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918     raeburn  4986:     my $as_hash = 1;
                   4987:     my %returnhash;
                   4988:     if (!$domfilter) { $domfilter=''; }
1.845     albertel 4989:     my %libserv = &all_library();
                   4990:     foreach my $tryserver (keys(%libserv)) {
                   4991:         if ( (  $hostidflag == 1 
                   4992: 	        && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 
                   4993: 	     || (!defined($hostidflag)) ) {
                   4994: 
1.918     raeburn  4995: 	    if (($domfilter eq '') ||
                   4996: 		(&host_domain($tryserver) eq $domfilter)) {
1.1180    droeschl 4997:                 my $rep;
                   4998:                 if (grep { $_ eq $tryserver } current_machine_ids()) {
                   4999:                     $rep = LONCAPA::Lond::dump_course_id_handler(
                   5000:                         join(":", (&host_domain($tryserver), $sincefilter, 
                   5001:                                 &escape($descfilter), &escape($instcodefilter), 
                   5002:                                 &escape($ownerfilter), &escape($coursefilter),
                   5003:                                 &escape($typefilter), &escape($regexp_ok), 
                   5004:                                 $as_hash, &escape($selfenrollonly), 
                   5005:                                 &escape($catfilter), $showhidden, $caller, 
                   5006:                                 &escape($cloner), &escape($cc_clone), $cloneonly, 
                   5007:                                 &escape($createdbefore), &escape($createdafter), 
1.1287    raeburn  5008:                                 &escape($creationcontext),$domcloner,$hasuniquecode,
                   5009:                                 $reqcrsdom,&escape($reqinstcode))));
1.1180    droeschl 5010:                 } else {
                   5011:                     $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
                   5012:                              $sincefilter.':'.&escape($descfilter).':'.
                   5013:                              &escape($instcodefilter).':'.&escape($ownerfilter).
                   5014:                              ':'.&escape($coursefilter).':'.&escape($typefilter).
                   5015:                              ':'.&escape($regexp_ok).':'.$as_hash.':'.
                   5016:                              &escape($selfenrollonly).':'.&escape($catfilter).':'.
                   5017:                              $showhidden.':'.$caller.':'.&escape($cloner).':'.
                   5018:                              &escape($cc_clone).':'.$cloneonly.':'.
                   5019:                              &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287    raeburn  5020:                              &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
                   5021:                              ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180    droeschl 5022:                 }
                   5023:                      
1.918     raeburn  5024:                 my @pairs=split(/\&/,$rep);
                   5025:                 foreach my $item (@pairs) {
                   5026:                     my ($key,$value)=split(/\=/,$item,2);
                   5027:                     $key = &unescape($key);
                   5028:                     next if ($key =~ /^error: 2 /);
                   5029:                     my $result = &thaw_unescape($value);
                   5030:                     if (ref($result) eq 'HASH') {
                   5031:                         $returnhash{$key}=$result;
                   5032:                     } else {
1.921     raeburn  5033:                         my @responses = split(/:/,$value);
                   5034:                         my @items = ('description','inst_code','owner','type');
1.918     raeburn  5035:                         for (my $i=0; $i<@responses; $i++) {
1.921     raeburn  5036:                             $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918     raeburn  5037:                         }
1.1008    raeburn  5038:                     }
1.353     www      5039:                 }
                   5040:             }
                   5041:         }
                   5042:     }
                   5043:     return %returnhash;
                   5044: }
                   5045: 
1.1055    raeburn  5046: sub courselastaccess {
                   5047:     my ($cdom,$cnum,$hostidref) = @_;
                   5048:     my %returnhash;
                   5049:     if ($cdom && $cnum) {
                   5050:         my $chome = &homeserver($cnum,$cdom);
                   5051:         if ($chome ne 'no_host') {
                   5052:             my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
                   5053:             &extract_lastaccess(\%returnhash,$rep);
                   5054:         }
                   5055:     } else {
                   5056:         if (!$cdom) { $cdom=''; }
                   5057:         my %libserv = &all_library();
                   5058:         foreach my $tryserver (keys(%libserv)) {
                   5059:             if (ref($hostidref) eq 'ARRAY') {
                   5060:                 next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
                   5061:             } 
                   5062:             if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
                   5063:                 my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
                   5064:                 &extract_lastaccess(\%returnhash,$rep);
                   5065:             }
                   5066:         }
                   5067:     }
                   5068:     return %returnhash;
                   5069: }
                   5070: 
                   5071: sub extract_lastaccess {
                   5072:     my ($returnhash,$rep) = @_;
                   5073:     if (ref($returnhash) eq 'HASH') {
                   5074:         unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 
                   5075:                 $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
                   5076:                  $rep eq '') {
                   5077:             my @pairs=split(/\&/,$rep);
                   5078:             foreach my $item (@pairs) {
                   5079:                 my ($key,$value)=split(/\=/,$item,2);
                   5080:                 $key = &unescape($key);
                   5081:                 next if ($key =~ /^error: 2 /);
                   5082:                 $returnhash->{$key} = &thaw_unescape($value);
                   5083:             }
                   5084:         }
                   5085:     }
                   5086:     return;
                   5087: }
                   5088: 
1.658     raeburn  5089: # ---------------------------------------------------------- DC e-mail
1.662     raeburn  5090: 
                   5091: sub dcmailput {
1.685     raeburn  5092:     my ($domain,$msgid,$message,$server)=@_;
1.662     raeburn  5093:     my $status = &Apache::lonnet::critical(
1.740     www      5094:        'dcmailput:'.$domain.':'.&escape($msgid).'='.
                   5095:        &escape($message),$server);
1.662     raeburn  5096:     return $status;
                   5097: }
                   5098: 
1.658     raeburn  5099: sub dcmaildump {
                   5100:     my ($dom,$startdate,$enddate,$senders) = @_;
1.685     raeburn  5101:     my %returnhash=();
1.846     albertel 5102: 
                   5103:     if (defined(&domain($dom,'primary'))) {
1.685     raeburn  5104:         my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
                   5105:                                                          &escape($enddate).':';
                   5106: 	my @esc_senders=map { &escape($_)} @$senders;
                   5107: 	$cmd.=&escape(join('&',@esc_senders));
1.846     albertel 5108: 	foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800     albertel 5109:             my ($key,$value) = split(/\=/,$line,2);
1.685     raeburn  5110:             if (($key) && ($value)) {
                   5111:                 $returnhash{&unescape($key)} = &unescape($value);
1.658     raeburn  5112:             }
                   5113:         }
                   5114:     }
                   5115:     return %returnhash;
                   5116: }
1.662     raeburn  5117: # ---------------------------------------------------------- Domain roles
                   5118: 
                   5119: sub get_domain_roles {
                   5120:     my ($dom,$roles,$startdate,$enddate)=@_;
1.1018    raeburn  5121:     if ((!defined($startdate)) || ($startdate eq '')) {
1.662     raeburn  5122:         $startdate = '.';
                   5123:     }
1.1018    raeburn  5124:     if ((!defined($enddate)) || ($enddate eq '')) {
1.662     raeburn  5125:         $enddate = '.';
                   5126:     }
1.922     raeburn  5127:     my $rolelist;
                   5128:     if (ref($roles) eq 'ARRAY') {
1.1219    raeburn  5129:         $rolelist = join('&',@{$roles});
1.922     raeburn  5130:     }
1.662     raeburn  5131:     my %personnel = ();
1.841     albertel 5132: 
                   5133:     my %servers = &get_servers($dom,'library');
                   5134:     foreach my $tryserver (keys(%servers)) {
                   5135: 	%{$personnel{$tryserver}}=();
                   5136: 	foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
                   5137: 					    &escape($startdate).':'.
                   5138: 					    &escape($enddate).':'.
                   5139: 					    &escape($rolelist), $tryserver))) {
                   5140: 	    my ($key,$value) = split(/\=/,$line,2);
                   5141: 	    if (($key) && ($value)) {
                   5142: 		$personnel{$tryserver}{&unescape($key)} = &unescape($value);
                   5143: 	    }
                   5144: 	}
1.662     raeburn  5145:     }
                   5146:     return %personnel;
                   5147: }
1.658     raeburn  5148: 
1.1332    raeburn  5149: sub get_active_domroles {
                   5150:     my ($dom,$roles) = @_;
                   5151:     return () unless (ref($roles) eq 'ARRAY');
                   5152:     my $now = time;
                   5153:     my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
                   5154:     my %domroles;
                   5155:     foreach my $server (keys(%dompersonnel)) {
                   5156:         foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
                   5157:             my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
                   5158:             $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
                   5159:         }
                   5160:     }
                   5161:     return %domroles;
                   5162: }
                   5163: 
1.1057    www      5164: # ----------------------------------------------------------- Interval timing 
1.149     www      5165: 
1.1153    www      5166: {
                   5167: # Caches needed for speedup of navmaps
                   5168: # We don't want to cache this for very long at all (5 seconds at most)
                   5169: # 
                   5170: # The user for whom we cache
                   5171: my $cachedkey='';
                   5172: # The cached times for this user
                   5173: my %cachedtimes=();
                   5174: # When this was last done
1.1282    raeburn  5175: my $cachedtime='';
1.1153    www      5176: 
                   5177: sub load_all_first_access {
1.1308    raeburn  5178:     my ($uname,$udom,$ignorecache)=@_;
1.1156    www      5179:     if (($cachedkey eq $uname.':'.$udom) &&
1.1308    raeburn  5180:         (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
                   5181:         (!$ignorecache)) {
1.1154    raeburn  5182:         return;
                   5183:     }
                   5184:     $cachedtime=time;
                   5185:     $cachedkey=$uname.':'.$udom;
                   5186:     %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153    www      5187: }
                   5188: 
1.504     albertel 5189: sub get_first_access {
1.1308    raeburn  5190:     my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790     albertel 5191:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 5192:     if ($argsymb) { $symb=$argsymb; }
                   5193:     my ($map,$id,$res)=&decode_symb($symb);
1.1162    raeburn  5194:     if ($argmap) { $map = $argmap; }
1.926     albertel 5195:     if ($type eq 'course') {
                   5196: 	$res='course';
                   5197:     } elsif ($type eq 'map') {
1.588     albertel 5198: 	$res=&symbread($map);
                   5199:     } else {
                   5200: 	$res=$symb;
                   5201:     }
1.1308    raeburn  5202:     &load_all_first_access($uname,$udom,$ignorecache);
1.1153    www      5203:     return $cachedtimes{"$courseid\0$res"};
1.504     albertel 5204: }
                   5205: 
                   5206: sub set_first_access {
1.1162    raeburn  5207:     my ($type,$interval)=@_;
1.790     albertel 5208:     my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504     albertel 5209:     my ($map,$id,$res)=&decode_symb($symb);
1.928     albertel 5210:     if ($type eq 'course') {
                   5211: 	$res='course';
                   5212:     } elsif ($type eq 'map') {
1.588     albertel 5213: 	$res=&symbread($map);
                   5214:     } else {
                   5215: 	$res=$symb;
                   5216:     }
1.1153    www      5217:     $cachedkey='';
1.1162    raeburn  5218:     my $firstaccess=&get_first_access($type,$symb,$map);
1.505     albertel 5219:     if (!$firstaccess) {
1.1162    raeburn  5220:         my $start = time;
                   5221: 	my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
                   5222:                           $udom,$uname);
                   5223:         if ($putres eq 'ok') {
                   5224:             &put('timerinterval',{"$courseid\0$res"=>$interval},
                   5225:                  $udom,$uname); 
                   5226:             &appenv(
                   5227:                      {
                   5228:                         'course.'.$courseid.'.firstaccess.'.$res   => $start,
                   5229:                         'course.'.$courseid.'.timerinterval.'.$res => $interval,
                   5230:                      }
                   5231:                   );
1.1365    raeburn  5232:             if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
                   5233:                 $cachedtimes{"$courseid\0$res"} = $start;
                   5234:             }
1.1162    raeburn  5235:         }
                   5236:         return $putres;
1.505     albertel 5237:     }
                   5238:     return 'already_set';
1.504     albertel 5239: }
1.1153    www      5240: }
1.1282    raeburn  5241: 
1.110     www      5242: # --------------------------------------------- Set Expire Date for Spreadsheet
                   5243: 
                   5244: sub expirespread {
                   5245:     my ($uname,$udom,$stype,$usymb)=@_;
1.620     albertel 5246:     my $cid=$env{'request.course.id'}; 
1.110     www      5247:     if ($cid) {
                   5248:        my $now=time;
                   5249:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620     albertel 5250:        return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
                   5251:                             $env{'course.'.$cid.'.num'}.
1.110     www      5252: 	        	    ':nohist_expirationdates:'.
                   5253:                             &escape($key).'='.$now,
1.620     albertel 5254:                             $env{'course.'.$cid.'.home'})
1.110     www      5255:     }
                   5256:     return 'ok';
1.14      www      5257: }
                   5258: 
1.109     www      5259: # ----------------------------------------------------- Devalidate Spreadsheets
                   5260: 
                   5261: sub devalidate {
1.325     www      5262:     my ($symb,$uname,$udom)=@_;
1.620     albertel 5263:     my $cid=$env{'request.course.id'}; 
1.109     www      5264:     if ($cid) {
1.391     matthew  5265:         # delete the stored spreadsheets for
                   5266:         # - the student level sheet of this user in course's homespace
                   5267:         # - the assessment level sheet for this resource 
                   5268:         #   for this user in user's homespace
1.553     albertel 5269: 	# - current conditional state info
1.325     www      5270: 	my $key=$uname.':'.$udom.':';
1.109     www      5271:         my $status=
1.299     matthew  5272: 	    &del('nohist_calculatedsheets',
1.391     matthew  5273: 		 [$key.'studentcalc:'],
1.620     albertel 5274: 		 $env{'course.'.$cid.'.domain'},
                   5275: 		 $env{'course.'.$cid.'.num'})
1.133     albertel 5276: 		.' '.
                   5277: 	    &del('nohist_calculatedsheets_'.$cid,
1.391     matthew  5278: 		 [$key.'assesscalc:'.$symb],$udom,$uname);
1.109     www      5279:         unless ($status eq 'ok ok') {
                   5280:            &logthis('Could not devalidate spreadsheet '.
1.325     www      5281:                     $uname.' at '.$udom.' for '.
1.109     www      5282: 		    $symb.': '.$status);
1.133     albertel 5283:         }
1.553     albertel 5284: 	&delenv('user.state.'.$cid);
1.109     www      5285:     }
                   5286: }
                   5287: 
1.265     albertel 5288: sub get_scalar {
                   5289:     my ($string,$end) = @_;
                   5290:     my $value;
                   5291:     if ($$string =~ s/^([^&]*?)($end)/$2/) {
                   5292: 	$value = $1;
                   5293:     } elsif ($$string =~ s/^([^&]*?)&//) {
                   5294: 	$value = $1;
                   5295:     }
                   5296:     return &unescape($value);
                   5297: }
                   5298: 
                   5299: sub array2str {
                   5300:   my (@array) = @_;
                   5301:   my $result=&arrayref2str(\@array);
                   5302:   $result=~s/^__ARRAY_REF__//;
                   5303:   $result=~s/__END_ARRAY_REF__$//;
                   5304:   return $result;
                   5305: }
                   5306: 
1.204     albertel 5307: sub arrayref2str {
                   5308:   my ($arrayref) = @_;
1.265     albertel 5309:   my $result='__ARRAY_REF__';
1.204     albertel 5310:   foreach my $elem (@$arrayref) {
1.265     albertel 5311:     if(ref($elem) eq 'ARRAY') {
                   5312:       $result.=&arrayref2str($elem).'&';
                   5313:     } elsif(ref($elem) eq 'HASH') {
                   5314:       $result.=&hashref2str($elem).'&';
                   5315:     } elsif(ref($elem)) {
                   5316:       #print("Got a ref of ".(ref($elem))." skipping.");
1.204     albertel 5317:     } else {
                   5318:       $result.=&escape($elem).'&';
                   5319:     }
                   5320:   }
                   5321:   $result=~s/\&$//;
1.265     albertel 5322:   $result .= '__END_ARRAY_REF__';
1.204     albertel 5323:   return $result;
                   5324: }
                   5325: 
1.168     albertel 5326: sub hash2str {
1.204     albertel 5327:   my (%hash) = @_;
                   5328:   my $result=&hashref2str(\%hash);
1.265     albertel 5329:   $result=~s/^__HASH_REF__//;
                   5330:   $result=~s/__END_HASH_REF__$//;
1.204     albertel 5331:   return $result;
                   5332: }
                   5333: 
                   5334: sub hashref2str {
                   5335:   my ($hashref)=@_;
1.265     albertel 5336:   my $result='__HASH_REF__';
1.800     albertel 5337:   foreach my $key (sort(keys(%$hashref))) {
                   5338:     if (ref($key) eq 'ARRAY') {
                   5339:       $result.=&arrayref2str($key).'=';
                   5340:     } elsif (ref($key) eq 'HASH') {
                   5341:       $result.=&hashref2str($key).'=';
                   5342:     } elsif (ref($key)) {
1.265     albertel 5343:       $result.='=';
1.800     albertel 5344:       #print("Got a ref of ".(ref($key))." skipping.");
1.204     albertel 5345:     } else {
1.1132    raeburn  5346: 	if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204     albertel 5347:     }
                   5348: 
1.800     albertel 5349:     if(ref($hashref->{$key}) eq 'ARRAY') {
                   5350:       $result.=&arrayref2str($hashref->{$key}).'&';
                   5351:     } elsif(ref($hashref->{$key}) eq 'HASH') {
                   5352:       $result.=&hashref2str($hashref->{$key}).'&';
                   5353:     } elsif(ref($hashref->{$key})) {
1.265     albertel 5354:        $result.='&';
1.800     albertel 5355:       #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204     albertel 5356:     } else {
1.800     albertel 5357:       $result.=&escape($hashref->{$key}).'&';
1.204     albertel 5358:     }
                   5359:   }
1.168     albertel 5360:   $result=~s/\&$//;
1.265     albertel 5361:   $result .= '__END_HASH_REF__';
1.168     albertel 5362:   return $result;
                   5363: }
                   5364: 
                   5365: sub str2hash {
1.265     albertel 5366:     my ($string)=@_;
                   5367:     my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
                   5368:     return %$hash;
                   5369: }
                   5370: 
                   5371: sub str2hashref {
1.168     albertel 5372:   my ($string) = @_;
1.265     albertel 5373: 
                   5374:   my %hash;
                   5375: 
                   5376:   if($string !~ /^__HASH_REF__/) {
                   5377:       if (! ($string eq '' || !defined($string))) {
                   5378: 	  $hash{'error'}='Not hash reference';
                   5379:       }
                   5380:       return (\%hash, $string);
                   5381:   }
                   5382: 
                   5383:   $string =~ s/^__HASH_REF__//;
                   5384: 
                   5385:   while($string !~ /^__END_HASH_REF__/) {
                   5386:       #key
                   5387:       my $key='';
                   5388:       if($string =~ /^__HASH_REF__/) {
                   5389:           ($key, $string)=&str2hashref($string);
                   5390:           if(defined($key->{'error'})) {
                   5391:               $hash{'error'}='Bad data';
                   5392:               return (\%hash, $string);
                   5393:           }
                   5394:       } elsif($string =~ /^__ARRAY_REF__/) {
                   5395:           ($key, $string)=&str2arrayref($string);
                   5396:           if($key->[0] eq 'Array reference error') {
                   5397:               $hash{'error'}='Bad data';
                   5398:               return (\%hash, $string);
                   5399:           }
                   5400:       } else {
                   5401:           $string =~ s/^(.*?)=//;
1.267     albertel 5402: 	  $key=&unescape($1);
1.265     albertel 5403:       }
                   5404:       $string =~ s/^=//;
                   5405: 
                   5406:       #value
                   5407:       my $value='';
                   5408:       if($string =~ /^__HASH_REF__/) {
                   5409:           ($value, $string)=&str2hashref($string);
                   5410:           if(defined($value->{'error'})) {
                   5411:               $hash{'error'}='Bad data';
                   5412:               return (\%hash, $string);
                   5413:           }
                   5414:       } elsif($string =~ /^__ARRAY_REF__/) {
                   5415:           ($value, $string)=&str2arrayref($string);
                   5416:           if($value->[0] eq 'Array reference error') {
                   5417:               $hash{'error'}='Bad data';
                   5418:               return (\%hash, $string);
                   5419:           }
                   5420:       } else {
                   5421: 	  $value=&get_scalar(\$string,'__END_HASH_REF__');
                   5422:       }
                   5423:       $string =~ s/^&//;
                   5424: 
                   5425:       $hash{$key}=$value;
1.204     albertel 5426:   }
1.265     albertel 5427: 
                   5428:   $string =~ s/^__END_HASH_REF__//;
                   5429: 
                   5430:   return (\%hash, $string);
1.204     albertel 5431: }
                   5432: 
                   5433: sub str2array {
1.265     albertel 5434:     my ($string)=@_;
                   5435:     my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
                   5436:     return @$array;
                   5437: }
                   5438: 
                   5439: sub str2arrayref {
1.204     albertel 5440:   my ($string) = @_;
1.265     albertel 5441:   my @array;
                   5442: 
                   5443:   if($string !~ /^__ARRAY_REF__/) {
                   5444:       if (! ($string eq '' || !defined($string))) {
                   5445: 	  $array[0]='Array reference error';
                   5446:       }
                   5447:       return (\@array, $string);
                   5448:   }
                   5449: 
                   5450:   $string =~ s/^__ARRAY_REF__//;
                   5451: 
                   5452:   while($string !~ /^__END_ARRAY_REF__/) {
                   5453:       my $value='';
                   5454:       if($string =~ /^__HASH_REF__/) {
                   5455:           ($value, $string)=&str2hashref($string);
                   5456:           if(defined($value->{'error'})) {
                   5457:               $array[0] ='Array reference error';
                   5458:               return (\@array, $string);
                   5459:           }
                   5460:       } elsif($string =~ /^__ARRAY_REF__/) {
                   5461:           ($value, $string)=&str2arrayref($string);
                   5462:           if($value->[0] eq 'Array reference error') {
                   5463:               $array[0] ='Array reference error';
                   5464:               return (\@array, $string);
                   5465:           }
                   5466:       } else {
                   5467: 	  $value=&get_scalar(\$string,'__END_ARRAY_REF__');
                   5468:       }
                   5469:       $string =~ s/^&//;
                   5470: 
                   5471:       push(@array, $value);
1.191     harris41 5472:   }
1.265     albertel 5473: 
                   5474:   $string =~ s/^__END_ARRAY_REF__//;
                   5475: 
                   5476:   return (\@array, $string);
1.168     albertel 5477: }
                   5478: 
1.167     albertel 5479: # -------------------------------------------------------------------Temp Store
                   5480: 
1.168     albertel 5481: sub tmpreset {
                   5482:   my ($symb,$namespace,$domain,$stuname) = @_;
                   5483:   if (!$symb) {
                   5484:     $symb=&symbread();
1.620     albertel 5485:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 5486:   }
                   5487:   $symb=escape($symb);
                   5488: 
1.620     albertel 5489:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.168     albertel 5490:   $namespace=~s/\//\_/g;
                   5491:   $namespace=~s/\W//g;
                   5492: 
1.620     albertel 5493:   if (!$domain) { $domain=$env{'user.domain'}; }
                   5494:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 5495:   if ($domain eq 'public' && $stuname eq 'public') {
                   5496:       $stuname=$ENV{'REMOTE_ADDR'};
                   5497:   }
1.1117    foxr     5498:   my $path=LONCAPA::tempdir();
1.168     albertel 5499:   my %hash;
                   5500:   if (tie(%hash,'GDBM_File',
                   5501: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 5502: 	  &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  5503:     foreach my $key (keys(%hash)) {
1.180     albertel 5504:       if ($key=~ /:$symb/) {
1.168     albertel 5505: 	delete($hash{$key});
                   5506:       }
                   5507:     }
                   5508:   }
                   5509: }
                   5510: 
1.167     albertel 5511: sub tmpstore {
1.168     albertel 5512:   my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   5513: 
                   5514:   if (!$symb) {
                   5515:     $symb=&symbread();
1.620     albertel 5516:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 5517:   }
                   5518:   $symb=escape($symb);
                   5519: 
                   5520:   if (!$namespace) {
                   5521:     # I don't think we would ever want to store this for a course.
                   5522:     # it seems this will only be used if we don't have a course.
1.620     albertel 5523:     #$namespace=$env{'request.course.id'};
1.168     albertel 5524:     #if (!$namespace) {
1.620     albertel 5525:       $namespace=$env{'request.state'};
1.168     albertel 5526:     #}
                   5527:   }
                   5528:   $namespace=~s/\//\_/g;
                   5529:   $namespace=~s/\W//g;
1.620     albertel 5530:   if (!$domain) { $domain=$env{'user.domain'}; }
                   5531:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 5532:   if ($domain eq 'public' && $stuname eq 'public') {
                   5533:       $stuname=$ENV{'REMOTE_ADDR'};
                   5534:   }
1.168     albertel 5535:   my $now=time;
                   5536:   my %hash;
1.1117    foxr     5537:   my $path=LONCAPA::tempdir();
1.168     albertel 5538:   if (tie(%hash,'GDBM_File',
                   5539: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 5540: 	  &GDBM_WRCREAT(),0640)) {
1.168     albertel 5541:     $hash{"version:$symb"}++;
                   5542:     my $version=$hash{"version:$symb"};
                   5543:     my $allkeys=''; 
                   5544:     foreach my $key (keys(%$storehash)) {
                   5545:       $allkeys.=$key.':';
1.591     albertel 5546:       $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168     albertel 5547:     }
                   5548:     $hash{"$version:$symb:timestamp"}=$now;
                   5549:     $allkeys.='timestamp';
                   5550:     $hash{"$version:keys:$symb"}=$allkeys;
                   5551:     if (untie(%hash)) {
                   5552:       return 'ok';
                   5553:     } else {
                   5554:       return "error:$!";
                   5555:     }
                   5556:   } else {
                   5557:     return "error:$!";
                   5558:   }
                   5559: }
1.167     albertel 5560: 
1.168     albertel 5561: # -----------------------------------------------------------------Temp Restore
1.167     albertel 5562: 
1.168     albertel 5563: sub tmprestore {
                   5564:   my ($symb,$namespace,$domain,$stuname) = @_;
1.167     albertel 5565: 
1.168     albertel 5566:   if (!$symb) {
                   5567:     $symb=&symbread();
1.620     albertel 5568:     if (!$symb) { $symb= $env{'request.url'}; }
1.168     albertel 5569:   }
                   5570:   $symb=escape($symb);
                   5571: 
1.620     albertel 5572:   if (!$namespace) { $namespace=$env{'request.state'}; }
1.591     albertel 5573: 
1.620     albertel 5574:   if (!$domain) { $domain=$env{'user.domain'}; }
                   5575:   if (!$stuname) { $stuname=$env{'user.name'}; }
1.591     albertel 5576:   if ($domain eq 'public' && $stuname eq 'public') {
                   5577:       $stuname=$ENV{'REMOTE_ADDR'};
                   5578:   }
1.168     albertel 5579:   my %returnhash;
                   5580:   $namespace=~s/\//\_/g;
                   5581:   $namespace=~s/\W//g;
                   5582:   my %hash;
1.1117    foxr     5583:   my $path=LONCAPA::tempdir();
1.168     albertel 5584:   if (tie(%hash,'GDBM_File',
                   5585: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 5586: 	  &GDBM_READER(),0640)) {
1.168     albertel 5587:     my $version=$hash{"version:$symb"};
                   5588:     $returnhash{'version'}=$version;
                   5589:     my $scope;
                   5590:     for ($scope=1;$scope<=$version;$scope++) {
                   5591:       my $vkeys=$hash{"$scope:keys:$symb"};
                   5592:       my @keys=split(/:/,$vkeys);
                   5593:       my $key;
                   5594:       $returnhash{"$scope:keys"}=$vkeys;
                   5595:       foreach $key (@keys) {
1.591     albertel 5596: 	$returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
                   5597: 	$returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167     albertel 5598:       }
                   5599:     }
1.168     albertel 5600:     if (!(untie(%hash))) {
                   5601:       return "error:$!";
                   5602:     }
                   5603:   } else {
                   5604:     return "error:$!";
                   5605:   }
                   5606:   return %returnhash;
1.167     albertel 5607: }
                   5608: 
1.9       www      5609: # ----------------------------------------------------------------------- Store
                   5610: 
                   5611: sub store {
1.1269    raeburn  5612:     my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124     www      5613:     my $home='';
                   5614: 
1.168     albertel 5615:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      5616: 
1.213     www      5617:     $symb=&symbclean($symb);
1.122     albertel 5618:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      5619: 
1.620     albertel 5620:     if (!$domain) { $domain=$env{'user.domain'}; }
                   5621:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      5622: 
                   5623:     &devalidate($symb,$stuname,$domain);
1.109     www      5624: 
                   5625:     $symb=escape($symb);
1.187     www      5626:     if (!$namespace) { 
1.620     albertel 5627:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      5628:           return ''; 
                   5629:        } 
                   5630:     }
1.620     albertel 5631:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      5632: 
                   5633:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   5634:     $$storehash{'host'}=$perlvar{'lonHostID'};
                   5635: 
1.12      www      5636:     my $namevalue='';
1.800     albertel 5637:     foreach my $key (keys(%$storehash)) {
                   5638:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 5639:     }
1.12      www      5640:     $namevalue=~s/\&$//;
1.187     www      5641:     &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269    raeburn  5642:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9       www      5643: }
                   5644: 
1.47      www      5645: # -------------------------------------------------------------- Critical Store
                   5646: 
                   5647: sub cstore {
1.1269    raeburn  5648:     my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124     www      5649:     my $home='';
                   5650: 
1.168     albertel 5651:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      5652: 
1.213     www      5653:     $symb=&symbclean($symb);
1.122     albertel 5654:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      5655: 
1.620     albertel 5656:     if (!$domain) { $domain=$env{'user.domain'}; }
                   5657:     if (!$stuname) { $stuname=$env{'user.name'}; }
1.325     www      5658: 
                   5659:     &devalidate($symb,$stuname,$domain);
1.109     www      5660: 
                   5661:     $symb=escape($symb);
1.187     www      5662:     if (!$namespace) { 
1.620     albertel 5663:        unless ($namespace=$env{'request.course.id'}) { 
1.187     www      5664:           return ''; 
                   5665:        } 
                   5666:     }
1.620     albertel 5667:     if (!$home) { $home=$env{'user.home'}; }
1.447     www      5668: 
                   5669:     $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
                   5670:     $$storehash{'host'}=$perlvar{'lonHostID'};
1.122     albertel 5671: 
1.47      www      5672:     my $namevalue='';
1.800     albertel 5673:     foreach my $key (keys(%$storehash)) {
                   5674:         $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191     harris41 5675:     }
1.47      www      5676:     $namevalue=~s/\&$//;
1.187     www      5677:     &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188     www      5678:     return critical
1.1269    raeburn  5679:                 ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47      www      5680: }
                   5681: 
1.9       www      5682: # --------------------------------------------------------------------- Restore
                   5683: 
                   5684: sub restore {
1.124     www      5685:     my ($symb,$namespace,$domain,$stuname) = @_;
                   5686:     my $home='';
                   5687: 
1.168     albertel 5688:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      5689: 
1.122     albertel 5690:     if (!$symb) {
1.1224    raeburn  5691:         return if ($namespace eq 'courserequests');
                   5692:         unless ($symb=escape(&symbread())) { return ''; }
1.122     albertel 5693:     } else {
1.1224    raeburn  5694:         unless ($namespace eq 'courserequests') {
                   5695:             $symb=&escape(&symbclean($symb));
                   5696:         }
1.122     albertel 5697:     }
1.188     www      5698:     if (!$namespace) { 
1.620     albertel 5699:        unless ($namespace=$env{'request.course.id'}) { 
1.188     www      5700:           return ''; 
                   5701:        } 
                   5702:     }
1.620     albertel 5703:     if (!$domain) { $domain=$env{'user.domain'}; }
                   5704:     if (!$stuname) { $stuname=$env{'user.name'}; }
                   5705:     if (!$home) { $home=$env{'user.home'}; }
1.122     albertel 5706:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
                   5707: 
1.12      www      5708:     my %returnhash=();
1.800     albertel 5709:     foreach my $line (split(/\&/,$answer)) {
                   5710: 	my ($name,$value)=split(/\=/,$line);
1.591     albertel 5711:         $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191     harris41 5712:     }
1.75      www      5713:     my $version;
                   5714:     for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800     albertel 5715:        foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
                   5716:           $returnhash{$item}=$returnhash{$version.':'.$item};
1.191     harris41 5717:        }
1.75      www      5718:     }
1.13      www      5719:     return %returnhash;
1.34      www      5720: }
                   5721: 
                   5722: # ---------------------------------------------------------- Course Description
1.1118    foxr     5723: #
                   5724: #  
1.34      www      5725: 
                   5726: sub coursedescription {
1.731     albertel 5727:     my ($courseid,$args)=@_;
1.34      www      5728:     $courseid=~s/^\///;
1.49      www      5729:     $courseid=~s/\_/\//g;
1.34      www      5730:     my ($cdomain,$cnum)=split(/\//,$courseid);
1.129     albertel 5731:     my $chome=&homeserver($cnum,$cdomain);
1.302     albertel 5732:     my $normalid=$cdomain.'_'.$cnum;
                   5733:     # need to always cache even if we get errors otherwise we keep 
                   5734:     # trying and trying and trying to get the course description.
                   5735:     my %envhash=();
                   5736:     my %returnhash=();
1.731     albertel 5737:     
                   5738:     my $expiretime=600;
                   5739:     if ($env{'request.course.id'} eq $normalid) {
                   5740: 	$expiretime=120;
                   5741:     }
                   5742: 
                   5743:     my $prefix='course.'.$cdomain.'_'.$cnum.'.';
                   5744:     if (!$args->{'freshen_cache'}
                   5745: 	&& ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
                   5746: 	foreach my $key (keys(%env)) {
                   5747: 	    next if ($key !~ /^\Q$prefix\E(.*)/);
                   5748: 	    my ($setting) = $1;
                   5749: 	    $returnhash{$setting} = $env{$key};
                   5750: 	}
                   5751: 	return %returnhash;
                   5752:     }
                   5753: 
1.1118    foxr     5754:     # get the data again
                   5755: 
1.731     albertel 5756:     if (!$args->{'one_time'}) {
                   5757: 	$envhash{'course.'.$normalid.'.last_cache'}=time;
                   5758:     }
1.811     albertel 5759: 
1.34      www      5760:     if ($chome ne 'no_host') {
1.302     albertel 5761:        %returnhash=&dump('environment',$cdomain,$cnum);
1.129     albertel 5762:        if (!exists($returnhash{'con_lost'})) {
1.1118    foxr     5763: 	   my $username = $env{'user.name'}; # Defult username
                   5764: 	   if(defined $args->{'user'}) {
                   5765: 	       $username = $args->{'user'};
                   5766: 	   }
1.129     albertel 5767:            $returnhash{'home'}= $chome;
                   5768: 	   $returnhash{'domain'} = $cdomain;
                   5769: 	   $returnhash{'num'} = $cnum;
1.741     raeburn  5770:            if (!defined($returnhash{'type'})) {
                   5771:                $returnhash{'type'} = 'Course';
                   5772:            }
1.130     albertel 5773:            while (my ($name,$value) = each %returnhash) {
1.53      www      5774:                $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129     albertel 5775:            }
1.270     www      5776:            $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117    foxr     5777:            $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118    foxr     5778: 	       $username.'_'.$cdomain.'_'.$cnum;
1.60      www      5779:            $envhash{'course.'.$normalid.'.home'}=$chome;
                   5780:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
                   5781:            $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34      www      5782:        }
                   5783:     }
1.731     albertel 5784:     if (!$args->{'one_time'}) {
1.949     raeburn  5785: 	&appenv(\%envhash);
1.731     albertel 5786:     }
1.302     albertel 5787:     return %returnhash;
1.461     www      5788: }
                   5789: 
1.1080    raeburn  5790: sub update_released_required {
                   5791:     my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
                   5792:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   5793:         $cid = $env{'request.course.id'};
                   5794:         $cdom = $env{'course.'.$cid.'.domain'};
                   5795:         $cnum = $env{'course.'.$cid.'.num'};
                   5796:         $chome = $env{'course.'.$cid.'.home'};
                   5797:     }
                   5798:     if ($needsrelease) {
                   5799:         my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
                   5800:         my $needsupdate;
                   5801:         if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
                   5802:             $needsupdate = 1;
                   5803:         } else {
                   5804:             my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   5805:             my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
                   5806:             if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
                   5807:                 $needsupdate = 1;
                   5808:             }
                   5809:         }
                   5810:         if ($needsupdate) {
                   5811:             my %needshash = (
                   5812:                              'internal.releaserequired' => $needsrelease,
                   5813:                             );
                   5814:             my $putresult = &put('environment',\%needshash,$cdom,$cnum);
                   5815:             if ($putresult eq 'ok') {
                   5816:                 &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
                   5817:                 my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
                   5818:                 if (ref($crsinfo{$cid}) eq 'HASH') {
                   5819:                     $crsinfo{$cid}{'releaserequired'} = $needsrelease;
                   5820:                     &courseidput($cdom,\%crsinfo,$chome,'notime');
                   5821:                 }
                   5822:             }
                   5823:         }
                   5824:     }
                   5825:     return;
                   5826: }
                   5827: 
1.461     www      5828: # -------------------------------------------------See if a user is privileged
                   5829: 
                   5830: sub privileged {
1.1219    raeburn  5831:     my ($username,$domain,$possdomains,$possroles)=@_;
1.1170    droeschl 5832:     my $now = time;
1.1219    raeburn  5833:     my $roles;
                   5834:     if (ref($possroles) eq 'ARRAY') {
                   5835:         $roles = $possroles; 
                   5836:     } else {
                   5837:         $roles = ['dc','su'];
                   5838:     }
                   5839:     if (ref($possdomains) eq 'ARRAY') {
                   5840:         my %privileged = &privileged_by_domain($possdomains,$roles);
                   5841:         foreach my $dom (@{$possdomains}) {
                   5842:             if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
                   5843:                 (ref($privileged{$dom}) eq 'HASH')) {
                   5844:                 foreach my $role (@{$roles}) {
                   5845:                     if (ref($privileged{$dom}{$role}) eq 'HASH') {
                   5846:                         if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
                   5847:                             my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
                   5848:                             return 1 unless (($end && $end < $now) ||
                   5849:                                              ($start && $start > $now));
                   5850:                         }
                   5851:                     }
                   5852:                 }
                   5853:             }
                   5854:         }
                   5855:     } else {
                   5856:         my %rolesdump = &dump("roles", $domain, $username) or return 0;
                   5857:         my $now = time;
1.1170    droeschl 5858: 
1.1275    musolffc 5859:         for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170    droeschl 5860:             my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219    raeburn  5861:             if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170    droeschl 5862:                 return 1 unless ($tend && $tend < $now) 
1.1219    raeburn  5863:                         or ($tstart && $tstart > $now);
1.1170    droeschl 5864:             }
1.1219    raeburn  5865:         }
                   5866:     }
                   5867:     return 0;
                   5868: }
1.1170    droeschl 5869: 
1.1219    raeburn  5870: sub privileged_by_domain {
                   5871:     my ($domains,$roles) = @_;
                   5872:     my %privileged = ();
                   5873:     my $cachetime = 60*60*24;
                   5874:     my $now = time;
                   5875:     unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
                   5876:         return %privileged;
                   5877:     }
                   5878:     foreach my $dom (@{$domains}) {
                   5879:         next if (ref($privileged{$dom}) eq 'HASH');
                   5880:         my $needroles;
                   5881:         foreach my $role (@{$roles}) {
                   5882:             my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
                   5883:             if (defined($cached)) {
                   5884:                 if (ref($result) eq 'HASH') {
                   5885:                     $privileged{$dom}{$role} = $result;
                   5886:                 }
                   5887:             } else {
                   5888:                 $needroles = 1;
                   5889:             }
                   5890:         }
                   5891:         if ($needroles) {
                   5892:             my %dompersonnel = &get_domain_roles($dom,$roles);
                   5893:             $privileged{$dom} = {};
                   5894:             foreach my $server (keys(%dompersonnel)) {
                   5895:                 if (ref($dompersonnel{$server}) eq 'HASH') {
                   5896:                     foreach my $item (keys(%{$dompersonnel{$server}})) {
                   5897:                         my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
                   5898:                         my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
                   5899:                         next if ($end && $end < $now);
                   5900:                         $privileged{$dom}{$trole}{$uname.':'.$udom} = 
                   5901:                             $dompersonnel{$server}{$item};
                   5902:                     }
                   5903:                 }
                   5904:             }
                   5905:             if (ref($privileged{$dom}) eq 'HASH') {
                   5906:                 foreach my $role (@{$roles}) {
                   5907:                     if (ref($privileged{$dom}{$role}) eq 'HASH') {
                   5908:                         &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
                   5909:                     } else {
                   5910:                         my %hash = ();
                   5911:                         &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
                   5912:                     }
                   5913:                 }
                   5914:             }
                   5915:         }
                   5916:     }
                   5917:     return %privileged;
1.9       www      5918: }
1.1       albertel 5919: 
1.103     harris41 5920: # -------------------------------------------------------- Get user privileges
1.11      www      5921: 
                   5922: sub rolesinit {
1.1169    droeschl 5923:     my ($domain, $username) = @_;
                   5924:     my %userroles = ('user.login.time' => time);
                   5925:     my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
                   5926: 
                   5927:     # firstaccess and timerinterval are related to timed maps/resources. 
                   5928:     # also, blocking can be triggered by an activating timer
                   5929:     # it's saved in the user's %env.
                   5930:     my %firstaccess = &dump('firstaccesstimes', $domain, $username);
                   5931:     my %timerinterval = &dump('timerinterval', $domain, $username);
                   5932:     my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
                   5933:         %timerintchk, %timerintenv);
                   5934: 
1.1162    raeburn  5935:     foreach my $key (keys(%firstaccess)) {
1.1169    droeschl 5936:         my ($cid, $rest) = split(/\0/, $key);
1.1162    raeburn  5937:         $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
                   5938:     }
1.1169    droeschl 5939: 
1.1162    raeburn  5940:     foreach my $key (keys(%timerinterval)) {
                   5941:         my ($cid,$rest) = split(/\0/,$key);
                   5942:         $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
                   5943:     }
1.1169    droeschl 5944: 
1.11      www      5945:     my %allroles=();
1.1162    raeburn  5946:     my %allgroups=();
1.11      www      5947: 
1.1274    raeburn  5948:     for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169    droeschl 5949:         my $role = $rolesdump{$area};
                   5950:         $area =~ s/\_\w\w$//;
                   5951: 
                   5952:         my ($trole, $tend, $tstart, $group_privs);
                   5953: 
                   5954:         if ($role =~ /^cr/) {
                   5955:         # Custom role, defined by a user 
                   5956:         # e.g., user.role.cr/msu/smith/mynewrole
                   5957:             if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
                   5958:                 $trole = $1;
                   5959:                 ($tend, $tstart) = split('_', $2);
                   5960:             } else {
                   5961:                 $trole = $role;
                   5962:             }
                   5963:         } elsif ($role =~ m|^gr/|) {
                   5964:         # Role of member in a group, defined within a course/community
                   5965:         # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
                   5966:             ($trole, $tend, $tstart) = split(/_/, $role);
                   5967:             next if $tstart eq '-1';
                   5968:             ($trole, $group_privs) = split(/\//, $trole);
                   5969:             $group_privs = &unescape($group_privs);
                   5970:         } else {
                   5971:         # Just a normal role, defined in roles.tab
                   5972:             ($trole, $tend, $tstart) = split(/_/,$role);
                   5973:         }
                   5974: 
                   5975:         my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
                   5976:                  $username);
                   5977:         @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
                   5978: 
                   5979:         # role expired or not available yet?
                   5980:         $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or 
                   5981:             ($tstart != 0 && $tstart > $userroles{'user.login.time'});
                   5982: 
                   5983:         next if $area eq '' or $trole eq '';
                   5984: 
                   5985:         my $spec = "$trole.$area";
                   5986:         my ($tdummy, $tdomain, $trest) = split(/\//, $area);
                   5987: 
                   5988:         if ($trole =~ /^cr\//) {
                   5989:         # Custom role, defined by a user
                   5990:             &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
                   5991:         } elsif ($trole eq 'gr') {
                   5992:         # Role of a member in a group, defined within a course/community
                   5993:             &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
                   5994:             next;
                   5995:         } else {
                   5996:         # Normal role, defined in roles.tab
                   5997:             &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
                   5998:         }
                   5999: 
                   6000:         my $cid = $tdomain.'_'.$trest;
                   6001:         unless ($firstaccchk{$cid}) {
                   6002:             if (ref($coursetimerstarts{$cid}) eq 'HASH') {
                   6003:                 foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
                   6004:                     $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} = 
                   6005:                         $coursetimerstarts{$cid}{$item}; 
                   6006:                 }
                   6007:             }
                   6008:             $firstaccchk{$cid} = 1;
                   6009:         }
                   6010:         unless ($timerintchk{$cid}) {
                   6011:             if (ref($coursetimerintervals{$cid}) eq 'HASH') {
                   6012:                 foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
                   6013:                     $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
                   6014:                        $coursetimerintervals{$cid}{$item};
1.1162    raeburn  6015:                 }
1.12      www      6016:             }
1.1169    droeschl 6017:             $timerintchk{$cid} = 1;
1.191     harris41 6018:         }
1.11      www      6019:     }
1.1169    droeschl 6020: 
1.1341    raeburn  6021:     @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
                   6022:                                                           \%allroles, \%allgroups);
1.1169    droeschl 6023:     $env{'user.adv'} = $userroles{'user.adv'};
1.1341    raeburn  6024:     $env{'user.rar'} = $userroles{'user.rar'};
1.1169    droeschl 6025: 
1.1162    raeburn  6026:     return (\%userroles,\%firstaccenv,\%timerintenv);
1.11      www      6027: }
                   6028: 
1.567     raeburn  6029: sub set_arearole {
1.1215    raeburn  6030:     my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
                   6031:     unless ($nolog) {
1.567     raeburn  6032: # log the associated role with the area
1.1215    raeburn  6033:         &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
                   6034:     }
1.743     albertel 6035:     return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567     raeburn  6036: }
                   6037: 
                   6038: sub custom_roleprivs {
                   6039:     my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
                   6040:     my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250    raeburn  6041:     my $homsvr = &homeserver($rauthor,$rdomain);
1.838     albertel 6042:     if (&hostname($homsvr) ne '') {
1.567     raeburn  6043:         my ($rdummy,$roledef)=
                   6044:             &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
                   6045:         if (($rdummy ne 'con_lost') && ($roledef ne '')) {
                   6046:             my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
                   6047:             if (defined($syspriv)) {
1.1043    raeburn  6048:                 if ($trest =~ /^$match_community$/) {
                   6049:                     $syspriv =~ s/bre\&S//; 
                   6050:                 }
1.567     raeburn  6051:                 $$allroles{'cm./'}.=':'.$syspriv;
                   6052:                 $$allroles{$spec.'./'}.=':'.$syspriv;
                   6053:             }
                   6054:             if ($tdomain ne '') {
                   6055:                 if (defined($dompriv)) {
                   6056:                     $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
                   6057:                     $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
                   6058:                 }
                   6059:                 if (($trest ne '') && (defined($coursepriv))) {
1.1332    raeburn  6060:                     if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
                   6061:                         my $rolename = $1;
                   6062:                         $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
                   6063:                     }
1.567     raeburn  6064:                     $$allroles{'cm.'.$area}.=':'.$coursepriv;
                   6065:                     $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
                   6066:                 }
                   6067:             }
                   6068:         }
                   6069:     }
                   6070: }
                   6071: 
1.1332    raeburn  6072: sub course_adhocrole_privs {
                   6073:     my ($rolename,$cdom,$cnum,$coursepriv) = @_;
                   6074:     my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
                   6075:     if ($overrides{"internal.adhocpriv.$rolename"}) {
                   6076:         my (%currprivs,%storeprivs);
                   6077:         foreach my $item (split(/:/,$coursepriv)) {
                   6078:             my ($priv,$restrict) = split(/\&/,$item);
                   6079:             $currprivs{$priv} = $restrict;
                   6080:         }
                   6081:         my (%possadd,%possremove,%full);
                   6082:         foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
                   6083:             my ($priv,$restrict)=split(/\&/,$item);
                   6084:             $full{$priv} = $restrict;
                   6085:         }
                   6086:         foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
                   6087:              next if ($item eq '');
                   6088:              my ($rule,$rest) = split(/=/,$item);
                   6089:              next unless (($rule eq 'off') || ($rule eq 'on'));
                   6090:              foreach my $priv (split(/:/,$rest)) {
                   6091:                  if ($priv ne '') {
                   6092:                      if ($rule eq 'off') {
                   6093:                          $possremove{$priv} = 1;
                   6094:                      } else {
                   6095:                          $possadd{$priv} = 1;
                   6096:                      }
                   6097:                  }
                   6098:              }
                   6099:          }
                   6100:          foreach my $priv (sort(keys(%full))) {
                   6101:              if (exists($currprivs{$priv})) {
                   6102:                  unless (exists($possremove{$priv})) {
                   6103:                      $storeprivs{$priv} = $currprivs{$priv};
                   6104:                  }
                   6105:              } elsif (exists($possadd{$priv})) {
                   6106:                  $storeprivs{$priv} = $full{$priv};
                   6107:              }
                   6108:          }
                   6109:          $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
                   6110:      }
                   6111:      return $coursepriv;
                   6112: }
                   6113: 
1.678     raeburn  6114: sub group_roleprivs {
                   6115:     my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
                   6116:     my $access = 1;
                   6117:     my $now = time;
                   6118:     if (($tend!=0) && ($tend<$now)) { $access = 0; }
                   6119:     if (($tstart!=0) && ($tstart>$now)) { $access=0; }
                   6120:     if ($access) {
1.811     albertel 6121:         my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678     raeburn  6122:         $$allgroups{$course}{$group} .=':'.$group_privs;
                   6123:     }
                   6124: }
1.567     raeburn  6125: 
                   6126: sub standard_roleprivs {
                   6127:     my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
                   6128:     if (defined($pr{$trole.':s'})) {
                   6129:         $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
                   6130:         $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
                   6131:     }
                   6132:     if ($tdomain ne '') {
                   6133:         if (defined($pr{$trole.':d'})) {
                   6134:             $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   6135:             $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   6136:         }
                   6137:         if (($trest ne '') && (defined($pr{$trole.':c'}))) {
                   6138:             $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
                   6139:             $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
                   6140:         }
                   6141:     }
                   6142: }
                   6143: 
                   6144: sub set_userprivs {
1.1064    raeburn  6145:     my ($userroles,$allroles,$allgroups,$groups_roles) = @_; 
1.567     raeburn  6146:     my $author=0;
                   6147:     my $adv=0;
1.1341    raeburn  6148:     my $rar=0;
1.678     raeburn  6149:     my %grouproles = ();
                   6150:     if (keys(%{$allgroups}) > 0) {
1.1064    raeburn  6151:         my @groupkeys; 
1.1000    raeburn  6152:         foreach my $role (keys(%{$allroles})) {
1.1064    raeburn  6153:             push(@groupkeys,$role);
                   6154:         }
                   6155:         if (ref($groups_roles) eq 'HASH') {
                   6156:             foreach my $key (keys(%{$groups_roles})) {
                   6157:                 unless (grep(/^\Q$key\E$/,@groupkeys)) {
                   6158:                     push(@groupkeys,$key);
                   6159:                 }
                   6160:             }
                   6161:         }
                   6162:         if (@groupkeys > 0) {
                   6163:             foreach my $role (@groupkeys) {
                   6164:                 my ($trole,$area,$sec,$extendedarea);
                   6165:                 if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
                   6166:                     $trole = $1;
                   6167:                     $area = $2;
                   6168:                     $sec = $3;
                   6169:                     $extendedarea = $area.$sec;
                   6170:                     if (exists($$allgroups{$area})) {
                   6171:                         foreach my $group (keys(%{$$allgroups{$area}})) {
                   6172:                             my $spec = $trole.'.'.$extendedarea;
                   6173:                             $grouproles{$spec.'.'.$area.'/'.$group} = 
1.681     raeburn  6174:                                                 $$allgroups{$area}{$group};
1.1064    raeburn  6175:                         }
1.678     raeburn  6176:                     }
                   6177:                 }
                   6178:             }
                   6179:         }
                   6180:     }
1.800     albertel 6181:     foreach my $group (keys(%grouproles)) {
                   6182:         $$allroles{$group} = $grouproles{$group};
1.678     raeburn  6183:     }
1.800     albertel 6184:     foreach my $role (keys(%{$allroles})) {
                   6185:         my %thesepriv;
1.941     raeburn  6186:         if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800     albertel 6187:         foreach my $item (split(/:/,$$allroles{$role})) {
                   6188:             if ($item ne '') {
                   6189:                 my ($privilege,$restrictions)=split(/&/,$item);
1.567     raeburn  6190:                 if ($restrictions eq '') {
                   6191:                     $thesepriv{$privilege}='F';
                   6192:                 } elsif ($thesepriv{$privilege} ne 'F') {
                   6193:                     $thesepriv{$privilege}.=$restrictions;
                   6194:                 }
                   6195:                 if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341    raeburn  6196:                 if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567     raeburn  6197:             }
                   6198:         }
                   6199:         my $thesestr='';
1.1104    raeburn  6200:         foreach my $priv (sort(keys(%thesepriv))) {
1.800     albertel 6201: 	    $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
                   6202: 	}
                   6203:         $userroles->{'user.priv.'.$role} = $thesestr;
1.567     raeburn  6204:     }
1.1341    raeburn  6205:     return ($author,$adv,$rar);
1.567     raeburn  6206: }
                   6207: 
1.994     raeburn  6208: sub role_status {
1.1104    raeburn  6209:     my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994     raeburn  6210:     if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250    raeburn  6211:         my ($one,$two) = split(m{\./},$rolekey,2);
                   6212:         (undef,undef,$$role) = split(/\./,$one,3);
1.994     raeburn  6213:         unless (!defined($$role) || $$role eq '') {
1.1251    raeburn  6214:             $$where = '/'.$two;
1.994     raeburn  6215:             $$trolecode=$$role.'.'.$$where;
                   6216:             ($$tstart,$$tend)=split(/\./,$env{$rolekey});
                   6217:             $$tstatus='is';
1.1104    raeburn  6218:             if ($$tstart && $$tstart>$update) {
1.994     raeburn  6219:                 $$tstatus='future';
1.1034    raeburn  6220:                 if ($$tstart<$now) {
                   6221:                     if ($$tstart && $$tstart>$refresh) {
1.1002    raeburn  6222:                         if (($$where ne '') && ($$role ne '')) {
1.1064    raeburn  6223:                             my (%allroles,%allgroups,$group_privs,
                   6224:                                 %groups_roles,@rolecodes);
1.1002    raeburn  6225:                             my %userroles = (
                   6226:                                 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
                   6227:                             );
1.1064    raeburn  6228:                             @rolecodes = ('cm'); 
1.1002    raeburn  6229:                             my $spec=$$role.'.'.$$where;
                   6230:                             my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
                   6231:                             if ($$role =~ /^cr\//) {
                   6232:                                 &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064    raeburn  6233:                                 push(@rolecodes,'cr');
1.1002    raeburn  6234:                             } elsif ($$role eq 'gr') {
1.1064    raeburn  6235:                                 push(@rolecodes,$$role);
1.1002    raeburn  6236:                                 my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
                   6237:                                                     $env{'user.name'});
1.1064    raeburn  6238:                                 my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002    raeburn  6239:                                 (undef,my $group_privs) = split(/\//,$trole);
                   6240:                                 $group_privs = &unescape($group_privs);
                   6241:                                 &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064    raeburn  6242:                                 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  6243:                                 &get_groups_roles($tdomain,$trest,
                   6244:                                                   \%course_roles,\@rolecodes,
                   6245:                                                   \%groups_roles);
1.1002    raeburn  6246:                             } else {
1.1064    raeburn  6247:                                 push(@rolecodes,$$role);
1.1002    raeburn  6248:                                 &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
                   6249:                             }
1.1341    raeburn  6250:                             my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
                   6251:                                                                    \%groups_roles);
1.1064    raeburn  6252:                             &appenv(\%userroles,\@rolecodes);
1.1342    raeburn  6253:                             &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002    raeburn  6254:                         }
                   6255:                     }
1.1034    raeburn  6256:                     $$tstatus = 'is';
1.1002    raeburn  6257:                 }
1.994     raeburn  6258:             }
                   6259:             if ($$tend) {
1.1104    raeburn  6260:                 if ($$tend<$update) {
1.994     raeburn  6261:                     $$tstatus='expired';
                   6262:                 } elsif ($$tend<$now) {
                   6263:                     $$tstatus='will_not';
                   6264:                 }
                   6265:             }
                   6266:         }
                   6267:     }
                   6268: }
                   6269: 
1.1104    raeburn  6270: sub get_groups_roles {
                   6271:     my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
                   6272:     return unless((ref($cdom_courseroles) eq 'HASH') && 
                   6273:                   (ref($rolecodes) eq 'ARRAY') && 
                   6274:                   (ref($groups_roles) eq 'HASH')); 
                   6275:     if (keys(%{$cdom_courseroles}) > 0) {
                   6276:         my ($cnum) = ($rest =~ /^($match_courseid)/);
                   6277:         if ($cdom ne '' && $cnum ne '') {
                   6278:             foreach my $key (keys(%{$cdom_courseroles})) {
                   6279:                 if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
                   6280:                     my $crsrole = $1;
                   6281:                     my $crssec = $2;
                   6282:                     if ($crsrole =~ /^cr/) {
                   6283:                         unless (grep(/^cr$/,@{$rolecodes})) {
                   6284:                             push(@{$rolecodes},'cr');
                   6285:                         }
                   6286:                     } else {
                   6287:                         unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
                   6288:                             push(@{$rolecodes},$crsrole);
                   6289:                         }
                   6290:                     }
                   6291:                     my $rolekey = "$crsrole./$cdom/$cnum";
                   6292:                     if ($crssec ne '') {
                   6293:                         $rolekey .= "/$crssec";
                   6294:                     }
                   6295:                     $rolekey .= './';
                   6296:                     $groups_roles->{$rolekey} = $rolecodes;
                   6297:                 }
                   6298:             }
                   6299:         }
                   6300:     }
                   6301:     return;
                   6302: }
                   6303: 
                   6304: sub delete_env_groupprivs {
                   6305:     my ($where,$courseroles,$possroles) = @_;
                   6306:     return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
                   6307:     my ($dummy,$udom,$uname,$group) = split(/\//,$where);
                   6308:     unless (ref($courseroles->{$udom}) eq 'HASH') {
                   6309:         %{$courseroles->{$udom}} =
                   6310:             &get_my_roles('','','userroles',['active'],
                   6311:                           $possroles,[$udom],1);
                   6312:     }
                   6313:     if (ref($courseroles->{$udom}) eq 'HASH') {
                   6314:         foreach my $item (keys(%{$courseroles->{$udom}})) {
                   6315:             my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
                   6316:             my $area = '/'.$cdom.'/'.$cnum;
                   6317:             my $privkey = "user.priv.$crsrole.$area";
                   6318:             if ($crssec ne '') {
                   6319:                 $privkey .= '/'.$crssec;
                   6320:             }
                   6321:             $privkey .= ".$area/$group";
                   6322:             &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
                   6323:         }
                   6324:     }
                   6325:     return;
                   6326: }
                   6327: 
1.994     raeburn  6328: sub check_adhoc_privs {
1.1329    raeburn  6329:     my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994     raeburn  6330:     my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329    raeburn  6331:     if ($sec) {
                   6332:         $cckey .= '/'.$sec;
                   6333:     } 
1.1185    raeburn  6334:     my $setprivs;
1.994     raeburn  6335:     if ($env{$cckey}) {
                   6336:         my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104    raeburn  6337:         &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994     raeburn  6338:         unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329    raeburn  6339:             &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185    raeburn  6340:             $setprivs = 1;
1.994     raeburn  6341:         }
                   6342:     } else {
1.1330    raeburn  6343:         &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185    raeburn  6344:         $setprivs = 1;
1.994     raeburn  6345:     }
1.1185    raeburn  6346:     return $setprivs;
1.994     raeburn  6347: }
                   6348: 
                   6349: sub set_adhoc_privileges {
1.1326    raeburn  6350: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329    raeburn  6351:     my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994     raeburn  6352:     my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329    raeburn  6353:     if ($sec ne '') {
                   6354:         $area .= '/'.$sec;
                   6355:     }
1.994     raeburn  6356:     my $spec = $role.'.'.$area;
                   6357:     my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215    raeburn  6358:                                   $env{'user.name'},1);
1.1326    raeburn  6359:     my %rolehash = ();
1.1332    raeburn  6360:     if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
                   6361:         my $rolename = $1;
1.1326    raeburn  6362:         &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332    raeburn  6363:         my %domdef = &get_domain_defaults($dcdom);
                   6364:         if (ref($domdef{'adhocroles'}) eq 'HASH') {
                   6365:             if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
                   6366:                 &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
                   6367:             }
                   6368:         }
1.1326    raeburn  6369:     } else {
                   6370:         &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
                   6371:     }
1.1341    raeburn  6372:     my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994     raeburn  6373:     &appenv(\%userroles,[$role,'cm']);
1.1342    raeburn  6374:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1088    raeburn  6375:     unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
                   6376:         &appenv( {'request.role'        => $spec,
                   6377:                   'request.role.domain' => $dcdom,
1.1332    raeburn  6378:                   'request.course.sec'  => $sec,
1.1088    raeburn  6379:                  }
                   6380:                );
                   6381:         my $tadv=0;
                   6382:         if (&allowed('adv') eq 'F') { $tadv=1; }
                   6383:         &appenv({'request.role.adv'    => $tadv});
                   6384:     }
1.994     raeburn  6385: }
                   6386: 
1.12      www      6387: # --------------------------------------------------------------- get interface
                   6388: 
                   6389: sub get {
1.131     albertel 6390:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      6391:    my $items='';
1.800     albertel 6392:    foreach my $item (@$storearr) {
                   6393:        $items.=&escape($item).'&';
1.191     harris41 6394:    }
1.12      www      6395:    $items=~s/\&$//;
1.620     albertel 6396:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6397:    if (!$uname) { $uname=$env{'user.name'}; }
1.131     albertel 6398:    my $uhome=&homeserver($uname,$udomain);
                   6399: 
1.133     albertel 6400:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      6401:    my @pairs=split(/\&/,$rep);
1.273     albertel 6402:    if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   6403:      return @pairs;
                   6404:    }
1.15      www      6405:    my %returnhash=();
1.42      www      6406:    my $i=0;
1.800     albertel 6407:    foreach my $item (@$storearr) {
                   6408:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      6409:       $i++;
1.191     harris41 6410:    }
1.15      www      6411:    return %returnhash;
1.27      www      6412: }
                   6413: 
                   6414: # --------------------------------------------------------------- del interface
                   6415: 
                   6416: sub del {
1.133     albertel 6417:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.27      www      6418:    my $items='';
1.800     albertel 6419:    foreach my $item (@$storearr) {
                   6420:        $items.=&escape($item).'&';
1.191     harris41 6421:    }
1.984     neumanie 6422: 
1.27      www      6423:    $items=~s/\&$//;
1.620     albertel 6424:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6425:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 6426:    my $uhome=&homeserver($uname,$udomain);
                   6427:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      6428: }
                   6429: 
                   6430: # -------------------------------------------------------------- dump interface
                   6431: 
1.1180    droeschl 6432: sub unserialize {
                   6433:     my ($rep, $escapedkeys) = @_;
                   6434: 
                   6435:     return {} if $rep =~ /^error/;
                   6436: 
                   6437:     my %returnhash=();
1.1252    raeburn  6438: 	foreach my $item (split(/\&/,$rep)) {
1.1180    droeschl 6439: 	    my ($key, $value) = split(/=/, $item, 2);
                   6440: 	    $key = unescape($key) unless $escapedkeys;
                   6441: 	    next if $key =~ /^error: 2 /;
1.1252    raeburn  6442: 	    $returnhash{$key} = &thaw_unescape($value);
1.1180    droeschl 6443: 	}
                   6444:     #return %returnhash;
                   6445:     return \%returnhash;
                   6446: }        
                   6447: 
                   6448: # see Lond::dump_with_regexp
                   6449: # if $escapedkeys hash keys won't get unescaped.
1.15      www      6450: sub dump {
1.1180    droeschl 6451:     my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755     albertel 6452:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6453:     if (!$uname) { $uname=$env{'user.name'}; }
                   6454:     my $uhome=&homeserver($uname,$udomain);
1.1167    droeschl 6455: 
1.1266    raeburn  6456:     if ($regexp) {
                   6457:         $regexp=&escape($regexp);
                   6458:     } else {
                   6459:         $regexp='.';
                   6460:     }
1.1180    droeschl 6461:     if (grep { $_ eq $uhome } current_machine_ids()) {
                   6462:         # user is hosted on this machine
1.1266    raeburn  6463:         my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226    raeburn  6464:                     $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180    droeschl 6465:         return %{unserialize($reply, $escapedkeys)};
                   6466:     }
1.1166    raeburn  6467:     my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755     albertel 6468:     my @pairs=split(/\&/,$rep);
                   6469:     my %returnhash=();
1.1098    foxr     6470:     if (!($rep =~ /^error/ )) {
                   6471: 	foreach my $item (@pairs) {
                   6472: 	    my ($key,$value)=split(/=/,$item,2);
1.1180    droeschl 6473:         $key = unescape($key) unless $escapedkeys;
                   6474:         #$key = &unescape($key);
1.1098    foxr     6475: 	    next if ($key =~ /^error: 2 /);
                   6476: 	    $returnhash{$key}=&thaw_unescape($value);
                   6477: 	}
1.755     albertel 6478:     }
                   6479:     return %returnhash;
1.407     www      6480: }
                   6481: 
1.1098    foxr     6482: 
1.717     albertel 6483: # --------------------------------------------------------- dumpstore interface
                   6484: 
                   6485: sub dumpstore {
                   6486:    my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180    droeschl 6487:    # same as dump but keys must be escaped. They may contain colon separated
                   6488:    # lists of values that may themself contain colons (e.g. symbs).
                   6489:    return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717     albertel 6490: }
                   6491: 
1.407     www      6492: # -------------------------------------------------------------- keys interface
                   6493: 
                   6494: sub getkeys {
                   6495:    my ($namespace,$udomain,$uname)=@_;
1.620     albertel 6496:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6497:    if (!$uname) { $uname=$env{'user.name'}; }
1.407     www      6498:    my $uhome=&homeserver($uname,$udomain);
                   6499:    my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
                   6500:    my @keyarray=();
1.800     albertel 6501:    foreach my $key (split(/\&/,$rep)) {
1.812     raeburn  6502:       next if ($key =~ /^error: 2 /);
1.800     albertel 6503:       push(@keyarray,&unescape($key));
1.407     www      6504:    }
                   6505:    return @keyarray;
1.318     matthew  6506: }
                   6507: 
1.319     matthew  6508: # --------------------------------------------------------------- currentdump
                   6509: sub currentdump {
1.328     matthew  6510:    my ($courseid,$sdom,$sname)=@_;
1.620     albertel 6511:    $courseid = $env{'request.course.id'} if (! defined($courseid));
                   6512:    $sdom     = $env{'user.domain'}       if (! defined($sdom));
                   6513:    $sname    = $env{'user.name'}         if (! defined($sname));
1.326     matthew  6514:    my $uhome = &homeserver($sname,$sdom);
1.1180    droeschl 6515:    my $rep;
                   6516: 
                   6517:    if (grep { $_ eq $uhome } current_machine_ids()) {
                   6518:        $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname, 
                   6519:                    $courseid)));
                   6520:    } else {
                   6521:        $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
                   6522:    }
                   6523: 
1.318     matthew  6524:    return if ($rep =~ /^(error:|no_such_host)/);
1.319     matthew  6525:    #
1.318     matthew  6526:    my %returnhash=();
1.319     matthew  6527:    #
1.1343    raeburn  6528:    if ($rep eq 'unknown_cmd') {
1.319     matthew  6529:        # an old lond will not know currentdump
                   6530:        # Do a dump and make it look like a currentdump
1.822     albertel 6531:        my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319     matthew  6532:        return if ($tmp[0] =~ /^(error:|no_such_host)/);
                   6533:        my %hash = @tmp;
                   6534:        @tmp=();
1.424     matthew  6535:        %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319     matthew  6536:    } else {
                   6537:        my @pairs=split(/\&/,$rep);
1.800     albertel 6538:        foreach my $pair (@pairs) {
                   6539:            my ($key,$value)=split(/=/,$pair,2);
1.319     matthew  6540:            my ($symb,$param) = split(/:/,$key);
                   6541:            $returnhash{&unescape($symb)}->{&unescape($param)} = 
1.557     albertel 6542:                                                         &thaw_unescape($value);
1.319     matthew  6543:        }
1.191     harris41 6544:    }
1.12      www      6545:    return %returnhash;
1.424     matthew  6546: }
                   6547: 
                   6548: sub convert_dump_to_currentdump{
                   6549:     my %hash = %{shift()};
                   6550:     my %returnhash;
                   6551:     # Code ripped from lond, essentially.  The only difference
                   6552:     # here is the unescaping done by lonnet::dump().  Conceivably
                   6553:     # we might run in to problems with parameter names =~ /^v\./
                   6554:     while (my ($key,$value) = each(%hash)) {
                   6555:         my ($v,$symb,$param) = split(/:/,$key);
1.822     albertel 6556: 	$symb  = &unescape($symb);
                   6557: 	$param = &unescape($param);
1.424     matthew  6558:         next if ($v eq 'version' || $symb eq 'keys');
                   6559:         next if (exists($returnhash{$symb}) &&
                   6560:                  exists($returnhash{$symb}->{$param}) &&
                   6561:                  $returnhash{$symb}->{'v.'.$param} > $v);
                   6562:         $returnhash{$symb}->{$param}=$value;
                   6563:         $returnhash{$symb}->{'v.'.$param}=$v;
                   6564:     }
                   6565:     #
                   6566:     # Remove all of the keys in the hashes which keep track of
                   6567:     # the version of the parameter.
                   6568:     while (my ($symb,$param_hash) = each(%returnhash)) {
                   6569:         # use a foreach because we are going to delete from the hash.
                   6570:         foreach my $key (keys(%$param_hash)) {
                   6571:             delete($param_hash->{$key}) if ($key =~ /^v\./);
                   6572:         }
                   6573:     }
                   6574:     return \%returnhash;
1.12      www      6575: }
                   6576: 
1.627     albertel 6577: # ------------------------------------------------------ critical inc interface
                   6578: 
                   6579: sub cinc {
                   6580:     return &inc(@_,'critical');
                   6581: }
                   6582: 
1.449     matthew  6583: # --------------------------------------------------------------- inc interface
                   6584: 
                   6585: sub inc {
1.627     albertel 6586:     my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620     albertel 6587:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6588:     if (!$uname) { $uname=$env{'user.name'}; }
1.449     matthew  6589:     my $uhome=&homeserver($uname,$udomain);
                   6590:     my $items='';
                   6591:     if (! ref($store)) {
                   6592:         # got a single value, so use that instead
                   6593:         $items = &escape($store).'=&';
                   6594:     } elsif (ref($store) eq 'SCALAR') {
                   6595:         $items = &escape($$store).'=&';        
                   6596:     } elsif (ref($store) eq 'ARRAY') {
                   6597:         $items = join('=&',map {&escape($_);} @{$store});
                   6598:     } elsif (ref($store) eq 'HASH') {
                   6599:         while (my($key,$value) = each(%{$store})) {
                   6600:             $items.= &escape($key).'='.&escape($value).'&';
                   6601:         }
                   6602:     }
                   6603:     $items=~s/\&$//;
1.627     albertel 6604:     if ($critical) {
                   6605: 	return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
                   6606:     } else {
                   6607: 	return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
                   6608:     }
1.449     matthew  6609: }
                   6610: 
1.12      www      6611: # --------------------------------------------------------------- put interface
                   6612: 
                   6613: sub put {
1.134     albertel 6614:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 6615:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6616:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 6617:    my $uhome=&homeserver($uname,$udomain);
1.12      www      6618:    my $items='';
1.800     albertel 6619:    foreach my $item (keys(%$storehash)) {
                   6620:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 6621:    }
1.12      www      6622:    $items=~s/\&$//;
1.134     albertel 6623:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47      www      6624: }
                   6625: 
1.631     albertel 6626: # ------------------------------------------------------------ newput interface
                   6627: 
                   6628: sub newput {
                   6629:    my ($namespace,$storehash,$udomain,$uname)=@_;
                   6630:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6631:    if (!$uname) { $uname=$env{'user.name'}; }
                   6632:    my $uhome=&homeserver($uname,$udomain);
                   6633:    my $items='';
                   6634:    foreach my $key (keys(%$storehash)) {
                   6635:        $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   6636:    }
                   6637:    $items=~s/\&$//;
                   6638:    return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
                   6639: }
                   6640: 
                   6641: # ---------------------------------------------------------  putstore interface
                   6642: 
1.524     raeburn  6643: sub putstore {
1.1269    raeburn  6644:    my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620     albertel 6645:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6646:    if (!$uname) { $uname=$env{'user.name'}; }
1.524     raeburn  6647:    my $uhome=&homeserver($uname,$udomain);
                   6648:    my $items='';
1.715     albertel 6649:    foreach my $key (keys(%$storehash)) {
                   6650:        $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524     raeburn  6651:    }
1.715     albertel 6652:    $items=~s/\&$//;
1.716     albertel 6653:    my $esc_symb=&escape($symb);
                   6654:    my $esc_v=&escape($version);
1.715     albertel 6655:    my $reply =
1.716     albertel 6656:        &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715     albertel 6657: 	      $uhome);
1.1269    raeburn  6658:    if (($tolog) && ($reply eq 'ok')) {
                   6659:        my $namevalue='';
                   6660:        foreach my $key (keys(%{$storehash})) {
                   6661:            $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
                   6662:        }
                   6663:        $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
                   6664:                      '&host='.&escape($perlvar{'lonHostID'}).
                   6665:                      '&version='.$esc_v.
                   6666:                      '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
                   6667:        &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
                   6668:    }
1.715     albertel 6669:    if ($reply eq 'unknown_cmd') {
1.716     albertel 6670:        # gfall back to way things use to be done
1.715     albertel 6671:        return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
                   6672: 			    $uname);
1.524     raeburn  6673:    }
1.715     albertel 6674:    return $reply;
                   6675: }
                   6676: 
                   6677: sub old_putstore {
1.716     albertel 6678:     my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
                   6679:     if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6680:     if (!$uname) { $uname=$env{'user.name'}; }
                   6681:     my $uhome=&homeserver($uname,$udomain);
                   6682:     my %newstorehash;
1.800     albertel 6683:     foreach my $item (keys(%$storehash)) {
                   6684: 	my $key = $version.':'.&escape($symb).':'.$item;
                   6685: 	$newstorehash{$key} = $storehash->{$item};
1.716     albertel 6686:     }
                   6687:     my $items='';
                   6688:     my %allitems = ();
1.800     albertel 6689:     foreach my $item (keys(%newstorehash)) {
                   6690: 	if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716     albertel 6691: 	    my $key = $1.':keys:'.$2;
                   6692: 	    $allitems{$key} .= $3.':';
                   6693: 	}
1.800     albertel 6694: 	$items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716     albertel 6695:     }
1.800     albertel 6696:     foreach my $item (keys(%allitems)) {
                   6697: 	$allitems{$item} =~ s/\:$//;
                   6698: 	$items.= $item.'='.$allitems{$item}.'&';
1.716     albertel 6699:     }
                   6700:     $items=~s/\&$//;
                   6701:     return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524     raeburn  6702: }
                   6703: 
1.47      www      6704: # ------------------------------------------------------ critical put interface
                   6705: 
                   6706: sub cput {
1.134     albertel 6707:    my ($namespace,$storehash,$udomain,$uname)=@_;
1.620     albertel 6708:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6709:    if (!$uname) { $uname=$env{'user.name'}; }
1.134     albertel 6710:    my $uhome=&homeserver($uname,$udomain);
1.47      www      6711:    my $items='';
1.800     albertel 6712:    foreach my $item (keys(%$storehash)) {
                   6713:        $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191     harris41 6714:    }
1.47      www      6715:    $items=~s/\&$//;
1.134     albertel 6716:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      6717: }
                   6718: 
                   6719: # -------------------------------------------------------------- eget interface
                   6720: 
                   6721: sub eget {
1.133     albertel 6722:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      6723:    my $items='';
1.800     albertel 6724:    foreach my $item (@$storearr) {
                   6725:        $items.=&escape($item).'&';
1.191     harris41 6726:    }
1.12      www      6727:    $items=~s/\&$//;
1.620     albertel 6728:    if (!$udomain) { $udomain=$env{'user.domain'}; }
                   6729:    if (!$uname) { $uname=$env{'user.name'}; }
1.133     albertel 6730:    my $uhome=&homeserver($uname,$udomain);
                   6731:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      6732:    my @pairs=split(/\&/,$rep);
                   6733:    my %returnhash=();
1.42      www      6734:    my $i=0;
1.800     albertel 6735:    foreach my $item (@$storearr) {
                   6736:       $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42      www      6737:       $i++;
1.191     harris41 6738:    }
1.12      www      6739:    return %returnhash;
                   6740: }
                   6741: 
1.667     albertel 6742: # ------------------------------------------------------------ tmpput interface
                   6743: sub tmpput {
1.802     raeburn  6744:     my ($storehash,$server,$context)=@_;
1.667     albertel 6745:     my $items='';
1.800     albertel 6746:     foreach my $item (keys(%$storehash)) {
                   6747: 	$items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667     albertel 6748:     }
                   6749:     $items=~s/\&$//;
1.802     raeburn  6750:     if (defined($context)) {
                   6751:         $items .= ':'.&escape($context);
                   6752:     }
1.667     albertel 6753:     return &reply("tmpput:$items",$server);
                   6754: }
                   6755: 
                   6756: # ------------------------------------------------------------ tmpget interface
                   6757: sub tmpget {
1.688     albertel 6758:     my ($token,$server)=@_;
                   6759:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   6760:     my $rep=&reply("tmpget:$token",$server);
1.667     albertel 6761:     my %returnhash;
1.1328    raeburn  6762:     if ($rep =~ /^(con_lost|error|no_such_host)/i) {
                   6763:         return %returnhash;
                   6764:     }
1.667     albertel 6765:     foreach my $item (split(/\&/,$rep)) {
                   6766: 	my ($key,$value)=split(/=/,$item);
                   6767: 	$returnhash{&unescape($key)}=&thaw_unescape($value);
                   6768:     }
                   6769:     return %returnhash;
                   6770: }
                   6771: 
1.1113    raeburn  6772: # ------------------------------------------------------------ tmpdel interface
1.688     albertel 6773: sub tmpdel {
                   6774:     my ($token,$server)=@_;
                   6775:     if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
                   6776:     return &reply("tmpdel:$token",$server);
                   6777: }
                   6778: 
1.1198    raeburn  6779: # ------------------------------------------------------------ get_timebased_id 
                   6780: 
                   6781: sub get_timebased_id {
                   6782:     my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
                   6783:         $maxtries) = @_;
                   6784:     my ($newid,$error,$dellock);
                   6785:     unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {  
                   6786:         return ('','ok','invalid call to get suffix');
                   6787:     }
                   6788: 
                   6789: # set defaults for any optional args for which values were not supplied
                   6790:     if ($who eq '') {
                   6791:         $who = $env{'user.name'}.':'.$env{'user.domain'};
                   6792:     }
                   6793:     if (!$locktries) {
                   6794:         $locktries = 3;
                   6795:     }
                   6796:     if (!$maxtries) {
                   6797:         $maxtries = 10;
                   6798:     }
                   6799:     
                   6800:     if (($cdom eq '') || ($cnum eq '')) {
                   6801:         if ($env{'request.course.id'}) {
                   6802:             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   6803:             $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   6804:         }
                   6805:         if (($cdom eq '') || ($cnum eq '')) {
                   6806:             return ('','ok','call to get suffix not in course context');
                   6807:         }
                   6808:     }
                   6809: 
                   6810: # construct locking item
                   6811:     my $lockhash = {
                   6812:                       $prefix."\0".'locked_'.$keyid => $who,
                   6813:                    };
                   6814:     my $tries = 0;
                   6815: 
                   6816: # attempt to get lock on nohist_$namespace file
                   6817:     my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
                   6818:     while (($gotlock ne 'ok') && $tries <$locktries) {
                   6819:         $tries ++;
                   6820:         sleep 1;
                   6821:         $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
                   6822:     }
                   6823: 
                   6824: # attempt to get unique identifier, based on current timestamp
                   6825:     if ($gotlock eq 'ok') {
                   6826:         my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
                   6827:         my $id = time;
                   6828:         $newid = $id;
1.1268    raeburn  6829:         if ($idtype eq 'addcode') {
                   6830:             $newid .= &sixnum_code();
                   6831:         }
1.1198    raeburn  6832:         my $idtries = 0;
                   6833:         while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
                   6834:             if ($idtype eq 'concat') {
                   6835:                 $newid = $id.$idtries;
1.1268    raeburn  6836:             } elsif ($idtype eq 'addcode') {
                   6837:                 $newid = $newid.&sixnum_code();
1.1198    raeburn  6838:             } else {
                   6839:                 $newid ++;
                   6840:             }
                   6841:             $idtries ++;
                   6842:         }
                   6843:         if (!exists($inuse{$prefix."\0".$newid})) {
                   6844:             my %new_item =  (
                   6845:                               $prefix."\0".$newid => $who,
                   6846:                             );
                   6847:             my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
                   6848:                                                  $cdom,$cnum);
                   6849:             if ($putresult ne 'ok') {
                   6850:                 undef($newid);
                   6851:                 $error = 'error saving new item: '.$putresult;
                   6852:             }
                   6853:         } else {
1.1268    raeburn  6854:              undef($newid);
1.1198    raeburn  6855:              $error = ('error: no unique suffix available for the new item ');
                   6856:         }
                   6857: #  remove lock
                   6858:         my @del_lock = ($prefix."\0".'locked_'.$keyid);
                   6859:         $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
                   6860:     } else {
                   6861:         $error = "error: could not obtain lockfile\n";
                   6862:         $dellock = 'ok';
1.1276    raeburn  6863:         if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
                   6864:             $dellock = 'nolock';
                   6865:         }
1.1198    raeburn  6866:     }
                   6867:     return ($newid,$dellock,$error);
                   6868: }
                   6869: 
1.1268    raeburn  6870: sub sixnum_code {
                   6871:     my $code;
                   6872:     for (0..6) {
                   6873:         $code .= int( rand(9) );
                   6874:     }
                   6875:     return $code;
                   6876: }
                   6877: 
1.765     albertel 6878: # -------------------------------------------------- portfolio access checking
                   6879: 
                   6880: sub portfolio_access {
1.1270    raeburn  6881:     my ($requrl,$clientip) = @_;
1.765     albertel 6882:     my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270    raeburn  6883:     my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814     raeburn  6884:     if ($result) {
                   6885:         my %setters;
                   6886:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   6887:             my ($startblock,$endblock) =
                   6888:                 &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
                   6889:             if ($startblock && $endblock) {
                   6890:                 return 'B';
                   6891:             }
                   6892:         } else {
                   6893:             my ($startblock,$endblock) =
                   6894:                 &Apache::loncommon::blockcheck(\%setters,'port');
                   6895:             if ($startblock && $endblock) {
                   6896:                 return 'B';
                   6897:             }
                   6898:         }
                   6899:     }
1.765     albertel 6900:     if ($result eq 'ok') {
1.766     albertel 6901:        return 'F';
1.765     albertel 6902:     } elsif ($result =~ /^[^:]+:guest_/) {
1.766     albertel 6903:        return 'A';
1.765     albertel 6904:     }
1.766     albertel 6905:     return '';
1.765     albertel 6906: }
                   6907: 
                   6908: sub get_portfolio_access {
1.1270    raeburn  6909:     my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767     albertel 6910: 
                   6911:     if (!ref($access_hash)) {
                   6912: 	my $current_perms = &get_portfile_permissions($udom,$unum);
                   6913: 	my %access_controls = &get_access_controls($current_perms,$group,
                   6914: 						   $file_name);
                   6915: 	$access_hash = $access_controls{$file_name};
                   6916:     }
                   6917: 
1.1270    raeburn  6918:     my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765     albertel 6919:     my $now = time;
                   6920:     if (ref($access_hash) eq 'HASH') {
                   6921:         foreach my $key (keys(%{$access_hash})) {
                   6922:             my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
                   6923:             if ($start > $now) {
                   6924:                 next;
                   6925:             }
                   6926:             if ($end && $end<$now) {
                   6927:                 next;
                   6928:             }
                   6929:             if ($scope eq 'public') {
                   6930:                 $public = $key;
                   6931:                 last;
                   6932:             } elsif ($scope eq 'guest') {
                   6933:                 $guest = $key;
                   6934:             } elsif ($scope eq 'domains') {
                   6935:                 push(@domains,$key);
                   6936:             } elsif ($scope eq 'users') {
                   6937:                 push(@users,$key);
                   6938:             } elsif ($scope eq 'course') {
                   6939:                 push(@courses,$key);
                   6940:             } elsif ($scope eq 'group') {
                   6941:                 push(@groups,$key);
1.1270    raeburn  6942:             } elsif ($scope eq 'ip') {
                   6943:                 push(@ips,$key);
1.765     albertel 6944:             }
                   6945:         }
                   6946:         if ($public) {
                   6947:             return 'ok';
1.1270    raeburn  6948:         } elsif (@ips > 0) {
                   6949:             my $allowed;
                   6950:             foreach my $ipkey (@ips) {
                   6951:                 if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
                   6952:                     if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
                   6953:                         $allowed = 1;
                   6954:                         last; 
                   6955:                     }
                   6956:                 }
                   6957:             }
                   6958:             if ($allowed) {
                   6959:                 return 'ok';
                   6960:             }
1.765     albertel 6961:         }
                   6962:         if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   6963:             if ($guest) {
                   6964:                 return $guest;
                   6965:             }
                   6966:         } else {
                   6967:             if (@domains > 0) {
                   6968:                 foreach my $domkey (@domains) {
                   6969:                     if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
                   6970:                         if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
                   6971:                             return 'ok';
                   6972:                         }
                   6973:                     }
                   6974:                 }
                   6975:             }
                   6976:             if (@users > 0) {
                   6977:                 foreach my $userkey (@users) {
1.865     raeburn  6978:                     if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
                   6979:                         foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
                   6980:                             if (ref($item) eq 'HASH') {
                   6981:                                 if (($item->{'uname'} eq $env{'user.name'}) &&
                   6982:                                     ($item->{'udom'} eq $env{'user.domain'})) {
                   6983:                                     return 'ok';
                   6984:                                 }
                   6985:                             }
                   6986:                         }
                   6987:                     } 
1.765     albertel 6988:                 }
                   6989:             }
                   6990:             my %roleshash;
                   6991:             my @courses_and_groups = @courses;
                   6992:             push(@courses_and_groups,@groups); 
                   6993:             if (@courses_and_groups > 0) {
                   6994:                 my (%allgroups,%allroles); 
                   6995:                 my ($start,$end,$role,$sec,$group);
                   6996:                 foreach my $envkey (%env) {
1.1060    raeburn  6997:                     if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 6998:                         my $cid = $2.'_'.$3; 
                   6999:                         if ($1 eq 'gr') {
                   7000:                             $group = $4;
                   7001:                             $allgroups{$cid}{$group} = $env{$envkey};
                   7002:                         } else {
                   7003:                             if ($4 eq '') {
                   7004:                                 $sec = 'none';
                   7005:                             } else {
                   7006:                                 $sec = $4;
                   7007:                             }
                   7008:                             $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   7009:                         }
1.811     albertel 7010:                     } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765     albertel 7011:                         my $cid = $2.'_'.$3;
                   7012:                         if ($4 eq '') {
                   7013:                             $sec = 'none';
                   7014:                         } else {
                   7015:                             $sec = $4;
                   7016:                         }
                   7017:                         $allroles{$cid}{$1}{$sec} = $env{$envkey};
                   7018:                     }
                   7019:                 }
                   7020:                 if (keys(%allroles) == 0) {
                   7021:                     return;
                   7022:                 }
                   7023:                 foreach my $key (@courses_and_groups) {
                   7024:                     my %content = %{$$access_hash{$key}};
                   7025:                     my $cnum = $content{'number'};
                   7026:                     my $cdom = $content{'domain'};
                   7027:                     my $cid = $cdom.'_'.$cnum;
                   7028:                     if (!exists($allroles{$cid})) {
                   7029:                         next;
                   7030:                     }    
                   7031:                     foreach my $role_id (keys(%{$content{'roles'}})) {
                   7032:                         my @sections = @{$content{'roles'}{$role_id}{'section'}};
                   7033:                         my @groups = @{$content{'roles'}{$role_id}{'group'}};
                   7034:                         my @status = @{$content{'roles'}{$role_id}{'access'}};
                   7035:                         my @roles = @{$content{'roles'}{$role_id}{'role'}};
                   7036:                         foreach my $role (keys(%{$allroles{$cid}})) {
                   7037:                             if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
                   7038:                                 foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
                   7039:                                     if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
                   7040:                                         if (grep/^all$/,@sections) {
                   7041:                                             return 'ok';
                   7042:                                         } else {
                   7043:                                             if (grep/^$sec$/,@sections) {
                   7044:                                                 return 'ok';
                   7045:                                             }
                   7046:                                         }
                   7047:                                     }
                   7048:                                 }
                   7049:                                 if (keys(%{$allgroups{$cid}}) == 0) {
                   7050:                                     if (grep/^none$/,@groups) {
                   7051:                                         return 'ok';
                   7052:                                     }
                   7053:                                 } else {
                   7054:                                     if (grep/^all$/,@groups) {
                   7055:                                         return 'ok';
                   7056:                                     } 
                   7057:                                     foreach my $group (keys(%{$allgroups{$cid}})) {
                   7058:                                         if (grep/^$group$/,@groups) {
                   7059:                                             return 'ok';
                   7060:                                         }
                   7061:                                     }
                   7062:                                 } 
                   7063:                             }
                   7064:                         }
                   7065:                     }
                   7066:                 }
                   7067:             }
                   7068:             if ($guest) {
                   7069:                 return $guest;
                   7070:             }
                   7071:         }
                   7072:     }
                   7073:     return;
                   7074: }
                   7075: 
                   7076: sub course_group_datechecker {
                   7077:     my ($dates,$now,$status) = @_;
                   7078:     my ($start,$end) = split(/\./,$dates);
                   7079:     if (!$start && !$end) {
                   7080:         return 'ok';
                   7081:     }
                   7082:     if (grep/^active$/,@{$status}) {
                   7083:         if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
                   7084:             return 'ok';
                   7085:         }
                   7086:     }
                   7087:     if (grep/^previous$/,@{$status}) {
                   7088:         if ($end > $now ) {
                   7089:             return 'ok';
                   7090:         }
                   7091:     }
                   7092:     if (grep/^future$/,@{$status}) {
                   7093:         if ($start > $now) {
                   7094:             return 'ok';
                   7095:         }
                   7096:     }
                   7097:     return; 
                   7098: }
                   7099: 
                   7100: sub parse_portfolio_url {
                   7101:     my ($url) = @_;
                   7102: 
                   7103:     my ($type,$udom,$unum,$group,$file_name);
                   7104:     
1.823     albertel 7105:     if ($url =~  m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765     albertel 7106: 	$type = 1;
                   7107:         $udom = $1;
                   7108:         $unum = $2;
                   7109:         $file_name = $3;
1.823     albertel 7110:     } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765     albertel 7111: 	$type = 2;
                   7112:         $udom = $1;
                   7113:         $unum = $2;
                   7114:         $group = $3;
                   7115:         $file_name = $3.'/'.$4;
                   7116:     }
                   7117:     if (wantarray) {
                   7118: 	return ($type,$udom,$unum,$file_name,$group);
                   7119:     }
                   7120:     return $type;
                   7121: }
                   7122: 
                   7123: sub is_portfolio_url {
                   7124:     my ($url) = @_;
                   7125:     return scalar(&parse_portfolio_url($url));
                   7126: }
                   7127: 
1.798     raeburn  7128: sub is_portfolio_file {
                   7129:     my ($file) = @_;
1.820     raeburn  7130:     if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798     raeburn  7131:         return 1;
                   7132:     }
                   7133:     return;
                   7134: }
                   7135: 
1.976     raeburn  7136: sub usertools_access {
1.1084    raeburn  7137:     my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985     raeburn  7138:     my ($access,%tools);
                   7139:     if ($context eq '') {
                   7140:         $context = 'tools';
                   7141:     }
                   7142:     if ($context eq 'requestcourses') {
                   7143:         %tools = (
                   7144:                       official   => 1,
                   7145:                       unofficial => 1,
1.1006    raeburn  7146:                       community  => 1,
1.1246    raeburn  7147:                       textbook   => 1,
1.1305    raeburn  7148:                       placement  => 1,
1.985     raeburn  7149:                  );
1.1183    raeburn  7150:     } elsif ($context eq 'requestauthor') {
                   7151:         %tools = (
                   7152:                       requestauthor => 1,
                   7153:                  );
1.985     raeburn  7154:     } else {
                   7155:         %tools = (
                   7156:                       aboutme   => 1,
                   7157:                       blog      => 1,
1.1177    raeburn  7158:                       webdav    => 1,
1.985     raeburn  7159:                       portfolio => 1,
                   7160:                  );
                   7161:     }
1.976     raeburn  7162:     return if (!defined($tools{$tool}));
                   7163: 
1.1242    raeburn  7164:     if (($udom eq '') || ($uname eq '')) {
1.976     raeburn  7165:         $udom = $env{'user.domain'};
                   7166:         $uname = $env{'user.name'};
                   7167:     }
                   7168: 
1.978     raeburn  7169:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
                   7170:         if ($action ne 'reload') {
1.985     raeburn  7171:             if ($context eq 'requestcourses') {
                   7172:                 return $env{'environment.canrequest.'.$tool};
1.1183    raeburn  7173:             } elsif ($context eq 'requestauthor') {
                   7174:                 return $env{'environment.canrequest.author'};
1.985     raeburn  7175:             } else {
                   7176:                 return $env{'environment.availabletools.'.$tool};
                   7177:             }
                   7178:         }
1.976     raeburn  7179:     }
                   7180: 
1.1183    raeburn  7181:     my ($toolstatus,$inststatus,$envkey);
                   7182:     if ($context eq 'requestauthor') {
                   7183:         $envkey = $context; 
                   7184:     } else {
                   7185:         $envkey = $context.'.'.$tool;
                   7186:     }
1.976     raeburn  7187: 
1.985     raeburn  7188:     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
                   7189:          ($action ne 'reload')) {
1.1183    raeburn  7190:         $toolstatus = $env{'environment.'.$envkey};
1.976     raeburn  7191:         $inststatus = $env{'environment.inststatus'};
                   7192:     } else {
1.1084    raeburn  7193:         if (ref($userenvref) eq 'HASH') {
1.1183    raeburn  7194:             $toolstatus = $userenvref->{$envkey};
1.1084    raeburn  7195:             $inststatus = $userenvref->{'inststatus'};
                   7196:         } else {
1.1183    raeburn  7197:             my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
                   7198:             $toolstatus = $userenv{$envkey};
1.1084    raeburn  7199:             $inststatus = $userenv{'inststatus'};
                   7200:         }
1.976     raeburn  7201:     }
                   7202: 
                   7203:     if ($toolstatus ne '') {
                   7204:         if ($toolstatus) {
                   7205:             $access = 1;
                   7206:         } else {
                   7207:             $access = 0;
                   7208:         }
                   7209:         return $access;
                   7210:     }
                   7211: 
1.1084    raeburn  7212:     my ($is_adv,%domdef);
                   7213:     if (ref($is_advref) eq 'HASH') {
                   7214:         $is_adv = $is_advref->{'is_adv'};
                   7215:     } else {
                   7216:         $is_adv = &is_advanced_user($udom,$uname);
                   7217:     }
                   7218:     if (ref($domdefref) eq 'HASH') {
                   7219:         %domdef = %{$domdefref};
                   7220:     } else {
                   7221:         %domdef = &get_domain_defaults($udom);
                   7222:     }
1.976     raeburn  7223:     if (ref($domdef{$tool}) eq 'HASH') {
                   7224:         if ($is_adv) {
                   7225:             if ($domdef{$tool}{'_LC_adv'} ne '') {
                   7226:                 if ($domdef{$tool}{'_LC_adv'}) { 
                   7227:                     $access = 1;
                   7228:                 } else {
                   7229:                     $access = 0;
                   7230:                 }
                   7231:                 return $access;
                   7232:             }
                   7233:         }
                   7234:         if ($inststatus ne '') {
                   7235:             my ($hasaccess,$hasnoaccess);
                   7236:             foreach my $affiliation (split(/:/,$inststatus)) {
                   7237:                 if ($domdef{$tool}{$affiliation} ne '') { 
                   7238:                     if ($domdef{$tool}{$affiliation}) {
                   7239:                         $hasaccess = 1;
                   7240:                     } else {
                   7241:                         $hasnoaccess = 1;
                   7242:                     }
                   7243:                 }
                   7244:             }
                   7245:             if ($hasaccess || $hasnoaccess) {
                   7246:                 if ($hasaccess) {
                   7247:                     $access = 1;
                   7248:                 } elsif ($hasnoaccess) {
                   7249:                     $access = 0; 
                   7250:                 }
                   7251:                 return $access;
                   7252:             }
                   7253:         } else {
                   7254:             if ($domdef{$tool}{'default'} ne '') {
                   7255:                 if ($domdef{$tool}{'default'}) {
                   7256:                     $access = 1;
                   7257:                 } elsif ($domdef{$tool}{'default'} == 0) {
                   7258:                     $access = 0;
                   7259:                 }
                   7260:                 return $access;
                   7261:             }
                   7262:         }
                   7263:     } else {
1.1177    raeburn  7264:         if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985     raeburn  7265:             $access = 1;
                   7266:         } else {
                   7267:             $access = 0;
                   7268:         }
1.976     raeburn  7269:         return $access;
                   7270:     }
                   7271: }
                   7272: 
1.1050    raeburn  7273: sub is_course_owner {
                   7274:     my ($cdom,$cnum,$udom,$uname) = @_;
                   7275:     if (($udom eq '') || ($uname eq '')) {
                   7276:         $udom = $env{'user.domain'};
                   7277:         $uname = $env{'user.name'};
                   7278:     }
                   7279:     unless (($udom eq '') || ($uname eq '')) {
                   7280:         if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
                   7281:             if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
                   7282:                 return 1;
                   7283:             } else {
                   7284:                 my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
                   7285:                 if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
                   7286:                     return 1;
                   7287:                 }
                   7288:             }
                   7289:         }
                   7290:     }
                   7291:     return;
                   7292: }
                   7293: 
1.976     raeburn  7294: sub is_advanced_user {
                   7295:     my ($udom,$uname) = @_;
1.1085    raeburn  7296:     if ($udom ne '' && $uname ne '') {
                   7297:         if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128    raeburn  7298:             if (wantarray) {
                   7299:                 return ($env{'user.adv'},$env{'user.author'});
                   7300:             } else {
                   7301:                 return $env{'user.adv'};
                   7302:             }
1.1085    raeburn  7303:         }
                   7304:     }
1.976     raeburn  7305:     my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
                   7306:     my %allroles;
1.1128    raeburn  7307:     my ($is_adv,$is_author);
1.976     raeburn  7308:     foreach my $role (keys(%roleshash)) {
                   7309:         my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
                   7310:         my $area = '/'.$tdomain.'/'.$trest;
                   7311:         if ($sec ne '') {
                   7312:             $area .= '/'.$sec;
                   7313:         }
                   7314:         if (($area ne '') && ($trole ne '')) {
                   7315:             my $spec=$trole.'.'.$area;
                   7316:             if ($trole =~ /^cr\//) {
                   7317:                 &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
                   7318:             } elsif ($trole ne 'gr') {
                   7319:                 &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
                   7320:             }
1.1128    raeburn  7321:             if ($trole eq 'au') {
                   7322:                 $is_author = 1;
                   7323:             }
1.976     raeburn  7324:         }
                   7325:     }
                   7326:     foreach my $role (keys(%allroles)) {
                   7327:         last if ($is_adv);
                   7328:         foreach my $item (split(/:/,$allroles{$role})) {
                   7329:             if ($item ne '') {
                   7330:                 my ($privilege,$restrictions)=split(/&/,$item);
                   7331:                 if ($privilege eq 'adv') {
                   7332:                     $is_adv = 1;
                   7333:                     last;
                   7334:                 }
                   7335:             }
                   7336:         }
                   7337:     }
1.1128    raeburn  7338:     if (wantarray) {
                   7339:         return ($is_adv,$is_author);
                   7340:     }
1.976     raeburn  7341:     return $is_adv;
                   7342: }
1.798     raeburn  7343: 
1.1035    raeburn  7344: sub check_can_request {
1.1036    raeburn  7345:     my ($dom,$can_request,$request_domains) = @_;
1.1035    raeburn  7346:     my $canreq = 0;
                   7347:     my ($types,$typename) = &Apache::loncommon::course_types();
                   7348:     my @options = ('approval','validate','autolimit');
                   7349:     my $optregex = join('|',@options);
                   7350:     if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
                   7351:         foreach my $type (@{$types}) {
                   7352:             if (&usertools_access($env{'user.name'},
                   7353:                                   $env{'user.domain'},
                   7354:                                   $type,undef,'requestcourses')) {
                   7355:                 $canreq ++;
1.1036    raeburn  7356:                 if (ref($request_domains) eq 'HASH') {
                   7357:                     push(@{$request_domains->{$type}},$env{'user.domain'});
                   7358:                 }
1.1035    raeburn  7359:                 if ($dom eq $env{'user.domain'}) {
                   7360:                     $can_request->{$type} = 1;
                   7361:                 }
                   7362:             }
                   7363:             if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
                   7364:                 my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
                   7365:                 if (@curr > 0) {
1.1036    raeburn  7366:                     foreach my $item (@curr) {
                   7367:                         if (ref($request_domains) eq 'HASH') {
                   7368:                             my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
                   7369:                             if ($otherdom ne '') {
                   7370:                                 if (ref($request_domains->{$type}) eq 'ARRAY') {
                   7371:                                     unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
                   7372:                                         push(@{$request_domains->{$type}},$otherdom);
                   7373:                                     }
                   7374:                                 } else {
                   7375:                                     push(@{$request_domains->{$type}},$otherdom);
                   7376:                                 }
                   7377:                             }
                   7378:                         }
                   7379:                     }
                   7380:                     unless($dom eq $env{'user.domain'}) {
                   7381:                         $canreq ++;
1.1035    raeburn  7382:                         if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
                   7383:                             $can_request->{$type} = 1;
                   7384:                         }
                   7385:                     }
                   7386:                 }
                   7387:             }
                   7388:         }
                   7389:     }
                   7390:     return $canreq;
                   7391: }
                   7392: 
1.341     www      7393: # ---------------------------------------------- Custom access rule evaluation
                   7394: 
                   7395: sub customaccess {
                   7396:     my ($priv,$uri)=@_;
1.807     albertel 7397:     my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819     www      7398:     my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807     albertel 7399:     $udom = &LONCAPA::clean_domain($udom);
                   7400:     $ucrs = &LONCAPA::clean_username($ucrs);
1.341     www      7401:     my $access=0;
1.800     albertel 7402:     foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893     albertel 7403: 	my ($effect,$realm,$role,$type)=split(/\:/,$right);
                   7404: 	if ($type eq 'user') {
                   7405: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896     albertel 7406: 		my ($tdom,$tuname)=split(m{/},$scope);
1.893     albertel 7407: 		if ($tdom) {
                   7408: 		    if ($tdom ne $env{'user.domain'}) { next; }
                   7409: 		}
1.896     albertel 7410: 		if ($tuname) {
                   7411: 		    if ($tuname ne $env{'user.name'}) { next; }
1.893     albertel 7412: 		}
                   7413: 		$access=($effect eq 'allow');
                   7414: 		last;
                   7415: 	    }
                   7416: 	} else {
                   7417: 	    if ($role) {
                   7418: 		if ($role ne $urole) { next; }
                   7419: 	    }
                   7420: 	    foreach my $scope (split(/\s*\,\s*/,$realm)) {
                   7421: 		my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
                   7422: 		if ($tdom) {
                   7423: 		    if ($tdom ne $udom) { next; }
                   7424: 		}
                   7425: 		if ($tcrs) {
                   7426: 		    if ($tcrs ne $ucrs) { next; }
                   7427: 		}
                   7428: 		if ($tsec) {
                   7429: 		    if ($tsec ne $usec) { next; }
                   7430: 		}
                   7431: 		$access=($effect eq 'allow');
                   7432: 		last;
                   7433: 	    }
                   7434: 	    if ($realm eq '' && $role eq '') {
                   7435: 		$access=($effect eq 'allow');
                   7436: 	    }
1.402     bowersj2 7437: 	}
1.341     www      7438:     }
                   7439:     return $access;
                   7440: }
                   7441: 
1.103     harris41 7442: # ------------------------------------------------- Check for a user privilege
1.12      www      7443: 
                   7444: sub allowed {
1.1281    raeburn  7445:     my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705     albertel 7446:     my $ver_orguri=$uri;
1.439     www      7447:     $uri=&deversion($uri);
1.152     www      7448:     my $orguri=$uri;
1.52      www      7449:     $uri=&declutter($uri);
1.809     raeburn  7450: 
1.810     raeburn  7451:     if ($priv eq 'evb') {
                   7452: # Evade communication block restrictions for specified role in a course
                   7453:         if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
                   7454:             return $1;
                   7455:         } else {
                   7456:             return;
                   7457:         }
                   7458:     }
                   7459: 
1.620     albertel 7460:     if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54      www      7461: # Free bre access to adm and meta resources
1.1343    raeburn  7462:     if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|ext\.tool)$})) 
1.769     albertel 7463: 	 || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 
                   7464: 	&& ($priv eq 'bre')) {
1.14      www      7465: 	return 'F';
1.159     www      7466:     }
                   7467: 
1.545     banghart 7468: # Free bre access to user's own portfolio contents
1.714     raeburn  7469:     my ($space,$domain,$name,@dir)=split('/',$uri);
1.647     raeburn  7470:     if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 
1.714     raeburn  7471: 	($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814     raeburn  7472:         my %setters;
                   7473:         my ($startblock,$endblock) = 
                   7474:             &Apache::loncommon::blockcheck(\%setters,'port');
                   7475:         if ($startblock && $endblock) {
                   7476:             return 'B';
                   7477:         } else {
                   7478:             return 'F';
                   7479:         }
1.545     banghart 7480:     }
                   7481: 
1.762     raeburn  7482: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714     raeburn  7483:     if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 
                   7484:          && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
                   7485:         if (exists($env{'request.course.id'})) {
                   7486:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   7487:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   7488:             if (($domain eq $cdom) && ($name eq $cnum)) {
                   7489:                 my $courseprivid=$env{'request.course.id'};
                   7490:                 $courseprivid=~s/\_/\//;
                   7491:                 if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
                   7492:                     .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
                   7493:                     return $1; 
1.762     raeburn  7494:                 } else {
                   7495:                     if ($env{'request.course.sec'}) {
                   7496:                         $courseprivid.='/'.$env{'request.course.sec'};
                   7497:                     }
                   7498:                     if ($env{'user.priv.'.$env{'request.role'}.'./'.
                   7499:                         $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
                   7500:                         return $2;
                   7501:                     }
1.714     raeburn  7502:                 }
                   7503:             }
                   7504:         }
                   7505:     }
                   7506: 
1.159     www      7507: # Free bre to public access
                   7508: 
                   7509:     if ($priv eq 'bre') {
1.1362    raeburn  7510:         my $copyright;
                   7511:         unless ($uri =~ /ext\.tool/) {
                   7512:             $copyright=&metadata($uri,'copyright');
                   7513:         }
1.620     albertel 7514: 	if (($copyright eq 'public') && (!$env{'request.course.id'})) { 
1.301     www      7515:            return 'F'; 
                   7516:         }
1.238     www      7517:         if ($copyright eq 'priv') {
                   7518:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 7519: 	    unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238     www      7520: 		return '';
                   7521:             }
                   7522:         }
                   7523:         if ($copyright eq 'domain') {
                   7524:             $uri=~/([^\/]+)\/([^\/]+)\//;
1.620     albertel 7525: 	    unless (($env{'user.domain'} eq $1) ||
                   7526:                  ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238     www      7527: 		return '';
                   7528:             }
1.262     matthew  7529:         }
1.620     albertel 7530:         if ($env{'request.role'}=~ /li\.\//) {
1.262     matthew  7531:             # Library role, so allow browsing of resources in this domain.
                   7532:             return 'F';
1.238     www      7533:         }
1.341     www      7534:         if ($copyright eq 'custom') {
                   7535: 	    unless (&customaccess($priv,$uri)) { return ''; }
                   7536:         }
1.14      www      7537:     }
1.264     matthew  7538:     # Domain coordinator is trying to create a course
1.620     albertel 7539:     if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264     matthew  7540:         # uri is the requested domain in this case.
                   7541:         # comparison to 'request.role.domain' shows if the user has selected
1.678     raeburn  7542:         # a role of dc for the domain in question.
1.620     albertel 7543:         return 'F' if ($uri eq $env{'request.role.domain'});
1.264     matthew  7544:     }
1.29      www      7545: 
1.52      www      7546:     my $thisallowed='';
                   7547:     my $statecond=0;
                   7548:     my $courseprivid='';
                   7549: 
1.1039    raeburn  7550:     my $ownaccess;
1.1043    raeburn  7551:     # Community Coordinator or Assistant Co-author browsing resource space.
1.1039    raeburn  7552:     if (($priv eq 'bro') && ($env{'user.author'})) {
                   7553:         if ($uri eq '') {
                   7554:             $ownaccess = 1;
                   7555:         } else {
                   7556:             if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   7557:                 my $udom = $env{'user.domain'};
                   7558:                 my $uname = $env{'user.name'};
                   7559:                 if ($uri =~ m{^\Q$udom\E/?$}) {
                   7560:                     $ownaccess = 1;
1.1040    raeburn  7561:                 } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039    raeburn  7562:                     unless ($uri =~ m{\.\./}) {
                   7563:                         $ownaccess = 1;
                   7564:                     }
                   7565:                 } elsif (($udom ne 'public') && ($uname ne 'public')) {
                   7566:                     my $now = time;
                   7567:                     if ($uri =~ m{^([^/]+)/?$}) {
                   7568:                         my $adom = $1;
                   7569:                         foreach my $key (keys(%env)) {
1.1042    raeburn  7570:                             if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039    raeburn  7571:                                 my ($start,$end) = split('.',$env{$key});
                   7572:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   7573:                                     $ownaccess = 1;
                   7574:                                     last;
                   7575:                                 }
                   7576:                             }
                   7577:                         }
                   7578:                     } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
                   7579:                         my $adom = $1;
                   7580:                         my $aname = $2;
1.1042    raeburn  7581:                         foreach my $role ('ca','aa') { 
                   7582:                             if ($env{"user.role.$role./$adom/$aname"}) {
                   7583:                                 my ($start,$end) =
                   7584:                                     split('.',$env{"user.role.$role./$adom/$aname"});
                   7585:                                 if (($now >= $start) && (!$end || $end < $now)) {
                   7586:                                     $ownaccess = 1;
                   7587:                                     last;
                   7588:                                 }
1.1039    raeburn  7589:                             }
                   7590:                         }
                   7591:                     }
                   7592:                 }
                   7593:             }
                   7594:         }
                   7595:     }
                   7596: 
1.52      www      7597: # Course
                   7598: 
1.620     albertel 7599:     if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  7600:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  7601:             $thisallowed.=$1;
                   7602:         }
1.52      www      7603:     }
1.29      www      7604: 
1.52      www      7605: # Domain
                   7606: 
1.620     albertel 7607:     if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479     albertel 7608:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  7609:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  7610:             $thisallowed.=$1;
                   7611:         }
1.12      www      7612:     }
1.52      www      7613: 
1.1141    raeburn  7614: # User who is not author or co-author might still be able to edit
                   7615: # resource of an author in the domain (e.g., if Domain Coordinator).
                   7616:     if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
                   7617:         (&allowed('mdc',$env{'request.course.id'}))) {
                   7618:         if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
                   7619:             $thisallowed.=$1;
                   7620:         }
                   7621:     }
                   7622: 
1.52      www      7623: # Course: uri itself is a course
1.66      www      7624:     my $courseuri=$uri;
                   7625:     $courseuri=~s/\_(\d)/\/$1/;
1.83      www      7626:     $courseuri=~s/^([^\/])/\/$1/;
1.81      www      7627: 
1.620     albertel 7628:     if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479     albertel 7629:        =~/\Q$priv\E\&([^\:]*)/) {
1.1043    raeburn  7630:         unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039    raeburn  7631:             $thisallowed.=$1;
                   7632:         }
1.12      www      7633:     }
1.29      www      7634: 
1.665     albertel 7635: # URI is an uploaded document for this course, default permissions don't matter
1.611     albertel 7636: # not allowing 'edit' access (editupload) to uploaded course docs
1.492     albertel 7637:     if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665     albertel 7638: 	$thisallowed='';
1.671     raeburn  7639:         my ($match)=&is_on_map($uri);
                   7640:         if ($match) {
                   7641:             if ($env{'user.priv.'.$env{'request.role'}.'./'}
                   7642:                   =~/\Q$priv\E\&([^\:]*)/) {
1.1281    raeburn  7643:                 my $value = $1;
                   7644:                 if ($noblockcheck) {
                   7645:                     $thisallowed.=$value;
1.1162    raeburn  7646:                 } else {
1.1281    raeburn  7647:                     my @blockers = &has_comm_blocking($priv,$symb,$uri);
                   7648:                     if (@blockers > 0) {
                   7649:                         $thisallowed = 'B';
                   7650:                     } else {
                   7651:                         $thisallowed.=$value;
                   7652:                     }
1.1162    raeburn  7653:                 }
1.671     raeburn  7654:             }
                   7655:         } else {
1.705     albertel 7656:             my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671     raeburn  7657:             if ($refuri) {
                   7658:                 if ($refuri =~ m|^/adm/|) {
1.669     raeburn  7659:                     $thisallowed='F';
1.671     raeburn  7660:                 } else {
                   7661:                     $refuri=&declutter($refuri);
                   7662:                     my ($match) = &is_on_map($refuri);
                   7663:                     if ($match) {
1.1281    raeburn  7664:                         if ($noblockcheck) {
                   7665:                             $thisallowed='F';
1.1162    raeburn  7666:                         } else {
1.1281    raeburn  7667:                             my @blockers = &has_comm_blocking($priv,$symb,$refuri);
                   7668:                             if (@blockers > 0) {
                   7669:                                 $thisallowed = 'B';
                   7670:                             } else {
                   7671:                                 $thisallowed='F';
                   7672:                             }
1.1162    raeburn  7673:                         }
1.671     raeburn  7674:                     }
1.669     raeburn  7675:                 }
1.671     raeburn  7676:             }
                   7677:         }
1.314     www      7678:     }
1.492     albertel 7679: 
1.766     albertel 7680:     if ($priv eq 'bre'
                   7681: 	&& $thisallowed ne 'F' 
                   7682: 	&& $thisallowed ne '2'
                   7683: 	&& &is_portfolio_url($uri)) {
1.1270    raeburn  7684: 	$thisallowed = &portfolio_access($uri,$clientip);
1.766     albertel 7685:     }
1.1250    raeburn  7686: 
1.52      www      7687: # Full access at system, domain or course-wide level? Exit.
1.29      www      7688:     if ($thisallowed=~/F/) {
                   7689: 	return 'F';
                   7690:     }
                   7691: 
1.52      www      7692: # If this is generating or modifying users, exit with special codes
1.29      www      7693: 
1.643     www      7694:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
                   7695: 	if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642     albertel 7696: 	    my ($audom,$auname)=split('/',$uri);
1.643     www      7697: # no author name given, so this just checks on the general right to make a co-author in this domain
                   7698: 	    unless ($auname) { return $thisallowed; }
                   7699: # an author name is given, so we are about to actually make a co-author for a certain account
1.642     albertel 7700: 	    if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
                   7701: 		(($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
                   7702: 		 ($audom ne $env{'request.role.domain'}))) { return ''; }
                   7703: 	}
1.52      www      7704: 	return $thisallowed;
                   7705:     }
                   7706: #
1.103     harris41 7707: # Gathered so far: system, domain and course wide privileges
1.52      www      7708: #
                   7709: # Course: See if uri or referer is an individual resource that is part of 
                   7710: # the course
                   7711: 
1.620     albertel 7712:     if ($env{'request.course.id'}) {
1.232     www      7713: 
1.620     albertel 7714:        $courseprivid=$env{'request.course.id'};
                   7715:        if ($env{'request.course.sec'}) {
                   7716:           $courseprivid.='/'.$env{'request.course.sec'};
1.52      www      7717:        }
                   7718:        $courseprivid=~s/\_/\//;
                   7719:        my $checkreferer=1;
1.232     www      7720:        my ($match,$cond)=&is_on_map($uri);
                   7721:        if ($match) {
                   7722:            $statecond=$cond;
1.620     albertel 7723:            if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 7724:                =~/\Q$priv\E\&([^\:]*)/) {
1.1162    raeburn  7725:                my $value = $1;
                   7726:                if ($priv eq 'bre') {
1.1281    raeburn  7727:                    if ($noblockcheck) {
                   7728:                        $thisallowed.=$value;
1.1162    raeburn  7729:                    } else {
1.1281    raeburn  7730:                        my @blockers = &has_comm_blocking($priv,$symb,$uri);
                   7731:                        if (@blockers > 0) {
                   7732:                            $thisallowed = 'B';
                   7733:                        } else {
                   7734:                            $thisallowed.=$value;
                   7735:                        }
1.1162    raeburn  7736:                    }
                   7737:                } else {
                   7738:                    $thisallowed.=$value;
                   7739:                }
1.52      www      7740:                $checkreferer=0;
                   7741:            }
1.29      www      7742:        }
1.83      www      7743:        
1.148     www      7744:        if ($checkreferer) {
1.620     albertel 7745: 	  my $refuri=$env{'httpref.'.$orguri};
1.148     www      7746:             unless ($refuri) {
1.800     albertel 7747:                 foreach my $key (keys(%env)) {
                   7748: 		    if ($key=~/^httpref\..*\*/) {
                   7749: 			my $pattern=$key;
1.156     www      7750:                         $pattern=~s/^httpref\.\/res\///;
1.148     www      7751:                         $pattern=~s/\*/\[\^\/\]\+/g;
                   7752:                         $pattern=~s/\//\\\//g;
1.152     www      7753:                         if ($orguri=~/$pattern/) {
1.800     albertel 7754: 			    $refuri=$env{$key};
1.148     www      7755:                         }
                   7756:                     }
1.191     harris41 7757:                 }
1.148     www      7758:             }
1.232     www      7759: 
1.148     www      7760:          if ($refuri) { 
1.152     www      7761: 	  $refuri=&declutter($refuri);
1.232     www      7762:           my ($match,$cond)=&is_on_map($refuri);
                   7763:             if ($match) {
                   7764:               my $refstatecond=$cond;
1.620     albertel 7765:               if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479     albertel 7766:                   =~/\Q$priv\E\&([^\:]*)/) {
1.1162    raeburn  7767:                   my $value = $1;
                   7768:                   if ($priv eq 'bre') {
1.1281    raeburn  7769:                       if ($noblockcheck) {
                   7770:                           $thisallowed.=$value;
1.1162    raeburn  7771:                       } else {
1.1281    raeburn  7772:                           my @blockers = &has_comm_blocking($priv,$symb,$refuri);
                   7773:                           if (@blockers > 0) {
                   7774:                               $thisallowed = 'B';
                   7775:                           } else {
                   7776:                               $thisallowed.=$value;
                   7777:                           }
1.1162    raeburn  7778:                       }
                   7779:                   } else {
                   7780:                       $thisallowed.=$value;
                   7781:                   }
1.53      www      7782:                   $uri=$refuri;
                   7783:                   $statecond=$refstatecond;
1.52      www      7784:               }
                   7785:           }
1.148     www      7786:         }
1.29      www      7787:        }
1.52      www      7788:    }
1.29      www      7789: 
1.52      www      7790: #
1.103     harris41 7791: # Gathered now: all privileges that could apply, and condition number
1.52      www      7792: # 
                   7793: #
                   7794: # Full or no access?
                   7795: #
1.29      www      7796: 
1.52      www      7797:     if ($thisallowed=~/F/) {
                   7798: 	return 'F';
                   7799:     }
1.29      www      7800: 
1.52      www      7801:     unless ($thisallowed) {
                   7802:         return '';
                   7803:     }
1.29      www      7804: 
1.52      www      7805: # Restrictions exist, deal with them
                   7806: #
                   7807: #   C:according to course preferences
                   7808: #   R:according to resource settings
                   7809: #   L:unless locked
                   7810: #   X:according to user session state
                   7811: #
                   7812: 
                   7813: # Possibly locked functionality, check all courses
1.54      www      7814: # Locks might take effect only after 10 minutes cache expiration for other
                   7815: # courses, and 2 minutes for current course
1.52      www      7816: 
                   7817:     my $envkey;
                   7818:     if ($thisallowed=~/L/) {
1.1000    raeburn  7819:         foreach $envkey (keys(%env)) {
1.54      www      7820:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
                   7821:                my $courseid=$2;
                   7822:                my $roleid=$1.'.'.$2;
1.92      www      7823:                $courseid=~s/^\///;
1.54      www      7824:                my $expiretime=600;
1.620     albertel 7825:                if ($env{'request.role'} eq $roleid) {
1.54      www      7826: 		  $expiretime=120;
                   7827:                }
                   7828: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
                   7829:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620     albertel 7830:                if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731     albertel 7831: 		   &coursedescription($courseid,{'freshen_cache' => 1});
1.54      www      7832:                }
1.620     albertel 7833:                if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   7834:                 || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
                   7835: 		   if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
                   7836:                        &log($env{'user.domain'},$env{'user.name'},
                   7837:                             $env{'user.home'},
1.57      www      7838:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52      www      7839:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 7840:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      7841: 		       return '';
                   7842:                    }
                   7843:                }
1.620     albertel 7844:                if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
                   7845:                 || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
                   7846: 		   if ($env{'priv.'.$priv.'.lock.expire'}>time) {
                   7847:                        &log($env{'user.domain'},$env{'user.name'},
                   7848:                             $env{'user.home'},
1.57      www      7849:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52      www      7850:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620     albertel 7851:                             $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      7852: 		       return '';
                   7853:                    }
                   7854:                }
                   7855: 	   }
1.29      www      7856:        }
1.52      www      7857:     }
                   7858:    
                   7859: #
                   7860: # Rest of the restrictions depend on selected course
                   7861: #
                   7862: 
1.620     albertel 7863:     unless ($env{'request.course.id'}) {
1.766     albertel 7864: 	if ($thisallowed eq 'A') {
                   7865: 	    return 'A';
1.814     raeburn  7866:         } elsif ($thisallowed eq 'B') {
                   7867:             return 'B';
1.766     albertel 7868: 	} else {
                   7869: 	    return '1';
                   7870: 	}
1.52      www      7871:     }
1.29      www      7872: 
1.52      www      7873: #
                   7874: # Now user is definitely in a course
                   7875: #
1.53      www      7876: 
                   7877: 
                   7878: # Course preferences
                   7879: 
                   7880:    if ($thisallowed=~/C/) {
1.620     albertel 7881:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
                   7882:        my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
                   7883:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479     albertel 7884: 	   =~/\Q$rolecode\E/) {
1.1304    raeburn  7885: 	   if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689     albertel 7886: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   7887: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
                   7888: 			$env{'request.course.id'});
                   7889: 	   }
1.237     www      7890:            return '';
                   7891:        }
                   7892: 
1.620     albertel 7893:        if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479     albertel 7894: 	   =~/\Q$unamedom\E/) {
1.1304    raeburn  7895: 	   if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689     albertel 7896: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
                   7897: 			'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
                   7898: 			$env{'request.course.id'});
                   7899: 	   }
1.54      www      7900:            return '';
                   7901:        }
1.53      www      7902:    }
                   7903: 
                   7904: # Resource preferences
                   7905: 
                   7906:    if ($thisallowed=~/R/) {
1.620     albertel 7907:        my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479     albertel 7908:        if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103    raeburn  7909: 	   if (($priv ne 'pch') && ($priv ne 'plc')) { 
1.689     albertel 7910: 	       &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
                   7911: 			'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
                   7912: 	   }
                   7913: 	   return '';
1.54      www      7914:        }
1.53      www      7915:    }
1.30      www      7916: 
1.246     www      7917: # Restricted by state or randomout?
1.30      www      7918: 
1.52      www      7919:    if ($thisallowed=~/X/) {
1.620     albertel 7920:       if ($env{'acc.randomout'}) {
1.579     albertel 7921: 	 if (!$symb) { $symb=&symbread($uri,1); }
1.620     albertel 7922:          if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 
1.248     www      7923:             return ''; 
                   7924:          }
1.247     www      7925:       }
                   7926:       if (&condval($statecond)) {
1.52      www      7927: 	 return '2';
                   7928:       } else {
                   7929:          return '';
                   7930:       }
                   7931:    }
1.30      www      7932: 
1.766     albertel 7933:     if ($thisallowed eq 'A') {
                   7934: 	return 'A';
1.814     raeburn  7935:     } elsif ($thisallowed eq 'B') {
                   7936:         return 'B';
1.766     albertel 7937:     }
1.52      www      7938:    return 'F';
1.232     www      7939: }
1.1162    raeburn  7940: 
1.1192    raeburn  7941: # ------------------------------------------- Check construction space access
                   7942: 
                   7943: sub constructaccess {
                   7944:     my ($url,$setpriv)=@_;
                   7945: 
                   7946: # We do not allow editing of previous versions of files
                   7947:     if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
                   7948: 
                   7949: # Get username and domain from URL
                   7950:     my ($ownername,$ownerdomain,$ownerhome);
                   7951: 
                   7952:     ($ownerdomain,$ownername) =
1.1325    raeburn  7953:         ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192    raeburn  7954: 
                   7955: # The URL does not really point to any authorspace, forget it
                   7956:     unless (($ownername) && ($ownerdomain)) { return ''; }
                   7957: 
                   7958: # Now we need to see if the user has access to the authorspace of
                   7959: # $ownername at $ownerdomain
                   7960: 
                   7961:     if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
                   7962: # Real author for this?
                   7963:        $ownerhome = $env{'user.home'};
                   7964:        if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
                   7965:           return ($ownername,$ownerdomain,$ownerhome);
                   7966:        }
                   7967:     } else {
                   7968: # Co-author for this?
                   7969:         if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
                   7970:             exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
                   7971:             $ownerhome = &homeserver($ownername,$ownerdomain);
                   7972:             return ($ownername,$ownerdomain,$ownerhome);
                   7973:         }
1.1312    raeburn  7974:         if ($env{'request.course.id'}) {
                   7975:             if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
                   7976:                 ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
                   7977:                 if (&allowed('mdc',$env{'request.course.id'})) {
                   7978:                     $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
                   7979:                     return ($ownername,$ownerdomain,$ownerhome);
                   7980:                 }
                   7981:             }
                   7982:         }
1.1192    raeburn  7983:     }
                   7984: 
                   7985: # We don't have any access right now. If we are not possibly going to do anything about this,
                   7986: # we might as well leave
                   7987:    unless ($setpriv) { return ''; }
                   7988: 
                   7989: # Backdoor access?
                   7990:     my $allowed=&allowed('eco',$ownerdomain);
                   7991: # Nope
                   7992:     unless ($allowed) { return ''; }
                   7993: # Looks like we may have access, but could be locked by the owner of the construction space
                   7994:     if ($allowed eq 'U') {
                   7995:         my %blocked=&get('environment',['domcoord.author'],
                   7996:                          $ownerdomain,$ownername);
                   7997: # Is blocked by owner
                   7998:         if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
                   7999:     }
                   8000:     if (($allowed eq 'F') || ($allowed eq 'U')) {
                   8001: # Grant temporary access
                   8002:         my $then=$env{'user.login.time'};
1.1209    raeburn  8003:         my $update=$env{'user.update.time'};
1.1192    raeburn  8004:         if (!$update) { $update = $then; }
                   8005:         my $refresh=$env{'user.refresh.time'};
                   8006:         if (!$refresh) { $refresh = $update; }
                   8007:         my $now = time;
                   8008:         &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
                   8009:                            $now,'ca','constructaccess');
                   8010:         $ownerhome = &homeserver($ownername,$ownerdomain);
                   8011:         return($ownername,$ownerdomain,$ownerhome);
                   8012:     }
                   8013: # No business here
                   8014:     return '';
                   8015: }
                   8016: 
1.1282    raeburn  8017: # ----------------------------------------------------------- Content Blocking
                   8018: 
                   8019: {
                   8020: # Caches for faster Course Contents display where content blocking
                   8021: # is in operation (i.e., interval param set) for timed quiz.
                   8022: #
                   8023: # User for whom data are being temporarily cached.
                   8024: my $cacheduser='';
                   8025: # Cached blockers for this user (a hash of blocking items). 
                   8026: my %cachedblockers=();
                   8027: # When the data were last cached.
                   8028: my $cachedlast='';
                   8029: 
                   8030: sub load_all_blockers {
                   8031:     my ($uname,$udom,$blocks)=@_;
                   8032:     if (($uname ne '') && ($udom ne '')) { 
                   8033:         if (($cacheduser eq $uname.':'.$udom) &&
                   8034:             (abs($cachedlast-time)<5)) {
                   8035:             return;
                   8036:         }
                   8037:     }
                   8038:     $cachedlast=time;
                   8039:     $cacheduser=$uname.':'.$udom;
                   8040:     %cachedblockers = &get_commblock_resources($blocks);
                   8041: }
                   8042: 
1.1162    raeburn  8043: sub get_comm_blocks {
                   8044:     my ($cdom,$cnum) = @_;
                   8045:     if ($cdom eq '' || $cnum eq '') {
                   8046:         return unless ($env{'request.course.id'});
                   8047:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   8048:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8049:     }
                   8050:     my %commblocks;
                   8051:     my $hashid=$cdom.'_'.$cnum;
                   8052:     my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
                   8053:     if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
                   8054:         %commblocks = %{$blocksref};
                   8055:     } else {
                   8056:         %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   8057:         my $cachetime = 600;
                   8058:         &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
                   8059:     }
                   8060:     return %commblocks;
                   8061: }
                   8062: 
1.1282    raeburn  8063: sub get_commblock_resources {
                   8064:     my ($blocks) = @_;
                   8065:     my %blockers = ();
                   8066:     return %blockers unless ($env{'request.course.id'});
                   8067:     return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162    raeburn  8068:     my %commblocks;
                   8069:     if (ref($blocks) eq 'HASH') {
                   8070:         %commblocks = %{$blocks};
                   8071:     } else {
                   8072:         %commblocks = &get_comm_blocks();
                   8073:     }
1.1282    raeburn  8074:     return %blockers unless (keys(%commblocks) > 0); 
                   8075:     my $navmap = Apache::lonnavmaps::navmap->new();
                   8076:     return %blockers unless (ref($navmap));
1.1162    raeburn  8077:     my $now = time;
                   8078:     foreach my $block (keys(%commblocks)) {
                   8079:         if ($block =~ /^(\d+)____(\d+)$/) {
                   8080:             my ($start,$end) = ($1,$2);
                   8081:             if ($start <= $now && $end >= $now) {
                   8082:                 if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   8083:                     if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
                   8084:                         if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282    raeburn  8085:                             if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
                   8086:                                 $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'}; 
1.1162    raeburn  8087:                             }
                   8088:                         }
                   8089:                         if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282    raeburn  8090:                             if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
                   8091:                                 $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162    raeburn  8092:                             }
                   8093:                         }
                   8094:                     }
                   8095:                 }
                   8096:             }
                   8097:         } elsif ($block =~ /^firstaccess____(.+)$/) {
                   8098:             my $item = $1;
1.1163    raeburn  8099:             my @to_test;
1.1162    raeburn  8100:             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   8101:                 if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1282    raeburn  8102:                     my @interval;
                   8103:                     my $type = 'map';
                   8104:                     if ($item eq 'course') {
                   8105:                         $type = 'course';
                   8106:                         @interval=&EXT("resource.0.interval");
                   8107:                     } else {
                   8108:                         if ($item =~ /___\d+___/) {
                   8109:                             $type = 'resource';
                   8110:                             @interval=&EXT("resource.0.interval",$item);
                   8111:                             if (ref($navmap)) {                        
                   8112:                                 my $res = $navmap->getBySymb($item); 
                   8113:                                 push(@to_test,$res);
                   8114:                             }
1.1162    raeburn  8115:                         } else {
1.1282    raeburn  8116:                             my $mapsymb = &symbread($item,1);
                   8117:                             if ($mapsymb) {
                   8118:                                 if (ref($navmap)) {
                   8119:                                     my $mapres = $navmap->getBySymb($mapsymb);
                   8120:                                     @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
                   8121:                                     foreach my $res (@to_test) {
                   8122:                                         my $symb = $res->symb();
                   8123:                                         next if ($symb eq $mapsymb);
                   8124:                                         if ($symb ne '') {
                   8125:                                             @interval=&EXT("resource.0.interval",$symb);
                   8126:                                             if ($interval[1] eq 'map') {
                   8127:                                                 last;
1.1162    raeburn  8128:                                             }
                   8129:                                         }
                   8130:                                     }
                   8131:                                 }
                   8132:                             }
                   8133:                         }
1.1282    raeburn  8134:                     }
1.1310    raeburn  8135:                     if ($interval[0] =~ /^(\d+)/) {
1.1308    raeburn  8136:                         my $timelimit = $1; 
1.1282    raeburn  8137:                         my $first_access;
                   8138:                         if ($type eq 'resource') {
                   8139:                             $first_access=&get_first_access($interval[1],$item);
                   8140:                         } elsif ($type eq 'map') {
                   8141:                             $first_access=&get_first_access($interval[1],undef,$item);
                   8142:                         } else {
                   8143:                             $first_access=&get_first_access($interval[1]);
                   8144:                         }
                   8145:                         if ($first_access) {
1.1292    raeburn  8146:                             my $timesup = $first_access+$timelimit;
1.1282    raeburn  8147:                             if ($timesup > $now) {
                   8148:                                 my $activeblock;
                   8149:                                 foreach my $res (@to_test) {
1.1283    raeburn  8150:                                     if ($res->answerable()) {
1.1282    raeburn  8151:                                         $activeblock = 1;
                   8152:                                         last;
                   8153:                                     }
                   8154:                                 }
                   8155:                                 if ($activeblock) {
                   8156:                                     if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
                   8157:                                          if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
                   8158:                                              $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
                   8159:                                          }
                   8160:                                     }
                   8161:                                     if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
                   8162:                                         if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
                   8163:                                             $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163    raeburn  8164:                                         }
1.1162    raeburn  8165:                                     }
                   8166:                                 }
                   8167:                             }
                   8168:                         }
                   8169:                     }
                   8170:                 }
                   8171:             }
                   8172:         }
                   8173:     }
1.1282    raeburn  8174:     return %blockers;
1.1162    raeburn  8175: }
                   8176: 
1.1282    raeburn  8177: sub has_comm_blocking {
                   8178:     my ($priv,$symb,$uri,$blocks) = @_;
                   8179:     my @blockers;
                   8180:     return unless ($env{'request.course.id'});
                   8181:     return unless ($priv eq 'bre');
                   8182:     return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
                   8183:     return if ($env{'request.state'} eq 'construct');
                   8184:     &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
                   8185:     return unless (keys(%cachedblockers) > 0);
                   8186:     my (%possibles,@symbs);
                   8187:     if (!$symb) {
                   8188:         $symb = &symbread($uri,1,1,1,\%possibles);
1.1162    raeburn  8189:     }
1.1282    raeburn  8190:     if ($symb) {
                   8191:         @symbs = ($symb);
                   8192:     } elsif (keys(%possibles)) { 
                   8193:         @symbs = keys(%possibles);
                   8194:     }
                   8195:     my $noblock;
                   8196:     foreach my $symb (@symbs) {
                   8197:         last if ($noblock);
                   8198:         my ($map,$resid,$resurl)=&decode_symb($symb);
                   8199:         foreach my $block (keys(%cachedblockers)) {
                   8200:             if ($block =~ /^firstaccess____(.+)$/) {
                   8201:                 my $item = $1;
                   8202:                 if (($item eq $map) || ($item eq $symb)) {
                   8203:                     $noblock = 1;
                   8204:                     last;
                   8205:                 }
                   8206:             }
                   8207:             if (ref($cachedblockers{$block}) eq 'HASH') {
                   8208:                 if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
                   8209:                     if ($cachedblockers{$block}{'resources'}{$symb}) {
                   8210:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   8211:                             push(@blockers,$block);
                   8212:                         }
                   8213:                     }
                   8214:                 }
1.1162    raeburn  8215:             }
1.1282    raeburn  8216:             if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
                   8217:                 if ($cachedblockers{$block}{'maps'}{$map}) {
                   8218:                     unless (grep(/^\Q$block\E$/,@blockers)) {
                   8219:                         push(@blockers,$block);
                   8220:                     }
                   8221:                 }
1.1162    raeburn  8222:             }
                   8223:         }
                   8224:     }
1.1282    raeburn  8225:     return if ($noblock);
                   8226:     return @blockers;
                   8227: }
1.1162    raeburn  8228: }
                   8229: 
1.1282    raeburn  8230: # -------------------------------- Deversion and split uri into path an filename   
                   8231: 
1.1133    foxr     8232: #
1.1282    raeburn  8233: #   Removes the version from a URI and
1.1133    foxr     8234: #   splits it in to its filename and path to the filename.
                   8235: #   Seems like File::Basename could have done this more clearly.
                   8236: #   Parameters:
                   8237: #      $uri   - input URI
                   8238: #   Returns:
                   8239: #     Two element list consisting of 
                   8240: #     $pathname  - the URI up to and excluding the trailing /
                   8241: #     $filename  - The part of the URI following the last /
                   8242: #  NOTE:
                   8243: #    Another realization of this is simply:
                   8244: #    use File::Basename;
                   8245: #    ...
                   8246: #    $uri = shift;
                   8247: #    $filename = basename($uri);
                   8248: #    $path     = dirname($uri);
                   8249: #    return ($filename, $path);
                   8250: #
                   8251: #     The implementation below is probably faster however.
                   8252: #
1.710     albertel 8253: sub split_uri_for_cond {
                   8254:     my $uri=&deversion(&declutter(shift));
                   8255:     my @uriparts=split(/\//,$uri);
                   8256:     my $filename=pop(@uriparts);
                   8257:     my $pathname=join('/',@uriparts);
                   8258:     return ($pathname,$filename);
                   8259: }
1.232     www      8260: # --------------------------------------------------- Is a resource on the map?
                   8261: 
                   8262: sub is_on_map {
1.710     albertel 8263:     my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289     bowersj2 8264:     #Trying to find the conditional for the file
1.620     albertel 8265:     my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289     bowersj2 8266: 	       /\&\Q$filename\E\:([\d\|]+)\&/);
1.232     www      8267:     if ($match) {
1.289     bowersj2 8268: 	return (1,$1);
                   8269:     } else {
1.434     www      8270: 	return (0,0);
1.289     bowersj2 8271:     }
1.12      www      8272: }
                   8273: 
1.427     www      8274: # --------------------------------------------------------- Get symb from alias
                   8275: 
                   8276: sub get_symb_from_alias {
                   8277:     my $symb=shift;
                   8278:     my ($map,$resid,$url)=&decode_symb($symb);
                   8279: # Already is a symb
                   8280:     if ($url) { return $symb; }
                   8281: # Must be an alias
                   8282:     my $aliassymb='';
                   8283:     my %bighash;
1.620     albertel 8284:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427     www      8285:                             &GDBM_READER(),0640)) {
                   8286:         my $rid=$bighash{'mapalias_'.$symb};
                   8287: 	if ($rid) {
                   8288: 	    my ($mapid,$resid)=split(/\./,$rid);
1.429     albertel 8289: 	    $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
                   8290: 				    $resid,$bighash{'src_'.$rid});
1.427     www      8291: 	}
                   8292:         untie %bighash;
                   8293:     }
                   8294:     return $aliassymb;
                   8295: }
                   8296: 
1.12      www      8297: # ----------------------------------------------------------------- Define Role
                   8298: 
                   8299: sub definerole {
                   8300:   if (allowed('mcr','/')) {
1.1326    raeburn  8301:     my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800     albertel 8302:     foreach my $role (split(':',$sysrole)) {
                   8303: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 8304:         if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
                   8305:         if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
                   8306: 	    if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      8307:                return "refused:s:$crole&$cqual"; 
                   8308:             }
                   8309:         }
1.191     harris41 8310:     }
1.800     albertel 8311:     foreach my $role (split(':',$domrole)) {
                   8312: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 8313:         if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
                   8314:         if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
                   8315: 	    if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 
1.21      www      8316:                return "refused:d:$crole&$cqual"; 
                   8317:             }
                   8318:         }
1.191     harris41 8319:     }
1.800     albertel 8320:     foreach my $role (split(':',$courole)) {
                   8321: 	my ($crole,$cqual)=split(/\&/,$role);
1.479     albertel 8322:         if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
                   8323:         if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
                   8324: 	    if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 
1.21      www      8325:                return "refused:c:$crole&$cqual"; 
                   8326:             }
                   8327:         }
1.191     harris41 8328:     }
1.1326    raeburn  8329:     my $uhome;
                   8330:     if (($uname ne '') && ($udom ne '')) {
                   8331:         $uhome = &homeserver($uname,$udom);
                   8332:         return $uhome if ($uhome eq 'no_host');
                   8333:     } else {
                   8334:         $uname = $env{'user.name'};
                   8335:         $udom = $env{'user.domain'};
                   8336:         $uhome = $env{'user.home'};
                   8337:     }
1.620     albertel 8338:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326    raeburn  8339:                 "$udom:$uname:rolesdef_$rolename=".
1.21      www      8340:                 escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326    raeburn  8341:     return reply($command,$uhome);
1.12      www      8342:   } else {
                   8343:     return 'refused';
                   8344:   }
1.105     harris41 8345: }
                   8346: 
                   8347: # ---------------- Make a metadata query against the network of library servers
                   8348: 
                   8349: sub metadata_query {
1.1237    raeburn  8350:     my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120     harris41 8351:     my %rhash;
1.845     albertel 8352:     my %libserv = &all_library();
1.244     matthew  8353:     my @server_list = (defined($server_array) ? @$server_array
                   8354:                                               : keys(%libserv) );
                   8355:     for my $server (@server_list) {
1.1237    raeburn  8356:         my $domains = ''; 
                   8357:         if (ref($domains_hash) eq 'HASH') {
                   8358:             $domains = $domains_hash->{$server}; 
                   8359:         }
1.118     harris41 8360: 	unless ($custom or $customshow) {
1.1237    raeburn  8361: 	    my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118     harris41 8362: 	    $rhash{$server}=$reply;
                   8363: 	}
                   8364: 	else {
                   8365: 	    my $reply=&reply("querysend:".&escape($query).':'.
1.1237    raeburn  8366: 			     &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118     harris41 8367: 			     $server);
                   8368: 	    $rhash{$server}=$reply;
                   8369: 	}
1.112     harris41 8370:     }
1.118     harris41 8371:     return \%rhash;
1.240     www      8372: }
                   8373: 
                   8374: # ----------------------------------------- Send log queries and wait for reply
                   8375: 
                   8376: sub log_query {
                   8377:     my ($uname,$udom,$query,%filters)=@_;
                   8378:     my $uhome=&homeserver($uname,$udom);
                   8379:     if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838     albertel 8380:     my $uhost=&hostname($uhome);
1.800     albertel 8381:     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240     www      8382:     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
                   8383:                        $uhome);
1.479     albertel 8384:     unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242     www      8385:     return get_query_reply($queryid);
                   8386: }
                   8387: 
1.818     raeburn  8388: # -------------------------- Update MySQL table for portfolio file
                   8389: 
                   8390: sub update_portfolio_table {
1.821     raeburn  8391:     my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970     raeburn  8392:     if ($group ne '') {
                   8393:         $file_name =~s /^\Q$group\E//;
                   8394:     }
1.818     raeburn  8395:     my $homeserver = &homeserver($uname,$udom);
                   8396:     my $queryid=
1.821     raeburn  8397:         &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
                   8398:                ':'.&escape($file_name).':'.$action,$homeserver);
1.818     raeburn  8399:     my $reply = &get_query_reply($queryid);
                   8400:     return $reply;
                   8401: }
                   8402: 
1.899     raeburn  8403: # -------------------------- Update MySQL allusers table
                   8404: 
                   8405: sub update_allusers_table {
                   8406:     my ($uname,$udom,$names) = @_;
                   8407:     my $homeserver = &homeserver($uname,$udom);
                   8408:     my $queryid=
                   8409:         &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
                   8410:                'lastname='.&escape($names->{'lastname'}).'%%'.
                   8411:                'firstname='.&escape($names->{'firstname'}).'%%'.
                   8412:                'middlename='.&escape($names->{'middlename'}).'%%'.
                   8413:                'generation='.&escape($names->{'generation'}).'%%'.
                   8414:                'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
                   8415:                'id='.&escape($names->{'id'}),$homeserver);
1.1075    raeburn  8416:     return;
1.899     raeburn  8417: }
                   8418: 
1.508     raeburn  8419: # ------- Request retrieval of institutional classlists for course(s)
1.506     raeburn  8420: 
                   8421: sub fetch_enrollment_query {
1.511     raeburn  8422:     my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317    raeburn  8423:     my ($homeserver,$sleep,$loopmax);
1.547     raeburn  8424:     my $maxtries = 1;
1.508     raeburn  8425:     if ($context eq 'automated') {
                   8426:         $homeserver = $perlvar{'lonHostID'};
1.1317    raeburn  8427:         $sleep = 2;
                   8428:         $loopmax = 100;
1.547     raeburn  8429:         $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508     raeburn  8430:     } else {
                   8431:         $homeserver = &homeserver($cnum,$dom);
                   8432:     }
1.838     albertel 8433:     my $host=&hostname($homeserver);
1.506     raeburn  8434:     my $cmd = '';
1.1000    raeburn  8435:     foreach my $affiliate (keys(%{$affiliatesref})) {
1.800     albertel 8436:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506     raeburn  8437:     }
                   8438:     $cmd =~ s/%%$//;
                   8439:     $cmd = &escape($cmd);
                   8440:     my $query = 'fetchenrollment';
1.620     albertel 8441:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526     raeburn  8442:     unless ($queryid=~/^\Q$host\E\_/) { 
                   8443:         &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 
                   8444:         return 'error: '.$queryid;
                   8445:     }
1.1317    raeburn  8446:     my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547     raeburn  8447:     my $tries = 1;
                   8448:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317    raeburn  8449:         $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547     raeburn  8450:         $tries ++;
                   8451:     }
1.526     raeburn  8452:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620     albertel 8453:         &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526     raeburn  8454:     } else {
1.901     albertel 8455:         my @responses = split(/:/,$reply);
1.1322    raeburn  8456:         if (grep { $_ eq $homeserver } &current_machine_ids()) {
1.800     albertel 8457:             foreach my $line (@responses) {
                   8458:                 my ($key,$value) = split(/=/,$line,2);
1.515     raeburn  8459:                 $$replyref{$key} = $value;
                   8460:             }
                   8461:         } else {
1.1117    foxr     8462:             my $pathname = LONCAPA::tempdir();
1.800     albertel 8463:             foreach my $line (@responses) {
                   8464:                 my ($key,$value) = split(/=/,$line);
1.506     raeburn  8465:                 $$replyref{$key} = $value;
                   8466:                 if ($value > 0) {
1.800     albertel 8467:                     foreach my $item (@{$$affiliatesref{$key}}) {
                   8468:                         my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506     raeburn  8469:                         my $destname = $pathname.'/'.$filename;
                   8470:                         my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526     raeburn  8471:                         if ($xml_classlist =~ /^error/) {
                   8472:                             &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
                   8473:                         } else {
1.1359    raeburn  8474:                             if ( open(FILE,">",$destname) ) {
1.506     raeburn  8475:                                 print FILE &unescape($xml_classlist);
                   8476:                                 close(FILE);
1.526     raeburn  8477:                             } else {
                   8478:                                 &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506     raeburn  8479:                             }
                   8480:                         }
                   8481:                     }
                   8482:                 }
                   8483:             }
                   8484:         }
                   8485:         return 'ok';
                   8486:     }
                   8487:     return 'error';
                   8488: }
                   8489: 
1.242     www      8490: sub get_query_reply {
1.1317    raeburn  8491:     my ($queryid,$sleep,$loopmax) = @_;;
                   8492:     if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
                   8493:         $sleep = 0.2;
                   8494:     }
                   8495:     if (($loopmax eq '') || ($loopmax =~ /\D/)) {
                   8496:         $loopmax = 100;
                   8497:     }
1.1117    foxr     8498:     my $replyfile=LONCAPA::tempdir().$queryid;
1.240     www      8499:     my $reply='';
1.1317    raeburn  8500:     for (1..$loopmax) {
                   8501: 	sleep($sleep);
1.240     www      8502:         if (-e $replyfile.'.end') {
1.1359    raeburn  8503: 	    if (open(my $fh,"<",$replyfile)) {
1.904     albertel 8504: 		$reply = join('',<$fh>);
                   8505: 		close($fh);
1.240     www      8506: 	   } else { return 'error: reply_file_error'; }
1.242     www      8507:            return &unescape($reply);
                   8508: 	}
1.240     www      8509:     }
1.242     www      8510:     return 'timeout:'.$queryid;
1.240     www      8511: }
                   8512: 
                   8513: sub courselog_query {
1.241     www      8514: #
                   8515: # possible filters:
                   8516: # url: url or symb
                   8517: # username
                   8518: # domain
                   8519: # action: view, submit, grade
                   8520: # start: timestamp
                   8521: # end: timestamp
                   8522: #
1.240     www      8523:     my (%filters)=@_;
1.620     albertel 8524:     unless ($env{'request.course.id'}) { return 'no_course'; }
1.241     www      8525:     if ($filters{'url'}) {
                   8526: 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
                   8527:         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
                   8528:         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
                   8529:     }
1.620     albertel 8530:     my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
                   8531:     my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240     www      8532:     return &log_query($cname,$cdom,'courselog',%filters);
                   8533: }
                   8534: 
                   8535: sub userlog_query {
1.858     raeburn  8536: #
                   8537: # possible filters:
                   8538: # action: log check role
                   8539: # start: timestamp
                   8540: # end: timestamp
                   8541: #
1.240     www      8542:     my ($uname,$udom,%filters)=@_;
                   8543:     return &log_query($uname,$udom,'userlog',%filters);
1.12      www      8544: }
                   8545: 
1.506     raeburn  8546: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 
                   8547: 
                   8548: sub auto_run {
1.508     raeburn  8549:     my ($cnum,$cdom) = @_;
1.876     raeburn  8550:     my $response = 0;
                   8551:     my $settings;
                   8552:     my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
                   8553:     if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   8554:         $settings = $domconfig{'autoenroll'};
                   8555:         if ($settings->{'run'} eq '1') {
                   8556:             $response = 1;
                   8557:         }
                   8558:     } else {
1.934     raeburn  8559:         my $homeserver;
                   8560:         if (&is_course($cdom,$cnum)) {
                   8561:             $homeserver = &homeserver($cnum,$cdom);
                   8562:         } else {
                   8563:             $homeserver = &domain($cdom,'primary');
                   8564:         }
                   8565:         if ($homeserver ne 'no_host') {
                   8566:             $response = &reply('autorun:'.$cdom,$homeserver);
                   8567:         }
1.876     raeburn  8568:     }
1.506     raeburn  8569:     return $response;
                   8570: }
1.776     albertel 8571: 
1.506     raeburn  8572: sub auto_get_sections {
1.508     raeburn  8573:     my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007    raeburn  8574:     my $homeserver;
                   8575:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 
                   8576:         $homeserver = &homeserver($cnum,$cdom);
                   8577:     }
                   8578:     if (!defined($homeserver)) { 
                   8579:         if ($cdom =~ /^$match_domain$/) {
                   8580:             $homeserver = &domain($cdom,'primary');
                   8581:         }
                   8582:     }
                   8583:     my @secs;
                   8584:     if (defined($homeserver)) {
                   8585:         my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
                   8586:         unless ($response eq 'refused') {
                   8587:             @secs = split(/:/,$response);
                   8588:         }
1.506     raeburn  8589:     }
                   8590:     return @secs;
                   8591: }
1.776     albertel 8592: 
1.506     raeburn  8593: sub auto_new_course {
1.1099    raeburn  8594:     my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508     raeburn  8595:     my $homeserver = &homeserver($cnum,$cdom);
1.1099    raeburn  8596:     my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506     raeburn  8597:     return $response;
                   8598: }
1.776     albertel 8599: 
1.506     raeburn  8600: sub auto_validate_courseID {
1.508     raeburn  8601:     my ($cnum,$cdom,$inst_course_id) = @_;
                   8602:     my $homeserver = &homeserver($cnum,$cdom);
1.511     raeburn  8603:     my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506     raeburn  8604:     return $response;
                   8605: }
1.776     albertel 8606: 
1.1007    raeburn  8607: sub auto_validate_instcode {
1.1020    raeburn  8608:     my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007    raeburn  8609:     my ($homeserver,$response);
                   8610:     if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   8611:         $homeserver = &homeserver($cnum,$cdom);
                   8612:     }
                   8613:     if (!defined($homeserver)) {
                   8614:         if ($cdom =~ /^$match_domain$/) {
                   8615:             $homeserver = &domain($cdom,'primary');
                   8616:         }
                   8617:     }
1.1065    raeburn  8618:     $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
                   8619:                         &escape($instcode).':'.&escape($owner),$homeserver));
1.1216    raeburn  8620:     my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
                   8621:     return ($outcome,$description,$defaultcredits);
1.1007    raeburn  8622: }
                   8623: 
1.506     raeburn  8624: sub auto_create_password {
1.873     raeburn  8625:     my ($cnum,$cdom,$authparam,$udom) = @_;
                   8626:     my ($homeserver,$response);
1.506     raeburn  8627:     my $create_passwd = 0;
                   8628:     my $authchk = '';
1.873     raeburn  8629:     if ($udom =~ /^$match_domain$/) {
                   8630:         $homeserver = &domain($udom,'primary');
                   8631:     }
                   8632:     if ($homeserver eq '') {
                   8633:         if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
                   8634:             $homeserver = &homeserver($cnum,$cdom);
                   8635:         }
                   8636:     }
                   8637:     if ($homeserver eq '') {
                   8638:         $authchk = 'nodomain';
1.506     raeburn  8639:     } else {
1.873     raeburn  8640:         $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
                   8641:         if ($response eq 'refused') {
                   8642:             $authchk = 'refused';
                   8643:         } else {
1.901     albertel 8644:             ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873     raeburn  8645:         }
1.506     raeburn  8646:     }
                   8647:     return ($authparam,$create_passwd,$authchk);
                   8648: }
                   8649: 
1.706     raeburn  8650: sub auto_photo_permission {
                   8651:     my ($cnum,$cdom,$students) = @_;
                   8652:     my $homeserver = &homeserver($cnum,$cdom);
1.707     albertel 8653:     my ($outcome,$perm_reqd,$conditions) = 
                   8654: 	split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709     albertel 8655:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   8656: 	return (undef,undef);
                   8657:     }
1.706     raeburn  8658:     return ($outcome,$perm_reqd,$conditions);
                   8659: }
                   8660: 
                   8661: sub auto_checkphotos {
                   8662:     my ($uname,$udom,$pid) = @_;
                   8663:     my $homeserver = &homeserver($uname,$udom);
                   8664:     my ($result,$resulttype);
                   8665:     my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707     albertel 8666: 				   &escape($uname).':'.&escape($pid),
                   8667: 				   $homeserver));
1.709     albertel 8668:     if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   8669: 	return (undef,undef);
                   8670:     }
1.706     raeburn  8671:     if ($outcome) {
                   8672:         ($result,$resulttype) = split(/:/,$outcome);
                   8673:     } 
                   8674:     return ($result,$resulttype);
                   8675: }
                   8676: 
                   8677: sub auto_photochoice {
                   8678:     my ($cnum,$cdom) = @_;
                   8679:     my $homeserver = &homeserver($cnum,$cdom);
                   8680:     my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707     albertel 8681: 						       &escape($cdom),
                   8682: 						       $homeserver)));
1.709     albertel 8683:     if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
                   8684: 	return (undef,undef);
                   8685:     }
1.706     raeburn  8686:     return ($update,$comment);
                   8687: }
                   8688: 
                   8689: sub auto_photoupdate {
                   8690:     my ($affiliatesref,$dom,$cnum,$photo) = @_;
                   8691:     my $homeserver = &homeserver($cnum,$dom);
1.838     albertel 8692:     my $host=&hostname($homeserver);
1.706     raeburn  8693:     my $cmd = '';
                   8694:     my $maxtries = 1;
1.800     albertel 8695:     foreach my $affiliate (keys(%{$affiliatesref})) {
                   8696:         $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706     raeburn  8697:     }
                   8698:     $cmd =~ s/%%$//;
                   8699:     $cmd = &escape($cmd);
                   8700:     my $query = 'institutionalphotos';
                   8701:     my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
                   8702:     unless ($queryid=~/^\Q$host\E\_/) {
                   8703:         &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
                   8704:         return 'error: '.$queryid;
                   8705:     }
                   8706:     my $reply = &get_query_reply($queryid);
                   8707:     my $tries = 1;
                   8708:     while (($reply=~/^timeout/) && ($tries < $maxtries)) {
                   8709:         $reply = &get_query_reply($queryid);
                   8710:         $tries ++;
                   8711:     }
                   8712:     if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
                   8713:         &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
                   8714:     } else {
                   8715:         my @responses = split(/:/,$reply);
                   8716:         my $outcome = shift(@responses); 
                   8717:         foreach my $item (@responses) {
                   8718:             my ($key,$value) = split(/=/,$item);
                   8719:             $$photo{$key} = $value;
                   8720:         }
                   8721:         return $outcome;
                   8722:     }
                   8723:     return 'error';
                   8724: }
                   8725: 
1.521     raeburn  8726: sub auto_instcode_format {
1.793     albertel 8727:     my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
                   8728: 	$cat_order) = @_;
1.521     raeburn  8729:     my $courses = '';
1.772     raeburn  8730:     my @homeservers;
1.521     raeburn  8731:     if ($caller eq 'global') {
1.841     albertel 8732: 	my %servers = &get_servers($codedom,'library');
                   8733: 	foreach my $tryserver (keys(%servers)) {
                   8734: 	    if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   8735: 		push(@homeservers,$tryserver);
                   8736: 	    }
1.584     raeburn  8737:         }
1.1022    raeburn  8738:     } elsif ($caller eq 'requests') {
                   8739:         if ($codedom =~ /^$match_domain$/) {
                   8740:             my $chome = &domain($codedom,'primary');
                   8741:             unless ($chome eq 'no_host') {
                   8742:                 push(@homeservers,$chome);
                   8743:             }
                   8744:         }
1.521     raeburn  8745:     } else {
1.772     raeburn  8746:         push(@homeservers,&homeserver($caller,$codedom));
1.521     raeburn  8747:     }
1.793     albertel 8748:     foreach my $code (keys(%{$instcodes})) {
                   8749:         $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521     raeburn  8750:     }
                   8751:     chop($courses);
1.772     raeburn  8752:     my $ok_response = 0;
                   8753:     my $response;
                   8754:     while (@homeservers > 0 && $ok_response == 0) {
                   8755:         my $server = shift(@homeservers); 
                   8756:         $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
                   8757:         if ($response !~ /(con_lost|error|no_such_host|refused)/) {
                   8758:             my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 
1.901     albertel 8759: 		split(/:/,$response);
1.772     raeburn  8760:             %{$codes} = (%{$codes},&str2hash($codes_str));
                   8761:             push(@{$codetitles},&str2array($codetitles_str));
                   8762:             %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
                   8763:             %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
                   8764:             $ok_response = 1;
                   8765:         }
                   8766:     }
                   8767:     if ($ok_response) {
1.521     raeburn  8768:         return 'ok';
1.772     raeburn  8769:     } else {
                   8770:         return $response;
1.521     raeburn  8771:     }
                   8772: }
                   8773: 
1.792     raeburn  8774: sub auto_instcode_defaults {
                   8775:     my ($domain,$returnhash,$code_order) = @_;
                   8776:     my @homeservers;
1.841     albertel 8777: 
                   8778:     my %servers = &get_servers($domain,'library');
                   8779:     foreach my $tryserver (keys(%servers)) {
                   8780: 	if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   8781: 	    push(@homeservers,$tryserver);
                   8782: 	}
1.792     raeburn  8783:     }
1.841     albertel 8784: 
1.792     raeburn  8785:     my $response;
1.841     albertel 8786:     foreach my $server (@homeservers) {
1.792     raeburn  8787:         $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841     albertel 8788:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
                   8789: 	
                   8790: 	foreach my $pair (split(/\&/,$response)) {
                   8791: 	    my ($name,$value)=split(/\=/,$pair);
                   8792: 	    if ($name eq 'code_order') {
                   8793: 		@{$code_order} = split(/\&/,&unescape($value));
                   8794: 	    } else {
                   8795: 		$returnhash->{&unescape($name)}=&unescape($value);
                   8796: 	    }
                   8797: 	}
                   8798: 	return 'ok';
1.792     raeburn  8799:     }
1.841     albertel 8800: 
                   8801:     return $response;
1.1003    raeburn  8802: }
                   8803: 
                   8804: sub auto_possible_instcodes {
1.1007    raeburn  8805:     my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
                   8806:     unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 
                   8807:             (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
                   8808:         return;
                   8809:     }
1.1003    raeburn  8810:     my (@homeservers,$uhome);
                   8811:     if (defined(&domain($domain,'primary'))) {
                   8812:         $uhome=&domain($domain,'primary');
                   8813:         push(@homeservers,&domain($domain,'primary'));
                   8814:     } else {
                   8815:         my %servers = &get_servers($domain,'library');
                   8816:         foreach my $tryserver (keys(%servers)) {
                   8817:             if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
                   8818:                 push(@homeservers,$tryserver);
                   8819:             }
                   8820:         }
                   8821:     }
                   8822:     my $response;
                   8823:     foreach my $server (@homeservers) {
                   8824:         $response=&reply('autopossibleinstcodes:'.$domain,$server);
                   8825:         next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007    raeburn  8826:         my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 
                   8827:             split(':',$response);
                   8828:         @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
                   8829:         @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003    raeburn  8830:         foreach my $item (split('&',$cat_title)) {   
1.1005    raeburn  8831:             my ($name,$value)=split('=',$item);
                   8832:             $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  8833:         }
                   8834:         foreach my $item (split('&',$cat_order)) {
1.1005    raeburn  8835:             my ($name,$value)=split('=',$item);
                   8836:             $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003    raeburn  8837:         }
                   8838:         return 'ok';
                   8839:     }
                   8840:     return $response;
                   8841: }
1.792     raeburn  8842: 
1.1010    raeburn  8843: sub auto_courserequest_checks {
                   8844:     my ($dom) = @_;
1.1020    raeburn  8845:     my ($homeserver,%validations);
                   8846:     if ($dom =~ /^$match_domain$/) {
                   8847:         $homeserver = &domain($dom,'primary');
                   8848:     }
                   8849:     unless ($homeserver eq 'no_host') {
                   8850:         my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
                   8851:         unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
                   8852:             my @items = split(/&/,$response);
                   8853:             foreach my $item (@items) {
                   8854:                 my ($key,$value) = split('=',$item);
                   8855:                 $validations{&unescape($key)} = &thaw_unescape($value);
                   8856:             }
                   8857:         }
                   8858:     }
1.1010    raeburn  8859:     return %validations; 
                   8860: }
                   8861: 
1.1020    raeburn  8862: sub auto_courserequest_validation {
1.1255    raeburn  8863:     my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020    raeburn  8864:     my ($homeserver,$response);
                   8865:     if ($dom =~ /^$match_domain$/) {
                   8866:         $homeserver = &domain($dom,'primary');
                   8867:     }
1.1255    raeburn  8868:     unless ($homeserver eq 'no_host') {
                   8869:         my $customdata;
                   8870:         if (ref($custominfo) eq 'HASH') {
                   8871:             $customdata = &freeze_escape($custominfo);
                   8872:         }
1.1020    raeburn  8873:         $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021    raeburn  8874:                                     ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255    raeburn  8875:                                     ':'.&escape($instcode).':'.&escape($instseclist).':'.
                   8876:                                     $customdata,$homeserver));
1.1020    raeburn  8877:     }
                   8878:     return $response;
                   8879: }
                   8880: 
1.777     albertel 8881: sub auto_validate_class_sec {
1.918     raeburn  8882:     my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773     raeburn  8883:     my $homeserver = &homeserver($cnum,$cdom);
1.918     raeburn  8884:     my $ownerlist;
                   8885:     if (ref($owners) eq 'ARRAY') {
                   8886:         $ownerlist = join(',',@{$owners});
                   8887:     } else {
                   8888:         $ownerlist = $owners;
                   8889:     }
1.773     raeburn  8890:     my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918     raeburn  8891:                         &escape($ownerlist).':'.$cdom,$homeserver);
1.773     raeburn  8892:     return $response;
                   8893: }
                   8894: 
1.1367  ! raeburn  8895: sub auto_validate_instclasses {
        !          8896:     my ($cdom,$cnum,$owners,$classesref) = @_;
        !          8897:     my ($homeserver,%validations);
        !          8898:     $homeserver = &homeserver($cnum,$cdom);
        !          8899:     unless ($homeserver eq 'no_host') {
        !          8900:         my $ownerlist;
        !          8901:         if (ref($owners) eq 'ARRAY') {
        !          8902:             $ownerlist = join(',',@{$owners});
        !          8903:         } else {
        !          8904:             $ownerlist = $owners;
        !          8905:         }
        !          8906:         if (ref($classesref) eq 'HASH') {
        !          8907:             my $classes = &freeze_escape($classesref);
        !          8908:             my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
        !          8909:                                 ':'.$cdom.':'.$classes,$homeserver);
        !          8910:             unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
        !          8911:                 my @items = split(/&/,$response);
        !          8912:                 foreach my $item (@items) {
        !          8913:                     my ($key,$value) = split('=',$item);
        !          8914:                     $validations{&unescape($key)} = &thaw_unescape($value);
        !          8915:                 }
        !          8916:             }
        !          8917:         }
        !          8918:     }
        !          8919:     return %validations;
        !          8920: }
        !          8921: 
1.1248    raeburn  8922: sub auto_crsreq_update {
                   8923:     my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257    raeburn  8924:         $code,$accessstart,$accessend,$inbound) = @_;
1.1248    raeburn  8925:     my ($homeserver,%crsreqresponse);
                   8926:     if ($cdom =~ /^$match_domain$/) {
                   8927:         $homeserver = &domain($cdom,'primary');
                   8928:     }
                   8929:     unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
                   8930:         my $info;
                   8931:         if (ref($inbound) eq 'HASH') {
                   8932:             $info = &freeze_escape($inbound);
                   8933:         }
                   8934:         my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
                   8935:                             ':'.&escape($action).':'.&escape($ownername).':'.
                   8936:                             &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257    raeburn  8937:                             &escape($title).':'.&escape($code).':'.
                   8938:                             &escape($accessstart).':'.&escape($accessend).':'.$info,
                   8939:                             $homeserver);
1.1248    raeburn  8940:         unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
                   8941:             my @items = split(/&/,$response);
                   8942:             foreach my $item (@items) {
                   8943:                 my ($key,$value) = split('=',$item);
                   8944:                 $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
                   8945:             }
                   8946:         }
                   8947:     }
                   8948:     return \%crsreqresponse;
                   8949: }
                   8950: 
1.1305    raeburn  8951: sub auto_export_grades {
1.1309    raeburn  8952:     my ($cdom,$cnum,$inforef,$gradesref) = @_;
                   8953:     my ($homeserver,%exportresponse);
                   8954:     if ($cdom =~ /^$match_domain$/) {
                   8955:         $homeserver = &domain($cdom,'primary');
                   8956:     }
                   8957:     unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
                   8958:         my $info;
                   8959:         if (ref($inforef) eq 'HASH') {
                   8960:             $info = &freeze_escape($inforef);
                   8961:         }
                   8962:         if (ref($gradesref) eq 'HASH') {
                   8963:             my $grades = &freeze_escape($gradesref);
                   8964:             my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
                   8965:                                 $info.':'.$grades,$homeserver);
                   8966:             unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
                   8967:                 my @items = split(/&/,$response);
                   8968:                 foreach my $item (@items) {
                   8969:                     my ($key,$value) = split('=',$item);
                   8970:                     $exportresponse{&unescape($key)} = &thaw_unescape($value);
                   8971:                 }
                   8972:             }
                   8973:         }
                   8974:     }
                   8975:     return \%exportresponse;
1.1305    raeburn  8976: }
                   8977: 
1.1287    raeburn  8978: sub check_instcode_cloning {
                   8979:     my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
                   8980:     unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
                   8981:         return;
                   8982:     }
                   8983:     my $canclone;
                   8984:     if (@{$code_order} > 0) {
                   8985:         my $instcoderegexp ='^';
                   8986:         my @clonecodes = split(/\&/,$cloner);
                   8987:         foreach my $item (@{$code_order}) {
                   8988:             if (grep(/^\Q$item\E=/,@clonecodes)) {
                   8989:                 foreach my $pair (@clonecodes) {
                   8990:                     my ($key,$val) = split(/\=/,$pair,2);
                   8991:                     $val = &unescape($val);
                   8992:                     if ($key eq $item) {
                   8993:                         $instcoderegexp .= '('.$val.')';
                   8994:                         last;
                   8995:                     }
                   8996:                 }
                   8997:             } else {
                   8998:                 $instcoderegexp .= $codedefaults->{$item};
                   8999:             }
                   9000:         }
                   9001:         $instcoderegexp .= '$';
                   9002:         my (@from,@to);
                   9003:         eval {
                   9004:                (@from) = ($clonefromcode =~ /$instcoderegexp/);
                   9005:                (@to) = ($clonetocode =~ /$instcoderegexp/);
                   9006:         };
                   9007:         if ((@from > 0) && (@to > 0)) {
                   9008:             my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
                   9009:             if (!@diffs) {
                   9010:                 $canclone = 1;
                   9011:             }
                   9012:         }
                   9013:     }
                   9014:     return $canclone;
                   9015: }
                   9016: 
                   9017: sub default_instcode_cloning {
                   9018:     my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
                   9019:     my (%codedefaults,@code_order,$canclone);
                   9020:     if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
                   9021:         %codedefaults = %{$codedefaultsref};
                   9022:         @code_order = @{$codeorderref};
                   9023:     } elsif ($clonedom) {
                   9024:         &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
                   9025:     }
                   9026:     if (($domdefclone) && (@code_order)) {
                   9027:         my @clonecodes = split(/\+/,$domdefclone);
                   9028:         my $instcoderegexp ='^';
                   9029:         foreach my $item (@code_order) {
                   9030:             if (grep(/^\Q$item\E$/,@clonecodes)) {
                   9031:                 $instcoderegexp .= '('.$codedefaults{$item}.')';
                   9032:             } else {
                   9033:                 $instcoderegexp .= $codedefaults{$item};
                   9034:             }
                   9035:         }
                   9036:         $instcoderegexp .= '$';
                   9037:         my (@from,@to);
                   9038:         eval {
                   9039:             (@from) = ($clonefromcode =~ /$instcoderegexp/);
                   9040:             (@to) = ($clonetocode =~ /$instcoderegexp/);
                   9041:         };
                   9042:         if ((@from > 0) && (@to > 0)) {
                   9043:             my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
                   9044:             if (!@diffs) {
                   9045:                 $canclone = 1;
                   9046:             }
                   9047:         }
                   9048:     }
                   9049:     return $canclone;
                   9050: }
                   9051: 
1.679     raeburn  9052: # ------------------------------------------------------- Course Group routines
                   9053: 
                   9054: sub get_coursegroups {
1.809     raeburn  9055:     my ($cdom,$cnum,$group,$namespace) = @_;
                   9056:     return(&dump($namespace,$cdom,$cnum,$group));
1.805     raeburn  9057: }
                   9058: 
1.679     raeburn  9059: sub modify_coursegroup {
                   9060:     my ($cdom,$cnum,$groupsettings) = @_;
                   9061:     return(&put('coursegroups',$groupsettings,$cdom,$cnum));
                   9062: }
                   9063: 
1.809     raeburn  9064: sub toggle_coursegroup_status {
                   9065:     my ($cdom,$cnum,$group,$action) = @_;
                   9066:     my ($from_namespace,$to_namespace);
                   9067:     if ($action eq 'delete') {
                   9068:         $from_namespace = 'coursegroups';
                   9069:         $to_namespace = 'deleted_groups';
                   9070:     } else {
                   9071:         $from_namespace = 'deleted_groups';
                   9072:         $to_namespace = 'coursegroups';
                   9073:     }
                   9074:     my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805     raeburn  9075:     if (my $tmp = &error(%curr_group)) {
                   9076:         &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
                   9077:         return ('read error',$tmp);
                   9078:     } else {
                   9079:         my %savedsettings = %curr_group; 
1.809     raeburn  9080:         my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805     raeburn  9081:         my $deloutcome;
                   9082:         if ($result eq 'ok') {
1.809     raeburn  9083:             $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805     raeburn  9084:         } else {
                   9085:             return ('write error',$result);
                   9086:         }
                   9087:         if ($deloutcome eq 'ok') {
                   9088:             return 'ok';
                   9089:         } else {
                   9090:             return ('delete error',$deloutcome);
                   9091:         }
                   9092:     }
                   9093: }
                   9094: 
1.679     raeburn  9095: sub modify_group_roles {
1.957     raeburn  9096:     my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679     raeburn  9097:     my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
                   9098:     my $role = 'gr/'.&escape($userprivs);
                   9099:     my ($uname,$udom) = split(/:/,$user);
1.957     raeburn  9100:     my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684     raeburn  9101:     if ($result eq 'ok') {
                   9102:         &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
                   9103:     }
1.679     raeburn  9104:     return $result;
                   9105: }
                   9106: 
                   9107: sub modify_coursegroup_membership {
                   9108:     my ($cdom,$cnum,$membership) = @_;
                   9109:     my $result = &put('groupmembership',$membership,$cdom,$cnum);
                   9110:     return $result;
                   9111: }
                   9112: 
1.682     raeburn  9113: sub get_active_groups {
                   9114:     my ($udom,$uname,$cdom,$cnum) = @_;
                   9115:     my $now = time;
                   9116:     my %groups = ();
                   9117:     foreach my $key (keys(%env)) {
1.811     albertel 9118:         if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682     raeburn  9119:             my ($start,$end) = split(/\./,$env{$key});
                   9120:             if (($end!=0) && ($end<$now)) { next; }
                   9121:             if (($start!=0) && ($start>$now)) { next; }
                   9122:             if ($1 eq $cdom && $2 eq $cnum) {
                   9123:                 $groups{$3} = $env{$key} ;
                   9124:             }
                   9125:         }
                   9126:     }
                   9127:     return %groups;
                   9128: }
                   9129: 
1.683     raeburn  9130: sub get_group_membership {
                   9131:     my ($cdom,$cnum,$group) = @_;
                   9132:     return(&dump('groupmembership',$cdom,$cnum,$group));
                   9133: }
                   9134: 
                   9135: sub get_users_groups {
                   9136:     my ($udom,$uname,$courseid) = @_;
1.733     raeburn  9137:     my @usersgroups;
1.683     raeburn  9138:     my $cachetime=1800;
                   9139: 
                   9140:     my $hashid="$udom:$uname:$courseid";
1.733     raeburn  9141:     my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
                   9142:     if (defined($cached)) {
1.734     albertel 9143:         @usersgroups = split(/:/,$grouplist);
1.733     raeburn  9144:     } else {  
                   9145:         $grouplist = '';
1.816     raeburn  9146:         my $courseurl = &courseid_to_courseurl($courseid);
1.1166    raeburn  9147:         my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817     raeburn  9148:         my $access_end = $env{'course.'.$courseid.
                   9149:                               '.default_enrollment_end_date'};
                   9150:         my $now = time;
                   9151:         foreach my $key (keys(%roleshash)) {
                   9152:             if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
                   9153:                 my $group = $1;
                   9154:                 if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
                   9155:                     my $start = $2;
                   9156:                     my $end = $1;
                   9157:                     if ($start == -1) { next; } # deleted from group
                   9158:                     if (($start!=0) && ($start>$now)) { next; }
                   9159:                     if (($end!=0) && ($end<$now)) {
                   9160:                         if ($access_end && $access_end < $now) {
                   9161:                             if ($access_end - $end < 86400) {
                   9162:                                 push(@usersgroups,$group);
1.733     raeburn  9163:                             }
                   9164:                         }
1.817     raeburn  9165:                         next;
1.733     raeburn  9166:                     }
1.817     raeburn  9167:                     push(@usersgroups,$group);
1.683     raeburn  9168:                 }
                   9169:             }
                   9170:         }
1.817     raeburn  9171:         @usersgroups = &sort_course_groups($courseid,@usersgroups);
                   9172:         $grouplist = join(':',@usersgroups);
                   9173:         &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683     raeburn  9174:     }
1.733     raeburn  9175:     return @usersgroups;
1.683     raeburn  9176: }
                   9177: 
                   9178: sub devalidate_getgroups_cache {
                   9179:     my ($udom,$uname,$cdom,$cnum)=@_;
                   9180:     my $courseid = $cdom.'_'.$cnum;
1.807     albertel 9181: 
1.683     raeburn  9182:     my $hashid="$udom:$uname:$courseid";
                   9183:     &devalidate_cache_new('getgroups',$hashid);
                   9184: }
                   9185: 
1.12      www      9186: # ------------------------------------------------------------------ Plain Text
                   9187: 
                   9188: sub plaintext {
1.988     raeburn  9189:     my ($short,$type,$cid,$forcedefault) = @_;
1.1046    raeburn  9190:     if ($short =~ m{^cr/}) {
1.758     albertel 9191: 	return (split('/',$short))[-1];
                   9192:     }
1.742     raeburn  9193:     if (!defined($cid)) {
                   9194:         $cid = $env{'request.course.id'};
                   9195:     }
                   9196:     my %rolenames = (
1.1008    raeburn  9197:                       Course    => 'std',
                   9198:                       Community => 'alt1',
1.1305    raeburn  9199:                       Placement => 'std',
1.742     raeburn  9200:                     );
1.1037    raeburn  9201:     if ($cid ne '') {
                   9202:         if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
                   9203:             unless ($forcedefault) {
                   9204:                 my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 
                   9205:                 &Apache::lonlocal::mt_escape(\$roletext);
                   9206:                 return &Apache::lonlocal::mt($roletext);
                   9207:             }
                   9208:         }
                   9209:     }
                   9210:     if ((defined($type)) && (defined($rolenames{$type})) &&
                   9211:         (defined($rolenames{$type})) && 
                   9212:         (defined($prp{$short}{$rolenames{$type}}))) {
1.742     raeburn  9213:         return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037    raeburn  9214:     } elsif ($cid ne '') {
                   9215:         my $crstype = $env{'course.'.$cid.'.type'};
                   9216:         if (($crstype ne '') && (defined($rolenames{$crstype})) &&
                   9217:             (defined($prp{$short}{$rolenames{$crstype}}))) {
                   9218:             return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
                   9219:         }
1.742     raeburn  9220:     }
1.1037    raeburn  9221:     return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12      www      9222: }
                   9223: 
                   9224: # ----------------------------------------------------------------- Assign Role
                   9225: 
                   9226: sub assignrole {
1.957     raeburn  9227:     my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
                   9228:         $context)=@_;
1.21      www      9229:     my $mrole;
                   9230:     if ($role =~ /^cr\//) {
1.393     www      9231:         my $cwosec=$url;
1.811     albertel 9232:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393     www      9233: 	unless (&allowed('ccr',$cwosec)) {
1.1026    raeburn  9234:            my $refused = 1;
                   9235:            if ($context eq 'requestcourses') {
                   9236:                if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
                   9237:                    if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
                   9238:                        if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
                   9239:                            my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   9240:                            my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   9241:                            if ($crsenv{'internal.courseowner'} eq
                   9242:                                $env{'user.name'}.':'.$env{'user.domain'}) {
                   9243:                                $refused = '';
                   9244:                            }
                   9245:                        }
                   9246:                    }
                   9247:                }
                   9248:            }
                   9249:            if ($refused) {
                   9250:                &logthis('Refused custom assignrole: '.
                   9251:                         $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
                   9252:                         ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
                   9253:                return 'refused';
                   9254:            }
1.104     www      9255:         }
1.21      www      9256:         $mrole='cr';
1.678     raeburn  9257:     } elsif ($role =~ /^gr\//) {
                   9258:         my $cwogrp=$url;
1.811     albertel 9259:         $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678     raeburn  9260:         unless (&allowed('mdg',$cwogrp)) {
                   9261:             &logthis('Refused group assignrole: '.
                   9262:               $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
                   9263:                     $env{'user.name'}.' at '.$env{'user.domain'});
                   9264:             return 'refused';
                   9265:         }
                   9266:         $mrole='gr';
1.21      www      9267:     } else {
1.82      www      9268:         my $cwosec=$url;
1.811     albertel 9269:         $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932     raeburn  9270:         if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
                   9271:             my $refused;
                   9272:             if (($env{'request.course.sec'}  ne '') && ($role eq 'st')) {
                   9273:                 if (!(&allowed('c'.$role,$url))) {
                   9274:                     $refused = 1;
                   9275:                 }
                   9276:             } else {
                   9277:                 $refused = 1;
                   9278:             }
1.947     raeburn  9279:             if ($refused) {
1.1045    raeburn  9280:                 my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
                   9281:                 if (!$selfenroll && $context eq 'course') {
                   9282:                     my %crsenv;
                   9283:                     if ($role eq 'cc' || $role eq 'co') {
                   9284:                         %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   9285:                         if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
                   9286:                             if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
                   9287:                                 if ($crsenv{'internal.courseowner'} eq 
                   9288:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   9289:                                     $refused = '';
                   9290:                                 }
                   9291:                             }
                   9292:                         } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 
                   9293:                             if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
                   9294:                                 if ($crsenv{'internal.courseowner'} eq 
                   9295:                                     $env{'user.name'}.':'.$env{'user.domain'}) {
                   9296:                                     $refused = '';
                   9297:                                 }
                   9298:                             }
                   9299:                         }
                   9300:                     }
                   9301:                 } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947     raeburn  9302:                     $refused = '';
1.1017    raeburn  9303:                 } elsif ($context eq 'requestcourses') {
1.1041    raeburn  9304:                     my @possroles = ('st','ta','ep','in','cc','co');
1.1026    raeburn  9305:                     if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041    raeburn  9306:                         my $wrongcc;
                   9307:                         if ($cnum =~ /^$match_community$/) {
                   9308:                             $wrongcc = 1 if ($role eq 'cc');
                   9309:                         } else {
                   9310:                             $wrongcc = 1 if ($role eq 'co');
                   9311:                         }
                   9312:                         unless ($wrongcc) {
                   9313:                             my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
                   9314:                             if ($crsenv{'internal.courseowner'} eq 
                   9315:                                  $env{'user.name'}.':'.$env{'user.domain'}) {
                   9316:                                 $refused = '';
                   9317:                             }
1.1017    raeburn  9318:                         }
                   9319:                     }
1.1183    raeburn  9320:                 } elsif ($context eq 'requestauthor') {
                   9321:                     if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) && 
                   9322:                         ($url eq '/'.$udom.'/') && ($role eq 'au')) {
                   9323:                         if ($env{'environment.requestauthor'} eq 'automatic') {
                   9324:                             $refused = '';
                   9325:                         } else {
                   9326:                             my %domdefaults = &get_domain_defaults($udom);
                   9327:                             if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
                   9328:                                 my $checkbystatus;
                   9329:                                 if ($env{'user.adv'}) { 
                   9330:                                     my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
                   9331:                                     if ($disposition eq 'automatic') {
                   9332:                                         $refused = '';
                   9333:                                     } elsif ($disposition eq '') {
                   9334:                                         $checkbystatus = 1;
                   9335:                                     } 
                   9336:                                 } else {
                   9337:                                     $checkbystatus = 1;
                   9338:                                 }
                   9339:                                 if ($checkbystatus) {
                   9340:                                     if ($env{'environment.inststatus'}) {
                   9341:                                         my @inststatuses = split(/,/,$env{'environment.inststatus'});
                   9342:                                         foreach my $type (@inststatuses) {
                   9343:                                             if (($type ne '') &&
                   9344:                                                 ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
                   9345:                                                 $refused = '';
                   9346:                                             }
                   9347:                                         }
                   9348:                                     } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
                   9349:                                         $refused = '';
                   9350:                                     }
                   9351:                                 }
                   9352:                             }
                   9353:                         }
                   9354:                     }
1.1017    raeburn  9355:                 }
                   9356:                 if ($refused) {
1.947     raeburn  9357:                     &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
                   9358:                              ' '.$role.' '.$end.' '.$start.' by '.
                   9359: 	  	             $env{'user.name'}.' at '.$env{'user.domain'});
                   9360:                     return 'refused';
                   9361:                 }
1.932     raeburn  9362:             }
1.1131    raeburn  9363:         } elsif ($role eq 'au') {
                   9364:             if ($url ne '/'.$udom.'/') {
                   9365:                 &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
                   9366:                          ' to assign author role for '.$uname.':'.$udom.
                   9367:                          ' in domain: '.$url.' refused (wrong domain).');
                   9368:                 return 'refused';
                   9369:             }
1.104     www      9370:         }
1.21      www      9371:         $mrole=$role;
                   9372:     }
1.620     albertel 9373:     my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21      www      9374:                 "$udom:$uname:$url".'_'."$mrole=$role";
1.81      www      9375:     if ($end) { $command.='_'.$end; }
1.21      www      9376:     if ($start) {
                   9377: 	if ($end) { 
1.81      www      9378:            $command.='_'.$start; 
1.21      www      9379:         } else {
1.81      www      9380:            $command.='_0_'.$start;
1.21      www      9381:         }
                   9382:     }
1.739     raeburn  9383:     my $origstart = $start;
                   9384:     my $origend = $end;
1.957     raeburn  9385:     my $delflag;
1.357     www      9386: # actually delete
                   9387:     if ($deleteflag) {
1.373     www      9388: 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357     www      9389: # modify command to delete the role
1.620     albertel 9390:            $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357     www      9391:                 "$udom:$uname:$url".'_'."$mrole";
1.620     albertel 9392: 	   &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 
1.357     www      9393: # set start and finish to negative values for userrolelog
                   9394:            $start=-1;
                   9395:            $end=-1;
1.957     raeburn  9396:            $delflag = 1;
1.357     www      9397:         }
                   9398:     }
                   9399: # send command
1.349     www      9400:     my $answer=&reply($command,&homeserver($uname,$udom));
1.357     www      9401: # log new user role if status is ok
1.349     www      9402:     if ($answer eq 'ok') {
1.663     raeburn  9403: 	&userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184    raeburn  9404:         if (($role eq 'cc') || ($role eq 'in') ||
                   9405:             ($role eq 'ep') || ($role eq 'ad') ||
                   9406:             ($role eq 'ta') || ($role eq 'st') ||
                   9407:             ($role=~/^cr/) || ($role eq 'gr') ||
                   9408:             ($role eq 'co')) {
1.1200    raeburn  9409: # for course roles, perform group memberships changes triggered by role change.
                   9410:             unless ($role =~ /^gr/) {
                   9411:                 &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
                   9412:                                                  $origstart,$selfenroll,$context);
                   9413:             }
1.1184    raeburn  9414:             &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   9415:                            $selfenroll,$context);
                   9416:         } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334    raeburn  9417:                  ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
                   9418:                  ($role eq 'da')) {
1.1184    raeburn  9419:             &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   9420:                            $context);
                   9421:         } elsif (($role eq 'ca') || ($role eq 'aa')) {
                   9422:             &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
                   9423:                              $context); 
                   9424:         }
1.1053    raeburn  9425:         if ($role eq 'cc') {
                   9426:             &autoupdate_coowners($url,$end,$start,$uname,$udom);
                   9427:         }
1.349     www      9428:     }
                   9429:     return $answer;
1.169     harris41 9430: }
                   9431: 
1.1053    raeburn  9432: sub autoupdate_coowners {
                   9433:     my ($url,$end,$start,$uname,$udom) = @_;
                   9434:     my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
                   9435:     if (($cdom ne '') && ($cnum ne '')) {
                   9436:         my $now = time;
                   9437:         my %domdesign = &Apache::loncommon::get_domainconf($cdom);
                   9438:         if ($domdesign{$cdom.'.autoassign.co-owners'}) {
                   9439:             my %coursehash = &coursedescription($cdom.'_'.$cnum);
                   9440:             my $instcode = $coursehash{'internal.coursecode'};
                   9441:             if ($instcode ne '') {
1.1056    raeburn  9442:                 if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
                   9443:                     unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053    raeburn  9444:                         my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056    raeburn  9445:                         my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
                   9446:                         if ($result eq 'valid') {
                   9447:                             if ($coursehash{'internal.co-owners'}) {
1.1053    raeburn  9448:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   9449:                                     push(@newcoowners,$coowner);
                   9450:                                 }
                   9451:                                 unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
                   9452:                                     push(@newcoowners,$uname.':'.$udom);
                   9453:                                 }
                   9454:                                 @newcoowners = sort(@newcoowners);
                   9455:                             } else {
                   9456:                                 push(@newcoowners,$uname.':'.$udom);
                   9457:                             }
                   9458:                         } else {
                   9459:                             if ($coursehash{'internal.co-owners'}) {
                   9460:                                 foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
                   9461:                                     unless ($coowner eq $uname.':'.$udom) {
                   9462:                                         push(@newcoowners,$coowner);
                   9463:                                     }
                   9464:                                 }
                   9465:                                 unless (@newcoowners > 0) {
                   9466:                                     $delcoowners = 1;
                   9467:                                     $coowners = '';
                   9468:                                 }
                   9469:                             }
                   9470:                         }
                   9471:                         if (@newcoowners || $delcoowners) {
                   9472:                             &store_coowners($cdom,$cnum,$coursehash{'home'},
                   9473:                                             $delcoowners,@newcoowners);
                   9474:                         }
                   9475:                     }
                   9476:                 }
                   9477:             }
                   9478:         }
                   9479:     }
                   9480: }
                   9481: 
                   9482: sub store_coowners {
                   9483:     my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
                   9484:     my $cid = $cdom.'_'.$cnum;
                   9485:     my ($coowners,$delresult,$putresult);
                   9486:     if (@newcoowners) {
                   9487:         $coowners = join(',',@newcoowners);
                   9488:         my %coownershash = (
                   9489:                             'internal.co-owners' => $coowners,
                   9490:                            );
                   9491:         $putresult = &put('environment',\%coownershash,$cdom,$cnum);
                   9492:         if ($putresult eq 'ok') {
                   9493:             if ($env{'course.'.$cid.'.num'} eq $cnum) {
                   9494:                 &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
                   9495:             }
                   9496:         }
                   9497:     }
                   9498:     if ($delcoowners) {
                   9499:         $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
                   9500:         if ($delresult eq 'ok') {
                   9501:             if ($env{'course.'.$cid.'.internal.co-owners'}) {
                   9502:                 &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
                   9503:             }
                   9504:         }
                   9505:     }
                   9506:     if (($putresult eq 'ok') || ($delresult eq 'ok')) {
                   9507:         my %crsinfo =
                   9508:             &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
                   9509:         if (ref($crsinfo{$cid}) eq 'HASH') {
                   9510:             $crsinfo{$cid}{'co-owners'} = \@newcoowners;
                   9511:             my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
                   9512:         }
                   9513:     }
                   9514: }
                   9515: 
1.169     harris41 9516: # -------------------------------------------------- Modify user authentication
1.197     www      9517: # Overrides without validation
                   9518: 
1.169     harris41 9519: sub modifyuserauth {
                   9520:     my ($udom,$uname,$umode,$upass)=@_;
                   9521:     my $uhome=&homeserver($uname,$udom);
1.197     www      9522:     unless (&allowed('mau',$udom)) { return 'refused'; }
                   9523:     &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620     albertel 9524:              $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   9525:              ' in domain '.$env{'request.role.domain'});  
1.169     harris41 9526:     my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
                   9527: 		     &escape($upass),$uhome);
1.620     albertel 9528:     &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197     www      9529:         'Authentication changed for '.$udom.', '.$uname.', '.$umode.
                   9530:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
                   9531:     &log($udom,,$uname,$uhome,
1.620     albertel 9532:         'Authentication changed by '.$env{'user.domain'}.', '.
                   9533:                                      $env{'user.name'}.', '.$umode.
1.197     www      9534:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169     harris41 9535:     unless ($reply eq 'ok') {
1.197     www      9536:         &logthis('Authentication mode error: '.$reply);
1.169     harris41 9537: 	return 'error: '.$reply;
                   9538:     }   
1.170     harris41 9539:     return 'ok';
1.80      www      9540: }
                   9541: 
1.81      www      9542: # --------------------------------------------------------------- Modify a user
1.80      www      9543: 
1.81      www      9544: sub modifyuser {
1.206     matthew  9545:     my ($udom,    $uname, $uid,
                   9546:         $umode,   $upass, $first,
                   9547:         $middle,  $last,  $gene,
1.1058    raeburn  9548:         $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807     albertel 9549:     $udom= &LONCAPA::clean_domain($udom);
                   9550:     $uname=&LONCAPA::clean_username($uname);
1.1059    raeburn  9551:     my $showcandelete = 'none';
                   9552:     if (ref($candelete) eq 'ARRAY') {
                   9553:         if (@{$candelete} > 0) {
                   9554:             $showcandelete = join(', ',@{$candelete});
                   9555:         }
                   9556:     }
1.81      www      9557:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80      www      9558:              $umode.', '.$first.', '.$middle.', '.
1.1059    raeburn  9559: 	     $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206     matthew  9560:              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
                   9561:                                      ' desiredhome not specified'). 
1.620     albertel 9562:              ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
                   9563:              ' in domain '.$env{'request.role.domain'});
1.230     stredwic 9564:     my $uhome=&homeserver($uname,$udom,'true');
1.1075    raeburn  9565:     my $newuser;
                   9566:     if ($uhome eq 'no_host') {
                   9567:         $newuser = 1;
                   9568:     }
1.80      www      9569: # ----------------------------------------------------------------- Create User
1.406     albertel 9570:     if (($uhome eq 'no_host') && 
                   9571: 	(($umode && $upass) || ($umode eq 'localauth'))) {
1.80      www      9572:         my $unhome='';
1.844     albertel 9573:         if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 
1.209     matthew  9574:             $unhome = $desiredhome;
1.620     albertel 9575: 	} elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
                   9576: 	    $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209     matthew  9577:         } else { # load balancing routine for determining $unhome
1.81      www      9578:             my $loadm=10000000;
1.841     albertel 9579: 	    my %servers = &get_servers($udom,'library');
                   9580: 	    foreach my $tryserver (keys(%servers)) {
                   9581: 		my $answer=reply('load',$tryserver);
                   9582: 		if (($answer=~/\d+/) && ($answer<$loadm)) {
                   9583: 		    $loadm=$answer;
                   9584: 		    $unhome=$tryserver;
                   9585: 		}
1.80      www      9586: 	    }
                   9587:         }
                   9588:         if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206     matthew  9589: 	    return 'error: unable to find a home server for '.$uname.
                   9590:                    ' in domain '.$udom;
1.80      www      9591:         }
                   9592:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
                   9593:                          &escape($upass),$unhome);
                   9594: 	unless ($reply eq 'ok') {
                   9595:             return 'error: '.$reply;
                   9596:         }   
1.230     stredwic 9597:         $uhome=&homeserver($uname,$udom,'true');
1.80      www      9598:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386     matthew  9599: 	    return 'error: unable verify users home machine.';
1.80      www      9600:         }
1.209     matthew  9601:     }   # End of creation of new user
1.80      www      9602: # ---------------------------------------------------------------------- Add ID
                   9603:     if ($uid) {
                   9604:        $uid=~tr/A-Z/a-z/;
                   9605:        my %uidhash=&idrget($udom,$uname);
1.196     www      9606:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 
                   9607:          && (!$forceid)) {
1.80      www      9608: 	  unless ($uid eq $uidhash{$uname}) {
1.386     matthew  9609: 	      return 'error: user id "'.$uid.'" does not match '.
                   9610:                   'current user id "'.$uidhash{$uname}.'".';
1.80      www      9611:           }
                   9612:        } else {
1.1300    raeburn  9613: 	  &idput($udom,{$uname => $uid},$uhome,'ids');
1.80      www      9614:        }
                   9615:     }
                   9616: # -------------------------------------------------------------- Add names, etc
1.313     matthew  9617:     my @tmp=&get('environment',
1.899     raeburn  9618: 		   ['firstname','middlename','lastname','generation','id',
1.963     raeburn  9619:                     'permanentemail','inststatus'],
1.134     albertel 9620: 		   $udom,$uname);
1.1075    raeburn  9621:     my (%names,%oldnames);
1.313     matthew  9622:     if ($tmp[0] =~ m/^error:.*/) { 
                   9623:         %names=(); 
                   9624:     } else {
                   9625:         %names = @tmp;
1.1075    raeburn  9626:         %oldnames = %names;
1.313     matthew  9627:     }
1.388     www      9628: #
1.1058    raeburn  9629: # If name, email and/or uid are blank (e.g., because an uploaded file
                   9630: # of users did not contain them), do not overwrite existing values
                   9631: # unless field is in $candelete array ref.  
                   9632: #
                   9633: 
                   9634:     my @fields = ('firstname','middlename','lastname','generation',
                   9635:                   'permanentemail','id');
                   9636:     my %newvalues;
                   9637:     if (ref($candelete) eq 'ARRAY') {
                   9638:         foreach my $field (@fields) {
                   9639:             if (grep(/^\Q$field\E$/,@{$candelete})) {
                   9640:                 if ($field eq 'firstname') {
                   9641:                     $names{$field} = $first;
                   9642:                 } elsif ($field eq 'middlename') {
                   9643:                     $names{$field} = $middle;
                   9644:                 } elsif ($field eq 'lastname') {
                   9645:                     $names{$field} = $last;
                   9646:                 } elsif ($field eq 'generation') { 
                   9647:                     $names{$field} = $gene;
                   9648:                 } elsif ($field eq 'permanentemail') {
                   9649:                     $names{$field} = $email;
                   9650:                 } elsif ($field eq 'id') {
                   9651:                     $names{$field}  = $uid;
                   9652:                 }
                   9653:             }
                   9654:         }
                   9655:     }
1.388     www      9656:     if ($first)  { $names{'firstname'}  = $first; }
1.385     matthew  9657:     if (defined($middle)) { $names{'middlename'} = $middle; }
1.388     www      9658:     if ($last)   { $names{'lastname'}   = $last; }
1.385     matthew  9659:     if (defined($gene))   { $names{'generation'} = $gene; }
1.592     www      9660:     if ($email) {
                   9661:        $email=~s/[^\w\@\.\-\,]//gs;
1.963     raeburn  9662:        if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592     www      9663:     }
1.899     raeburn  9664:     if ($uid) { $names{'id'}  = $uid; }
1.989     raeburn  9665:     if (defined($inststatus)) {
                   9666:         $names{'inststatus'} = '';
                   9667:         my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
                   9668:         if (ref($usertypes) eq 'HASH') {
                   9669:             my @okstatuses; 
                   9670:             foreach my $item (split(/:/,$inststatus)) {
                   9671:                 if (defined($usertypes->{$item})) {
                   9672:                     push(@okstatuses,$item);  
                   9673:                 }
                   9674:             }
                   9675:             if (@okstatuses) {
                   9676:                 $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
                   9677:             }
                   9678:         }
                   9679:     }
1.1075    raeburn  9680:     my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963     raeburn  9681:                  $umode.', '.$first.', '.$middle.', '.
1.1075    raeburn  9682:                  $last.', '.$gene.', '.$email.', '.$inststatus;
1.963     raeburn  9683:     if ($env{'user.name'} ne '' && $env{'user.domain'}) {
                   9684:         $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
                   9685:     } else {
                   9686:         $logmsg .= ' during self creation';
                   9687:     }
1.1075    raeburn  9688:     my $changed;
                   9689:     if ($newuser) {
                   9690:         $changed = 1;
                   9691:     } else {
                   9692:         foreach my $field (@fields) {
                   9693:             if ($names{$field} ne $oldnames{$field}) {
                   9694:                 $changed = 1;
                   9695:                 last;
                   9696:             }
                   9697:         }
                   9698:     }
                   9699:     unless ($changed) {
                   9700:         $logmsg = 'No changes in user information needed for: '.$logmsg;
                   9701:         &logthis($logmsg);
                   9702:         return 'ok';
                   9703:     }
                   9704:     my $reply = &put('environment', \%names, $udom,$uname);
                   9705:     if ($reply ne 'ok') { 
                   9706:         return 'error: '.$reply;
                   9707:     }
1.1087    raeburn  9708:     if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
                   9709:         &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
                   9710:     }
1.1075    raeburn  9711:     my $sqlresult = &update_allusers_table($uname,$udom,\%names);
                   9712:     &devalidate_cache_new('namescache',$uname.':'.$udom);
                   9713:     $logmsg = 'Success modifying user '.$logmsg;
1.963     raeburn  9714:     &logthis($logmsg);
1.134     albertel 9715:     return 'ok';
1.80      www      9716: }
                   9717: 
1.81      www      9718: # -------------------------------------------------------------- Modify student
1.80      www      9719: 
1.81      www      9720: sub modifystudent {
                   9721:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957     raeburn  9722:         $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314    raeburn  9723:         $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455     albertel 9724:     if (!$cid) {
1.620     albertel 9725: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 9726: 	    return 'not_in_class';
                   9727: 	}
1.80      www      9728:     }
                   9729: # --------------------------------------------------------------- Make the user
1.81      www      9730:     my $reply=&modifyuser
1.209     matthew  9731: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990     raeburn  9732:          $desiredhome,$email,$inststatus);
1.80      www      9733:     unless ($reply eq 'ok') { return $reply; }
1.297     matthew  9734:     # This will cause &modify_student_enrollment to get the uid from the
1.1235    raeburn  9735:     # student's environment
1.297     matthew  9736:     $uid = undef if (!$forceid);
1.455     albertel 9737:     $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216    raeburn  9738:                                         $gene,$usec,$end,$start,$type,$locktype,
1.1314    raeburn  9739:                                         $cid,$selfenroll,$context,$credits,$instsec);
1.297     matthew  9740:     return $reply;
                   9741: }
                   9742: 
                   9743: sub modify_student_enrollment {
1.1216    raeburn  9744:     my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314    raeburn  9745:         $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455     albertel 9746:     my ($cdom,$cnum,$chome);
                   9747:     if (!$cid) {
1.620     albertel 9748: 	unless ($cid=$env{'request.course.id'}) {
1.455     albertel 9749: 	    return 'not_in_class';
                   9750: 	}
1.620     albertel 9751: 	$cdom=$env{'course.'.$cid.'.domain'};
                   9752: 	$cnum=$env{'course.'.$cid.'.num'};
1.455     albertel 9753:     } else {
                   9754: 	($cdom,$cnum)=split(/_/,$cid);
                   9755:     }
1.620     albertel 9756:     $chome=$env{'course.'.$cid.'.home'};
1.455     albertel 9757:     if (!$chome) {
1.457     raeburn  9758: 	$chome=&homeserver($cnum,$cdom);
1.297     matthew  9759:     }
1.455     albertel 9760:     if (!$chome) { return 'unknown_course'; }
1.297     matthew  9761:     # Make sure the user exists
1.81      www      9762:     my $uhome=&homeserver($uname,$udom);
                   9763:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   9764: 	return 'error: no such user';
                   9765:     }
1.297     matthew  9766:     # Get student data if we were not given enough information
                   9767:     if (!defined($first)  || $first  eq '' || 
                   9768:         !defined($last)   || $last   eq '' || 
                   9769:         !defined($uid)    || $uid    eq '' || 
                   9770:         !defined($middle) || $middle eq '' || 
                   9771:         !defined($gene)   || $gene   eq '') {
1.294     matthew  9772:         # They did not supply us with enough data to enroll the student, so
                   9773:         # we need to pick up more information.
1.297     matthew  9774:         my %tmp = &get('environment',
1.294     matthew  9775:                        ['firstname','middlename','lastname', 'generation','id']
1.297     matthew  9776:                        ,$udom,$uname);
                   9777: 
1.800     albertel 9778:         #foreach my $key (keys(%tmp)) {
                   9779:         #    &logthis("key $key = ".$tmp{$key});
1.455     albertel 9780:         #}
1.294     matthew  9781:         $first  = $tmp{'firstname'}  if (!defined($first)  || $first  eq '');
                   9782:         $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
                   9783:         $last   = $tmp{'lastname'}   if (!defined($last)   || $last eq '');
1.297     matthew  9784:         $gene   = $tmp{'generation'} if (!defined($gene)   || $gene eq '');
1.294     matthew  9785:         $uid    = $tmp{'id'}         if (!defined($uid)    || $uid  eq '');
                   9786:     }
1.556     albertel 9787:     my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148    raeburn  9788:     my $user = "$uname:$udom";
                   9789:     my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487     albertel 9790:     my $reply=cput('classlist',
1.1148    raeburn  9791: 		   {$user => 
1.1314    raeburn  9792: 			join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487     albertel 9793: 		   $cdom,$cnum);
1.1148    raeburn  9794:     if (($reply eq 'ok') || ($reply eq 'delayed')) {
                   9795:         &devalidate_getsection_cache($udom,$uname,$cid);
                   9796:     } else { 
1.81      www      9797: 	return 'error: '.$reply;
                   9798:     }
1.297     matthew  9799:     # Add student role to user
1.83      www      9800:     my $uurl='/'.$cid;
1.81      www      9801:     $uurl=~s/\_/\//g;
                   9802:     if ($usec) {
                   9803: 	$uurl.='/'.$usec;
                   9804:     }
1.1148    raeburn  9805:     my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
                   9806:                              $selfenroll,$context);
                   9807:     if ($result ne 'ok') {
                   9808:         if ($old_entry{$user} ne '') {
                   9809:             $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
                   9810:         } else {
                   9811:             $reply = &del('classlist',[$user],$cdom,$cnum);
                   9812:         }
                   9813:     }
                   9814:     return $result; 
1.21      www      9815: }
                   9816: 
1.556     albertel 9817: sub format_name {
                   9818:     my ($firstname,$middlename,$lastname,$generation,$first)=@_;
                   9819:     my $name;
                   9820:     if ($first ne 'lastname') {
                   9821: 	$name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
                   9822:     } else {
                   9823: 	if ($lastname=~/\S/) {
                   9824: 	    $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
                   9825: 	    $name=~s/\s+,/,/;
                   9826: 	} else {
                   9827: 	    $name.= $firstname.' '.$middlename.' '.$generation;
                   9828: 	}
                   9829:     }
                   9830:     $name=~s/^\s+//;
                   9831:     $name=~s/\s+$//;
                   9832:     $name=~s/\s+/ /g;
                   9833:     return $name;
                   9834: }
                   9835: 
1.84      www      9836: # ------------------------------------------------- Write to course preferences
                   9837: 
                   9838: sub writecoursepref {
                   9839:     my ($courseid,%prefs)=@_;
                   9840:     $courseid=~s/^\///;
                   9841:     $courseid=~s/\_/\//g;
                   9842:     my ($cdomain,$cnum)=split(/\//,$courseid);
                   9843:     my $chome=homeserver($cnum,$cdomain);
                   9844:     if (($chome eq '') || ($chome eq 'no_host')) { 
                   9845: 	return 'error: no such course';
                   9846:     }
                   9847:     my $cstring='';
1.800     albertel 9848:     foreach my $pref (keys(%prefs)) {
                   9849: 	$cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191     harris41 9850:     }
1.84      www      9851:     $cstring=~s/\&$//;
                   9852:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
                   9853: }
                   9854: 
                   9855: # ---------------------------------------------------------- Make/modify course
                   9856: 
                   9857: sub createcourse {
1.741     raeburn  9858:     my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017    raeburn  9859:         $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84      www      9860:     $url=&declutter($url);
                   9861:     my $cid='';
1.1028    raeburn  9862:     if ($context eq 'requestcourses') {
                   9863:         my $can_create = 0;
                   9864:         my ($ownername,$ownerdom) = split(':',$course_owner);
                   9865:         if ($udom eq $ownerdom) {
                   9866:             if (&usertools_access($ownername,$ownerdom,$category,undef,
                   9867:                                   $context)) {
                   9868:                 $can_create = 1;
                   9869:             }
                   9870:         } else {
                   9871:             my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
                   9872:                                            $category);
                   9873:             if ($userenv{'reqcrsotherdom.'.$category} ne '') {
                   9874:                 my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
                   9875:                 if (@curr > 0) {
                   9876:                     my @options = qw(approval validate autolimit);
                   9877:                     my $optregex = join('|',@options);
                   9878:                     if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
                   9879:                         $can_create = 1;
                   9880:                     }
                   9881:                 }
                   9882:             }
                   9883:         }
                   9884:         if ($can_create) {
                   9885:             unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
                   9886:                 unless (&allowed('ccc',$udom)) {
                   9887:                     return 'refused'; 
                   9888:                 }
1.1017    raeburn  9889:             }
                   9890:         } else {
                   9891:             return 'refused';
                   9892:         }
1.1028    raeburn  9893:     } elsif (!&allowed('ccc',$udom)) {
                   9894:         return 'refused';
1.84      www      9895:     }
1.1011    raeburn  9896: # --------------------------------------------------------------- Get Unique ID
                   9897:     my $uname;
                   9898:     if ($cnum =~ /^$match_courseid$/) {
                   9899:         my $chome=&homeserver($cnum,$udom,'true');
                   9900:         if (($chome eq '') || ($chome eq 'no_host')) {
                   9901:             $uname = $cnum;
                   9902:         } else {
1.1038    raeburn  9903:             $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  9904:         }
                   9905:     } else {
1.1038    raeburn  9906:         $uname = &generate_coursenum($udom,$crstype);
1.1011    raeburn  9907:     }
                   9908:     return $uname if ($uname =~ /^error/);
                   9909: # -------------------------------------------------- Check supplied server name
1.1052    raeburn  9910:     if (!defined($course_server)) {
                   9911:         if (defined(&domain($udom,'primary'))) {
                   9912:             $course_server = &domain($udom,'primary');
                   9913:         } else {
                   9914:             $course_server = $env{'user.home'}; 
                   9915:         }
                   9916:     }
                   9917:     my %host_servers =
                   9918:         &Apache::lonnet::get_servers($udom,'library');
                   9919:     unless ($host_servers{$course_server}) {
                   9920:         return 'error: invalid home server for course: '.$course_server;
1.264     matthew  9921:     }
1.84      www      9922: # ------------------------------------------------------------- Make the course
                   9923:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264     matthew  9924:                       $course_server);
1.84      www      9925:     unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011    raeburn  9926:     my $uhome=&homeserver($uname,$udom,'true');
1.84      www      9927:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   9928: 	return 'error: no such course';
                   9929:     }
1.271     www      9930: # ----------------------------------------------------------------- Course made
1.516     raeburn  9931: # log existence
1.1029    raeburn  9932:     my $now = time;
1.918     raeburn  9933:     my $newcourse = {
                   9934:                     $udom.'_'.$uname => {
1.921     raeburn  9935:                                      description => $description,
                   9936:                                      inst_code   => $inst_code,
                   9937:                                      owner       => $course_owner,
                   9938:                                      type        => $crstype,
1.1029    raeburn  9939:                                      creator     => $env{'user.name'}.':'.
                   9940:                                                     $env{'user.domain'},
                   9941:                                      created     => $now,
                   9942:                                      context     => $context,
1.918     raeburn  9943:                                                 },
                   9944:                     };
1.921     raeburn  9945:     &courseidput($udom,$newcourse,$uhome,'notime');
1.358     www      9946: # set toplevel url
1.271     www      9947:     my $topurl=$url;
                   9948:     unless ($nonstandard) {
                   9949: # ------------------------------------------ For standard courses, make top url
                   9950:         my $mapurl=&clutter($url);
1.278     www      9951:         if ($mapurl eq '/res/') { $mapurl=''; }
1.620     albertel 9952:         $env{'form.initmap'}=(<<ENDINITMAP);
1.271     www      9953: <map>
                   9954: <resource id="1" type="start"></resource>
                   9955: <resource id="2" src="$mapurl"></resource>
                   9956: <resource id="3" type="finish"></resource>
                   9957: <link index="1" from="1" to="2"></link>
                   9958: <link index="2" from="2" to="3"></link>
                   9959: </map>
                   9960: ENDINITMAP
                   9961:         $topurl=&declutter(
1.638     albertel 9962:         &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271     www      9963:                           );
                   9964:     }
                   9965: # ----------------------------------------------------------- Write preferences
1.84      www      9966:     &writecoursepref($udom.'_'.$uname,
1.1056    raeburn  9967:                      ('description'              => $description,
                   9968:                       'url'                      => $topurl,
                   9969:                       'internal.creator'         => $env{'user.name'}.':'.
                   9970:                                                     $env{'user.domain'},
                   9971:                       'internal.created'         => $now,
                   9972:                       'internal.creationcontext' => $context)
                   9973:                     );
1.84      www      9974:     return '/'.$udom.'/'.$uname;
                   9975: }
                   9976: 
1.1011    raeburn  9977: # ------------------------------------------------------------------- Create ID
                   9978: sub generate_coursenum {
1.1038    raeburn  9979:     my ($udom,$crstype) = @_;
1.1011    raeburn  9980:     my $domdesc = &domain($udom);
                   9981:     return 'error: invalid domain' if ($domdesc eq '');
1.1038    raeburn  9982:     my $first;
                   9983:     if ($crstype eq 'Community') {
                   9984:         $first = '0';
                   9985:     } else {
                   9986:         $first = int(1+rand(9)); 
                   9987:     } 
                   9988:     my $uname=$first.
1.1011    raeburn  9989:         ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   9990:         substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   9991:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   9992: # ----------------------------------------------- Make sure that does not exist
                   9993:     my $uhome=&homeserver($uname,$udom,'true');
                   9994:     unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038    raeburn  9995:         if ($crstype eq 'Community') {
                   9996:             $first = '0';
                   9997:         } else {
                   9998:             $first = int(1+rand(9));
                   9999:         }
                   10000:         $uname=$first.
1.1011    raeburn  10001:                ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
                   10002:                substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   10003:                unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   10004:         $uhome=&homeserver($uname,$udom,'true');
                   10005:         unless (($uhome eq '') || ($uhome eq 'no_host')) {
                   10006:             return 'error: unable to generate unique course-ID';
                   10007:         }
                   10008:     }
                   10009:     return $uname;
                   10010: }
                   10011: 
1.813     albertel 10012: sub is_course {
1.1167    droeschl 10013:     my ($cdom, $cnum) = scalar(@_) == 1 ? 
                   10014:          ($_[0] =~ /^($match_domain)_($match_courseid)$/)  :  @_;
                   10015: 
                   10016:     return unless $cdom and $cnum;
                   10017: 
                   10018:     my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
                   10019:         '.');
                   10020: 
1.1219    raeburn  10021:     return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167    droeschl 10022:     return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813     albertel 10023: }
                   10024: 
1.1015    raeburn  10025: sub store_userdata {
                   10026:     my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013    raeburn  10027:     my $result;
1.1016    raeburn  10028:     if ($datakey ne '') {
1.1013    raeburn  10029:         if (ref($storehash) eq 'HASH') {
1.1017    raeburn  10030:             if ($udom eq '' || $uname eq '') {
                   10031:                 $udom = $env{'user.domain'};
                   10032:                 $uname = $env{'user.name'};
                   10033:             }
                   10034:             my $uhome=&homeserver($uname,$udom);
1.1013    raeburn  10035:             if (($uhome eq '') || ($uhome eq 'no_host')) {
                   10036:                 $result = 'error: no_host';
                   10037:             } else {
                   10038:                 $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
                   10039:                 $storehash->{'host'} = $perlvar{'lonHostID'};
                   10040: 
                   10041:                 my $namevalue='';
                   10042:                 foreach my $key (keys(%{$storehash})) {
                   10043:                     $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
                   10044:                 }
                   10045:                 $namevalue=~s/\&$//;
1.1224    raeburn  10046:                 unless ($namespace eq 'courserequests') {
                   10047:                     $datakey = &escape($datakey);
                   10048:                 }
1.1105    raeburn  10049:                 $result =  &reply("store:$udom:$uname:$namespace:$datakey:".
                   10050:                                   $namevalue,$uhome);
1.1013    raeburn  10051:             }
                   10052:         } else {
                   10053:             $result = 'error: data to store was not a hash reference'; 
                   10054:         }
                   10055:     } else {
                   10056:         $result= 'error: invalid requestkey'; 
                   10057:     }
                   10058:     return $result;
                   10059: }
                   10060: 
1.21      www      10061: # ---------------------------------------------------------- Assign Custom Role
                   10062: 
                   10063: sub assigncustomrole {
1.957     raeburn  10064:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21      www      10065:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957     raeburn  10066:                        $end,$start,$deleteflag,$selfenroll,$context);
1.21      www      10067: }
                   10068: 
                   10069: # ----------------------------------------------------------------- Revoke Role
                   10070: 
                   10071: sub revokerole {
1.957     raeburn  10072:     my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21      www      10073:     my $now=time;
1.965     raeburn  10074:     return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21      www      10075: }
                   10076: 
                   10077: # ---------------------------------------------------------- Revoke Custom Role
                   10078: 
                   10079: sub revokecustomrole {
1.957     raeburn  10080:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21      www      10081:     my $now=time;
1.357     www      10082:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957     raeburn  10083:            $deleteflag,$selfenroll,$context);
1.17      www      10084: }
                   10085: 
1.533     banghart 10086: # ------------------------------------------------------------ Disk usage
1.535     albertel 10087: sub diskusage {
1.955     raeburn  10088:     my ($udom,$uname,$directorypath,$getpropath)=@_;
                   10089:     $directorypath =~ s/\/$//;
                   10090:     my $listing=&reply('du2:'.&escape($directorypath).':'
                   10091:                        .&escape($getpropath).':'.&escape($uname).':'
                   10092:                        .&escape($udom),homeserver($uname,$udom));
                   10093:     if ($listing eq 'unknown_cmd') {
                   10094:         if ($getpropath) {
                   10095:             $directorypath = &propath($udom,$uname).'/'.$directorypath; 
                   10096:         }
                   10097:         $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
                   10098:     }
1.514     albertel 10099:     return $listing;
1.512     banghart 10100: }
                   10101: 
1.566     banghart 10102: sub is_locked {
1.1096    raeburn  10103:     my ($file_name, $domain, $user, $which) = @_;
1.566     banghart 10104:     my @check;
                   10105:     my $is_locked;
1.1093    raeburn  10106:     push (@check,$file_name);
1.613     albertel 10107:     my %locked = &get('file_permissions',\@check,
1.620     albertel 10108: 		      $env{'user.domain'},$env{'user.name'});
1.615     albertel 10109:     my ($tmp)=keys(%locked);
                   10110:     if ($tmp=~/^error:/) { undef(%locked); }
1.745     raeburn  10111:     
1.566     banghart 10112:     if (ref($locked{$file_name}) eq 'ARRAY') {
1.745     raeburn  10113:         $is_locked = 'false';
                   10114:         foreach my $entry (@{$locked{$file_name}}) {
1.1096    raeburn  10115:            if (ref($entry) eq 'ARRAY') {
1.746     raeburn  10116:                $is_locked = 'true';
1.1096    raeburn  10117:                if (ref($which) eq 'ARRAY') {
                   10118:                    push(@{$which},$entry);
                   10119:                } else {
                   10120:                    last;
                   10121:                }
1.745     raeburn  10122:            }
                   10123:        }
1.566     banghart 10124:     } else {
                   10125:         $is_locked = 'false';
                   10126:     }
1.1093    raeburn  10127:     return $is_locked;
1.566     banghart 10128: }
                   10129: 
1.759     albertel 10130: sub declutter_portfile {
                   10131:     my ($file) = @_;
1.833     albertel 10132:     $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759     albertel 10133:     return $file;
                   10134: }
                   10135: 
1.559     banghart 10136: # ------------------------------------------------------------- Mark as Read Only
                   10137: 
                   10138: sub mark_as_readonly {
                   10139:     my ($domain,$user,$files,$what) = @_;
1.613     albertel 10140:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 10141:     my ($tmp)=keys(%current_permissions);
                   10142:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560     banghart 10143:     foreach my $file (@{$files}) {
1.759     albertel 10144: 	$file = &declutter_portfile($file);
1.561     banghart 10145:         push(@{$current_permissions{$file}},$what);
1.559     banghart 10146:     }
1.613     albertel 10147:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 10148:     return;
                   10149: }
                   10150: 
1.572     banghart 10151: # ------------------------------------------------------------Save Selected Files
                   10152: 
                   10153: sub save_selected_files {
                   10154:     my ($user, $path, @files) = @_;
                   10155:     my $filename = $user."savedfiles";
1.573     banghart 10156:     my @other_files = &files_not_in_path($user, $path);
1.1359    raeburn  10157:     open (OUT,'>',LONCAPA::tempdir().$filename);
1.573     banghart 10158:     foreach my $file (@files) {
1.620     albertel 10159:         print (OUT $env{'form.currentpath'}.$file."\n");
1.573     banghart 10160:     }
                   10161:     foreach my $file (@other_files) {
1.574     banghart 10162:         print (OUT $file."\n");
1.572     banghart 10163:     }
1.574     banghart 10164:     close (OUT);
1.572     banghart 10165:     return 'ok';
                   10166: }
                   10167: 
1.574     banghart 10168: sub clear_selected_files {
                   10169:     my ($user) = @_;
                   10170:     my $filename = $user."savedfiles";
1.1359    raeburn  10171:     open (OUT,'>',LONCAPA::tempdir().$filename);
1.574     banghart 10172:     print (OUT undef);
                   10173:     close (OUT);
                   10174:     return ("ok");    
                   10175: }
                   10176: 
1.572     banghart 10177: sub files_in_path {
                   10178:     my ($user, $path) = @_;
                   10179:     my $filename = $user."savedfiles";
                   10180:     my %return_files;
1.1359    raeburn  10181:     open (IN,'<',LONCAPA::tempdir().$filename);
1.573     banghart 10182:     while (my $line_in = <IN>) {
1.574     banghart 10183:         chomp ($line_in);
                   10184:         my @paths_and_file = split (m!/!, $line_in);
                   10185:         my $file_part = pop (@paths_and_file);
                   10186:         my $path_part = join ('/', @paths_and_file);
1.573     banghart 10187:         $path_part.='/';
                   10188:         my $path_and_file = $path_part.$file_part;
                   10189:         if ($path_part eq $path) {
                   10190:             $return_files{$file_part}= 'selected';
                   10191:         }
                   10192:     }
1.574     banghart 10193:     close (IN);
                   10194:     return (\%return_files);
1.572     banghart 10195: }
                   10196: 
                   10197: # called in portfolio select mode, to show files selected NOT in current directory
                   10198: sub files_not_in_path {
                   10199:     my ($user, $path) = @_;
                   10200:     my $filename = $user."savedfiles";
                   10201:     my @return_files;
                   10202:     my $path_part;
1.1359    raeburn  10203:     open(IN, '<',LONCAPA::tempdir().$filename);
1.800     albertel 10204:     while (my $line = <IN>) {
1.572     banghart 10205:         #ok, I know it's clunky, but I want it to work
1.800     albertel 10206:         my @paths_and_file = split(m|/|, $line);
                   10207:         my $file_part = pop(@paths_and_file);
                   10208:         chomp($file_part);
                   10209:         my $path_part = join('/', @paths_and_file);
1.572     banghart 10210:         $path_part .= '/';
                   10211:         my $path_and_file = $path_part.$file_part;
                   10212:         if ($path_part ne $path) {
1.800     albertel 10213:             push(@return_files, ($path_and_file));
1.572     banghart 10214:         }
                   10215:     }
1.800     albertel 10216:     close(OUT);
1.574     banghart 10217:     return (@return_files);
1.572     banghart 10218: }
                   10219: 
1.1273    raeburn  10220: #------------------------------Submitted/Handedback Portfolio Files Versioning
                   10221:  
                   10222: sub portfiles_versioning {
                   10223:     my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
                   10224:     my $portfolio_root = '/userfiles/portfolio';
                   10225:     return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
                   10226:     foreach my $file (@{$portfiles}) {
                   10227:         &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
                   10228:         my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
                   10229:         my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
                   10230:         my $getpropath = 1;
                   10231:         my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
                   10232:                                              $stu_name,$getpropath);
                   10233:         my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
                   10234:         my $new_answer = 
                   10235:             &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
                   10236:         if ($new_answer ne 'problem getting file') {
                   10237:             push(@{$versioned_portfiles}, $directory.$new_answer);
                   10238:             &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
                   10239:                               [$symb,$env{'request.course.id'},'graded']);
                   10240:         }
                   10241:     }
                   10242: }
                   10243: 
                   10244: sub get_next_version {
                   10245:     my ($answer_name, $answer_ext, $dir_list) = @_;
                   10246:     my $version;
                   10247:     if (ref($dir_list) eq 'ARRAY') {
                   10248:         foreach my $row (@{$dir_list}) {
                   10249:             my ($file) = split(/\&/,$row,2);
                   10250:             my ($file_name,$file_version,$file_ext) =
                   10251:                 &file_name_version_ext($file);
                   10252:             if (($file_name eq $answer_name) &&
                   10253:                 ($file_ext eq $answer_ext)) {
                   10254:                      # gets here if filename and extension match,
                   10255:                      # regardless of version
                   10256:                 if ($file_version ne '') {
                   10257:                     # a versioned file is found  so save it for later
                   10258:                     if ($file_version > $version) {
                   10259:                         $version = $file_version;
                   10260:                     }
                   10261:                 }
                   10262:             }
                   10263:         }
                   10264:     }
                   10265:     $version ++;
                   10266:     return($version);
                   10267: }
                   10268: 
                   10269: sub version_selected_portfile {
                   10270:     my ($domain,$stu_name,$directory,$file_name,$version) = @_;
                   10271:     my ($answer_name,$answer_ver,$answer_ext) =
                   10272:         &file_name_version_ext($file_name);
                   10273:     my $new_answer;
                   10274:     $env{'form.copy'} =
                   10275:         &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
                   10276:     if($env{'form.copy'} eq '-1') {
                   10277:         $new_answer = 'problem getting file';
                   10278:     } else {
                   10279:         $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
                   10280:         my $copy_result = 
                   10281:             &finishuserfileupload($stu_name,$domain,'copy',
                   10282:                                   '/portfolio'.$directory.$new_answer);
                   10283:     }
                   10284:     undef($env{'form.copy'});
                   10285:     return ($new_answer);
                   10286: }
                   10287: 
                   10288: sub file_name_version_ext {
                   10289:     my ($file)=@_;
                   10290:     my @file_parts = split(/\./, $file);
                   10291:     my ($name,$version,$ext);
                   10292:     if (@file_parts > 1) {
                   10293:         $ext=pop(@file_parts);
                   10294:         if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
                   10295:             $version=pop(@file_parts);
                   10296:         }
                   10297:         $name=join('.',@file_parts);
                   10298:     } else {
                   10299:         $name=join('.',@file_parts);
                   10300:     }
                   10301:     return($name,$version,$ext);
                   10302: }
                   10303: 
1.745     raeburn  10304: #----------------------------------------------Get portfolio file permissions
1.629     banghart 10305: 
1.745     raeburn  10306: sub get_portfile_permissions {
                   10307:     my ($domain,$user) = @_;
1.613     albertel 10308:     my %current_permissions = &dump('file_permissions',$domain,$user);
1.615     albertel 10309:     my ($tmp)=keys(%current_permissions);
                   10310:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  10311:     return \%current_permissions;
                   10312: }
                   10313: 
                   10314: #---------------------------------------------Get portfolio file access controls
                   10315: 
1.749     raeburn  10316: sub get_access_controls {
1.745     raeburn  10317:     my ($current_permissions,$group,$file) = @_;
1.769     albertel 10318:     my %access;
                   10319:     my $real_file = $file;
                   10320:     $file =~ s/\.meta$//;
1.745     raeburn  10321:     if (defined($file)) {
1.749     raeburn  10322:         if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
                   10323:             foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769     albertel 10324:                 $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749     raeburn  10325:             }
                   10326:         }
1.745     raeburn  10327:     } else {
1.749     raeburn  10328:         foreach my $key (keys(%{$current_permissions})) {
                   10329:             if ($key =~ /\0accesscontrol$/) {
                   10330:                 if (defined($group)) {
                   10331:                     if ($key !~ m-^\Q$group\E/-) {
                   10332:                         next;
                   10333:                     }
                   10334:                 }
                   10335:                 my ($fullpath) = split(/\0/,$key);
                   10336:                 if (ref($$current_permissions{$key}) eq 'HASH') {
                   10337:                     foreach my $control (keys(%{$$current_permissions{$key}})) {
                   10338:                         $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
                   10339:                     }
                   10340:                 }
                   10341:             }
                   10342:         }
                   10343:     }
                   10344:     return %access;
                   10345: }
                   10346: 
                   10347: sub modify_access_controls {
                   10348:     my ($file_name,$changes,$domain,$user)=@_;
                   10349:     my ($outcome,$deloutcome);
                   10350:     my %store_permissions;
                   10351:     my %new_values;
                   10352:     my %new_control;
                   10353:     my %translation;
                   10354:     my @deletions = ();
                   10355:     my $now = time;
                   10356:     if (exists($$changes{'activate'})) {
                   10357:         if (ref($$changes{'activate'}) eq 'HASH') {
                   10358:             my @newitems = sort(keys(%{$$changes{'activate'}}));
                   10359:             my $numnew = scalar(@newitems);
                   10360:             for (my $i=0; $i<$numnew; $i++) {
                   10361:                 my $newkey = $newitems[$i];
                   10362:                 my $newid = &Apache::loncommon::get_cgi_id();
1.797     raeburn  10363:                 if ($newkey =~ /^\d+:/) { 
                   10364:                     $newkey =~ s/^(\d+)/$newid/;
                   10365:                     $translation{$1} = $newid;
                   10366:                 } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
                   10367:                     $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
                   10368:                     $translation{$1} = $newid;
                   10369:                 }
1.749     raeburn  10370:                 $new_values{$file_name."\0".$newkey} = 
                   10371:                                           $$changes{'activate'}{$newitems[$i]};
                   10372:                 $new_control{$newkey} = $now;
                   10373:             }
                   10374:         }
                   10375:     }
                   10376:     my %todelete;
                   10377:     my %changed_items;
                   10378:     foreach my $action ('delete','update') {
                   10379:         if (exists($$changes{$action})) {
                   10380:             if (ref($$changes{$action}) eq 'HASH') {
                   10381:                 foreach my $key (keys(%{$$changes{$action}})) {
                   10382:                     my ($itemnum) = ($key =~ /^([^:]+):/);
                   10383:                     if ($action eq 'delete') { 
                   10384:                         $todelete{$itemnum} = 1;
                   10385:                     } else {
                   10386:                         $changed_items{$itemnum} = $key;
                   10387:                     }
                   10388:                 }
1.745     raeburn  10389:             }
                   10390:         }
1.749     raeburn  10391:     }
                   10392:     # get lock on access controls for file.
                   10393:     my $lockhash = {
                   10394:                   $file_name."\0".'locked_access_records' => $env{'user.name'}.
                   10395:                                                        ':'.$env{'user.domain'},
                   10396:                    }; 
                   10397:     my $tries = 0;
                   10398:     my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   10399:    
1.1288    damieng  10400:     while (($gotlock ne 'ok') && $tries < 10) {
1.749     raeburn  10401:         $tries ++;
1.1289    damieng  10402:         sleep(0.1);
1.749     raeburn  10403:         $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
                   10404:     }
                   10405:     if ($gotlock eq 'ok') {
                   10406:         my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
                   10407:         my ($tmp)=keys(%curr_permissions);
                   10408:         if ($tmp=~/^error:/) { undef(%curr_permissions); }
                   10409:         if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
                   10410:             my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
                   10411:             if (ref($curr_controls) eq 'HASH') {
                   10412:                 foreach my $control_item (keys(%{$curr_controls})) {
                   10413:                     my ($itemnum) = ($control_item =~ /^([^:]+):/);
                   10414:                     if (defined($todelete{$itemnum})) {
                   10415:                         push(@deletions,$file_name."\0".$control_item);
                   10416:                     } else {
                   10417:                         if (defined($changed_items{$itemnum})) {
                   10418:                             $new_control{$changed_items{$itemnum}} = $now;
                   10419:                             push(@deletions,$file_name."\0".$control_item);
                   10420:                             $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
                   10421:                         } else {
                   10422:                             $new_control{$control_item} = $$curr_controls{$control_item};
                   10423:                         }
                   10424:                     }
1.745     raeburn  10425:                 }
                   10426:             }
                   10427:         }
1.970     raeburn  10428:         my ($group);
                   10429:         if (&is_course($domain,$user)) {
                   10430:             ($group,my $file) = split(/\//,$file_name,2);
                   10431:         }
1.749     raeburn  10432:         $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
                   10433:         $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
                   10434:         $outcome = &put('file_permissions',\%new_values,$domain,$user);
                   10435:         #  remove lock
                   10436:         my @del_lock = ($file_name."\0".'locked_access_records');
                   10437:         my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818     raeburn  10438:         my $sqlresult =
1.970     raeburn  10439:             &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818     raeburn  10440:                                     $group);
1.749     raeburn  10441:     } else {
                   10442:         $outcome = "error: could not obtain lockfile\n";  
1.745     raeburn  10443:     }
1.749     raeburn  10444:     return ($outcome,$deloutcome,\%new_values,\%translation);
1.745     raeburn  10445: }
                   10446: 
1.827     raeburn  10447: sub make_public_indefinitely {
1.1271    raeburn  10448:     my (@requrl) = @_;
                   10449:     return &automated_portfile_access('public',\@requrl);
                   10450: }
                   10451: 
                   10452: sub automated_portfile_access {
                   10453:     my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273    raeburn  10454:     unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
                   10455:         return 'invalid';
                   10456:     }
1.1271    raeburn  10457:     my %urls;
                   10458:     if (ref($addsref) eq 'ARRAY') {
                   10459:         foreach my $requrl (@{$addsref}) {
                   10460:             if (&is_portfolio_url($requrl)) {
                   10461:                 unless (exists($urls{$requrl})) {
                   10462:                     $urls{$requrl} = 'add';
                   10463:                 }
                   10464:             }
                   10465:         }
                   10466:     }
                   10467:     if (ref($delsref) eq 'ARRAY') {
                   10468:         foreach my $requrl (@{$delsref}) { 
                   10469:             if (&is_portfolio_url($requrl)) {
                   10470:                 unless (exists($urls{$requrl})) {
                   10471:                     $urls{$requrl} = 'delete'; 
                   10472:                 }
                   10473:             }
                   10474:         }
                   10475:     }
                   10476:     unless (keys(%urls)) {
                   10477:         return 'invalid';
                   10478:     }
                   10479:     my $ip;
                   10480:     if ($accesstype eq 'ip') {
                   10481:         if (ref($info) eq 'HASH') {
                   10482:             if ($info->{'ip'} ne '') {
                   10483:                 $ip = $info->{'ip'};
                   10484:             }
                   10485:         }
                   10486:         if ($ip eq '') {
                   10487:             return 'invalid';
                   10488:         }
                   10489:     }
                   10490:     my $errors;
1.827     raeburn  10491:     my $now = time;
1.1271    raeburn  10492:     my %current_perms;
                   10493:     foreach my $requrl (sort(keys(%urls))) {
                   10494:         my $action;
                   10495:         if ($urls{$requrl} eq 'add') {
                   10496:             $action = 'activate';
                   10497:         } else {
                   10498:             $action = 'none';
                   10499:         }
                   10500:         my $aclnum = 0;
1.827     raeburn  10501:         my (undef,$udom,$unum,$file_name,$group) =
                   10502:             &parse_portfolio_url($requrl);
1.1271    raeburn  10503:         unless (exists($current_perms{$unum.':'.$udom})) {
                   10504:             $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
                   10505:         }
                   10506:         my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827     raeburn  10507:                                                    $group,$file_name);
                   10508:         foreach my $key (keys(%{$access_controls{$file_name}})) {
                   10509:             my ($num,$scope,$end,$start) = 
                   10510:                 ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271    raeburn  10511:             if ($scope eq $accesstype) {
                   10512:                 if (($start <= $now) && ($end == 0)) {
                   10513:                     if ($accesstype eq 'ip') {
                   10514:                         if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
                   10515:                             if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
                   10516:                                 if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
                   10517:                                     if ($urls{$requrl} eq 'add') {
                   10518:                                         $action = 'none';
                   10519:                                         last;
                   10520:                                     } else {
                   10521:                                         $action = 'delete';
                   10522:                                         $aclnum = $num;
                   10523:                                         last;
                   10524:                                     }
                   10525:                                 }
                   10526:                             }
                   10527:                         }
                   10528:                     } elsif ($accesstype eq 'public') {
                   10529:                         if ($urls{$requrl} eq 'add') {
                   10530:                             $action = 'none';
                   10531:                             last;
                   10532:                         } else {
                   10533:                             $action = 'delete';
                   10534:                             $aclnum = $num;
                   10535:                             last;
                   10536:                         }
                   10537:                     }
                   10538:                 } elsif ($accesstype eq 'public') {
1.827     raeburn  10539:                     $action = 'update';
                   10540:                     $aclnum = $num;
1.1271    raeburn  10541:                     last;
1.827     raeburn  10542:                 }
                   10543:             }
                   10544:         }
                   10545:         if ($action eq 'none') {
1.1271    raeburn  10546:             next;
1.827     raeburn  10547:         } else {
                   10548:             my %changes;
                   10549:             my $newend = 0;
                   10550:             my $newstart = $now;
1.1271    raeburn  10551:             my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827     raeburn  10552:             $changes{$action}{$newkey} = {
1.1271    raeburn  10553:                 type => $accesstype,
1.827     raeburn  10554:                 time => {
                   10555:                     start => $newstart,
                   10556:                     end   => $newend,
                   10557:                 },
                   10558:             };
1.1271    raeburn  10559:             if ($accesstype eq 'ip') {
                   10560:                 $changes{$action}{$newkey}{'ip'} = [$ip];
                   10561:             }
1.827     raeburn  10562:             my ($outcome,$deloutcome,$new_values,$translation) =
                   10563:                 &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271    raeburn  10564:             unless ($outcome eq 'ok') {
                   10565:                 $errors .= $outcome.' ';
                   10566:             }
1.827     raeburn  10567:         }
1.1271    raeburn  10568:     }
                   10569:     if ($errors) {
                   10570:         $errors =~ s/\s$//;
                   10571:         return $errors;
1.827     raeburn  10572:     } else {
1.1271    raeburn  10573:         return 'ok';
1.827     raeburn  10574:     }
                   10575: }
                   10576: 
1.745     raeburn  10577: #------------------------------------------------------Get Marked as Read Only
                   10578: 
                   10579: sub get_marked_as_readonly {
                   10580:     my ($domain,$user,$what,$group) = @_;
                   10581:     my $current_permissions = &get_portfile_permissions($domain,$user);
1.563     banghart 10582:     my @readonly_files;
1.629     banghart 10583:     my $cmp1=$what;
                   10584:     if (ref($what)) { $cmp1=join('',@{$what}) };
1.745     raeburn  10585:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   10586:         if (defined($group)) {
                   10587:             if ($file_name !~ m-^\Q$group\E/-) {
                   10588:                 next;
                   10589:             }
                   10590:         }
1.561     banghart 10591:         if (ref($value) eq "ARRAY"){
                   10592:             foreach my $stored_what (@{$value}) {
1.629     banghart 10593:                 my $cmp2=$stored_what;
1.759     albertel 10594:                 if (ref($stored_what) eq 'ARRAY') {
1.746     raeburn  10595:                     $cmp2=join('',@{$stored_what});
1.745     raeburn  10596:                 }
1.629     banghart 10597:                 if ($cmp1 eq $cmp2) {
1.561     banghart 10598:                     push(@readonly_files, $file_name);
1.745     raeburn  10599:                     last;
1.563     banghart 10600:                 } elsif (!defined($what)) {
                   10601:                     push(@readonly_files, $file_name);
1.745     raeburn  10602:                     last;
1.561     banghart 10603:                 }
                   10604:             }
1.745     raeburn  10605:         }
1.561     banghart 10606:     }
                   10607:     return @readonly_files;
                   10608: }
1.577     banghart 10609: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561     banghart 10610: 
1.577     banghart 10611: sub get_marked_as_readonly_hash {
1.745     raeburn  10612:     my ($current_permissions,$group,$what) = @_;
1.577     banghart 10613:     my %readonly_files;
1.745     raeburn  10614:     while (my ($file_name,$value) = each(%{$current_permissions})) {
                   10615:         if (defined($group)) {
                   10616:             if ($file_name !~ m-^\Q$group\E/-) {
                   10617:                 next;
                   10618:             }
                   10619:         }
1.577     banghart 10620:         if (ref($value) eq "ARRAY"){
                   10621:             foreach my $stored_what (@{$value}) {
1.745     raeburn  10622:                 if (ref($stored_what) eq 'ARRAY') {
1.750     banghart 10623:                     foreach my $lock_descriptor(@{$stored_what}) {
                   10624:                         if ($lock_descriptor eq 'graded') {
                   10625:                             $readonly_files{$file_name} = 'graded';
                   10626:                         } elsif ($lock_descriptor eq 'handback') {
                   10627:                             $readonly_files{$file_name} = 'handback';
                   10628:                         } else {
                   10629:                             if (!exists($readonly_files{$file_name})) {
                   10630:                                 $readonly_files{$file_name} = 'locked';
                   10631:                             }
                   10632:                         }
1.745     raeburn  10633:                     }
1.750     banghart 10634:                 } 
1.577     banghart 10635:             }
                   10636:         } 
                   10637:     }
                   10638:     return %readonly_files;
                   10639: }
1.559     banghart 10640: # ------------------------------------------------------------ Unmark as Read Only
                   10641: 
                   10642: sub unmark_as_readonly {
1.629     banghart 10643:     # unmarks $file_name (if $file_name is defined), or all files locked by $what 
                   10644:     # for portfolio submissions, $what contains [$symb,$crsid] 
1.745     raeburn  10645:     my ($domain,$user,$what,$file_name,$group) = @_;
1.759     albertel 10646:     $file_name = &declutter_portfile($file_name);
1.634     albertel 10647:     my $symb_crs = $what;
                   10648:     if (ref($what)) { $symb_crs=join('',@$what); }
1.745     raeburn  10649:     my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615     albertel 10650:     my ($tmp)=keys(%current_permissions);
                   10651:     if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745     raeburn  10652:     my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650     albertel 10653:     foreach my $file (@readonly_files) {
1.759     albertel 10654: 	my $clean_file = &declutter_portfile($file);
                   10655: 	if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650     albertel 10656: 	my $current_locks = $current_permissions{$file};
1.563     banghart 10657:         my @new_locks;
                   10658:         my @del_keys;
                   10659:         if (ref($current_locks) eq "ARRAY"){
                   10660:             foreach my $locker (@{$current_locks}) {
1.632     albertel 10661:                 my $compare=$locker;
1.749     raeburn  10662:                 if (ref($locker) eq 'ARRAY') {
1.745     raeburn  10663:                     $compare=join('',@{$locker});
1.746     raeburn  10664:                     if ($compare ne $symb_crs) {
                   10665:                         push(@new_locks, $locker);
                   10666:                     }
1.563     banghart 10667:                 }
                   10668:             }
1.650     albertel 10669:             if (scalar(@new_locks) > 0) {
1.563     banghart 10670:                 $current_permissions{$file} = \@new_locks;
                   10671:             } else {
                   10672:                 push(@del_keys, $file);
1.613     albertel 10673:                 &del('file_permissions',\@del_keys, $domain, $user);
1.650     albertel 10674:                 delete($current_permissions{$file});
1.563     banghart 10675:             }
                   10676:         }
1.561     banghart 10677:     }
1.613     albertel 10678:     &put('file_permissions',\%current_permissions,$domain,$user);
1.559     banghart 10679:     return;
                   10680: }
1.512     banghart 10681: 
1.17      www      10682: # ------------------------------------------------------------ Directory lister
                   10683: 
                   10684: sub dirlist {
1.955     raeburn  10685:     my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18      www      10686:     $uri=~s/^\///;
                   10687:     $uri=~s/\/$//;
1.253     stredwic 10688:     my ($udom, $uname);
1.955     raeburn  10689:     if ($getuserdir) {
1.253     stredwic 10690:         $udom = $userdomain;
                   10691:         $uname = $username;
1.955     raeburn  10692:     } else {
                   10693:         (undef,$udom,$uname)=split(/\//,$uri);
                   10694:         if(defined($userdomain)) {
                   10695:             $udom = $userdomain;
                   10696:         }
                   10697:         if(defined($username)) {
                   10698:             $uname = $username;
                   10699:         }
1.253     stredwic 10700:     }
1.955     raeburn  10701:     my ($dirRoot,$listing,@listing_results);
1.253     stredwic 10702: 
1.955     raeburn  10703:     $dirRoot = $perlvar{'lonDocRoot'};
                   10704:     if (defined($getpropath)) {
                   10705:         $dirRoot = &propath($udom,$uname);
1.253     stredwic 10706:         $dirRoot =~ s/\/$//;
1.955     raeburn  10707:     } elsif (defined($getuserdir)) {
                   10708:         my $subdir=$uname.'__';
                   10709:         $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   10710:         $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
                   10711:                    ."/$udom/$subdir/$uname";
                   10712:     } elsif (defined($alternateRoot)) {
                   10713:         $dirRoot = $alternateRoot;
1.751     banghart 10714:     }
1.253     stredwic 10715: 
                   10716:     if($udom) {
                   10717:         if($uname) {
1.1135    raeburn  10718:             my $uhome = &homeserver($uname,$udom);
1.1136    raeburn  10719:             if ($uhome eq 'no_host') {
                   10720:                 return ([],'no_host');
                   10721:             }
1.955     raeburn  10722:             $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956     raeburn  10723:                               .$getuserdir.':'.&escape($dirRoot)
1.1135    raeburn  10724:                               .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955     raeburn  10725:             if ($listing eq 'unknown_cmd') {
1.1135    raeburn  10726:                 $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955     raeburn  10727:             } else {
                   10728:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   10729:             }
1.605     matthew  10730:             if ($listing eq 'unknown_cmd') {
1.1135    raeburn  10731:                 $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605     matthew  10732:                 @listing_results = split(/:/,$listing);
                   10733:             } else {
                   10734:                 @listing_results = map { &unescape($_); } split(/:/,$listing);
                   10735:             }
1.1135    raeburn  10736:             if (($listing eq 'no_such_host') || ($listing eq 'con_lost') || 
1.1136    raeburn  10737:                 ($listing eq 'rejected') || ($listing eq 'refused') ||
                   10738:                 ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
                   10739:                 return ([],$listing);
                   10740:             } else {
                   10741:                 return (\@listing_results);
1.1135    raeburn  10742:             }
1.955     raeburn  10743:         } elsif(!$alternateRoot) {
1.1136    raeburn  10744:             my (%allusers,%listerror);
1.841     albertel 10745: 	    my %servers = &get_servers($udom,'library');
1.955     raeburn  10746:  	    foreach my $tryserver (keys(%servers)) {
                   10747:                 $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
                   10748:                                   &escape($udom),$tryserver);
                   10749:                 if ($listing eq 'unknown_cmd') {
                   10750: 		    $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
                   10751: 				      $udom, $tryserver);
                   10752:                 } else {
                   10753:                     @listing_results = map { &unescape($_); } split(/:/,$listing);
                   10754:                 }
1.841     albertel 10755: 		if ($listing eq 'unknown_cmd') {
                   10756: 		    $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
                   10757: 				      $udom, $tryserver);
                   10758: 		    @listing_results = split(/:/,$listing);
                   10759: 		} else {
                   10760: 		    @listing_results =
                   10761: 			map { &unescape($_); } split(/:/,$listing);
                   10762: 		}
1.1136    raeburn  10763:                 if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
                   10764:                     ($listing eq 'rejected') || ($listing eq 'refused') ||
                   10765:                     ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
                   10766:                     $listerror{$tryserver} = $listing;
                   10767:                 } else {
1.841     albertel 10768: 		    foreach my $line (@listing_results) {
                   10769: 			my ($entry) = split(/&/,$line,2);
                   10770: 			$allusers{$entry} = 1;
                   10771: 		    }
                   10772: 		}
1.253     stredwic 10773:             }
1.1136    raeburn  10774:             my @alluserslist=();
1.800     albertel 10775:             foreach my $user (sort(keys(%allusers))) {
1.1136    raeburn  10776:                 push(@alluserslist,$user.'&user');
1.253     stredwic 10777:             }
1.1318    droeschl 10778: 
                   10779:             if (!%listerror) {
                   10780:                 # no errors
                   10781:                 return (\@alluserslist);
                   10782:             } elsif (scalar(keys(%servers)) == 1) {
                   10783:                 # one library server, one error 
                   10784:                 my ($key) = keys(%listerror);
                   10785:                 return (\@alluserslist, $listerror{$key});
                   10786:             } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
                   10787:                 # con_lost indicates that we might miss data from at least one
                   10788:                 # library server
                   10789:                 return (\@alluserslist, 'con_lost');
                   10790:             } else {
                   10791:                 # multiple library servers and no con_lost -> data should be
                   10792:                 # complete. 
                   10793:                 return (\@alluserslist);
                   10794:             }
                   10795: 
1.253     stredwic 10796:         } else {
1.1136    raeburn  10797:             return ([],'missing username');
1.253     stredwic 10798:         }
1.955     raeburn  10799:     } elsif(!defined($getpropath)) {
1.1136    raeburn  10800:         my $path = $perlvar{'lonDocRoot'}.'/res/'; 
                   10801:         my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
                   10802:         return (\@all_domains);
1.955     raeburn  10803:     } else {
1.1136    raeburn  10804:         return ([],'missing domain');
1.275     stredwic 10805:     }
                   10806: }
                   10807: 
                   10808: # --------------------------------------------- GetFileTimestamp
                   10809: # This function utilizes dirlist and returns the date stamp for
                   10810: # when it was last modified.  It will also return an error of -1
                   10811: # if an error occurs
                   10812: 
                   10813: sub GetFileTimestamp {
1.955     raeburn  10814:     my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807     albertel 10815:     $studentDomain = &LONCAPA::clean_domain($studentDomain);
                   10816:     $studentName   = &LONCAPA::clean_username($studentName);
1.1136    raeburn  10817:     my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
                   10818:                                     undef,$getuserdir);
                   10819:     if (($error eq 'empty') || ($error eq 'no_such_dir')) {
                   10820:         return -1;
                   10821:     }
                   10822:     if (ref($fileref) eq 'ARRAY') {
                   10823:         my @stats = split('&',$fileref->[0]);
1.375     matthew  10824:         # @stats contains first the filename, then the stat output
                   10825:         return $stats[10]; # so this is 10 instead of 9.
1.275     stredwic 10826:     } else {
                   10827:         return -1;
1.253     stredwic 10828:     }
1.26      www      10829: }
                   10830: 
1.712     albertel 10831: sub stat_file {
                   10832:     my ($uri) = @_;
1.787     albertel 10833:     $uri = &clutter_with_no_wrapper($uri);
1.722     albertel 10834: 
1.955     raeburn  10835:     my ($udom,$uname,$file);
1.712     albertel 10836:     if ($uri =~ m-^/(uploaded|editupload)/-) {
                   10837: 	($udom,$uname,$file) =
1.811     albertel 10838: 	    ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712     albertel 10839: 	$file = 'userfiles/'.$file;
                   10840:     }
                   10841:     if ($uri =~ m-^/res/-) {
                   10842: 	($udom,$uname) = 
1.807     albertel 10843: 	    ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712     albertel 10844: 	$file = $uri;
                   10845:     }
                   10846: 
                   10847:     if (!$udom || !$uname || !$file) {
                   10848: 	# unable to handle the uri
                   10849: 	return ();
                   10850:     }
1.956     raeburn  10851:     my $getpropath;
                   10852:     if ($file =~ /^userfiles\//) {
                   10853:         $getpropath = 1;
                   10854:     }
1.1136    raeburn  10855:     my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
                   10856:     if (($error eq 'empty') || ($error eq 'no_such_dir')) {
                   10857:         return ();
                   10858:     } else {
                   10859:         if (ref($listref) eq 'ARRAY') {
                   10860:             my @stats = split('&',$listref->[0]);
                   10861: 	    shift(@stats); #filename is first
                   10862: 	    return @stats;
                   10863:         }
1.712     albertel 10864:     }
                   10865:     return ();
                   10866: }
                   10867: 
1.1313    raeburn  10868: # --------------------------------------------------------- recursedirs
                   10869: # Recursive function to traverse either a specific user's Authoring Space
                   10870: # or corresponding Published Resource Space, and populate the hash ref:
                   10871: # $dirhashref with URLs of all directories, and if $filehashref hash
                   10872: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
                   10873: # or .rights files in resource space, and .meta, .save, .log, and .bak
                   10874: # files in Authoring Space.
                   10875: #
                   10876: # Inputs:
                   10877: #
                   10878: # $is_home - true if current server is home server for user's space
                   10879: # $context - either: priv, or res respectively for Authoring or Resource Space.
                   10880: # $docroot - Document root (i.e., /home/httpd/html
                   10881: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
                   10882: # $relpath - Current path (relative to top level).
                   10883: # $dirhashref - reference to hash to populate with URLs of directories (Required)
                   10884: # $filehashref - reference to hash to populate with URLs of files (Optional)
                   10885: #
                   10886: # Returns: nothing
                   10887: #
                   10888: # Side Effects: populates $dirhashref, and $filehashref (if provided).
                   10889: #
                   10890: # Currently used by interface/londocs.pm to create linked select boxes for
                   10891: # directory and filename to import a Course "Author" resource into a course, and
                   10892: # also to create linked select boxes for Authoring Space and Directory to choose
                   10893: # save location for creation of a new "standard" problem from the Course Editor.
                   10894: #
                   10895: 
                   10896: sub recursedirs {
                   10897:     my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
                   10898:     return unless (ref($dirhashref) eq 'HASH');
                   10899:     my $currpath = $docroot.$toppath;
                   10900:     if ($relpath) {
                   10901:         $currpath .= "/$relpath";
                   10902:     }
                   10903:     my $savefile;
                   10904:     if (ref($filehashref)) {
                   10905:         $savefile = 1;
                   10906:     }
                   10907:     if ($is_home) {
                   10908:         if (opendir(my $dirh,$currpath)) {
                   10909:             foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
                   10910:                 next if ($item eq '');
                   10911:                 if (-d "$currpath/$item") {
                   10912:                     my $newpath;
                   10913:                     if ($relpath) {
                   10914:                         $newpath = "$relpath/$item";
                   10915:                     } else {
                   10916:                         $newpath = $item;
                   10917:                     }
                   10918:                     $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
                   10919:                     &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
                   10920:                 } elsif ($savefile) {
                   10921:                     if ($context eq 'priv') {
                   10922:                         unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
                   10923:                             $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
                   10924:                         }
                   10925:                     } else {
                   10926:                         unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
                   10927:                             $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
                   10928:                         }
                   10929:                     }
                   10930:                 }
                   10931:             }
                   10932:             closedir($dirh);
                   10933:         }
                   10934:     } else {
                   10935:         my ($dirlistref,$listerror) =
                   10936:             &dirlist($toppath.$relpath);
                   10937:         my @dir_lines;
                   10938:         my $dirptr=16384;
                   10939:         if (ref($dirlistref) eq 'ARRAY') {
                   10940:             foreach my $dir_line (sort
                   10941:                               {
                   10942:                                   my ($afile)=split('&',$a,2);
                   10943:                                   my ($bfile)=split('&',$b,2);
                   10944:                                   return (lc($afile) cmp lc($bfile));
                   10945:                               } (@{$dirlistref})) {
                   10946:                 my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
                   10947:                     split(/\&/,$dir_line,16);
                   10948:                 $item =~ s/\s+$//;
                   10949:                 next if (($item =~ /^\.\.?$/) || ($obs));
                   10950:                 if ($dirptr&$testdir) {
                   10951:                     my $newpath;
                   10952:                     if ($relpath) {
                   10953:                         $newpath = "$relpath/$item";
                   10954:                     } else {
                   10955:                         $relpath = '/';
                   10956:                         $newpath = $item;
                   10957:                     }
                   10958:                     $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
                   10959:                     &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
                   10960:                 } elsif ($savefile) {
                   10961:                     if ($context eq 'priv') {
                   10962:                         unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
                   10963:                             $filehashref->{$relpath}{$item} = 1;
                   10964:                         }
                   10965:                     } else {
                   10966:                         unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
                   10967:                             $filehashref->{$relpath}{$item} = 1;
                   10968:                         }
                   10969:                     }
                   10970:                 }
                   10971:             }
                   10972:         }
                   10973:     }
                   10974:     return;
                   10975: }
                   10976: 
1.26      www      10977: # -------------------------------------------------------- Value of a Condition
                   10978: 
1.713     albertel 10979: # gets the value of a specific preevaluated condition
                   10980: #    stored in the string  $env{user.state.<cid>}
                   10981: # or looks up a condition reference in the bighash and if if hasn't
                   10982: # already been evaluated recurses into docondval to get the value of
                   10983: # the condition, then memoizing it to 
                   10984: #   $env{user.state.<cid>.<condition>}
1.40      www      10985: sub directcondval {
                   10986:     my $number=shift;
1.620     albertel 10987:     if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555     albertel 10988: 	&Apache::lonuserstate::evalstate();
                   10989:     }
1.713     albertel 10990:     if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
                   10991: 	return $env{'user.state.'.$env{'request.course.id'}.".$number"};
                   10992:     } elsif ($number =~ /^_/) {
                   10993: 	my $sub_condition;
                   10994: 	if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   10995: 		&GDBM_READER(),0640)) {
                   10996: 	    $sub_condition=$bighash{'conditions'.$number};
                   10997: 	    untie(%bighash);
                   10998: 	}
                   10999: 	my $value = &docondval($sub_condition);
1.949     raeburn  11000: 	&appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713     albertel 11001: 	return $value;
                   11002:     }
1.620     albertel 11003:     if ($env{'user.state.'.$env{'request.course.id'}}) {
                   11004:        return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40      www      11005:     } else {
                   11006:        return 2;
                   11007:     }
                   11008: }
                   11009: 
1.713     albertel 11010: # get the collection of conditions for this resource
1.26      www      11011: sub condval {
                   11012:     my $condidx=shift;
1.54      www      11013:     my $allpathcond='';
1.713     albertel 11014:     foreach my $cond (split(/\|/,$condidx)) {
                   11015: 	if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
                   11016: 	    $allpathcond.=
                   11017: 		'('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
                   11018: 	}
1.191     harris41 11019:     }
1.54      www      11020:     $allpathcond=~s/\|$//;
1.713     albertel 11021:     return &docondval($allpathcond);
                   11022: }
                   11023: 
                   11024: #evaluates an expression of conditions
                   11025: sub docondval {
                   11026:     my ($allpathcond) = @_;
                   11027:     my $result=0;
                   11028:     if ($env{'request.course.id'}
                   11029: 	&& defined($allpathcond)) {
                   11030: 	my $operand='|';
                   11031: 	my @stack;
                   11032: 	foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
                   11033: 	    if ($chunk eq '(') {
                   11034: 		push @stack,($operand,$result);
                   11035: 	    } elsif ($chunk eq ')') {
                   11036: 		my $before=pop @stack;
                   11037: 		if (pop @stack eq '&') {
                   11038: 		    $result=$result>$before?$before:$result;
                   11039: 		} else {
                   11040: 		    $result=$result>$before?$result:$before;
                   11041: 		}
                   11042: 	    } elsif (($chunk eq '&') || ($chunk eq '|')) {
                   11043: 		$operand=$chunk;
                   11044: 	    } else {
                   11045: 		my $new=directcondval($chunk);
                   11046: 		if ($operand eq '&') {
                   11047: 		    $result=$result>$new?$new:$result;
                   11048: 		} else {
                   11049: 		    $result=$result>$new?$result:$new;
                   11050: 		}
                   11051: 	    }
                   11052: 	}
1.26      www      11053:     }
                   11054:     return $result;
1.421     albertel 11055: }
                   11056: 
                   11057: # ---------------------------------------------------- Devalidate courseresdata
                   11058: 
                   11059: sub devalidatecourseresdata {
                   11060:     my ($coursenum,$coursedomain)=@_;
                   11061:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 11062:     &devalidate_cache_new('courseres',$hashid);
1.28      www      11063: }
                   11064: 
1.763     www      11065: 
1.200     www      11066: # --------------------------------------------------- Course Resourcedata Query
1.878     foxr     11067: #
                   11068: #  Parameters:
                   11069: #      $coursenum    - Number of the course.
                   11070: #      $coursedomain - Domain at which the course was created.
                   11071: #  Returns:
                   11072: #     A hash of the course parameters along (I think) with timestamps
                   11073: #     and version info.
1.877     foxr     11074: 
1.624     albertel 11075: sub get_courseresdata {
                   11076:     my ($coursenum,$coursedomain)=@_;
1.200     www      11077:     my $coursehom=&homeserver($coursenum,$coursedomain);
                   11078:     my $hashid=$coursenum.':'.$coursedomain;
1.599     albertel 11079:     my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624     albertel 11080:     my %dumpreply;
1.417     albertel 11081:     unless (defined($cached)) {
1.624     albertel 11082: 	%dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417     albertel 11083: 	$result=\%dumpreply;
1.251     albertel 11084: 	my ($tmp) = keys(%dumpreply);
                   11085: 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599     albertel 11086: 	    &do_cache_new('courseres',$hashid,$result,600);
1.306     albertel 11087: 	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
                   11088: 	    return $tmp;
1.416     albertel 11089: 	} elsif ($tmp =~ /^(error)/) {
1.417     albertel 11090: 	    $result=undef;
1.599     albertel 11091: 	    &do_cache_new('courseres',$hashid,$result,600);
1.250     albertel 11092: 	}
                   11093:     }
1.624     albertel 11094:     return $result;
                   11095: }
                   11096: 
1.633     albertel 11097: sub devalidateuserresdata {
                   11098:     my ($uname,$udom)=@_;
                   11099:     my $hashid="$udom:$uname";
                   11100:     &devalidate_cache_new('userres',$hashid);
                   11101: }
                   11102: 
1.624     albertel 11103: sub get_userresdata {
                   11104:     my ($uname,$udom)=@_;
                   11105:     #most student don\'t have any data set, check if there is some data
                   11106:     if (&EXT_cache_status($udom,$uname)) { return undef; }
                   11107: 
                   11108:     my $hashid="$udom:$uname";
                   11109:     my ($result,$cached)=&is_cached_new('userres',$hashid);
                   11110:     if (!defined($cached)) {
                   11111: 	my %resourcedata=&dump('resourcedata',$udom,$uname);
                   11112: 	$result=\%resourcedata;
                   11113: 	&do_cache_new('userres',$hashid,$result,600);
                   11114:     }
                   11115:     my ($tmp)=keys(%$result);
                   11116:     if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
                   11117: 	return $result;
                   11118:     }
                   11119:     #error 2 occurs when the .db doesn't exist
                   11120:     if ($tmp!~/error: 2 /) {
1.1294    raeburn  11121:         if ((!defined($cached)) || ($tmp ne 'con_lost')) {
                   11122: 	    &logthis("<font color=\"blue\">WARNING:".
                   11123: 		     " Trying to get resource data for ".
                   11124: 		     $uname." at ".$udom.": ".
                   11125: 		     $tmp."</font>");
                   11126:         }
1.624     albertel 11127:     } elsif ($tmp=~/error: 2 /) {
1.633     albertel 11128: 	#&EXT_cache_set($udom,$uname);
                   11129: 	&do_cache_new('userres',$hashid,undef,600);
1.636     albertel 11130: 	undef($tmp); # not really an error so don't send it back
1.624     albertel 11131:     }
                   11132:     return $tmp;
                   11133: }
1.879     foxr     11134: #----------------------------------------------- resdata - return resource data
                   11135: #  Purpose:
                   11136: #    Return resource data for either users or for a course.
                   11137: #  Parameters:
                   11138: #     $name      - Course/user name.
                   11139: #     $domain    - Name of the domain the user/course is registered on.
1.1311    raeburn  11140: #     $type      - Type of thing $name is (must be 'course' or 'user')
1.1301    raeburn  11141: #     $mapp      - decluttered URL of enclosing map  
                   11142: #     $recursed  - Ref to scalar -- set to 1, if nested maps have been recursed.
                   11143: #     $recurseup - Ref to array of map URLs, starting with map containing
                   11144: #                  $mapp up through hierarchy of nested maps to top level map.  
                   11145: #     $courseid  - CourseID (first part of param identifier).
                   11146: #     $modifier  - Middle part of param identifier.
                   11147: #     $what      - Last part of param identifier.
1.879     foxr     11148: #     @which     - Array of names of resources desired.
                   11149: #  Returns:
                   11150: #     The value of the first reasource in @which that is found in the
                   11151: #     resource hash.
                   11152: #  Exceptional Conditions:
                   11153: #     If the $type passed in is not valid (not the string 'course' or 
                   11154: #     'user', an undefined  reference is returned.
                   11155: #     If none of the resources are found, an undef is returned
1.624     albertel 11156: sub resdata {
1.1301    raeburn  11157:     my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
                   11158:         $modifier,$what,@which)=@_;
1.624     albertel 11159:     my $result;
                   11160:     if ($type eq 'course') {
                   11161: 	$result=&get_courseresdata($name,$domain);
                   11162:     } elsif ($type eq 'user') {
                   11163: 	$result=&get_userresdata($name,$domain);
                   11164:     }
                   11165:     if (!ref($result)) { return $result; }    
1.251     albertel 11166:     foreach my $item (@which) {
1.1301    raeburn  11167:         if ($item->[1] eq 'course') {
                   11168:             if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
                   11169:                 unless ($$recursed) {
1.1302    raeburn  11170:                     @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301    raeburn  11171:                     $$recursed = 1;
                   11172:                 }
                   11173:                 foreach my $item (@${recurseup}) {
                   11174:                     my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
                   11175:                     last if (defined($result->{$norecursechk}));
                   11176:                     my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
                   11177:                     if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
                   11178:                 }
                   11179:             }
                   11180:         }
                   11181:         if (defined($result->{$item->[0]})) {
1.927     albertel 11182: 	    return [$result->{$item->[0]},$item->[1]];
1.251     albertel 11183: 	}
1.250     albertel 11184:     }
1.291     albertel 11185:     return undef;
1.200     www      11186: }
                   11187: 
1.1360    raeburn  11188: sub get_domain_lti {
                   11189:     my ($cdom,$context) = @_;
                   11190:     my ($name,%lti);
                   11191:     if ($context eq 'consumer') {
                   11192:         $name = 'ltitools';
                   11193:     } elsif ($context eq 'provider') {
                   11194:         $name = 'lti';
                   11195:     } else {
                   11196:         return %lti;
                   11197:     }
                   11198:     my ($result,$cached)=&is_cached_new($name,$cdom);
1.1298    raeburn  11199:     if (defined($cached)) {
                   11200:         if (ref($result) eq 'HASH') {
1.1360    raeburn  11201:             %lti = %{$result};
1.1298    raeburn  11202:         }
                   11203:     } else {
1.1360    raeburn  11204:         my %domconfig = &get_dom('configuration',[$name],$cdom);
                   11205:         if (ref($domconfig{$name}) eq 'HASH') {
                   11206:             %lti = %{$domconfig{$name}};
                   11207:             my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
                   11208:             if (ref($encdomconfig{$name}) eq 'HASH') {
                   11209:                 foreach my $id (keys(%lti)) {
                   11210:                     if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
1.1344    raeburn  11211:                         foreach my $item ('key','secret') {
1.1360    raeburn  11212:                             $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
1.1344    raeburn  11213:                         }
                   11214:                     }
                   11215:                 }
                   11216:             }
1.1298    raeburn  11217:         }
                   11218:         my $cachetime = 24*60*60;
1.1360    raeburn  11219:         &do_cache_new($name,$cdom,\%lti,$cachetime);
1.1298    raeburn  11220:     }
1.1360    raeburn  11221:     return %lti;
1.1298    raeburn  11222: }
                   11223: 
1.1236    raeburn  11224: sub get_numsuppfiles {
                   11225:     my ($cnum,$cdom,$ignorecache)=@_;
                   11226:     my $hashid=$cnum.':'.$cdom;
                   11227:     my ($suppcount,$cached);
                   11228:     unless ($ignorecache) {
                   11229:         ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
                   11230:     }
                   11231:     unless (defined($cached)) {
                   11232:         my $chome=&homeserver($cnum,$cdom);
                   11233:         unless ($chome eq 'no_host') {
1.1366    raeburn  11234:             ($suppcount,my $supptools,my $errors) = (0,0,0);
1.1236    raeburn  11235:             my $suppmap = 'supplemental.sequence';
1.1366    raeburn  11236:             ($suppcount,$supptools,$errors) =
                   11237:                 &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
                   11238:                                                          $supptools,$errors);
1.1236    raeburn  11239:         }
                   11240:         &do_cache_new('suppcount',$hashid,$suppcount,600);
                   11241:     }
                   11242:     return $suppcount;
                   11243: }
                   11244: 
1.379     matthew  11245: #
                   11246: # EXT resource caching routines
                   11247: #
                   11248: 
1.1302    raeburn  11249: {
                   11250: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
                   11251: #
                   11252: # The course for which we cache
                   11253: my $cachedmapkey='';
                   11254: # The cached recursive maps for this course
                   11255: my %cachedmaps=();
                   11256: # When this was last done
                   11257: my $cachedmaptime='';
                   11258: 
1.379     matthew  11259: sub clear_EXT_cache_status {
1.383     albertel 11260:     &delenv('cache.EXT.');
1.379     matthew  11261: }
                   11262: 
                   11263: sub EXT_cache_status {
                   11264:     my ($target_domain,$target_user) = @_;
1.383     albertel 11265:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620     albertel 11266:     if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379     matthew  11267:         # We know already the user has no data
                   11268:         return 1;
                   11269:     } else {
                   11270:         return 0;
                   11271:     }
                   11272: }
                   11273: 
                   11274: sub EXT_cache_set {
                   11275:     my ($target_domain,$target_user) = @_;
1.383     albertel 11276:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949     raeburn  11277:     #&appenv({$cachename => time});
1.379     matthew  11278: }
                   11279: 
1.28      www      11280: # --------------------------------------------------------- Value of a Variable
1.58      www      11281: sub EXT {
1.715     albertel 11282: 
1.1228    raeburn  11283:     my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68      www      11284:     unless ($varname) { return ''; }
1.218     albertel 11285:     #get real user name/domain, courseid and symb
                   11286:     my $courseid;
1.359     albertel 11287:     my $publicuser;
1.427     www      11288:     if ($symbparm) {
                   11289: 	$symbparm=&get_symb_from_alias($symbparm);
                   11290:     }
1.218     albertel 11291:     if (!($uname && $udom)) {
1.790     albertel 11292:       (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218     albertel 11293:       if (!$symbparm) {	$symbparm=$cursymb; }
                   11294:     } else {
1.620     albertel 11295: 	$courseid=$env{'request.course.id'};
1.218     albertel 11296:     }
1.48      www      11297:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
                   11298:     my $rest;
1.320     albertel 11299:     if (defined($therest[0])) {
1.48      www      11300:        $rest=join('.',@therest);
                   11301:     } else {
                   11302:        $rest='';
                   11303:     }
1.320     albertel 11304: 
1.57      www      11305:     my $qualifierrest=$qualifier;
                   11306:     if ($rest) { $qualifierrest.='.'.$rest; }
                   11307:     my $spacequalifierrest=$space;
                   11308:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28      www      11309:     if ($realm eq 'user') {
1.48      www      11310: # --------------------------------------------------------------- user.resource
                   11311: 	if ($space eq 'resource') {
1.651     albertel 11312: 	    if ( (defined($Apache::lonhomework::parsing_a_problem)
                   11313: 		  || defined($Apache::lonhomework::parsing_a_task))
                   11314: 		 &&
1.744     albertel 11315: 		 ($symbparm eq &symbread()) ) {	
                   11316: 		# if we are in the middle of processing the resource the
                   11317: 		# get the value we are planning on committing
                   11318:                 if (defined($Apache::lonhomework::results{$qualifierrest})) {
                   11319:                     return $Apache::lonhomework::results{$qualifierrest};
                   11320:                 } else {
                   11321:                     return $Apache::lonhomework::history{$qualifierrest};
                   11322:                 }
1.335     albertel 11323: 	    } else {
1.359     albertel 11324: 		my %restored;
1.620     albertel 11325: 		if ($publicuser || $env{'request.state'} eq 'construct') {
1.359     albertel 11326: 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
                   11327: 		} else {
                   11328: 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
                   11329: 		}
1.335     albertel 11330: 		return $restored{$qualifierrest};
                   11331: 	    }
1.48      www      11332: # ----------------------------------------------------------------- user.access
                   11333:         } elsif ($space eq 'access') {
1.218     albertel 11334: 	    # FIXME - not supporting calls for a specific user
1.48      www      11335:             return &allowed($qualifier,$rest);
                   11336: # ------------------------------------------ user.preferences, user.environment
                   11337:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620     albertel 11338: 	    if (($uname eq $env{'user.name'}) &&
                   11339: 		($udom eq $env{'user.domain'})) {
                   11340: 		return $env{join('.',('environment',$qualifierrest))};
1.218     albertel 11341: 	    } else {
1.359     albertel 11342: 		my %returnhash;
                   11343: 		if (!$publicuser) {
                   11344: 		    %returnhash=&userenvironment($udom,$uname,
                   11345: 						 $qualifierrest);
                   11346: 		}
1.218     albertel 11347: 		return $returnhash{$qualifierrest};
                   11348: 	    }
1.48      www      11349: # ----------------------------------------------------------------- user.course
                   11350:         } elsif ($space eq 'course') {
1.218     albertel 11351: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 11352:             return $env{join('.',('request.course',$qualifier))};
1.48      www      11353: # ------------------------------------------------------------------- user.role
                   11354:         } elsif ($space eq 'role') {
1.218     albertel 11355: 	    # FIXME - not supporting calls for a specific user
1.620     albertel 11356:             my ($role,$where)=split(/\./,$env{'request.role'});
1.48      www      11357:             if ($qualifier eq 'value') {
                   11358: 		return $role;
                   11359:             } elsif ($qualifier eq 'extent') {
                   11360:                 return $where;
                   11361:             }
                   11362: # ----------------------------------------------------------------- user.domain
                   11363:         } elsif ($space eq 'domain') {
1.218     albertel 11364:             return $udom;
1.48      www      11365: # ------------------------------------------------------------------- user.name
                   11366:         } elsif ($space eq 'name') {
1.218     albertel 11367:             return $uname;
1.48      www      11368: # ---------------------------------------------------- Any other user namespace
1.29      www      11369:         } else {
1.359     albertel 11370: 	    my %reply;
                   11371: 	    if (!$publicuser) {
                   11372: 		%reply=&get($space,[$qualifierrest],$udom,$uname);
                   11373: 	    }
                   11374: 	    return $reply{$qualifierrest};
1.48      www      11375:         }
1.236     www      11376:     } elsif ($realm eq 'query') {
                   11377: # ---------------------------------------------- pull stuff out of query string
1.384     albertel 11378:         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                   11379: 						[$spacequalifierrest]);
1.620     albertel 11380: 	return $env{'form.'.$spacequalifierrest}; 
1.236     www      11381:    } elsif ($realm eq 'request') {
1.48      www      11382: # ------------------------------------------------------------- request.browser
                   11383:         if ($space eq 'browser') {
1.1145    bisitz   11384:             return $env{'browser.'.$qualifier};
1.57      www      11385: # ------------------------------------------------------------ request.filename
                   11386:         } else {
1.620     albertel 11387:             return $env{'request.'.$spacequalifierrest};
1.29      www      11388:         }
1.28      www      11389:     } elsif ($realm eq 'course') {
1.48      www      11390: # ---------------------------------------------------------- course.description
1.620     albertel 11391:         return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57      www      11392:     } elsif ($realm eq 'resource') {
1.165     www      11393: 
1.620     albertel 11394: 	if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539     albertel 11395: 	    if (!$symbparm) { $symbparm=&symbread(); }
                   11396: 	}
1.693     albertel 11397: 
1.1232    raeburn  11398:         if ($qualifier eq '') {
                   11399: 	    if ($space eq 'title') {
                   11400: 	        if (!$symbparm) { $symbparm = $env{'request.filename'}; }
                   11401: 	        return &gettitle($symbparm);
                   11402: 	    }
1.693     albertel 11403: 	
1.1232    raeburn  11404: 	    if ($space eq 'map') {
                   11405: 	        my ($map) = &decode_symb($symbparm);
                   11406: 	        return &symbread($map);
                   11407: 	    }
                   11408:             if ($space eq 'maptitle') {
                   11409:                 my ($map) = &decode_symb($symbparm);
                   11410:                 return &gettitle($map);
                   11411:             }
                   11412: 	    if ($space eq 'filename') {
                   11413: 	        if ($symbparm) {
                   11414: 		    return &clutter((&decode_symb($symbparm))[2]);
                   11415: 	        }
                   11416: 	        return &hreflocation('',$env{'request.filename'});
1.905     albertel 11417: 	    }
1.1232    raeburn  11418: 
1.1233    raeburn  11419:             if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
                   11420:                 if ($space eq 'visibleparts') {
                   11421:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   11422:                     my $item;
                   11423:                     if (ref($navmap)) {
                   11424:                         my $res = $navmap->getBySymb($symbparm);
                   11425:                         my $parts = $res->parts();
                   11426:                         if (ref($parts) eq 'ARRAY') {
                   11427:                             $item = join(',',@{$parts});
                   11428:                         }
                   11429:                         undef($navmap);
1.1232    raeburn  11430:                     }
1.1233    raeburn  11431:                     return $item;
1.1232    raeburn  11432:                 }
                   11433:             }
                   11434:         }
1.693     albertel 11435: 
1.1301    raeburn  11436: 	my ($section, $group, @groups, @recurseup, $recursed);
                   11437: 	my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228    raeburn  11438:         if (($courseid eq '') && ($cid)) {
                   11439:             $courseid = $cid;
                   11440:         }
                   11441: 	if (($symbparm && $courseid) && 
                   11442: 	    (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid)))  {
1.165     www      11443: 
1.218     albertel 11444: 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165     www      11445: 
1.60      www      11446: # ----------------------------------------------------- Cascading lookup scheme
1.218     albertel 11447: 	    my $symbp=$symbparm;
1.1301    raeburn  11448: 	    $mapp=&deversion((&decode_symb($symbp))[0]);
1.218     albertel 11449: 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301    raeburn  11450:             my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218     albertel 11451: 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620     albertel 11452: 	    if (($env{'user.name'} eq $uname) &&
                   11453: 		($env{'user.domain'} eq $udom)) {
                   11454: 		$section=$env{'request.course.sec'};
1.733     raeburn  11455:                 @groups = split(/:/,$env{'request.course.groups'});  
                   11456:                 @groups=&sort_course_groups($courseid,@groups); 
1.218     albertel 11457: 	    } else {
1.539     albertel 11458: 		if (! defined($usection)) {
1.551     albertel 11459: 		    $section=&getsection($udom,$uname,$courseid);
1.539     albertel 11460: 		} else {
                   11461: 		    $section = $usection;
                   11462: 		}
1.733     raeburn  11463:                 @groups = &get_users_groups($udom,$uname,$courseid);
1.218     albertel 11464: 	    }
                   11465: 
                   11466: 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
                   11467: 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301    raeburn  11468:             my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218     albertel 11469: 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
                   11470: 
1.593     albertel 11471: 	    $courselevel=$courseid.'.'.$spacequalifierrest;
1.218     albertel 11472: 	    my $courselevelr=$courseid.'.'.$symbparm;
1.1301    raeburn  11473:             $courseleveli=$courseid.'.'.$recurseparm;
1.593     albertel 11474: 	    $courselevelm=$courseid.'.'.$mapparm;
1.69      www      11475: 
1.60      www      11476: # ----------------------------------------------------------- first, check user
1.624     albertel 11477: 
1.1301    raeburn  11478: 	    my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
                   11479:                                    \@recurseup,$courseid,'.',$spacequalifierrest, 
1.927     albertel 11480: 				       ([$courselevelr,'resource'],
                   11481: 					[$courselevelm,'map'     ],
1.1301    raeburn  11482:                                         [$courseleveli,'map'     ],
1.927     albertel 11483: 					[$courselevel, 'course'  ]));
1.931     albertel 11484: 	    if (defined($userreply)) { return &get_reply($userreply); }
1.95      www      11485: 
1.594     albertel 11486: # ------------------------------------------------ second, check some of course
1.684     raeburn  11487:             my $coursereply;
1.691     raeburn  11488:             if (@groups > 0) {
                   11489:                 $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301    raeburn  11490:                                        $recurseparm,$mapparm,$spacequalifierrest,
                   11491:                                        $mapp,\$recursed,\@recurseup);
                   11492:                 if (defined($coursereply)) { return &get_reply($coursereply); } 
1.684     raeburn  11493:             }
1.96      www      11494: 
1.684     raeburn  11495: 	    $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927     albertel 11496: 				  $env{'course.'.$courseid.'.domain'},
1.1301    raeburn  11497: 				  'course',$mapp,\$recursed,\@recurseup,
                   11498:                                   $courseid,'.['.$section.'].',$spacequalifierrest,
1.927     albertel 11499: 				  ([$seclevelr,   'resource'],
                   11500: 				   [$seclevelm,   'map'     ],
1.1301    raeburn  11501:                                    [$secleveli,   'map'     ],
1.927     albertel 11502: 				   [$seclevel,    'course'  ],
                   11503: 				   [$courselevelr,'resource']));
                   11504: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.200     www      11505: 
1.60      www      11506: # ------------------------------------------------------ third, check map parms
1.218     albertel 11507: 	    my %parmhash=();
                   11508: 	    my $thisparm='';
                   11509: 	    if (tie(%parmhash,'GDBM_File',
1.620     albertel 11510: 		    $env{'request.course.fn'}.'_parms.db',
1.256     albertel 11511: 		    &GDBM_READER(),0640)) {
1.218     albertel 11512: 		$thisparm=$parmhash{$symbparm};
                   11513: 		untie(%parmhash);
                   11514: 	    }
1.927     albertel 11515: 	    if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218     albertel 11516: 	}
1.594     albertel 11517: # ------------------------------------------ fourth, look in resource metadata
1.1301    raeburn  11518:  
                   11519:         my $what = $spacequalifierrest;
                   11520: 	$what=~s/\./\_/;
1.282     albertel 11521: 	my $filename;
                   11522: 	if (!$symbparm) { $symbparm=&symbread(); }
                   11523: 	if ($symbparm) {
1.409     www      11524: 	    $filename=(&decode_symb($symbparm))[2];
1.282     albertel 11525: 	} else {
1.620     albertel 11526: 	    $filename=$env{'request.filename'};
1.282     albertel 11527: 	}
1.1362    raeburn  11528:         my $toolsymb;
                   11529:         if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
                   11530:             $toolsymb = $symbparm;
                   11531:         }
                   11532: 	my $metadata=&metadata($filename,$what,$toolsymb);
1.927     albertel 11533: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362    raeburn  11534: 	$metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927     albertel 11535: 	if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142     www      11536: 
1.1301    raeburn  11537: # ----------------------------------------------- fifth, look in rest of course
1.593     albertel 11538: 	if ($symbparm && defined($courseid) && 
1.620     albertel 11539: 	    $courseid eq $env{'request.course.id'}) {
1.624     albertel 11540: 	    my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
                   11541: 				     $env{'course.'.$courseid.'.domain'},
1.1301    raeburn  11542: 				     'course',$mapp,\$recursed,\@recurseup,
                   11543:                                      $courseid,'.',$spacequalifierrest,
1.927     albertel 11544: 				     ([$courselevelm,'map'   ],
1.1301    raeburn  11545:                                       [$courseleveli,'map'   ],
1.927     albertel 11546: 				      [$courselevel, 'course']));
                   11547: 	    if (defined($coursereply)) { return &get_reply($coursereply); }
1.593     albertel 11548: 	}
1.145     www      11549: # ------------------------------------------------------------------ Cascade up
1.218     albertel 11550: 	unless ($space eq '0') {
1.336     albertel 11551: 	    my @parts=split(/_/,$space);
                   11552: 	    my $id=pop(@parts);
                   11553: 	    my $part=join('_',@parts);
                   11554: 	    if ($part eq '') { $part='0'; }
1.927     albertel 11555: 	    my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395     albertel 11556: 				 $symbparm,$udom,$uname,$section,1);
1.938     raeburn  11557: 	    if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218     albertel 11558: 	}
1.395     albertel 11559: 	if ($recurse) { return undef; }
1.1362    raeburn  11560: 	my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927     albertel 11561: 	if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48      www      11562: # ---------------------------------------------------- Any other user namespace
                   11563:     } elsif ($realm eq 'environment') {
                   11564: # ----------------------------------------------------------------- environment
1.620     albertel 11565: 	if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
                   11566: 	    return $env{'environment.'.$spacequalifierrest};
1.219     albertel 11567: 	} else {
1.770     albertel 11568: 	    if ($uname eq 'anonymous' && $udom eq '') {
                   11569: 		return '';
                   11570: 	    }
1.219     albertel 11571: 	    my %returnhash=&userenvironment($udom,$uname,
                   11572: 					    $spacequalifierrest);
                   11573: 	    return $returnhash{$spacequalifierrest};
                   11574: 	}
1.28      www      11575:     } elsif ($realm eq 'system') {
1.48      www      11576: # ----------------------------------------------------------------- system.time
                   11577: 	if ($space eq 'time') {
                   11578: 	    return time;
                   11579:         }
1.696     albertel 11580:     } elsif ($realm eq 'server') {
                   11581: # ----------------------------------------------------------------- system.time
                   11582: 	if ($space eq 'name') {
                   11583: 	    return $ENV{'SERVER_NAME'};
                   11584:         }
1.28      www      11585:     }
1.48      www      11586:     return '';
1.61      www      11587: }
                   11588: 
1.927     albertel 11589: sub get_reply {
                   11590:     my ($reply_value) = @_;
1.940     raeburn  11591:     if (ref($reply_value) eq 'ARRAY') {
                   11592:         if (wantarray) {
                   11593: 	    return @$reply_value;
                   11594:         }
                   11595:         return $reply_value->[0];
                   11596:     } else {
                   11597:         return $reply_value;
1.927     albertel 11598:     }
                   11599: }
                   11600: 
1.691     raeburn  11601: sub check_group_parms {
1.1301    raeburn  11602:     my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
                   11603:         $recursed,$recurseupref) = @_;
                   11604:     my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
                   11605:                   [$what,'course']);
                   11606:     my $coursereply;
1.691     raeburn  11607:     foreach my $group (@{$groups}) {
1.1301    raeburn  11608:         my @groupitems = ();
1.691     raeburn  11609:         foreach my $level (@levels) {
1.927     albertel 11610:              my $item = $courseid.'.['.$group.'].'.$level->[0];
                   11611:              push(@groupitems,[$item,$level->[1]]);
1.691     raeburn  11612:         }
1.1301    raeburn  11613:         my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
                   11614:                                    $env{'course.'.$courseid.'.domain'},
                   11615:                                    'course',$mapp,$recursed,$recurseupref,
                   11616:                                    $courseid,'.['.$group.'].',$what,
                   11617:                                    @groupitems);
                   11618:         last if (defined($coursereply));
1.691     raeburn  11619:     }
                   11620:     return $coursereply;
                   11621: }
                   11622: 
1.1301    raeburn  11623: sub get_map_hierarchy {
1.1302    raeburn  11624:     my ($mapname,$courseid) = @_;
                   11625:     my @recurseup = ();
1.1301    raeburn  11626:     if ($mapname) {
1.1302    raeburn  11627:         if (($cachedmapkey eq $courseid) &&
                   11628:             (abs($cachedmaptime-time)<5)) {
                   11629:             if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
                   11630:                 return @{$cachedmaps{$mapname}};
                   11631:             }
                   11632:         }
1.1301    raeburn  11633:         my $navmap = Apache::lonnavmaps::navmap->new();
                   11634:         if (ref($navmap)) {
                   11635:             @recurseup = $navmap->recurseup_maps($mapname);
                   11636:             undef($navmap);
1.1302    raeburn  11637:             $cachedmaps{$mapname} = \@recurseup;
                   11638:             $cachedmaptime=time;
                   11639:             $cachedmapkey=$courseid;
1.1301    raeburn  11640:         }
                   11641:     }
                   11642:     return @recurseup;
                   11643: }
                   11644: 
1.1302    raeburn  11645: }
                   11646: 
1.691     raeburn  11647: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733     raeburn  11648:     my ($courseid,@groups) = @_;
                   11649:     @groups = sort(@groups);
1.691     raeburn  11650:     return @groups;
                   11651: }
                   11652: 
1.395     albertel 11653: sub packages_tab_default {
1.1362    raeburn  11654:     my ($uri,$varname,$toolsymb)=@_;
1.395     albertel 11655:     my (undef,$part,$name)=split(/\./,$varname);
1.738     albertel 11656: 
                   11657:     my (@extension,@specifics,$do_default);
1.1362    raeburn  11658:     foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395     albertel 11659: 	my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738     albertel 11660: 	if ($pack_type eq 'default') {
                   11661: 	    $do_default=1;
                   11662: 	} elsif ($pack_type eq 'extension') {
                   11663: 	    push(@extension,[$package,$pack_type,$pack_part]);
1.885     albertel 11664: 	} elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848     albertel 11665: 	    # only look at packages defaults for packages that this id is
1.738     albertel 11666: 	    push(@specifics,[$package,$pack_type,$pack_part]);
                   11667: 	}
                   11668:     }
                   11669:     # first look for a package that matches the requested part id
                   11670:     foreach my $package (@specifics) {
                   11671: 	my (undef,$pack_type,$pack_part)=@{$package};
                   11672: 	next if ($pack_part ne $part);
                   11673: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   11674: 	    return $packagetab{"$pack_type&$name&default"};
                   11675: 	}
                   11676:     }
                   11677:     # look for any possible matching non extension_ package
                   11678:     foreach my $package (@specifics) {
                   11679: 	my (undef,$pack_type,$pack_part)=@{$package};
1.468     albertel 11680: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   11681: 	    return $packagetab{"$pack_type&$name&default"};
                   11682: 	}
1.585     albertel 11683: 	if ($pack_type eq 'part') { $pack_part='0'; }
1.468     albertel 11684: 	if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
                   11685: 	    return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395     albertel 11686: 	}
                   11687:     }
1.738     albertel 11688:     # look for any posible extension_ match
                   11689:     foreach my $package (@extension) {
                   11690: 	my ($package,$pack_type)=@{$package};
                   11691: 	if (defined($packagetab{"$pack_type&$name&default"})) {
                   11692: 	    return $packagetab{"$pack_type&$name&default"};
                   11693: 	}
                   11694: 	if (defined($packagetab{$package."&$name&default"})) {
                   11695: 	    return $packagetab{$package."&$name&default"};
                   11696: 	}
                   11697:     }
                   11698:     # look for a global default setting
                   11699:     if ($do_default && defined($packagetab{"default&$name&default"})) {
                   11700: 	return $packagetab{"default&$name&default"};
                   11701:     }
1.395     albertel 11702:     return undef;
                   11703: }
                   11704: 
1.334     albertel 11705: sub add_prefix_and_part {
                   11706:     my ($prefix,$part)=@_;
                   11707:     my $keyroot;
                   11708:     if (defined($prefix) && $prefix !~ /^__/) {
                   11709: 	# prefix that has a part already
                   11710: 	$keyroot=$prefix;
                   11711:     } elsif (defined($prefix)) {
                   11712: 	# prefix that is missing a part
                   11713: 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
                   11714:     } else {
                   11715: 	# no prefix at all
                   11716: 	if (defined($part)) { $keyroot='_'.$part; }
                   11717:     }
                   11718:     return $keyroot;
                   11719: }
                   11720: 
1.71      www      11721: # ---------------------------------------------------------------- Get metadata
                   11722: 
1.599     albertel 11723: my %metaentry;
1.1070    www      11724: my %importedpartids;
1.71      www      11725: sub metadata {
1.1362    raeburn  11726:     my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71      www      11727:     $uri=&declutter($uri);
1.288     albertel 11728:     # if it is a non metadata possible uri return quickly
1.529     albertel 11729:     if (($uri eq '') || 
                   11730: 	(($uri =~ m|^/*adm/|) && 
1.1343    raeburn  11731: 	     ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108    raeburn  11732:         ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924     albertel 11733: 	return undef;
                   11734:     }
1.1261    raeburn  11735:     if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv}) 
1.924     albertel 11736: 	&& &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468     albertel 11737: 	return undef;
1.288     albertel 11738:     }
1.73      www      11739:     my $filename=$uri;
                   11740:     $uri=~s/\.meta$//;
1.172     www      11741: #
                   11742: # Is the metadata already cached?
1.177     www      11743: # Look at timestamp of caching
1.172     www      11744: # Everything is cached by the main uri, libraries are never directly cached
                   11745: #
1.428     albertel 11746:     if (!defined($liburi)) {
1.599     albertel 11747: 	my ($result,$cached)=&is_cached_new('meta',$uri);
1.428     albertel 11748: 	if (defined($cached)) { return $result->{':'.$what}; }
                   11749:     }
1.1362    raeburn  11750: 
                   11751: #
                   11752: # If the uri is for an external tool the file from
                   11753: # which metadata should be retrieved depends on whether
                   11754: # the tool had been configured to be gradable (set in the Course
                   11755: # Editor or Resource Editor).
                   11756: #
                   11757: # If a valid symb has been included as the third arg in the call
                   11758: # to &metadata() that can be used to retrieve the value of
                   11759: # parameter_0_gradable set for the resource, and included in the
                   11760: # uploaded map containing the tool. The value is retrieved via
                   11761: # &EXT(), if a valid symb is available.  Otherwise the value of
                   11762: # gradable in the exttool_$marker.db file for the tool instance
1.1364    raeburn  11763: # is retrieved via &get().
                   11764: #
                   11765: # When lonuserstate::traceroute() calls lonnet::EXT() for 
                   11766: # hiddenresource and encrypturl (during course initialization)
                   11767: # the map-level parameter for resource.0.gradable included in the 
                   11768: # uploaded map containing the tool will not yet have been stored
                   11769: # in the user_course_parms.db file for the user's session, so in 
                   11770: # this case fall back to retrieving gradable status from the
                   11771: # exttool_$marker.db file.
1.1362    raeburn  11772: #
                   11773: # In order to avoid an infinite loop, &metadata() will return
                   11774: # before a call to &EXT(), if the uri is for an external tool
                   11775: # and the $what for which metadata is being requested is
                   11776: # parameter_0_gradable or 0_gradable.
                   11777: #
                   11778: 
                   11779:     if ($uri =~ /ext\.tool$/) {
                   11780:         if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
                   11781:             return;
                   11782:         } else {
                   11783:             my ($checked,$use_passback);
                   11784:             if ($toolsymb ne '') {
                   11785:                 (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364    raeburn  11786:                 if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362    raeburn  11787:                     $checked = 1;
                   11788:                     if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
                   11789:                         $use_passback = 1;
                   11790:                     }
                   11791:                 }
                   11792:             }
                   11793:             unless ($checked) {
                   11794:                 my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
                   11795:                 $marker=~s/\D//g;
1.1363    raeburn  11796:                 if ($marker) {
1.1362    raeburn  11797:                     my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
                   11798:                     $use_passback = $toolsettings{'gradable'};
                   11799:                 }
                   11800:             }
                   11801:             if ($use_passback) {
                   11802:                 $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
                   11803:             } else {
                   11804:                 $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
                   11805:             }
                   11806:         }
                   11807:     }
                   11808: 
1.428     albertel 11809:     {
1.1069    www      11810: # Imported parts would go here
1.1070    www      11811:         my %importedids=();
                   11812:         my @origfileimportpartids=();
1.1069    www      11813:         my $importedparts=0;
1.172     www      11814: #
                   11815: # Is this a recursive call for a library?
                   11816: #
1.599     albertel 11817: #	if (! exists($metacache{$uri})) {
                   11818: #	    $metacache{$uri}={};
                   11819: #	}
1.924     albertel 11820: 	my $cachetime = 60*60;
1.171     www      11821:         if ($liburi) {
                   11822: 	    $liburi=&declutter($liburi);
                   11823:             $filename=$liburi;
1.401     bowersj2 11824:         } else {
1.599     albertel 11825: 	    &devalidate_cache_new('meta',$uri);
                   11826: 	    undef(%metaentry);
1.401     bowersj2 11827: 	}
1.140     www      11828:         my %metathesekeys=();
1.73      www      11829:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489     albertel 11830: 	my $metastring;
1.1140    www      11831: 	if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929     albertel 11832: 	    my $which = &hreflocation('','/'.($liburi || $uri));
1.924     albertel 11833: 	    $metastring = 
1.929     albertel 11834: 		&Apache::lonnet::ssi_body($which,
1.924     albertel 11835: 					  ('grade_target' => 'meta'));
                   11836: 	    $cachetime = 1; # only want this cached in the child not long term
1.1108    raeburn  11837: 	} elsif (($uri !~ m -^(editupload)/-) && 
                   11838:                  ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543     albertel 11839: 	    my $file=&filelocation('',&clutter($filename));
1.599     albertel 11840: 	    #push(@{$metaentry{$uri.'.file'}},$file);
1.543     albertel 11841: 	    $metastring=&getfile($file);
1.489     albertel 11842: 	}
1.208     albertel 11843:         my $parser=HTML::LCParser->new(\$metastring);
1.71      www      11844:         my $token;
1.140     www      11845:         undef %metathesekeys;
1.71      www      11846:         while ($token=$parser->get_token) {
1.339     albertel 11847: 	    if ($token->[0] eq 'S') {
                   11848: 		if (defined($token->[2]->{'package'})) {
1.172     www      11849: #
                   11850: # This is a package - get package info
                   11851: #
1.339     albertel 11852: 		    my $package=$token->[2]->{'package'};
                   11853: 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   11854: 		    if (defined($token->[2]->{'id'})) { 
                   11855: 			$keyroot.='_'.$token->[2]->{'id'}; 
                   11856: 		    }
1.599     albertel 11857: 		    if ($metaentry{':packages'}) {
                   11858: 			$metaentry{':packages'}.=','.$package.$keyroot;
1.339     albertel 11859: 		    } else {
1.599     albertel 11860: 			$metaentry{':packages'}=$package.$keyroot;
1.339     albertel 11861: 		    }
1.736     albertel 11862: 		    foreach my $pack_entry (keys(%packagetab)) {
1.432     albertel 11863: 			my $part=$keyroot;
                   11864: 			$part=~s/^\_//;
1.736     albertel 11865: 			if ($pack_entry=~/^\Q$package\E\&/ || 
                   11866: 			    $pack_entry=~/^\Q$package\E_0\&/) {
                   11867: 			    my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395     albertel 11868: 			    # ignore package.tab specified default values
                   11869:                             # here &package_tab_default() will fetch those
                   11870: 			    if ($subp eq 'default') { next; }
1.736     albertel 11871: 			    my $value=$packagetab{$pack_entry};
1.432     albertel 11872: 			    my $unikey;
                   11873: 			    if ($pack =~ /_0$/) {
                   11874: 				$unikey='parameter_0_'.$name;
                   11875: 				$part=0;
                   11876: 			    } else {
                   11877: 				$unikey='parameter'.$keyroot.'_'.$name;
                   11878: 			    }
1.339     albertel 11879: 			    if ($subp eq 'display') {
                   11880: 				$value.=' [Part: '.$part.']';
                   11881: 			    }
1.599     albertel 11882: 			    $metaentry{':'.$unikey.'.part'}=$part;
1.395     albertel 11883: 			    $metathesekeys{$unikey}=1;
1.599     albertel 11884: 			    unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   11885: 				$metaentry{':'.$unikey.'.'.$subp}=$value;
1.339     albertel 11886: 			    }
1.599     albertel 11887: 			    if (defined($metaentry{':'.$unikey.'.default'})) {
                   11888: 				$metaentry{':'.$unikey}=
                   11889: 				    $metaentry{':'.$unikey.'.default'};
1.356     albertel 11890: 			    }
1.339     albertel 11891: 			}
                   11892: 		    }
                   11893: 		} else {
1.172     www      11894: #
                   11895: # This is not a package - some other kind of start tag
1.339     albertel 11896: #
                   11897: 		    my $entry=$token->[1];
1.1068    www      11898: 		    my $unikey='';
1.175     www      11899: 
1.339     albertel 11900: 		    if ($entry eq 'import') {
1.175     www      11901: #
                   11902: # Importing a library here
1.339     albertel 11903: #
1.1067    www      11904:                         my $location=$parser->get_text('/import');
                   11905:                         my $dir=$filename;
                   11906:                         $dir=~s|[^/]*$||;
                   11907:                         $location=&filelocation($dir,$location);
1.1069    www      11908:                        
1.1068    www      11909:                         my $importmode=$token->[2]->{'importmode'};
                   11910:                         if ($importmode eq 'problem') {
1.1069    www      11911: # Import as problem/response
1.1068    www      11912:                            $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   11913:                         } elsif ($importmode eq 'part') {
                   11914: # Import as part(s)
1.1069    www      11915:                            $importedparts=1;
                   11916: # We need to get the original file and the imported file to get the part order correct
                   11917: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
                   11918: # Load and inspect original file
1.1070    www      11919:                            if ($#origfileimportpartids<0) {
                   11920:                               undef(%importedpartids);
                   11921:                               my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
                   11922:                               my $origfile=&getfile($origfilelocation);
                   11923:                               @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
                   11924:                            }
                   11925: 
1.1069    www      11926: # Load and inspect imported file
                   11927:                            my $impfile=&getfile($location);
                   11928:                            my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
                   11929:                            if ($#impfilepartids>=0) {
                   11930: # This problem had parts
1.1070    www      11931:                                $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069    www      11932:                            } else {
                   11933: # Importing by turning a single problem into a problem part
                   11934: # It gets the import-tags ID as part-ID
                   11935:                                $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070    www      11936:                                $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069    www      11937:                            }
1.1068    www      11938:                         } else {
                   11939: # Normal import
                   11940:                            $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   11941:                            if (defined($token->[2]->{'id'})) {
                   11942:                               $unikey.='_'.$token->[2]->{'id'};
                   11943:                            }
1.1067    www      11944:                         }
                   11945: 
1.339     albertel 11946: 			if ($depthcount<20) {
1.736     albertel 11947: 			    my $metadata = 
1.1362    raeburn  11948: 				&metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736     albertel 11949: 					  $depthcount+1);
                   11950: 			    foreach my $meta (split(',',$metadata)) {
                   11951: 				$metaentry{':'.$meta}=$metaentry{':'.$meta};
                   11952: 				$metathesekeys{$meta}=1;
1.339     albertel 11953: 			    }
1.1068    www      11954: 			
                   11955:                         }
1.1067    www      11956: 		    } else {
                   11957: #
                   11958: # Not importing, some other kind of non-package, non-library start tag
                   11959: # 
                   11960:                         $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   11961:                         if (defined($token->[2]->{'id'})) {
                   11962:                             $unikey.='_'.$token->[2]->{'id'};
                   11963:                         }
1.339     albertel 11964: 			if (defined($token->[2]->{'name'})) { 
                   11965: 			    $unikey.='_'.$token->[2]->{'name'}; 
                   11966: 			}
                   11967: 			$metathesekeys{$unikey}=1;
1.736     albertel 11968: 			foreach my $param (@{$token->[3]}) {
                   11969: 			    $metaentry{':'.$unikey.'.'.$param} =
                   11970: 				$token->[2]->{$param};
1.339     albertel 11971: 			}
                   11972: 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599     albertel 11973: 			my $default=$metaentry{':'.$unikey.'.default'};
1.339     albertel 11974: 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
                   11975: 		 # only ws inside the tag, and not in default, so use default
                   11976: 		 # as value
1.599     albertel 11977: 			    $metaentry{':'.$unikey}=$default;
1.908     albertel 11978: 			} elsif ( $internaltext =~ /\S/ ) {
                   11979: 		  # something interesting inside the tag
                   11980: 			    $metaentry{':'.$unikey}=$internaltext;
1.339     albertel 11981: 			} else {
1.908     albertel 11982: 		  # no interesting values, don't set a default
1.339     albertel 11983: 			}
1.172     www      11984: # end of not-a-package not-a-library import
1.339     albertel 11985: 		    }
1.172     www      11986: # end of not-a-package start tag
1.339     albertel 11987: 		}
1.172     www      11988: # the next is the end of "start tag"
1.339     albertel 11989: 	    }
                   11990: 	}
1.483     albertel 11991: 	my ($extension) = ($uri =~ /\.(\w+)$/);
1.883     albertel 11992: 	$extension = lc($extension);
                   11993: 	if ($extension eq 'htm') { $extension='html'; }
                   11994: 
1.737     albertel 11995: 	foreach my $key (keys(%packagetab)) {
1.483     albertel 11996: 	    #no specific packages #how's our extension
                   11997: 	    if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488     albertel 11998: 	    &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483     albertel 11999: 					 \%metathesekeys);
                   12000: 	}
1.883     albertel 12001: 
                   12002: 	if (!exists($metaentry{':packages'})
                   12003: 	    || $packagetab{"import_defaults&extension_$extension"}) {
1.737     albertel 12004: 	    foreach my $key (keys(%packagetab)) {
1.483     albertel 12005: 		#no specific packages well let's get default then
                   12006: 		if ($key!~/^default&/) { next; }
1.488     albertel 12007: 		&metadata_create_package_def($uri,$key,'default',
1.483     albertel 12008: 					     \%metathesekeys);
                   12009: 	    }
                   12010: 	}
1.338     www      12011: # are there custom rights to evaluate
1.599     albertel 12012: 	if ($metaentry{':copyright'} eq 'custom') {
1.339     albertel 12013: 
1.338     www      12014:     #
                   12015:     # Importing a rights file here
1.339     albertel 12016:     #
                   12017: 	    unless ($depthcount) {
1.599     albertel 12018: 		my $location=$metaentry{':customdistributionfile'};
1.339     albertel 12019: 		my $dir=$filename;
                   12020: 		$dir=~s|[^/]*$||;
                   12021: 		$location=&filelocation($dir,$location);
1.736     albertel 12022: 		my $rights_metadata =
1.1362    raeburn  12023: 		    &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736     albertel 12024: 			      $depthcount+1);
                   12025: 		foreach my $rights (split(',',$rights_metadata)) {
                   12026: 		    #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
                   12027: 		    $metathesekeys{$rights}=1;
1.339     albertel 12028: 		}
                   12029: 	    }
                   12030: 	}
1.737     albertel 12031: 	# uniqifiy package listing
                   12032: 	my %seen;
                   12033: 	my @uniq_packages =
                   12034: 	    grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
                   12035: 	$metaentry{':packages'} = join(',',@uniq_packages);
                   12036: 
1.1070    www      12037:         if ($importedparts) {
                   12038: # We had imported parts and need to rebuild partorder
                   12039:            $metaentry{':partorder'}='';
                   12040:            $metathesekeys{'partorder'}=1;
                   12041:            for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
                   12042:                if ($origfileimportpartids[$index] eq 'part') {
                   12043: # original part, part of the problem
                   12044:                   $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
                   12045:                } else {
                   12046: # we have imported parts at this position
                   12047:                   $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
                   12048:                }
                   12049:            }
                   12050:            $metaentry{':partorder'}=~s/^\,//;
                   12051:         }
                   12052: 
1.737     albertel 12053: 	$metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599     albertel 12054: 	&metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274    raeburn  12055: 	$metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.924     albertel 12056: 	&do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177     www      12057: # this is the end of "was not already recently cached
1.71      www      12058:     }
1.599     albertel 12059:     return $metaentry{':'.$what};
1.261     albertel 12060: }
                   12061: 
1.488     albertel 12062: sub metadata_create_package_def {
1.483     albertel 12063:     my ($uri,$key,$package,$metathesekeys)=@_;
                   12064:     my ($pack,$name,$subp)=split(/\&/,$key);
                   12065:     if ($subp eq 'default') { next; }
                   12066:     
1.599     albertel 12067:     if (defined($metaentry{':packages'})) {
                   12068: 	$metaentry{':packages'}.=','.$package;
1.483     albertel 12069:     } else {
1.599     albertel 12070: 	$metaentry{':packages'}=$package;
1.483     albertel 12071:     }
                   12072:     my $value=$packagetab{$key};
                   12073:     my $unikey;
                   12074:     $unikey='parameter_0_'.$name;
1.599     albertel 12075:     $metaentry{':'.$unikey.'.part'}=0;
1.483     albertel 12076:     $$metathesekeys{$unikey}=1;
1.599     albertel 12077:     unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
                   12078: 	$metaentry{':'.$unikey.'.'.$subp}=$value;
1.483     albertel 12079:     }
1.599     albertel 12080:     if (defined($metaentry{':'.$unikey.'.default'})) {
                   12081: 	$metaentry{':'.$unikey}=
                   12082: 	    $metaentry{':'.$unikey.'.default'};
1.483     albertel 12083:     }
                   12084: }
                   12085: 
1.261     albertel 12086: sub metadata_generate_part0 {
                   12087:     my ($metadata,$metacache,$uri) = @_;
                   12088:     my %allnames;
1.737     albertel 12089:     foreach my $metakey (keys(%$metadata)) {
1.261     albertel 12090: 	if ($metakey=~/^parameter\_(.*)/) {
1.428     albertel 12091: 	  my $part=$$metacache{':'.$metakey.'.part'};
                   12092: 	  my $name=$$metacache{':'.$metakey.'.name'};
1.356     albertel 12093: 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261     albertel 12094: 	    $allnames{$name}=$part;
                   12095: 	  }
                   12096: 	}
                   12097:     }
                   12098:     foreach my $name (keys(%allnames)) {
                   12099:       $$metadata{"parameter_0_$name"}=1;
1.428     albertel 12100:       my $key=":parameter_0_$name";
1.261     albertel 12101:       $$metacache{"$key.part"}='0';
                   12102:       $$metacache{"$key.name"}=$name;
1.428     albertel 12103:       $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261     albertel 12104: 					   $allnames{$name}.'_'.$name.
                   12105: 					   '.type'};
1.428     albertel 12106:       my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261     albertel 12107: 			     '.display'};
1.644     www      12108:       my $expr='[Part: '.$allnames{$name}.']';
1.479     albertel 12109:       $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261     albertel 12110:       $$metacache{"$key.display"}=$olddis;
                   12111:     }
1.71      www      12112: }
                   12113: 
1.764     albertel 12114: # ------------------------------------------------------ Devalidate title cache
                   12115: 
                   12116: sub devalidate_title_cache {
                   12117:     my ($url)=@_;
                   12118:     if (!$env{'request.course.id'}) { return; }
                   12119:     my $symb=&symbread($url);
                   12120:     if (!$symb) { return; }
                   12121:     my $key=$env{'request.course.id'}."\0".$symb;
                   12122:     &devalidate_cache_new('title',$key);
                   12123: }
                   12124: 
1.1014    droeschl 12125: # ------------------------------------------------- Get the title of a course
                   12126: 
                   12127: sub current_course_title {
                   12128:     return $env{ 'course.' . $env{'request.course.id'} . '.description' };
                   12129: }
1.301     www      12130: # ------------------------------------------------- Get the title of a resource
                   12131: 
                   12132: sub gettitle {
                   12133:     my $urlsymb=shift;
                   12134:     my $symb=&symbread($urlsymb);
1.534     albertel 12135:     if ($symb) {
1.620     albertel 12136: 	my $key=$env{'request.course.id'}."\0".$symb;
1.599     albertel 12137: 	my ($result,$cached)=&is_cached_new('title',$key);
1.575     albertel 12138: 	if (defined($cached)) { 
                   12139: 	    return $result;
                   12140: 	}
1.534     albertel 12141: 	my ($map,$resid,$url)=&decode_symb($symb);
                   12142: 	my $title='';
1.907     albertel 12143: 	if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
                   12144: 	    $title = $env{'course.'.$env{'request.course.id'}.'.description'};
                   12145: 	} else {
                   12146: 	    if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
                   12147: 		    &GDBM_READER(),0640)) {
                   12148: 		my $mapid=$bighash{'map_pc_'.&clutter($map)};
                   12149: 		$title=$bighash{'title_'.$mapid.'.'.$resid};
                   12150: 		untie(%bighash);
                   12151: 	    }
1.534     albertel 12152: 	}
                   12153: 	$title=~s/\&colon\;/\:/gs;
                   12154: 	if ($title) {
1.1159    www      12155: # Remember both $symb and $title for dynamic metadata
                   12156:             $accesshash{$symb.'___crstitle'}=$title;
1.1161    www      12157:             $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159    www      12158: # Cache this title and then return it
1.599     albertel 12159: 	    return &do_cache_new('title',$key,$title,600);
1.534     albertel 12160: 	}
                   12161: 	$urlsymb=$url;
                   12162:     }
                   12163:     my $title=&metadata($urlsymb,'title');
                   12164:     if (!$title) { $title=(split('/',$urlsymb))[-1]; }    
                   12165:     return $title;
1.301     www      12166: }
1.613     albertel 12167: 
1.614     albertel 12168: sub get_slot {
                   12169:     my ($which,$cnum,$cdom)=@_;
                   12170:     if (!$cnum || !$cdom) {
1.790     albertel 12171: 	(undef,my $courseid)=&whichuser();
1.620     albertel 12172: 	$cdom=$env{'course.'.$courseid.'.domain'};
                   12173: 	$cnum=$env{'course.'.$courseid.'.num'};
1.614     albertel 12174:     }
1.703     albertel 12175:     my $key=join("\0",'slots',$cdom,$cnum,$which);
                   12176:     my %slotinfo;
                   12177:     if (exists($remembered{$key})) {
                   12178: 	$slotinfo{$which} = $remembered{$key};
                   12179:     } else {
                   12180: 	%slotinfo=&get('slots',[$which],$cdom,$cnum);
                   12181: 	&Apache::lonhomework::showhash(%slotinfo);
                   12182: 	my ($tmp)=keys(%slotinfo);
                   12183: 	if ($tmp=~/^error:/) { return (); }
                   12184: 	$remembered{$key} = $slotinfo{$which};
                   12185:     }
1.616     albertel 12186:     if (ref($slotinfo{$which}) eq 'HASH') {
                   12187: 	return %{$slotinfo{$which}};
                   12188:     }
                   12189:     return $slotinfo{$which};
1.614     albertel 12190: }
1.1150    raeburn  12191: 
                   12192: sub get_reservable_slots {
                   12193:     my ($cnum,$cdom,$uname,$udom) = @_;
                   12194:     my $now = time;
                   12195:     my $reservable_info;
                   12196:     my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
                   12197:     if (exists($remembered{$key})) {
                   12198:         $reservable_info = $remembered{$key};
                   12199:     } else {
                   12200:         my %resv;
                   12201:         ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
                   12202:         &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
                   12203:         $reservable_info = \%resv;
                   12204:         $remembered{$key} = $reservable_info;
                   12205:     }
                   12206:     return $reservable_info;
                   12207: }
                   12208: 
                   12209: sub get_course_slots {
                   12210:     my ($cnum,$cdom) = @_;
                   12211:     my $hashid=$cnum.':'.$cdom;
                   12212:     my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
                   12213:     if (defined($cached)) {
                   12214:         if (ref($result) eq 'HASH') {
                   12215:             return %{$result};
                   12216:         }
                   12217:     } else {
                   12218:         my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
                   12219:         my ($tmp) = keys(%slots);
                   12220:         if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219    raeburn  12221:             &do_cache_new('allslots',$hashid,\%slots,600);
1.1150    raeburn  12222:             return %slots;
                   12223:         }
                   12224:     }
                   12225:     return;
                   12226: }
                   12227: 
                   12228: sub devalidate_slots_cache {
                   12229:     my ($cnum,$cdom)=@_;
                   12230:     my $hashid=$cnum.':'.$cdom;
                   12231:     &devalidate_cache_new('allslots',$hashid);
                   12232: }
                   12233: 
1.1181    raeburn  12234: sub get_coursechange {
                   12235:     my ($cdom,$cnum) = @_;
                   12236:     if ($cdom eq '' || $cnum eq '') {
                   12237:         return unless ($env{'request.course.id'});
                   12238:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   12239:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   12240:     }
                   12241:     my $hashid=$cdom.'_'.$cnum;
                   12242:     my ($change,$cached)=&is_cached_new('crschange',$hashid);
                   12243:     if ((defined($cached)) && ($change ne '')) {
                   12244:         return $change;
                   12245:     } else {
                   12246:         my %crshash;
                   12247:         %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
                   12248:         if ($crshash{'internal.contentchange'} eq '') {
                   12249:             $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
                   12250:             if ($change eq '') {
                   12251:                 %crshash = &get('environment',['internal.created'],$cdom,$cnum);
                   12252:                 $change = $crshash{'internal.created'};
                   12253:             }
                   12254:         } else {
                   12255:             $change = $crshash{'internal.contentchange'};
                   12256:         }
                   12257:         my $cachetime = 600;
                   12258:         &do_cache_new('crschange',$hashid,$change,$cachetime);
                   12259:     }
                   12260:     return $change;
                   12261: }
                   12262: 
                   12263: sub devalidate_coursechange_cache {
                   12264:     my ($cnum,$cdom)=@_;
                   12265:     my $hashid=$cnum.':'.$cdom;
                   12266:     &devalidate_cache_new('crschange',$hashid);
                   12267: }
                   12268: 
1.31      www      12269: # ------------------------------------------------- Update symbolic store links
                   12270: 
                   12271: sub symblist {
                   12272:     my ($mapname,%newhash)=@_;
1.438     www      12273:     $mapname=&deversion(&declutter($mapname));
1.31      www      12274:     my %hash;
1.620     albertel 12275:     if (($env{'request.course.fn'}) && (%newhash)) {
                   12276:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 12277:                       &GDBM_WRCREAT(),0640)) {
1.1000    raeburn  12278: 	    foreach my $url (keys(%newhash)) {
1.711     albertel 12279: 		next if ($url eq 'last_known'
                   12280: 			 && $env{'form.no_update_last_known'});
                   12281: 		$hash{declutter($url)}=&encode_symb($mapname,
                   12282: 						    $newhash{$url}->[1],
                   12283: 						    $newhash{$url}->[0]);
1.191     harris41 12284:             }
1.31      www      12285:             if (untie(%hash)) {
                   12286: 		return 'ok';
                   12287:             }
                   12288:         }
                   12289:     }
                   12290:     return 'error';
1.212     www      12291: }
                   12292: 
                   12293: # --------------------------------------------------------------- Verify a symb
                   12294: 
                   12295: sub symbverify {
1.1190    raeburn  12296:     my ($symb,$thisurl,$encstate)=@_;
1.510     www      12297:     my $thisfn=$thisurl;
1.439     www      12298:     $thisfn=&declutter($thisfn);
1.215     www      12299: # direct jump to resource in page or to a sequence - will construct own symbs
                   12300:     if ($thisfn=~/\.(page|sequence)$/) { return 1; }
                   12301: # check URL part
1.409     www      12302:     my ($map,$resid,$url)=&decode_symb($symb);
1.439     www      12303: 
1.431     www      12304:     unless ($url eq $thisfn) { return 0; }
1.213     www      12305: 
1.216     www      12306:     $symb=&symbclean($symb);
1.510     www      12307:     $thisurl=&deversion($thisurl);
1.439     www      12308:     $thisfn=&deversion($thisfn);
1.213     www      12309: 
                   12310:     my %bighash;
                   12311:     my $okay=0;
1.431     www      12312: 
1.620     albertel 12313:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 12314:                             &GDBM_READER(),0640)) {
1.1204    raeburn  12315:         my $noclutter;
1.1032    raeburn  12316:         if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
                   12317:             $thisurl =~ s/\?.+$//;
1.1204    raeburn  12318:             if ($map =~ m{^uploaded/.+\.page$}) {
                   12319:                 $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
                   12320:                 $thisurl =~ s{^\Qhttp://https://\E}{https://};
                   12321:                 $noclutter = 1;
                   12322:             }
                   12323:         }
                   12324:         my $ids;
                   12325:         if ($noclutter) {
                   12326:             $ids=$bighash{'ids_'.$thisurl};
                   12327:         } else {
                   12328:             $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032    raeburn  12329:         }
1.1102    raeburn  12330:         unless ($ids) {
                   12331:             my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;  
                   12332:             $ids=$bighash{$idkey};
1.216     www      12333:         }
                   12334:         if ($ids) {
                   12335: # ------------------------------------------------------------------- Has ID(s)
1.1202    raeburn  12336:             if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203    raeburn  12337:                 $symb =~ s/\?.+$//;
1.1202    raeburn  12338:             }
1.800     albertel 12339: 	    foreach my $id (split(/\,/,$ids)) {
                   12340: 	       my ($mapid,$resid)=split(/\./,$id);
1.216     www      12341:                if (
                   12342:   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190    raeburn  12343:    eq $symb) {
                   12344:                    if (ref($encstate)) {
                   12345:                        $$encstate = $bighash{'encrypted_'.$id};
                   12346:                    }
1.620     albertel 12347: 		   if (($env{'request.role.adv'}) ||
1.1101    raeburn  12348: 		       ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
                   12349:                        ($thisurl eq '/adm/navmaps')) {
1.1190    raeburn  12350: 		       $okay=1;
1.1202    raeburn  12351:                        last;
1.582     albertel 12352: 		   }
                   12353: 	       }
1.216     www      12354: 	   }
                   12355:         }
1.213     www      12356: 	untie(%bighash);
                   12357:     }
                   12358:     return $okay;
1.31      www      12359: }
                   12360: 
1.210     www      12361: # --------------------------------------------------------------- Clean-up symb
                   12362: 
                   12363: sub symbclean {
                   12364:     my $symb=shift;
1.568     albertel 12365:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210     www      12366: # remove version from map
                   12367:     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215     www      12368: 
1.210     www      12369: # remove version from URL
                   12370:     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213     www      12371: 
1.507     www      12372: # remove wrapper
                   12373: 
1.510     www      12374:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694     albertel 12375:     $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210     www      12376:     return $symb;
1.409     www      12377: }
                   12378: 
                   12379: # ---------------------------------------------- Split symb to find map and url
1.429     albertel 12380: 
                   12381: sub encode_symb {
                   12382:     my ($map,$resid,$url)=@_;
                   12383:     return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
                   12384: }
1.409     www      12385: 
                   12386: sub decode_symb {
1.568     albertel 12387:     my $symb=shift;
                   12388:     if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
                   12389:     my ($map,$resid,$url)=split(/___/,$symb);
1.413     www      12390:     return (&fixversion($map),$resid,&fixversion($url));
                   12391: }
                   12392: 
                   12393: sub fixversion {
                   12394:     my $fn=shift;
1.609     banghart 12395:     if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435     www      12396:     my %bighash;
                   12397:     my $uri=&clutter($fn);
1.620     albertel 12398:     my $key=$env{'request.course.id'}.'_'.$uri;
1.440     www      12399: # is this cached?
1.599     albertel 12400:     my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440     www      12401:     if (defined($cached)) { return $result; }
                   12402: # unfortunately not cached, or expired
1.620     albertel 12403:     if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440     www      12404: 	    &GDBM_READER(),0640)) {
                   12405:  	if ($bighash{'version_'.$uri}) {
                   12406:  	    my $version=$bighash{'version_'.$uri};
1.444     www      12407:  	    unless (($version eq 'mostrecent') || 
                   12408: 		    ($version==&getversion($uri))) {
1.440     www      12409:  		$uri=~s/\.(\w+)$/\.$version\.$1/;
                   12410:  	    }
                   12411:  	}
                   12412:  	untie %bighash;
1.413     www      12413:     }
1.599     albertel 12414:     return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438     www      12415: }
                   12416: 
                   12417: sub deversion {
                   12418:     my $url=shift;
                   12419:     $url=~s/\.\d+\.(\w+)$/\.$1/;
                   12420:     return $url;
1.210     www      12421: }
                   12422: 
1.31      www      12423: # ------------------------------------------------------ Return symb list entry
                   12424: 
                   12425: sub symbread {
1.1282    raeburn  12426:     my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1265    raeburn  12427:     my $cache_str='request.symbread.cached.'.$thisfn;
1.1282    raeburn  12428:     if (defined($env{$cache_str})) {
                   12429:         if ($ignorecachednull) {
                   12430:             return $env{$cache_str} unless ($env{$cache_str} eq '');
                   12431:         } else {
                   12432:             return $env{$cache_str};
                   12433:         }
                   12434:     }
1.242     www      12435: # no filename provided? try from environment
1.1265    raeburn  12436:     unless ($thisfn) {
1.620     albertel 12437:         if ($env{'request.symb'}) {
                   12438: 	    return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539     albertel 12439: 	}
1.620     albertel 12440: 	$thisfn=$env{'request.filename'};
1.44      www      12441:     }
1.569     albertel 12442:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242     www      12443: # is that filename actually a symb? Verify, clean, and return
                   12444:     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539     albertel 12445: 	if (&symbverify($thisfn,$1)) {
1.620     albertel 12446: 	    return $env{$cache_str}=&symbclean($thisfn);
1.539     albertel 12447: 	}
1.242     www      12448:     }
1.44      www      12449:     $thisfn=declutter($thisfn);
1.31      www      12450:     my %hash;
1.37      www      12451:     my %bighash;
                   12452:     my $syval='';
1.620     albertel 12453:     if (($env{'request.course.fn'}) && ($thisfn)) {
1.481     raeburn  12454:         my $targetfn = $thisfn;
1.609     banghart 12455:         if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481     raeburn  12456:             $targetfn = 'adm/wrapper/'.$thisfn;
                   12457:         }
1.687     albertel 12458: 	if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
                   12459: 	    $targetfn=$1;
                   12460: 	}
1.620     albertel 12461:         if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256     albertel 12462:                       &GDBM_READER(),0640)) {
1.481     raeburn  12463: 	    $syval=$hash{$targetfn};
1.37      www      12464:             untie(%hash);
                   12465:         }
                   12466: # ---------------------------------------------------------- There was an entry
                   12467:         if ($syval) {
1.601     albertel 12468: 	    #unless ($syval=~/\_\d+$/) {
1.620     albertel 12469: 		#unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949     raeburn  12470: 		    #&appenv({'request.ambiguous' => $thisfn});
1.620     albertel 12471: 		    #return $env{$cache_str}='';
1.601     albertel 12472: 		#}    
                   12473: 		#$syval.=$1;
                   12474: 	    #}
1.37      www      12475:         } else {
                   12476: # ------------------------------------------------------- Was not in symb table
1.620     albertel 12477:            if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256     albertel 12478:                             &GDBM_READER(),0640)) {
1.37      www      12479: # ---------------------------------------------- Get ID(s) for current resource
1.280     www      12480:               my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65      www      12481:               unless ($ids) { 
                   12482:                  $ids=$bighash{'ids_/'.$thisfn};
1.242     www      12483:               }
                   12484:               unless ($ids) {
                   12485: # alias?
                   12486: 		  $ids=$bighash{'mapalias_'.$thisfn};
1.65      www      12487:               }
1.37      www      12488:               if ($ids) {
                   12489: # ------------------------------------------------------------------- Has ID(s)
                   12490:                  my @possibilities=split(/\,/,$ids);
1.39      www      12491:                  if ($#possibilities==0) {
                   12492: # ----------------------------------------------- There is only one possibility
1.37      www      12493: 		     my ($mapid,$resid)=split(/\./,$ids);
1.626     albertel 12494: 		     $syval=&encode_symb($bighash{'map_id_'.$mapid},
                   12495: 						    $resid,$thisfn);
1.1282    raeburn  12496:                      if (ref($possibles) eq 'HASH') {
                   12497:                          $possibles->{$syval} = 1;    
                   12498:                      }
                   12499:                      if ($checkforblock) {
                   12500:                          my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
                   12501:                          if (@blockers) {
                   12502:                              $syval = '';
                   12503:                              return;
                   12504:                          }
                   12505:                      }
                   12506:                  } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) { 
1.39      www      12507: # ------------------------------------------ There is more than one possibility
                   12508:                      my $realpossible=0;
1.800     albertel 12509:                      foreach my $id (@possibilities) {
                   12510: 			 my $file=$bighash{'src_'.$id};
1.1282    raeburn  12511:                          my $canaccess;
                   12512:                          if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
                   12513:                              $canaccess = 1;
                   12514:                          } else { 
                   12515:                              $canaccess = &allowed('bre',$file);
                   12516:                          }
                   12517:                          if ($canaccess) {
                   12518:          		     my ($mapid,$resid)=split(/\./,$id);
                   12519:                              if ($bighash{'map_type_'.$mapid} ne 'page') {
                   12520:                                  my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
                   12521: 						             $resid,$thisfn);
                   12522:                                  if (ref($possibles) eq 'HASH') {
                   12523:                                      $possibles->{$syval} = 1;
                   12524:                                  }
                   12525:                                  if ($checkforblock) {
                   12526:                                      my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
                   12527:                                      unless (@blockers > 0) {
                   12528:                                          $syval = $poss_syval;
                   12529:                                          $realpossible++;
                   12530:                                      }
                   12531:                                  } else {
                   12532:                                      $syval = $poss_syval;
                   12533:                                      $realpossible++;
                   12534:                                  }
                   12535:                              }
1.39      www      12536: 			 }
1.191     harris41 12537:                      }
1.39      www      12538: 		     if ($realpossible!=1) { $syval=''; }
1.249     www      12539:                  } else {
                   12540:                      $syval='';
1.37      www      12541:                  }
                   12542: 	      }
1.1282    raeburn  12543:               untie(%bighash);
1.481     raeburn  12544:            }
1.31      www      12545:         }
1.62      www      12546:         if ($syval) {
1.620     albertel 12547: 	    return $env{$cache_str}=$syval;
1.62      www      12548:         }
1.31      www      12549:     }
1.949     raeburn  12550:     &appenv({'request.ambiguous' => $thisfn});
1.620     albertel 12551:     return $env{$cache_str}='';
1.31      www      12552: }
                   12553: 
                   12554: # ---------------------------------------------------------- Return random seed
                   12555: 
1.32      www      12556: sub numval {
                   12557:     my $txt=shift;
                   12558:     $txt=~tr/A-J/0-9/;
                   12559:     $txt=~tr/a-j/0-9/;
                   12560:     $txt=~tr/K-T/0-9/;
                   12561:     $txt=~tr/k-t/0-9/;
                   12562:     $txt=~tr/U-Z/0-5/;
                   12563:     $txt=~tr/u-z/0-5/;
                   12564:     $txt=~s/\D//g;
1.564     albertel 12565:     if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32      www      12566:     return int($txt);
1.368     albertel 12567: }
                   12568: 
1.484     albertel 12569: sub numval2 {
                   12570:     my $txt=shift;
                   12571:     $txt=~tr/A-J/0-9/;
                   12572:     $txt=~tr/a-j/0-9/;
                   12573:     $txt=~tr/K-T/0-9/;
                   12574:     $txt=~tr/k-t/0-9/;
                   12575:     $txt=~tr/U-Z/0-5/;
                   12576:     $txt=~tr/u-z/0-5/;
                   12577:     $txt=~s/\D//g;
                   12578:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   12579:     my $total;
                   12580:     foreach my $val (@txts) { $total+=$val; }
1.564     albertel 12581:     if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484     albertel 12582:     return int($total);
                   12583: }
                   12584: 
1.575     albertel 12585: sub numval3 {
                   12586:     use integer;
                   12587:     my $txt=shift;
                   12588:     $txt=~tr/A-J/0-9/;
                   12589:     $txt=~tr/a-j/0-9/;
                   12590:     $txt=~tr/K-T/0-9/;
                   12591:     $txt=~tr/k-t/0-9/;
                   12592:     $txt=~tr/U-Z/0-5/;
                   12593:     $txt=~tr/u-z/0-5/;
                   12594:     $txt=~s/\D//g;
                   12595:     my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
                   12596:     my $total;
                   12597:     foreach my $val (@txts) { $total+=$val; }
                   12598:     if ($_64bit) { $total=(($total<<32)>>32); }
                   12599:     return $total;
                   12600: }
                   12601: 
1.675     albertel 12602: sub digest {
                   12603:     my ($data)=@_;
                   12604:     my $digest=&Digest::MD5::md5($data);
                   12605:     my ($a,$b,$c,$d)=unpack("iiii",$digest);
                   12606:     my ($e,$f);
                   12607:     {
                   12608:         use integer;
                   12609:         $e=($a+$b);
                   12610:         $f=($c+$d);
                   12611:         if ($_64bit) {
                   12612:             $e=(($e<<32)>>32);
                   12613:             $f=(($f<<32)>>32);
                   12614:         }
                   12615:     }
                   12616:     if (wantarray) {
                   12617: 	return ($e,$f);
                   12618:     } else {
                   12619: 	my $g;
                   12620: 	{
                   12621: 	    use integer;
                   12622: 	    $g=($e+$f);
                   12623: 	    if ($_64bit) {
                   12624: 		$g=(($g<<32)>>32);
                   12625: 	    }
                   12626: 	}
                   12627: 	return $g;
                   12628:     }
                   12629: }
                   12630: 
1.368     albertel 12631: sub latest_rnd_algorithm_id {
1.675     albertel 12632:     return '64bit5';
1.366     albertel 12633: }
1.32      www      12634: 
1.503     albertel 12635: sub get_rand_alg {
                   12636:     my ($courseid)=@_;
1.790     albertel 12637:     if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503     albertel 12638:     if ($courseid) {
1.620     albertel 12639: 	return $env{"course.$courseid.rndseed"};
1.503     albertel 12640:     }
                   12641:     return &latest_rnd_algorithm_id();
                   12642: }
                   12643: 
1.562     albertel 12644: sub validCODE {
                   12645:     my ($CODE)=@_;
                   12646:     if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
                   12647:     return 0;
                   12648: }
                   12649: 
1.491     albertel 12650: sub getCODE {
1.620     albertel 12651:     if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618     albertel 12652:     if ( (defined($Apache::lonhomework::parsing_a_problem) ||
                   12653: 	  defined($Apache::lonhomework::parsing_a_task) ) &&
                   12654: 	 &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491     albertel 12655: 	return $Apache::lonhomework::history{'resource.CODE'};
                   12656:     }
                   12657:     return undef;
                   12658: }
1.1133    foxr     12659: #
                   12660: #  Determines the random seed for a specific context:
                   12661: #
                   12662: # parameters:
                   12663: #   symb      - in course context the symb for the seed.
                   12664: #   course_id - The course id of the form domain_coursenum.
                   12665: #   domain    - Domain for the user.
                   12666: #   course    - Course for the user.
                   12667: #   cenv      - environment of the course.
                   12668: #
                   12669: # NOTE:
                   12670: #   All parameters are picked out of the environment if missing
                   12671: #   or not defined.
                   12672: #   If a symb cannot be determined the current time is used instead.
                   12673: #
                   12674: #  For a given well defined symb, courside, domain, username,
                   12675: #  and course environment, the seed is reproducible.
                   12676: #
1.31      www      12677: sub rndseed {
1.1133    foxr     12678:     my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790     albertel 12679:     my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896     albertel 12680:     if (!defined($symb)) {
1.366     albertel 12681: 	unless ($symb=$wsymb) { return time; }
                   12682:     }
1.1146    foxr     12683:     if (!defined $courseid) { 
                   12684: 	$courseid=$wcourseid; 
                   12685:     }
                   12686:     if (!defined $domain) { $domain=$wdomain; }
                   12687:     if (!defined $username) { $username=$wusername }
1.1133    foxr     12688: 
                   12689:     my $which;
                   12690:     if (defined($cenv->{'rndseed'})) {
                   12691: 	$which = $cenv->{'rndseed'};
                   12692:     } else {
                   12693: 	$which =&get_rand_alg($courseid);
                   12694:     }
1.491     albertel 12695:     if (defined(&getCODE())) {
1.1133    foxr     12696: 
1.675     albertel 12697: 	if ($which eq '64bit5') {
                   12698: 	    return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
                   12699: 	} elsif ($which eq '64bit4') {
1.575     albertel 12700: 	    return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
                   12701: 	} else {
                   12702: 	    return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
                   12703: 	}
1.675     albertel 12704:     } elsif ($which eq '64bit5') {
                   12705: 	return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575     albertel 12706:     } elsif ($which eq '64bit4') {
                   12707: 	return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501     albertel 12708:     } elsif ($which eq '64bit3') {
                   12709: 	return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443     albertel 12710:     } elsif ($which eq '64bit2') {
                   12711: 	return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366     albertel 12712:     } elsif ($which eq '64bit') {
                   12713: 	return &rndseed_64bit($symb,$courseid,$domain,$username);
                   12714:     }
                   12715:     return &rndseed_32bit($symb,$courseid,$domain,$username);
                   12716: }
                   12717: 
                   12718: sub rndseed_32bit {
                   12719:     my ($symb,$courseid,$domain,$username)=@_;
                   12720:     {
                   12721: 	use integer;
                   12722: 	my $symbchck=unpack("%32C*",$symb) << 27;
                   12723: 	my $symbseed=numval($symb) << 22;
                   12724: 	my $namechck=unpack("%32C*",$username) << 17;
                   12725: 	my $nameseed=numval($username) << 12;
                   12726: 	my $domainseed=unpack("%32C*",$domain) << 7;
                   12727: 	my $courseseed=unpack("%32C*",$courseid);
                   12728: 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790     albertel 12729: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   12730: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 12731: 	if ($_64bit) { $num=(($num<<32)>>32); }
1.366     albertel 12732: 	return $num;
                   12733:     }
                   12734: }
                   12735: 
                   12736: sub rndseed_64bit {
                   12737:     my ($symb,$courseid,$domain,$username)=@_;
                   12738:     {
                   12739: 	use integer;
                   12740: 	my $symbchck=unpack("%32S*",$symb) << 21;
                   12741: 	my $symbseed=numval($symb) << 10;
                   12742: 	my $namechck=unpack("%32S*",$username);
                   12743: 	
                   12744: 	my $nameseed=numval($username) << 21;
                   12745: 	my $domainseed=unpack("%32S*",$domain) << 10;
                   12746: 	my $courseseed=unpack("%32S*",$courseid);
                   12747: 	
                   12748: 	my $num1=$symbchck+$symbseed+$namechck;
                   12749: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 12750: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   12751: 	#&logthis("rndseed :$num:$symb");
1.564     albertel 12752: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366     albertel 12753: 	return "$num1,$num2";
1.155     albertel 12754:     }
1.366     albertel 12755: }
                   12756: 
1.443     albertel 12757: sub rndseed_64bit2 {
                   12758:     my ($symb,$courseid,$domain,$username)=@_;
                   12759:     {
                   12760: 	use integer;
                   12761: 	# strings need to be an even # of cahracters long, it it is odd the
                   12762:         # last characters gets thrown away
                   12763: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   12764: 	my $symbseed=numval($symb) << 10;
                   12765: 	my $namechck=unpack("%32S*",$username.' ');
                   12766: 	
                   12767: 	my $nameseed=numval($username) << 21;
1.501     albertel 12768: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   12769: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   12770: 	
                   12771: 	my $num1=$symbchck+$symbseed+$namechck;
                   12772: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 12773: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   12774: 	#&logthis("rndseed :$num:$symb");
1.803     albertel 12775: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501     albertel 12776: 	return "$num1,$num2";
                   12777:     }
                   12778: }
                   12779: 
                   12780: sub rndseed_64bit3 {
                   12781:     my ($symb,$courseid,$domain,$username)=@_;
                   12782:     {
                   12783: 	use integer;
                   12784: 	# strings need to be an even # of cahracters long, it it is odd the
                   12785:         # last characters gets thrown away
                   12786: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   12787: 	my $symbseed=numval2($symb) << 10;
                   12788: 	my $namechck=unpack("%32S*",$username.' ');
                   12789: 	
                   12790: 	my $nameseed=numval2($username) << 21;
1.443     albertel 12791: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   12792: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   12793: 	
                   12794: 	my $num1=$symbchck+$symbseed+$namechck;
                   12795: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 12796: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   12797: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.564     albertel 12798: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110    www      12799: 	
1.503     albertel 12800: 	return "$num1:$num2";
1.443     albertel 12801:     }
                   12802: }
                   12803: 
1.575     albertel 12804: sub rndseed_64bit4 {
                   12805:     my ($symb,$courseid,$domain,$username)=@_;
                   12806:     {
                   12807: 	use integer;
                   12808: 	# strings need to be an even # of cahracters long, it it is odd the
                   12809:         # last characters gets thrown away
                   12810: 	my $symbchck=unpack("%32S*",$symb.' ') << 21;
                   12811: 	my $symbseed=numval3($symb) << 10;
                   12812: 	my $namechck=unpack("%32S*",$username.' ');
                   12813: 	
                   12814: 	my $nameseed=numval3($username) << 21;
                   12815: 	my $domainseed=unpack("%32S*",$domain.' ') << 10;
                   12816: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   12817: 	
                   12818: 	my $num1=$symbchck+$symbseed+$namechck;
                   12819: 	my $num2=$nameseed+$domainseed+$courseseed;
1.790     albertel 12820: 	#&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   12821: 	#&logthis("rndseed :$num1:$num2:$_64bit");
1.575     albertel 12822: 	if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110    www      12823: 	
1.575     albertel 12824: 	return "$num1:$num2";
                   12825:     }
                   12826: }
                   12827: 
1.675     albertel 12828: sub rndseed_64bit5 {
                   12829:     my ($symb,$courseid,$domain,$username)=@_;
                   12830:     my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
                   12831:     return "$num1:$num2";
                   12832: }
                   12833: 
1.366     albertel 12834: sub rndseed_CODE_64bit {
                   12835:     my ($symb,$courseid,$domain,$username)=@_;
1.155     albertel 12836:     {
1.366     albertel 12837: 	use integer;
1.443     albertel 12838: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484     albertel 12839: 	my $symbseed=numval2($symb);
1.491     albertel 12840: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   12841: 	my $CODEseed=numval(&getCODE());
1.443     albertel 12842: 	my $courseseed=unpack("%32S*",$courseid.' ');
1.484     albertel 12843: 	my $num1=$symbseed+$CODEchck;
                   12844: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 12845: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   12846: 	#&logthis("rndseed :$num1:$num2:$symb");
1.564     albertel 12847: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   12848: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503     albertel 12849: 	return "$num1:$num2";
1.366     albertel 12850:     }
                   12851: }
                   12852: 
1.575     albertel 12853: sub rndseed_CODE_64bit4 {
                   12854:     my ($symb,$courseid,$domain,$username)=@_;
                   12855:     {
                   12856: 	use integer;
                   12857: 	my $symbchck=unpack("%32S*",$symb.' ') << 16;
                   12858: 	my $symbseed=numval3($symb);
                   12859: 	my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
                   12860: 	my $CODEseed=numval3(&getCODE());
                   12861: 	my $courseseed=unpack("%32S*",$courseid.' ');
                   12862: 	my $num1=$symbseed+$CODEchck;
                   12863: 	my $num2=$CODEseed+$courseseed+$symbchck;
1.790     albertel 12864: 	#&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
                   12865: 	#&logthis("rndseed :$num1:$num2:$symb");
1.575     albertel 12866: 	if ($_64bit) { $num1=(($num1<<32)>>32); }
                   12867: 	if ($_64bit) { $num2=(($num2<<32)>>32); }
                   12868: 	return "$num1:$num2";
                   12869:     }
                   12870: }
                   12871: 
1.675     albertel 12872: sub rndseed_CODE_64bit5 {
                   12873:     my ($symb,$courseid,$domain,$username)=@_;
                   12874:     my $code = &getCODE();
                   12875:     my ($num1,$num2)=&digest("$symb,$courseid,$code");
                   12876:     return "$num1:$num2";
                   12877: }
                   12878: 
1.366     albertel 12879: sub setup_random_from_rndseed {
                   12880:     my ($rndseed)=@_;
1.503     albertel 12881:     if ($rndseed =~/([,:])/) {
1.1262    raeburn  12882:         my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
                   12883:         if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
                   12884:             &Math::Random::random_set_seed_from_phrase($rndseed);
                   12885:         } else {
                   12886:             &Math::Random::random_set_seed($num1,$num2);
                   12887:         }
1.366     albertel 12888:     } else {
                   12889: 	&Math::Random::random_set_seed_from_phrase($rndseed);
1.98      albertel 12890:     }
1.36      albertel 12891: }
                   12892: 
1.474     albertel 12893: sub latest_receipt_algorithm_id {
1.835     albertel 12894:     return 'receipt3';
1.474     albertel 12895: }
                   12896: 
1.480     www      12897: sub recunique {
                   12898:     my $fucourseid=shift;
                   12899:     my $unique;
1.835     albertel 12900:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
                   12901: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 12902: 	$unique=$env{"course.$fucourseid.internal.encseed"};
1.480     www      12903:     } else {
                   12904: 	$unique=$perlvar{'lonReceipt'};
                   12905:     }
                   12906:     return unpack("%32C*",$unique);
                   12907: }
                   12908: 
                   12909: sub recprefix {
                   12910:     my $fucourseid=shift;
                   12911:     my $prefix;
1.835     albertel 12912:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
                   12913: 	$env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620     albertel 12914: 	$prefix=$env{"course.$fucourseid.internal.encpref"};
1.480     www      12915:     } else {
                   12916: 	$prefix=$perlvar{'lonHostID'};
                   12917:     }
                   12918:     return unpack("%32C*",$prefix);
                   12919: }
                   12920: 
1.76      www      12921: sub ireceipt {
1.474     albertel 12922:     my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835     albertel 12923: 
                   12924:     my $return =&recprefix($fucourseid).'-';
                   12925: 
                   12926:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
                   12927: 	$env{'request.state'} eq 'construct') {
                   12928: 	$return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
                   12929: 	return $return;
                   12930:     }
                   12931: 
1.76      www      12932:     my $cuname=unpack("%32C*",$funame);
                   12933:     my $cudom=unpack("%32C*",$fudom);
                   12934:     my $cucourseid=unpack("%32C*",$fucourseid);
                   12935:     my $cusymb=unpack("%32C*",$fusymb);
1.480     www      12936:     my $cunique=&recunique($fucourseid);
1.474     albertel 12937:     my $cpart=unpack("%32S*",$part);
1.835     albertel 12938:     if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
                   12939: 
1.790     albertel 12940: 	#&logthis("doing receipt2  using parts $cpart, uname $cuname and udom $cudom gets  ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474     albertel 12941: 			       
                   12942: 	$return.= ($cunique%$cuname+
                   12943: 		   $cunique%$cudom+
                   12944: 		   $cusymb%$cuname+
                   12945: 		   $cusymb%$cudom+
                   12946: 		   $cucourseid%$cuname+
                   12947: 		   $cucourseid%$cudom+
                   12948: 		   $cpart%$cuname+
                   12949: 		   $cpart%$cudom);
                   12950:     } else {
                   12951: 	$return.= ($cunique%$cuname+
                   12952: 		   $cunique%$cudom+
                   12953: 		   $cusymb%$cuname+
                   12954: 		   $cusymb%$cudom+
                   12955: 		   $cucourseid%$cuname+
                   12956: 		   $cucourseid%$cudom);
                   12957:     }
                   12958:     return $return;
1.76      www      12959: }
                   12960: 
                   12961: sub receipt {
1.474     albertel 12962:     my ($part)=@_;
1.790     albertel 12963:     my ($symb,$courseid,$domain,$name) = &whichuser();
1.474     albertel 12964:     return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76      www      12965: }
1.260     ng       12966: 
1.790     albertel 12967: sub whichuser {
                   12968:     my ($passedsymb)=@_;
                   12969:     my ($symb,$courseid,$domain,$name,$publicuser);
                   12970:     if (defined($env{'form.grade_symb'})) {
                   12971: 	my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
                   12972: 	my $allowed=&allowed('vgr',$tmp_courseid);
                   12973: 	if (!$allowed &&
                   12974: 	    exists($env{'request.course.sec'}) &&
                   12975: 	    $env{'request.course.sec'} !~ /^\s*$/) {
                   12976: 	    $allowed=&allowed('vgr',$tmp_courseid.
                   12977: 			      '/'.$env{'request.course.sec'});
                   12978: 	}
                   12979: 	if ($allowed) {
                   12980: 	    ($symb)=&get_env_multiple('form.grade_symb');
                   12981: 	    $courseid=$tmp_courseid;
                   12982: 	    ($domain)=&get_env_multiple('form.grade_domain');
                   12983: 	    ($name)=&get_env_multiple('form.grade_username');
                   12984: 	    return ($symb,$courseid,$domain,$name,$publicuser);
                   12985: 	}
                   12986:     }
                   12987:     if (!$passedsymb) {
                   12988: 	$symb=&symbread();
                   12989:     } else {
                   12990: 	$symb=$passedsymb;
                   12991:     }
                   12992:     $courseid=$env{'request.course.id'};
                   12993:     $domain=$env{'user.domain'};
                   12994:     $name=$env{'user.name'};
                   12995:     if ($name eq 'public' && $domain eq 'public') {
                   12996: 	if (!defined($env{'form.username'})) {
                   12997: 	    $env{'form.username'}.=time.rand(10000000);
                   12998: 	}
                   12999: 	$name.=$env{'form.username'};
                   13000:     }
                   13001:     return ($symb,$courseid,$domain,$name,$publicuser);
                   13002: 
                   13003: }
                   13004: 
1.36      albertel 13005: # ------------------------------------------------------------ Serves up a file
1.472     albertel 13006: # returns either the contents of the file or 
                   13007: # -1 if the file doesn't exist
1.481     raeburn  13008: #
                   13009: # if the target is a file that was uploaded via DOCS, 
                   13010: # a check will be made to see if a current copy exists on the local server,
                   13011: # if it does this will be served, otherwise a copy will be retrieved from
                   13012: # the home server for the course and stored in /home/httpd/html/userfiles on
                   13013: # the local server.   
1.472     albertel 13014: 
1.36      albertel 13015: sub getfile {
1.538     albertel 13016:     my ($file) = @_;
1.609     banghart 13017:     if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538     albertel 13018:     &repcopy($file);
                   13019:     return &readfile($file);
                   13020: }
                   13021: 
                   13022: sub repcopy_userfile {
                   13023:     my ($file)=@_;
1.1142    raeburn  13024:     my $londocroot = $perlvar{'lonDocRoot'};
                   13025:     if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164    raeburn  13026:     if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538     albertel 13027:     my ($cdom,$cnum,$filename) = 
1.811     albertel 13028: 	($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538     albertel 13029:     my $uri="/uploaded/$cdom/$cnum/$filename";
                   13030:     if (-e "$file") {
1.828     www      13031: # we already have a local copy, check it out
1.538     albertel 13032: 	my @fileinfo = stat($file);
1.828     www      13033: 	my $rtncode;
                   13034: 	my $info;
1.538     albertel 13035: 	my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482     albertel 13036: 	if ($lwpresp ne 'ok') {
1.828     www      13037: # there is no such file anymore, even though we had a local copy
1.482     albertel 13038: 	    if ($rtncode eq '404') {
1.538     albertel 13039: 		unlink($file);
1.482     albertel 13040: 	    }
                   13041: 	    return -1;
                   13042: 	}
                   13043: 	if ($info < $fileinfo[9]) {
1.828     www      13044: # nice, the file we have is up-to-date, just say okay
1.607     raeburn  13045: 	    return 'ok';
1.828     www      13046: 	} else {
                   13047: # the file is outdated, get rid of it
                   13048: 	    unlink($file);
1.482     albertel 13049: 	}
1.828     www      13050:     }
                   13051: # one way or the other, at this point, we don't have the file
                   13052: # construct the correct path for the file
                   13053:     my @parts = ($cdom,$cnum); 
                   13054:     if ($filename =~ m|^(.+)/[^/]+$|) {
                   13055: 	push @parts, split(/\//,$1);
                   13056:     }
                   13057:     my $path = $perlvar{'lonDocRoot'}.'/userfiles';
                   13058:     foreach my $part (@parts) {
                   13059: 	$path .= '/'.$part;
                   13060: 	if (!-e $path) {
                   13061: 	    mkdir($path,0770);
1.482     albertel 13062: 	}
                   13063:     }
1.828     www      13064: # now the path exists for sure
                   13065: # get a user agent
                   13066:     my $transferfile=$file.'.in.transfer';
                   13067: # FIXME: this should flock
                   13068:     if (-e $transferfile) { return 'ok'; }
                   13069:     my $request;
                   13070:     $uri=~s/^\///;
1.980     raeburn  13071:     my $homeserver = &homeserver($cnum,$cdom);
                   13072:     my $protocol = $protocol{$homeserver};
                   13073:     $protocol = 'http' if ($protocol ne 'https');
                   13074:     $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.1345    raeburn  13075:     my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828     www      13076: # did it work?
                   13077:     if ($response->is_error()) {
                   13078: 	unlink($transferfile);
                   13079: 	&logthis("Userfile repcopy failed for $uri");
                   13080: 	return -1;
                   13081:     }
                   13082: # worked, rename the transfer file
                   13083:     rename($transferfile,$file);
1.607     raeburn  13084:     return 'ok';
1.481     raeburn  13085: }
                   13086: 
1.517     albertel 13087: sub tokenwrapper {
                   13088:     my $uri=shift;
1.980     raeburn  13089:     $uri=~s|^https?\://([^/]+)||;
1.552     albertel 13090:     $uri=~s|^/||;
1.620     albertel 13091:     $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517     albertel 13092:     my $token=$1;
1.552     albertel 13093:     my (undef,$udom,$uname,$file)=split('/',$uri,4);
                   13094:     if ($udom && $uname && $file) {
                   13095: 	$file=~s|(\?\.*)*$||;
1.949     raeburn  13096:         &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980     raeburn  13097:         my $homeserver = &homeserver($uname,$udom);
                   13098:         my $protocol = $protocol{$homeserver};
                   13099:         $protocol = 'http' if ($protocol ne 'https');
                   13100:         return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517     albertel 13101:                (($uri=~/\?/)?'&':'?').'token='.$token.
                   13102:                                '&tokenissued='.$perlvar{'lonHostID'};
                   13103:     } else {
                   13104:         return '/adm/notfound.html';
                   13105:     }
                   13106: }
                   13107: 
1.828     www      13108: # call with reqtype HEAD: get last modification time
                   13109: # call with reqtype GET: get the file contents
                   13110: # Do not call this with reqtype GET for large files! It loads everything into memory
                   13111: #
1.481     raeburn  13112: sub getuploaded {
                   13113:     my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
                   13114:     $uri=~s/^\///;
1.980     raeburn  13115:     my $homeserver = &homeserver($cnum,$cdom);
                   13116:     my $protocol = $protocol{$homeserver};
                   13117:     $protocol = 'http' if ($protocol ne 'https');
                   13118:     $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481     raeburn  13119:     my $request=new HTTP::Request($reqtype,$uri);
1.1345    raeburn  13120:     my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481     raeburn  13121:     $$rtncode = $response->code;
1.482     albertel 13122:     if (! $response->is_success()) {
                   13123: 	return 'failed';
                   13124:     }      
                   13125:     if ($reqtype eq 'HEAD') {
1.486     www      13126: 	$$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482     albertel 13127:     } elsif ($reqtype eq 'GET') {
                   13128: 	$$info = $response->content;
1.472     albertel 13129:     }
1.482     albertel 13130:     return 'ok';
1.36      albertel 13131: }
                   13132: 
1.481     raeburn  13133: sub readfile {
                   13134:     my $file = shift;
                   13135:     if ( (! -e $file ) || ($file eq '') ) { return -1; };
                   13136:     my $fh;
1.1359    raeburn  13137:     open($fh,"<",$file);
1.481     raeburn  13138:     my $a='';
1.800     albertel 13139:     while (my $line = <$fh>) { $a .= $line; }
1.481     raeburn  13140:     return $a;
                   13141: }
                   13142: 
1.36      albertel 13143: sub filelocation {
1.590     banghart 13144:     my ($dir,$file) = @_;
                   13145:     my $location;
                   13146:     $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700     albertel 13147: 
                   13148:     if ($file =~ m-^/adm/-) {
                   13149: 	$file=~s-^/adm/wrapper/-/-;
                   13150: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
                   13151:     }
1.882     albertel 13152: 
1.1139    www      13153:     if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956     raeburn  13154:         $location = $file;
1.609     banghart 13155:     } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590     banghart 13156:         my ($udom,$uname,$filename)=
1.811     albertel 13157:   	    ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590     banghart 13158:         my $home=&homeserver($uname,$udom);
                   13159:         my $is_me=0;
                   13160:         my @ids=&current_machine_ids();
                   13161:         foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
                   13162:         if ($is_me) {
1.1117    foxr     13163:   	    $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590     banghart 13164:         } else {
                   13165:   	  $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
                   13166:   	      $udom.'/'.$uname.'/'.$filename;
                   13167:         }
1.882     albertel 13168:     } elsif ($file =~ m-^/adm/-) {
                   13169: 	$location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590     banghart 13170:     } else {
                   13171:         $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139    www      13172:         $file=~s:^/(res|priv)/:/:;
                   13173:         my $space=$1;
1.590     banghart 13174:         if ( !( $file =~ m:^/:) ) {
                   13175:             $location = $dir. '/'.$file;
                   13176:         } else {
1.1142    raeburn  13177:             $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590     banghart 13178:         }
1.59      albertel 13179:     }
1.590     banghart 13180:     $location=~s://+:/:g; # remove duplicate /
1.930     albertel 13181:     while ($location=~m{/\.\./}) {
                   13182: 	if ($location =~ m{/[^/]+/\.\./}) {
                   13183: 	    $location=~ s{/[^/]+/\.\./}{/}g;
                   13184: 	} else {
                   13185: 	    $location=~ s{/\.\./}{/}g;
                   13186: 	}
                   13187:     } #remove dir/..
1.590     banghart 13188:     while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
                   13189:     return $location;
1.46      www      13190: }
1.36      albertel 13191: 
1.46      www      13192: sub hreflocation {
                   13193:     my ($dir,$file)=@_;
1.980     raeburn  13194:     unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666     albertel 13195: 	$file=filelocation($dir,$file);
1.700     albertel 13196:     } elsif ($file=~m-^/adm/-) {
                   13197: 	$file=~s-^/adm/wrapper/-/-;
                   13198: 	$file=~s-^/adm/coursedocs/showdoc/-/-;
1.666     albertel 13199:     }
                   13200:     if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
                   13201: 	$file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
                   13202:     } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143    raeburn  13203: 	$file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
                   13204: 	        {/uploaded/$1/$2/}x;
1.46      www      13205:     }
1.913     albertel 13206:     if ($file=~ m{^/userfiles/}) {
                   13207: 	$file =~ s{^/userfiles/}{/uploaded/};
                   13208:     }
1.462     albertel 13209:     return $file;
1.465     albertel 13210: }
                   13211: 
1.1139    www      13212: 
                   13213: 
                   13214: 
                   13215: 
1.465     albertel 13216: sub current_machine_domains {
1.853     albertel 13217:     return &machine_domains(&hostname($perlvar{'lonHostID'}));
                   13218: }
                   13219: 
                   13220: sub machine_domains {
                   13221:     my ($hostname) = @_;
1.465     albertel 13222:     my @domains;
1.838     albertel 13223:     my %hostname = &all_hostnames();
1.465     albertel 13224:     while( my($id, $name) = each(%hostname)) {
1.467     matthew  13225: #	&logthis("-$id-$name-$hostname-");
1.465     albertel 13226: 	if ($hostname eq $name) {
1.844     albertel 13227: 	    push(@domains,&host_domain($id));
1.465     albertel 13228: 	}
                   13229:     }
                   13230:     return @domains;
                   13231: }
                   13232: 
                   13233: sub current_machine_ids {
1.853     albertel 13234:     return &machine_ids(&hostname($perlvar{'lonHostID'}));
                   13235: }
                   13236: 
                   13237: sub machine_ids {
                   13238:     my ($hostname) = @_;
                   13239:     $hostname ||= &hostname($perlvar{'lonHostID'});
1.465     albertel 13240:     my @ids;
1.888     albertel 13241:     my %name_to_host = &all_names();
1.889     albertel 13242:     if (ref($name_to_host{$hostname}) eq 'ARRAY') {
                   13243: 	return @{ $name_to_host{$hostname} };
                   13244:     }
                   13245:     return;
1.31      www      13246: }
                   13247: 
1.824     raeburn  13248: sub additional_machine_domains {
                   13249:     my @domains;
1.1359    raeburn  13250:     open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
1.824     raeburn  13251:     while( my $line = <$fh>) {
                   13252:         $line =~ s/\s//g;
                   13253:         push(@domains,$line);
                   13254:     }
                   13255:     return @domains;
                   13256: }
                   13257: 
                   13258: sub default_login_domain {
                   13259:     my $domain = $perlvar{'lonDefDomain'};
                   13260:     my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
                   13261:     foreach my $posdom (&current_machine_domains(),
                   13262:                         &additional_machine_domains()) {
                   13263:         if (lc($posdom) eq lc($testdomain)) {
                   13264:             $domain=$posdom;
                   13265:             last;
                   13266:         }
                   13267:     }
                   13268:     return $domain;
                   13269: }
                   13270: 
1.31      www      13271: # ------------------------------------------------------------- Declutters URLs
                   13272: 
                   13273: sub declutter {
                   13274:     my $thisfn=shift;
1.569     albertel 13275:     if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261    raeburn  13276:     unless ($thisfn=~m{^/home/httpd/html/priv/}) {
                   13277:         $thisfn=~s{^/home/httpd/html}{};
                   13278:     }
1.31      www      13279:     $thisfn=~s/^\///;
1.697     albertel 13280:     $thisfn=~s|^adm/wrapper/||;
                   13281:     $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31      www      13282:     $thisfn=~s/^res\///;
1.1172    bisitz   13283:     $thisfn=~s/^priv\///;
1.1032    raeburn  13284:     unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
                   13285:         $thisfn=~s/\?.+$//;
                   13286:     }
1.268     www      13287:     return $thisfn;
                   13288: }
                   13289: 
                   13290: # ------------------------------------------------------------- Clutter up URLs
                   13291: 
                   13292: sub clutter {
                   13293:     my $thisfn='/'.&declutter(shift);
1.887     albertel 13294:     if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884     albertel 13295: 	|| $thisfn =~ m{^/adm/(includes|pages)} ) { 
1.270     www      13296:        $thisfn='/res'.$thisfn; 
                   13297:     }
1.1031    raeburn  13298:     if ($thisfn !~m|^/adm|) {
                   13299: 	if ($thisfn =~ m|^/ext/|) {
1.694     albertel 13300: 	    $thisfn='/adm/wrapper'.$thisfn;
1.695     albertel 13301: 	} else {
                   13302: 	    my ($ext) = ($thisfn =~ /\.(\w+)$/);
                   13303: 	    my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698     albertel 13304: 	    if ($embstyle eq 'ssi'
                   13305: 		|| ($embstyle eq 'hdn')
                   13306: 		|| ($embstyle eq 'rat')
                   13307: 		|| ($embstyle eq 'prv')
                   13308: 		|| ($embstyle eq 'ign')) {
                   13309: 		#do nothing with these
                   13310: 	    } elsif (($embstyle eq 'img') 
1.695     albertel 13311: 		|| ($embstyle eq 'emb')
                   13312: 		|| ($embstyle eq 'wrp')) {
                   13313: 		$thisfn='/adm/wrapper'.$thisfn;
1.698     albertel 13314: 	    } elsif ($embstyle eq 'unk'
                   13315: 		     && $thisfn!~/\.(sequence|page)$/) {
1.695     albertel 13316: 		$thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698     albertel 13317: 	    } else {
1.718     www      13318: #		&logthis("Got a blank emb style");
1.695     albertel 13319: 	    }
1.694     albertel 13320: 	}
1.1343    raeburn  13321:     } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298    raeburn  13322:         $thisfn='/adm/wrapper'.$thisfn;
1.694     albertel 13323:     }
1.31      www      13324:     return $thisfn;
1.12      www      13325: }
                   13326: 
1.787     albertel 13327: sub clutter_with_no_wrapper {
                   13328:     my $uri = &clutter(shift);
                   13329:     if ($uri =~ m-^/adm/-) {
                   13330: 	$uri =~ s-^/adm/wrapper/-/-;
                   13331: 	$uri =~ s-^/adm/coursedocs/showdoc/-/-;
                   13332:     }
                   13333:     return $uri;
                   13334: }
                   13335: 
1.557     albertel 13336: sub freeze_escape {
                   13337:     my ($value)=@_;
                   13338:     if (ref($value)) {
                   13339: 	$value=&nfreeze($value);
                   13340: 	return '__FROZEN__'.&escape($value);
                   13341:     }
                   13342:     return &escape($value);
                   13343: }
                   13344: 
1.11      www      13345: 
1.557     albertel 13346: sub thaw_unescape {
                   13347:     my ($value)=@_;
                   13348:     if ($value =~ /^__FROZEN__/) {
                   13349: 	substr($value,0,10,undef);
                   13350: 	$value=&unescape($value);
                   13351: 	return &thaw($value);
                   13352:     }
                   13353:     return &unescape($value);
                   13354: }
                   13355: 
1.436     albertel 13356: sub correct_line_ends {
                   13357:     my ($result)=@_;
                   13358:     $$result =~s/\r\n/\n/mg;
                   13359:     $$result =~s/\r/\n/mg;
1.415     albertel 13360: }
1.1       albertel 13361: # ================================================================ Main Program
                   13362: 
1.184     www      13363: sub goodbye {
1.204     albertel 13364:    &logthis("Starting Shut down");
1.443     albertel 13365: #not converted to using infrastruture and probably shouldn't be
1.870     albertel 13366:    &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443     albertel 13367: #converted
1.599     albertel 13368: #   &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870     albertel 13369:    &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
                   13370: #   &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
                   13371: #   &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425     albertel 13372: #1.1 only
1.870     albertel 13373: #   &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
                   13374: #   &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
                   13375: #   &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
                   13376: #   &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
                   13377:    &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599     albertel 13378:    &logthis(sprintf("%-20s is %s",'kicks',$kicks));
                   13379:    &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184     www      13380:    &flushcourselogs();
                   13381:    &logthis("Shutting down");
                   13382: }
                   13383: 
1.852     albertel 13384: sub get_dns {
1.1210    raeburn  13385:     my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869     albertel 13386:     if (!$ignore_cache) {
                   13387: 	my ($content,$cached)=
                   13388: 	    &Apache::lonnet::is_cached_new('dns',$url);
                   13389: 	if ($cached) {
1.1210    raeburn  13390: 	    &$func($content,$hashref);
1.869     albertel 13391: 	    return;
                   13392: 	}
                   13393:     }
                   13394: 
                   13395:     my %alldns;
1.1359    raeburn  13396:     open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852     albertel 13397:     foreach my $dns (<$config>) {
                   13398: 	next if ($dns !~ /^\^(\S*)/x);
1.979     raeburn  13399:         my $line = $1;
                   13400:         my ($host,$protocol) = split(/:/,$line);
                   13401:         if ($protocol ne 'https') {
                   13402:             $protocol = 'http';
                   13403:         }
                   13404: 	$alldns{$host} = $protocol;
1.869     albertel 13405:     }
                   13406:     while (%alldns) {
1.1263    raeburn  13407: 	my ($dns) = sort { $b cmp $a } keys(%alldns);
1.979     raeburn  13408: 	my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.1345    raeburn  13409:         my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
1.979     raeburn  13410:         delete($alldns{$dns});
1.852     albertel 13411: 	next if ($response->is_error());
                   13412: 	my @content = split("\n",$response->content);
1.1210    raeburn  13413: 	unless ($nocache) {
1.1219    raeburn  13414: 	    &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1210    raeburn  13415: 	}
                   13416: 	&$func(\@content,$hashref);
1.869     albertel 13417: 	return;
1.852     albertel 13418:     }
                   13419:     close($config);
1.871     albertel 13420:     my $which = (split('/',$url))[3];
                   13421:     &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
1.1359    raeburn  13422:     open($config,"<","$perlvar{'lonTabDir'}/dns_$which.tab");
1.869     albertel 13423:     my @content = <$config>;
1.1210    raeburn  13424:     &$func(\@content,$hashref);
                   13425:     return;
                   13426: }
                   13427: 
                   13428: # ------------------------------------------------------Get DNS checksums file
1.1211    raeburn  13429: sub parse_dns_checksums_tab {
1.1210    raeburn  13430:     my ($lines,$hashref) = @_;
1.1264    raeburn  13431:     my $lonhost = $perlvar{'lonHostID'};
                   13432:     my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210    raeburn  13433:     my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264    raeburn  13434:     my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
                   13435:     my $webconfdir = '/etc/httpd/conf';
                   13436:     if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
                   13437:         $webconfdir = '/etc/apache2';
                   13438:     } elsif ($distro =~ /^sles(\d+)$/) {
                   13439:         if ($1 >= 10) {
                   13440:             $webconfdir = '/etc/apache2';
                   13441:         }
                   13442:     } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
                   13443:         if ($1 >= 10.0) {
                   13444:             $webconfdir = '/etc/apache2';
                   13445:         }
                   13446:     }
1.1210    raeburn  13447:     my ($release,$timestamp) = split(/\-/,$loncaparev);
                   13448:     my (%chksum,%revnum);
                   13449:     if (ref($lines) eq 'ARRAY') {
                   13450:         chomp(@{$lines});
1.1238    raeburn  13451:         my $version = shift(@{$lines});
                   13452:         if ($version eq $release) {  
1.1210    raeburn  13453:             foreach my $line (@{$lines}) {
1.1238    raeburn  13454:                 my ($file,$version,$shasum) = split(/,/,$line);
1.1264    raeburn  13455:                 if ($file =~ m{^/etc/httpd/conf}) {
                   13456:                     if ($webconfdir eq '/etc/apache2') {
                   13457:                         $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
                   13458:                     }
                   13459:                 }
1.1238    raeburn  13460:                 $chksum{$file} = $shasum;
                   13461:                 $revnum{$file} = $version;
1.1210    raeburn  13462:             }
                   13463:             if (ref($hashref) eq 'HASH') {
                   13464:                 %{$hashref} = (
                   13465:                                 sums     => \%chksum,
                   13466:                                 versions => \%revnum,
                   13467:                               );
                   13468:             }
                   13469:         }
                   13470:     }
1.869     albertel 13471:     return;
1.852     albertel 13472: }
1.1210    raeburn  13473: 
                   13474: sub fetch_dns_checksums {
1.1238    raeburn  13475:     my %checksums;
                   13476:     my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260    raeburn  13477:     my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238    raeburn  13478:     my ($release,$timestamp) = split(/\-/,$loncaparev);
                   13479:     &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211    raeburn  13480:              \%checksums);
1.1210    raeburn  13481:     return \%checksums;
                   13482: }
                   13483: 
1.327     albertel 13484: # ------------------------------------------------------------ Read domain file
                   13485: {
1.852     albertel 13486:     my $loaded;
1.846     albertel 13487:     my %domain;
                   13488: 
1.852     albertel 13489:     sub parse_domain_tab {
                   13490: 	my ($lines) = @_;
                   13491: 	foreach my $line (@$lines) {
                   13492: 	    next if ($line =~ /^(\#|\s*$ )/x);
1.403     www      13493: 
1.846     albertel 13494: 	    chomp($line);
1.852     albertel 13495: 	    my ($name,@elements) = split(/:/,$line,9);
1.846     albertel 13496: 	    my %this_domain;
                   13497: 	    foreach my $field ('description', 'auth_def', 'auth_arg_def',
                   13498: 			       'lang_def', 'city', 'longi', 'lati',
                   13499: 			       'primary') {
                   13500: 		$this_domain{$field} = shift(@elements);
                   13501: 	    }
                   13502: 	    $domain{$name} = \%this_domain;
1.852     albertel 13503: 	}
                   13504:     }
1.864     albertel 13505: 
                   13506:     sub reset_domain_info {
                   13507: 	undef($loaded);
                   13508: 	undef(%domain);
                   13509:     }
                   13510: 
1.852     albertel 13511:     sub load_domain_tab {
1.1293    raeburn  13512: 	my ($ignore_cache,$nocache) = @_;
                   13513: 	&get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852     albertel 13514: 	my $fh;
1.1359    raeburn  13515: 	if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852     albertel 13516: 	    my @lines = <$fh>;
                   13517: 	    &parse_domain_tab(\@lines);
1.448     albertel 13518: 	}
1.852     albertel 13519: 	close($fh);
                   13520: 	$loaded = 1;
1.327     albertel 13521:     }
1.846     albertel 13522: 
                   13523:     sub domain {
1.852     albertel 13524: 	&load_domain_tab() if (!$loaded);
                   13525: 
1.846     albertel 13526: 	my ($name,$what) = @_;
                   13527: 	return if ( !exists($domain{$name}) );
                   13528: 
                   13529: 	if (!$what) {
                   13530: 	    return $domain{$name}{'description'};
                   13531: 	}
                   13532: 	return $domain{$name}{$what};
                   13533:     }
1.974     raeburn  13534: 
                   13535:     sub domain_info {
                   13536:         &load_domain_tab() if (!$loaded);
                   13537:         return %domain;
                   13538:     }
                   13539: 
1.327     albertel 13540: }
                   13541: 
                   13542: 
1.1       albertel 13543: # ------------------------------------------------------------- Read hosts file
                   13544: {
1.838     albertel 13545:     my %hostname;
1.844     albertel 13546:     my %hostdom;
1.845     albertel 13547:     my %libserv;
1.852     albertel 13548:     my $loaded;
1.888     albertel 13549:     my %name_to_host;
1.1074    raeburn  13550:     my %internetdom;
1.1107    raeburn  13551:     my %LC_dns_serv;
1.852     albertel 13552: 
                   13553:     sub parse_hosts_tab {
                   13554: 	my ($file) = @_;
                   13555: 	foreach my $configline (@$file) {
                   13556: 	    next if ($configline =~ /^(\#|\s*$ )/x);
1.1107    raeburn  13557:             chomp($configline);
                   13558: 	    if ($configline =~ /^\^/) {
                   13559:                 if ($configline =~ /^\^([\w.\-]+)/) {
                   13560:                     $LC_dns_serv{$1} = 1;
                   13561:                 }
                   13562:                 next;
                   13563:             }
1.1074    raeburn  13564: 	    my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852     albertel 13565: 	    $name=~s/\s//g;
                   13566: 	    if ($id && $domain && $role && $name) {
1.1351    raeburn  13567:                 if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
                   13568:                     my $curr = $hostname{$id};
                   13569:                     my $skip;
                   13570:                     if (ref($name_to_host{$curr}) eq 'ARRAY') {
                   13571:                         if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
                   13572:                             $skip = 1;
                   13573:                         } else {
                   13574:                             @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
                   13575:                         }
                   13576:                     }
                   13577:                     unless ($skip) {
                   13578:                         push(@{$name_to_host{$name}},$id);
                   13579:                     }
                   13580:                 } else {
                   13581:                     push(@{$name_to_host{$name}},$id);
                   13582:                 }
1.852     albertel 13583: 		$hostname{$id}=$name;
                   13584: 		$hostdom{$id}=$domain;
                   13585: 		if ($role eq 'library') { $libserv{$id}=$name; }
1.969     raeburn  13586:                 if (defined($protocol)) {
                   13587:                     if ($protocol eq 'https') {
                   13588:                         $protocol{$id} = $protocol;
                   13589:                     } else {
                   13590:                         $protocol{$id} = 'http'; 
                   13591:                     }
1.968     raeburn  13592:                 } else {
1.969     raeburn  13593:                     $protocol{$id} = 'http';
1.968     raeburn  13594:                 }
1.1074    raeburn  13595:                 if (defined($intdom)) {
                   13596:                     $internetdom{$id} = $intdom;
                   13597:                 }
1.852     albertel 13598: 	    }
                   13599: 	}
                   13600:     }
1.864     albertel 13601:     
                   13602:     sub reset_hosts_info {
1.897     albertel 13603: 	&purge_remembered();
1.864     albertel 13604: 	&reset_domain_info();
                   13605: 	&reset_hosts_ip_info();
1.1339    raeburn  13606:         undef(%internetdom);
1.892     albertel 13607: 	undef(%name_to_host);
1.864     albertel 13608: 	undef(%hostname);
                   13609: 	undef(%hostdom);
                   13610: 	undef(%libserv);
                   13611: 	undef($loaded);
                   13612:     }
1.1       albertel 13613: 
1.852     albertel 13614:     sub load_hosts_tab {
1.1293    raeburn  13615: 	my ($ignore_cache,$nocache) = @_;
                   13616: 	&get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359    raeburn  13617: 	open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852     albertel 13618: 	my @config = <$config>;
                   13619: 	&parse_hosts_tab(\@config);
                   13620: 	close($config);
                   13621: 	$loaded=1;
1.1       albertel 13622:     }
1.852     albertel 13623: 
1.838     albertel 13624:     sub hostname {
1.852     albertel 13625: 	&load_hosts_tab() if (!$loaded);
                   13626: 
1.838     albertel 13627: 	my ($lonid) = @_;
                   13628: 	return $hostname{$lonid};
                   13629:     }
1.845     albertel 13630: 
1.838     albertel 13631:     sub all_hostnames {
1.852     albertel 13632: 	&load_hosts_tab() if (!$loaded);
                   13633: 
1.838     albertel 13634: 	return %hostname;
                   13635:     }
1.845     albertel 13636: 
1.888     albertel 13637:     sub all_names {
1.1293    raeburn  13638:         my ($ignore_cache,$nocache) = @_;
                   13639: 	&load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888     albertel 13640: 
                   13641: 	return %name_to_host;
                   13642:     }
                   13643: 
1.974     raeburn  13644:     sub all_host_domain {
                   13645:         &load_hosts_tab() if (!$loaded);
                   13646:         return %hostdom;
                   13647:     }
                   13648: 
1.1339    raeburn  13649:     sub all_host_intdom {
                   13650:         &load_hosts_tab() if (!$loaded);
                   13651:         return %internetdom;
                   13652:     }
                   13653: 
1.845     albertel 13654:     sub is_library {
1.852     albertel 13655: 	&load_hosts_tab() if (!$loaded);
                   13656: 
1.845     albertel 13657: 	return exists($libserv{$_[0]});
                   13658:     }
                   13659: 
                   13660:     sub all_library {
1.852     albertel 13661: 	&load_hosts_tab() if (!$loaded);
                   13662: 
1.845     albertel 13663: 	return %libserv;
                   13664:     }
                   13665: 
1.1062    droeschl 13666:     sub unique_library {
                   13667: 	#2x reverse removes all hostnames that appear more than once
                   13668:         my %unique = reverse &all_library();
                   13669:         return reverse %unique;
                   13670:     }
                   13671: 
1.841     albertel 13672:     sub get_servers {
1.852     albertel 13673: 	&load_hosts_tab() if (!$loaded);
                   13674: 
1.841     albertel 13675: 	my ($domain,$type) = @_;
                   13676: 	my %possible_hosts = ($type eq 'library') ? %libserv
                   13677: 	                                          : %hostname;
                   13678: 	my %result;
1.842     albertel 13679: 	if (ref($domain) eq 'ARRAY') {
                   13680: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843     albertel 13681: 		if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842     albertel 13682: 		    $result{$host} = $hostname;
                   13683: 		}
                   13684: 	    }
                   13685: 	} else {
                   13686: 	    while ( my ($host,$hostname) = each(%possible_hosts)) {
                   13687: 		if ($hostdom{$host} eq $domain) {
                   13688: 		    $result{$host} = $hostname;
                   13689: 		}
1.841     albertel 13690: 	    }
                   13691: 	}
                   13692: 	return %result;
                   13693:     }
1.845     albertel 13694: 
1.1062    droeschl 13695:     sub get_unique_servers {
                   13696:         my %unique = reverse &get_servers(@_);
                   13697: 	return reverse %unique;
                   13698:     }
                   13699: 
1.844     albertel 13700:     sub host_domain {
1.852     albertel 13701: 	&load_hosts_tab() if (!$loaded);
                   13702: 
1.844     albertel 13703: 	my ($lonid) = @_;
                   13704: 	return $hostdom{$lonid};
                   13705:     }
                   13706: 
1.841     albertel 13707:     sub all_domains {
1.852     albertel 13708: 	&load_hosts_tab() if (!$loaded);
                   13709: 
1.841     albertel 13710: 	my %seen;
                   13711: 	my @uniq = grep(!$seen{$_}++, values(%hostdom));
                   13712: 	return @uniq;
                   13713:     }
1.1074    raeburn  13714: 
                   13715:     sub internet_dom {
                   13716:         &load_hosts_tab() if (!$loaded);
                   13717: 
                   13718:         my ($lonid) = @_;
                   13719:         return $internetdom{$lonid};
                   13720:     }
1.1107    raeburn  13721: 
                   13722:     sub is_LC_dns {
                   13723:         &load_hosts_tab() if (!$loaded);
                   13724: 
                   13725:         my ($hostname) = @_;
                   13726:         return exists($LC_dns_serv{$hostname});
                   13727:     }
                   13728: 
1.1       albertel 13729: }
                   13730: 
1.847     albertel 13731: { 
                   13732:     my %iphost;
1.856     albertel 13733:     my %name_to_ip;
                   13734:     my %lonid_to_ip;
1.869     albertel 13735: 
1.847     albertel 13736:     sub get_hosts_from_ip {
                   13737: 	my ($ip) = @_;
                   13738: 	my %iphosts = &get_iphost();
                   13739: 	if (ref($iphosts{$ip})) {
                   13740: 	    return @{$iphosts{$ip}};
                   13741: 	}
                   13742: 	return;
1.839     albertel 13743:     }
1.864     albertel 13744:     
                   13745:     sub reset_hosts_ip_info {
                   13746: 	undef(%iphost);
                   13747: 	undef(%name_to_ip);
                   13748: 	undef(%lonid_to_ip);
                   13749:     }
1.856     albertel 13750: 
                   13751:     sub get_host_ip {
                   13752: 	my ($lonid) = @_;
                   13753: 	if (exists($lonid_to_ip{$lonid})) {
                   13754: 	    return $lonid_to_ip{$lonid};
                   13755: 	}
                   13756: 	my $name=&hostname($lonid);
                   13757:    	my $ip = gethostbyname($name);
                   13758: 	return if (!$ip || length($ip) ne 4);
                   13759: 	$ip=inet_ntoa($ip);
                   13760: 	$name_to_ip{$name}   = $ip;
                   13761: 	$lonid_to_ip{$lonid} = $ip;
                   13762: 	return $ip;
                   13763:     }
1.847     albertel 13764:     
                   13765:     sub get_iphost {
1.1293    raeburn  13766: 	my ($ignore_cache,$nocache) = @_;
1.894     albertel 13767: 
1.869     albertel 13768: 	if (!$ignore_cache) {
                   13769: 	    if (%iphost) {
                   13770: 		return %iphost;
                   13771: 	    }
                   13772: 	    my ($ip_info,$cached)=
                   13773: 		&Apache::lonnet::is_cached_new('iphost','iphost');
                   13774: 	    if ($cached) {
                   13775: 		%iphost      = %{$ip_info->[0]};
                   13776: 		%name_to_ip  = %{$ip_info->[1]};
                   13777: 		%lonid_to_ip = %{$ip_info->[2]};
                   13778: 		return %iphost;
                   13779: 	    }
                   13780: 	}
1.894     albertel 13781: 
                   13782: 	# get yesterday's info for fallback
                   13783: 	my %old_name_to_ip;
                   13784: 	my ($ip_info,$cached)=
                   13785: 	    &Apache::lonnet::is_cached_new('iphost','iphost');
                   13786: 	if ($cached) {
                   13787: 	    %old_name_to_ip = %{$ip_info->[1]};
                   13788: 	}
                   13789: 
1.1293    raeburn  13790: 	my %name_to_host = &all_names($ignore_cache,$nocache);
1.888     albertel 13791: 	foreach my $name (keys(%name_to_host)) {
1.847     albertel 13792: 	    my $ip;
                   13793: 	    if (!exists($name_to_ip{$name})) {
                   13794: 		$ip = gethostbyname($name);
                   13795: 		if (!$ip || length($ip) ne 4) {
1.894     albertel 13796: 		    if (defined($old_name_to_ip{$name})) {
                   13797: 			$ip = $old_name_to_ip{$name};
                   13798: 			&logthis("Can't find $name defaulting to old $ip");
                   13799: 		    } else {
                   13800: 			&logthis("Name $name no IP found");
                   13801: 			next;
                   13802: 		    }
                   13803: 		} else {
                   13804: 		    $ip=inet_ntoa($ip);
1.847     albertel 13805: 		}
                   13806: 		$name_to_ip{$name} = $ip;
                   13807: 	    } else {
                   13808: 		$ip = $name_to_ip{$name};
1.653     albertel 13809: 	    }
1.888     albertel 13810: 	    foreach my $id (@{ $name_to_host{$name} }) {
                   13811: 		$lonid_to_ip{$id} = $ip;
                   13812: 	    }
                   13813: 	    push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598     albertel 13814: 	}
1.1293    raeburn  13815:         unless ($nocache) {
                   13816: 	    &do_cache_new('iphost','iphost',
                   13817: 		          [\%iphost,\%name_to_ip,\%lonid_to_ip],
                   13818: 		          48*60*60);
                   13819:         }
1.869     albertel 13820: 
1.847     albertel 13821: 	return %iphost;
1.598     albertel 13822:     }
                   13823: 
1.992     raeburn  13824:     #
                   13825:     #  Given a DNS returns the loncapa host name for that DNS 
                   13826:     # 
                   13827:     sub host_from_dns {
                   13828:         my ($dns) = @_;
                   13829:         my @hosts;
                   13830:         my $ip;
                   13831: 
1.993     raeburn  13832:         if (exists($name_to_ip{$dns})) {
1.992     raeburn  13833:             $ip = $name_to_ip{$dns};
                   13834:         }
                   13835:         if (!$ip) {
                   13836:             $ip = gethostbyname($dns); # Initial translation to IP is in net order.
                   13837:             if (length($ip) == 4) { 
                   13838: 	        $ip   = &IO::Socket::inet_ntoa($ip);
                   13839:             }
                   13840:         }
                   13841:         if ($ip) {
                   13842: 	    @hosts = get_hosts_from_ip($ip);
                   13843: 	    return $hosts[0];
                   13844:         }
                   13845:         return undef;
1.986     foxr     13846:     }
1.992     raeburn  13847: 
1.1074    raeburn  13848:     sub get_internet_names {
                   13849:         my ($lonid) = @_;
                   13850:         return if ($lonid eq '');
                   13851:         my ($idnref,$cached)=
                   13852:             &Apache::lonnet::is_cached_new('internetnames',$lonid);
                   13853:         if ($cached) {
                   13854:             return $idnref;
                   13855:         }
                   13856:         my $ip = &get_host_ip($lonid);
                   13857:         my @hosts = &get_hosts_from_ip($ip);
                   13858:         my %iphost = &get_iphost();
                   13859:         my (@idns,%seen);
                   13860:         foreach my $id (@hosts) {
                   13861:             my $dom = &host_domain($id);
                   13862:             my $prim_id = &domain($dom,'primary');
                   13863:             my $prim_ip = &get_host_ip($prim_id);
                   13864:             next if ($seen{$prim_ip});
                   13865:             if (ref($iphost{$prim_ip}) eq 'ARRAY') {
                   13866:                 foreach my $id (@{$iphost{$prim_ip}}) {
                   13867:                     my $intdom = &internet_dom($id);
                   13868:                     unless (grep(/^\Q$intdom\E$/,@idns)) {
                   13869:                         push(@idns,$intdom);
                   13870:                     }
                   13871:                 }
                   13872:             }
                   13873:             $seen{$prim_ip} = 1;
                   13874:         }
1.1219    raeburn  13875:         return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074    raeburn  13876:     }
                   13877: 
1.986     foxr     13878: }
                   13879: 
1.1079    raeburn  13880: sub all_loncaparevs {
1.1249    raeburn  13881:     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 2.11);
1.1079    raeburn  13882: }
                   13883: 
1.1227    raeburn  13884: # ---------------------------------------------------------- Read loncaparev table
                   13885: {
                   13886:     sub load_loncaparevs { 
                   13887:         if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359    raeburn  13888:             if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227    raeburn  13889:                 while (my $configline=<$config>) {
                   13890:                     chomp($configline);
                   13891:                     my ($hostid,$loncaparev)=split(/:/,$configline);
                   13892:                     $loncaparevs{$hostid}=$loncaparev;
                   13893:                 }
                   13894:                 close($config);
                   13895:             }
                   13896:         }
                   13897:     }
                   13898: }
                   13899: 
                   13900: # ---------------------------------------------------------- Read serverhostID table
                   13901: {
                   13902:     sub load_serverhomeIDs {
                   13903:         if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359    raeburn  13904:             if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227    raeburn  13905:                 while (my $configline=<$config>) {
                   13906:                     chomp($configline);
                   13907:                     my ($name,$id)=split(/:/,$configline);
                   13908:                     $serverhomeIDs{$name}=$id;
                   13909:                 }
                   13910:                 close($config);
                   13911:             }
                   13912:         }
                   13913:     }
                   13914: }
                   13915: 
                   13916: 
1.862     albertel 13917: BEGIN {
                   13918: 
                   13919: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
                   13920:     unless ($readit) {
                   13921: {
                   13922:     my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
                   13923:     %perlvar = (%perlvar,%{$configvars});
                   13924: }
                   13925: 
                   13926: 
1.1       albertel 13927: # ------------------------------------------------------ Read spare server file
                   13928: {
1.1359    raeburn  13929:     open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1       albertel 13930: 
                   13931:     while (my $configline=<$config>) {
                   13932:        chomp($configline);
1.284     matthew  13933:        if ($configline) {
1.784     albertel 13934: 	   my ($host,$type) = split(':',$configline,2);
1.785     albertel 13935: 	   if (!defined($type) || $type eq '') { $type = 'default' };
1.784     albertel 13936: 	   push(@{ $spareid{$type} }, $host);
1.1       albertel 13937:        }
                   13938:     }
1.448     albertel 13939:     close($config);
1.1       albertel 13940: }
1.11      www      13941: # ------------------------------------------------------------ Read permissions
                   13942: {
1.1359    raeburn  13943:     open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11      www      13944: 
                   13945:     while (my $configline=<$config>) {
1.448     albertel 13946: 	chomp($configline);
                   13947: 	if ($configline) {
                   13948: 	    my ($role,$perm)=split(/ /,$configline);
                   13949: 	    if ($perm ne '') { $pr{$role}=$perm; }
                   13950: 	}
1.11      www      13951:     }
1.448     albertel 13952:     close($config);
1.11      www      13953: }
                   13954: 
                   13955: # -------------------------------------------- Read plain texts for permissions
                   13956: {
1.1359    raeburn  13957:     open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11      www      13958: 
                   13959:     while (my $configline=<$config>) {
1.448     albertel 13960: 	chomp($configline);
                   13961: 	if ($configline) {
1.742     raeburn  13962: 	    my ($short,@plain)=split(/:/,$configline);
                   13963:             %{$prp{$short}} = ();
                   13964: 	    if (@plain > 0) {
                   13965:                 $prp{$short}{'std'} = $plain[0];
                   13966:                 for (my $i=1; $i<@plain; $i++) {
                   13967:                     $prp{$short}{'alt'.$i} = $plain[$i];  
                   13968:                 }
                   13969:             }
1.448     albertel 13970: 	}
1.135     www      13971:     }
1.448     albertel 13972:     close($config);
1.135     www      13973: }
                   13974: 
                   13975: # ---------------------------------------------------------- Read package table
                   13976: {
1.1359    raeburn  13977:     open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135     www      13978: 
                   13979:     while (my $configline=<$config>) {
1.483     albertel 13980: 	if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448     albertel 13981: 	chomp($configline);
                   13982: 	my ($short,$plain)=split(/:/,$configline);
                   13983: 	my ($pack,$name)=split(/\&/,$short);
                   13984: 	if ($plain ne '') {
                   13985: 	    $packagetab{$pack.'&'.$name.'&name'}=$name; 
                   13986: 	    $packagetab{$short}=$plain; 
                   13987: 	}
1.11      www      13988:     }
1.448     albertel 13989:     close($config);
1.329     matthew  13990: }
                   13991: 
1.1073    raeburn  13992: # ---------------------------------------------------------- Read loncaparev table
1.1227    raeburn  13993: 
                   13994: &load_loncaparevs();
1.1073    raeburn  13995: 
1.1074    raeburn  13996: # ---------------------------------------------------------- Read serverhostID table
                   13997: 
1.1227    raeburn  13998: &load_serverhomeIDs();
                   13999: 
                   14000: # ---------------------------------------------------------- Read releaseslist XML
1.1079    raeburn  14001: {
                   14002:     my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
                   14003:     if (-e $file) {
                   14004:         my $parser = HTML::LCParser->new($file);
                   14005:         while (my $token = $parser->get_token()) {
                   14006:             if ($token->[0] eq 'S') {
                   14007:                 my $item = $token->[1];
                   14008:                 my $name = $token->[2]{'name'};
                   14009:                 my $value = $token->[2]{'value'};
1.1285    raeburn  14010:                 my $valuematch = $token->[2]{'valuematch'};
1.1303    raeburn  14011:                 my $namematch = $token->[2]{'namematch'};
                   14012:                 if ($item eq 'parameter') {
                   14013:                     if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
                   14014:                         my $release = $parser->get_text();
                   14015:                         $release =~ s/(^\s*|\s*$ )//gx;
                   14016:                         $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
                   14017:                     }
                   14018:                 } elsif ($item ne '' && $name ne '') {
1.1079    raeburn  14019:                     my $release = $parser->get_text();
                   14020:                     $release =~ s/(^\s*|\s*$ )//gx;
1.1303    raeburn  14021:                     $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079    raeburn  14022:                 }
                   14023:             }
                   14024:         }
                   14025:     }
1.1073    raeburn  14026: }
                   14027: 
1.1138    raeburn  14028: # ---------------------------------------------------------- Read managers table
                   14029: {
                   14030:     if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359    raeburn  14031:         if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138    raeburn  14032:             while (my $configline=<$config>) {
                   14033:                 chomp($configline);
                   14034:                 next if ($configline =~ /^\#/);
                   14035:                 if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
                   14036:                     $managerstab{$configline} = 1;
                   14037:                 }
                   14038:             }
                   14039:             close($config);
                   14040:         }
                   14041:     }
                   14042: }
                   14043: 
1.329     matthew  14044: # ------------- set up temporary directory
                   14045: {
1.1117    foxr     14046:     $tmpdir = LONCAPA::tempdir();
1.329     matthew  14047: 
1.11      www      14048: }
                   14049: 
1.794     albertel 14050: $memcache=new Cache::Memcached({'servers'           => ['127.0.0.1:11211'],
                   14051: 				'compress_threshold'=> 20_000,
                   14052:  			        });
1.185     www      14053: 
1.281     www      14054: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186     www      14055: $dumpcount=0;
1.958     www      14056: $locknum=0;
1.22      www      14057: 
1.163     harris41 14058: &logtouch();
1.672     albertel 14059: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195     www      14060: $readit=1;
1.564     albertel 14061:     {
                   14062: 	use integer;
                   14063: 	my $test=(2**32)+1;
1.568     albertel 14064: 	if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564     albertel 14065: 	&logthis(" Detected 64bit platform ($_64bit)");
                   14066:     }
1.195     www      14067: }
1.1       albertel 14068: }
1.179     www      14069: 
1.1       albertel 14070: 1;
1.191     harris41 14071: __END__
                   14072: 
1.243     albertel 14073: =pod
                   14074: 
1.191     harris41 14075: =head1 NAME
                   14076: 
1.243     albertel 14077: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191     harris41 14078: 
                   14079: =head1 SYNOPSIS
                   14080: 
1.243     albertel 14081: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191     harris41 14082: 
                   14083:  &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
                   14084: 
1.243     albertel 14085: Common parameters:
                   14086: 
                   14087: =over 4
                   14088: 
                   14089: =item *
                   14090: 
                   14091: $uname : an internal username (if $cname expecting a course Id specifically)
                   14092: 
                   14093: =item *
                   14094: 
                   14095: $udom : a domain (if $cdom expecting a course's domain specifically)
                   14096: 
                   14097: =item *
                   14098: 
                   14099: $symb : a resource instance identifier
                   14100: 
                   14101: =item *
                   14102: 
                   14103: $namespace : the name of a .db file that contains the data needed or
                   14104: being set.
                   14105: 
                   14106: =back
                   14107: 
1.394     bowersj2 14108: =head1 OVERVIEW
1.191     harris41 14109: 
1.394     bowersj2 14110: lonnet provides subroutines which interact with the
                   14111: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
                   14112: about classes, users, and resources.
1.243     albertel 14113: 
                   14114: For many of these objects you can also use this to store data about
                   14115: them or modify them in various ways.
1.191     harris41 14116: 
1.394     bowersj2 14117: =head2 Symbs
1.191     harris41 14118: 
1.394     bowersj2 14119: To identify a specific instance of a resource, LON-CAPA uses symbols
                   14120: or "symbs"X<symb>. These identifiers are built from the URL of the
                   14121: map, the resource number of the resource in the map, and the URL of
                   14122: the resource itself. The latter is somewhat redundant, but might help
                   14123: if maps change.
                   14124: 
                   14125: An example is
                   14126: 
                   14127:  msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
                   14128: 
                   14129: The respective map entry is
                   14130: 
                   14131:  <resource id="19" src="/res/msu/korte/tests/part12.problem"
                   14132:   title="Problem 2">
                   14133:  </resource>
                   14134: 
                   14135: Symbs are used by the random number generator, as well as to store and
                   14136: restore data specific to a certain instance of for example a problem.
                   14137: 
                   14138: =head2 Storing And Retrieving Data
                   14139: 
                   14140: X<store()>X<cstore()>X<restore()>Three of the most important functions
                   14141: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
                   14142: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
                   14143: is is the non-critical message twin of cstore. These functions are for
                   14144: handlers to store a perl hash to a user's permanent data space in an
                   14145: easy manner, and to retrieve it again on another call. It is expected
                   14146: that a handler would use this once at the beginning to retrieve data,
                   14147: and then again once at the end to send only the new data back.
                   14148: 
                   14149: The data is stored in the user's data directory on the user's
                   14150: homeserver under the ID of the course.
                   14151: 
                   14152: The hash that is returned by restore will have all of the previous
                   14153: value for all of the elements of the hash.
                   14154: 
                   14155: Example:
                   14156: 
                   14157:  #creating a hash
                   14158:  my %hash;
                   14159:  $hash{'foo'}='bar';
                   14160: 
                   14161:  #storing it
                   14162:  &Apache::lonnet::cstore(\%hash);
                   14163: 
                   14164:  #changing a value
                   14165:  $hash{'foo'}='notbar';
                   14166: 
                   14167:  #adding a new value
                   14168:  $hash{'bar'}='foo';
                   14169:  &Apache::lonnet::cstore(\%hash);
                   14170: 
                   14171:  #retrieving the hash
                   14172:  my %history=&Apache::lonnet::restore();
                   14173: 
                   14174:  #print the hash
                   14175:  foreach my $key (sort(keys(%history))) {
                   14176:    print("\%history{$key} = $history{$key}");
                   14177:  }
                   14178: 
                   14179: Will print out:
1.191     harris41 14180: 
1.394     bowersj2 14181:  %history{1:foo} = bar
                   14182:  %history{1:keys} = foo:timestamp
                   14183:  %history{1:timestamp} = 990455579
                   14184:  %history{2:bar} = foo
                   14185:  %history{2:foo} = notbar
                   14186:  %history{2:keys} = foo:bar:timestamp
                   14187:  %history{2:timestamp} = 990455580
                   14188:  %history{bar} = foo
                   14189:  %history{foo} = notbar
                   14190:  %history{timestamp} = 990455580
                   14191:  %history{version} = 2
                   14192: 
                   14193: Note that the special hash entries C<keys>, C<version> and
                   14194: C<timestamp> were added to the hash. C<version> will be equal to the
                   14195: total number of versions of the data that have been stored. The
                   14196: C<timestamp> attribute will be the UNIX time the hash was
                   14197: stored. C<keys> is available in every historical section to list which
                   14198: keys were added or changed at a specific historical revision of a
                   14199: hash.
                   14200: 
                   14201: B<Warning>: do not store the hash that restore returns directly. This
                   14202: will cause a mess since it will restore the historical keys as if the
                   14203: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191     harris41 14204: 
1.394     bowersj2 14205: Calling convention:
1.191     harris41 14206: 
1.1225    raeburn  14207:  my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269    raeburn  14208:  &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191     harris41 14209: 
1.394     bowersj2 14210: For more detailed information, see lonnet specific documentation.
1.191     harris41 14211: 
1.394     bowersj2 14212: =head1 RETURN MESSAGES
1.191     harris41 14213: 
1.394     bowersj2 14214: =over 4
1.191     harris41 14215: 
1.394     bowersj2 14216: =item * B<con_lost>: unable to contact remote host
1.191     harris41 14217: 
1.394     bowersj2 14218: =item * B<con_delayed>: unable to contact remote host, message will be delivered
                   14219: when the connection is brought back up
1.191     harris41 14220: 
1.394     bowersj2 14221: =item * B<con_failed>: unable to contact remote host and unable to save message
                   14222: for later delivery
1.191     harris41 14223: 
1.967     bisitz   14224: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191     harris41 14225: 
1.394     bowersj2 14226: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243     albertel 14227: that was requested
1.191     harris41 14228: 
1.243     albertel 14229: =back
1.191     harris41 14230: 
1.243     albertel 14231: =head1 PUBLIC SUBROUTINES
1.191     harris41 14232: 
1.243     albertel 14233: =head2 Session Environment Functions
1.191     harris41 14234: 
1.243     albertel 14235: =over 4
1.191     harris41 14236: 
1.394     bowersj2 14237: =item * 
                   14238: X<appenv()>
1.949     raeburn  14239: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394     bowersj2 14240: the user envirnoment file, and will be restored for each access this
1.620     albertel 14241: user makes during this session, also modifies the %env for the current
1.949     raeburn  14242: process. Optional rolesarrayref - if defined contains a reference to an array
                   14243: of roles which are exempt from the restriction on modifying user.role entries 
                   14244: in the user's environment.db and in %env.    
1.191     harris41 14245: 
                   14246: =item *
1.394     bowersj2 14247: X<delenv()>
1.987     raeburn  14248: B<delenv($delthis,$regexp)>: removes all items from the session
                   14249: environment file that begin with $delthis. If the 
                   14250: optional second arg - $regexp - is true, $delthis is treated as a 
                   14251: regular expression, otherwise \Q$delthis\E is used. 
                   14252: The values are also deleted from the current processes %env.
1.191     harris41 14253: 
1.795     albertel 14254: =item * get_env_multiple($name) 
                   14255: 
                   14256: gets $name from the %env hash, it seemlessly handles the cases where multiple
                   14257: values may be defined and end up as an array ref.
                   14258: 
                   14259: returns an array of values
                   14260: 
1.243     albertel 14261: =back
                   14262: 
                   14263: =head2 User Information
1.191     harris41 14264: 
1.243     albertel 14265: =over 4
1.191     harris41 14266: 
                   14267: =item *
1.394     bowersj2 14268: X<queryauthenticate()>
                   14269: B<queryauthenticate($uname,$udom)>: try to determine user's current 
1.191     harris41 14270: authentication scheme
                   14271: 
                   14272: =item *
1.394     bowersj2 14273: X<authenticate()>
1.1073    raeburn  14274: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394     bowersj2 14275: authenticate user from domain's lib servers (first use the current
                   14276: one). C<$upass> should be the users password.
1.1073    raeburn  14277: $checkdefauth is optional (value is 1 if a check should be made to
                   14278:    authenticate user using default authentication method, and allow
                   14279:    account creation if username does not have account in the domain).
                   14280: $clientcancheckhost is optional (value is 1 if checking whether the
                   14281:    server can host will occur on the client side in lonauth.pm).   
1.191     harris41 14282: 
                   14283: =item *
1.394     bowersj2 14284: X<homeserver()>
                   14285: B<homeserver($uname,$udom)>: find the server which has
                   14286: the user's directory and files (there must be only one), this caches
                   14287: the answer, and also caches if there is a borken connection.
1.191     harris41 14288: 
                   14289: =item *
1.394     bowersj2 14290: X<idget()>
1.1300    raeburn  14291: B<idget($udom,$idsref,$namespace)>: find the usernames behind either 
                   14292: a list of student/employee IDs or clicker IDs
                   14293: (student/employee IDs are a unique resource in a domain, there must be 
                   14294: only 1 ID per username, and only 1 username per ID in a specific domain).
                   14295: clickerIDs are not necessarily unique, as students might share clickers.
                   14296: (returns hash: id=>name,id=>name)
1.191     harris41 14297: 
                   14298: =item *
1.394     bowersj2 14299: X<idrget()>
                   14300: B<idrget($udom,@unames)>: find the IDs behind a list of
                   14301: usernames (returns hash: name=>id,name=>id)
1.191     harris41 14302: 
                   14303: =item *
1.394     bowersj2 14304: X<idput()>
1.1300    raeburn  14305: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of 
                   14306: names and associated student/employee IDs or clicker IDs.
                   14307: 
                   14308: =item *
                   14309: X<iddel()>
                   14310: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted 
                   14311: student/employee ID or clicker ID username look-ups from domain.
                   14312: The homeserver ($uhome) and namespace ($namespace) are optional.
                   14313: If no $uhome is provided, it will be determined usig &homeserver()
                   14314: for each user.  If no $namespace is provided, the default is ids.
                   14315: 
                   14316: =item *
                   14317: X<updateclickers()>
                   14318: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update 
                   14319: clicker ID-to-username look-ups in clickers.db on library server.
                   14320: Permitted actions are add or del (i.e., add or delete). The 
                   14321: clickers.db contains clickerID as keys (escaped), and each corresponding
                   14322: value is an escaped comma-separated list of usernames (for whom the
                   14323: library server is the homeserver), who registered that particular ID.
                   14324: If $critical is true, the update will be sent via &critical, otherwise
                   14325: &reply() will be used.
1.191     harris41 14326: 
                   14327: =item *
1.394     bowersj2 14328: X<rolesinit()>
1.1169    droeschl 14329: B<rolesinit($udom,$username)>: get user privileges.
                   14330: returns user role, first access and timer interval hashes
1.243     albertel 14331: 
                   14332: =item *
1.1171    droeschl 14333: X<privileged()>
                   14334: B<privileged($username,$domain)>: returns a true if user has a
                   14335: privileged and active role (i.e. su or dc), false otherwise.
                   14336: 
                   14337: =item *
1.551     albertel 14338: X<getsection()>
                   14339: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243     albertel 14340: course $cname, return section name/number or '' for "not in course"
                   14341: and '-1' for "no section"
                   14342: 
                   14343: =item *
1.394     bowersj2 14344: X<userenvironment()>
                   14345: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243     albertel 14346: passed in @what from the requested user's environment, returns a hash
                   14347: 
1.858     raeburn  14348: =item * 
                   14349: X<userlog_query()>
1.859     albertel 14350: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
                   14351: activity.log file. %filters defines filters applied when parsing the
                   14352: log file. These can be start or end timestamps, or the type of action
                   14353: - log to look for Login or Logout events, check for Checkin or
                   14354: Checkout, role for role selection. The response is in the form
                   14355: timestamp1:hostid1:event1&timestamp2:hostid2:event2 where events are
                   14356: escaped strings of the action recorded in the activity.log file.
1.858     raeburn  14357: 
1.243     albertel 14358: =back
                   14359: 
                   14360: =head2 User Roles
                   14361: 
                   14362: =over 4
                   14363: 
                   14364: =item *
                   14365: 
1.1284    raeburn  14366: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege; 
                   14367: returns codes for allowed actions.
                   14368: 
                   14369: The first argument is required, all others are optional.
                   14370: 
                   14371: $priv is the privilege being checked.
                   14372: $uri contains additional information about what is being checked for access (e.g.,
                   14373: URL, course ID etc.). 
                   14374: $symb is the unique resource instance identifier in a course; if needed,
                   14375: but not provided, it will be retrieved via a call to &symbread(). 
                   14376: $role is the role for which a priv is being checked (only used if priv is evb). 
                   14377: $clientip is the user's IP address (only used when checking for access to portfolio 
                   14378: files).
                   14379: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This 
                   14380: prevents recursive calls to &allowed.
                   14381: 
1.243     albertel 14382:  F: full access
                   14383:  U,I,K: authentication modes (cxx only)
                   14384:  '': forbidden
                   14385:  1: user needs to choose course
                   14386:  2: browse allowed
1.766     albertel 14387:  A: passphrase authentication needed
1.1284    raeburn  14388:  B: access temporarily blocked because of a blocking event in a course.
1.243     albertel 14389: 
                   14390: =item *
                   14391: 
1.1192    raeburn  14392: constructaccess($url,$setpriv) : check for access to construction space URL
                   14393: 
                   14394: See if the owner domain and name in the URL match those in the
                   14395: expected environment.  If so, return three element list
                   14396: ($ownername,$ownerdomain,$ownerhome).
                   14397: 
                   14398: Otherwise return the null string.
                   14399: 
                   14400: If second argument 'setpriv' is true, it assigns the privileges,
                   14401: and returns the same three element list, unless the owner has
                   14402: blocked "ad hoc" Domain Coordinator access to the Author Space,
                   14403: in which case the null string is returned.
                   14404: 
                   14405: =item *
                   14406: 
1.1326    raeburn  14407: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
                   14408: define a custom role rolename set privileges in format of lonTabs/roles.tab
                   14409: for system, domain, and course level. $uname and $udom are optional (current
                   14410: user's username and domain will be used when either of $uname or $udom are absent.
1.243     albertel 14411: 
                   14412: =item *
                   14413: 
1.988     raeburn  14414: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 
                   14415: (rolesplain.tab); plain text explanation of a user role term.
1.1008    raeburn  14416: $type is Course (default) or Community.
1.988     raeburn  14417: If $forcedefault evaluates to true, text returned will be default 
                   14418: text for $type. Otherwise, if this is a course, the text returned 
                   14419: will be a custom name for the role (if defined in the course's 
                   14420: environment).  If no custom name is defined the default is returned.
                   14421:    
1.832     raeburn  14422: =item *
                   14423: 
1.1219    raeburn  14424: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858     raeburn  14425: All arguments are optional. Returns a hash of a roles, either for
                   14426: co-author/assistant author roles for a user's Construction Space
1.906     albertel 14427: (default), or if $context is 'userroles', roles for the user himself,
1.933     raeburn  14428: In the hash, keys are set to colon-separated $uname,$udom,$role, and
                   14429: (optionally) if $withsec is true, a fourth colon-separated item - $section.
                   14430: For each key, value is set to colon-separated start and end times for
                   14431: the role.  If no username and domain are specified, will default to
1.934     raeburn  14432: current user/domain. Types, roles, and roledoms are references to arrays
1.858     raeburn  14433: of role statuses (active, future or previous), roles 
                   14434: (e.g., cc,in, st etc.) and domains of the roles which can be used
                   14435: to restrict the list of roles reported. If no array ref is 
                   14436: provided for types, will default to return only active roles.
1.834     albertel 14437: 
1.1195    raeburn  14438: =item *
                   14439: 
                   14440: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196    raeburn  14441: user: $uname:$udom has a role in the course: $cdom_$cnum. 
                   14442: 
                   14443: Additional optional arguments are: $type (if role checking is to be restricted 
                   14444: to certain user status types -- previous (expired roles), active (currently
1.1195    raeburn  14445: available roles) or future (roles available in the future), and
                   14446: $hideprivileged -- if true will not report course roles for users who
1.1219    raeburn  14447: have active Domain Coordinator role in course's domain or in additional
                   14448: domains (specified in 'Domains to check for privileged users' in course
                   14449: environment -- set via:  Course Settings -> Classlists and staff listing).
                   14450: 
                   14451: =item *
                   14452: 
                   14453: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
                   14454: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
                   14455: $possdomains and $possroles are optional array refs -- to domains to check and
                   14456: roles to check.  If $possdomains is not specified, a dump will be done of the
                   14457: users' roles.db to check for a dc or su role in any domain. This can be
                   14458: time consuming if &privileged is called repeatedly (e.g., when displaying a
                   14459: classlist), so in such cases, supplying a $possdomains array is preferred, as
                   14460: this then allows &privileged_by_domain() to be used, which caches the identity
                   14461: of privileged users, eliminating the need for repeated calls to &dump().
                   14462: 
                   14463: =item *
                   14464: 
                   14465: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
                   14466: where the outer hash keys are domains specified in the $possdomains array ref,
                   14467: next inner hash keys are privileged roles specified in the $roles array ref,
                   14468: and the innermost hash contains key = value pairs for username:domain = end:start
                   14469: for active or future "privileged" users with that role in that domain. To avoid
                   14470: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
                   14471: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195    raeburn  14472: 
1.243     albertel 14473: =back
                   14474: 
                   14475: =head2 User Modification
                   14476: 
                   14477: =over 4
                   14478: 
                   14479: =item *
                   14480: 
1.957     raeburn  14481: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243     albertel 14482: user for the level given by URL.  Optional start and end dates (leave empty
                   14483: string or zero for "no date")
1.191     harris41 14484: 
                   14485: =item *
                   14486: 
1.243     albertel 14487: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
                   14488: change a users, password, possible return values are: ok,
                   14489: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
                   14490: refused
1.191     harris41 14491: 
                   14492: =item *
                   14493: 
1.243     albertel 14494: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191     harris41 14495: 
                   14496: =item *
                   14497: 
1.1058    raeburn  14498: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
                   14499:            $forceid,$desiredhome,$email,$inststatus,$candelete) :
                   14500: 
                   14501: will update user information (firstname,middlename,lastname,generation,
                   14502: permanentemail), and if forceid is true, student/employee ID also.
                   14503: A user's institutional affiliation(s) can also be updated.
                   14504: User information fields will not be overwritten with empty entries 
                   14505: unless the field is included in the $candelete array reference.
                   14506: This array is included when a single user is modified via "Manage Users",
                   14507: or when Autoupdate.pl is run by cron in a domain.
1.191     harris41 14508: 
                   14509: =item *
                   14510: 
1.286     matthew  14511: modifystudent
                   14512: 
1.957     raeburn  14513: modify a student's enrollment and identification information.
1.1235    raeburn  14514: The course id is resolved based on the current user's environment.  
                   14515: This means the invoking user must be a course coordinator or otherwise
1.286     matthew  14516: associated with a course.
                   14517: 
1.297     matthew  14518: This call is essentially a wrapper for lonnet::modifyuser and
                   14519: lonnet::modify_student_enrollment
1.286     matthew  14520: 
                   14521: Inputs: 
                   14522: 
                   14523: =over 4
                   14524: 
1.957     raeburn  14525: =item B<$udom> Student's loncapa domain
1.286     matthew  14526: 
1.957     raeburn  14527: =item B<$uname> Student's loncapa login name
1.286     matthew  14528: 
1.964     bisitz   14529: =item B<$uid> Student/Employee ID
1.286     matthew  14530: 
1.957     raeburn  14531: =item B<$umode> Student's authentication mode
1.286     matthew  14532: 
1.957     raeburn  14533: =item B<$upass> Student's password
1.286     matthew  14534: 
1.957     raeburn  14535: =item B<$first> Student's first name
1.286     matthew  14536: 
1.957     raeburn  14537: =item B<$middle> Student's middle name
1.286     matthew  14538: 
1.957     raeburn  14539: =item B<$last> Student's last name
1.286     matthew  14540: 
1.957     raeburn  14541: =item B<$gene> Student's generation
1.286     matthew  14542: 
1.957     raeburn  14543: =item B<$usec> Student's section in course
1.286     matthew  14544: 
                   14545: =item B<$end> Unix time of the roles expiration
                   14546: 
                   14547: =item B<$start> Unix time of the roles start date
                   14548: 
                   14549: =item B<$forceid> If defined, allow $uid to be changed
                   14550: 
                   14551: =item B<$desiredhome> server to use as home server for student
                   14552: 
1.957     raeburn  14553: =item B<$email> Student's permanent e-mail address
                   14554: 
                   14555: =item B<$type> Type of enrollment (auto or manual)
                   14556: 
1.963     raeburn  14557: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto    
                   14558: 
                   14559: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957     raeburn  14560: 
1.963     raeburn  14561: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957     raeburn  14562: 
1.963     raeburn  14563: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957     raeburn  14564: 
1.1216    raeburn  14565: =item B<$inststatus> institutional status of user - : separated string of escaped status types
                   14566: 
                   14567: =item B<$credits> Number of credits student will earn from this class - only needs to be supplied if value needs to be different from default credits for class.
1.957     raeburn  14568: 
1.286     matthew  14569: =back
1.297     matthew  14570: 
                   14571: =item *
                   14572: 
                   14573: modify_student_enrollment
                   14574: 
1.1235    raeburn  14575: Change a student's enrollment status in a class.  The environment variable
1.297     matthew  14576: 'role.request.course' must be defined for this function to proceed.
                   14577: 
                   14578: Inputs:
                   14579: 
                   14580: =over 4
                   14581: 
1.1235    raeburn  14582: =item $udom, student's domain
1.297     matthew  14583: 
1.1235    raeburn  14584: =item $uname, student's name
1.297     matthew  14585: 
1.1235    raeburn  14586: =item $uid, student's user id
1.297     matthew  14587: 
1.1235    raeburn  14588: =item $first, student's first name
1.297     matthew  14589: 
                   14590: =item $middle
                   14591: 
                   14592: =item $last
                   14593: 
                   14594: =item $gene
                   14595: 
                   14596: =item $usec
                   14597: 
                   14598: =item $end
                   14599: 
                   14600: =item $start
                   14601: 
1.957     raeburn  14602: =item $type
                   14603: 
                   14604: =item $locktype
                   14605: 
                   14606: =item $cid
                   14607: 
                   14608: =item $selfenroll
                   14609: 
                   14610: =item $context
                   14611: 
1.1216    raeburn  14612: =item $credits, number of credits student will earn from this class
                   14613: 
1.1314    raeburn  14614: =item $instsec, institutional course section code for student
                   14615: 
1.297     matthew  14616: =back
                   14617: 
1.191     harris41 14618: 
                   14619: =item *
                   14620: 
1.243     albertel 14621: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
                   14622: custom role; give a custom role to a user for the level given by URL.  Specify
                   14623: name and domain of role author, and role name
1.191     harris41 14624: 
                   14625: =item *
                   14626: 
1.243     albertel 14627: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191     harris41 14628: 
                   14629: =item *
                   14630: 
1.243     albertel 14631: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
                   14632: 
                   14633: =back
                   14634: 
                   14635: =head2 Course Infomation
                   14636: 
                   14637: =over 4
1.191     harris41 14638: 
                   14639: =item *
                   14640: 
1.1118    foxr     14641: coursedescription($courseid,$options) : returns a hash of information about the
1.631     albertel 14642: specified course id, including all environment settings for the
                   14643: course, the description of the course will be in the hash under the
                   14644: key 'description'
1.191     harris41 14645: 
1.1118    foxr     14646: $options is an optional parameter that if supplied is a hash reference that controls
                   14647: what how this function works.  It has the following key/values:
                   14648: 
                   14649: =over 4
                   14650: 
                   14651: =item freshen_cache
                   14652: 
                   14653: If defined, and the environment cache for the course is valid, it is 
                   14654: returned in the returned hash.
                   14655: 
                   14656: =item one_time
                   14657: 
                   14658: If defined, the last cache time is set to _now_
                   14659: 
                   14660: =item user
                   14661: 
                   14662: If defined, the supplied username is used instead of the current user.
                   14663: 
                   14664: 
                   14665: =back
                   14666: 
1.191     harris41 14667: =item *
                   14668: 
1.624     albertel 14669: resdata($name,$domain,$type,@which) : request for current parameter
                   14670: setting for a specific $type, where $type is either 'course' or 'user',
                   14671: @what should be a list of parameters to ask about. This routine caches
1.1235    raeburn  14672: answers for 10 minutes.
1.243     albertel 14673: 
1.877     foxr     14674: =item *
                   14675: 
                   14676: get_courseresdata($courseid, $domain) : dump the entire course resource
                   14677: data base, returning a hash that is keyed by the resource name and has
                   14678: values that are the resource value.  I believe that the timestamps and
                   14679: versions are also returned.
                   14680: 
1.1236    raeburn  14681: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
                   14682: supplemental content area. This routine caches the number of files for 
                   14683: 10 minutes.
                   14684: 
1.243     albertel 14685: =back
                   14686: 
                   14687: =head2 Course Modification
                   14688: 
                   14689: =over 4
1.191     harris41 14690: 
                   14691: =item *
                   14692: 
1.243     albertel 14693: writecoursepref($courseid,%prefs) : write preferences (environment
                   14694: database) for a course
1.191     harris41 14695: 
                   14696: =item *
                   14697: 
1.1011    raeburn  14698: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
                   14699: 
                   14700: =item *
                   14701: 
1.1038    raeburn  14702: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243     albertel 14703: 
1.1167    droeschl 14704: =item *
                   14705: 
                   14706: is_course($courseid), is_course($cdom, $cnum)
                   14707: 
                   14708: Accepts either a combined $courseid (in the form of domain_courseid) or the
                   14709: two component version $cdom, $cnum. It checks if the specified course exists.
                   14710: 
                   14711: Returns:
                   14712:     undef if the course doesn't exist, otherwise
                   14713:     in scalar context the combined courseid.
                   14714:     in list context the two components of the course identifier, domain and 
                   14715:     courseid.    
                   14716: 
1.243     albertel 14717: =back
                   14718: 
                   14719: =head2 Resource Subroutines
                   14720: 
                   14721: =over 4
1.191     harris41 14722: 
                   14723: =item *
                   14724: 
1.243     albertel 14725: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191     harris41 14726: 
                   14727: =item *
                   14728: 
1.243     albertel 14729: repcopy($filename) : subscribes to the requested file, and attempts to
                   14730: replicate from the owning library server, Might return
1.607     raeburn  14731: 'unavailable', 'not_found', 'forbidden', 'ok', or
                   14732: 'bad_request', also attempts to grab the metadata for the
1.243     albertel 14733: resource. Expects the local filesystem pathname
                   14734: (/home/httpd/html/res/....)
                   14735: 
                   14736: =back
                   14737: 
                   14738: =head2 Resource Information
                   14739: 
                   14740: =over 4
1.191     harris41 14741: 
                   14742: =item *
                   14743: 
1.1228    raeburn  14744: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates 
                   14745: and returns the value of a variety of different possible values,
                   14746: $varname should be a request string, and the other parameters can be
                   14747: used to specify who and what one is asking about. Ordinarily, $cid 
                   14748: does not need to be specified, as it is retrived from 
                   14749: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
                   14750: within lonuserstate::loadmap() when initializing a course, before
                   14751: $env{'request.course.id'} has been set, so it needs to be provided
                   14752: in that one case.
1.243     albertel 14753: 
                   14754: Possible values for $varname are environment.lastname (or other item
                   14755: from the envirnment hash), user.name (or someother aspect about the
                   14756: user), resource.0.maxtries (or some other part and parameter of a
                   14757: resource)
1.204     albertel 14758: 
                   14759: =item *
                   14760: 
1.243     albertel 14761: directcondval($number) : get current value of a condition; reads from a state
                   14762: string
1.204     albertel 14763: 
                   14764: =item *
                   14765: 
1.243     albertel 14766: condval($condidx) : value of condition index based on state
1.204     albertel 14767: 
                   14768: =item *
                   14769: 
1.1362    raeburn  14770: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243     albertel 14771: resource's metadata, $what should be either a specific key, or either
                   14772: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362    raeburn  14773: packages that this resource currently uses, the last 3 arguments are 
                   14774: only used internally for recursive metadata.
                   14775: 
                   14776: the toolsymb is only used where the uri is for an external tool (for which
                   14777: the uri as well as the symb are guaranteed to be unique).
1.243     albertel 14778: 
                   14779: this function automatically caches all requests
1.191     harris41 14780: 
                   14781: =item *
                   14782: 
1.243     albertel 14783: metadata_query($query,$custom,$customshow) : make a metadata query against the
                   14784: network of library servers; returns file handle of where SQL and regex results
                   14785: will be stored for query
1.191     harris41 14786: 
                   14787: =item *
                   14788: 
1.1282    raeburn  14789: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) : 
                   14790: return symbolic list entry (all arguments optional). 
                   14791: 
                   14792: Args: filename is the filename (including path) for the file for which a symb 
                   14793: is required; donotrecurse, if true will prevent calls to allowed() being made 
                   14794: to check access status if more than one resource was found in the bighash 
                   14795: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of 
                   14796: a randompick); ignorecachednull, if true will prevent a symb of '' being 
                   14797: returned if $env{$cache_str} is defined as ''; checkforblock if true will
                   14798: cause possible symbs to be checked to determine if they are subject to content
                   14799: blocking, if so they will not be included as possible symbs; possibles is a
                   14800: ref to a hash, which, as a side effect, will be populated with all possible 
                   14801: symbs (content blocking not tested).
                   14802:  
1.243     albertel 14803: returns the data handle
1.191     harris41 14804: 
                   14805: =item *
                   14806: 
1.1190    raeburn  14807: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
                   14808: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582     albertel 14809: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190    raeburn  14810: on failure, user must be in a course, as it assumes the existence of
                   14811: the course initial hash, and uses $env('request.course.id'}.  The third
                   14812: arg is an optional reference to a scalar.  If this arg is passed in the 
                   14813: call to symbverify, it will be set to 1 if the symb has been set to be 
                   14814: encrypted; otherwise it will be null.  
1.191     harris41 14815: 
                   14816: =item *
                   14817: 
1.243     albertel 14818: symbclean($symb) : removes versions numbers from a symb, returns the
                   14819: cleaned symb
1.191     harris41 14820: 
                   14821: =item *
                   14822: 
1.243     albertel 14823: is_on_map($uri) : checks if the $uri is somewhere on the current
                   14824: course map, user must be in a course for it to work.
1.191     harris41 14825: 
                   14826: =item *
                   14827: 
1.243     albertel 14828: numval($salt) : return random seed value (addend for rndseed)
1.191     harris41 14829: 
                   14830: =item *
                   14831: 
1.243     albertel 14832: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
                   14833: a random seed, all arguments are optional, if they aren't sent it uses the
                   14834: environment to derive them. Note: if symb isn't sent and it can't get one
                   14835: from &symbread it will use the current time as its return value
1.191     harris41 14836: 
                   14837: =item *
                   14838: 
1.243     albertel 14839: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
                   14840: unfakeable, receipt
1.191     harris41 14841: 
                   14842: =item *
                   14843: 
1.620     albertel 14844: receipt() : API to ireceipt working off of env values; given out to users
1.191     harris41 14845: 
                   14846: =item *
                   14847: 
1.243     albertel 14848: countacc($url) : count the number of accesses to a given URL
1.191     harris41 14849: 
                   14850: =item *
                   14851: 
1.243     albertel 14852: 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 14853: 
                   14854: =item *
                   14855: 
1.243     albertel 14856: 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 14857: 
                   14858: =item *
                   14859: 
1.243     albertel 14860: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191     harris41 14861: 
                   14862: =item *
                   14863: 
1.243     albertel 14864: devalidate($symb) : devalidate temporary spreadsheet calculations,
                   14865: forcing spreadsheet to reevaluate the resource scores next time.
                   14866: 
1.1195    raeburn  14867: =item * 
                   14868: 
1.1196    raeburn  14869: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
                   14870: when viewing in course context.
1.1195    raeburn  14871: 
1.1196    raeburn  14872:  input: six args -- filename (decluttered), course number, course domain,
                   14873:                     url, symb (if registered) and group (if this is a 
                   14874:                     group item -- e.g., bulletin board, group page etc.).
1.1195    raeburn  14875: 
1.1196    raeburn  14876:  output: array of five scalars --
1.1195    raeburn  14877:          $cfile -- url for file editing if editable on current server
                   14878:          $home -- homeserver of resource (i.e., for author if published,
                   14879:                                           or course if uploaded.).
                   14880:          $switchserver --  1 if server switch will be needed.
1.1196    raeburn  14881:          $forceedit -- 1 if icon/link should be to go to edit mode 
                   14882:          $forceview -- 1 if icon/link should be to go to view mode
1.1195    raeburn  14883: 
                   14884: =item *
                   14885: 
                   14886: is_course_upload($file,$cnum,$cdom)
                   14887: 
                   14888: Used in course context to determine if current file was uploaded to 
                   14889: the course (i.e., would be found in /userfiles/docs on the course's 
                   14890: homeserver.
                   14891: 
                   14892:   input: 3 args -- filename (decluttered), course number and course domain.
                   14893:   output: boolean -- 1 if file was uploaded.
                   14894: 
1.243     albertel 14895: =back
                   14896: 
                   14897: =head2 Storing/Retreiving Data
                   14898: 
                   14899: =over 4
1.191     harris41 14900: 
                   14901: =item *
                   14902: 
1.1269    raeburn  14903: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
                   14904: permanently for this url; hashref needs to be given and should be a \%hashname;
                   14905: the remaining args aren't required and if they aren't passed or are '' they will
                   14906: be derived from the env (with the exception of $laststore, which is an 
                   14907: optional arg used when a user's submission is stored in grading).
                   14908: $laststore is $version=$timestamp, where $version is the most recent version
                   14909: number retrieved for the corresponding $symb in the $namespace db file, and
                   14910: $timestamp is the timestamp for that transaction (UNIX time).
                   14911: $laststore is currently only passed when cstore() is called by 
                   14912: structuretags::finalize_storage().
1.191     harris41 14913: 
                   14914: =item *
                   14915: 
1.1269    raeburn  14916: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
                   14917: but uses critical subroutine
1.191     harris41 14918: 
                   14919: =item *
                   14920: 
1.243     albertel 14921: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
                   14922: all args are optional
1.191     harris41 14923: 
                   14924: =item *
                   14925: 
1.717     albertel 14926: dumpstore($namespace,$udom,$uname,$regexp,$range) : 
                   14927: dumps the complete (or key matching regexp) namespace into a hash
                   14928: ($udom, $uname, $regexp, $range are optional) for a namespace that is
                   14929: normally &store()ed into
                   14930: 
                   14931: $range should be either an integer '100' (give me the first 100
                   14932:                                            matching records)
                   14933:               or be  two integers sperated by a - with no spaces
                   14934:                  '30-50' (give me the 30th through the 50th matching
                   14935:                           records)
                   14936: 
                   14937: 
                   14938: =item *
                   14939: 
1.1269    raeburn  14940: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717     albertel 14941: replaces a &store() version of data with a replacement set of data
                   14942: for a particular resource in a namespace passed in the $storehash hash 
1.1269    raeburn  14943: reference. If $tolog is true, the transaction is logged in the courselog
                   14944: with an action=PUTSTORE.
1.717     albertel 14945: 
                   14946: =item *
                   14947: 
1.243     albertel 14948: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
                   14949: works very similar to store/cstore, but all data is stored in a
                   14950: temporary location and can be reset using tmpreset, $storehash should
                   14951: be a hash reference, returns nothing on success
1.191     harris41 14952: 
                   14953: =item *
                   14954: 
1.243     albertel 14955: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
                   14956: similar to restore, but all data is stored in a temporary location and
                   14957: can be reset using tmpreset. Returns a hash of values on success,
                   14958: error string otherwise.
1.191     harris41 14959: 
                   14960: =item *
                   14961: 
1.243     albertel 14962: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
                   14963: deltes all keys for $symb form the temporary storage hash.
1.191     harris41 14964: 
                   14965: =item *
                   14966: 
1.243     albertel 14967: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   14968: reference filled in from namesp ($udom and $uname are optional)
1.191     harris41 14969: 
                   14970: =item *
                   14971: 
1.243     albertel 14972: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
                   14973: namesp ($udom and $uname are optional)
1.191     harris41 14974: 
                   14975: =item *
                   14976: 
1.702     albertel 14977: dump($namespace,$udom,$uname,$regexp,$range) : 
1.243     albertel 14978: dumps the complete (or key matching regexp) namespace into a hash
1.702     albertel 14979: ($udom, $uname, $regexp, $range are optional)
1.449     matthew  14980: 
1.702     albertel 14981: $range should be either an integer '100' (give me the first 100
                   14982:                                            matching records)
                   14983:               or be  two integers sperated by a - with no spaces
                   14984:                  '30-50' (give me the 30th through the 50th matching
                   14985:                           records)
1.449     matthew  14986: =item *
                   14987: 
                   14988: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
                   14989: $store can be a scalar, an array reference, or if the amount to be 
                   14990: incremented is > 1, a hash reference.
                   14991: 
                   14992: ($udom and $uname are optional)
1.191     harris41 14993: 
                   14994: =item *
                   14995: 
1.243     albertel 14996: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
                   14997: ($udom and $uname are optional)
1.191     harris41 14998: 
                   14999: =item *
                   15000: 
1.243     albertel 15001: cput($namespace,$storehash,$udom,$uname) : critical put
                   15002: ($udom and $uname are optional)
1.191     harris41 15003: 
                   15004: =item *
                   15005: 
1.748     albertel 15006: newput($namespace,$storehash,$udom,$uname) :
                   15007: 
                   15008: Attempts to store the items in the $storehash, but only if they don't
                   15009: currently exist, if this succeeds you can be certain that you have 
                   15010: successfully created a new key value pair in the $namespace db.
                   15011: 
                   15012: 
                   15013: Args:
                   15014:  $namespace: name of database to store values to
                   15015:  $storehash: hashref to store to the db
                   15016:  $udom: (optional) domain of user containing the db
                   15017:  $uname: (optional) name of user caontaining the db
                   15018: 
                   15019: Returns:
                   15020:  'ok' -> succeeded in storing all keys of $storehash
                   15021:  'key_exists: <key>' -> failed to anything out of $storehash, as at
                   15022:                         least <key> already existed in the db (other
                   15023:                         requested keys may also already exist)
1.967     bisitz   15024:  'error: <msg>' -> unable to tie the DB or other error occurred
1.748     albertel 15025:  'con_lost' -> unable to contact request server
                   15026:  'refused' -> action was not allowed by remote machine
                   15027: 
                   15028: 
                   15029: =item *
                   15030: 
1.243     albertel 15031: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   15032: reference filled in from namesp (encrypts the return communication)
                   15033: ($udom and $uname are optional)
1.191     harris41 15034: 
                   15035: =item *
                   15036: 
1.243     albertel 15037: log($udom,$name,$home,$message) : write to permanent log for user; use
                   15038: critical subroutine
                   15039: 
1.806     raeburn  15040: =item *
                   15041: 
1.860     raeburn  15042: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
                   15043: array reference filled in from namespace found in domain level on either
                   15044: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806     raeburn  15045: 
                   15046: =item *
                   15047: 
1.860     raeburn  15048: put_dom($namespace,$storehash,$udom,$uhome) :  stores hash in namespace at 
                   15049: domain level either on specified domain server ($uhome) or primary domain 
                   15050: server ($udom and $uhome are optional)
1.806     raeburn  15051: 
1.943     raeburn  15052: =item * 
                   15053: 
1.1240    raeburn  15054: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults 
                   15055: for: authentication, language, quotas, timezone, date locale, and portal URL in
                   15056: the target domain.
                   15057: 
                   15058: May also include additional key => value pairs for the following groups:
                   15059: 
                   15060: =over
                   15061: 
                   15062: =item
                   15063: disk quotas (MB allocated by default to portfolios and authoring spaces).
                   15064: 
                   15065: =over
                   15066: 
                   15067: =item defaultquota, authorquota
                   15068: 
                   15069: =back
                   15070: 
                   15071: =item
                   15072: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
                   15073: portfolio for users).
                   15074: 
                   15075: =over
                   15076: 
                   15077: =item
                   15078: aboutme, blog, webdav, portfolio
                   15079: 
                   15080: =back
                   15081: 
                   15082: =item
                   15083: requestcourses: ability to request courses, and how requests are processed.
                   15084: 
                   15085: =over
                   15086: 
                   15087: =item
1.1305    raeburn  15088: official, unofficial, community, textbook, placement
1.1240    raeburn  15089: 
                   15090: =back
                   15091: 
                   15092: =item
                   15093: inststatus: types of institutional affiliation, and order in which they are displayed.
                   15094: 
                   15095: =over
                   15096: 
                   15097: =item
1.1256    raeburn  15098: inststatustypes, inststatusorder, inststatusguest
1.1240    raeburn  15099: 
                   15100: =back
                   15101: 
                   15102: =item
                   15103: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
                   15104: for course's uploaded content.
                   15105: 
                   15106: =over
                   15107: 
                   15108: =item
1.1246    raeburn  15109: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota, 
1.1305    raeburn  15110: communityquota, textbookquota, placementquota
1.1240    raeburn  15111: 
                   15112: =back
                   15113: 
                   15114: =item
                   15115: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
                   15116: on your servers.
                   15117: 
                   15118: =over
                   15119: 
                   15120: =item 
                   15121: remotesessions, hostedsessions
                   15122: 
                   15123: =back
                   15124: 
                   15125: =back
                   15126: 
                   15127: In cases where a domain coordinator has never used the "Set Domain Configuration"
                   15128: utility to create a configuration.db file on a domain's primary library server 
                   15129: only the following domain defaults: auth_def, auth_arg_def, lang_def
                   15130: -- corresponding values are authentication type (internal, krb4, krb5,
                   15131: or localauth), initial password or a kerberos realm, language (e.g., en-us) -- 
                   15132: will be available. Values are retrieved from cache (if current), unless the
                   15133: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
                   15134: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
                   15135: 
                   15136: Typical usage:
1.943     raeburn  15137: 
1.1240    raeburn  15138: %domdefaults = &get_domain_defaults($target_domain);
1.943     raeburn  15139: 
1.243     albertel 15140: =back
                   15141: 
                   15142: =head2 Network Status Functions
                   15143: 
                   15144: =over 4
1.191     harris41 15145: 
                   15146: =item *
                   15147: 
1.1137    raeburn  15148: dirlist() : return directory list based on URI (first arg).
                   15149: 
                   15150: Inputs: 1 required, 5 optional.
                   15151: 
                   15152: =over
                   15153: 
                   15154: =item 
                   15155: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
                   15156: 
                   15157: =item
                   15158: $userdomain - domain of user/course to be listed. Extracted from $uri if absent. 
                   15159: 
                   15160: =item
                   15161: $username -  username of user/course to be listed. Extracted from $uri if absent. 
                   15162: 
                   15163: =item
                   15164: $getpropath - boolean: 1 if prepend path using &propath(). 
                   15165: 
                   15166: =item
                   15167: $getuserdir - boolean: 1 if prepend path for "userfiles".
                   15168: 
                   15169: =item 
                   15170: $alternateRoot - path to prepend in place of path from $uri.
                   15171: 
                   15172: =back
                   15173: 
                   15174: Returns: Array of up to two items.
                   15175: 
                   15176: =over
                   15177: 
                   15178: a reference to an array of files/subdirectories
                   15179: 
                   15180: =over
                   15181: 
                   15182: Each element in the array of files/subdirectories is a & separated list of
                   15183: item name and the result of running stat on the item.  If dirlist was requested
                   15184: for a file instead of a directory, the item name will be ''. For a directory 
                   15185: listing, if the item is a metadata file, the element will end &N&M 
                   15186: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
                   15187: default copyright set (1).  
                   15188: 
                   15189: =back
                   15190: 
                   15191: a scalar containing error condition (if encountered).
                   15192: 
                   15193: =over
                   15194: 
                   15195: =item 
                   15196: no_host (no homeserver identified for $username:$domain).
                   15197: 
                   15198: =item 
                   15199: no_such_host (server contacted for listing not identified as valid host).
                   15200: 
                   15201: =item 
                   15202: con_lost (connection to remote server failed).
                   15203: 
                   15204: =item 
                   15205: refused (invalid $username:$domain received on lond side).
                   15206: 
                   15207: =item 
                   15208: no_such_dir (directory at specified path on lond side does not exist). 
                   15209: 
                   15210: =item 
                   15211: empty (directory at specified path on lond side is empty).
                   15212: 
                   15213: =over
                   15214: 
                   15215: This is currently not encountered because the &ls3, &ls2, 
                   15216: &ls (_handler) routines on the lond side do not filter out
                   15217: . and .. from a directory listing. 
                   15218: 
                   15219: =back
                   15220: 
                   15221: =back
                   15222: 
                   15223: =back
1.191     harris41 15224: 
                   15225: =item *
                   15226: 
1.243     albertel 15227: spareserver() : find server with least workload from spare.tab
                   15228: 
1.986     foxr     15229: 
                   15230: =item *
                   15231: 
                   15232: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
                   15233: if there is no corresponding loncapa host.
                   15234: 
1.243     albertel 15235: =back
                   15236: 
1.986     foxr     15237: 
1.243     albertel 15238: =head2 Apache Request
                   15239: 
                   15240: =over 4
1.191     harris41 15241: 
                   15242: =item *
                   15243: 
1.243     albertel 15244: ssi($url,%hash) : server side include, does a complete request cycle on url to
                   15245: localhost, posts hash
                   15246: 
                   15247: =back
                   15248: 
                   15249: =head2 Data to String to Data
                   15250: 
                   15251: =over 4
1.191     harris41 15252: 
                   15253: =item *
                   15254: 
1.243     albertel 15255: hash2str(%hash) : convert a hash into a string complete with escaping and '='
                   15256: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191     harris41 15257: 
                   15258: =item *
                   15259: 
1.243     albertel 15260: hashref2str($hashref) : convert a hashref into a string complete with
                   15261: escaping and '=' and '&' separators, supports elements that are
                   15262: arrayrefs and hashrefs
1.191     harris41 15263: 
                   15264: =item *
                   15265: 
1.243     albertel 15266: arrayref2str($arrayref) : convert an arrayref into a string complete
                   15267: with escaping and '&' separators, supports elements that are arrayrefs
                   15268: and hashrefs
1.191     harris41 15269: 
                   15270: =item *
                   15271: 
1.243     albertel 15272: str2hash($string) : convert string to hash using unescaping and
                   15273: splitting on '=' and '&', supports elements that are arrayrefs and
                   15274: hashrefs
1.191     harris41 15275: 
                   15276: =item *
                   15277: 
1.243     albertel 15278: str2array($string) : convert string to hash using unescaping and
                   15279: splitting on '&', supports elements that are arrayrefs and hashrefs
                   15280: 
                   15281: =back
                   15282: 
                   15283: =head2 Logging Routines
                   15284: 
                   15285: 
                   15286: These routines allow one to make log messages in the lonnet.log and
                   15287: lonnet.perm logfiles.
1.191     harris41 15288: 
1.1119    foxr     15289: =over 4
                   15290: 
1.191     harris41 15291: =item *
                   15292: 
1.243     albertel 15293: logtouch() : make sure the logfile, lonnet.log, exists
1.191     harris41 15294: 
                   15295: =item *
                   15296: 
1.243     albertel 15297: logthis() : append message to the normal lonnet.log file, it gets
                   15298: preiodically rolled over and deleted.
1.191     harris41 15299: 
                   15300: =item *
                   15301: 
1.243     albertel 15302: logperm() : append a permanent message to lonnet.perm.log, this log
                   15303: file never gets deleted by any automated portion of the system, only
                   15304: messages of critical importance should go in here.
                   15305: 
1.1119    foxr     15306: 
1.243     albertel 15307: =back
                   15308: 
                   15309: =head2 General File Helper Routines
                   15310: 
                   15311: =over 4
1.191     harris41 15312: 
                   15313: =item *
                   15314: 
1.481     raeburn  15315: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
                   15316: (a) files in /uploaded
                   15317:   (i) If a local copy of the file exists - 
                   15318:       compares modification date of local copy with last-modified date for 
                   15319:       definitive version stored on home server for course. If local copy is 
                   15320:       stale, requests a new version from the home server and stores it. 
                   15321:       If the original has been removed from the home server, then local copy 
                   15322:       is unlinked.
                   15323:   (ii) If local copy does not exist -
                   15324:       requests the file from the home server and stores it. 
                   15325:   
                   15326:   If $caller is 'uploadrep':  
                   15327:     This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
                   15328:     for request for files originally uploaded via DOCS. 
                   15329:      - returns 'ok' if fresh local copy now available, -1 otherwise.
                   15330:   
                   15331:   Otherwise:
                   15332:      This indicates a call from the content generation phase of the request.
                   15333:      -  returns the entire contents of the file or -1.
                   15334:      
                   15335: (b) files in /res
                   15336:    - returns the entire contents of a file or -1; 
                   15337:    it properly subscribes to and replicates the file if neccessary.
1.191     harris41 15338: 
1.712     albertel 15339: 
                   15340: =item *
                   15341: 
                   15342: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
                   15343:                   reference
                   15344: 
                   15345: returns either a stat() list of data about the file or an empty list
                   15346: if the file doesn't exist or couldn't find out about it (connection
                   15347: problems or user unknown)
                   15348: 
1.191     harris41 15349: =item *
                   15350: 
1.243     albertel 15351: filelocation($dir,$file) : returns file system location of a file
                   15352: based on URI; meant to be "fairly clean" absolute reference, $dir is a
                   15353: directory that relative $file lookups are to looked in ($dir of /a/dir
                   15354: and a file of ../bob will become /a/bob)
1.191     harris41 15355: 
                   15356: =item *
                   15357: 
                   15358: hreflocation($dir,$file) : returns file system location or a URL; same as
                   15359: filelocation except for hrefs
                   15360: 
                   15361: =item *
                   15362: 
1.1261    raeburn  15363: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
                   15364: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191     harris41 15365: 
1.243     albertel 15366: =back
                   15367: 
1.608     albertel 15368: =head2 Usererfile file routines (/uploaded*)
                   15369: 
                   15370: =over 4
                   15371: 
                   15372: =item *
                   15373: 
                   15374: userfileupload(): main rotine for putting a file in a user or course's
                   15375:                   filespace, arguments are,
                   15376: 
1.620     albertel 15377:  formname - required - this is the name of the element in $env where the
1.608     albertel 15378:            filename, and the contents of the file to create/modifed exist
1.620     albertel 15379:            the filename is in $env{'form.'.$formname.'.filename'} and the
                   15380:            contents of the file is located in $env{'form.'.$formname}
1.1090    raeburn  15381:  context - if coursedoc, store the file in the course of the active role
                   15382:              of the current user; 
                   15383:            if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
                   15384:            if 'canceloverwrite': delete file in tmp/overwrites directory
1.608     albertel 15385:  subdir - required - subdirectory to put the file in under ../userfiles/
                   15386:          if undefined, it will be placed in "unknown"
                   15387: 
                   15388:  (This routine calls clean_filename() to remove any dangerous
                   15389:  characters from the filename, and then calls finuserfileupload() to
                   15390:  complete the transaction)
                   15391: 
                   15392:  returns either the url of the uploaded file (/uploaded/....) if successful
                   15393:  and /adm/notfound.html if unsuccessful
                   15394: 
                   15395: =item *
                   15396: 
                   15397: clean_filename(): routine for cleaing a filename up for storage in
                   15398:                  userfile space, argument is:
                   15399: 
                   15400:  filename - proposed filename
                   15401: 
                   15402: returns: the new clean filename
                   15403: 
                   15404: =item *
                   15405: 
1.1090    raeburn  15406: finishuserfileupload(): routine that creates and sends the file to
1.608     albertel 15407: userspace, probably shouldn't be called directly
                   15408: 
                   15409:   docuname: username or courseid of destination for the file
                   15410:   docudom: domain of user/course of destination for the file
                   15411:   formname: same as for userfileupload()
1.1090    raeburn  15412:   fname: filename (including subdirectories) for the file
                   15413:   parser: if 'parse', will parse (html) file to extract references to objects, links etc.
                   15414:   allfiles: reference to hash used to store objects found by parser
                   15415:   codebase: reference to hash used for codebases of java objects found by parser
                   15416:   thumbwidth: width (pixels) of thumbnail to be created for uploaded image
                   15417:   thumbheight: height (pixels) of thumbnail to be created for uploaded image
                   15418:   resizewidth: width to be used to resize image using resizeImage from ImageMagick
                   15419:   resizeheight: height to be used to resize image using resizeImage from ImageMagick
                   15420:   context: if 'overwrite', will move the uploaded file from its temporary location to
                   15421:             userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095    raeburn  15422:   mimetype: reference to scalar to accommodate mime type determined
                   15423:             from File::MMagic if $parser = parse.
1.608     albertel 15424: 
                   15425:  returns either the url of the uploaded file (/uploaded/....) if successful
1.1090    raeburn  15426:  and /adm/notfound.html if unsuccessful (or an error message if context 
                   15427:  was 'overwrite').
                   15428:  
1.608     albertel 15429: 
                   15430: =item *
                   15431: 
                   15432: renameuserfile(): renames an existing userfile to a new name
                   15433: 
                   15434:   Args:
                   15435:    docuname: username or courseid of destination for the file
                   15436:    docudom: domain of user/course of destination for the file
                   15437:    old: current file name (including any subdirs under userfiles)
                   15438:    new: desired file name (including any subdirs under userfiles)
                   15439: 
                   15440: =item *
                   15441: 
                   15442: mkdiruserfile(): creates a directory is a userfiles dir
                   15443: 
                   15444:   Args:
                   15445:    docuname: username or courseid of destination for the file
                   15446:    docudom: domain of user/course of destination for the file
                   15447:    dir: dir to create (including any subdirs under userfiles)
                   15448: 
                   15449: =item *
                   15450: 
                   15451: removeuserfile(): removes a file that exists in userfiles
                   15452: 
                   15453:   Args:
                   15454:    docuname: username or courseid of destination for the file
                   15455:    docudom: domain of user/course of destination for the file
                   15456:    fname: filname to delete (including any subdirs under userfiles)
                   15457: 
                   15458: =item *
                   15459: 
                   15460: removeuploadedurl(): convience function for removeuserfile()
                   15461: 
                   15462:   Args:
                   15463:    url:  a full /uploaded/... url to delete
                   15464: 
1.747     albertel 15465: =item * 
                   15466: 
                   15467: get_portfile_permissions():
                   15468:   Args:
                   15469:     domain: domain of user or course contain the portfolio files
                   15470:     user: name of user or num of course contain the portfolio files
                   15471:   Returns:
                   15472:     hashref of a dump of the proper file_permissions.db
                   15473:    
                   15474: 
                   15475: =item * 
                   15476: 
                   15477: get_access_controls():
                   15478: 
                   15479: Args:
                   15480:   current_permissions: the hash ref returned from get_portfile_permissions()
                   15481:   group: (optional) the group you want the files associated with
                   15482:   file: (optional) the file you want access info on
                   15483: 
                   15484: Returns:
1.749     raeburn  15485:     a hash (keys are file names) of hashes containing
                   15486:         keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
                   15487:         values are XML containing access control settings (see below) 
1.747     albertel 15488: 
                   15489: Internal notes:
                   15490: 
1.749     raeburn  15491:  access controls are stored in file_permissions.db as key=value pairs.
                   15492:     key -> path to file/file_name\0uniqueID:scope_end_start
                   15493:         where scope -> public,guest,course,group,domains or users.
                   15494:               end -> UNIX time for end of access (0 -> no end date)
                   15495:               start -> UNIX time for start of access
                   15496: 
                   15497:     value -> XML description of access control
                   15498:            <scope type=""> (type =1 of: public,guest,course,group,domains,users">
                   15499:             <start></start>
                   15500:             <end></end>
                   15501: 
                   15502:             <password></password>  for scope type = guest
                   15503: 
                   15504:             <domain></domain>     for scope type = course or group
                   15505:             <number></number>
                   15506:             <roles id="">
                   15507:              <role></role>
                   15508:              <access></access>
                   15509:              <section></section>
                   15510:              <group></group>
                   15511:             </roles>
                   15512: 
                   15513:             <dom></dom>         for scope type = domains
                   15514: 
                   15515:             <users>             for scope type = users
                   15516:              <user>
                   15517:               <uname></uname>
                   15518:               <udom></udom>
                   15519:              </user>
                   15520:             </users>
                   15521:            </scope> 
                   15522:               
                   15523:  Access data is also aggregated for each file in an additional key=value pair:
                   15524:  key -> path to file/file_name\0accesscontrol 
                   15525:  value -> reference to hash
                   15526:           hash contains key = value pairs
                   15527:           where key = uniqueID:scope_end_start
                   15528:                 value = UNIX time record was last updated
                   15529: 
                   15530:           Used to improve speed of look-ups of access controls for each file.  
                   15531:  
                   15532:  Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
                   15533: 
1.1198    raeburn  15534: =item *
                   15535: 
1.749     raeburn  15536: modify_access_controls():
                   15537: 
                   15538: Modifies access controls for a portfolio file
                   15539: Args
                   15540: 1. file name
                   15541: 2. reference to hash of required changes,
                   15542: 3. domain
                   15543: 4. username
                   15544:   where domain,username are the domain of the portfolio owner 
                   15545:   (either a user or a course) 
                   15546: 
                   15547: Returns:
                   15548: 1. result of additions or updates ('ok' or 'error', with error message). 
                   15549: 2. result of deletions ('ok' or 'error', with error message).
                   15550: 3. reference to hash of any new or updated access controls.
                   15551: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
                   15552:    key = integer (inbound ID)
1.1198    raeburn  15553:    value = uniqueID
                   15554: 
                   15555: =item *
                   15556: 
                   15557: get_timebased_id():
                   15558: 
                   15559: Attempts to get a unique timestamp-based suffix for use with items added to a 
                   15560: course via the Course Editor (e.g., folders, composite pages, 
                   15561: group bulletin boards).
                   15562: 
                   15563: Args: (first three required; six others optional)
                   15564: 
                   15565: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
                   15566:    docssequence, or name of group
                   15567: 
                   15568: 2. keyid (alphanumeric): name of temporary locking key in hash,
                   15569:    e.g., num, boardids
                   15570: 
                   15571: 3. namespace: name of gdbm file used to store suffixes already assigned;  
                   15572:    file will be named nohist_namespace.db
                   15573: 
                   15574: 4. cdom: domain of course; default is current course domain from %env
                   15575: 
                   15576: 5. cnum: course number; default is current course number from %env
                   15577: 
                   15578: 6. idtype: set to concat if an additional digit is to be appended to the 
                   15579:    unix timestamp to form the suffix, if the plain timestamp is already
                   15580:    in use.  Default is to not do this, but simply increment the unix 
                   15581:    timestamp by 1 until a unique key is obtained.
                   15582: 
                   15583: 7. who: holder of locking key; defaults to user:domain for user.
                   15584: 
                   15585: 8. locktries: number of attempts to obtain a lock (sleep of 1s before 
                   15586:    retrying); default is 3.
                   15587: 
                   15588: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.  
                   15589: 
                   15590: Returns:
                   15591: 
                   15592: 1. suffix obtained (numeric)
                   15593: 
                   15594: 2. result of deleting locking key (ok if deleted, or lock never obtained)
                   15595: 
                   15596: 3. error: contains (localized) error message if an error occurred.
                   15597: 
1.747     albertel 15598: 
1.608     albertel 15599: =back
                   15600: 
1.243     albertel 15601: =head2 HTTP Helper Routines
                   15602: 
                   15603: =over 4
                   15604: 
1.191     harris41 15605: =item *
                   15606: 
                   15607: escape() : unpack non-word characters into CGI-compatible hex codes
                   15608: 
                   15609: =item *
                   15610: 
                   15611: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
                   15612: 
1.243     albertel 15613: =back
                   15614: 
                   15615: =head1 PRIVATE SUBROUTINES
                   15616: 
                   15617: =head2 Underlying communication routines (Shouldn't call)
                   15618: 
                   15619: =over 4
                   15620: 
                   15621: =item *
                   15622: 
                   15623: subreply() : tries to pass a message to lonc, returns con_lost if incapable
                   15624: 
                   15625: =item *
                   15626: 
                   15627: reply() : uses subreply to send a message to remote machine, logs all failures
                   15628: 
                   15629: =item *
                   15630: 
                   15631: critical() : passes a critical message to another server; if cannot
                   15632: get through then place message in connection buffer directory and
                   15633: returns con_delayed, if incapable of saving message, returns
                   15634: con_failed
                   15635: 
                   15636: =item *
                   15637: 
                   15638: reconlonc() : tries to reconnect lonc client processes.
                   15639: 
                   15640: =back
                   15641: 
                   15642: =head2 Resource Access Logging
                   15643: 
                   15644: =over 4
                   15645: 
                   15646: =item *
                   15647: 
                   15648: flushcourselogs() : flush (save) buffer logs and access logs
                   15649: 
                   15650: =item *
                   15651: 
                   15652: courselog($what) : save message for course in hash
                   15653: 
                   15654: =item *
                   15655: 
                   15656: courseacclog($what) : save message for course using &courselog().  Perform
                   15657: special processing for specific resource types (problems, exams, quizzes, etc).
                   15658: 
1.191     harris41 15659: =item *
                   15660: 
                   15661: goodbye() : flush course logs and log shutting down; it is called in srm.conf
                   15662: as a PerlChildExitHandler
1.243     albertel 15663: 
                   15664: =back
                   15665: 
                   15666: =head2 Other
                   15667: 
                   15668: =over 4
                   15669: 
                   15670: =item *
                   15671: 
                   15672: symblist($mapname,%newhash) : update symbolic storage links
1.191     harris41 15673: 
                   15674: =back
                   15675: 
                   15676: =cut
1.877     foxr     15677: 

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