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

1.1       albertel    1: # The LearningOnline Network
                      2: # TCP networking package
1.12      www         3: #
1.385   ! matthew     4: # $Id: lonnet.pm,v 1.384 2003/07/01 20:45:17 albertel 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: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
                     29: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
                     30: # 11/8,11/16,11/18,11/22,11/23,12/22,
                     31: # 01/06,01/13,02/24,02/28,02/29,
                     32: # 03/01,03/02,03/06,03/07,03/13,
                     33: # 04/05,05/29,05/31,06/01,
                     34: # 06/05,06/26 Gerd Kortemeyer
                     35: # 06/26 Ben Tyszka
                     36: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
                     37: # 08/14 Ben Tyszka
                     38: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
                     39: # 10/04 Gerd Kortemeyer
                     40: # 10/04 Guy Albertelli
                     41: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29, 
                     42: # 10/30,10/31,
                     43: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
                     44: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
                     45: # 05/01/01 Guy Albertelli
                     46: # 05/01,06/01,09/01 Gerd Kortemeyer
                     47: # 09/01 Guy Albertelli
                     48: # 09/01,10/01,11/01 Gerd Kortemeyer
                     49: # YEAR=2001
                     50: # 3/2 Gerd Kortemeyer
                     51: # 3/19,3/20 Gerd Kortemeyer
                     52: # 5/26,5/28 Gerd Kortemeyer
                     53: # 5/30 H. K. Ng
                     54: # 6/1 Gerd Kortemeyer
                     55: # July Guy Albertelli
                     56: # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
                     57: # 10/2 Gerd Kortemeyer
1.179     www        58: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
1.182     matthew    59: # 12/5 Matthew Hall
1.184     www        60: # 12/5 Guy Albertelli
1.190     www        61: # 12/6,12/7,12/12 Gerd Kortemeyer
1.195     www        62: # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
1.196     www        63: # YEAR=2002
1.200     www        64: # 1/4,2/4,2/7 Gerd Kortemeyer
1.171     www        65: #
1.169     harris41   66: ###
                     67: 
1.1       albertel   68: package Apache::lonnet;
                     69: 
                     70: use strict;
                     71: use Apache::File;
1.8       www        72: use LWP::UserAgent();
1.15      www        73: use HTTP::Headers;
1.11      www        74: use vars 
1.300     albertel   75: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom 
1.301     www        76:    %libserv %pr %prp %metacache %packagetab %titlecache 
1.349     www        77:    %courselogs %accesshash %userrolehash $processmarker $dumpcount 
1.352     www        78:    %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache 
1.329     matthew    79:    %domaindescription %domain_auth_def %domain_auth_arg_def $tmpdir);
1.1       albertel   80: use IO::Socket;
1.31      www        81: use GDBM_File;
1.8       www        82: use Apache::Constants qw(:common :http);
1.208     albertel   83: use HTML::LCParser;
1.88      www        84: use Fcntl qw(:flock);
1.294     matthew    85: use Apache::loncoursedata;
                     86: 
1.195     www        87: my $readit;
1.1       albertel   88: 
                     89: # --------------------------------------------------------------------- Logging
                     90: 
1.163     harris41   91: sub logtouch {
                     92:     my $execdir=$perlvar{'lonDaemons'};
                     93:     unless (-e "$execdir/logs/lonnet.log") {
                     94: 	my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
                     95: 	close $fh;
                     96:     }
                     97:     my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
                     98:     chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
                     99: }
                    100: 
1.1       albertel  101: sub logthis {
                    102:     my $message=shift;
                    103:     my $execdir=$perlvar{'lonDaemons'};
                    104:     my $now=time;
                    105:     my $local=localtime($now);
1.162     harris41  106:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
                    107:     print $fh "$local ($$): $message\n";
1.1       albertel  108:     return 1;
                    109: }
                    110: 
                    111: sub logperm {
                    112:     my $message=shift;
                    113:     my $execdir=$perlvar{'lonDaemons'};
                    114:     my $now=time;
                    115:     my $local=localtime($now);
1.162     harris41  116:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
                    117:     print $fh "$now:$message:$local\n";
1.1       albertel  118:     return 1;
                    119: }
                    120: 
                    121: # -------------------------------------------------- Non-critical communication
                    122: sub subreply {
                    123:     my ($cmd,$server)=@_;
                    124:     my $peerfile="$perlvar{'lonSockDir'}/$server";
                    125:     my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                    126:                                      Type    => SOCK_STREAM,
                    127:                                      Timeout => 10)
                    128:        or return "con_lost";
                    129:     print $client "$cmd\n";
                    130:     my $answer=<$client>;
1.9       www       131:     if (!$answer) { $answer="con_lost"; }
1.1       albertel  132:     chomp($answer);
                    133:     return $answer;
                    134: }
                    135: 
                    136: sub reply {
                    137:     my ($cmd,$server)=@_;
1.205     www       138:     unless (defined($hostname{$server})) { return 'no_such_host'; }
1.1       albertel  139:     my $answer=subreply($cmd,$server);
1.203     www       140:     if ($answer eq 'con_lost') {
1.311     matthew   141:         #sleep 5; 
                    142:         #$answer=subreply($cmd,$server);
                    143:         #if ($answer eq 'con_lost') {
1.233     albertel  144: 	#   &logthis("Second attempt con_lost on $server");
                    145:         #   my $peerfile="$perlvar{'lonSockDir'}/$server";
                    146:         #   my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                    147:         #                                    Type    => SOCK_STREAM,
                    148:         #                                    Timeout => 10)
                    149:         #              or return "con_lost";
                    150:         #   &logthis("Killing socket");
                    151:         #   print $client "close_connection_exit\n";
                    152:            #sleep 5;
                    153:         #   $answer=subreply($cmd,$server);       
                    154:        #}   
1.203     www       155:     }
1.65      www       156:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.12      www       157:        &logthis("<font color=blue>WARNING:".
                    158:                 " $cmd to $server returned $answer</font>");
                    159:     }
1.1       albertel  160:     return $answer;
                    161: }
                    162: 
                    163: # ----------------------------------------------------------- Send USR1 to lonc
                    164: 
                    165: sub reconlonc {
                    166:     my $peerfile=shift;
                    167:     &logthis("Trying to reconnect for $peerfile");
                    168:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
                    169:     if (my $fh=Apache::File->new("$loncfile")) {
                    170: 	my $loncpid=<$fh>;
                    171:         chomp($loncpid);
                    172:         if (kill 0 => $loncpid) {
                    173: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
                    174:             kill USR1 => $loncpid;
                    175:             sleep 1;
                    176:             if (-e "$peerfile") { return; }
                    177:             &logthis("$peerfile still not there, give it another try");
                    178:             sleep 5;
                    179:             if (-e "$peerfile") { return; }
1.12      www       180:             &logthis(
                    181:   "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
1.1       albertel  182:         } else {
1.12      www       183: 	    &logthis(
                    184:                "<font color=blue>WARNING:".
                    185:                " lonc at pid $loncpid not responding, giving up</font>");
1.1       albertel  186:         }
                    187:     } else {
1.12      www       188:      &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
1.1       albertel  189:     }
                    190: }
                    191: 
                    192: # ------------------------------------------------------ Critical communication
1.12      www       193: 
1.1       albertel  194: sub critical {
                    195:     my ($cmd,$server)=@_;
1.89      www       196:     unless ($hostname{$server}) {
                    197:         &logthis("<font color=blue>WARNING:".
                    198:                " Critical message to unknown server ($server)</font>");
                    199:         return 'no_such_host';
                    200:     }
1.1       albertel  201:     my $answer=reply($cmd,$server);
                    202:     if ($answer eq 'con_lost') {
                    203:         my $pingreply=reply('ping',$server);
                    204: 	&reconlonc("$perlvar{'lonSockDir'}/$server");
                    205:         my $pongreply=reply('pong',$server);
                    206:         &logthis("Ping/Pong for $server: $pingreply/$pongreply");
                    207:         $answer=reply($cmd,$server);
                    208:         if ($answer eq 'con_lost') {
                    209:             my $now=time;
                    210:             my $middlename=$cmd;
1.5       www       211:             $middlename=substr($middlename,0,16);
1.1       albertel  212:             $middlename=~s/\W//g;
                    213:             my $dfilename=
1.305     www       214:       "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
                    215:             $dumpcount++;
1.1       albertel  216:             {
                    217:              my $dfh;
                    218:              if ($dfh=Apache::File->new(">$dfilename")) {
1.7       www       219:                 print $dfh "$cmd\n";
1.1       albertel  220: 	     }
                    221:             }
                    222:             sleep 2;
                    223:             my $wcmd='';
                    224:             {
                    225: 	     my $dfh;
                    226:              if ($dfh=Apache::File->new("$dfilename")) {
                    227:                 $wcmd=<$dfh>;
                    228: 	     }
                    229:             }
                    230:             chomp($wcmd);
1.7       www       231:             if ($wcmd eq $cmd) {
1.12      www       232: 		&logthis("<font color=blue>WARNING: ".
                    233:                          "Connection buffer $dfilename: $cmd</font>");
1.1       albertel  234:                 &logperm("D:$server:$cmd");
                    235: 	        return 'con_delayed';
                    236:             } else {
1.12      www       237:                 &logthis("<font color=red>CRITICAL:"
                    238:                         ." Critical connection failed: $server $cmd</font>");
1.1       albertel  239:                 &logperm("F:$server:$cmd");
                    240:                 return 'con_failed';
                    241:             }
                    242:         }
                    243:     }
                    244:     return $answer;
1.374     www       245: }
                    246:  
                    247: # ------------------------------------------- Transfer profile into environment
                    248: 
                    249: sub transfer_profile_to_env {
                    250:     my ($lonidsdir,$handle)=@_;
                    251:     my @profile;
                    252:     {
                    253: 	my $idf=Apache::File->new("$lonidsdir/$handle.id");
                    254: 	flock($idf,LOCK_SH);
                    255: 	@profile=<$idf>;
                    256: 	$idf->close();
                    257:     }
                    258:     my $envi;
                    259:     for ($envi=0;$envi<=$#profile;$envi++) {
                    260: 	chomp($profile[$envi]);
                    261: 	my ($envname,$envvalue)=split(/=/,$profile[$envi]);
                    262: 	$ENV{$envname} = $envvalue;
                    263:     }
                    264:     $ENV{'user.environment'} = "$lonidsdir/$handle.id";
1.1       albertel  265: }
                    266: 
1.5       www       267: # ---------------------------------------------------------- Append Environment
                    268: 
                    269: sub appenv {
1.6       www       270:     my %newenv=@_;
1.191     harris41  271:     foreach (keys %newenv) {
1.35      www       272: 	if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
                    273:             &logthis("<font color=blue>WARNING: ".
1.151     www       274:                 "Attempt to modify environment ".$_." to ".$newenv{$_}
                    275:                 .'</font>');
1.35      www       276: 	    delete($newenv{$_});
                    277:         } else {
                    278:             $ENV{$_}=$newenv{$_};
                    279:         }
1.191     harris41  280:     }
1.95      www       281: 
                    282:     my $lockfh;
                    283:     unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
1.97      www       284:        return 'error: '.$!;
1.95      www       285:     }
                    286:     unless (flock($lockfh,LOCK_EX)) {
                    287:          &logthis("<font color=blue>WARNING: ".
                    288:                   'Could not obtain exclusive lock in appenv: '.$!);
                    289:          $lockfh->close();
                    290:          return 'error: '.$!;
                    291:     }
                    292: 
1.6       www       293:     my @oldenv;
                    294:     {
                    295:      my $fh;
                    296:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
1.97      www       297: 	return 'error: '.$!;
1.6       www       298:      }
                    299:      @oldenv=<$fh>;
1.89      www       300:      $fh->close();
1.6       www       301:     }
                    302:     for (my $i=0; $i<=$#oldenv; $i++) {
                    303:         chomp($oldenv[$i]);
1.9       www       304:         if ($oldenv[$i] ne '') {
                    305:            my ($name,$value)=split(/=/,$oldenv[$i]);
1.24      www       306:            unless (defined($newenv{$name})) {
                    307: 	      $newenv{$name}=$value;
                    308: 	   }
1.9       www       309:         }
1.6       www       310:     }
                    311:     {
                    312:      my $fh;
                    313:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
                    314: 	return 'error';
                    315:      }
                    316:      my $newname;
1.93      www       317:      foreach $newname (keys %newenv) {
1.6       www       318: 	 print $fh "$newname=$newenv{$newname}\n";
                    319:      }
1.86      albertel  320:      $fh->close();
1.56      www       321:     }
1.95      www       322: 
                    323:     $lockfh->close();
1.56      www       324:     return 'ok';
                    325: }
                    326: # ----------------------------------------------------- Delete from Environment
                    327: 
                    328: sub delenv {
                    329:     my $delthis=shift;
                    330:     my %newenv=();
                    331:     if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
                    332:         &logthis("<font color=blue>WARNING: ".
                    333:                 "Attempt to delete from environment ".$delthis);
                    334:         return 'error';
                    335:     }
                    336:     my @oldenv;
                    337:     {
                    338:      my $fh;
                    339:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
                    340: 	return 'error';
                    341:      }
1.89      www       342:      unless (flock($fh,LOCK_SH)) {
                    343:          &logthis("<font color=blue>WARNING: ".
                    344:                   'Could not obtain shared lock in delenv: '.$!);
                    345:          $fh->close();
                    346:          return 'error: '.$!;
                    347:      }
1.56      www       348:      @oldenv=<$fh>;
1.89      www       349:      $fh->close();
1.56      www       350:     }
                    351:     {
                    352:      my $fh;
                    353:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
                    354: 	return 'error';
                    355:      }
1.89      www       356:      unless (flock($fh,LOCK_EX)) {
                    357:          &logthis("<font color=blue>WARNING: ".
                    358:                   'Could not obtain exclusive lock in delenv: '.$!);
                    359:          $fh->close();
                    360:          return 'error: '.$!;
                    361:      }
1.191     harris41  362:      foreach (@oldenv) {
1.56      www       363: 	 unless ($_=~/^$delthis/) { print $fh $_; }
1.191     harris41  364:      }
1.87      www       365:      $fh->close();
1.5       www       366:     }
                    367:     return 'ok';
1.369     albertel  368: }
                    369: 
                    370: # ------------------------------------------ Find out current server userload
                    371: # there is a copy in lond
                    372: sub userload {
                    373:     my $numusers=0;
                    374:     {
                    375: 	opendir(LONIDS,$perlvar{'lonIDsDir'});
                    376: 	my $filename;
                    377: 	my $curtime=time;
                    378: 	while ($filename=readdir(LONIDS)) {
                    379: 	    if ($filename eq '.' || $filename eq '..') {next;}
                    380: 	    my ($atime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[8];
1.371     albertel  381: 	    if ($curtime-$atime < 3600) { $numusers++; }
1.369     albertel  382: 	}
                    383: 	closedir(LONIDS);
                    384:     }
                    385:     my $userloadpercent=0;
                    386:     my $maxuserload=$perlvar{'lonUserLoadLim'};
                    387:     if ($maxuserload) {
1.371     albertel  388: 	$userloadpercent=100*$numusers/$maxuserload;
1.369     albertel  389:     }
1.372     albertel  390:     $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369     albertel  391:     return $userloadpercent;
1.283     www       392: }
                    393: 
                    394: # ------------------------------------------ Fight off request when overloaded
                    395: 
                    396: sub overloaderror {
                    397:     my ($r,$checkserver)=@_;
                    398:     unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
                    399:     my $loadavg;
                    400:     if ($checkserver eq $perlvar{'lonHostID'}) {
                    401:        my $loadfile=Apache::File->new('/proc/loadavg');
                    402:        $loadavg=<$loadfile>;
                    403:        $loadavg =~ s/\s.*//g;
1.285     matthew   404:        $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.283     www       405:     } else {
                    406:        $loadavg=&reply('load',$checkserver);
                    407:     }
1.285     matthew   408:     my $overload=$loadavg-100;
1.283     www       409:     if ($overload>0) {
1.285     matthew   410: 	$r->err_headers_out->{'Retry-After'}=$overload;
1.283     www       411:         $r->log_error('Overload of '.$overload.' on '.$checkserver);
                    412:         return 413;
                    413:     }    
                    414:     return '';
1.5       www       415: }
1.1       albertel  416: 
                    417: # ------------------------------ Find server with least workload from spare.tab
1.11      www       418: 
1.1       albertel  419: sub spareserver {
1.370     albertel  420:     my ($loadpercent,$userloadpercent) = @_;
1.1       albertel  421:     my $tryserver;
                    422:     my $spareserver='';
1.370     albertel  423:     if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
                    424:     my $lowestserver=$loadpercent > $userloadpercent?
                    425: 	             $loadpercent :  $userloadpercent;
1.1       albertel  426:     foreach $tryserver (keys %spareid) {
1.370     albertel  427:        my $loadans=reply('load',$tryserver);
                    428:        my $userloadans=reply('userload',$tryserver);
                    429:        if ($userloadans !~ /\d/) { $userloadans=0; }
                    430:        my $answer=$loadans > $userloadans?
                    431:                   $loadans :  $userloadans;
1.1       albertel  432:        if (($answer =~ /\d/) && ($answer<$lowestserver)) {
                    433: 	   $spareserver="http://$hostname{$tryserver}";
                    434:            $lowestserver=$answer;
                    435:        }
1.370     albertel  436:     }
1.1       albertel  437:     return $spareserver;
1.202     matthew   438: }
                    439: 
                    440: # --------------------------------------------- Try to change a user's password
                    441: 
                    442: sub changepass {
                    443:     my ($uname,$udom,$currentpass,$newpass,$server)=@_;
                    444:     $currentpass = &escape($currentpass);
                    445:     $newpass     = &escape($newpass);
                    446:     my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
                    447: 		       $server);
                    448:     if (! $answer) {
                    449: 	&logthis("No reply on password change request to $server ".
                    450: 		 "by $uname in domain $udom.");
                    451:     } elsif ($answer =~ "^ok") {
                    452:         &logthis("$uname in $udom successfully changed their password ".
                    453: 		 "on $server.");
                    454:     } elsif ($answer =~ "^pwchange_failure") {
                    455: 	&logthis("$uname in $udom was unable to change their password ".
                    456: 		 "on $server.  The action was blocked by either lcpasswd ".
                    457: 		 "or pwchange");
                    458:     } elsif ($answer =~ "^non_authorized") {
                    459:         &logthis("$uname in $udom did not get their password correct when ".
                    460: 		 "attempting to change it on $server.");
                    461:     } elsif ($answer =~ "^auth_mode_error") {
                    462:         &logthis("$uname in $udom attempted to change their password despite ".
                    463: 		 "not being locally or internally authenticated on $server.");
                    464:     } elsif ($answer =~ "^unknown_user") {
                    465:         &logthis("$uname in $udom attempted to change their password ".
                    466: 		 "on $server but were unable to because $server is not ".
                    467: 		 "their home server.");
                    468:     } elsif ($answer =~ "^refused") {
                    469: 	&logthis("$server refused to change $uname in $udom password because ".
                    470: 		 "it was sent an unencrypted request to change the password.");
                    471:     }
                    472:     return $answer;
1.1       albertel  473: }
                    474: 
1.169     harris41  475: # ----------------------- Try to determine user's current authentication scheme
                    476: 
                    477: sub queryauthenticate {
                    478:     my ($uname,$udom)=@_;
                    479:     if (($perlvar{'lonRole'} eq 'library') && 
                    480:         ($udom eq $perlvar{'lonDefDomain'})) {
                    481: 	my $answer=reply("encrypt:currentauth:$udom:$uname",
                    482: 			 $perlvar{'lonHostID'});
                    483: 	unless ($answer eq 'unknown_user' or $answer eq 'refused') {
                    484: 	    if (length($answer)) {
                    485: 		return $answer;
                    486: 	    }
                    487: 	    else {
                    488: 	&logthis("User $uname at $udom lacks an authentication mechanism");
                    489: 		return 'no_host';
                    490: 	    }
                    491: 	}
                    492:     }
                    493: 
                    494:     my $tryserver;
                    495:     foreach $tryserver (keys %libserv) {
                    496: 	if ($hostdom{$tryserver} eq $udom) {
                    497:            my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
                    498: 	   unless ($answer eq 'unknown_user' or $answer eq 'refused') {
                    499: 	       if (length($answer)) {
                    500: 		   return $answer;
                    501: 	       }
                    502: 	       else {
                    503: 	   &logthis("User $uname at $udom lacks an authentication mechanism");
                    504: 		   return 'no_host';
                    505: 	       }
                    506: 	   }
                    507:        }
                    508:     }
                    509:     &logthis("User $uname at $udom lacks an authentication mechanism");    
                    510:     return 'no_host';
                    511: }
                    512: 
1.1       albertel  513: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11      www       514: 
1.1       albertel  515: sub authenticate {
                    516:     my ($uname,$upass,$udom)=@_;
1.12      www       517:     $upass=escape($upass);
1.199     www       518:     $uname=~s/\W//g;
1.1       albertel  519:     if (($perlvar{'lonRole'} eq 'library') && 
                    520:         ($udom eq $perlvar{'lonDefDomain'})) {
1.3       www       521:     my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
1.2       www       522:         if ($answer =~ /authorized/) {
1.9       www       523:               if ($answer eq 'authorized') {
                    524:                  &logthis("User $uname at $udom authorized by local server"); 
                    525:                  return $perlvar{'lonHostID'}; 
                    526:               }
                    527:               if ($answer eq 'non_authorized') {
                    528:                  &logthis("User $uname at $udom rejected by local server"); 
                    529:                  return 'no_host'; 
                    530:               }
1.2       www       531: 	}
1.1       albertel  532:     }
                    533: 
                    534:     my $tryserver;
                    535:     foreach $tryserver (keys %libserv) {
                    536: 	if ($hostdom{$tryserver} eq $udom) {
1.10      www       537:            my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
1.1       albertel  538:            if ($answer =~ /authorized/) {
1.9       www       539:               if ($answer eq 'authorized') {
                    540:                  &logthis("User $uname at $udom authorized by $tryserver"); 
                    541:                  return $tryserver; 
                    542:               }
                    543:               if ($answer eq 'non_authorized') {
                    544:                  &logthis("User $uname at $udom rejected by $tryserver");
                    545:                  return 'no_host';
                    546:               } 
1.1       albertel  547: 	   }
                    548:        }
1.9       www       549:     }
                    550:     &logthis("User $uname at $udom could not be authenticated");    
1.1       albertel  551:     return 'no_host';
                    552: }
                    553: 
                    554: # ---------------------- Find the homebase for a user from domain's lib servers
