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

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

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