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

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

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