1.11      www       555: 
1.1       albertel  556: sub homeserver {
1.230     stredwic  557:     my ($uname,$udom,$ignoreBadCache)=@_;
1.1       albertel  558:     my $index="$uname:$udom";
1.221     matthew   559:     if ($homecache{$index}) { 
                    560:         return "$homecache{$index}"; 
                    561:     }
1.1       albertel  562:     my $tryserver;
                    563:     foreach $tryserver (keys %libserv) {
1.230     stredwic  564:         next if ($ignoreBadCache ne 'true' && 
1.231     stredwic  565: 		 exists($badServerCache{$tryserver}));
1.1       albertel  566: 	if ($hostdom{$tryserver} eq $udom) {
                    567:            my $answer=reply("home:$udom:$uname",$tryserver);
                    568:            if ($answer eq 'found') { 
1.221     matthew   569:               $homecache{$index}=$tryserver;
1.1       albertel  570:               return $tryserver; 
1.231     stredwic  571:            } elsif ($answer eq 'no_host') {
                    572: 	       $badServerCache{$tryserver}=1;
1.221     matthew   573:            }
1.1       albertel  574:        }
                    575:     }    
                    576:     return 'no_host';
1.70      www       577: }
                    578: 
                    579: # ------------------------------------- Find the usernames behind a list of IDs
                    580: 
                    581: sub idget {
                    582:     my ($udom,@ids)=@_;
                    583:     my %returnhash=();
                    584:     
                    585:     my $tryserver;
                    586:     foreach $tryserver (keys %libserv) {
                    587:        if ($hostdom{$tryserver} eq $udom) {
                    588: 	  my $idlist=join('&',@ids);
                    589:           $idlist=~tr/A-Z/a-z/; 
                    590: 	  my $reply=&reply("idget:$udom:".$idlist,$tryserver);
                    591:           my @answer=();
1.76      www       592:           if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70      www       593: 	      @answer=split(/\&/,$reply);
                    594:           }                    ;
                    595:           my $i;
                    596:           for ($i=0;$i<=$#ids;$i++) {
                    597:               if ($answer[$i]) {
                    598: 		  $returnhash{$ids[$i]}=$answer[$i];
                    599:               } 
                    600:           }
                    601:        }
                    602:     }    
                    603:     return %returnhash;
                    604: }
                    605: 
                    606: # ------------------------------------- Find the IDs behind a list of usernames
                    607: 
                    608: sub idrget {
                    609:     my ($udom,@unames)=@_;
                    610:     my %returnhash=();
1.191     harris41  611:     foreach (@unames) {
1.70      www       612:         $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
1.191     harris41  613:     }
1.70      www       614:     return %returnhash;
                    615: }
                    616: 
                    617: # ------------------------------- Store away a list of names and associated IDs
                    618: 
                    619: sub idput {
                    620:     my ($udom,%ids)=@_;
                    621:     my %servers=();
1.191     harris41  622:     foreach (keys %ids) {
1.70      www       623:         my $uhom=&homeserver($_,$udom);
                    624:         if ($uhom ne 'no_host') {
                    625:             my $id=&escape($ids{$_});
                    626:             $id=~tr/A-Z/a-z/;
                    627:             my $unam=&escape($_);
                    628: 	    if ($servers{$uhom}) {
                    629: 		$servers{$uhom}.='&'.$id.'='.$unam;
                    630:             } else {
                    631:                 $servers{$uhom}=$id.'='.$unam;
                    632:             }
                    633:             &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
                    634:         }
1.191     harris41  635:     }
                    636:     foreach (keys %servers) {
1.70      www       637:         &critical('idput:'.$udom.':'.$servers{$_},$_);
1.191     harris41  638:     }
1.344     www       639: }
                    640: 
                    641: # --------------------------------------------------- Assign a key to a student
                    642: 
                    643: sub assign_access_key {
1.364     www       644: #
                    645: # a valid key looks like uname:udom#comments
                    646: # comments are being appended
                    647: #
                    648:     my ($ckey,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1.344     www       649:     $cdom=
                    650:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
                    651:     $cnum=
                    652:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
                    653:     $udom=$ENV{'user.name'} unless (defined($udom));
                    654:     $uname=$ENV{'user.domain'} unless (defined($uname));
1.345     www       655:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.364     www       656:     if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
                    657:         ($existing{$ckey}=~/^$uname\:$udom\#(.*)$/)) { 
                    658:                                                   # assigned to this person
                    659:                                                   # - this should not happen,
1.345     www       660:                                                   # unless something went wrong
                    661:                                                   # the first time around
                    662: # ready to assign
1.364     www       663:         $logentry=$1.'; '.$logentry;
                    664:         if (&put('accesskey',{$ckey=>$uname.':'.$udom.'#'.$logentry},
                    665:                                                  $cdom,$cnum) eq 'ok') {
1.345     www       666: # key now belongs to user
1.346     www       667: 	    my $envkey='key.'.$cdom.'_'.$cnum;
1.345     www       668:             if (&put('environment',{$envkey => $ckey}) eq 'ok') {
                    669:                 &appenv('environment.'.$envkey => $ckey);
                    670:                 return 'ok';
                    671:             } else {
                    672:                 return 
                    673:   'error: Count not permanently assign key, will need to be re-entered later.';
                    674: 	    }
                    675:         } else {
                    676:             return 'error: Could not assign key, try again later.';
                    677:         }
1.364     www       678:     } elsif (!$existing{$ckey}) {
1.345     www       679: # the key does not exist
                    680: 	return 'error: The key does not exist';
                    681:     } else {
                    682: # the key is somebody else's
                    683: 	return 'error: The key is already in use';
                    684:     }
1.344     www       685: }
                    686: 
1.364     www       687: # ------------------------------------------ put an additional comment on a key
                    688: 
                    689: sub comment_access_key {
                    690: #
                    691: # a valid key looks like uname:udom#comments
                    692: # comments are being appended
                    693: #
                    694:     my ($ckey,$cdom,$cnum,$logentry)=@_;
                    695:     $cdom=
                    696:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
                    697:     $cnum=
                    698:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
                    699:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
                    700:     if ($existing{$ckey}) {
                    701:         $existing{$ckey}.='; '.$logentry;
                    702: # ready to assign
1.367     www       703:         if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364     www       704:                                                  $cdom,$cnum) eq 'ok') {
                    705: 	    return 'ok';
                    706:         } else {
                    707: 	    return 'error: Count not store comment.';
                    708:         }
                    709:     } else {
                    710: # the key does not exist
                    711: 	return 'error: The key does not exist';
                    712:     }
                    713: }
                    714: 
1.344     www       715: # ------------------------------------------------------ Generate a set of keys
                    716: 
                    717: sub generate_access_keys {
1.364     www       718:     my ($number,$cdom,$cnum,$logentry)=@_;
1.344     www       719:     $cdom=
                    720:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
                    721:     $cnum=
                    722:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
1.361     www       723:     unless (&allowed('mky',$cdom)) { return 0; }
1.344     www       724:     unless (($cdom) && ($cnum)) { return 0; }
                    725:     if ($number>10000) { return 0; }
                    726:     sleep(2); # make sure don't get same seed twice
                    727:     srand(time()^($$+($$<<15))); # from "Programming Perl"
                    728:     my $total=0;
                    729:     for (my $i=1;$i<=$number;$i++) {
                    730:        my $newkey=sprintf("%lx",int(100000*rand)).'-'.
                    731:                   sprintf("%lx",int(100000*rand)).'-'.
                    732:                   sprintf("%lx",int(100000*rand));
                    733:        $newkey=~s/1/g/g; # folks mix up 1 and l
                    734:        $newkey=~s/0/h/g; # and also 0 and O
                    735:        my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
                    736:        if ($existing{$newkey}) {
                    737:            $i--;
                    738:        } else {
1.364     www       739: 	  if (&put('accesskeys',
                    740:               { $newkey => '# generated '.localtime().
                    741:                            ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}.
                    742:                            '; '.$logentry },
                    743: 		   $cdom,$cnum) eq 'ok') {
1.344     www       744:               $total++;
                    745: 	  }
                    746:        }
                    747:     }
                    748:     &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
                    749:          'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
                    750:     return $total;
                    751: }
                    752: 
                    753: # ------------------------------------------------------- Validate an accesskey
                    754: 
                    755: sub validate_access_key {
                    756:     my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
                    757:     $cdom=
                    758:    $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom));
                    759:     $cnum=
                    760:    $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum));
                    761:     $udom=$ENV{'user.name'} unless (defined($udom));
                    762:     $uname=$ENV{'user.domain'} unless (defined($uname));
1.345     www       763:     my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.364     www       764:     return ($existing{$ckey}=~/^$uname\:$udom\#/);
1.70      www       765: }
                    766: 
                    767: # ------------------------------------- Find the section of student in a course
1.298     matthew   768: 
                    769: sub getsection {
                    770:     my ($udom,$unam,$courseid)=@_;
                    771:     $courseid=~s/\_/\//g;
                    772:     $courseid=~s/^(\w)/\/$1/;
                    773:     my %Pending; 
                    774:     my %Expired;
                    775:     #
                    776:     # Each role can either have not started yet (pending), be active, 
                    777:     #    or have expired.
                    778:     #
                    779:     # If there is an active role, we are done.
                    780:     #
                    781:     # If there is more than one role which has not started yet, 
                    782:     #     choose the one which will start sooner
                    783:     # If there is one role which has not started yet, return it.
                    784:     #
                    785:     # If there is more than one expired role, choose the one which ended last.
                    786:     # If there is a role which has expired, return it.
                    787:     #
                    788:     foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
                    789:                         &homeserver($unam,$udom)))) {
                    790:         my ($key,$value)=split(/\=/,$_);
                    791:         $key=&unescape($key);
                    792:         next if ($key !~/^$courseid(?:\/)*(\w+)*\_st$/);
                    793:         my $section=$1;
                    794:         if ($key eq $courseid.'_st') { $section=''; }
                    795:         my ($dummy,$end,$start)=split(/\_/,&unescape($value));
                    796:         my $now=time;
                    797:         if (defined($end) && ($now > $end)) {
                    798:             $Expired{$end}=$section;
                    799:             next;
                    800:         }
                    801:         if (defined($start) && ($now < $start)) {
                    802:             $Pending{$start}=$section;
                    803:             next;
                    804:         }
                    805:         return $section;
                    806:     }
                    807:     #
                    808:     # Presumedly there will be few matching roles from the above
                    809:     # loop and the sorting time will be negligible.
                    810:     if (scalar(keys(%Pending))) {
                    811:         my ($time) = sort {$a <=> $b} keys(%Pending);
                    812:         return $Pending{$time};
                    813:     } 
                    814:     if (scalar(keys(%Expired))) {
                    815:         my @sorted = sort {$a <=> $b} keys(%Expired);
                    816:         my $time = pop(@sorted);
                    817:         return $Expired{$time};
                    818:     }
                    819:     return '-1';
                    820: }
1.70      www       821: 
                    822: sub usection {
                    823:     my ($udom,$unam,$courseid)=@_;
                    824:     $courseid=~s/\_/\//g;
                    825:     $courseid=~s/^(\w)/\/$1/;
1.191     harris41  826:     foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
                    827:                         &homeserver($unam,$udom)))) {
1.70      www       828:         my ($key,$value)=split(/\=/,$_);
                    829:         $key=&unescape($key);
                    830:         if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
                    831:             my $section=$1;
                    832:             if ($key eq $courseid.'_st') { $section=''; }
                    833: 	    my ($dummy,$end,$start)=split(/\_/,&unescape($value));
                    834:             my $now=time;
                    835:             my $notactive=0;
                    836:             if ($start) {
                    837: 		if ($now<$start) { $notactive=1; }
                    838:             }
                    839:             if ($end) {
                    840:                 if ($now>$end) { $notactive=1; }
                    841:             } 
                    842:             unless ($notactive) { return $section; }
                    843:         }
1.191     harris41  844:     }
1.70      www       845:     return '-1';
                    846: }
                    847: 
                    848: # ------------------------------------- Read an entry from a user's environment
                    849: 
                    850: sub userenvironment {
                    851:     my ($udom,$unam,@what)=@_;
                    852:     my %returnhash=();
                    853:     my @answer=split(/\&/,
                    854:                 &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
                    855:                       &homeserver($unam,$udom)));
                    856:     my $i;
                    857:     for ($i=0;$i<=$#what;$i++) {
                    858: 	$returnhash{$what[$i]}=&unescape($answer[$i]);
                    859:     }
                    860:     return %returnhash;
1.1       albertel  861: }
                    862: 
1.263     www       863: # -------------------------------------------------------------------- New chat
                    864: 
                    865: sub chatsend {
                    866:     my ($newentry,$anon)=@_;
                    867:     my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
                    868:     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
                    869:     my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
                    870:     &reply('chatsend:'.$cdom.':'.$cnum.':'.
                    871: 	   &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
                    872: 		   &escape($newentry)),$chome);
1.292     www       873: }
                    874: 
                    875: # ------------------------------------------ Find current version of a resource
                    876: 
                    877: sub getversion {
                    878:     my $fname=&clutter(shift);
                    879:     unless ($fname=~/^\/res\//) { return -1; }
                    880:     return &currentversion(&filelocation('',$fname));
                    881: }
                    882: 
                    883: sub currentversion {
                    884:     my $fname=shift;
                    885:     my $author=$fname;
                    886:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                    887:     my ($udom,$uname)=split(/\//,$author);
                    888:     my $home=homeserver($uname,$udom);
                    889:     if ($home eq 'no_host') { 
                    890:         return -1; 
                    891:     }
                    892:     my $answer=reply("currentversion:$fname",$home);
                    893:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                    894: 	return -1;
                    895:     }
                    896:     return $answer;
1.263     www       897: }
                    898: 
1.1       albertel  899: # ----------------------------- Subscribe to a resource, return URL if possible
1.11      www       900: 
1.1       albertel  901: sub subscribe {
                    902:     my $fname=shift;
1.312     www       903:     if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.1       albertel  904:     my $author=$fname;
                    905:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                    906:     my ($udom,$uname)=split(/\//,$author);
                    907:     my $home=homeserver($uname,$udom);
1.335     albertel  908:     if ($home eq 'no_host') {
                    909:         return 'not_found';
1.1       albertel  910:     }
                    911:     my $answer=reply("sub:$fname",$home);
1.64      www       912:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
                    913: 	$answer.=' by '.$home;
                    914:     }
1.1       albertel  915:     return $answer;
                    916: }
                    917:     
1.8       www       918: # -------------------------------------------------------------- Replicate file
                    919: 
                    920: sub repcopy {
                    921:     my $filename=shift;
1.23      www       922:     $filename=~s/\/+/\//g;
1.214     www       923:     if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
1.8       www       924:     my $transname="$filename.in.transfer";
1.17      www       925:     if ((-e $filename) || (-e $transname)) { return OK; }
1.8       www       926:     my $remoteurl=subscribe($filename);
1.64      www       927:     if ($remoteurl =~ /^con_lost by/) {
                    928: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.8       www       929:            return HTTP_SERVICE_UNAVAILABLE;
                    930:     } elsif ($remoteurl eq 'not_found') {
                    931: 	   &logthis("Subscribe returned not_found: $filename");
                    932: 	   return HTTP_NOT_FOUND;
1.64      www       933:     } elsif ($remoteurl =~ /^rejected by/) {
                    934: 	   &logthis("Subscribe returned $remoteurl: $filename");
1.8       www       935:            return FORBIDDEN;
1.20      www       936:     } elsif ($remoteurl eq 'directory') {
                    937:            return OK;
1.8       www       938:     } else {
1.290     www       939:         my $author=$filename;
                    940:         $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
                    941:         my ($udom,$uname)=split(/\//,$author);
                    942:         my $home=homeserver($uname,$udom);
                    943:         unless ($home eq $perlvar{'lonHostID'}) {
1.8       www       944:            my @parts=split(/\//,$filename);
                    945:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
                    946:            if ($path ne "$perlvar{'lonDocRoot'}/res") {
                    947:                &logthis("Malconfiguration for replication: $filename");
                    948: 	       return HTTP_BAD_REQUEST;
                    949:            }
                    950:            my $count;
                    951:            for ($count=5;$count<$#parts;$count++) {
                    952:                $path.="/$parts[$count]";
                    953:                if ((-e $path)!=1) {
                    954: 		   mkdir($path,0777);
                    955:                }
                    956:            }
                    957:            my $ua=new LWP::UserAgent;
                    958:            my $request=new HTTP::Request('GET',"$remoteurl");
                    959:            my $response=$ua->request($request,$transname);
                    960:            if ($response->is_error()) {
                    961: 	       unlink($transname);
                    962:                my $message=$response->status_line;
1.12      www       963:                &logthis("<font color=blue>WARNING:"
                    964:                        ." LWP get: $message: $filename</font>");
1.8       www       965:                return HTTP_SERVICE_UNAVAILABLE;
                    966:            } else {
1.16      www       967: 	       if ($remoteurl!~/\.meta$/) {
                    968:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
                    969:                   my $mresponse=$ua->request($mrequest,$filename.'.meta');
                    970:                   if ($mresponse->is_error()) {
                    971: 		      unlink($filename.'.meta');
                    972:                       &logthis(
                    973:                      "<font color=yellow>INFO: No metadata: $filename</font>");
                    974:                   }
                    975: 	       }
1.8       www       976:                rename($transname,$filename);
                    977:                return OK;
                    978:            }
1.290     www       979:        }
1.8       www       980:     }
1.330     www       981: }
                    982: 
                    983: # ------------------------------------------------ Get server side include body
                    984: sub ssi_body {
1.381     albertel  985:     my ($filelink,%form)=@_;
1.330     www       986:     my $output=($filelink=~/^http\:/?&externalssi($filelink):
1.381     albertel  987:                                      &ssi($filelink,%form));
1.330     www       988:     $output=~s/^.*\<body[^\>]*\>//si;
                    989:     $output=~s/\<\/body\s*\>.*$//si;
1.331     www       990:     $output=~
                    991:             s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
1.330     www       992:     return $output;
1.8       www       993: }
                    994: 
1.15      www       995: # --------------------------------------------------------- Server Side Include
                    996: 
                    997: sub ssi {
                    998: 
1.23      www       999:     my ($fn,%form)=@_;
1.15      www      1000: 
                   1001:     my $ua=new LWP::UserAgent;
1.23      www      1002:     
                   1003:     my $request;
                   1004:     
                   1005:     if (%form) {
                   1006:       $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1.201     albertel 1007:       $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1.23      www      1008:     } else {
                   1009:       $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
                   1010:     }
                   1011: 
1.15      www      1012:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
                   1013:     my $response=$ua->request($request);
                   1014: 
1.324     www      1015:     return $response->content;
                   1016: }
                   1017: 
                   1018: sub externalssi {
                   1019:     my ($url)=@_;
                   1020:     my $ua=new LWP::UserAgent;
                   1021:     my $request=new HTTP::Request('GET',$url);
                   1022:     my $response=$ua->request($request);
1.15      www      1023:     return $response->content;
                   1024: }
1.254     www      1025: 
                   1026: # ------- Add a token to a remote URI's query string to vouch for access rights
                   1027: 
                   1028: sub tokenwrapper {
                   1029:     my $uri=shift;
1.259     www      1030:     $uri=~s/^http\:\/\/([^\/]+)//;
                   1031:     $uri=~s/^\///;
                   1032:     $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
                   1033:     my $token=$1;
                   1034:     if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
                   1035: 	&appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
                   1036:         return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
1.304     www      1037:                (($uri=~/\?/)?'&':'?').'token='.$token.
                   1038:                                '&tokenissued='.$perlvar{'lonHostID'};
1.259     www      1039:     } else {
                   1040: 	return '/adm/notfound.html';
                   1041:     }
1.254     www      1042: }
                   1043:     
1.257     www      1044: # --------------- Take an uploaded file and put it into the userfiles directory
1.259     www      1045: # input: name of form element, coursedoc=1 means this is for the course
1.257     www      1046: # output: url of file in userspace
                   1047: 
                   1048: sub userfileupload {
1.259     www      1049:     my ($formname,$coursedoc)=@_;
1.257     www      1050:     my $fname=$ENV{'form.'.$formname.'.filename'};
1.315     www      1051: # Replace Windows backslashes by forward slashes
1.257     www      1052:     $fname=~s/\\/\//g;
1.315     www      1053: # Get rid of everything but the actual filename
1.257     www      1054:     $fname=~s/^.*\/([^\/]+)$/$1/;
1.315     www      1055: # Replace spaces by underscores
                   1056:     $fname=~s/\s+/\_/g;
                   1057: # Replace all other weird characters by nothing
1.317     www      1058:     $fname=~s/[^\w\.\-]//g;
1.315     www      1059: # See if there is anything left
1.257     www      1060:     unless ($fname) { return 'error: no uploaded file'; }
                   1061:     chop($ENV{'form.'.$formname});
1.258     www      1062: # Create the directory if not present
1.259     www      1063:     my $docuname='';
                   1064:     my $docudom='';
                   1065:     my $docuhome='';
                   1066:     if ($coursedoc) {
                   1067: 	$docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
                   1068: 	$docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
                   1069: 	$docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
                   1070:     } else {
                   1071:         $docuname=$ENV{'user.name'};
                   1072:         $docudom=$ENV{'user.domain'};
                   1073:         $docuhome=$ENV{'user.home'};
                   1074:     }
1.271     www      1075:     return 
                   1076:         &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
                   1077: }
                   1078: 
                   1079: sub finishuserfileupload {
                   1080:     my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
1.259     www      1081:     my $path=$docudom.'/'.$docuname.'/';
1.258     www      1082:     my $filepath=$perlvar{'lonDocRoot'};
1.259     www      1083:     my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258     www      1084:     my $count;
                   1085:     for ($count=4;$count<=$#parts;$count++) {
                   1086:         $filepath.="/$parts[$count]";
                   1087:         if ((-e $filepath)!=1) {
                   1088: 	    mkdir($filepath,0777);
                   1089:         }
                   1090:     }
                   1091: # Save the file
                   1092:     {
                   1093:        my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
                   1094:        print $fh $ENV{'form.'.$formname};
                   1095:     }
1.259     www      1096: # Notify homeserver to grep it
                   1097: #
1.295     www      1098:     
                   1099:     my $fetchresult= 
                   1100:  &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome);
                   1101:     if ($fetchresult eq 'ok') {
1.259     www      1102: #
1.258     www      1103: # Return the URL to it
1.263     www      1104:         return '/uploaded/'.$path.$fname;
                   1105:     } else {
1.295     www      1106:         &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$fname.
                   1107:          ' to host '.$docuhome.': '.$fetchresult);
1.263     www      1108:         return '/adm/notfound.html';
                   1109:     }    
1.257     www      1110: }
1.15      www      1111: 
1.14      www      1112: # ------------------------------------------------------------------------- Log
                   1113: 
                   1114: sub log {
                   1115:     my ($dom,$nam,$hom,$what)=@_;
1.47      www      1116:     return critical("log:$dom:$nam:$what",$hom);
1.157     www      1117: }
                   1118: 
                   1119: # ------------------------------------------------------------------ Course Log
1.352     www      1120: #
                   1121: # This routine flushes several buffers of non-mission-critical nature
                   1122: #
1.157     www      1123: 
                   1124: sub flushcourselogs {
1.352     www      1125:     &logthis('Flushing log buffers');
                   1126: #
                   1127: # course logs
                   1128: # This is a log of all transactions in a course, which can be used
                   1129: # for data mining purposes
                   1130: #
                   1131: # It also collects the courseid database, which lists last transaction
                   1132: # times and course titles for all courseids
                   1133: #
                   1134:     my %courseidbuffer=();
1.191     harris41 1135:     foreach (keys %courselogs) {
1.157     www      1136:         my $crsid=$_;
1.352     www      1137:         if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188     www      1138: 		          &escape($courselogs{$crsid}),
                   1139: 		          $coursehombuf{$crsid}) eq 'ok') {
1.157     www      1140: 	    delete $courselogs{$crsid};
                   1141:         } else {
                   1142:             &logthis('Failed to flush log buffer for '.$crsid);
                   1143:             if (length($courselogs{$crsid})>40000) {
                   1144:                &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
                   1145:                         " exceeded maximum size, deleting.</font>");
                   1146:                delete $courselogs{$crsid};
                   1147:             }
1.352     www      1148:         }
                   1149:         if ($courseidbuffer{$coursehombuf{$crsid}}) {
                   1150:            $courseidbuffer{$coursehombuf{$crsid}}.='&'.
                   1151: 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
                   1152:         } else {
                   1153:            $courseidbuffer{$coursehombuf{$crsid}}=
                   1154: 			 &escape($crsid).'='.&escape($coursedescrbuf{$crsid});
                   1155:         }    
1.191     harris41 1156:     }
1.352     www      1157: #
                   1158: # Write course id database (reverse lookup) to homeserver of courses 
                   1159: # Is used in pickcourse
                   1160: #
                   1161:     foreach (keys %courseidbuffer) {
1.353     www      1162:         &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1.352     www      1163:     }
                   1164: #
                   1165: # File accesses
                   1166: # Writes to the dynamic metadata of resources to get hit counts, etc.
                   1167: #
1.191     harris41 1168:     foreach (keys %accesshash) {
1.185     www      1169:         my $entry=$_;
                   1170:         $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
                   1171:         my %temphash=($entry => $accesshash{$entry});
1.266     albertel 1172:         if (&Apache::lonnet::put('nohist_resevaldata',\%temphash,$1,$2) eq 'ok') {
1.185     www      1173: 	    delete $accesshash{$entry};
                   1174:         }
1.191     harris41 1175:     }
1.352     www      1176: #
                   1177: # Roles
                   1178: # Reverse lookup of user roles for course faculty/staff and co-authorship
                   1179: #
1.349     www      1180:     foreach (keys %userrolehash) {
                   1181:         my $entry=$_;
1.351     www      1182:         my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349     www      1183: 	    split(/\:/,$entry);
                   1184:         if (&Apache::lonnet::put('nohist_userroles',
1.351     www      1185:              { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349     www      1186:                 $rudom,$runame) eq 'ok') {
                   1187: 	    delete $userrolehash{$entry};
                   1188:         }
                   1189:     }
1.186     www      1190:     $dumpcount++;
1.157     www      1191: }
                   1192: 
                   1193: sub courselog {
                   1194:     my $what=shift;
1.158     www      1195:     $what=time.':'.$what;
1.157     www      1196:     unless ($ENV{'request.course.id'}) { return ''; }
1.188     www      1197:     $coursedombuf{$ENV{'request.course.id'}}=
1.352     www      1198:        $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
                   1199:     $coursenumbuf{$ENV{'request.course.id'}}=
1.188     www      1200:        $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
                   1201:     $coursehombuf{$ENV{'request.course.id'}}=
                   1202:        $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1.352     www      1203:     $coursedescrbuf{$ENV{'request.course.id'}}=
                   1204:        $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1.157     www      1205:     if (defined $courselogs{$ENV{'request.course.id'}}) {
                   1206: 	$courselogs{$ENV{'request.course.id'}}.='&'.$what;
                   1207:     } else {
                   1208: 	$courselogs{$ENV{'request.course.id'}}.=$what;
                   1209:     }
                   1210:     if (length($courselogs{$ENV{'request.course.id'}})>4048) {
                   1211: 	&flushcourselogs();
                   1212:     }
1.158     www      1213: }
                   1214: 
                   1215: sub courseacclog {
                   1216:     my $fnsymb=shift;
                   1217:     unless ($ENV{'request.course.id'}) { return ''; }
                   1218:     my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
1.192     www      1219:     if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
1.187     www      1220:         $what.=':POST';
1.191     harris41 1221: 	foreach (keys %ENV) {
1.158     www      1222:             if ($_=~/^form\.(.*)/) {
                   1223: 		$what.=':'.$1.'='.$ENV{$_};
                   1224:             }
1.191     harris41 1225:         }
1.158     www      1226:     }
                   1227:     &courselog($what);
1.149     www      1228: }
                   1229: 
1.185     www      1230: sub countacc {
                   1231:     my $url=&declutter(shift);
                   1232:     unless ($ENV{'request.course.id'}) { return ''; }
                   1233:     $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
1.281     www      1234:     my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.185     www      1235:     if (defined($accesshash{$key})) {
                   1236: 	$accesshash{$key}++;
                   1237:     } else {
                   1238:         $accesshash{$key}=1;
                   1239:     }
                   1240: }
1.349     www      1241: 
1.361     www      1242: sub linklog {
                   1243:     my ($from,$to)=@_;
                   1244:     $from=&declutter($from);
                   1245:     $to=&declutter($to);
                   1246:     $accesshash{$from.'___'.$to.'___comefrom'}=1;
                   1247:     $accesshash{$to.'___'.$from.'___goto'}=1;
                   1248: }
                   1249:   
1.349     www      1250: sub userrolelog {
                   1251:     my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
                   1252:     if (($trole=~/^ca/) || ($trole=~/^in/) || 
                   1253:         ($trole=~/^cc/) || ($trole=~/^ep/) ||
                   1254:         ($trole=~/^cr/)) {
1.350     www      1255:        my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
                   1256:        $userrolehash
                   1257:          {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349     www      1258:                     =$tend.':'.$tstart;
                   1259:    }
1.351     www      1260: }
                   1261: 
                   1262: sub get_course_adv_roles {
                   1263:     my $cid=shift;
                   1264:     $cid=$ENV{'request.course.id'} unless (defined($cid));
                   1265:     my %coursehash=&coursedescription($cid);
                   1266:     my %returnhash=();
                   1267:     my %dumphash=
                   1268:             &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
                   1269:     my $now=time;
                   1270:     foreach (keys %dumphash) {
                   1271: 	my ($tend,$tstart)=split(/\:/,$dumphash{$_});
                   1272:         if (($tstart) && ($tstart<0)) { next; }
                   1273:         if (($tend) && ($tend<$now)) { next; }
                   1274:         if (($tstart) && ($now<$tstart)) { next; }
                   1275:         my ($role,$username,$domain,$section)=split(/\:/,$_);
                   1276:         my $key=&plaintext($role);
                   1277:         if ($section) { $key.=' (Sec/Grp '.$section.')'; }
                   1278:         if ($returnhash{$key}) {
                   1279: 	    $returnhash{$key}.=','.$username.':'.$domain;
                   1280:         } else {
                   1281:             $returnhash{$key}=$username.':'.$domain;
                   1282:         }
1.373     www      1283:      }
                   1284:     return %returnhash;
1.351     www      1285: }
1.353     www      1286: 
                   1287: # ---------------------------------------------------------- Course ID routines
                   1288: # Deal with domain's nohist_courseid.db files
                   1289: #
                   1290: 
                   1291: sub courseidput {
                   1292:     my ($domain,$what,$coursehome)=@_;
                   1293:     return &reply('courseidput:'.$domain.':'.$what,$coursehome);
                   1294: }
                   1295: 
                   1296: sub courseiddump {
                   1297:     my ($domfilter,$descfilter,$sincefilter)=@_;
                   1298:     my %returnhash=();
1.355     www      1299:     unless ($domfilter) { $domfilter=''; }
1.353     www      1300:     foreach my $tryserver (keys %libserv) {
1.355     www      1301: 	if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1.353     www      1302: 	    foreach (
                   1303:              split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1.354     www      1304: 			       $sincefilter.':'.&escape($descfilter),
                   1305:                                $tryserver))) {
1.353     www      1306: 		my ($key,$value)=split(/\=/,$_);
                   1307:                 if (($key) && ($value)) {
                   1308: 		    $returnhash{&unescape($key)}=&unescape($value);
                   1309:                 }
                   1310:             }
                   1311: 
                   1312:         }
                   1313:     }
                   1314:     return %returnhash;
                   1315: }
                   1316: 
                   1317: #
1.149     www      1318: # ----------------------------------------------------------- Check out an item
                   1319: 
                   1320: sub checkout {
                   1321:     my ($symb,$tuname,$tudom,$tcrsid)=@_;
                   1322:     my $now=time;
                   1323:     my $lonhost=$perlvar{'lonHostID'};
                   1324:     my $infostr=&escape(
1.234     www      1325:                  'CHECKOUTTOKEN&'.
1.149     www      1326:                  $tuname.'&'.
                   1327:                  $tudom.'&'.
                   1328:                  $tcrsid.'&'.
                   1329:                  $symb.'&'.
                   1330: 		 $now.'&'.$ENV{'REMOTE_ADDR'});
                   1331:     my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151     www      1332:     if ($token=~/^error\:/) { 
                   1333:         &logthis("<font color=blue>WARNING: ".
                   1334:                 "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
                   1335:                  "</font>");
                   1336:         return ''; 
                   1337:     }
                   1338: 
1.149     www      1339:     $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
                   1340:     $token=~tr/a-z/A-Z/;
                   1341: 
1.153     www      1342:     my %infohash=('resource.0.outtoken' => $token,
                   1343:                   'resource.0.checkouttime' => $now,
                   1344:                   'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149     www      1345: 
                   1346:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
                   1347:        return '';
1.151     www      1348:     } else {
                   1349:         &logthis("<font color=blue>WARNING: ".
                   1350:                 "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
                   1351:                  "</font>");
1.149     www      1352:     }    
                   1353: 
                   1354:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
                   1355:                          &escape('Checkout '.$infostr.' - '.
                   1356:                                                  $token)) ne 'ok') {
                   1357: 	return '';
1.151     www      1358:     } else {
                   1359:         &logthis("<font color=blue>WARNING: ".
                   1360:                 "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
                   1361:                  "</font>");
1.149     www      1362:     }
1.151     www      1363:     return $token;
1.149     www      1364: }
                   1365: 
                   1366: # ------------------------------------------------------------ Check in an item
                   1367: 
                   1368: sub checkin {
                   1369:     my $token=shift;
1.150     www      1370:     my $now=time;
                   1371:     my ($ta,$tb,$lonhost)=split(/\*/,$token);
                   1372:     $lonhost=~tr/A-Z/a-z/;
                   1373:     my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
                   1374:     $dtoken=~s/\W/\_/g;
1.234     www      1375:     my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150     www      1376:                  split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
                   1377: 
1.154     www      1378:     unless (($tuname) && ($tudom)) {
                   1379:         &logthis('Check in '.$token.' ('.$dtoken.') failed');
                   1380:         return '';
                   1381:     }
                   1382:     
                   1383:     unless (&allowed('mgr',$tcrsid)) {
                   1384:         &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
                   1385:                  $ENV{'user.name'}.' - '.$ENV{'user.domain'});
                   1386:         return '';
                   1387:     }
                   1388: 
1.153     www      1389:     my %infohash=('resource.0.intoken' => $token,
                   1390:                   'resource.0.checkintime' => $now,
                   1391:                   'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150     www      1392: 
                   1393:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
                   1394:        return '';
                   1395:     }    
                   1396: 
                   1397:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
                   1398:                          &escape('Checkin - '.$token)) ne 'ok') {
                   1399: 	return '';
                   1400:     }
                   1401: 
                   1402:     return ($symb,$tuname,$tudom,$tcrsid);    
1.110     www      1403: }
                   1404: 
                   1405: # --------------------------------------------- Set Expire Date for Spreadsheet
                   1406: 
                   1407: sub expirespread {
                   1408:     my ($uname,$udom,$stype,$usymb)=@_;
                   1409:     my $cid=$ENV{'request.course.id'}; 
                   1410:     if ($cid) {
                   1411:        my $now=time;
                   1412:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
                   1413:        return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
                   1414:                             $ENV{'course.'.$cid.'.num'}.
                   1415: 	        	    ':nohist_expirationdates:'.
                   1416:                             &escape($key).'='.$now,
                   1417:                             $ENV{'course.'.$cid.'.home'})
                   1418:     }
                   1419:     return 'ok';
1.14      www      1420: }
                   1421: 
1.109     www      1422: # ----------------------------------------------------- Devalidate Spreadsheets
                   1423: 
                   1424: sub devalidate {
1.325     www      1425:     my ($symb,$uname,$udom)=@_;
1.109     www      1426:     my $cid=$ENV{'request.course.id'}; 
                   1427:     if ($cid) {
1.325     www      1428: # delete the stored spreadsheets for
                   1429: # - the student level sheet of this user in course's homespace
                   1430: # - the assessment level sheet for this resource 
                   1431: #   for this user in user's homespace
                   1432: 	my $key=$uname.':'.$udom.':';
1.109     www      1433:         my $status=
1.299     matthew  1434: 	    &del('nohist_calculatedsheets',
1.133     albertel 1435: 		 [$key.'studentcalc'],
                   1436: 		 $ENV{'course.'.$cid.'.domain'},
                   1437: 		 $ENV{'course.'.$cid.'.num'})
                   1438: 		.' '.
                   1439: 	    &del('nohist_calculatedsheets_'.$cid,
                   1440: 		 [$key.'assesscalc:'.$symb]);
1.109     www      1441:         unless ($status eq 'ok ok') {
                   1442:            &logthis('Could not devalidate spreadsheet '.
1.325     www      1443:                     $uname.' at '.$udom.' for '.
1.109     www      1444: 		    $symb.': '.$status);
1.133     albertel 1445:         }
1.109     www      1446:     }
                   1447: }
                   1448: 
1.265     albertel 1449: sub get_scalar {
                   1450:     my ($string,$end) = @_;
                   1451:     my $value;
                   1452:     if ($$string =~ s/^([^&]*?)($end)/$2/) {
                   1453: 	$value = $1;
                   1454:     } elsif ($$string =~ s/^([^&]*?)&//) {
                   1455: 	$value = $1;
                   1456:     }
                   1457:     return &unescape($value);
                   1458: }
                   1459: 
                   1460: sub array2str {
                   1461:   my (@array) = @_;
                   1462:   my $result=&arrayref2str(\@array);
                   1463:   $result=~s/^__ARRAY_REF__//;
                   1464:   $result=~s/__END_ARRAY_REF__$//;
                   1465:   return $result;
                   1466: }
                   1467: 
1.204     albertel 1468: sub arrayref2str {
                   1469:   my ($arrayref) = @_;
1.265     albertel 1470:   my $result='__ARRAY_REF__';
1.204     albertel 1471:   foreach my $elem (@$arrayref) {
1.265     albertel 1472:     if(ref($elem) eq 'ARRAY') {
                   1473:       $result.=&arrayref2str($elem).'&';
                   1474:     } elsif(ref($elem) eq 'HASH') {
                   1475:       $result.=&hashref2str($elem).'&';
                   1476:     } elsif(ref($elem)) {
                   1477:       #print("Got a ref of ".(ref($elem))." skipping.");
1.204     albertel 1478:     } else {
                   1479:       $result.=&escape($elem).'&';
                   1480:     }
                   1481:   }
                   1482:   $result=~s/\&$//;
1.265     albertel 1483:   $result .= '__END_ARRAY_REF__';
1.204     albertel 1484:   return $result;
                   1485: }
                   1486: 
1.168     albertel 1487: sub hash2str {
1.204     albertel 1488:   my (%hash) = @_;
                   1489:   my $result=&hashref2str(\%hash);
1.265     albertel 1490:   $result=~s/^__HASH_REF__//;
                   1491:   $result=~s/__END_HASH_REF__$//;
1.204     albertel 1492:   return $result;
                   1493: }
                   1494: 
                   1495: sub hashref2str {
                   1496:   my ($hashref)=@_;
1.265     albertel 1497:   my $result='__HASH_REF__';
1.204     albertel 1498:   foreach (keys(%$hashref)) {
                   1499:     if (ref($_) eq 'ARRAY') {
1.265     albertel 1500:       $result.=&arrayref2str($_).'=';
1.204     albertel 1501:     } elsif (ref($_) eq 'HASH') {
1.265     albertel 1502:       $result.=&hashref2str($_).'=';
1.204     albertel 1503:     } elsif (ref($_)) {
1.265     albertel 1504:       $result.='=';
                   1505:       #print("Got a ref of ".(ref($_))." skipping.");
1.204     albertel 1506:     } else {
1.265     albertel 1507: 	if ($_) {$result.=&escape($_).'=';} else { last; }
1.204     albertel 1508:     }
                   1509: 
1.265     albertel 1510:     if(ref($hashref->{$_}) eq 'ARRAY') {
                   1511:       $result.=&arrayref2str($hashref->{$_}).'&';
                   1512:     } elsif(ref($hashref->{$_}) eq 'HASH') {
                   1513:       $result.=&hashref2str($hashref->{$_}).'&';
                   1514:     } elsif(ref($hashref->{$_})) {
                   1515:        $result.='&';
                   1516:       #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1.204     albertel 1517:     } else {
1.265     albertel 1518:       $result.=&escape($hashref->{$_}).'&';
1.204     albertel 1519:     }
                   1520:   }
1.168     albertel 1521:   $result=~s/\&$//;
1.265     albertel 1522:   $result .= '__END_HASH_REF__';
1.168     albertel 1523:   return $result;
                   1524: }
                   1525: 
                   1526: sub str2hash {
1.265     albertel 1527:     my ($string)=@_;
                   1528:     my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
                   1529:     return %$hash;
                   1530: }
                   1531: 
                   1532: sub str2hashref {
1.168     albertel 1533:   my ($string) = @_;
1.265     albertel 1534: 
                   1535:   my %hash;
                   1536: 
                   1537:   if($string !~ /^__HASH_REF__/) {
                   1538:       if (! ($string eq '' || !defined($string))) {
                   1539: 	  $hash{'error'}='Not hash reference';
                   1540:       }
                   1541:       return (\%hash, $string);
                   1542:   }
                   1543: 
                   1544:   $string =~ s/^__HASH_REF__//;
                   1545: 
                   1546:   while($string !~ /^__END_HASH_REF__/) {
                   1547:       #key
                   1548:       my $key='';
                   1549:       if($string =~ /^__HASH_REF__/) {
                   1550:           ($key, $string)=&str2hashref($string);
                   1551:           if(defined($key->{'error'})) {
                   1552:               $hash{'error'}='Bad data';
                   1553:               return (\%hash, $string);
                   1554:           }
                   1555:       } elsif($string =~ /^__ARRAY_REF__/) {
                   1556:           ($key, $string)=&str2arrayref($string);
                   1557:           if($key->[0] eq 'Array reference error') {
                   1558:               $hash{'error'}='Bad data';
                   1559:               return (\%hash, $string);
                   1560:           }
                   1561:       } else {
                   1562:           $string =~ s/^(.*?)=//;
1.267     albertel 1563: 	  $key=&unescape($1);
1.265     albertel 1564:       }
                   1565:       $string =~ s/^=//;
                   1566: 
                   1567:       #value
                   1568:       my $value='';
                   1569:       if($string =~ /^__HASH_REF__/) {
                   1570:           ($value, $string)=&str2hashref($string);
                   1571:           if(defined($value->{'error'})) {
                   1572:               $hash{'error'}='Bad data';
                   1573:               return (\%hash, $string);
                   1574:           }
                   1575:       } elsif($string =~ /^__ARRAY_REF__/) {
                   1576:           ($value, $string)=&str2arrayref($string);
                   1577:           if($value->[0] eq 'Array reference error') {
                   1578:               $hash{'error'}='Bad data';
                   1579:               return (\%hash, $string);
                   1580:           }
                   1581:       } else {
                   1582: 	  $value=&get_scalar(\$string,'__END_HASH_REF__');
                   1583:       }
                   1584:       $string =~ s/^&//;
                   1585: 
                   1586:       $hash{$key}=$value;
1.204     albertel 1587:   }
1.265     albertel 1588: 
                   1589:   $string =~ s/^__END_HASH_REF__//;
                   1590: 
                   1591:   return (\%hash, $string);
1.204     albertel 1592: }
                   1593: 
                   1594: sub str2array {
1.265     albertel 1595:     my ($string)=@_;
                   1596:     my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
                   1597:     return @$array;
                   1598: }
                   1599: 
                   1600: sub str2arrayref {
1.204     albertel 1601:   my ($string) = @_;
1.265     albertel 1602:   my @array;
                   1603: 
                   1604:   if($string !~ /^__ARRAY_REF__/) {
                   1605:       if (! ($string eq '' || !defined($string))) {
                   1606: 	  $array[0]='Array reference error';
                   1607:       }
                   1608:       return (\@array, $string);
                   1609:   }
                   1610: 
                   1611:   $string =~ s/^__ARRAY_REF__//;
                   1612: 
                   1613:   while($string !~ /^__END_ARRAY_REF__/) {
                   1614:       my $value='';
                   1615:       if($string =~ /^__HASH_REF__/) {
                   1616:           ($value, $string)=&str2hashref($string);
                   1617:           if(defined($value->{'error'})) {
                   1618:               $array[0] ='Array reference error';
                   1619:               return (\@array, $string);
                   1620:           }
                   1621:       } elsif($string =~ /^__ARRAY_REF__/) {
                   1622:           ($value, $string)=&str2arrayref($string);
                   1623:           if($value->[0] eq 'Array reference error') {
                   1624:               $array[0] ='Array reference error';
                   1625:               return (\@array, $string);
                   1626:           }
                   1627:       } else {
                   1628: 	  $value=&get_scalar(\$string,'__END_ARRAY_REF__');
                   1629:       }
                   1630:       $string =~ s/^&//;
                   1631: 
                   1632:       push(@array, $value);
1.191     harris41 1633:   }
1.265     albertel 1634: 
                   1635:   $string =~ s/^__END_ARRAY_REF__//;
                   1636: 
                   1637:   return (\@array, $string);
1.168     albertel 1638: }
                   1639: 
1.167     albertel 1640: # -------------------------------------------------------------------Temp Store
                   1641: 
1.168     albertel 1642: sub tmpreset {
                   1643:   my ($symb,$namespace,$domain,$stuname) = @_;
                   1644:   if (!$symb) {
                   1645:     $symb=&symbread();
1.380     albertel 1646:     if (!$symb) { $symb= $ENV{'request.url'}; }
1.168     albertel 1647:   }
                   1648:   $symb=escape($symb);
                   1649: 
                   1650:   if (!$namespace) { $namespace=$ENV{'request.state'}; }
                   1651:   $namespace=~s/\//\_/g;
                   1652:   $namespace=~s/\W//g;
                   1653: 
                   1654:   #FIXME needs to do something for /pub resources
                   1655:   if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1656:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1657:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   1658:   my %hash;
                   1659:   if (tie(%hash,'GDBM_File',
                   1660: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 1661: 	  &GDBM_WRCREAT(),0640)) {
1.168     albertel 1662:     foreach my $key (keys %hash) {
1.180     albertel 1663:       if ($key=~ /:$symb/) {
1.168     albertel 1664: 	delete($hash{$key});
                   1665:       }
                   1666:     }
                   1667:   }
                   1668: }
                   1669: 
1.167     albertel 1670: sub tmpstore {
1.168     albertel 1671:   my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   1672: 
                   1673:   if (!$symb) {
                   1674:     $symb=&symbread();
                   1675:     if (!$symb) { $symb= $ENV{'request.url'}; }
                   1676:   }
                   1677:   $symb=escape($symb);
                   1678: 
                   1679:   if (!$namespace) {
                   1680:     # I don't think we would ever want to store this for a course.
                   1681:     # it seems this will only be used if we don't have a course.
                   1682:     #$namespace=$ENV{'request.course.id'};
                   1683:     #if (!$namespace) {
                   1684:       $namespace=$ENV{'request.state'};
                   1685:     #}
                   1686:   }
                   1687:   $namespace=~s/\//\_/g;
                   1688:   $namespace=~s/\W//g;
                   1689: #FIXME needs to do something for /pub resources
                   1690:   if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1691:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1692:   my $now=time;
                   1693:   my %hash;
                   1694:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   1695:   if (tie(%hash,'GDBM_File',
                   1696: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 1697: 	  &GDBM_WRCREAT(),0640)) {
1.168     albertel 1698:     $hash{"version:$symb"}++;
                   1699:     my $version=$hash{"version:$symb"};
                   1700:     my $allkeys=''; 
                   1701:     foreach my $key (keys(%$storehash)) {
                   1702:       $allkeys.=$key.':';
                   1703:       $hash{"$version:$symb:$key"}=$$storehash{$key};
                   1704:     }
                   1705:     $hash{"$version:$symb:timestamp"}=$now;
                   1706:     $allkeys.='timestamp';
                   1707:     $hash{"$version:keys:$symb"}=$allkeys;
                   1708:     if (untie(%hash)) {
                   1709:       return 'ok';
                   1710:     } else {
                   1711:       return "error:$!";
                   1712:     }
                   1713:   } else {
                   1714:     return "error:$!";
                   1715:   }
                   1716: }
1.167     albertel 1717: 
1.168     albertel 1718: # -----------------------------------------------------------------Temp Restore
1.167     albertel 1719: 
1.168     albertel 1720: sub tmprestore {
                   1721:   my ($symb,$namespace,$domain,$stuname) = @_;
1.167     albertel 1722: 
1.168     albertel 1723:   if (!$symb) {
                   1724:     $symb=&symbread();
                   1725:     if (!$symb) { $symb= $ENV{'request.url'}; }
                   1726:   }
                   1727:   $symb=escape($symb);
                   1728: 
                   1729:   if (!$namespace) { $namespace=$ENV{'request.state'}; }
                   1730:   #FIXME needs to do something for /pub resources
                   1731:   if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1732:   if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1733: 
                   1734:   my %returnhash;
                   1735:   $namespace=~s/\//\_/g;
                   1736:   $namespace=~s/\W//g;
                   1737:   my %hash;
                   1738:   my $path=$perlvar{'lonDaemons'}.'/tmp';
                   1739:   if (tie(%hash,'GDBM_File',
                   1740: 	  $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256     albertel 1741: 	  &GDBM_READER(),0640)) {
1.168     albertel 1742:     my $version=$hash{"version:$symb"};
                   1743:     $returnhash{'version'}=$version;
                   1744:     my $scope;
                   1745:     for ($scope=1;$scope<=$version;$scope++) {
                   1746:       my $vkeys=$hash{"$scope:keys:$symb"};
                   1747:       my @keys=split(/:/,$vkeys);
                   1748:       my $key;
                   1749:       $returnhash{"$scope:keys"}=$vkeys;
                   1750:       foreach $key (@keys) {
                   1751: 	$returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
                   1752: 	$returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1.167     albertel 1753:       }
                   1754:     }
1.168     albertel 1755:     if (!(untie(%hash))) {
                   1756:       return "error:$!";
                   1757:     }
                   1758:   } else {
                   1759:     return "error:$!";
                   1760:   }
                   1761:   return %returnhash;
1.167     albertel 1762: }
                   1763: 
1.9       www      1764: # ----------------------------------------------------------------------- Store
                   1765: 
                   1766: sub store {
1.124     www      1767:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   1768:     my $home='';
                   1769: 
1.168     albertel 1770:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      1771: 
1.213     www      1772:     $symb=&symbclean($symb);
1.122     albertel 1773:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      1774: 
1.325     www      1775:     if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1776:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1777: 
                   1778:     &devalidate($symb,$stuname,$domain);
1.109     www      1779: 
                   1780:     $symb=escape($symb);
1.187     www      1781:     if (!$namespace) { 
                   1782:        unless ($namespace=$ENV{'request.course.id'}) { 
                   1783:           return ''; 
                   1784:        } 
                   1785:     }
1.122     albertel 1786:     if (!$home) { $home=$ENV{'user.home'}; }
1.12      www      1787:     my $namevalue='';
1.191     harris41 1788:     foreach (keys %$storehash) {
1.122     albertel 1789:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1.191     harris41 1790:     }
1.12      www      1791:     $namevalue=~s/\&$//;
1.187     www      1792:     &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124     www      1793:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9       www      1794: }
                   1795: 
1.47      www      1796: # -------------------------------------------------------------- Critical Store
                   1797: 
                   1798: sub cstore {
1.124     www      1799:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
                   1800:     my $home='';
                   1801: 
1.168     albertel 1802:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      1803: 
1.213     www      1804:     $symb=&symbclean($symb);
1.122     albertel 1805:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109     www      1806: 
1.325     www      1807:     if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1808:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1809: 
                   1810:     &devalidate($symb,$stuname,$domain);
1.109     www      1811: 
                   1812:     $symb=escape($symb);
1.187     www      1813:     if (!$namespace) { 
                   1814:        unless ($namespace=$ENV{'request.course.id'}) { 
                   1815:           return ''; 
                   1816:        } 
                   1817:     }
1.122     albertel 1818:     if (!$home) { $home=$ENV{'user.home'}; }
                   1819: 
1.47      www      1820:     my $namevalue='';
1.191     harris41 1821:     foreach (keys %$storehash) {
1.122     albertel 1822:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1.191     harris41 1823:     }
1.47      www      1824:     $namevalue=~s/\&$//;
1.187     www      1825:     &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188     www      1826:     return critical
                   1827:                 ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47      www      1828: }
                   1829: 
1.9       www      1830: # --------------------------------------------------------------------- Restore
                   1831: 
                   1832: sub restore {
1.124     www      1833:     my ($symb,$namespace,$domain,$stuname) = @_;
                   1834:     my $home='';
                   1835: 
1.168     albertel 1836:     if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124     www      1837: 
1.122     albertel 1838:     if (!$symb) {
                   1839:       unless ($symb=escape(&symbread())) { return ''; }
                   1840:     } else {
1.213     www      1841:       $symb=&escape(&symbclean($symb));
1.122     albertel 1842:     }
1.188     www      1843:     if (!$namespace) { 
                   1844:        unless ($namespace=$ENV{'request.course.id'}) { 
                   1845:           return ''; 
                   1846:        } 
                   1847:     }
1.122     albertel 1848:     if (!$domain) { $domain=$ENV{'user.domain'}; }
                   1849:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
                   1850:     if (!$home) { $home=$ENV{'user.home'}; }
                   1851:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
                   1852: 
1.12      www      1853:     my %returnhash=();
1.191     harris41 1854:     foreach (split(/\&/,$answer)) {
1.12      www      1855: 	my ($name,$value)=split(/\=/,$_);
                   1856:         $returnhash{&unescape($name)}=&unescape($value);
1.191     harris41 1857:     }
1.75      www      1858:     my $version;
                   1859:     for ($version=1;$version<=$returnhash{'version'};$version++) {
1.191     harris41 1860:        foreach (split(/\:/,$returnhash{$version.':keys'})) {
1.75      www      1861:           $returnhash{$_}=$returnhash{$version.':'.$_};
1.191     harris41 1862:        }
1.75      www      1863:     }
1.13      www      1864:     return %returnhash;
1.34      www      1865: }
                   1866: 
                   1867: # ---------------------------------------------------------- Course Description
                   1868: 
                   1869: sub coursedescription {
                   1870:     my $courseid=shift;
                   1871:     $courseid=~s/^\///;
1.49      www      1872:     $courseid=~s/\_/\//g;
1.34      www      1873:     my ($cdomain,$cnum)=split(/\//,$courseid);
1.129     albertel 1874:     my $chome=&homeserver($cnum,$cdomain);
1.302     albertel 1875:     my $normalid=$cdomain.'_'.$cnum;
                   1876:     # need to always cache even if we get errors otherwise we keep 
                   1877:     # trying and trying and trying to get the course description.
                   1878:     my %envhash=();
                   1879:     my %returnhash=();
                   1880:     $envhash{'course.'.$normalid.'.last_cache'}=time;
1.34      www      1881:     if ($chome ne 'no_host') {
1.302     albertel 1882:        %returnhash=&dump('environment',$cdomain,$cnum);
1.129     albertel 1883:        if (!exists($returnhash{'con_lost'})) {
                   1884:            $returnhash{'home'}= $chome;
                   1885: 	   $returnhash{'domain'} = $cdomain;
                   1886: 	   $returnhash{'num'} = $cnum;
1.130     albertel 1887:            while (my ($name,$value) = each %returnhash) {
1.53      www      1888:                $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129     albertel 1889:            }
1.270     www      1890:            $returnhash{'url'}=&clutter($returnhash{'url'});
1.34      www      1891:            $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.38      www      1892: 	       $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60      www      1893:            $envhash{'course.'.$normalid.'.home'}=$chome;
                   1894:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
                   1895:            $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34      www      1896:        }
                   1897:     }
1.302     albertel 1898:     &appenv(%envhash);
                   1899:     return %returnhash;
1.9       www      1900: }
1.1       albertel 1901: 
1.103     harris41 1902: # -------------------------------------------------------- Get user privileges
1.11      www      1903: 
                   1904: sub rolesinit {
                   1905:     my ($domain,$username,$authhost)=@_;
                   1906:     my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12      www      1907:     if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11      www      1908:     my %allroles=();
                   1909:     my %thesepriv=();
                   1910:     my $now=time;
1.21      www      1911:     my $userroles="user.login.time=$now\n";
1.11      www      1912:     my $thesestr;
                   1913: 
                   1914:     if ($rolesdump ne '') {
1.191     harris41 1915:         foreach (split(/&/,$rolesdump)) {
1.21      www      1916: 	  if ($_!~/^rolesdef\&/) {
1.11      www      1917:             my ($area,$role)=split(/=/,$_);
1.21      www      1918:             $area=~s/\_\w\w$//;
1.11      www      1919:             my ($trole,$tend,$tstart)=split(/_/,$role);
1.21      www      1920:             $userroles.='user.role.'.$trole.'.'.$area.'='.
                   1921:                         $tstart.'.'.$tend."\n";
1.349     www      1922: # log the associated role with the area
                   1923:             &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.11      www      1924:             if ($tend!=0) {
                   1925: 	        if ($tend<$now) {
                   1926: 	            $trole='';
                   1927:                 } 
                   1928:             }
                   1929:             if ($tstart!=0) {
                   1930:                 if ($tstart>$now) {
                   1931:                    $trole='';        
                   1932:                 }
                   1933:             }
                   1934:             if (($area ne '') && ($trole ne '')) {
1.347     albertel 1935: 		my $spec=$trole.'.'.$area;
                   1936: 		my ($tdummy,$tdomain,$trest)=split(/\//,$area);
                   1937: 		if ($trole =~ /^cr\//) {
                   1938: 		    my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
                   1939: 		    my $homsvr=homeserver($rauthor,$rdomain);
                   1940: 		    if ($hostname{$homsvr} ne '') {
                   1941: 			my $roledef=
                   1942: 			    reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
                   1943: 				  $homsvr);
                   1944: 			if (($roledef ne 'con_lost') && ($roledef ne '')) {
                   1945: 			    my ($syspriv,$dompriv,$coursepriv)=
                   1946: 				split(/\_/,unescape($roledef));
                   1947: 			    if (defined($syspriv)) {
                   1948: 				$allroles{'cm./'}.=':'.$syspriv;
                   1949: 				$allroles{$spec.'./'}.=':'.$syspriv;
                   1950: 			    }
                   1951: 			    if ($tdomain ne '') {
                   1952: 				if (defined($dompriv)) {
                   1953: 				    $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
                   1954: 				    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
                   1955: 				}
                   1956: 				if ($trest ne '') {
                   1957: 				    if (defined($coursepriv)) {
                   1958: 					$allroles{'cm.'.$area}.=':'.$coursepriv;
                   1959: 					$allroles{$spec.'.'.$area}.=':'.$coursepriv;
                   1960: 				    }
                   1961: 				}
                   1962: 			    }
                   1963: 			}
                   1964: 		    }
                   1965: 		} else {
                   1966: 		    if (defined($pr{$trole.':s'})) {
                   1967: 			$allroles{'cm./'}.=':'.$pr{$trole.':s'};
                   1968: 			$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
                   1969: 		    }
                   1970: 		    if ($tdomain ne '') {
                   1971: 			if (defined($pr{$trole.':d'})) {
                   1972: 			    $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   1973: 			    $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
                   1974: 			}
                   1975: 			if ($trest ne '') {
                   1976: 			    if (defined($pr{$trole.':c'})) {
                   1977: 				$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
                   1978: 				$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
                   1979: 			    }
                   1980: 			}
                   1981: 		    }
                   1982: 		}
1.12      www      1983:             }
                   1984:           } 
1.191     harris41 1985:         }
1.125     www      1986:         my $adv=0;
1.128     www      1987:         my $author=0;
1.191     harris41 1988:         foreach (keys %allroles) {
1.11      www      1989:             %thesepriv=();
1.146     www      1990:             if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1.128     www      1991:             if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1.191     harris41 1992:             foreach (split(/:/,$allroles{$_})) {
1.11      www      1993:                 if ($_ ne '') {
1.103     harris41 1994: 		    my ($privilege,$restrictions)=split(/&/,$_);
1.11      www      1995:                     if ($restrictions eq '') {
1.103     harris41 1996: 			$thesepriv{$privilege}='F';
1.11      www      1997:                     } else {
1.103     harris41 1998:                         if ($thesepriv{$privilege} ne 'F') {
                   1999: 			    $thesepriv{$privilege}.=$restrictions;
1.11      www      2000:                         }
                   2001:                     }
                   2002:                 }
1.191     harris41 2003:             }
1.11      www      2004:             $thesestr='';
1.191     harris41 2005:             foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1.11      www      2006:             $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1.191     harris41 2007:         }
1.128     www      2008:         $userroles.='user.adv='.$adv."\n".
                   2009: 	            'user.author='.$author."\n";
1.126     www      2010:         $ENV{'user.adv'}=$adv;
1.11      www      2011:     }
                   2012:     return $userroles;  
                   2013: }
                   2014: 
1.12      www      2015: # --------------------------------------------------------------- get interface
                   2016: 
                   2017: sub get {
1.131     albertel 2018:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      2019:    my $items='';
1.191     harris41 2020:    foreach (@$storearr) {
1.12      www      2021:        $items.=escape($_).'&';
1.191     harris41 2022:    }
1.12      www      2023:    $items=~s/\&$//;
1.131     albertel 2024:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2025:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2026:    my $uhome=&homeserver($uname,$udomain);
                   2027: 
1.133     albertel 2028:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      2029:    my @pairs=split(/\&/,$rep);
1.273     albertel 2030:    if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
                   2031:      return @pairs;
                   2032:    }
1.15      www      2033:    my %returnhash=();
1.42      www      2034:    my $i=0;
1.191     harris41 2035:    foreach (@$storearr) {
1.42      www      2036:       $returnhash{$_}=unescape($pairs[$i]);
                   2037:       $i++;
1.191     harris41 2038:    }
1.15      www      2039:    return %returnhash;
1.27      www      2040: }
                   2041: 
                   2042: # --------------------------------------------------------------- del interface
                   2043: 
                   2044: sub del {
1.133     albertel 2045:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.27      www      2046:    my $items='';
1.191     harris41 2047:    foreach (@$storearr) {
1.27      www      2048:        $items.=escape($_).'&';
1.191     harris41 2049:    }
1.27      www      2050:    $items=~s/\&$//;
1.133     albertel 2051:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2052:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2053:    my $uhome=&homeserver($uname,$udomain);
                   2054: 
                   2055:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15      www      2056: }
                   2057: 
                   2058: # -------------------------------------------------------------- dump interface
                   2059: 
                   2060: sub dump {
1.193     www      2061:    my ($namespace,$udomain,$uname,$regexp)=@_;
1.129     albertel 2062:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2063:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2064:    my $uhome=&homeserver($uname,$udomain);
1.193     www      2065:    if ($regexp) {
                   2066:        $regexp=&escape($regexp);
                   2067:    } else {
                   2068:        $regexp='.';
                   2069:    }
                   2070:    my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
1.12      www      2071:    my @pairs=split(/\&/,$rep);
                   2072:    my %returnhash=();
1.191     harris41 2073:    foreach (@pairs) {
1.12      www      2074:       my ($key,$value)=split(/=/,$_);
1.29      www      2075:       $returnhash{unescape($key)}=unescape($value);
1.318     matthew  2076:    }
                   2077:    return %returnhash;
                   2078: }
                   2079: 
1.319     matthew  2080: # --------------------------------------------------------------- currentdump
                   2081: sub currentdump {
1.328     matthew  2082:    my ($courseid,$sdom,$sname)=@_;
1.326     matthew  2083:    $courseid = $ENV{'request.course.id'} if (! defined($courseid));
                   2084:    $sdom     = $ENV{'user.domain'}       if (! defined($sdom));
                   2085:    $sname    = $ENV{'user.name'}         if (! defined($sname));
                   2086:    my $uhome = &homeserver($sname,$sdom);
                   2087:    my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318     matthew  2088:    return if ($rep =~ /^(error:|no_such_host)/);
1.319     matthew  2089:    #
1.318     matthew  2090:    my %returnhash=();
1.319     matthew  2091:    #
                   2092:    if ($rep eq "unknown_cmd") { 
                   2093:        # an old lond will not know currentdump
                   2094:        # Do a dump and make it look like a currentdump
1.326     matthew  2095:        my @tmp = &dump($courseid,$sdom,$sname,'.');
1.319     matthew  2096:        return if ($tmp[0] =~ /^(error:|no_such_host)/);
                   2097:        my %hash = @tmp;
                   2098:        @tmp=();
                   2099:        # Code ripped from lond, essentially.  The only difference
                   2100:        # here is the unescaping done by lonnet::dump().  Conceivably
                   2101:        # we might run in to problems with parameter names =~ /^v\./
                   2102:        while (my ($key,$value) = each(%hash)) {
                   2103:            my ($v,$symb,$param) = split(/:/,$key);
                   2104:            next if ($v eq 'version' || $symb eq 'keys');
                   2105:            next if (exists($returnhash{$symb}) &&
                   2106:                     exists($returnhash{$symb}->{$param}) &&
                   2107:                     $returnhash{$symb}->{'v.'.$param} > $v);
                   2108:            $returnhash{$symb}->{$param}=$value;
                   2109:            $returnhash{$symb}->{'v.'.$param}=$v;
                   2110:        }
                   2111:        #
                   2112:        # Remove all of the keys in the hashes which keep track of
                   2113:        # the version of the parameter.
                   2114:        while (my ($symb,$param_hash) = each(%returnhash)) {
                   2115:            # use a foreach because we are going to delete from the hash.
                   2116:            foreach my $key (keys(%$param_hash)) {
                   2117:                delete($param_hash->{$key}) if ($key =~ /^v\./);
                   2118:            }
                   2119:        }
                   2120:    } else {
                   2121:        my @pairs=split(/\&/,$rep);
                   2122:        foreach (@pairs) {
                   2123:            my ($key,$value)=split(/=/,$_);
                   2124:            my ($symb,$param) = split(/:/,$key);
                   2125:            $returnhash{&unescape($symb)}->{&unescape($param)} = 
                   2126:                                                           &unescape($value);
                   2127:        }
1.191     harris41 2128:    }
1.12      www      2129:    return %returnhash;
                   2130: }
                   2131: 
                   2132: # --------------------------------------------------------------- put interface
                   2133: 
                   2134: sub put {
1.134     albertel 2135:    my ($namespace,$storehash,$udomain,$uname)=@_;
                   2136:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2137:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2138:    my $uhome=&homeserver($uname,$udomain);
1.12      www      2139:    my $items='';
1.191     harris41 2140:    foreach (keys %$storehash) {
1.134     albertel 2141:        $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1.191     harris41 2142:    }
1.12      www      2143:    $items=~s/\&$//;
1.134     albertel 2144:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47      www      2145: }
                   2146: 
                   2147: # ------------------------------------------------------ critical put interface
                   2148: 
                   2149: sub cput {
1.134     albertel 2150:    my ($namespace,$storehash,$udomain,$uname)=@_;
                   2151:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2152:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2153:    my $uhome=&homeserver($uname,$udomain);
1.47      www      2154:    my $items='';
1.191     harris41 2155:    foreach (keys %$storehash) {
1.134     albertel 2156:        $items.=escape($_).'='.escape($$storehash{$_}).'&';
1.191     harris41 2157:    }
1.47      www      2158:    $items=~s/\&$//;
1.134     albertel 2159:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      2160: }
                   2161: 
                   2162: # -------------------------------------------------------------- eget interface
                   2163: 
                   2164: sub eget {
1.133     albertel 2165:    my ($namespace,$storearr,$udomain,$uname)=@_;
1.12      www      2166:    my $items='';
1.191     harris41 2167:    foreach (@$storearr) {
1.12      www      2168:        $items.=escape($_).'&';
1.191     harris41 2169:    }
1.12      www      2170:    $items=~s/\&$//;
1.133     albertel 2171:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
                   2172:    if (!$uname) { $uname=$ENV{'user.name'}; }
                   2173:    my $uhome=&homeserver($uname,$udomain);
                   2174:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12      www      2175:    my @pairs=split(/\&/,$rep);
                   2176:    my %returnhash=();
1.42      www      2177:    my $i=0;
1.191     harris41 2178:    foreach (@$storearr) {
1.42      www      2179:       $returnhash{$_}=unescape($pairs[$i]);
                   2180:       $i++;
1.191     harris41 2181:    }
1.12      www      2182:    return %returnhash;
                   2183: }
                   2184: 
1.341     www      2185: # ---------------------------------------------- Custom access rule evaluation
                   2186: 
                   2187: sub customaccess {
                   2188:     my ($priv,$uri)=@_;
1.342     www      2189:     my ($urole,$urealm)=split(/\./,$ENV{'request.role'});
1.343     www      2190:     $urealm=~s/^\W//;
                   2191:     my ($udom,$ucrs,$usec)=split(/\//,$urealm);
1.341     www      2192:     my $access=0;
                   2193:     foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.342     www      2194: 	my ($effect,$realm,$role)=split(/\:/,$_);
1.343     www      2195:         if ($role) {
                   2196: 	   if ($role ne $urole) { next; }
                   2197:         }
                   2198:         foreach (split(/\s*\,\s*/,$realm)) {
                   2199:             my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
                   2200:             if ($tdom) {
                   2201: 		if ($tdom ne $udom) { next; }
                   2202:             }
                   2203:             if ($tcrs) {
                   2204: 		if ($tcrs ne $ucrs) { next; }
                   2205:             }
                   2206:             if ($tsec) {
                   2207: 		if ($tsec ne $usec) { next; }
                   2208:             }
                   2209:             $access=($effect eq 'allow');
                   2210:             last;
1.342     www      2211:         }
1.341     www      2212:     }
                   2213:     return $access;
                   2214: }
                   2215: 
1.103     harris41 2216: # ------------------------------------------------- Check for a user privilege
1.12      www      2217: 
                   2218: sub allowed {
                   2219:     my ($priv,$uri)=@_;
1.152     www      2220: 
                   2221:     my $orguri=$uri;
1.52      www      2222:     $uri=&declutter($uri);
1.29      www      2223: 
1.54      www      2224: # Free bre access to adm and meta resources
1.29      www      2225: 
1.54      www      2226:     if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14      www      2227: 	return 'F';
1.159     www      2228:     }
                   2229: 
                   2230: # Free bre to public access
                   2231: 
                   2232:     if ($priv eq 'bre') {
1.238     www      2233:         my $copyright=&metadata($uri,'copyright');
1.301     www      2234: 	if (($copyright eq 'public') && (!$ENV{'request.course.id'})) { 
                   2235:            return 'F'; 
                   2236:         }
1.238     www      2237:         if ($copyright eq 'priv') {
                   2238:             $uri=~/([^\/]+)\/([^\/]+)\//;
                   2239: 	    unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
                   2240: 		return '';
                   2241:             }
                   2242:         }
                   2243:         if ($copyright eq 'domain') {
                   2244:             $uri=~/([^\/]+)\/([^\/]+)\//;
                   2245: 	    unless (($ENV{'user.domain'} eq $1) ||
                   2246:                  ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
                   2247: 		return '';
                   2248:             }
1.262     matthew  2249:         }
                   2250:         if ($ENV{'request.role'}=~ /li\.\//) {
                   2251:             # Library role, so allow browsing of resources in this domain.
                   2252:             return 'F';
1.238     www      2253:         }
1.341     www      2254:         if ($copyright eq 'custom') {
                   2255: 	    unless (&customaccess($priv,$uri)) { return ''; }
                   2256:         }
1.14      www      2257:     }
1.264     matthew  2258:     # Domain coordinator is trying to create a course
                   2259:     if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
                   2260:         # uri is the requested domain in this case.
                   2261:         # comparison to 'request.role.domain' shows if the user has selected
                   2262:         # a role of dc for the domain in question. 
                   2263:         return 'F' if ($uri eq $ENV{'request.role.domain'});
                   2264:     }
1.29      www      2265: 
1.52      www      2266:     my $thisallowed='';
                   2267:     my $statecond=0;
                   2268:     my $courseprivid='';
                   2269: 
                   2270: # Course
                   2271: 
                   2272:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
                   2273:        $thisallowed.=$1;
                   2274:     }
1.29      www      2275: 
1.52      www      2276: # Domain
                   2277: 
                   2278:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
                   2279:        =~/$priv\&([^\:]*)/) {
1.12      www      2280:        $thisallowed.=$1;
                   2281:     }
1.52      www      2282: 
                   2283: # Course: uri itself is a course
1.66      www      2284:     my $courseuri=$uri;
                   2285:     $courseuri=~s/\_(\d)/\/$1/;
1.83      www      2286:     $courseuri=~s/^([^\/])/\/$1/;
1.81      www      2287: 
1.83      www      2288:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1.52      www      2289:        =~/$priv\&([^\:]*)/) {
1.12      www      2290:        $thisallowed.=$1;
                   2291:     }
1.29      www      2292: 
1.314     www      2293: # URI is an uploaded document for this course
                   2294: 
                   2295:     if (($priv eq 'bre') && 
                   2296:         ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
                   2297:         return 'F';
                   2298:     }
1.52      www      2299: # Full access at system, domain or course-wide level? Exit.
1.29      www      2300: 
                   2301:     if ($thisallowed=~/F/) {
                   2302: 	return 'F';
                   2303:     }
                   2304: 
1.52      www      2305: # If this is generating or modifying users, exit with special codes
1.29      www      2306: 
1.166     www      2307:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1.52      www      2308: 	return $thisallowed;
                   2309:     }
                   2310: #
1.103     harris41 2311: # Gathered so far: system, domain and course wide privileges
1.52      www      2312: #
                   2313: # Course: See if uri or referer is an individual resource that is part of 
                   2314: # the course
                   2315: 
                   2316:     if ($ENV{'request.course.id'}) {
1.232     www      2317: 
1.52      www      2318:        $courseprivid=$ENV{'request.course.id'};
                   2319:        if ($ENV{'request.course.sec'}) {
                   2320:           $courseprivid.='/'.$ENV{'request.course.sec'};
                   2321:        }
                   2322:        $courseprivid=~s/\_/\//;
                   2323:        my $checkreferer=1;
1.232     www      2324:        my ($match,$cond)=&is_on_map($uri);
                   2325:        if ($match) {
                   2326:            $statecond=$cond;
1.52      www      2327:            if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
                   2328:                =~/$priv\&([^\:]*)/) {
                   2329:                $thisallowed.=$1;
                   2330:                $checkreferer=0;
                   2331:            }
1.29      www      2332:        }
1.83      www      2333:        
1.148     www      2334:        if ($checkreferer) {
1.152     www      2335: 	  my $refuri=$ENV{'httpref.'.$orguri};
1.148     www      2336:             unless ($refuri) {
1.191     harris41 2337:                 foreach (keys %ENV) {
1.148     www      2338: 		    if ($_=~/^httpref\..*\*/) {
                   2339: 			my $pattern=$_;
1.156     www      2340:                         $pattern=~s/^httpref\.\/res\///;
1.148     www      2341:                         $pattern=~s/\*/\[\^\/\]\+/g;
                   2342:                         $pattern=~s/\//\\\//g;
1.152     www      2343:                         if ($orguri=~/$pattern/) {
1.148     www      2344: 			    $refuri=$ENV{$_};
                   2345:                         }
                   2346:                     }
1.191     harris41 2347:                 }
1.148     www      2348:             }
1.232     www      2349: 
1.148     www      2350:          if ($refuri) { 
1.152     www      2351: 	  $refuri=&declutter($refuri);
1.232     www      2352:           my ($match,$cond)=&is_on_map($refuri);
                   2353:             if ($match) {
                   2354:               my $refstatecond=$cond;
1.52      www      2355:               if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
                   2356:                   =~/$priv\&([^\:]*)/) {
                   2357:                   $thisallowed.=$1;
1.53      www      2358:                   $uri=$refuri;
                   2359:                   $statecond=$refstatecond;
1.52      www      2360:               }
                   2361:           }
1.148     www      2362:         }
1.29      www      2363:        }
1.52      www      2364:    }
1.29      www      2365: 
1.52      www      2366: #
1.103     harris41 2367: # Gathered now: all privileges that could apply, and condition number
1.52      www      2368: # 
                   2369: #
                   2370: # Full or no access?
                   2371: #
1.29      www      2372: 
1.52      www      2373:     if ($thisallowed=~/F/) {
                   2374: 	return 'F';
                   2375:     }
1.29      www      2376: 
1.52      www      2377:     unless ($thisallowed) {
                   2378:         return '';
                   2379:     }
1.29      www      2380: 
1.52      www      2381: # Restrictions exist, deal with them
                   2382: #
                   2383: #   C:according to course preferences
                   2384: #   R:according to resource settings
                   2385: #   L:unless locked
                   2386: #   X:according to user session state
                   2387: #
                   2388: 
                   2389: # Possibly locked functionality, check all courses
1.54      www      2390: # Locks might take effect only after 10 minutes cache expiration for other
                   2391: # courses, and 2 minutes for current course
1.52      www      2392: 
                   2393:     my $envkey;
                   2394:     if ($thisallowed=~/L/) {
                   2395:         foreach $envkey (keys %ENV) {
1.54      www      2396:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
                   2397:                my $courseid=$2;
                   2398:                my $roleid=$1.'.'.$2;
1.92      www      2399:                $courseid=~s/^\///;
1.54      www      2400:                my $expiretime=600;
                   2401:                if ($ENV{'request.role'} eq $roleid) {
                   2402: 		  $expiretime=120;
                   2403:                }
                   2404: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
                   2405:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
                   2406:                if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
                   2407: 		   &coursedescription($courseid);
                   2408:                }
                   2409:                if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
                   2410:                 || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
                   2411: 		   if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1.57      www      2412:                        &log($ENV{'user.domain'},$ENV{'user.name'},
1.239     www      2413:                             $ENV{'user.home'},
1.57      www      2414:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52      www      2415:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54      www      2416:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      2417: 		       return '';
                   2418:                    }
                   2419:                }
1.54      www      2420:                if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
                   2421:                 || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
                   2422: 		   if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1.57      www      2423:                        &log($ENV{'user.domain'},$ENV{'user.name'},
1.239     www      2424:                             $ENV{'user.home'},
1.57      www      2425:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52      www      2426:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54      www      2427:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52      www      2428: 		       return '';
                   2429:                    }
                   2430:                }
                   2431: 	   }
1.29      www      2432:        }
1.52      www      2433:     }
                   2434:    
                   2435: #
                   2436: # Rest of the restrictions depend on selected course
                   2437: #
                   2438: 
                   2439:     unless ($ENV{'request.course.id'}) {
                   2440:        return '1';
                   2441:     }
1.29      www      2442: 
1.52      www      2443: #
                   2444: # Now user is definitely in a course
                   2445: #
1.53      www      2446: 
                   2447: 
                   2448: # Course preferences
                   2449: 
                   2450:    if ($thisallowed=~/C/) {
1.54      www      2451:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1.237     www      2452:        my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
1.54      www      2453:        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.194     www      2454: 	   =~/$rolecode/) {
1.57      www      2455:            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
                   2456:                 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1.237     www      2457:                 $ENV{'request.course.id'});
                   2458:            return '';
                   2459:        }
                   2460: 
                   2461:        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
                   2462: 	   =~/$unamedom/) {
                   2463:            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
                   2464:                 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
1.54      www      2465:                 $ENV{'request.course.id'});
                   2466:            return '';
                   2467:        }
1.53      www      2468:    }
                   2469: 
                   2470: # Resource preferences
                   2471: 
                   2472:    if ($thisallowed=~/R/) {
1.54      www      2473:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1.341     www      2474:        if (&metadata($uri,'roledeny')=~/$rolecode/) {
                   2475: 	  &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1.57      www      2476:                     'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1.341     www      2477:           return '';
1.54      www      2478:        }
1.53      www      2479:    }
1.30      www      2480: 
1.246     www      2481: # Restricted by state or randomout?
1.30      www      2482: 
1.52      www      2483:    if ($thisallowed=~/X/) {
1.247     www      2484:       if ($ENV{'acc.randomout'}) {
1.249     www      2485:          my $symb=&symbread($uri,1);
1.248     www      2486:          if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) { 
                   2487:             return ''; 
                   2488:          }
1.247     www      2489:       }
                   2490:       if (&condval($statecond)) {
1.52      www      2491: 	 return '2';
                   2492:       } else {
                   2493:          return '';
                   2494:       }
                   2495:    }
1.30      www      2496: 
1.52      www      2497:    return 'F';
1.232     www      2498: }
                   2499: 
                   2500: # --------------------------------------------------- Is a resource on the map?
                   2501: 
                   2502: sub is_on_map {
                   2503:     my $uri=&declutter(shift);
                   2504:     my @uriparts=split(/\//,$uri);
                   2505:     my $filename=$uriparts[$#uriparts];
                   2506:     my $pathname=$uri;
1.289     bowersj2 2507:     $pathname=~s|/\Q$filename\E$||;
1.332     www      2508:     $pathname=~s/^adm\/wrapper\///;    
1.289     bowersj2 2509:     #Trying to find the conditional for the file
1.232     www      2510:     my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.289     bowersj2 2511: 	       /\&\Q$filename\E\:([\d\|]+)\&/);
1.232     www      2512:     if ($match) {
1.289     bowersj2 2513: 	return (1,$1);
                   2514:     } else {
                   2515: 	return (0,0);
                   2516:     }
1.12      www      2517: }
                   2518: 
                   2519: # ----------------------------------------------------------------- Define Role
                   2520: 
                   2521: sub definerole {
                   2522:   if (allowed('mcr','/')) {
                   2523:     my ($rolename,$sysrole,$domrole,$courole)=@_;
1.191     harris41 2524:     foreach (split('/',$sysrole)) {
1.21      www      2525: 	my ($crole,$cqual)=split(/\&/,$_);
                   2526:         if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
                   2527:         if ($pr{'cr:s'}=~/$crole\&/) {
                   2528: 	    if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) { 
                   2529:                return "refused:s:$crole&$cqual"; 
                   2530:             }
                   2531:         }
1.191     harris41 2532:     }
                   2533:     foreach (split('/',$domrole)) {
1.21      www      2534: 	my ($crole,$cqual)=split(/\&/,$_);
                   2535:         if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
                   2536:         if ($pr{'cr:d'}=~/$crole\&/) {
                   2537: 	    if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) { 
                   2538:                return "refused:d:$crole&$cqual"; 
                   2539:             }
                   2540:         }
1.191     harris41 2541:     }
                   2542:     foreach (split('/',$courole)) {
1.21      www      2543: 	my ($crole,$cqual)=split(/\&/,$_);
                   2544:         if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
                   2545:         if ($pr{'cr:c'}=~/$crole\&/) {
                   2546: 	    if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) { 
                   2547:                return "refused:c:$crole&$cqual"; 
                   2548:             }
                   2549:         }
1.191     harris41 2550:     }
1.12      www      2551:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
                   2552:                 "$ENV{'user.domain'}:$ENV{'user.name'}:".
1.21      www      2553: 	        "rolesdef_$rolename=".
                   2554:                 escape($sysrole.'_'.$domrole.'_'.$courole);
1.12      www      2555:     return reply($command,$ENV{'user.home'});
                   2556:   } else {
                   2557:     return 'refused';
                   2558:   }
1.105     harris41 2559: }
                   2560: 
                   2561: # ---------------- Make a metadata query against the network of library servers
                   2562: 
                   2563: sub metadata_query {
1.244     matthew  2564:     my ($query,$custom,$customshow,$server_array)=@_;
1.120     harris41 2565:     my %rhash;
1.244     matthew  2566:     my @server_list = (defined($server_array) ? @$server_array
                   2567:                                               : keys(%libserv) );
                   2568:     for my $server (@server_list) {
1.118     harris41 2569: 	unless ($custom or $customshow) {
                   2570: 	    my $reply=&reply("querysend:".&escape($query),$server);
                   2571: 	    $rhash{$server}=$reply;
                   2572: 	}
                   2573: 	else {
                   2574: 	    my $reply=&reply("querysend:".&escape($query).':'.
                   2575: 			     &escape($custom).':'.&escape($customshow),
                   2576: 			     $server);
                   2577: 	    $rhash{$server}=$reply;
                   2578: 	}
1.112     harris41 2579:     }
1.118     harris41 2580:     return \%rhash;
1.240     www      2581: }
                   2582: 
                   2583: # ----------------------------------------- Send log queries and wait for reply
                   2584: 
                   2585: sub log_query {
                   2586:     my ($uname,$udom,$query,%filters)=@_;
                   2587:     my $uhome=&homeserver($uname,$udom);
                   2588:     if ($uhome eq 'no_host') { return 'error: no_host'; }
                   2589:     my $uhost=$hostname{$uhome};
1.241     www      2590:     my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
1.240     www      2591:     my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
                   2592:                        $uhome);
                   2593:     unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
1.242     www      2594:     return get_query_reply($queryid);
                   2595: }
                   2596: 
                   2597: sub get_query_reply {
                   2598:     my $queryid=shift;
1.240     www      2599:     my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
                   2600:     my $reply='';
                   2601:     for (1..100) {
                   2602: 	sleep 2;
                   2603:         if (-e $replyfile.'.end') {
                   2604: 	    if (my $fh=Apache::File->new($replyfile)) {
                   2605:                $reply.=<$fh>;
                   2606:                $fh->close;
                   2607: 	   } else { return 'error: reply_file_error'; }
1.242     www      2608:            return &unescape($reply);
                   2609: 	}
1.240     www      2610:     }
1.242     www      2611:     return 'timeout:'.$queryid;
1.240     www      2612: }
                   2613: 
                   2614: sub courselog_query {
1.241     www      2615: #
                   2616: # possible filters:
                   2617: # url: url or symb
                   2618: # username
                   2619: # domain
                   2620: # action: view, submit, grade
                   2621: # start: timestamp
                   2622: # end: timestamp
                   2623: #
1.240     www      2624:     my (%filters)=@_;
                   2625:     unless ($ENV{'request.course.id'}) { return 'no_course'; }
1.241     www      2626:     if ($filters{'url'}) {
                   2627: 	$filters{'url'}=&symbclean(&declutter($filters{'url'}));
                   2628:         $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
                   2629:         $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
                   2630:     }
1.240     www      2631:     my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
                   2632:     my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
                   2633:     return &log_query($cname,$cdom,'courselog',%filters);
                   2634: }
                   2635: 
                   2636: sub userlog_query {
                   2637:     my ($uname,$udom,%filters)=@_;
                   2638:     return &log_query($uname,$udom,'userlog',%filters);
1.12      www      2639: }
                   2640: 
                   2641: # ------------------------------------------------------------------ Plain Text
                   2642: 
                   2643: sub plaintext {
1.22      www      2644:     my $short=shift;
                   2645:     return $prp{$short};
1.12      www      2646: }
                   2647: 
                   2648: # ----------------------------------------------------------------- Assign Role
                   2649: 
                   2650: sub assignrole {
1.357     www      2651:     my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
1.21      www      2652:     my $mrole;
                   2653:     if ($role =~ /^cr\//) {
1.104     www      2654: 	unless (&allowed('ccr',$url)) {
                   2655:            &logthis('Refused custom assignrole: '.
                   2656:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
                   2657: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
                   2658:            return 'refused'; 
                   2659:         }
1.21      www      2660:         $mrole='cr';
                   2661:     } else {
1.82      www      2662:         my $cwosec=$url;
1.83      www      2663:         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.373     www      2664:         unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) { 
1.104     www      2665:            &logthis('Refused assignrole: '.
                   2666:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
                   2667: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
                   2668:            return 'refused'; 
                   2669:         }
1.21      www      2670:         $mrole=$role;
                   2671:     }
                   2672:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
                   2673:                 "$udom:$uname:$url".'_'."$mrole=$role";
1.81      www      2674:     if ($end) { $command.='_'.$end; }
1.21      www      2675:     if ($start) {
                   2676: 	if ($end) { 
1.81      www      2677:            $command.='_'.$start; 
1.21      www      2678:         } else {
1.81      www      2679:            $command.='_0_'.$start;
1.21      www      2680:         }
                   2681:     }
1.357     www      2682: # actually delete
                   2683:     if ($deleteflag) {
1.373     www      2684: 	if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357     www      2685: # modify command to delete the role
                   2686:            $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:".
                   2687:                 "$udom:$uname:$url".'_'."$mrole";
1.373     www      2688: 	   &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom"); 
1.357     www      2689: # set start and finish to negative values for userrolelog
                   2690:            $start=-1;
                   2691:            $end=-1;
                   2692:         }
                   2693:     }
                   2694: # send command
1.349     www      2695:     my $answer=&reply($command,&homeserver($uname,$udom));
1.357     www      2696: # log new user role if status is ok
1.349     www      2697:     if ($answer eq 'ok') {
                   2698: 	&userrolelog($mrole,$uname,$udom,$url,$start,$end);
                   2699:     }
                   2700:     return $answer;
1.169     harris41 2701: }
                   2702: 
                   2703: # -------------------------------------------------- Modify user authentication
1.197     www      2704: # Overrides without validation
                   2705: 
1.169     harris41 2706: sub modifyuserauth {
                   2707:     my ($udom,$uname,$umode,$upass)=@_;
                   2708:     my $uhome=&homeserver($uname,$udom);
1.197     www      2709:     unless (&allowed('mau',$udom)) { return 'refused'; }
                   2710:     &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.272     matthew  2711:              $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
                   2712:              ' in domain '.$ENV{'request.role.domain'});  
1.169     harris41 2713:     my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
                   2714: 		     &escape($upass),$uhome);
1.197     www      2715:     &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
                   2716:         'Authentication changed for '.$udom.', '.$uname.', '.$umode.
                   2717:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
                   2718:     &log($udom,,$uname,$uhome,
                   2719:         'Authentication changed by '.$ENV{'user.domain'}.', '.
                   2720:                                      $ENV{'user.name'}.', '.$umode.
                   2721:          '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169     harris41 2722:     unless ($reply eq 'ok') {
1.197     www      2723:         &logthis('Authentication mode error: '.$reply);
1.169     harris41 2724: 	return 'error: '.$reply;
                   2725:     }   
1.170     harris41 2726:     return 'ok';
1.80      www      2727: }
                   2728: 
1.81      www      2729: # --------------------------------------------------------------- Modify a user
1.80      www      2730: 
1.81      www      2731: sub modifyuser {
1.206     matthew  2732:     my ($udom,    $uname, $uid,
                   2733:         $umode,   $upass, $first,
                   2734:         $middle,  $last,  $gene,
                   2735:         $forceid, $desiredhome)=@_;
1.198     www      2736:     $udom=~s/\W//g;
                   2737:     $uname=~s/\W//g;
1.81      www      2738:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80      www      2739:              $umode.', '.$first.', '.$middle.', '.
1.206     matthew  2740: 	     $last.', '.$gene.'(forceid: '.$forceid.')'.
                   2741:              (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
                   2742:                                      ' desiredhome not specified'). 
1.272     matthew  2743:              ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
                   2744:              ' in domain '.$ENV{'request.role.domain'});
1.230     stredwic 2745:     my $uhome=&homeserver($uname,$udom,'true');
1.80      www      2746: # ----------------------------------------------------------------- Create User
1.81      www      2747:     if (($uhome eq 'no_host') && ($umode) && ($upass)) {
1.80      www      2748:         my $unhome='';
1.209     matthew  2749:         if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) { 
                   2750:             $unhome = $desiredhome;
                   2751: 	} elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
1.80      www      2752: 	    $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1.209     matthew  2753:         } else { # load balancing routine for determining $unhome
1.80      www      2754:             my $tryserver;
1.81      www      2755:             my $loadm=10000000;
1.80      www      2756:             foreach $tryserver (keys %libserv) {
                   2757: 	       if ($hostdom{$tryserver} eq $udom) {
                   2758:                   my $answer=reply('load',$tryserver);
                   2759:                   if (($answer=~/\d+/) && ($answer<$loadm)) {
                   2760: 		      $loadm=$answer;
                   2761:                       $unhome=$tryserver;
                   2762:                   }
                   2763: 	       }
                   2764: 	    }
                   2765:         }
                   2766:         if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206     matthew  2767: 	    return 'error: unable to find a home server for '.$uname.
                   2768:                    ' in domain '.$udom;
1.80      www      2769:         }
                   2770:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
                   2771:                          &escape($upass),$unhome);
                   2772: 	unless ($reply eq 'ok') {
                   2773:             return 'error: '.$reply;
                   2774:         }   
1.230     stredwic 2775:         $uhome=&homeserver($uname,$udom,'true');
1.80      www      2776:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
                   2777: 	    return 'error: verify home';
                   2778:         }
1.209     matthew  2779:     }   # End of creation of new user
1.80      www      2780: # ---------------------------------------------------------------------- Add ID
                   2781:     if ($uid) {
                   2782:        $uid=~tr/A-Z/a-z/;
                   2783:        my %uidhash=&idrget($udom,$uname);
1.196     www      2784:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 
                   2785:          && (!$forceid)) {
1.80      www      2786: 	  unless ($uid eq $uidhash{$uname}) {
                   2787: 	      return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
                   2788:           }
                   2789:        } else {
                   2790: 	  &idput($udom,($uname => $uid));
                   2791:        }
                   2792:     }
                   2793: # -------------------------------------------------------------- Add names, etc
1.313     matthew  2794:     my @tmp=&get('environment',
1.134     albertel 2795: 		   ['firstname','middlename','lastname','generation'],
                   2796: 		   $udom,$uname);
1.313     matthew  2797:     my %names;
                   2798:     if ($tmp[0] =~ m/^error:.*/) { 
                   2799:         %names=(); 
                   2800:     } else {
                   2801:         %names = @tmp;
                   2802:     }
1.385   ! matthew  2803:     if (defined($first))  { $names{'firstname'}  = $first; }
        !          2804:     if (defined($middle)) { $names{'middlename'} = $middle; }
        !          2805:     if (defined($last))   { $names{'lastname'}   = $last; }
        !          2806:     if (defined($gene))   { $names{'generation'} = $gene; }
1.134     albertel 2807:     my $reply = &put('environment', \%names, $udom,$uname);
                   2808:     if ($reply ne 'ok') { return 'error: '.$reply; }
1.81      www      2809:     &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80      www      2810:              $umode.', '.$first.', '.$middle.', '.
                   2811: 	     $last.', '.$gene.' by '.
                   2812:              $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1.134     albertel 2813:     return 'ok';
1.80      www      2814: }
                   2815: 
1.81      www      2816: # -------------------------------------------------------------- Modify student
1.80      www      2817: 
1.81      www      2818: sub modifystudent {
                   2819:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.209     matthew  2820:         $end,$start,$forceid,$desiredhome)=@_;
1.81      www      2821:     my $cid='';
                   2822:     unless ($cid=$ENV{'request.course.id'}) {
1.80      www      2823: 	return 'not_in_class';
                   2824:     }
                   2825: # --------------------------------------------------------------- Make the user
1.81      www      2826:     my $reply=&modifyuser
1.209     matthew  2827: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
                   2828:          $desiredhome);
1.80      www      2829:     unless ($reply eq 'ok') { return $reply; }
1.297     matthew  2830:     # This will cause &modify_student_enrollment to get the uid from the
                   2831:     # students environment
                   2832:     $uid = undef if (!$forceid);
                   2833:     $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,
                   2834:                                         $last,$gene,$usec,$end,$start);
                   2835:     return $reply;
                   2836: }
                   2837: 
                   2838: sub modify_student_enrollment {
                   2839:     my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start) = @_;
                   2840:     # Get the course id from the environment
                   2841:     my $cid='';
                   2842:     unless ($cid=$ENV{'request.course.id'}) {
                   2843: 	return 'not_in_class';
                   2844:     }
                   2845:     # Make sure the user exists
1.81      www      2846:     my $uhome=&homeserver($uname,$udom);
                   2847:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   2848: 	return 'error: no such user';
                   2849:     }
1.297     matthew  2850:     #
                   2851:     # Get student data if we were not given enough information
                   2852:     if (!defined($first)  || $first  eq '' || 
                   2853:         !defined($last)   || $last   eq '' || 
                   2854:         !defined($uid)    || $uid    eq '' || 
                   2855:         !defined($middle) || $middle eq '' || 
                   2856:         !defined($gene)   || $gene   eq '') {
1.294     matthew  2857:         # They did not supply us with enough data to enroll the student, so
                   2858:         # we need to pick up more information.
1.297     matthew  2859:         my %tmp = &get('environment',
1.294     matthew  2860:                        ['firstname','middlename','lastname', 'generation','id']
1.297     matthew  2861:                        ,$udom,$uname);
                   2862: 
                   2863:         foreach (keys(%tmp)) {
                   2864:             &logthis("key $_ = ".$tmp{$_});
                   2865:         }
1.294     matthew  2866:         $first  = $tmp{'firstname'}  if (!defined($first)  || $first  eq '');
                   2867:         $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
                   2868:         $last   = $tmp{'lastname'}   if (!defined($last)   || $last eq '');
1.297     matthew  2869:         $gene   = $tmp{'generation'} if (!defined($gene)   || $gene eq '');
1.294     matthew  2870:         $uid    = $tmp{'id'}         if (!defined($uid)    || $uid  eq '');
                   2871:     }
                   2872:     my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
                   2873:                                                            $first,$middle);
1.297     matthew  2874:     my $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1.81      www      2875: 	              $ENV{'course.'.$cid.'.num'}.':classlist:'.
                   2876:                       &escape($uname.':'.$udom).'='.
1.294     matthew  2877:                       &escape(join(':',$end,$start,$uid,$usec,$fullname)),
1.81      www      2878: 	              $ENV{'course.'.$cid.'.home'});
                   2879:     unless (($reply eq 'ok') || ($reply eq 'delayed')) {
                   2880: 	return 'error: '.$reply;
                   2881:     }
1.297     matthew  2882:     # Add student role to user
1.83      www      2883:     my $uurl='/'.$cid;
1.81      www      2884:     $uurl=~s/\_/\//g;
                   2885:     if ($usec) {
                   2886: 	$uurl.='/'.$usec;
                   2887:     }
                   2888:     return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21      www      2889: }
                   2890: 
1.84      www      2891: # ------------------------------------------------- Write to course preferences
                   2892: 
                   2893: sub writecoursepref {
                   2894:     my ($courseid,%prefs)=@_;
                   2895:     $courseid=~s/^\///;
                   2896:     $courseid=~s/\_/\//g;
                   2897:     my ($cdomain,$cnum)=split(/\//,$courseid);
                   2898:     my $chome=homeserver($cnum,$cdomain);
                   2899:     if (($chome eq '') || ($chome eq 'no_host')) { 
                   2900: 	return 'error: no such course';
                   2901:     }
                   2902:     my $cstring='';
1.191     harris41 2903:     foreach (keys %prefs) {
1.84      www      2904: 	$cstring.=escape($_).'='.escape($prefs{$_}).'&';
1.191     harris41 2905:     }
1.84      www      2906:     $cstring=~s/\&$//;
                   2907:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
                   2908: }
                   2909: 
                   2910: # ---------------------------------------------------------- Make/modify course
                   2911: 
                   2912: sub createcourse {
1.271     www      2913:     my ($udom,$description,$url,$course_server,$nonstandard)=@_;
1.84      www      2914:     $url=&declutter($url);
                   2915:     my $cid='';
1.264     matthew  2916:     unless (&allowed('ccc',$udom)) {
1.84      www      2917:         return 'refused';
                   2918:     }
                   2919: # ------------------------------------------------------------------- Create ID
                   2920:    my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   2921:        unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
                   2922: # ----------------------------------------------- Make sure that does not exist
1.230     stredwic 2923:    my $uhome=&homeserver($uname,$udom,'true');
1.84      www      2924:    unless (($uhome eq '') || ($uhome eq 'no_host')) {
                   2925:        $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
                   2926:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1.230     stredwic 2927:        $uhome=&homeserver($uname,$udom,'true');       
1.84      www      2928:        unless (($uhome eq '') || ($uhome eq 'no_host')) {
                   2929:            return 'error: unable to generate unique course-ID';
                   2930:        } 
                   2931:    }
1.264     matthew  2932: # ------------------------------------------------ Check supplied server name
                   2933:     $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
                   2934:     if (! exists($libserv{$course_server})) {
                   2935:         return 'error:bad server name '.$course_server;
                   2936:     }
1.84      www      2937: # ------------------------------------------------------------- Make the course
                   2938:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264     matthew  2939:                       $course_server);
1.84      www      2940:     unless ($reply eq 'ok') { return 'error: '.$reply; }
1.230     stredwic 2941:     $uhome=&homeserver($uname,$udom,'true');
1.84      www      2942:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
                   2943: 	return 'error: no such course';
                   2944:     }
1.271     www      2945: # ----------------------------------------------------------------- Course made
1.358     www      2946: # log existance
                   2947:     &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description),
                   2948:                  $uhome);
                   2949:     &flushcourselogs();
                   2950: # set toplevel url
1.271     www      2951:     my $topurl=$url;
                   2952:     unless ($nonstandard) {
                   2953: # ------------------------------------------ For standard courses, make top url
                   2954:         my $mapurl=&clutter($url);
1.278     www      2955:         if ($mapurl eq '/res/') { $mapurl=''; }
1.271     www      2956:         $ENV{'form.initmap'}=(<<ENDINITMAP);
                   2957: <map>
                   2958: <resource id="1" type="start"></resource>
                   2959: <resource id="2" src="$mapurl"></resource>
                   2960: <resource id="3" type="finish"></resource>
                   2961: <link index="1" from="1" to="2"></link>
                   2962: <link index="2" from="2" to="3"></link>
                   2963: </map>
                   2964: ENDINITMAP
                   2965:         $topurl=&declutter(
                   2966:         &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
                   2967:                           );
                   2968:     }
                   2969: # ----------------------------------------------------------- Write preferences
1.84      www      2970:     &writecoursepref($udom.'_'.$uname,
                   2971:                      ('description' => $description,
1.271     www      2972:                       'url'         => $topurl));
1.84      www      2973:     return '/'.$udom.'/'.$uname;
                   2974: }
                   2975: 
1.21      www      2976: # ---------------------------------------------------------- Assign Custom Role
                   2977: 
                   2978: sub assigncustomrole {
1.357     www      2979:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
1.21      www      2980:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.357     www      2981:                        $end,$start,$deleteflag);
1.21      www      2982: }
                   2983: 
                   2984: # ----------------------------------------------------------------- Revoke Role
                   2985: 
                   2986: sub revokerole {
1.357     www      2987:     my ($udom,$uname,$url,$role,$deleteflag)=@_;
1.21      www      2988:     my $now=time;
1.357     www      2989:     return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
1.21      www      2990: }
                   2991: 
                   2992: # ---------------------------------------------------------- Revoke Custom Role
                   2993: 
                   2994: sub revokecustomrole {
1.357     www      2995:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
1.21      www      2996:     my $now=time;
1.357     www      2997:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
                   2998:            $deleteflag);
1.17      www      2999: }
                   3000: 
                   3001: # ------------------------------------------------------------ Directory lister
                   3002: 
                   3003: sub dirlist {
1.253     stredwic 3004:     my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
                   3005: 
1.18      www      3006:     $uri=~s/^\///;
                   3007:     $uri=~s/\/$//;
1.253     stredwic 3008:     my ($udom, $uname);
                   3009:     (undef,$udom,$uname)=split(/\//,$uri);
                   3010:     if(defined($userdomain)) {
                   3011:         $udom = $userdomain;
                   3012:     }
                   3013:     if(defined($username)) {
                   3014:         $uname = $username;
                   3015:     }
                   3016: 
                   3017:     my $dirRoot = $perlvar{'lonDocRoot'};
                   3018:     if(defined($alternateDirectoryRoot)) {
                   3019:         $dirRoot = $alternateDirectoryRoot;
                   3020:         $dirRoot =~ s/\/$//;
                   3021:     }
                   3022: 
                   3023:     if($udom) {
                   3024:         if($uname) {
                   3025:             my $listing=reply('ls:'.$dirRoot.'/'.$uri,
                   3026:                               homeserver($uname,$udom));
                   3027:             return split(/:/,$listing);
                   3028:         } elsif(!defined($alternateDirectoryRoot)) {
                   3029:             my $tryserver;
                   3030:             my %allusers=();
                   3031:             foreach $tryserver (keys %libserv) {
                   3032:                 if($hostdom{$tryserver} eq $udom) {
                   3033:                     my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
                   3034:                                       $udom, $tryserver);
                   3035:                     if (($listing ne 'no_such_dir') && ($listing ne 'empty')
                   3036:                         && ($listing ne 'con_lost')) {
                   3037:                         foreach (split(/:/,$listing)) {
                   3038:                             my ($entry,@stat)=split(/&/,$_);
                   3039:                             $allusers{$entry}=1;
                   3040:                         }
                   3041:                     }
1.191     harris41 3042:                 }
1.253     stredwic 3043:             }
                   3044:             my $alluserstr='';
                   3045:             foreach (sort keys %allusers) {
                   3046:                 $alluserstr.=$_.'&user:';
                   3047:             }
                   3048:             $alluserstr=~s/:$//;
                   3049:             return split(/:/,$alluserstr);
                   3050:         } else {
                   3051:             my @emptyResults = ();
                   3052:             push(@emptyResults, 'missing user name');
                   3053:             return split(':',@emptyResults);
                   3054:         }
                   3055:     } elsif(!defined($alternateDirectoryRoot)) {
                   3056:         my $tryserver;
                   3057:         my %alldom=();
                   3058:         foreach $tryserver (keys %libserv) {
                   3059:             $alldom{$hostdom{$tryserver}}=1;
                   3060:         }
                   3061:         my $alldomstr='';
                   3062:         foreach (sort keys %alldom) {
                   3063:             $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
                   3064:         }
                   3065:         $alldomstr=~s/:$//;
                   3066:         return split(/:/,$alldomstr);       
                   3067:     } else {
                   3068:         my @emptyResults = ();
                   3069:         push(@emptyResults, 'missing domain');
                   3070:         return split(':',@emptyResults);
1.275     stredwic 3071:     }
                   3072: }
                   3073: 
                   3074: # --------------------------------------------- GetFileTimestamp
                   3075: # This function utilizes dirlist and returns the date stamp for
                   3076: # when it was last modified.  It will also return an error of -1
                   3077: # if an error occurs
                   3078: 
                   3079: sub GetFileTimestamp {
                   3080:     my ($studentDomain,$studentName,$filename,$root)=@_;
                   3081:     $studentDomain=~s/\W//g;
                   3082:     $studentName=~s/\W//g;
                   3083:     my $subdir=$studentName.'__';
                   3084:     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   3085:     my $proname="$studentDomain/$subdir/$studentName";
                   3086:     $proname .= '/'.$filename;
1.375     matthew  3087:     my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain, 
                   3088:                                               $studentName, $root);
1.275     stredwic 3089:     my @stats = split('&', $fileStat);
                   3090:     if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375     matthew  3091:         # @stats contains first the filename, then the stat output
                   3092:         return $stats[10]; # so this is 10 instead of 9.
1.275     stredwic 3093:     } else {
                   3094:         return -1;
1.253     stredwic 3095:     }
1.26      www      3096: }
                   3097: 
                   3098: # -------------------------------------------------------- Value of a Condition
                   3099: 
1.40      www      3100: sub directcondval {
                   3101:     my $number=shift;
                   3102:     if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
                   3103:        return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
                   3104:     } else {
                   3105:        return 2;
                   3106:     }
                   3107: }
                   3108: 
1.26      www      3109: sub condval {
                   3110:     my $condidx=shift;
                   3111:     my $result=0;
1.54      www      3112:     my $allpathcond='';
1.191     harris41 3113:     foreach (split(/\|/,$condidx)) {
1.54      www      3114:        if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
                   3115: 	   $allpathcond.=
                   3116:                '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
                   3117:        }
1.191     harris41 3118:     }
1.54      www      3119:     $allpathcond=~s/\|$//;
1.33      www      3120:     if ($ENV{'request.course.id'}) {
1.54      www      3121:        if ($allpathcond) {
1.26      www      3122:           my $operand='|';
                   3123: 	  my @stack;
1.191     harris41 3124:            foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
1.26      www      3125:               if ($_ eq '(') {
                   3126:                  push @stack,($operand,$result)
                   3127:               } elsif ($_ eq ')') {
                   3128:                   my $before=pop @stack;
                   3129: 		  if (pop @stack eq '&') {
                   3130: 		      $result=$result>$before?$before:$result;
                   3131:                   } else {
                   3132:                       $result=$result>$before?$result:$before;
                   3133:                   }
                   3134:               } elsif (($_ eq '&') || ($_ eq '|')) {
                   3135:                   $operand=$_;
                   3136:               } else {
1.40      www      3137:                   my $new=directcondval($_);
1.26      www      3138:                   if ($operand eq '&') {
                   3139:                      $result=$result>$new?$new:$result;
                   3140:                   } else {
                   3141:                      $result=$result>$new?$result:$new;
1.191     harris41 3142:                   }
1.26      www      3143:               }
1.191     harris41 3144:           }
1.26      www      3145:        }
                   3146:     }
                   3147:     return $result;
1.279     www      3148: }
                   3149: 
                   3150: # ---------------------------------------------------- Devalidate courseresdata
                   3151: 
                   3152: sub devalidatecourseresdata {
                   3153:     my ($coursenum,$coursedomain)=@_;
                   3154:     my $hashid=$coursenum.':'.$coursedomain;
                   3155:     delete $courseresdatacache{$hashid.'.time'};
1.28      www      3156: }
                   3157: 
1.200     www      3158: # --------------------------------------------------- Course Resourcedata Query
                   3159: 
                   3160: sub courseresdata {
                   3161:     my ($coursenum,$coursedomain,@which)=@_;
                   3162:     my $coursehom=&homeserver($coursenum,$coursedomain);
                   3163:     my $hashid=$coursenum.':'.$coursedomain;
1.250     albertel 3164:     my $dodump=0;
                   3165:     if (!defined($courseresdatacache{$hashid.'.time'})) {
                   3166: 	$dodump=1;
                   3167:     } else {
                   3168: 	if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
                   3169:     }
                   3170:     if ($dodump) {
1.251     albertel 3171: 	my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
                   3172: 	my ($tmp) = keys(%dumpreply);
                   3173: 	if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   3174: 	    $courseresdatacache{$hashid.'.time'}=time;
                   3175: 	    $courseresdatacache{$hashid}=\%dumpreply;
1.306     albertel 3176: 	} elsif ($tmp =~ /^(con_lost|no_such_host)/) {
                   3177: 	    return $tmp;
1.250     albertel 3178: 	}
                   3179:     }
1.251     albertel 3180:     foreach my $item (@which) {
1.287     albertel 3181: 	if (defined($courseresdatacache{$hashid}->{$item})) {
1.251     albertel 3182: 	    return $courseresdatacache{$hashid}->{$item};
                   3183: 	}
1.250     albertel 3184:     }
1.291     albertel 3185:     return undef;
1.200     www      3186: }
                   3187: 
1.379     matthew  3188: #
                   3189: # EXT resource caching routines
                   3190: #
                   3191: 
                   3192: sub clear_EXT_cache_status {
1.383     albertel 3193:     &delenv('cache.EXT.');
1.379     matthew  3194: }
                   3195: 
                   3196: sub EXT_cache_status {
                   3197:     my ($target_domain,$target_user) = @_;
1.383     albertel 3198:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.379     matthew  3199:     if (exists($ENV{$cachename}) && ($ENV{$cachename}+1800) > time) {
                   3200:         # We know already the user has no data
                   3201:         return 1;
                   3202:     } else {
                   3203:         return 0;
                   3204:     }
                   3205: }
                   3206: 
                   3207: sub EXT_cache_set {
                   3208:     my ($target_domain,$target_user) = @_;
1.383     albertel 3209:     my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.379     matthew  3210:     &appenv($cachename => time);
                   3211: }
                   3212: 
1.28      www      3213: # --------------------------------------------------------- Value of a Variable
1.58      www      3214: sub EXT {
1.377     matthew  3215:     my ($varname,$symbparm,$udom,$uname,$usection)=@_;
1.218     albertel 3216: 
1.68      www      3217:     unless ($varname) { return ''; }
1.218     albertel 3218:     #get real user name/domain, courseid and symb
                   3219:     my $courseid;
1.359     albertel 3220:     my $publicuser;
1.218     albertel 3221:     if (!($uname && $udom)) {
1.360     albertel 3222:       (my $cursymb,$courseid,$udom,$uname,$publicuser)=
1.378     matthew  3223: 	  &Apache::lonxml::whichuser($symbparm);
1.218     albertel 3224:       if (!$symbparm) {	$symbparm=$cursymb; }
                   3225:     } else {
                   3226: 	$courseid=$ENV{'request.course.id'};
                   3227:     }
1.48      www      3228:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
                   3229:     my $rest;
1.320     albertel 3230:     if (defined($therest[0])) {
1.48      www      3231:        $rest=join('.',@therest);
                   3232:     } else {
                   3233:        $rest='';
                   3234:     }
1.320     albertel 3235: 
1.57      www      3236:     my $qualifierrest=$qualifier;
                   3237:     if ($rest) { $qualifierrest.='.'.$rest; }
                   3238:     my $spacequalifierrest=$space;
                   3239:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28      www      3240:     if ($realm eq 'user') {
1.48      www      3241: # --------------------------------------------------------------- user.resource
                   3242: 	if ($space eq 'resource') {
1.335     albertel 3243: 	    if (defined($Apache::lonhomework::parsing_a_problem)) {
                   3244: 		return $Apache::lonhomework::history{$qualifierrest};
                   3245: 	    } else {
1.359     albertel 3246: 		my %restored;
                   3247: 		if ($publicuser || $ENV{'request.state'} eq 'construct') {
                   3248: 		    %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
                   3249: 		} else {
                   3250: 		    %restored=&restore($symbparm,$courseid,$udom,$uname);
                   3251: 		}
1.335     albertel 3252: 		return $restored{$qualifierrest};
                   3253: 	    }
1.48      www      3254: # ----------------------------------------------------------------- user.access
                   3255:         } elsif ($space eq 'access') {
1.218     albertel 3256: 	    # FIXME - not supporting calls for a specific user
1.48      www      3257:             return &allowed($qualifier,$rest);
                   3258: # ------------------------------------------ user.preferences, user.environment
                   3259:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.218     albertel 3260: 	    if (($uname eq $ENV{'user.name'}) &&
                   3261: 		($udom eq $ENV{'user.domain'})) {
                   3262: 		return $ENV{join('.',('environment',$qualifierrest))};
                   3263: 	    } else {
1.359     albertel 3264: 		my %returnhash;
                   3265: 		if (!$publicuser) {
                   3266: 		    %returnhash=&userenvironment($udom,$uname,
                   3267: 						 $qualifierrest);
                   3268: 		}
1.218     albertel 3269: 		return $returnhash{$qualifierrest};
                   3270: 	    }
1.48      www      3271: # ----------------------------------------------------------------- user.course
                   3272:         } elsif ($space eq 'course') {
1.218     albertel 3273: 	    # FIXME - not supporting calls for a specific user
1.48      www      3274:             return $ENV{join('.',('request.course',$qualifier))};
                   3275: # ------------------------------------------------------------------- user.role
                   3276:         } elsif ($space eq 'role') {
1.218     albertel 3277: 	    # FIXME - not supporting calls for a specific user
1.48      www      3278:             my ($role,$where)=split(/\./,$ENV{'request.role'});
                   3279:             if ($qualifier eq 'value') {
                   3280: 		return $role;
                   3281:             } elsif ($qualifier eq 'extent') {
                   3282:                 return $where;
                   3283:             }
                   3284: # ----------------------------------------------------------------- user.domain
                   3285:         } elsif ($space eq 'domain') {
1.218     albertel 3286:             return $udom;
1.48      www      3287: # ------------------------------------------------------------------- user.name
                   3288:         } elsif ($space eq 'name') {
1.218     albertel 3289:             return $uname;
1.48      www      3290: # ---------------------------------------------------- Any other user namespace
1.29      www      3291:         } else {
1.359     albertel 3292: 	    my %reply;
                   3293: 	    if (!$publicuser) {
                   3294: 		%reply=&get($space,[$qualifierrest],$udom,$uname);
                   3295: 	    }
                   3296: 	    return $reply{$qualifierrest};
1.48      www      3297:         }
1.236     www      3298:     } elsif ($realm eq 'query') {
                   3299: # ---------------------------------------------- pull stuff out of query string
1.384     albertel 3300:         &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                   3301: 						[$spacequalifierrest]);
1.376     albertel 3302: 	return $ENV{'form.'.$spacequalifierrest}; 
1.236     www      3303:    } elsif ($realm eq 'request') {
1.48      www      3304: # ------------------------------------------------------------- request.browser
                   3305:         if ($space eq 'browser') {
                   3306: 	    return $ENV{'browser.'.$qualifier};
1.57      www      3307: # ------------------------------------------------------------ request.filename
                   3308:         } else {
                   3309:             return $ENV{'request.'.$spacequalifierrest};
1.29      www      3310:         }
1.28      www      3311:     } elsif ($realm eq 'course') {
1.48      www      3312: # ---------------------------------------------------------- course.description
1.218     albertel 3313:         return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
1.57      www      3314:     } elsif ($realm eq 'resource') {
1.165     www      3315: 
1.359     albertel 3316: 	if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) {
1.165     www      3317: 
1.218     albertel 3318: 	    #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165     www      3319: 
1.60      www      3320: # ----------------------------------------------------- Cascading lookup scheme
1.218     albertel 3321: 	    if (!$symbparm) { $symbparm=&symbread(); }
                   3322: 	    my $symbp=$symbparm;
                   3323: 	    my $mapp=(split(/\_\_\_/,$symbp))[0];
                   3324: 
                   3325: 	    my $symbparm=$symbp.'.'.$spacequalifierrest;
                   3326: 	    my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
                   3327: 
                   3328: 	    my $section;
                   3329: 	    if (($ENV{'user.name'} eq $uname) &&
                   3330: 		($ENV{'user.domain'} eq $udom)) {
1.255     albertel 3331: 		$section=$ENV{'request.course.sec'};
1.218     albertel 3332: 	    } else {
1.377     matthew  3333:                 if (! defined($usection)) {
                   3334:                     $section=&usection($udom,$uname,$courseid);
                   3335:                 } else {
                   3336:                     $section = $usection;
                   3337:                 }
1.218     albertel 3338: 	    }
                   3339: 
                   3340: 	    my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
                   3341: 	    my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
                   3342: 	    my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
                   3343: 
                   3344: 	    my $courselevel=$courseid.'.'.$spacequalifierrest;
                   3345: 	    my $courselevelr=$courseid.'.'.$symbparm;
                   3346: 	    my $courselevelm=$courseid.'.'.$mapparm;
1.69      www      3347: 
1.60      www      3348: # ----------------------------------------------------------- first, check user
1.379     matthew  3349: 	    #most student don\'t have any data set, check if there is some data
1.308     albertel 3350:             #every thirty minutes
1.379     matthew  3351: 	    if (! &EXT_cache_status($udom,$uname)) {
1.308     albertel 3352: 		my %resourcedata=&get('resourcedata',
                   3353: 				      [$courselevelr,$courselevelm,$courselevel],
                   3354: 				      $udom,$uname);
                   3355: 		my ($tmp)=keys(%resourcedata);
                   3356: 		if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
                   3357: 		    if ($resourcedata{$courselevelr}) {
                   3358: 			return $resourcedata{$courselevelr}; }
                   3359: 		    if ($resourcedata{$courselevelm}) {
                   3360: 			return $resourcedata{$courselevelm}; }
                   3361: 		    if ($resourcedata{$courselevel}) {
                   3362: 			return $resourcedata{$courselevel}; }
                   3363: 		} else {
                   3364: 		    if ($tmp!~/No such file/) {
                   3365: 			&logthis("<font color=blue>WARNING:".
                   3366: 				 " Trying to get resource data for ".
                   3367: 				 $uname." at ".$udom.": ".
                   3368: 				 $tmp."</font>");
                   3369: 		    } elsif ($tmp=~/error:No such file/) {
1.379     matthew  3370:                         &EXT_cache_set($udom,$uname);
1.308     albertel 3371: 		    } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
                   3372: 			return $tmp;
                   3373: 		    }
1.218     albertel 3374: 		}
                   3375: 	    }
1.95      www      3376: 
1.60      www      3377: # -------------------------------------------------------- second, check course
1.96      www      3378: 
1.218     albertel 3379: 	    my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
                   3380: 					  $ENV{'course.'.$courseid.'.domain'},
                   3381: 					  ($seclevelr,$seclevelm,$seclevel,
                   3382: 					   $courselevelr,$courselevelm,
                   3383: 					   $courselevel));
1.287     albertel 3384: 	    if (defined($coursereply)) { return $coursereply; }
1.200     www      3385: 
1.60      www      3386: # ------------------------------------------------------ third, check map parms
1.218     albertel 3387: 	    my %parmhash=();
                   3388: 	    my $thisparm='';
                   3389: 	    if (tie(%parmhash,'GDBM_File',
                   3390: 		    $ENV{'request.course.fn'}.'_parms.db',
1.256     albertel 3391: 		    &GDBM_READER(),0640)) {
1.218     albertel 3392: 		$thisparm=$parmhash{$symbparm};
                   3393: 		untie(%parmhash);
                   3394: 	    }
                   3395: 	    if ($thisparm) { return $thisparm; }
                   3396: 	}
1.60      www      3397: # --------------------------------------------- last, look in resource metadata
1.71      www      3398: 
1.218     albertel 3399: 	$spacequalifierrest=~s/\./\_/;
1.282     albertel 3400: 	my $filename;
                   3401: 	if (!$symbparm) { $symbparm=&symbread(); }
                   3402: 	if ($symbparm) {
                   3403: 	    $filename=(split(/\_\_\_/,$symbparm))[2];
                   3404: 	} else {
                   3405: 	    $filename=$ENV{'request.filename'};
                   3406: 	}
                   3407: 	my $metadata=&metadata($filename,$spacequalifierrest);
1.288     albertel 3408: 	if (defined($metadata)) { return $metadata; }
1.282     albertel 3409: 	$metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.288     albertel 3410: 	if (defined($metadata)) { return $metadata; }
1.142     www      3411: 
1.145     www      3412: # ------------------------------------------------------------------ Cascade up
1.218     albertel 3413: 	unless ($space eq '0') {
1.336     albertel 3414: 	    my @parts=split(/_/,$space);
                   3415: 	    my $id=pop(@parts);
                   3416: 	    my $part=join('_',@parts);
                   3417: 	    if ($part eq '') { $part='0'; }
                   3418: 	    my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
                   3419: 				 $symbparm,$udom,$uname);
1.337     albertel 3420: 	    if (defined($partgeneral)) { return $partgeneral; }
1.218     albertel 3421: 	}
1.71      www      3422: 
1.48      www      3423: # ---------------------------------------------------- Any other user namespace
                   3424:     } elsif ($realm eq 'environment') {
                   3425: # ----------------------------------------------------------------- environment
1.219     albertel 3426: 	if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
                   3427: 	    return $ENV{'environment.'.$spacequalifierrest};
                   3428: 	} else {
                   3429: 	    my %returnhash=&userenvironment($udom,$uname,
                   3430: 					    $spacequalifierrest);
                   3431: 	    return $returnhash{$spacequalifierrest};
                   3432: 	}
1.28      www      3433:     } elsif ($realm eq 'system') {
1.48      www      3434: # ----------------------------------------------------------------- system.time
                   3435: 	if ($space eq 'time') {
                   3436: 	    return time;
                   3437:         }
1.28      www      3438:     }
1.48      www      3439:     return '';
1.61      www      3440: }
                   3441: 
1.334     albertel 3442: sub add_prefix_and_part {
                   3443:     my ($prefix,$part)=@_;
                   3444:     my $keyroot;
                   3445:     if (defined($prefix) && $prefix !~ /^__/) {
                   3446: 	# prefix that has a part already
                   3447: 	$keyroot=$prefix;
                   3448:     } elsif (defined($prefix)) {
                   3449: 	# prefix that is missing a part
                   3450: 	if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
                   3451:     } else {
                   3452: 	# no prefix at all
                   3453: 	if (defined($part)) { $keyroot='_'.$part; }
                   3454:     }
                   3455:     return $keyroot;
                   3456: }
                   3457: 
1.71      www      3458: # ---------------------------------------------------------------- Get metadata
                   3459: 
                   3460: sub metadata {
1.176     www      3461:     my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.78      www      3462: 
1.71      www      3463:     $uri=&declutter($uri);
1.288     albertel 3464:     # if it is a non metadata possible uri return quickly
1.293     matthew  3465:     if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
                   3466:         ($uri =~ m|/$|) || ($uri =~ m|/.meta$|)) {
1.288     albertel 3467: 	return '';
                   3468:     }
1.73      www      3469:     my $filename=$uri;
                   3470:     $uri=~s/\.meta$//;
1.172     www      3471: #
                   3472: # Is the metadata already cached?
1.177     www      3473: # Look at timestamp of caching
1.172     www      3474: # Everything is cached by the main uri, libraries are never directly cached
                   3475: #
1.277     albertel 3476:     unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
1.172     www      3477: #
                   3478: # Is this a recursive call for a library?
                   3479: #
1.171     www      3480:         if ($liburi) {
                   3481: 	    $liburi=&declutter($liburi);
                   3482:             $filename=$liburi;
                   3483:         }
1.140     www      3484:         my %metathesekeys=();
1.73      www      3485:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.335     albertel 3486: 	my $metastring=&getfile(&filelocation('',&clutter($filename)));
1.208     albertel 3487:         my $parser=HTML::LCParser->new(\$metastring);
1.71      www      3488:         my $token;
1.140     www      3489:         undef %metathesekeys;
1.365     albertel 3490: 	delete($metacache{$uri.':packages'});
1.71      www      3491:         while ($token=$parser->get_token) {
1.339     albertel 3492: 	    if ($token->[0] eq 'S') {
                   3493: 		if (defined($token->[2]->{'package'})) {
1.172     www      3494: #
                   3495: # This is a package - get package info
                   3496: #
1.339     albertel 3497: 		    my $package=$token->[2]->{'package'};
                   3498: 		    my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   3499: 		    if (defined($token->[2]->{'id'})) { 
                   3500: 			$keyroot.='_'.$token->[2]->{'id'}; 
                   3501: 		    }
                   3502: 		    if ($metacache{$uri.':packages'}) {
                   3503: 			$metacache{$uri.':packages'}.=','.$package.$keyroot;
                   3504: 		    } else {
                   3505: 			$metacache{$uri.':packages'}=$package.$keyroot;
                   3506: 		    }
                   3507: 		    foreach (keys %packagetab) {
                   3508: 			if ($_=~/^$package\&/) {
                   3509: 			    my ($pack,$name,$subp)=split(/\&/,$_);
                   3510: 			    my $value=$packagetab{$_};
                   3511: 			    my $part=$keyroot;
                   3512: 			    $part=~s/^\_//;
                   3513: 			    if ($subp eq 'display') {
                   3514: 				$value.=' [Part: '.$part.']';
                   3515: 			    }
                   3516: 			    my $unikey='parameter'.$keyroot.'_'.$name;
1.356     albertel 3517: 			    if ($subp eq 'default') {
                   3518: 				$unikey='parameter_0_'.$name;
                   3519: 				$metacache{$uri.':'.$unikey.'.part'}='0';
                   3520: 			    } else {
                   3521: 				$metacache{$uri.':'.$unikey.'.part'}=$part;
                   3522: 				$metathesekeys{$unikey}=1;
                   3523: 			    }
1.339     albertel 3524: 			    unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
                   3525: 				$metacache{$uri.':'.$unikey.'.'.$subp}=$value;
                   3526: 			    }
                   3527: 			    if (defined($metacache{$uri.':'.$unikey.'.default'})) {
                   3528: 				$metacache{$uri.':'.$unikey}=
1.356     albertel 3529: 				    $metacache{$uri.':'.$unikey.'.default'};
                   3530: 			    }
1.339     albertel 3531: 			}
                   3532: 		    }
                   3533: 		} else {
1.172     www      3534: #
                   3535: # This is not a package - some other kind of start tag
1.339     albertel 3536: #
                   3537: 		    my $entry=$token->[1];
                   3538: 		    my $unikey;
                   3539: 		    if ($entry eq 'import') {
                   3540: 			$unikey='';
                   3541: 		    } else {
                   3542: 			$unikey=$entry;
                   3543: 		    }
                   3544: 		    $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
                   3545: 
                   3546: 		    if (defined($token->[2]->{'id'})) { 
                   3547: 			$unikey.='_'.$token->[2]->{'id'}; 
                   3548: 		    }
1.175     www      3549: 
1.339     albertel 3550: 		    if ($entry eq 'import') {
1.175     www      3551: #
                   3552: # Importing a library here
1.339     albertel 3553: #
                   3554: 			if ($depthcount<20) {
                   3555: 			    my $location=$parser->get_text('/import');
                   3556: 			    my $dir=$filename;
                   3557: 			    $dir=~s|[^/]*$||;
                   3558: 			    $location=&filelocation($dir,$location);
                   3559: 			    foreach (sort(split(/\,/,&metadata($uri,'keys',
                   3560: 							       $location,$unikey,
                   3561: 							       $depthcount+1)))) {
                   3562: 				$metathesekeys{$_}=1;
                   3563: 			    }
                   3564: 			}
                   3565: 		    } else { 
                   3566: 			
                   3567: 			if (defined($token->[2]->{'name'})) { 
                   3568: 			    $unikey.='_'.$token->[2]->{'name'}; 
                   3569: 			}
                   3570: 			$metathesekeys{$unikey}=1;
                   3571: 			foreach (@{$token->[3]}) {
                   3572: 			    $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
                   3573: 			}
                   3574: 			my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
                   3575: 			my $default=$metacache{$uri.':'.$unikey.'.default'};
                   3576: 			if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
                   3577: 		 # only ws inside the tag, and not in default, so use default
                   3578: 		 # as value
                   3579: 			    $metacache{$uri.':'.$unikey}=$default;
                   3580: 			} else {
1.321     albertel 3581: 		  # either something interesting inside the tag or default
                   3582:                   # uninteresting
1.339     albertel 3583: 			    $metacache{$uri.':'.$unikey}=$internaltext;
                   3584: 			}
1.172     www      3585: # end of not-a-package not-a-library import
1.339     albertel 3586: 		    }
1.172     www      3587: # end of not-a-package start tag
1.339     albertel 3588: 		}
1.172     www      3589: # the next is the end of "start tag"
1.339     albertel 3590: 	    }
                   3591: 	}
1.338     www      3592: # are there custom rights to evaluate
                   3593: 	if ($metacache{$uri.':copyright'} eq 'custom') {
1.339     albertel 3594: 
1.338     www      3595:     #
                   3596:     # Importing a rights file here
1.339     albertel 3597:     #
                   3598: 	    unless ($depthcount) {
                   3599: 		my $location=$metacache{$uri.':customdistributionfile'};
                   3600: 		my $dir=$filename;
                   3601: 		$dir=~s|[^/]*$||;
                   3602: 		$location=&filelocation($dir,$location);
                   3603: 		foreach (sort(split(/\,/,&metadata($uri,'keys',
                   3604: 						   $location,'_rights',
                   3605: 						   $depthcount+1)))) {
                   3606: 		    $metathesekeys{$_}=1;
                   3607: 		}
                   3608: 	    }
                   3609: 	}
                   3610: 	$metacache{$uri.':keys'}=join(',',keys %metathesekeys);
1.261     albertel 3611: 	&metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
1.339     albertel 3612: 	$metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
                   3613: 	$metacache{$uri.':cachedtimestamp'}=time;
1.177     www      3614: # this is the end of "was not already recently cached
1.71      www      3615:     }
                   3616:     return $metacache{$uri.':'.$what};
1.261     albertel 3617: }
                   3618: 
                   3619: sub metadata_generate_part0 {
                   3620:     my ($metadata,$metacache,$uri) = @_;
                   3621:     my %allnames;
                   3622:     foreach my $metakey (sort keys %$metadata) {
                   3623: 	if ($metakey=~/^parameter\_(.*)/) {
                   3624: 	  my $part=$$metacache{$uri.':'.$metakey.'.part'};
                   3625: 	  my $name=$$metacache{$uri.':'.$metakey.'.name'};
1.356     albertel 3626: 	  if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261     albertel 3627: 	    $allnames{$name}=$part;
                   3628: 	  }
                   3629: 	}
                   3630:     }
                   3631:     foreach my $name (keys(%allnames)) {
                   3632:       $$metadata{"parameter_0_$name"}=1;
                   3633:       my $key="$uri:parameter_0_$name";
                   3634:       $$metacache{"$key.part"}='0';
                   3635:       $$metacache{"$key.name"}=$name;
                   3636:       $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
                   3637: 					   $allnames{$name}.'_'.$name.
                   3638: 					   '.type'};
                   3639:       my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
                   3640: 			     '.display'};
                   3641:       my $expr='\\[Part: '.$allnames{$name}.'\\]';
                   3642:       $olddis=~s/$expr/\[Part: 0\]/;
                   3643:       $$metacache{"$key.display"}=$olddis;
                   3644:     }
1.71      www      3645: }
                   3646: 
1.301     www      3647: # ------------------------------------------------- Get the title of a resource
                   3648: 
                   3649: sub gettitle {
                   3650:     my $urlsymb=shift;
                   3651:     my $symb=&symbread($urlsymb);
                   3652:     unless ($symb) {
                   3653: 	unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
                   3654:         return &metadata($urlsymb,'title'); 
                   3655:     }
1.382     albertel 3656:     if ($titlecache{$symb}) {
                   3657: 	if (time < ($titlecache{$symb}[1] + 600)) {
                   3658: 	    return $titlecache{$symb}[0];
                   3659: 	} else {
                   3660: 	    delete($titlecache{$symb});
                   3661: 	}
                   3662:     }
1.301     www      3663:     my ($map,$resid,$url)=split(/\_\_\_/,$symb);
                   3664:     my $title='';
                   3665:     my %bighash;
                   3666:     if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
                   3667:                             &GDBM_READER(),0640)) {
                   3668:         my $mapid=$bighash{'map_pc_'.&clutter($map)};
                   3669:         $title=$bighash{'title_'.$mapid.'.'.$resid};
                   3670:         untie %bighash;
                   3671:     }
1.363     www      3672:     $title=~s/\&colon\;/\:/gs;
1.301     www      3673:     if ($title) {
1.382     albertel 3674:         $titlecache{$symb}=[$title,time];
1.301     www      3675:         return $title;
                   3676:     } else {
                   3677: 	return &metadata($urlsymb,'title');
                   3678:     }
                   3679: }
                   3680:     
1.31      www      3681: # ------------------------------------------------- Update symbolic store links
                   3682: 
                   3683: sub symblist {
                   3684:     my ($mapname,%newhash)=@_;
                   3685:     $mapname=declutter($mapname);
                   3686:     my %hash;
                   3687:     if (($ENV{'request.course.fn'}) && (%newhash)) {
                   3688:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.256     albertel 3689:                       &GDBM_WRCREAT(),0640)) {
1.191     harris41 3690: 	    foreach (keys %newhash) {
1.211     www      3691:                 $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
1.191     harris41 3692:             }
1.31      www      3693:             if (untie(%hash)) {
                   3694: 		return 'ok';
                   3695:             }
                   3696:         }
                   3697:     }
                   3698:     return 'error';
1.212     www      3699: }
                   3700: 
                   3701: # --------------------------------------------------------------- Verify a symb
                   3702: 
                   3703: sub symbverify {
                   3704:     my ($symb,$thisfn)=@_;
1.213     www      3705:     $thisfn=&declutter($thisfn);
1.215     www      3706: # direct jump to resource in page or to a sequence - will construct own symbs
                   3707:     if ($thisfn=~/\.(page|sequence)$/) { return 1; }
                   3708: # check URL part
1.213     www      3709:     my ($map,$resid,$url)=split(/\_\_\_/,$symb);
                   3710:     unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
                   3711: 
1.216     www      3712:     $symb=&symbclean($symb);
1.213     www      3713: 
                   3714:     my %bighash;
                   3715:     my $okay=0;
                   3716:     if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.256     albertel 3717:                             &GDBM_READER(),0640)) {
1.280     www      3718:         my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.216     www      3719:         unless ($ids) { 
                   3720:            $ids=$bighash{'ids_/'.$thisfn};
                   3721:         }
                   3722:         if ($ids) {
                   3723: # ------------------------------------------------------------------- Has ID(s)
                   3724: 	    foreach (split(/\,/,$ids)) {
                   3725:                my ($mapid,$resid)=split(/\./,$_);
                   3726:                if (
                   3727:   &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
                   3728:    eq $symb) { 
                   3729:                   $okay=1; 
                   3730:                }
                   3731: 	   }
                   3732:         }
1.213     www      3733: 	untie(%bighash);
                   3734:     }
                   3735:     return $okay;
1.31      www      3736: }
                   3737: 
1.210     www      3738: # --------------------------------------------------------------- Clean-up symb
                   3739: 
                   3740: sub symbclean {
                   3741:     my $symb=shift;
1.213     www      3742: 
1.210     www      3743: # remove version from map
                   3744:     $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215     www      3745: 
1.210     www      3746: # remove version from URL
                   3747:     $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213     www      3748: 
1.210     www      3749:     return $symb;
                   3750: }
                   3751: 
1.31      www      3752: # ------------------------------------------------------ Return symb list entry
                   3753: 
                   3754: sub symbread {
1.249     www      3755:     my ($thisfn,$donotrecurse)=@_;
1.242     www      3756: # no filename provided? try from environment
1.44      www      3757:     unless ($thisfn) {
1.210     www      3758:         if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
1.44      www      3759: 	$thisfn=$ENV{'request.filename'};
                   3760:     }
1.242     www      3761: # is that filename actually a symb? Verify, clean, and return
                   3762:     if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
                   3763: 	if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
                   3764:     }
1.44      www      3765:     $thisfn=declutter($thisfn);
1.31      www      3766:     my %hash;
1.37      www      3767:     my %bighash;
                   3768:     my $syval='';
1.45      www      3769:     if (($ENV{'request.course.fn'}) && ($thisfn)) {
1.31      www      3770:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1.256     albertel 3771:                       &GDBM_READER(),0640)) {
1.31      www      3772: 	    $syval=$hash{$thisfn};
1.37      www      3773:             untie(%hash);
                   3774:         }
                   3775: # ---------------------------------------------------------- There was an entry
                   3776:         if ($syval) {
                   3777:            unless ($syval=~/\_\d+$/) {
                   3778: 	       unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.44      www      3779:                   &appenv('request.ambiguous' => $thisfn);
1.37      www      3780:                   return '';
                   3781:                }    
                   3782:                $syval.=$1;
                   3783: 	   }
                   3784:         } else {
                   3785: # ------------------------------------------------------- Was not in symb table
                   3786:            if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1.256     albertel 3787:                             &GDBM_READER(),0640)) {
1.37      www      3788: # ---------------------------------------------- Get ID(s) for current resource
1.280     www      3789:               my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65      www      3790:               unless ($ids) { 
                   3791:                  $ids=$bighash{'ids_/'.$thisfn};
1.242     www      3792:               }
                   3793:               unless ($ids) {
                   3794: # alias?
                   3795: 		  $ids=$bighash{'mapalias_'.$thisfn};
1.65      www      3796:               }
1.37      www      3797:               if ($ids) {
                   3798: # ------------------------------------------------------------------- Has ID(s)
                   3799:                  my @possibilities=split(/\,/,$ids);
1.39      www      3800:                  if ($#possibilities==0) {
                   3801: # ----------------------------------------------- There is only one possibility
1.37      www      3802: 		     my ($mapid,$resid)=split(/\./,$ids);
                   3803:                      $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
1.249     www      3804:                  } elsif (!$donotrecurse) {
1.39      www      3805: # ------------------------------------------ There is more than one possibility
                   3806:                      my $realpossible=0;
1.191     harris41 3807:                      foreach (@possibilities) {
1.39      www      3808: 			 my $file=$bighash{'src_'.$_};
                   3809:                          if (&allowed('bre',$file)) {
                   3810:          		    my ($mapid,$resid)=split(/\./,$_);
                   3811:                             if ($bighash{'map_type_'.$mapid} ne 'page') {
                   3812: 				$realpossible++;
                   3813:                                 $syval=declutter($bighash{'map_id_'.$mapid}).
                   3814:                                        '___'.$resid;
                   3815:                             }
                   3816: 			 }
1.191     harris41 3817:                      }
1.39      www      3818: 		     if ($realpossible!=1) { $syval=''; }
1.249     www      3819:                  } else {
                   3820:                      $syval='';
1.37      www      3821:                  }
                   3822: 	      }
                   3823:               untie(%bighash)
                   3824:            } 
1.31      www      3825:         }
1.62      www      3826:         if ($syval) {
1.210     www      3827:            return &symbclean($syval.'___'.$thisfn); 
1.62      www      3828:         }
1.31      www      3829:     }
1.44      www      3830:     &appenv('request.ambiguous' => $thisfn);
1.31      www      3831:     return '';
                   3832: }
                   3833: 
                   3834: # ---------------------------------------------------------- Return random seed
                   3835: 
1.32      www      3836: sub numval {
                   3837:     my $txt=shift;
                   3838:     $txt=~tr/A-J/0-9/;
                   3839:     $txt=~tr/a-j/0-9/;
                   3840:     $txt=~tr/K-T/0-9/;
                   3841:     $txt=~tr/k-t/0-9/;
                   3842:     $txt=~tr/U-Z/0-5/;
                   3843:     $txt=~tr/u-z/0-5/;
                   3844:     $txt=~s/\D//g;
                   3845:     return int($txt);
1.368     albertel 3846: }
                   3847: 
                   3848: sub latest_rnd_algorithm_id {
                   3849:     return '64bit';
1.366     albertel 3850: }
1.32      www      3851: 
1.31      www      3852: sub rndseed {
1.155     albertel 3853:     my ($symb,$courseid,$domain,$username)=@_;
1.366     albertel 3854: 
                   3855:     my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
1.155     albertel 3856:     if (!$symb) {
1.366     albertel 3857: 	unless ($symb=$wsymb) { return time; }
                   3858:     }
                   3859:     if (!$courseid) { $courseid=$wcourseid; }
                   3860:     if (!$domain) { $domain=$wdomain; }
                   3861:     if (!$username) { $username=$wusername }
                   3862:     my $which=$ENV{"course.$courseid.rndseed"};
                   3863:     my $CODE=$ENV{'scantron.CODE'};
                   3864:     if (defined($CODE)) {
                   3865: 	&rndseed_CODE_64bit($symb,$courseid,$domain,$username);
                   3866:     } elsif ($which eq '64bit') {
                   3867: 	return &rndseed_64bit($symb,$courseid,$domain,$username);
                   3868:     }
                   3869:     return &rndseed_32bit($symb,$courseid,$domain,$username);
                   3870: }
                   3871: 
                   3872: sub rndseed_32bit {
                   3873:     my ($symb,$courseid,$domain,$username)=@_;
                   3874:     {
                   3875: 	use integer;
                   3876: 	my $symbchck=unpack("%32C*",$symb) << 27;
                   3877: 	my $symbseed=numval($symb) << 22;
                   3878: 	my $namechck=unpack("%32C*",$username) << 17;
                   3879: 	my $nameseed=numval($username) << 12;
                   3880: 	my $domainseed=unpack("%32C*",$domain) << 7;
                   3881: 	my $courseseed=unpack("%32C*",$courseid);
                   3882: 	my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
                   3883: 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   3884: 	#&Apache::lonxml::debug("rndseed :$num:$symb");
                   3885: 	return $num;
                   3886:     }
                   3887: }
                   3888: 
                   3889: sub rndseed_64bit {
                   3890:     my ($symb,$courseid,$domain,$username)=@_;
                   3891:     {
                   3892: 	use integer;
                   3893: 	my $symbchck=unpack("%32S*",$symb) << 21;
                   3894: 	my $symbseed=numval($symb) << 10;
                   3895: 	my $namechck=unpack("%32S*",$username);
                   3896: 	
                   3897: 	my $nameseed=numval($username) << 21;
                   3898: 	my $domainseed=unpack("%32S*",$domain) << 10;
                   3899: 	my $courseseed=unpack("%32S*",$courseid);
                   3900: 	
                   3901: 	my $num1=$symbchck+$symbseed+$namechck;
                   3902: 	my $num2=$nameseed+$domainseed+$courseseed;
                   3903: 	#&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
                   3904: 	#&Apache::lonxml::debug("rndseed :$num:$symb");
                   3905: 	return "$num1,$num2";
1.155     albertel 3906:     }
1.366     albertel 3907: }
                   3908: 
                   3909: sub rndseed_CODE_64bit {
                   3910:     my ($symb,$courseid,$domain,$username)=@_;
1.155     albertel 3911:     {
1.366     albertel 3912: 	use integer;
                   3913: 	my $symbchck=unpack("%32S*",$symb) << 16;
                   3914: 	my $symbseed=numval($symb);
                   3915: 	my $CODEseed=numval($ENV{'scantron.CODE'}) << 16;
                   3916: 	my $courseseed=unpack("%32S*",$courseid);
                   3917: 	my $num1=$symbseed+$CODEseed;
                   3918: 	my $num2=$courseseed+$symbchck;
                   3919: 	#&Apache::lonxml::debug("$symbseed:$CODEseed|$courseseed:$symbchck");
                   3920: 	#&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
                   3921: 	return "$num1,$num2";
                   3922:     }
                   3923: }
                   3924: 
                   3925: sub setup_random_from_rndseed {
                   3926:     my ($rndseed)=@_;
                   3927:     if ($rndseed =~/,/) {
                   3928: 	my ($num1,$num2)=split(/,/,$rndseed);
                   3929: 	&Math::Random::random_set_seed(abs($num1),abs($num2));
                   3930:     } else {
                   3931: 	&Math::Random::random_set_seed_from_phrase($rndseed);
1.98      albertel 3932:     }
1.36      albertel 3933: }
                   3934: 
1.76      www      3935: sub ireceipt {
                   3936:     my ($funame,$fudom,$fucourseid,$fusymb)=@_;
                   3937:     my $cuname=unpack("%32C*",$funame);
                   3938:     my $cudom=unpack("%32C*",$fudom);
                   3939:     my $cucourseid=unpack("%32C*",$fucourseid);
                   3940:     my $cusymb=unpack("%32C*",$fusymb);
1.77      www      3941:     my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
1.76      www      3942:     return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
                   3943:            ($cunique%$cuname+
                   3944:             $cunique%$cudom+
                   3945:             $cusymb%$cuname+
                   3946:             $cusymb%$cudom+
                   3947:             $cucourseid%$cuname+
                   3948:             $cucourseid%$cudom);
                   3949: }
                   3950: 
                   3951: sub receipt {
1.260     ng       3952:   my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
                   3953:   return &ireceipt($name,$domain,$courseid,$symb);
1.76      www      3954: }
1.260     ng       3955: 
1.36      albertel 3956: # ------------------------------------------------------------ Serves up a file
                   3957: # returns either the contents of the file or a -1
                   3958: sub getfile {
1.269     www      3959:  my $file=shift;
                   3960:  if ($file=~/^\/*uploaded\//) { # user file
                   3961:     my $ua=new LWP::UserAgent;
                   3962:     my $request=new HTTP::Request('GET',&tokenwrapper($file));
                   3963:     my $response=$ua->request($request);
                   3964:     if ($response->is_success()) {
                   3965:        return $response->content;
                   3966:     } else { 
                   3967:        return -1; 
                   3968:     }
                   3969:  } else { # normal file from res space
1.37      www      3970:   &repcopy($file);
1.36      albertel 3971:   if (! -e $file ) { return -1; };
                   3972:   my $fh=Apache::File->new($file);
                   3973:   my $a='';
                   3974:   while (<$fh>) { $a .=$_; }
1.269     www      3975:   return $a;
                   3976:  }
1.36      albertel 3977: }
                   3978: 
                   3979: sub filelocation {
                   3980:   my ($dir,$file) = @_;
                   3981:   my $location;
                   3982:   $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.59      albertel 3983:   if ($file=~m:^/~:) { # is a contruction space reference
                   3984:     $location = $file;
                   3985:     $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.270     www      3986:   } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
                   3987:     $location=$file;
1.36      albertel 3988:   } else {
1.59      albertel 3989:     $file=~s/^$perlvar{'lonDocRoot'}//;
                   3990:     $file=~s:^/*res::;
                   3991:     if ( !( $file =~ m:^/:) ) {
                   3992:       $location = $dir. '/'.$file;
                   3993:     } else {
                   3994:       $location = '/home/httpd/html/res'.$file;
                   3995:     }
1.36      albertel 3996:   }
                   3997:   $location=~s://+:/:g; # remove duplicate /
1.46      www      3998:   while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
                   3999:   return $location;
                   4000: }
1.36      albertel 4001: 
1.46      www      4002: sub hreflocation {
                   4003:     my ($dir,$file)=@_;
1.191     harris41 4004:     unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
1.46      www      4005:        my $finalpath=filelocation($dir,$file);
                   4006:        $finalpath=~s/^\/home\/httpd\/html//;
1.225     albertel 4007:        $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
1.46      www      4008:        return $finalpath;
                   4009:     } else {
                   4010:        return $file;
                   4011:     }
1.31      www      4012: }
                   4013: 
                   4014: # ------------------------------------------------------------- Declutters URLs
                   4015: 
                   4016: sub declutter {
                   4017:     my $thisfn=shift;
                   4018:     $thisfn=~s/^$perlvar{'lonDocRoot'}//;
                   4019:     $thisfn=~s/^\///;
                   4020:     $thisfn=~s/^res\///;
1.235     www      4021:     $thisfn=~s/\?.+$//;
1.268     www      4022:     return $thisfn;
                   4023: }
                   4024: 
                   4025: # ------------------------------------------------------------- Clutter up URLs
                   4026: 
                   4027: sub clutter {
                   4028:     my $thisfn='/'.&declutter(shift);
1.270     www      4029:     unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) { 
                   4030:        $thisfn='/res'.$thisfn; 
                   4031:     }
1.31      www      4032:     return $thisfn;
1.12      www      4033: }
                   4034: 
                   4035: # -------------------------------------------------------- Escape Special Chars
                   4036: 
                   4037: sub escape {
                   4038:     my $str=shift;
                   4039:     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
                   4040:     return $str;
                   4041: }
                   4042: 
                   4043: # ----------------------------------------------------- Un-Escape Special Chars
                   4044: 
                   4045: sub unescape {
                   4046:     my $str=shift;
                   4047:     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
                   4048:     return $str;
                   4049: }
1.11      www      4050: 
1.1       albertel 4051: # ================================================================ Main Program
                   4052: 
1.184     www      4053: sub goodbye {
1.204     albertel 4054:    &logthis("Starting Shut down");
1.184     www      4055:    &flushcourselogs();
                   4056:    &logthis("Shutting down");
1.362     albertel 4057:    return DONE;
1.184     www      4058: }
                   4059: 
1.179     www      4060: BEGIN {
1.228     harris41 4061: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
1.195     www      4062:     unless ($readit) {
1.217     harris41 4063: {
                   4064:     my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
                   4065: 
                   4066:     while (my $configline=<$config>) {
                   4067:         if ($configline =~ /^[^\#]*PerlSetVar/) {
1.1       albertel 4068: 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8       www      4069:            chomp($varvalue);
1.1       albertel 4070:            $perlvar{$varname}=$varvalue;
                   4071:         }
                   4072:     }
                   4073: }
1.227     harris41 4074: {
                   4075:     my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
                   4076: 
                   4077:     while (my $configline=<$config>) {
                   4078:         if ($configline =~ /^[^\#]*PerlSetVar/) {
                   4079: 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
                   4080:            chomp($varvalue);
                   4081:            $perlvar{$varname}=$varvalue;
                   4082:         }
                   4083:     }
                   4084: }
1.1       albertel 4085: 
1.327     albertel 4086: # ------------------------------------------------------------ Read domain file
                   4087: {
                   4088:     my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
                   4089:                             '/domain.tab');
                   4090:     %domaindescription = ();
                   4091:     %domain_auth_def = ();
                   4092:     %domain_auth_arg_def = ();
                   4093:     if ($fh) {
                   4094:        while (<$fh>) {
                   4095:            next if /^\#/;
                   4096:            chomp;
                   4097:            my ($domain, $domain_description, $def_auth, $def_auth_arg)
                   4098:                = split(/:/,$_,4);
                   4099:            $domain_auth_def{$domain}=$def_auth;
                   4100:            $domain_auth_arg_def{$domain}=$def_auth_arg;
                   4101:            $domaindescription{$domain}=$domain_description;
                   4102: #          &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
                   4103: #          &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
                   4104:        }
                   4105:     }
                   4106: }
                   4107: 
                   4108: 
1.1       albertel 4109: # ------------------------------------------------------------- Read hosts file
                   4110: {
                   4111:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
                   4112: 
                   4113:     while (my $configline=<$config>) {
1.303     matthew  4114:        next if ($configline =~ /^(\#|\s*$)/);
1.154     www      4115:        chomp($configline);
1.245     www      4116:        my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
1.252     albertel 4117:        if ($id && $domain && $role && $name && $ip) {
                   4118: 	 $hostname{$id}=$name;
                   4119: 	 $hostdom{$id}=$domain;
                   4120: 	 $hostip{$id}=$ip;
1.300     albertel 4121: 	 $iphost{$ip}=$id;
1.252     albertel 4122: 	 if ($role eq 'library') { $libserv{$id}=$name; }
                   4123:        } else {
                   4124: 	 if ($configline) {
                   4125: 	   &logthis("Skipping hosts.tab line -$configline-");
                   4126: 	 }
1.245     www      4127:        }
1.1       albertel 4128:     }
                   4129: }
                   4130: 
                   4131: # ------------------------------------------------------ Read spare server file
                   4132: {
                   4133:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
                   4134: 
                   4135:     while (my $configline=<$config>) {
                   4136:        chomp($configline);
1.284     matthew  4137:        if ($configline) {
1.1       albertel 4138:           $spareid{$configline}=1;
                   4139:        }
                   4140:     }
                   4141: }
1.11      www      4142: # ------------------------------------------------------------ Read permissions
                   4143: {
                   4144:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
                   4145: 
                   4146:     while (my $configline=<$config>) {
                   4147:        chomp($configline);
1.160     www      4148:       if ($configline) {
1.11      www      4149:        my ($role,$perm)=split(/ /,$configline);
                   4150:        if ($perm ne '') { $pr{$role}=$perm; }
1.160     www      4151:       }
1.11      www      4152:     }
                   4153: }
                   4154: 
                   4155: # -------------------------------------------- Read plain texts for permissions
                   4156: {
                   4157:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
                   4158: 
                   4159:     while (my $configline=<$config>) {
                   4160:        chomp($configline);
1.160     www      4161:       if ($configline) {
1.11      www      4162:        my ($short,$plain)=split(/:/,$configline);
                   4163:        if ($plain ne '') { $prp{$short}=$plain; }
1.160     www      4164:       }
1.135     www      4165:     }
                   4166: }
                   4167: 
                   4168: # ---------------------------------------------------------- Read package table
                   4169: {
                   4170:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
                   4171: 
                   4172:     while (my $configline=<$config>) {
                   4173:        chomp($configline);
                   4174:        my ($short,$plain)=split(/:/,$configline);
1.143     www      4175:        my ($pack,$name)=split(/\&/,$short);
                   4176:        if ($plain ne '') {
                   4177:           $packagetab{$pack.'&'.$name.'&name'}=$name; 
                   4178:           $packagetab{$short}=$plain; 
1.25      www      4179:        }
1.11      www      4180:     }
1.329     matthew  4181: }
                   4182: 
                   4183: # ------------- set up temporary directory
                   4184: {
                   4185:     $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
                   4186: 
1.11      www      4187: }
                   4188: 
1.71      www      4189: %metacache=();
1.185     www      4190: 
1.281     www      4191: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186     www      4192: $dumpcount=0;
1.22      www      4193: 
1.163     harris41 4194: &logtouch();
1.12      www      4195: &logthis('<font color=yellow>INFO: Read configuration</font>');
1.195     www      4196: $readit=1;
                   4197: }
1.1       albertel 4198: }
1.179     www      4199: 
1.1       albertel 4200: 1;
1.191     harris41 4201: __END__
                   4202: 
1.243     albertel 4203: =pod
                   4204: 
1.191     harris41 4205: =head1 NAME
                   4206: 
1.243     albertel 4207: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191     harris41 4208: 
                   4209: =head1 SYNOPSIS
                   4210: 
1.243     albertel 4211: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191     harris41 4212: 
                   4213:  &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
                   4214: 
1.243     albertel 4215: Common parameters:
                   4216: 
                   4217: =over 4
                   4218: 
                   4219: =item *
                   4220: 
                   4221: $uname : an internal username (if $cname expecting a course Id specifically)
                   4222: 
                   4223: =item *
                   4224: 
                   4225: $udom : a domain (if $cdom expecting a course's domain specifically)
                   4226: 
                   4227: =item *
                   4228: 
                   4229: $symb : a resource instance identifier
                   4230: 
                   4231: =item *
                   4232: 
                   4233: $namespace : the name of a .db file that contains the data needed or
                   4234: being set.
                   4235: 
                   4236: =back
                   4237: 
1.191     harris41 4238: =head1 INTRODUCTION
                   4239: 
                   4240: This module provides subroutines which interact with the
1.243     albertel 4241: lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about 
                   4242: - classes
                   4243: - users 
                   4244: - resources
                   4245: 
                   4246: For many of these objects you can also use this to store data about
                   4247: them or modify them in various ways.
1.191     harris41 4248: 
                   4249: This is part of the LearningOnline Network with CAPA project
                   4250: described at http://www.lon-capa.org.
                   4251: 
1.243     albertel 4252: =head1 RETURN MESSAGES
1.191     harris41 4253: 
                   4254: =over 4
                   4255: 
                   4256: =item *
                   4257: 
1.243     albertel 4258: con_lost : unable to contact remote host
1.191     harris41 4259: 
                   4260: =item *
                   4261: 
1.243     albertel 4262: con_delayed : unable to contact remote host, message will be delivered
                   4263: when the connection is brought back up
1.191     harris41 4264: 
                   4265: =item *
                   4266: 
1.243     albertel 4267: con_failed : unable to contact remote host and unable to save message
                   4268: for later delivery
1.191     harris41 4269: 
                   4270: =item *
                   4271: 
1.243     albertel 4272: error: : an error a occured, a description of the error follows the :
1.191     harris41 4273: 
                   4274: =item *
                   4275: 
1.243     albertel 4276: no_such_host : unable to fund a host associated with the user/domain
                   4277: that was requested
1.191     harris41 4278: 
1.243     albertel 4279: =back
1.191     harris41 4280: 
1.243     albertel 4281: =head1 PUBLIC SUBROUTINES
1.191     harris41 4282: 
1.243     albertel 4283: =head2 Session Environment Functions
1.191     harris41 4284: 
1.243     albertel 4285: =over 4
1.191     harris41 4286: 
                   4287: =item *
                   4288: 
1.243     albertel 4289: appenv(%hash) : the value of %hash is written to the user envirnoment
                   4290: file, and will be restored for each access this user makes during this
                   4291: session, also modifies the %ENV for the current process
1.191     harris41 4292: 
                   4293: =item *
                   4294: 
1.243     albertel 4295: delenv($regexp) : removes all items from the session environment file that matches the regular expression in $regexp. The values are also delted from the current processes %ENV.
1.191     harris41 4296: 
1.243     albertel 4297: =back
                   4298: 
                   4299: =head2 User Information
1.191     harris41 4300: 
1.243     albertel 4301: =over 4
1.191     harris41 4302: 
                   4303: =item *
                   4304: 
                   4305: queryauthenticate($uname,$udom) : try to determine user's current
                   4306: authentication scheme
                   4307: 
                   4308: =item *
                   4309: 
                   4310: authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
1.243     albertel 4311: servers (first use the current one), $upass should be the users password
1.191     harris41 4312: 
                   4313: =item *
                   4314: 
1.243     albertel 4315: homeserver($uname,$udom) : find the server which has the user's
                   4316: directory and files (there must be only one), this caches the answer,
                   4317: and also caches if there is a borken connection.
1.191     harris41 4318: 
                   4319: =item *
                   4320: 
1.243     albertel 4321: idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
                   4322: unique resource in a domain, there must be only 1 ID per username, and
                   4323: only 1 username per ID in a specific domain) (returns hash:
1.191     harris41 4324: id=>name,id=>name)
                   4325: 
                   4326: =item *
                   4327: 
                   4328: idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
                   4329: name=>id,name=>id)
                   4330: 
                   4331: =item *
                   4332: 
                   4333: idput($udom,%ids) : store away a list of names and associated IDs
                   4334: 
                   4335: =item *
                   4336: 
1.243     albertel 4337: rolesinit($udom,$username,$authhost) : get user privileges
                   4338: 
                   4339: =item *
                   4340: 
                   4341: usection($udom,$uname,$cname) : finds the section of student in the
                   4342: course $cname, return section name/number or '' for "not in course"
                   4343: and '-1' for "no section"
                   4344: 
                   4345: =item *
                   4346: 
                   4347: userenvironment($udom,$uname,@what) : gets the values of the keys
                   4348: passed in @what from the requested user's environment, returns a hash
                   4349: 
                   4350: =back
                   4351: 
                   4352: =head2 User Roles
                   4353: 
                   4354: =over 4
                   4355: 
                   4356: =item *
                   4357: 
                   4358: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
                   4359: actions
                   4360:  F: full access
                   4361:  U,I,K: authentication modes (cxx only)
                   4362:  '': forbidden
                   4363:  1: user needs to choose course
                   4364:  2: browse allowed
                   4365: 
                   4366: =item *
                   4367: 
                   4368: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
                   4369: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
                   4370: and course level
                   4371: 
                   4372: =item *
                   4373: 
                   4374: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
                   4375: explanation of a user role term
                   4376: 
                   4377: =back
                   4378: 
                   4379: =head2 User Modification
                   4380: 
                   4381: =over 4
                   4382: 
                   4383: =item *
                   4384: 
                   4385: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
                   4386: user for the level given by URL.  Optional start and end dates (leave empty
                   4387: string or zero for "no date")
1.191     harris41 4388: 
                   4389: =item *
                   4390: 
1.243     albertel 4391: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
                   4392: change a users, password, possible return values are: ok,
                   4393: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
                   4394: refused
1.191     harris41 4395: 
                   4396: =item *
                   4397: 
1.243     albertel 4398: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191     harris41 4399: 
                   4400: =item *
                   4401: 
1.243     albertel 4402: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) : 
                   4403: modify user
1.191     harris41 4404: 
                   4405: =item *
                   4406: 
1.286     matthew  4407: modifystudent
                   4408: 
                   4409: modify a students enrollment and identification information.
                   4410: The course id is resolved based on the current users environment.  
                   4411: This means the envoking user must be a course coordinator or otherwise
                   4412: associated with a course.
                   4413: 
1.297     matthew  4414: This call is essentially a wrapper for lonnet::modifyuser and
                   4415: lonnet::modify_student_enrollment
1.286     matthew  4416: 
                   4417: Inputs: 
                   4418: 
                   4419: =over 4
                   4420: 
                   4421: =item B<$udom> Students loncapa domain
                   4422: 
                   4423: =item B<$uname> Students loncapa login name
                   4424: 
                   4425: =item B<$uid> Students id/student number
                   4426: 
                   4427: =item B<$umode> Students authentication mode
                   4428: 
                   4429: =item B<$upass> Students password
                   4430: 
                   4431: =item B<$first> Students first name
                   4432: 
                   4433: =item B<$middle> Students middle name
                   4434: 
                   4435: =item B<$last> Students last name
                   4436: 
                   4437: =item B<$gene> Students generation
                   4438: 
                   4439: =item B<$usec> Students section in course
                   4440: 
                   4441: =item B<$end> Unix time of the roles expiration
                   4442: 
                   4443: =item B<$start> Unix time of the roles start date
                   4444: 
                   4445: =item B<$forceid> If defined, allow $uid to be changed
                   4446: 
                   4447: =item B<$desiredhome> server to use as home server for student
                   4448: 
                   4449: =back
1.297     matthew  4450: 
                   4451: =item *
                   4452: 
                   4453: modify_student_enrollment
                   4454: 
                   4455: Change a students enrollment status in a class.  The environment variable
                   4456: 'role.request.course' must be defined for this function to proceed.
                   4457: 
                   4458: Inputs:
                   4459: 
                   4460: =over 4
                   4461: 
                   4462: =item $udom, students domain
                   4463: 
                   4464: =item $uname, students name
                   4465: 
                   4466: =item $uid, students user id
                   4467: 
                   4468: =item $first, students first name
                   4469: 
                   4470: =item $middle
                   4471: 
                   4472: =item $last
                   4473: 
                   4474: =item $gene
                   4475: 
                   4476: =item $usec
                   4477: 
                   4478: =item $end
                   4479: 
                   4480: =item $start
                   4481: 
                   4482: =back
                   4483: 
1.191     harris41 4484: 
                   4485: =item *
                   4486: 
1.243     albertel 4487: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
                   4488: custom role; give a custom role to a user for the level given by URL.  Specify
                   4489: name and domain of role author, and role name
1.191     harris41 4490: 
                   4491: =item *
                   4492: 
1.243     albertel 4493: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191     harris41 4494: 
                   4495: =item *
                   4496: 
1.243     albertel 4497: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
                   4498: 
                   4499: =back
                   4500: 
                   4501: =head2 Course Infomation
                   4502: 
                   4503: =over 4
1.191     harris41 4504: 
                   4505: =item *
                   4506: 
1.243     albertel 4507: coursedescription($courseid) : course description
1.191     harris41 4508: 
                   4509: =item *
                   4510: 
1.243     albertel 4511: courseresdata($coursenum,$coursedomain,@which) : request for current
                   4512: parameter setting for a specific course, @what should be a list of
                   4513: parameters to ask about. This routine caches answers for 5 minutes.
                   4514: 
                   4515: =back
                   4516: 
                   4517: =head2 Course Modification
                   4518: 
                   4519: =over 4
1.191     harris41 4520: 
                   4521: =item *
                   4522: 
1.243     albertel 4523: writecoursepref($courseid,%prefs) : write preferences (environment
                   4524: database) for a course
1.191     harris41 4525: 
                   4526: =item *
                   4527: 
1.243     albertel 4528: createcourse($udom,$description,$url) : make/modify course
                   4529: 
                   4530: =back
                   4531: 
                   4532: =head2 Resource Subroutines
                   4533: 
                   4534: =over 4
1.191     harris41 4535: 
                   4536: =item *
                   4537: 
1.243     albertel 4538: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191     harris41 4539: 
                   4540: =item *
                   4541: 
1.243     albertel 4542: repcopy($filename) : subscribes to the requested file, and attempts to
                   4543: replicate from the owning library server, Might return
                   4544: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
                   4545: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
                   4546: resource. Expects the local filesystem pathname
                   4547: (/home/httpd/html/res/....)
                   4548: 
                   4549: =back
                   4550: 
                   4551: =head2 Resource Information
                   4552: 
                   4553: =over 4
1.191     harris41 4554: 
                   4555: =item *
                   4556: 
1.243     albertel 4557: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
                   4558: a vairety of different possible values, $varname should be a request
                   4559: string, and the other parameters can be used to specify who and what
                   4560: one is asking about.
                   4561: 
                   4562: Possible values for $varname are environment.lastname (or other item
                   4563: from the envirnment hash), user.name (or someother aspect about the
                   4564: user), resource.0.maxtries (or some other part and parameter of a
                   4565: resource)
1.204     albertel 4566: 
                   4567: =item *
                   4568: 
1.243     albertel 4569: directcondval($number) : get current value of a condition; reads from a state
                   4570: string
1.204     albertel 4571: 
                   4572: =item *
                   4573: 
1.243     albertel 4574: condval($condidx) : value of condition index based on state
1.204     albertel 4575: 
                   4576: =item *
                   4577: 
1.243     albertel 4578: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
                   4579: resource's metadata, $what should be either a specific key, or either
                   4580: 'keys' (to get a list of possible keys) or 'packages' to get a list of
                   4581: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
                   4582: 
                   4583: this function automatically caches all requests
1.191     harris41 4584: 
                   4585: =item *
                   4586: 
1.243     albertel 4587: metadata_query($query,$custom,$customshow) : make a metadata query against the
                   4588: network of library servers; returns file handle of where SQL and regex results
                   4589: will be stored for query
1.191     harris41 4590: 
                   4591: =item *
                   4592: 
1.243     albertel 4593: symbread($filename) : return symbolic list entry (filename argument optional);
                   4594: returns the data handle
1.191     harris41 4595: 
                   4596: =item *
                   4597: 
1.243     albertel 4598: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
                   4599: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
                   4600: failure, user must be in a course, as it assumes the existance of the
                   4601: course initi hash, and uses $ENV('request.course.id'}
                   4602: 
1.191     harris41 4603: 
                   4604: =item *
                   4605: 
1.243     albertel 4606: symbclean($symb) : removes versions numbers from a symb, returns the
                   4607: cleaned symb
1.191     harris41 4608: 
                   4609: =item *
                   4610: 
1.243     albertel 4611: is_on_map($uri) : checks if the $uri is somewhere on the current
                   4612: course map, user must be in a course for it to work.
1.191     harris41 4613: 
                   4614: =item *
                   4615: 
1.243     albertel 4616: numval($salt) : return random seed value (addend for rndseed)
1.191     harris41 4617: 
                   4618: =item *
                   4619: 
1.243     albertel 4620: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
                   4621: a random seed, all arguments are optional, if they aren't sent it uses the
                   4622: environment to derive them. Note: if symb isn't sent and it can't get one
                   4623: from &symbread it will use the current time as its return value
1.191     harris41 4624: 
                   4625: =item *
                   4626: 
1.243     albertel 4627: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
                   4628: unfakeable, receipt
1.191     harris41 4629: 
                   4630: =item *
                   4631: 
1.243     albertel 4632: receipt() : API to ireceipt working off of ENV values; given out to users
1.191     harris41 4633: 
                   4634: =item *
                   4635: 
1.243     albertel 4636: countacc($url) : count the number of accesses to a given URL
1.191     harris41 4637: 
                   4638: =item *
                   4639: 
1.243     albertel 4640: 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 4641: 
                   4642: =item *
                   4643: 
1.243     albertel 4644: 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 4645: 
                   4646: =item *
                   4647: 
1.243     albertel 4648: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191     harris41 4649: 
                   4650: =item *
                   4651: 
1.243     albertel 4652: devalidate($symb) : devalidate temporary spreadsheet calculations,
                   4653: forcing spreadsheet to reevaluate the resource scores next time.
                   4654: 
                   4655: =back
                   4656: 
                   4657: =head2 Storing/Retreiving Data
                   4658: 
                   4659: =over 4
1.191     harris41 4660: 
                   4661: =item *
                   4662: 
1.243     albertel 4663: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
                   4664: for this url; hashref needs to be given and should be a \%hashname; the
                   4665: remaining args aren't required and if they aren't passed or are '' they will
                   4666: be derived from the ENV
1.191     harris41 4667: 
                   4668: =item *
                   4669: 
1.243     albertel 4670: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
                   4671: uses critical subroutine
1.191     harris41 4672: 
                   4673: =item *
                   4674: 
1.243     albertel 4675: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
                   4676: all args are optional
1.191     harris41 4677: 
                   4678: =item *
                   4679: 
1.243     albertel 4680: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
                   4681: works very similar to store/cstore, but all data is stored in a
                   4682: temporary location and can be reset using tmpreset, $storehash should
                   4683: be a hash reference, returns nothing on success
1.191     harris41 4684: 
                   4685: =item *
                   4686: 
1.243     albertel 4687: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
                   4688: similar to restore, but all data is stored in a temporary location and
                   4689: can be reset using tmpreset. Returns a hash of values on success,
                   4690: error string otherwise.
1.191     harris41 4691: 
                   4692: =item *
                   4693: 
1.243     albertel 4694: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
                   4695: deltes all keys for $symb form the temporary storage hash.
1.191     harris41 4696: 
                   4697: =item *
                   4698: 
1.243     albertel 4699: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   4700: reference filled in from namesp ($udom and $uname are optional)
1.191     harris41 4701: 
                   4702: =item *
                   4703: 
1.243     albertel 4704: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
                   4705: namesp ($udom and $uname are optional)
1.191     harris41 4706: 
                   4707: =item *
                   4708: 
1.243     albertel 4709: dump($namespace,$udom,$uname,$regexp) : 
                   4710: dumps the complete (or key matching regexp) namespace into a hash
                   4711: ($udom, $uname and $regexp are optional)
1.191     harris41 4712: 
                   4713: =item *
                   4714: 
1.243     albertel 4715: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
                   4716: ($udom and $uname are optional)
1.191     harris41 4717: 
                   4718: =item *
                   4719: 
1.243     albertel 4720: cput($namespace,$storehash,$udom,$uname) : critical put
                   4721: ($udom and $uname are optional)
1.191     harris41 4722: 
                   4723: =item *
                   4724: 
1.243     albertel 4725: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
                   4726: reference filled in from namesp (encrypts the return communication)
                   4727: ($udom and $uname are optional)
1.191     harris41 4728: 
                   4729: =item *
                   4730: 
1.243     albertel 4731: log($udom,$name,$home,$message) : write to permanent log for user; use
                   4732: critical subroutine
                   4733: 
                   4734: =back
                   4735: 
                   4736: =head2 Network Status Functions
                   4737: 
                   4738: =over 4
1.191     harris41 4739: 
                   4740: =item *
                   4741: 
                   4742: dirlist($uri) : return directory list based on URI
                   4743: 
                   4744: =item *
                   4745: 
1.243     albertel 4746: spareserver() : find server with least workload from spare.tab
                   4747: 
                   4748: =back
                   4749: 
                   4750: =head2 Apache Request
                   4751: 
                   4752: =over 4
1.191     harris41 4753: 
                   4754: =item *
                   4755: 
1.243     albertel 4756: ssi($url,%hash) : server side include, does a complete request cycle on url to
                   4757: localhost, posts hash
                   4758: 
                   4759: =back
                   4760: 
                   4761: =head2 Data to String to Data
                   4762: 
                   4763: =over 4
1.191     harris41 4764: 
                   4765: =item *
                   4766: 
1.243     albertel 4767: hash2str(%hash) : convert a hash into a string complete with escaping and '='
                   4768: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191     harris41 4769: 
                   4770: =item *
                   4771: 
1.243     albertel 4772: hashref2str($hashref) : convert a hashref into a string complete with
                   4773: escaping and '=' and '&' separators, supports elements that are
                   4774: arrayrefs and hashrefs
1.191     harris41 4775: 
                   4776: =item *
                   4777: 
1.243     albertel 4778: arrayref2str($arrayref) : convert an arrayref into a string complete
                   4779: with escaping and '&' separators, supports elements that are arrayrefs
                   4780: and hashrefs
1.191     harris41 4781: 
                   4782: =item *
                   4783: 
1.243     albertel 4784: str2hash($string) : convert string to hash using unescaping and
                   4785: splitting on '=' and '&', supports elements that are arrayrefs and
                   4786: hashrefs
1.191     harris41 4787: 
                   4788: =item *
                   4789: 
1.243     albertel 4790: str2array($string) : convert string to hash using unescaping and
                   4791: splitting on '&', supports elements that are arrayrefs and hashrefs
                   4792: 
                   4793: =back
                   4794: 
                   4795: =head2 Logging Routines
                   4796: 
                   4797: =over 4
                   4798: 
                   4799: These routines allow one to make log messages in the lonnet.log and
                   4800: lonnet.perm logfiles.
1.191     harris41 4801: 
                   4802: =item *
                   4803: 
1.243     albertel 4804: logtouch() : make sure the logfile, lonnet.log, exists
1.191     harris41 4805: 
                   4806: =item *
                   4807: 
1.243     albertel 4808: logthis() : append message to the normal lonnet.log file, it gets
                   4809: preiodically rolled over and deleted.
1.191     harris41 4810: 
                   4811: =item *
                   4812: 
1.243     albertel 4813: logperm() : append a permanent message to lonnet.perm.log, this log
                   4814: file never gets deleted by any automated portion of the system, only
                   4815: messages of critical importance should go in here.
                   4816: 
                   4817: =back
                   4818: 
                   4819: =head2 General File Helper Routines
                   4820: 
                   4821: =over 4
1.191     harris41 4822: 
                   4823: =item *
                   4824: 
1.243     albertel 4825: getfile($file) : returns the entire contents of a file or -1; it
                   4826: properly subscribes to and replicates the file if neccessary.
1.191     harris41 4827: 
                   4828: =item *
                   4829: 
1.243     albertel 4830: filelocation($dir,$file) : returns file system location of a file
                   4831: based on URI; meant to be "fairly clean" absolute reference, $dir is a
                   4832: directory that relative $file lookups are to looked in ($dir of /a/dir
                   4833: and a file of ../bob will become /a/bob)
1.191     harris41 4834: 
                   4835: =item *
                   4836: 
                   4837: hreflocation($dir,$file) : returns file system location or a URL; same as
                   4838: filelocation except for hrefs
                   4839: 
                   4840: =item *
                   4841: 
                   4842: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
                   4843: 
1.243     albertel 4844: =back
                   4845: 
                   4846: =head2 HTTP Helper Routines
                   4847: 
                   4848: =over 4
                   4849: 
1.191     harris41 4850: =item *
                   4851: 
                   4852: escape() : unpack non-word characters into CGI-compatible hex codes
                   4853: 
                   4854: =item *
                   4855: 
                   4856: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
                   4857: 
1.243     albertel 4858: =back
                   4859: 
                   4860: =head1 PRIVATE SUBROUTINES
                   4861: 
                   4862: =head2 Underlying communication routines (Shouldn't call)
                   4863: 
                   4864: =over 4
                   4865: 
                   4866: =item *
                   4867: 
                   4868: subreply() : tries to pass a message to lonc, returns con_lost if incapable
                   4869: 
                   4870: =item *
                   4871: 
                   4872: reply() : uses subreply to send a message to remote machine, logs all failures
                   4873: 
                   4874: =item *
                   4875: 
                   4876: critical() : passes a critical message to another server; if cannot
                   4877: get through then place message in connection buffer directory and
                   4878: returns con_delayed, if incapable of saving message, returns
                   4879: con_failed
                   4880: 
                   4881: =item *
                   4882: 
                   4883: reconlonc() : tries to reconnect lonc client processes.
                   4884: 
                   4885: =back
                   4886: 
                   4887: =head2 Resource Access Logging
                   4888: 
                   4889: =over 4
                   4890: 
                   4891: =item *
                   4892: 
                   4893: flushcourselogs() : flush (save) buffer logs and access logs
                   4894: 
                   4895: =item *
                   4896: 
                   4897: courselog($what) : save message for course in hash
                   4898: 
                   4899: =item *
                   4900: 
                   4901: courseacclog($what) : save message for course using &courselog().  Perform
                   4902: special processing for specific resource types (problems, exams, quizzes, etc).
                   4903: 
1.191     harris41 4904: =item *
                   4905: 
                   4906: goodbye() : flush course logs and log shutting down; it is called in srm.conf
                   4907: as a PerlChildExitHandler
1.243     albertel 4908: 
                   4909: =back
                   4910: 
                   4911: =head2 Other
                   4912: 
                   4913: =over 4
                   4914: 
                   4915: =item *
                   4916: 
                   4917: symblist($mapname,%newhash) : update symbolic storage links
1.191     harris41 4918: 
                   4919: =back
                   4920: 
                   4921: =cut

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