File:  [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.164: download - view: text, annotated - select for diffs
Tue Oct 16 08:53:19 2001 UTC (22 years, 9 months ago) by www
Branches: MAIN
CVS tags: HEAD
part.id instead of part_id (hopefully)

    1: # The LearningOnline Network
    2: # TCP networking package
    3: #
    4: # Functions for use by content handlers:
    5: #
    6: # metadata_query(sql-query-string,custom-metadata-regex) : 
    7: #                                    returns file handle of where sql and
    8: #                                    regex results will be stored for query
    9: # plaintext(short)   : plain text explanation of short term
   10: # fileembstyle(ext)  : embed style in page for file extension
   11: # filedescription(ext) : descriptor text for file extension
   12: # allowed(short,url) : returns codes for allowed actions 
   13: #                      F: full access
   14: #                      U,I,K: authentication modes (cxx only)
   15: #                      '': forbidden
   16: #                      1: user needs to choose course
   17: #                      2: browse allowed
   18: # definerole(rolename,sys,dom,cou) : define a custom role rolename
   19: #                      set privileges in format of lonTabs/roles.tab for
   20: #                      system, domain and course level, 
   21: # assignrole(udom,uname,url,role,end,start) : give a role to a user for the
   22: #                      level given by url. Optional start and end dates
   23: #                      (leave empty string or zero for "no date") 
   24: # assigncustomrole (udom,uname,url,rdom,rnam,rolename,end,start) : give a
   25: #                      custom role to a user for the level given by url.
   26: #                      Specify name and domain of role author, and role name
   27: # revokerole (udom,uname,url,role) : Revoke a role for url
   28: # revokecustomrole (udom,uname,url,rdom,rnam,rolename) : Revoke a custom role
   29: # appenv(hash)       : adds hash to session environment
   30: # delenv(varname)    : deletes all environment entries starting with varname
   31: # store(hashref,symb,courseid,udom,uname)
   32: #                    : stores hash permanently for this url
   33: #                      hashref needs to be given, and should be a \%hashname
   34: #                      the remaining args aren't required and if they aren't
   35: #                      passed or are '' they will be derived from the ENV
   36: # cstore(hashref,symb,courseid,udom,uname)
   37: #                    : same as store but uses the critical interface to 
   38: #                      guarentee a store
   39: # restore(symb,courseid,udom,uname)
   40: #                    : returns hash for this symb, all args are optional
   41: #                      if they aren't given they will be derived from the 
   42: #                      current enviroment
   43: #
   44: #
   45: # for the next 6 functions udom and uname are optional
   46: #         if supplied they use udom as the domain and uname
   47: #         as the username for the function (supply a courseid
   48: #         for the uname if you want a course database)
   49: #         if not supplied it uses %ENV and looks at 
   50: #         user. attribute for the values
   51: #
   52: # eget(namesp,arrayref,udom,uname)
   53: #                    : returns hash with keys from array  reference filled
   54: #                      in from namesp (encrypts the return communication)
   55: # get(namesp,arrayref,udom,uname)
   56: #                    : returns hash with keys from array  reference filled
   57: #                      in from namesp
   58: # dump(namesp,udom,uname) : dumps the complete namespace into a hash
   59: # del(namesp,array,udom,uname)  : deletes keys out of array from namesp
   60: # put(namesp,hash,udom,uname)   : stores hash in namesp
   61: # cput(namesp,hash,udom,uname)  : critical put
   62: #
   63: #
   64: # ssi(url,hash)      : does a complete request cycle on url to localhost, posts
   65: #                      hash
   66: # coursedescription(id) : returns and caches course description for id
   67: # repcopy(filename)  : replicate file
   68: # dirlist(url)       : gets a directory listing
   69: # directcondval(index) : reading condition value of single condition from 
   70: #                        state string
   71: # condval(index)     : value of condition index based on state
   72: # EXT(name)          : value of a variable
   73: # symblist(map,hash) : Updates symbolic storage links
   74: # symbread([filename]) : returns the data handle (filename optional)
   75: # rndseed([symb,courseid,domain,uname])
   76: #                    : returns a random seed, all arguments are optional,
   77: #                      if they aren't sent it use the environment to derive
   78: #                      them
   79: #                      Note: if symb isn't sent and it can't get one from
   80: #                      &symbread it will use the current time as it's return
   81: # receipt()          : returns a receipt to be given out to users 
   82: # getfile(filename)  : returns the contents of filename, or a -1 if it can't
   83: #                      be found, replicates and subscribes to the file
   84: # filelocation(dir,file) : returns a fairly clean absolute reference to file 
   85: #                          from the directory dir
   86: # hreflocation(dir,file) : same as filelocation, but for hrefs
   87: # log(domain,user,home,msg) : write to permanent log for user
   88: # usection(domain,user,courseid) : output of section name/number or '' for
   89: #                                  "not in course" and '-1' for "no section"
   90: # userenvironment(domain,user,what) : puts out any environment parameter 
   91: #                                     for a user
   92: # idput(domain,hash) : writes IDs for users from hash (name=>id,name=>id)
   93: # idget(domain,array): returns hash with usernames (id=>name,id=>name) for
   94: #                      an array of IDs
   95: # idrget(domain,array): returns hash with IDs for usernames (name=>id,...) for
   96: #                       an array of names
   97: # metadata(file,entry): returns the metadata entry for a file. entry='keys'
   98: #                       returns a comma separated list of keys
   99: #
  100: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
  101: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
  102: # 11/8,11/16,11/18,11/22,11/23,12/22,
  103: # 01/06,01/13,02/24,02/28,02/29,
  104: # 03/01,03/02,03/06,03/07,03/13,
  105: # 04/05,05/29,05/31,06/01,
  106: # 06/05,06/26 Gerd Kortemeyer
  107: # 06/26 Ben Tyszka
  108: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
  109: # 08/14 Ben Tyszka
  110: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
  111: # 10/04 Gerd Kortemeyer
  112: # 10/04 Guy Albertelli
  113: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29, 
  114: # 10/30,10/31,
  115: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
  116: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
  117: # 05/01/01 Guy Albertelli
  118: # 05/01,06/01,09/01 Gerd Kortemeyer
  119: # 09/01 Guy Albertelli
  120: # 09/01,10/01,11/01 Gerd Kortemeyer
  121: # YEAR=2001
  122: # 02/27/01 Scott Harrison
  123: # 3/2 Gerd Kortemeyer
  124: # 3/15,3/19 Scott Harrison
  125: # 3/19,3/20 Gerd Kortemeyer
  126: # 3/22,3/27,4/2,4/16,4/17 Scott Harrison
  127: # 5/26,5/28 Gerd Kortemeyer
  128: # 5/30 H. K. Ng
  129: # 6/1 Gerd Kortemeyer
  130: # July Guy Albertelli
  131: # 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,
  132: # 10/2 Gerd Kortemeyer
  133: # 10/5,10/10 Scott Harrison
  134: # 10/15 Gerd Kortemeyer
  135: 
  136: package Apache::lonnet;
  137: 
  138: use strict;
  139: use Apache::File;
  140: use LWP::UserAgent();
  141: use HTTP::Headers;
  142: use vars 
  143: qw(%perlvar %hostname %homecache %hostip %spareid %hostdom %libserv %pr %prp %fe %fd $readit %metacache %packagetab %courselogs);
  144: use IO::Socket;
  145: use GDBM_File;
  146: use Apache::Constants qw(:common :http);
  147: use HTML::TokeParser;
  148: use Fcntl qw(:flock);
  149: 
  150: # --------------------------------------------------------------------- Logging
  151: 
  152: sub logtouch {
  153:     my $execdir=$perlvar{'lonDaemons'};
  154:     unless (-e "$execdir/logs/lonnet.log") {
  155: 	my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
  156: 	close $fh;
  157:     }
  158:     my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
  159:     chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
  160: }
  161: 
  162: sub logthis {
  163:     my $message=shift;
  164:     my $execdir=$perlvar{'lonDaemons'};
  165:     my $now=time;
  166:     my $local=localtime($now);
  167:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
  168:     print $fh "$local ($$): $message\n";
  169:     return 1;
  170: }
  171: 
  172: sub logperm {
  173:     my $message=shift;
  174:     my $execdir=$perlvar{'lonDaemons'};
  175:     my $now=time;
  176:     my $local=localtime($now);
  177:     my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
  178:     print $fh "$now:$message:$local\n";
  179:     return 1;
  180: }
  181: 
  182: # -------------------------------------------------- Non-critical communication
  183: sub subreply {
  184:     my ($cmd,$server)=@_;
  185:     my $peerfile="$perlvar{'lonSockDir'}/$server";
  186:     my $client=IO::Socket::UNIX->new(Peer    =>"$peerfile",
  187:                                      Type    => SOCK_STREAM,
  188:                                      Timeout => 10)
  189:        or return "con_lost";
  190:     print $client "$cmd\n";
  191:     my $answer=<$client>;
  192:     if (!$answer) { $answer="con_lost"; }
  193:     chomp($answer);
  194:     return $answer;
  195: }
  196: 
  197: sub reply {
  198:     my ($cmd,$server)=@_;
  199:     my $answer=subreply($cmd,$server);
  200:     if ($answer eq 'con_lost') { $answer=subreply($cmd,$server); }
  201:     if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
  202:        &logthis("<font color=blue>WARNING:".
  203:                 " $cmd to $server returned $answer</font>");
  204:     }
  205:     return $answer;
  206: }
  207: 
  208: # ----------------------------------------------------------- Send USR1 to lonc
  209: 
  210: sub reconlonc {
  211:     my $peerfile=shift;
  212:     &logthis("Trying to reconnect for $peerfile");
  213:     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
  214:     if (my $fh=Apache::File->new("$loncfile")) {
  215: 	my $loncpid=<$fh>;
  216:         chomp($loncpid);
  217:         if (kill 0 => $loncpid) {
  218: 	    &logthis("lonc at pid $loncpid responding, sending USR1");
  219:             kill USR1 => $loncpid;
  220:             sleep 1;
  221:             if (-e "$peerfile") { return; }
  222:             &logthis("$peerfile still not there, give it another try");
  223:             sleep 5;
  224:             if (-e "$peerfile") { return; }
  225:             &logthis(
  226:   "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
  227:         } else {
  228: 	    &logthis(
  229:                "<font color=blue>WARNING:".
  230:                " lonc at pid $loncpid not responding, giving up</font>");
  231:         }
  232:     } else {
  233:      &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
  234:     }
  235: }
  236: 
  237: # ------------------------------------------------------ Critical communication
  238: 
  239: sub critical {
  240:     my ($cmd,$server)=@_;
  241:     unless ($hostname{$server}) {
  242:         &logthis("<font color=blue>WARNING:".
  243:                " Critical message to unknown server ($server)</font>");
  244:         return 'no_such_host';
  245:     }
  246:     my $answer=reply($cmd,$server);
  247:     if ($answer eq 'con_lost') {
  248:         my $pingreply=reply('ping',$server);
  249: 	&reconlonc("$perlvar{'lonSockDir'}/$server");
  250:         my $pongreply=reply('pong',$server);
  251:         &logthis("Ping/Pong for $server: $pingreply/$pongreply");
  252:         $answer=reply($cmd,$server);
  253:         if ($answer eq 'con_lost') {
  254:             my $now=time;
  255:             my $middlename=$cmd;
  256:             $middlename=substr($middlename,0,16);
  257:             $middlename=~s/\W//g;
  258:             my $dfilename=
  259:              "$perlvar{'lonSockDir'}/delayed/$now.$middlename.$server";
  260:             {
  261:              my $dfh;
  262:              if ($dfh=Apache::File->new(">$dfilename")) {
  263:                 print $dfh "$cmd\n";
  264: 	     }
  265:             }
  266:             sleep 2;
  267:             my $wcmd='';
  268:             {
  269: 	     my $dfh;
  270:              if ($dfh=Apache::File->new("$dfilename")) {
  271:                 $wcmd=<$dfh>;
  272: 	     }
  273:             }
  274:             chomp($wcmd);
  275:             if ($wcmd eq $cmd) {
  276: 		&logthis("<font color=blue>WARNING: ".
  277:                          "Connection buffer $dfilename: $cmd</font>");
  278:                 &logperm("D:$server:$cmd");
  279: 	        return 'con_delayed';
  280:             } else {
  281:                 &logthis("<font color=red>CRITICAL:"
  282:                         ." Critical connection failed: $server $cmd</font>");
  283:                 &logperm("F:$server:$cmd");
  284:                 return 'con_failed';
  285:             }
  286:         }
  287:     }
  288:     return $answer;
  289: }
  290: 
  291: # ---------------------------------------------------------- Append Environment
  292: 
  293: sub appenv {
  294:     my %newenv=@_;
  295:     map {
  296: 	if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
  297:             &logthis("<font color=blue>WARNING: ".
  298:                 "Attempt to modify environment ".$_." to ".$newenv{$_}
  299:                 .'</font>');
  300: 	    delete($newenv{$_});
  301:         } else {
  302:             $ENV{$_}=$newenv{$_};
  303:         }
  304:     } keys %newenv;
  305: 
  306:     my $lockfh;
  307:     unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
  308:        return 'error: '.$!;
  309:     }
  310:     unless (flock($lockfh,LOCK_EX)) {
  311:          &logthis("<font color=blue>WARNING: ".
  312:                   'Could not obtain exclusive lock in appenv: '.$!);
  313:          $lockfh->close();
  314:          return 'error: '.$!;
  315:     }
  316: 
  317:     my @oldenv;
  318:     {
  319:      my $fh;
  320:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
  321: 	return 'error: '.$!;
  322:      }
  323:      @oldenv=<$fh>;
  324:      $fh->close();
  325:     }
  326:     for (my $i=0; $i<=$#oldenv; $i++) {
  327:         chomp($oldenv[$i]);
  328:         if ($oldenv[$i] ne '') {
  329:            my ($name,$value)=split(/=/,$oldenv[$i]);
  330:            unless (defined($newenv{$name})) {
  331: 	      $newenv{$name}=$value;
  332: 	   }
  333:         }
  334:     }
  335:     {
  336:      my $fh;
  337:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
  338: 	return 'error';
  339:      }
  340:      my $newname;
  341:      foreach $newname (keys %newenv) {
  342: 	 print $fh "$newname=$newenv{$newname}\n";
  343:      }
  344:      $fh->close();
  345:     }
  346: 
  347:     $lockfh->close();
  348:     return 'ok';
  349: }
  350: # ----------------------------------------------------- Delete from Environment
  351: 
  352: sub delenv {
  353:     my $delthis=shift;
  354:     my %newenv=();
  355:     if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
  356:         &logthis("<font color=blue>WARNING: ".
  357:                 "Attempt to delete from environment ".$delthis);
  358:         return 'error';
  359:     }
  360:     my @oldenv;
  361:     {
  362:      my $fh;
  363:      unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
  364: 	return 'error';
  365:      }
  366:      unless (flock($fh,LOCK_SH)) {
  367:          &logthis("<font color=blue>WARNING: ".
  368:                   'Could not obtain shared lock in delenv: '.$!);
  369:          $fh->close();
  370:          return 'error: '.$!;
  371:      }
  372:      @oldenv=<$fh>;
  373:      $fh->close();
  374:     }
  375:     {
  376:      my $fh;
  377:      unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
  378: 	return 'error';
  379:      }
  380:      unless (flock($fh,LOCK_EX)) {
  381:          &logthis("<font color=blue>WARNING: ".
  382:                   'Could not obtain exclusive lock in delenv: '.$!);
  383:          $fh->close();
  384:          return 'error: '.$!;
  385:      }
  386:      map {
  387: 	 unless ($_=~/^$delthis/) { print $fh $_; }
  388:      } @oldenv;
  389:      $fh->close();
  390:     }
  391:     return 'ok';
  392: }
  393: 
  394: # ------------------------------ Find server with least workload from spare.tab
  395: 
  396: sub spareserver {
  397:     my $tryserver;
  398:     my $spareserver='';
  399:     my $lowestserver=100;
  400:     foreach $tryserver (keys %spareid) {
  401:        my $answer=reply('load',$tryserver);
  402:        if (($answer =~ /\d/) && ($answer<$lowestserver)) {
  403: 	   $spareserver="http://$hostname{$tryserver}";
  404:            $lowestserver=$answer;
  405:        }
  406:     }    
  407:     return $spareserver;
  408: }
  409: 
  410: # --------- Try to authenticate user from domain's lib servers (first this one)
  411: 
  412: sub authenticate {
  413:     my ($uname,$upass,$udom)=@_;
  414:     $upass=escape($upass);
  415:     if (($perlvar{'lonRole'} eq 'library') && 
  416:         ($udom eq $perlvar{'lonDefDomain'})) {
  417:     my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
  418:         if ($answer =~ /authorized/) {
  419:               if ($answer eq 'authorized') {
  420:                  &logthis("User $uname at $udom authorized by local server"); 
  421:                  return $perlvar{'lonHostID'}; 
  422:               }
  423:               if ($answer eq 'non_authorized') {
  424:                  &logthis("User $uname at $udom rejected by local server"); 
  425:                  return 'no_host'; 
  426:               }
  427: 	}
  428:     }
  429: 
  430:     my $tryserver;
  431:     foreach $tryserver (keys %libserv) {
  432: 	if ($hostdom{$tryserver} eq $udom) {
  433:            my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
  434:            if ($answer =~ /authorized/) {
  435:               if ($answer eq 'authorized') {
  436:                  &logthis("User $uname at $udom authorized by $tryserver"); 
  437:                  return $tryserver; 
  438:               }
  439:               if ($answer eq 'non_authorized') {
  440:                  &logthis("User $uname at $udom rejected by $tryserver");
  441:                  return 'no_host';
  442:               } 
  443: 	   }
  444:        }
  445:     }
  446:     &logthis("User $uname at $udom could not be authenticated");    
  447:     return 'no_host';
  448: }
  449: 
  450: # ---------------------- Find the homebase for a user from domain's lib servers
  451: 
  452: sub homeserver {
  453:     my ($uname,$udom)=@_;
  454: 
  455:     my $index="$uname:$udom";
  456:     if ($homecache{$index}) { return "$homecache{$index}"; }
  457: 
  458:     my $tryserver;
  459:     foreach $tryserver (keys %libserv) {
  460: 	if ($hostdom{$tryserver} eq $udom) {
  461:            my $answer=reply("home:$udom:$uname",$tryserver);
  462:            if ($answer eq 'found') { 
  463: 	      $homecache{$index}=$tryserver;
  464:               return $tryserver; 
  465: 	   }
  466:        }
  467:     }    
  468:     return 'no_host';
  469: }
  470: 
  471: # ------------------------------------- Find the usernames behind a list of IDs
  472: 
  473: sub idget {
  474:     my ($udom,@ids)=@_;
  475:     my %returnhash=();
  476:     
  477:     my $tryserver;
  478:     foreach $tryserver (keys %libserv) {
  479:        if ($hostdom{$tryserver} eq $udom) {
  480: 	  my $idlist=join('&',@ids);
  481:           $idlist=~tr/A-Z/a-z/; 
  482: 	  my $reply=&reply("idget:$udom:".$idlist,$tryserver);
  483:           my @answer=();
  484:           if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
  485: 	      @answer=split(/\&/,$reply);
  486:           }                    ;
  487:           my $i;
  488:           for ($i=0;$i<=$#ids;$i++) {
  489:               if ($answer[$i]) {
  490: 		  $returnhash{$ids[$i]}=$answer[$i];
  491:               } 
  492:           }
  493:        }
  494:     }    
  495:     return %returnhash;
  496: }
  497: 
  498: # ------------------------------------- Find the IDs behind a list of usernames
  499: 
  500: sub idrget {
  501:     my ($udom,@unames)=@_;
  502:     my %returnhash=();
  503:     map {
  504:         $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
  505:     } @unames;
  506:     return %returnhash;
  507: }
  508: 
  509: # ------------------------------- Store away a list of names and associated IDs
  510: 
  511: sub idput {
  512:     my ($udom,%ids)=@_;
  513:     my %servers=();
  514:     map {
  515:         my $uhom=&homeserver($_,$udom);
  516:         if ($uhom ne 'no_host') {
  517:             my $id=&escape($ids{$_});
  518:             $id=~tr/A-Z/a-z/;
  519:             my $unam=&escape($_);
  520: 	    if ($servers{$uhom}) {
  521: 		$servers{$uhom}.='&'.$id.'='.$unam;
  522:             } else {
  523:                 $servers{$uhom}=$id.'='.$unam;
  524:             }
  525:             &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
  526:         }
  527:     } keys %ids;
  528:     map {
  529:         &critical('idput:'.$udom.':'.$servers{$_},$_);
  530:     } keys %servers;
  531: }
  532: 
  533: # ------------------------------------- Find the section of student in a course
  534: 
  535: sub usection {
  536:     my ($udom,$unam,$courseid)=@_;
  537:     $courseid=~s/\_/\//g;
  538:     $courseid=~s/^(\w)/\/$1/;
  539:     map {
  540:         my ($key,$value)=split(/\=/,$_);
  541:         $key=&unescape($key);
  542:         if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
  543:             my $section=$1;
  544:             if ($key eq $courseid.'_st') { $section=''; }
  545: 	    my ($dummy,$end,$start)=split(/\_/,&unescape($value));
  546:             my $now=time;
  547:             my $notactive=0;
  548:             if ($start) {
  549: 		if ($now<$start) { $notactive=1; }
  550:             }
  551:             if ($end) {
  552:                 if ($now>$end) { $notactive=1; }
  553:             } 
  554:             unless ($notactive) { return $section; }
  555:         }
  556:     } split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
  557:                         &homeserver($unam,$udom)));
  558:     return '-1';
  559: }
  560: 
  561: # ------------------------------------- Read an entry from a user's environment
  562: 
  563: sub userenvironment {
  564:     my ($udom,$unam,@what)=@_;
  565:     my %returnhash=();
  566:     my @answer=split(/\&/,
  567:                 &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
  568:                       &homeserver($unam,$udom)));
  569:     my $i;
  570:     for ($i=0;$i<=$#what;$i++) {
  571: 	$returnhash{$what[$i]}=&unescape($answer[$i]);
  572:     }
  573:     return %returnhash;
  574: }
  575: 
  576: # ----------------------------- Subscribe to a resource, return URL if possible
  577: 
  578: sub subscribe {
  579:     my $fname=shift;
  580:     my $author=$fname;
  581:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
  582:     my ($udom,$uname)=split(/\//,$author);
  583:     my $home=homeserver($uname,$udom);
  584:     if (($home eq 'no_host') || ($home eq $perlvar{'lonHostID'})) { 
  585:         return 'not_found'; 
  586:     }
  587:     my $answer=reply("sub:$fname",$home);
  588:     if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
  589: 	$answer.=' by '.$home;
  590:     }
  591:     return $answer;
  592: }
  593:     
  594: # -------------------------------------------------------------- Replicate file
  595: 
  596: sub repcopy {
  597:     my $filename=shift;
  598:     $filename=~s/\/+/\//g;
  599:     my $transname="$filename.in.transfer";
  600:     if ((-e $filename) || (-e $transname)) { return OK; }
  601:     my $remoteurl=subscribe($filename);
  602:     if ($remoteurl =~ /^con_lost by/) {
  603: 	   &logthis("Subscribe returned $remoteurl: $filename");
  604:            return HTTP_SERVICE_UNAVAILABLE;
  605:     } elsif ($remoteurl eq 'not_found') {
  606: 	   &logthis("Subscribe returned not_found: $filename");
  607: 	   return HTTP_NOT_FOUND;
  608:     } elsif ($remoteurl =~ /^rejected by/) {
  609: 	   &logthis("Subscribe returned $remoteurl: $filename");
  610:            return FORBIDDEN;
  611:     } elsif ($remoteurl eq 'directory') {
  612:            return OK;
  613:     } else {
  614:            my @parts=split(/\//,$filename);
  615:            my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
  616:            if ($path ne "$perlvar{'lonDocRoot'}/res") {
  617:                &logthis("Malconfiguration for replication: $filename");
  618: 	       return HTTP_BAD_REQUEST;
  619:            }
  620:            my $count;
  621:            for ($count=5;$count<$#parts;$count++) {
  622:                $path.="/$parts[$count]";
  623:                if ((-e $path)!=1) {
  624: 		   mkdir($path,0777);
  625:                }
  626:            }
  627:            my $ua=new LWP::UserAgent;
  628:            my $request=new HTTP::Request('GET',"$remoteurl");
  629:            my $response=$ua->request($request,$transname);
  630:            if ($response->is_error()) {
  631: 	       unlink($transname);
  632:                my $message=$response->status_line;
  633:                &logthis("<font color=blue>WARNING:"
  634:                        ." LWP get: $message: $filename</font>");
  635:                return HTTP_SERVICE_UNAVAILABLE;
  636:            } else {
  637: 	       if ($remoteurl!~/\.meta$/) {
  638:                   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
  639:                   my $mresponse=$ua->request($mrequest,$filename.'.meta');
  640:                   if ($mresponse->is_error()) {
  641: 		      unlink($filename.'.meta');
  642:                       &logthis(
  643:                      "<font color=yellow>INFO: No metadata: $filename</font>");
  644:                   }
  645: 	       }
  646:                rename($transname,$filename);
  647:                return OK;
  648:            }
  649:     }
  650: }
  651: 
  652: # --------------------------------------------------------- Server Side Include
  653: 
  654: sub ssi {
  655: 
  656:     my ($fn,%form)=@_;
  657: 
  658:     my $ua=new LWP::UserAgent;
  659:     
  660:     my $request;
  661:     
  662:     if (%form) {
  663:       $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
  664:       $request->content(join '&', map { "$_=$form{$_}" } keys %form);
  665:     } else {
  666:       $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
  667:     }
  668: 
  669:     $request->header(Cookie => $ENV{'HTTP_COOKIE'});
  670:     my $response=$ua->request($request);
  671: 
  672:     return $response->content;
  673: }
  674: 
  675: # ------------------------------------------------------------------------- Log
  676: 
  677: sub log {
  678:     my ($dom,$nam,$hom,$what)=@_;
  679:     return critical("log:$dom:$nam:$what",$hom);
  680: }
  681: 
  682: # ------------------------------------------------------------------ Course Log
  683: 
  684: sub flushcourselogs {
  685:     &logthis('Flushing course log buffers');
  686:     map {
  687:         my $crsid=$_;
  688:         if (&reply('log:'.$ENV{'course.'.$crsid.'.domain'}.':'.
  689: 		          $ENV{'course.'.$crsid.'.num'}.':'.
  690: 		           &escape($courselogs{$crsid}),
  691: 		          $ENV{'course.'.$crsid.'.home'}) eq 'ok') {
  692: 	    delete $courselogs{$crsid};
  693:         } else {
  694:             &logthis('Failed to flush log buffer for '.$crsid);
  695:             if (length($courselogs{$crsid})>40000) {
  696:                &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
  697:                         " exceeded maximum size, deleting.</font>");
  698:                delete $courselogs{$crsid};
  699:             }
  700:         }        
  701:     } keys %courselogs;
  702: }
  703: 
  704: sub courselog {
  705:     my $what=shift;
  706:     $what=time.':'.$what;
  707:     unless ($ENV{'request.course.id'}) { return ''; }
  708:     if (defined $courselogs{$ENV{'request.course.id'}}) {
  709: 	$courselogs{$ENV{'request.course.id'}}.='&'.$what;
  710:     } else {
  711: 	$courselogs{$ENV{'request.course.id'}}.=$what;
  712:     }
  713:     if (length($courselogs{$ENV{'request.course.id'}})>4048) {
  714: 	&flushcourselogs();
  715:     }
  716: }
  717: 
  718: sub courseacclog {
  719:     my $fnsymb=shift;
  720:     unless ($ENV{'request.course.id'}) { return ''; }
  721:     my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
  722:     if ($what=~/(problem|exam|quiz|assess|survey|form)$/) {
  723: 	map {
  724:             if ($_=~/^form\.(.*)/) {
  725: 		$what.=':'.$1.'='.$ENV{$_};
  726:             }
  727:         } keys %ENV;
  728:     }
  729:     &courselog($what);
  730: }
  731: 
  732: # ----------------------------------------------------------- Check out an item
  733: 
  734: sub checkout {
  735:     my ($symb,$tuname,$tudom,$tcrsid)=@_;
  736:     my $now=time;
  737:     my $lonhost=$perlvar{'lonHostID'};
  738:     my $infostr=&escape(
  739:                  $tuname.'&'.
  740:                  $tudom.'&'.
  741:                  $tcrsid.'&'.
  742:                  $symb.'&'.
  743: 		 $now.'&'.$ENV{'REMOTE_ADDR'});
  744:     my $token=&reply('tmpput:'.$infostr,$lonhost);
  745:     if ($token=~/^error\:/) { 
  746:         &logthis("<font color=blue>WARNING: ".
  747:                 "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
  748:                  "</font>");
  749:         return ''; 
  750:     }
  751: 
  752:     $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
  753:     $token=~tr/a-z/A-Z/;
  754: 
  755:     my %infohash=('resource.0.outtoken' => $token,
  756:                   'resource.0.checkouttime' => $now,
  757:                   'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
  758: 
  759:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
  760:        return '';
  761:     } else {
  762:         &logthis("<font color=blue>WARNING: ".
  763:                 "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
  764:                  "</font>");
  765:     }    
  766: 
  767:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
  768:                          &escape('Checkout '.$infostr.' - '.
  769:                                                  $token)) ne 'ok') {
  770: 	return '';
  771:     } else {
  772:         &logthis("<font color=blue>WARNING: ".
  773:                 "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
  774:                  "</font>");
  775:     }
  776:     return $token;
  777: }
  778: 
  779: # ------------------------------------------------------------ Check in an item
  780: 
  781: sub checkin {
  782:     my $token=shift;
  783:     my $now=time;
  784:     my ($ta,$tb,$lonhost)=split(/\*/,$token);
  785:     $lonhost=~tr/A-Z/a-z/;
  786:     my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
  787:     $dtoken=~s/\W/\_/g;
  788:     my ($tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
  789:                  split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
  790: 
  791:     unless (($tuname) && ($tudom)) {
  792:         &logthis('Check in '.$token.' ('.$dtoken.') failed');
  793:         return '';
  794:     }
  795:     
  796:     unless (&allowed('mgr',$tcrsid)) {
  797:         &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
  798:                  $ENV{'user.name'}.' - '.$ENV{'user.domain'});
  799:         return '';
  800:     }
  801: 
  802:     my %infohash=('resource.0.intoken' => $token,
  803:                   'resource.0.checkintime' => $now,
  804:                   'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
  805: 
  806:     unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
  807:        return '';
  808:     }    
  809: 
  810:     if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
  811:                          &escape('Checkin - '.$token)) ne 'ok') {
  812: 	return '';
  813:     }
  814: 
  815:     return ($symb,$tuname,$tudom,$tcrsid);    
  816: }
  817: 
  818: # --------------------------------------------- Set Expire Date for Spreadsheet
  819: 
  820: sub expirespread {
  821:     my ($uname,$udom,$stype,$usymb)=@_;
  822:     my $cid=$ENV{'request.course.id'}; 
  823:     if ($cid) {
  824:        my $now=time;
  825:        my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
  826:        return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
  827:                             $ENV{'course.'.$cid.'.num'}.
  828: 	        	    ':nohist_expirationdates:'.
  829:                             &escape($key).'='.$now,
  830:                             $ENV{'course.'.$cid.'.home'})
  831:     }
  832:     return 'ok';
  833: }
  834: 
  835: # ----------------------------------------------------- Devalidate Spreadsheets
  836: 
  837: sub devalidate {
  838:     my $symb=shift;
  839:     my $cid=$ENV{'request.course.id'}; 
  840:     if ($cid) {
  841: 	my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
  842:         my $status=
  843: 	    &del('nohist_calculatedsheet',
  844: 		 [$key.'studentcalc'],
  845: 		 $ENV{'course.'.$cid.'.domain'},
  846: 		 $ENV{'course.'.$cid.'.num'})
  847: 		.' '.
  848: 	    &del('nohist_calculatedsheets_'.$cid,
  849: 		 [$key.'assesscalc:'.$symb]);
  850:         unless ($status eq 'ok ok') {
  851:            &logthis('Could not devalidate spreadsheet '.
  852:                     $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
  853: 		    $symb.': '.$status);
  854:         }
  855:     }
  856: }
  857: 
  858: # ----------------------------------------------------------------------- Store
  859: 
  860: sub store {
  861:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
  862:     my $home='';
  863: 
  864:     if ($stuname) {
  865: 	$home=&homeserver($stuname,$domain);
  866:     }
  867: 
  868:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
  869: 
  870:     &devalidate($symb);
  871: 
  872:     $symb=escape($symb);
  873:     if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
  874:     if (!$domain) { $domain=$ENV{'user.domain'}; }
  875:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
  876:     if (!$home) { $home=$ENV{'user.home'}; }
  877:     my $namevalue='';
  878:     map {
  879:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
  880:     } keys %$storehash;
  881:     $namevalue=~s/\&$//;
  882:     return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
  883: }
  884: 
  885: # -------------------------------------------------------------- Critical Store
  886: 
  887: sub cstore {
  888:     my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
  889:     my $home='';
  890: 
  891:     if ($stuname) {
  892: 	$home=&homeserver($stuname,$domain);
  893:     }
  894: 
  895:     if (!$symb) { unless ($symb=&symbread()) { return ''; } }
  896: 
  897:     &devalidate($symb);
  898: 
  899:     $symb=escape($symb);
  900:     if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
  901:     if (!$domain) { $domain=$ENV{'user.domain'}; }
  902:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
  903:     if (!$home) { $home=$ENV{'user.home'}; }
  904: 
  905:     my $namevalue='';
  906:     map {
  907:         $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
  908:     } keys %$storehash;
  909:     $namevalue=~s/\&$//;
  910:     return critical("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
  911: }
  912: 
  913: # --------------------------------------------------------------------- Restore
  914: 
  915: sub restore {
  916:     my ($symb,$namespace,$domain,$stuname) = @_;
  917:     my $home='';
  918: 
  919:     if ($stuname) {
  920: 	$home=&homeserver($stuname,$domain);
  921:     }
  922: 
  923:     if (!$symb) {
  924:       unless ($symb=escape(&symbread())) { return ''; }
  925:     } else {
  926:       $symb=&escape($symb);
  927:     }
  928:     if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
  929:     if (!$domain) { $domain=$ENV{'user.domain'}; }
  930:     if (!$stuname) { $stuname=$ENV{'user.name'}; }
  931:     if (!$home) { $home=$ENV{'user.home'}; }
  932:     my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
  933: 
  934:     my %returnhash=();
  935:     map {
  936: 	my ($name,$value)=split(/\=/,$_);
  937:         $returnhash{&unescape($name)}=&unescape($value);
  938:     } split(/\&/,$answer);
  939:     my $version;
  940:     for ($version=1;$version<=$returnhash{'version'};$version++) {
  941:        map {
  942:           $returnhash{$_}=$returnhash{$version.':'.$_};
  943:        } split(/\:/,$returnhash{$version.':keys'});
  944:     }
  945:     return %returnhash;
  946: }
  947: 
  948: # ---------------------------------------------------------- Course Description
  949: 
  950: sub coursedescription {
  951:     my $courseid=shift;
  952:     $courseid=~s/^\///;
  953:     $courseid=~s/\_/\//g;
  954:     my ($cdomain,$cnum)=split(/\//,$courseid);
  955:     my $chome=&homeserver($cnum,$cdomain);
  956:     if ($chome ne 'no_host') {
  957:        my %returnhash=&dump('environment',$cdomain,$cnum);
  958:        if (!exists($returnhash{'con_lost'})) {
  959:            my $normalid=$cdomain.'_'.$cnum;
  960:            my %envhash=();
  961:            $returnhash{'home'}= $chome;
  962: 	   $returnhash{'domain'} = $cdomain;
  963: 	   $returnhash{'num'} = $cnum;
  964:            while (my ($name,$value) = each %returnhash) {
  965:                $envhash{'course.'.$normalid.'.'.$name}=$value;
  966:            }
  967:            $returnhash{'url'}='/res/'.declutter($returnhash{'url'});
  968:            $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
  969: 	       $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
  970:            $envhash{'course.'.$normalid.'.last_cache'}=time;
  971:            $envhash{'course.'.$normalid.'.home'}=$chome;
  972:            $envhash{'course.'.$normalid.'.domain'}=$cdomain;
  973:            $envhash{'course.'.$normalid.'.num'}=$cnum;
  974:            &appenv(%envhash);
  975:            return %returnhash;
  976:        }
  977:     }
  978:     return ();
  979: }
  980: 
  981: # -------------------------------------------------------- Get user privileges
  982: 
  983: sub rolesinit {
  984:     my ($domain,$username,$authhost)=@_;
  985:     my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
  986:     if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
  987:     my %allroles=();
  988:     my %thesepriv=();
  989:     my $now=time;
  990:     my $userroles="user.login.time=$now\n";
  991:     my $thesestr;
  992: 
  993:     if ($rolesdump ne '') {
  994:         map {
  995: 	  if ($_!~/^rolesdef\&/) {
  996:             my ($area,$role)=split(/=/,$_);
  997:             $area=~s/\_\w\w$//;
  998:             my ($trole,$tend,$tstart)=split(/_/,$role);
  999:             $userroles.='user.role.'.$trole.'.'.$area.'='.
 1000:                         $tstart.'.'.$tend."\n";
 1001:             if ($tend!=0) {
 1002: 	        if ($tend<$now) {
 1003: 	            $trole='';
 1004:                 } 
 1005:             }
 1006:             if ($tstart!=0) {
 1007:                 if ($tstart>$now) {
 1008:                    $trole='';        
 1009:                 }
 1010:             }
 1011:             if (($area ne '') && ($trole ne '')) {
 1012: 	       my $spec=$trole.'.'.$area;
 1013:                my ($tdummy,$tdomain,$trest)=split(/\//,$area);
 1014:                if ($trole =~ /^cr\//) {
 1015: 		   my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
 1016:                    my $homsvr=homeserver($rauthor,$rdomain);
 1017:                    if ($hostname{$homsvr} ne '') {
 1018:                       my $roledef=
 1019: 			  reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
 1020:                                 $homsvr);
 1021:                       if (($roledef ne 'con_lost') && ($roledef ne '')) {
 1022:                          my ($syspriv,$dompriv,$coursepriv)=
 1023: 			     split(/\_/,unescape($roledef));
 1024:  	                 $allroles{'cm./'}.=':'.$syspriv;
 1025:                          $allroles{$spec.'./'}.=':'.$syspriv;
 1026:                          if ($tdomain ne '') {
 1027:                              $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
 1028:                              $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
 1029:                              if ($trest ne '') {
 1030: 		                $allroles{'cm.'.$area}.=':'.$coursepriv;
 1031: 		                $allroles{$spec.'.'.$area}.=':'.$coursepriv;
 1032:                              }
 1033: 	                 }
 1034:                       }
 1035:                    }
 1036:                } else {
 1037: 	           $allroles{'cm./'}.=':'.$pr{$trole.':s'};
 1038: 	           $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
 1039:                    if ($tdomain ne '') {
 1040:                      $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
 1041:                      $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
 1042:                       if ($trest ne '') {
 1043: 		          $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
 1044: 		          $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
 1045:                       }
 1046: 	           }
 1047: 	       }
 1048:             }
 1049:           } 
 1050:         } split(/&/,$rolesdump);
 1051:         my $adv=0;
 1052:         my $author=0;
 1053:         map {
 1054:             %thesepriv=();
 1055:             if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
 1056:             if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
 1057:             map {
 1058:                 if ($_ ne '') {
 1059: 		    my ($privilege,$restrictions)=split(/&/,$_);
 1060:                     if ($restrictions eq '') {
 1061: 			$thesepriv{$privilege}='F';
 1062:                     } else {
 1063:                         if ($thesepriv{$privilege} ne 'F') {
 1064: 			    $thesepriv{$privilege}.=$restrictions;
 1065:                         }
 1066:                     }
 1067:                 }
 1068:             } split(/:/,$allroles{$_});
 1069:             $thesestr='';
 1070:             map { $thesestr.=':'.$_.'&'.$thesepriv{$_}; } keys %thesepriv;
 1071:             $userroles.='user.priv.'.$_.'='.$thesestr."\n";
 1072:         } keys %allroles;            
 1073:         $userroles.='user.adv='.$adv."\n".
 1074: 	            'user.author='.$author."\n";
 1075:         $ENV{'user.adv'}=$adv;
 1076:     }
 1077:     return $userroles;  
 1078: }
 1079: 
 1080: # --------------------------------------------------------------- get interface
 1081: 
 1082: sub get {
 1083:    my ($namespace,$storearr,$udomain,$uname)=@_;
 1084:    my $items='';
 1085:    map {
 1086:        $items.=escape($_).'&';
 1087:    } @$storearr;
 1088:    $items=~s/\&$//;
 1089:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1090:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1091:    my $uhome=&homeserver($uname,$udomain);
 1092: 
 1093:    my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
 1094:    my @pairs=split(/\&/,$rep);
 1095:    my %returnhash=();
 1096:    my $i=0;
 1097:    map {
 1098:       $returnhash{$_}=unescape($pairs[$i]);
 1099:       $i++;
 1100:    } @$storearr;
 1101:    return %returnhash;
 1102: }
 1103: 
 1104: # --------------------------------------------------------------- del interface
 1105: 
 1106: sub del {
 1107:    my ($namespace,$storearr,$udomain,$uname)=@_;
 1108:    my $items='';
 1109:    map {
 1110:        $items.=escape($_).'&';
 1111:    } @$storearr;
 1112:    $items=~s/\&$//;
 1113:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1114:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1115:    my $uhome=&homeserver($uname,$udomain);
 1116: 
 1117:    return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
 1118: }
 1119: 
 1120: # -------------------------------------------------------------- dump interface
 1121: 
 1122: sub dump {
 1123:    my ($namespace,$udomain,$uname)=@_;
 1124:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1125:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1126:    my $uhome=&homeserver($uname,$udomain);
 1127:    my $rep=reply("dump:$udomain:$uname:$namespace",$uhome);
 1128:    my @pairs=split(/\&/,$rep);
 1129:    my %returnhash=();
 1130:    map {
 1131:       my ($key,$value)=split(/=/,$_);
 1132:       $returnhash{unescape($key)}=unescape($value);
 1133:    } @pairs;
 1134:    return %returnhash;
 1135: }
 1136: 
 1137: # --------------------------------------------------------------- put interface
 1138: 
 1139: sub put {
 1140:    my ($namespace,$storehash,$udomain,$uname)=@_;
 1141:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1142:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1143:    my $uhome=&homeserver($uname,$udomain);
 1144:    my $items='';
 1145:    map {
 1146:        $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
 1147:    } keys %$storehash;
 1148:    $items=~s/\&$//;
 1149:    return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
 1150: }
 1151: 
 1152: # ------------------------------------------------------ critical put interface
 1153: 
 1154: sub cput {
 1155:    my ($namespace,$storehash,$udomain,$uname)=@_;
 1156:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1157:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1158:    my $uhome=&homeserver($uname,$udomain);
 1159:    my $items='';
 1160:    map {
 1161:        $items.=escape($_).'='.escape($$storehash{$_}).'&';
 1162:    } keys %$storehash;
 1163:    $items=~s/\&$//;
 1164:    return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
 1165: }
 1166: 
 1167: # -------------------------------------------------------------- eget interface
 1168: 
 1169: sub eget {
 1170:    my ($namespace,$storearr,$udomain,$uname)=@_;
 1171:    my $items='';
 1172:    map {
 1173:        $items.=escape($_).'&';
 1174:    } @$storearr;
 1175:    $items=~s/\&$//;
 1176:    if (!$udomain) { $udomain=$ENV{'user.domain'}; }
 1177:    if (!$uname) { $uname=$ENV{'user.name'}; }
 1178:    my $uhome=&homeserver($uname,$udomain);
 1179:    my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
 1180:    my @pairs=split(/\&/,$rep);
 1181:    my %returnhash=();
 1182:    my $i=0;
 1183:    map {
 1184:       $returnhash{$_}=unescape($pairs[$i]);
 1185:       $i++;
 1186:    } @$storearr;
 1187:    return %returnhash;
 1188: }
 1189: 
 1190: # ------------------------------------------------- Check for a user privilege
 1191: 
 1192: sub allowed {
 1193:     my ($priv,$uri)=@_;
 1194: 
 1195:     my $orguri=$uri;
 1196:     $uri=&declutter($uri);
 1197: 
 1198: # Free bre access to adm and meta resources
 1199: 
 1200:     if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
 1201: 	return 'F';
 1202:     }
 1203: 
 1204: # Free bre to public access
 1205: 
 1206:     if ($priv eq 'bre') {
 1207: 	if (&metadata($uri,'copyright') eq 'public') { return 'F'; }
 1208:     }
 1209: 
 1210:     my $thisallowed='';
 1211:     my $statecond=0;
 1212:     my $courseprivid='';
 1213: 
 1214: # Course
 1215: 
 1216:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
 1217:        $thisallowed.=$1;
 1218:     }
 1219: 
 1220: # Domain
 1221: 
 1222:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
 1223:        =~/$priv\&([^\:]*)/) {
 1224:        $thisallowed.=$1;
 1225:     }
 1226: 
 1227: # Course: uri itself is a course
 1228:     my $courseuri=$uri;
 1229:     $courseuri=~s/\_(\d)/\/$1/;
 1230:     $courseuri=~s/^([^\/])/\/$1/;
 1231: 
 1232:     if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
 1233:        =~/$priv\&([^\:]*)/) {
 1234:        $thisallowed.=$1;
 1235:     }
 1236: 
 1237: # Full access at system, domain or course-wide level? Exit.
 1238: 
 1239:     if ($thisallowed=~/F/) {
 1240: 	return 'F';
 1241:     }
 1242: 
 1243: # If this is generating or modifying users, exit with special codes
 1244: 
 1245:     if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:'=~/\:$priv\:/) {
 1246: 	return $thisallowed;
 1247:     }
 1248: #
 1249: # Gathered so far: system, domain and course wide privileges
 1250: #
 1251: # Course: See if uri or referer is an individual resource that is part of 
 1252: # the course
 1253: 
 1254:     if ($ENV{'request.course.id'}) {
 1255:        $courseprivid=$ENV{'request.course.id'};
 1256:        if ($ENV{'request.course.sec'}) {
 1257:           $courseprivid.='/'.$ENV{'request.course.sec'};
 1258:        }
 1259:        $courseprivid=~s/\_/\//;
 1260:        my $checkreferer=1;
 1261:        my @uriparts=split(/\//,$uri);
 1262:        my $filename=$uriparts[$#uriparts];
 1263:        my $pathname=$uri;
 1264:        $pathname=~s/\/$filename$//;
 1265:        if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
 1266:            /\&$filename\:([\d\|]+)\&/) {
 1267:            $statecond=$1;
 1268:            if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
 1269:                =~/$priv\&([^\:]*)/) {
 1270:                $thisallowed.=$1;
 1271:                $checkreferer=0;
 1272:            }
 1273:        }
 1274:        
 1275:        if ($checkreferer) {
 1276: 	  my $refuri=$ENV{'httpref.'.$orguri};
 1277: 
 1278:             unless ($refuri) {
 1279:                 map {
 1280: 		    if ($_=~/^httpref\..*\*/) {
 1281: 			my $pattern=$_;
 1282:                         $pattern=~s/^httpref\.\/res\///;
 1283:                         $pattern=~s/\*/\[\^\/\]\+/g;
 1284:                         $pattern=~s/\//\\\//g;
 1285:                         if ($orguri=~/$pattern/) {
 1286: 			    $refuri=$ENV{$_};
 1287:                         }
 1288:                     }
 1289:                 } keys %ENV;
 1290:             }
 1291:          if ($refuri) { 
 1292: 	  $refuri=&declutter($refuri);
 1293:           my @uriparts=split(/\//,$refuri);
 1294:           my $filename=$uriparts[$#uriparts];
 1295:           my $pathname=$refuri;
 1296:           $pathname=~s/\/$filename$//;
 1297:             if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
 1298:               /\&$filename\:([\d\|]+)\&/) {
 1299:               my $refstatecond=$1;
 1300:               if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
 1301:                   =~/$priv\&([^\:]*)/) {
 1302:                   $thisallowed.=$1;
 1303:                   $uri=$refuri;
 1304:                   $statecond=$refstatecond;
 1305:               }
 1306:           }
 1307:         }
 1308:        }
 1309:    }
 1310: 
 1311: #
 1312: # Gathered now: all privileges that could apply, and condition number
 1313: # 
 1314: #
 1315: # Full or no access?
 1316: #
 1317: 
 1318:     if ($thisallowed=~/F/) {
 1319: 	return 'F';
 1320:     }
 1321: 
 1322:     unless ($thisallowed) {
 1323:         return '';
 1324:     }
 1325: 
 1326: # Restrictions exist, deal with them
 1327: #
 1328: #   C:according to course preferences
 1329: #   R:according to resource settings
 1330: #   L:unless locked
 1331: #   X:according to user session state
 1332: #
 1333: 
 1334: # Possibly locked functionality, check all courses
 1335: # Locks might take effect only after 10 minutes cache expiration for other
 1336: # courses, and 2 minutes for current course
 1337: 
 1338:     my $envkey;
 1339:     if ($thisallowed=~/L/) {
 1340:         foreach $envkey (keys %ENV) {
 1341:            if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
 1342:                my $courseid=$2;
 1343:                my $roleid=$1.'.'.$2;
 1344:                $courseid=~s/^\///;
 1345:                my $expiretime=600;
 1346:                if ($ENV{'request.role'} eq $roleid) {
 1347: 		  $expiretime=120;
 1348:                }
 1349: 	       my ($cdom,$cnum,$csec)=split(/\//,$courseid);
 1350:                my $prefix='course.'.$cdom.'_'.$cnum.'.';
 1351:                if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
 1352: 		   &coursedescription($courseid);
 1353:                }
 1354:                if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
 1355:                 || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
 1356: 		   if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
 1357:                        &log($ENV{'user.domain'},$ENV{'user.name'},
 1358:                             $ENV{'user.host'},
 1359:                             'Locked by res: '.$priv.' for '.$uri.' due to '.
 1360:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
 1361:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
 1362: 		       return '';
 1363:                    }
 1364:                }
 1365:                if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
 1366:                 || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
 1367: 		   if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
 1368:                        &log($ENV{'user.domain'},$ENV{'user.name'},
 1369:                             $ENV{'user.host'},
 1370:                             'Locked by priv: '.$priv.' for '.$uri.' due to '.
 1371:                             $cdom.'/'.$cnum.'/'.$csec.' expire '.
 1372:                             $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
 1373: 		       return '';
 1374:                    }
 1375:                }
 1376: 	   }
 1377:        }
 1378:     }
 1379:    
 1380: #
 1381: # Rest of the restrictions depend on selected course
 1382: #
 1383: 
 1384:     unless ($ENV{'request.course.id'}) {
 1385:        return '1';
 1386:     }
 1387: 
 1388: #
 1389: # Now user is definitely in a course
 1390: #
 1391: 
 1392: 
 1393: # Course preferences
 1394: 
 1395:    if ($thisallowed=~/C/) {
 1396:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
 1397:        if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
 1398: 	   =~/\,$rolecode\,/) {
 1399:            &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
 1400:                 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
 1401:                 $ENV{'request.course.id'});
 1402:            return '';
 1403:        }
 1404:    }
 1405: 
 1406: # Resource preferences
 1407: 
 1408:    if ($thisallowed=~/R/) {
 1409:        my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
 1410:        my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
 1411:        if (-e $filename) {
 1412:            my @content;
 1413:            {
 1414: 	     my $fh=Apache::File->new($filename);
 1415:              @content=<$fh>;
 1416: 	   }
 1417:            if (join('',@content)=~
 1418:                     /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
 1419: 	       &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
 1420:                     'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
 1421:            return '';
 1422: 
 1423:            }
 1424:        }
 1425:    }
 1426: 
 1427: # Restricted by state?
 1428: 
 1429:    if ($thisallowed=~/X/) {
 1430:       if (&condval($statecond)) {
 1431: 	 return '2';
 1432:       } else {
 1433:          return '';
 1434:       }
 1435:    }
 1436: 
 1437:    return 'F';
 1438: }
 1439: 
 1440: # ----------------------------------------------------------------- Define Role
 1441: 
 1442: sub definerole {
 1443:   if (allowed('mcr','/')) {
 1444:     my ($rolename,$sysrole,$domrole,$courole)=@_;
 1445:     map {
 1446: 	my ($crole,$cqual)=split(/\&/,$_);
 1447:         if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
 1448:         if ($pr{'cr:s'}=~/$crole\&/) {
 1449: 	    if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) { 
 1450:                return "refused:s:$crole&$cqual"; 
 1451:             }
 1452:         }
 1453:     } split('/',$sysrole);
 1454:     map {
 1455: 	my ($crole,$cqual)=split(/\&/,$_);
 1456:         if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
 1457:         if ($pr{'cr:d'}=~/$crole\&/) {
 1458: 	    if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) { 
 1459:                return "refused:d:$crole&$cqual"; 
 1460:             }
 1461:         }
 1462:     } split('/',$domrole);
 1463:     map {
 1464: 	my ($crole,$cqual)=split(/\&/,$_);
 1465:         if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
 1466:         if ($pr{'cr:c'}=~/$crole\&/) {
 1467: 	    if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) { 
 1468:                return "refused:c:$crole&$cqual"; 
 1469:             }
 1470:         }
 1471:     } split('/',$courole);
 1472:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
 1473:                 "$ENV{'user.domain'}:$ENV{'user.name'}:".
 1474: 	        "rolesdef_$rolename=".
 1475:                 escape($sysrole.'_'.$domrole.'_'.$courole);
 1476:     return reply($command,$ENV{'user.home'});
 1477:   } else {
 1478:     return 'refused';
 1479:   }
 1480: }
 1481: 
 1482: # ---------------- Make a metadata query against the network of library servers
 1483: 
 1484: sub metadata_query {
 1485:     my ($query,$custom,$customshow)=@_;
 1486:     # need to put in a library server loop here and return a hash
 1487:     my %rhash;
 1488:     for my $server (keys %libserv) {
 1489: 	unless ($custom or $customshow) {
 1490: 	    my $reply=&reply("querysend:".&escape($query),$server);
 1491: 	    $rhash{$server}=$reply;
 1492: 	}
 1493: 	else {
 1494: 	    my $reply=&reply("querysend:".&escape($query).':'.
 1495: 			     &escape($custom).':'.&escape($customshow),
 1496: 			     $server);
 1497: 	    $rhash{$server}=$reply;
 1498: 	}
 1499:     }
 1500:     return \%rhash;
 1501: }
 1502: 
 1503: # ------------------------------------------------------------------ Plain Text
 1504: 
 1505: sub plaintext {
 1506:     my $short=shift;
 1507:     return $prp{$short};
 1508: }
 1509: 
 1510: # ------------------------------------------------------------------ Plain Text
 1511: 
 1512: sub fileembstyle {
 1513:     my $ending=shift;
 1514:     return $fe{$ending};
 1515: }
 1516: 
 1517: # ------------------------------------------------------------ Description Text
 1518: 
 1519: sub filedescription {
 1520:     my $ending=shift;
 1521:     return $fd{$ending};
 1522: }
 1523: 
 1524: # ----------------------------------------------------------------- Assign Role
 1525: 
 1526: sub assignrole {
 1527:     my ($udom,$uname,$url,$role,$end,$start)=@_;
 1528:     my $mrole;
 1529:     if ($role =~ /^cr\//) {
 1530: 	unless (&allowed('ccr',$url)) {
 1531:            &logthis('Refused custom assignrole: '.
 1532:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
 1533: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 1534:            return 'refused'; 
 1535:         }
 1536:         $mrole='cr';
 1537:     } else {
 1538:         my $cwosec=$url;
 1539:         $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
 1540:         unless (&allowed('c'.$role,$cwosec)) { 
 1541:            &logthis('Refused assignrole: '.
 1542:              $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
 1543: 		    $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 1544:            return 'refused'; 
 1545:         }
 1546:         $mrole=$role;
 1547:     }
 1548:     my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
 1549:                 "$udom:$uname:$url".'_'."$mrole=$role";
 1550:     if ($end) { $command.='_'.$end; }
 1551:     if ($start) {
 1552: 	if ($end) { 
 1553:            $command.='_'.$start; 
 1554:         } else {
 1555:            $command.='_0_'.$start;
 1556:         }
 1557:     }
 1558:     return &reply($command,&homeserver($uname,$udom));
 1559: }
 1560: 
 1561: # --------------------------------------------------------------- Modify a user
 1562: 
 1563: 
 1564: sub modifyuser {
 1565:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene)=@_;
 1566:     &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
 1567:              $umode.', '.$first.', '.$middle.', '.
 1568: 	     $last.', '.$gene.' by '.
 1569:              $ENV{'user.name'}.' at '.$ENV{'user.domain'});  
 1570:     my $uhome=&homeserver($uname,$udom);
 1571: # ----------------------------------------------------------------- Create User
 1572:     if (($uhome eq 'no_host') && ($umode) && ($upass)) {
 1573:         my $unhome='';
 1574: 	if ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
 1575: 	    $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
 1576:         } else {
 1577:             my $tryserver;
 1578:             my $loadm=10000000;
 1579:             foreach $tryserver (keys %libserv) {
 1580: 	       if ($hostdom{$tryserver} eq $udom) {
 1581:                   my $answer=reply('load',$tryserver);
 1582:                   if (($answer=~/\d+/) && ($answer<$loadm)) {
 1583: 		      $loadm=$answer;
 1584:                       $unhome=$tryserver;
 1585:                   }
 1586: 	       }
 1587: 	    }
 1588:         }
 1589:         if (($unhome eq '') || ($unhome eq 'no_host')) {
 1590: 	    return 'error: find home';
 1591:         }
 1592:         my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
 1593:                          &escape($upass),$unhome);
 1594: 	unless ($reply eq 'ok') {
 1595:             return 'error: '.$reply;
 1596:         }   
 1597:         $uhome=&homeserver($uname,$udom);
 1598:         if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
 1599: 	    return 'error: verify home';
 1600:         }
 1601:     }
 1602: # ---------------------------------------------------------------------- Add ID
 1603:     if ($uid) {
 1604:        $uid=~tr/A-Z/a-z/;
 1605:        my %uidhash=&idrget($udom,$uname);
 1606:        if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)) {
 1607: 	  unless ($uid eq $uidhash{$uname}) {
 1608: 	      return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
 1609:           }
 1610:        } else {
 1611: 	  &idput($udom,($uname => $uid));
 1612:        }
 1613:     }
 1614: # -------------------------------------------------------------- Add names, etc
 1615:     my %names=&get('environment',
 1616: 		   ['firstname','middlename','lastname','generation'],
 1617: 		   $udom,$uname);
 1618:     if ($first)  { $names{'firstname'}  = $first; }
 1619:     if ($middle) { $names{'middlename'} = $middle; }
 1620:     if ($last)   { $names{'lastname'}   = $last; }
 1621:     if ($gene)   { $names{'generation'} = $gene; }
 1622:     my $reply = &put('environment', \%names, $udom,$uname);
 1623:     if ($reply ne 'ok') { return 'error: '.$reply; }
 1624:     &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
 1625:              $umode.', '.$first.', '.$middle.', '.
 1626: 	     $last.', '.$gene.' by '.
 1627:              $ENV{'user.name'}.' at '.$ENV{'user.domain'});
 1628:     return 'ok';
 1629: }
 1630: 
 1631: # -------------------------------------------------------------- Modify student
 1632: 
 1633: sub modifystudent {
 1634:     my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
 1635:         $end,$start)=@_;
 1636:     my $cid='';
 1637:     unless ($cid=$ENV{'request.course.id'}) {
 1638: 	return 'not_in_class';
 1639:     }
 1640: # --------------------------------------------------------------- Make the user
 1641:     my $reply=&modifyuser
 1642: 	($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene);
 1643:     unless ($reply eq 'ok') { return $reply; }
 1644:     my $uhome=&homeserver($uname,$udom);
 1645:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
 1646: 	return 'error: no such user';
 1647:     }
 1648: # -------------------------------------------------- Add student to course list
 1649:     $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
 1650: 	              $ENV{'course.'.$cid.'.num'}.':classlist:'.
 1651:                       &escape($uname.':'.$udom).'='.
 1652:                       &escape($end.':'.$start),
 1653: 	              $ENV{'course.'.$cid.'.home'});
 1654:     unless (($reply eq 'ok') || ($reply eq 'delayed')) {
 1655: 	return 'error: '.$reply;
 1656:     }
 1657: # ---------------------------------------------------- Add student role to user
 1658:     my $uurl='/'.$cid;
 1659:     $uurl=~s/\_/\//g;
 1660:     if ($usec) {
 1661: 	$uurl.='/'.$usec;
 1662:     }
 1663:     return &assignrole($udom,$uname,$uurl,'st',$end,$start);
 1664: }
 1665: 
 1666: # ------------------------------------------------- Write to course preferences
 1667: 
 1668: sub writecoursepref {
 1669:     my ($courseid,%prefs)=@_;
 1670:     $courseid=~s/^\///;
 1671:     $courseid=~s/\_/\//g;
 1672:     my ($cdomain,$cnum)=split(/\//,$courseid);
 1673:     my $chome=homeserver($cnum,$cdomain);
 1674:     if (($chome eq '') || ($chome eq 'no_host')) { 
 1675: 	return 'error: no such course';
 1676:     }
 1677:     my $cstring='';
 1678:     map {
 1679: 	$cstring.=escape($_).'='.escape($prefs{$_}).'&';
 1680:     } keys %prefs;
 1681:     $cstring=~s/\&$//;
 1682:     return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
 1683: }
 1684: 
 1685: # ---------------------------------------------------------- Make/modify course
 1686: 
 1687: sub createcourse {
 1688:     my ($udom,$description,$url)=@_;
 1689:     $url=&declutter($url);
 1690:     my $cid='';
 1691:     unless (&allowed('ccc',$ENV{'user.domain'})) {
 1692:         return 'refused';
 1693:     }
 1694:     unless ($udom eq $ENV{'user.domain'}) {
 1695:         return 'refused';
 1696:     }
 1697: # ------------------------------------------------------------------- Create ID
 1698:    my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
 1699:        unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
 1700: # ----------------------------------------------- Make sure that does not exist
 1701:    my $uhome=&homeserver($uname,$udom);
 1702:    unless (($uhome eq '') || ($uhome eq 'no_host')) {
 1703:        $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
 1704:         unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
 1705:        $uhome=&homeserver($uname,$udom);       
 1706:        unless (($uhome eq '') || ($uhome eq 'no_host')) {
 1707:            return 'error: unable to generate unique course-ID';
 1708:        } 
 1709:    }
 1710: # ------------------------------------------------------------- Make the course
 1711:     my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
 1712:                       $ENV{'user.home'});
 1713:     unless ($reply eq 'ok') { return 'error: '.$reply; }
 1714:     $uhome=&homeserver($uname,$udom);
 1715:     if (($uhome eq '') || ($uhome eq 'no_host')) { 
 1716: 	return 'error: no such course';
 1717:     }
 1718:     &writecoursepref($udom.'_'.$uname,
 1719:                      ('description' => $description,
 1720:                       'url'         => $url));
 1721:     return '/'.$udom.'/'.$uname;
 1722: }
 1723: 
 1724: # ---------------------------------------------------------- Assign Custom Role
 1725: 
 1726: sub assigncustomrole {
 1727:     my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
 1728:     return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
 1729:                        $end,$start);
 1730: }
 1731: 
 1732: # ----------------------------------------------------------------- Revoke Role
 1733: 
 1734: sub revokerole {
 1735:     my ($udom,$uname,$url,$role)=@_;
 1736:     my $now=time;
 1737:     return &assignrole($udom,$uname,$url,$role,$now);
 1738: }
 1739: 
 1740: # ---------------------------------------------------------- Revoke Custom Role
 1741: 
 1742: sub revokecustomrole {
 1743:     my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
 1744:     my $now=time;
 1745:     return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
 1746: }
 1747: 
 1748: # ------------------------------------------------------------ Directory lister
 1749: 
 1750: sub dirlist {
 1751:     my $uri=shift;
 1752:     $uri=~s/^\///;
 1753:     $uri=~s/\/$//;
 1754:     my ($res,$udom,$uname,@rest)=split(/\//,$uri);
 1755:     if ($udom) {
 1756:      if ($uname) {
 1757:        my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/'.$uri,
 1758:                       homeserver($uname,$udom));
 1759:        return split(/:/,$listing);
 1760:      } else {
 1761:        my $tryserver;
 1762:        my %allusers=();
 1763:        foreach $tryserver (keys %libserv) {
 1764: 	  if ($hostdom{$tryserver} eq $udom) {
 1765:              my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.$udom,
 1766: 			       $tryserver);
 1767:              if (($listing ne 'no_such_dir') && ($listing ne 'empty')
 1768:               && ($listing ne 'con_lost')) {
 1769:                 map {
 1770:                   my ($entry,@stat)=split(/&/,$_);
 1771:                   $allusers{$entry}=1;
 1772:                 } split(/:/,$listing);
 1773:              }
 1774: 	  }
 1775:        }
 1776:        my $alluserstr='';
 1777:        map {
 1778:            $alluserstr.=$_.'&user:';
 1779:        } sort keys %allusers;
 1780:        $alluserstr=~s/:$//;
 1781:        return split(/:/,$alluserstr);
 1782:      } 
 1783:    } else {
 1784:        my $tryserver;
 1785:        my %alldom=();
 1786:        foreach $tryserver (keys %libserv) {
 1787: 	   $alldom{$hostdom{$tryserver}}=1;
 1788:        }
 1789:        my $alldomstr='';
 1790:        map {
 1791:           $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
 1792:        } sort keys %alldom;
 1793:        $alldomstr=~s/:$//;
 1794:        return split(/:/,$alldomstr);       
 1795:    }
 1796: }
 1797: 
 1798: # -------------------------------------------------------- Value of a Condition
 1799: 
 1800: sub directcondval {
 1801:     my $number=shift;
 1802:     if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
 1803:        return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
 1804:     } else {
 1805:        return 2;
 1806:     }
 1807: }
 1808: 
 1809: sub condval {
 1810:     my $condidx=shift;
 1811:     my $result=0;
 1812:     my $allpathcond='';
 1813:     map {
 1814:        if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
 1815: 	   $allpathcond.=
 1816:                '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
 1817:        }
 1818:     } split(/\|/,$condidx);
 1819:     $allpathcond=~s/\|$//;
 1820:     if ($ENV{'request.course.id'}) {
 1821:        if ($allpathcond) {
 1822:           my $operand='|';
 1823: 	  my @stack;
 1824:           map {
 1825:               if ($_ eq '(') {
 1826:                  push @stack,($operand,$result)
 1827:               } elsif ($_ eq ')') {
 1828:                   my $before=pop @stack;
 1829: 		  if (pop @stack eq '&') {
 1830: 		      $result=$result>$before?$before:$result;
 1831:                   } else {
 1832:                       $result=$result>$before?$result:$before;
 1833:                   }
 1834:               } elsif (($_ eq '&') || ($_ eq '|')) {
 1835:                   $operand=$_;
 1836:               } else {
 1837:                   my $new=directcondval($_);
 1838:                   if ($operand eq '&') {
 1839:                      $result=$result>$new?$new:$result;
 1840:                   } else {
 1841:                      $result=$result>$new?$result:$new;
 1842:                   }                  
 1843:               }
 1844:           } ($allpathcond=~/(\d+|\(|\)|\&|\|)/g);
 1845:        }
 1846:     }
 1847:     return $result;
 1848: }
 1849: 
 1850: # --------------------------------------------------------- Value of a Variable
 1851: 
 1852: sub EXT {
 1853:     my ($varname,$symbparm)=@_;
 1854:     unless ($varname) { return ''; }
 1855:     my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
 1856:     my $rest;
 1857:     if ($therest[0]) {
 1858:        $rest=join('.',@therest);
 1859:     } else {
 1860:        $rest='';
 1861:     }
 1862:     my $qualifierrest=$qualifier;
 1863:     if ($rest) { $qualifierrest.='.'.$rest; }
 1864:     my $spacequalifierrest=$space;
 1865:     if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
 1866:     if ($realm eq 'user') {
 1867: # --------------------------------------------------------------- user.resource
 1868: 	if ($space eq 'resource') {
 1869: 	    my %restored=&restore();
 1870:             return $restored{$qualifierrest};
 1871: # ----------------------------------------------------------------- user.access
 1872:         } elsif ($space eq 'access') {
 1873:             return &allowed($qualifier,$rest);
 1874: # ------------------------------------------ user.preferences, user.environment
 1875:         } elsif (($space eq 'preferences') || ($space eq 'environment')) {
 1876:             return $ENV{join('.',('environment',$qualifierrest))};
 1877: # ----------------------------------------------------------------- user.course
 1878:         } elsif ($space eq 'course') {
 1879:             return $ENV{join('.',('request.course',$qualifier))};
 1880: # ------------------------------------------------------------------- user.role
 1881:         } elsif ($space eq 'role') {
 1882:             my ($role,$where)=split(/\./,$ENV{'request.role'});
 1883:             if ($qualifier eq 'value') {
 1884: 		return $role;
 1885:             } elsif ($qualifier eq 'extent') {
 1886:                 return $where;
 1887:             }
 1888: # ----------------------------------------------------------------- user.domain
 1889:         } elsif ($space eq 'domain') {
 1890:             return $ENV{'user.domain'};
 1891: # ------------------------------------------------------------------- user.name
 1892:         } elsif ($space eq 'name') {
 1893:             return $ENV{'user.name'};
 1894: # ---------------------------------------------------- Any other user namespace
 1895:         } else {
 1896:             my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
 1897:             my %reply=&get($space,[$item]);
 1898:             return $reply{$item};
 1899:         }
 1900:     } elsif ($realm eq 'request') {
 1901: # ------------------------------------------------------------- request.browser
 1902:         if ($space eq 'browser') {
 1903: 	    return $ENV{'browser.'.$qualifier};
 1904: # ------------------------------------------------------------ request.filename
 1905:         } else {
 1906:             return $ENV{'request.'.$spacequalifierrest};
 1907:         }
 1908:     } elsif ($realm eq 'course') {
 1909: # ---------------------------------------------------------- course.description
 1910:         return $ENV{'course.'.$ENV{'request.course.id'}.'.'.
 1911:                               $spacequalifierrest};
 1912:     } elsif ($realm eq 'resource') {
 1913:        if ($ENV{'request.course.id'}) {
 1914: # ----------------------------------------------------- Cascading lookup scheme
 1915:          my $symbp;
 1916:          if ($symbparm) {
 1917:             $symbp=$symbparm;
 1918: 	 } else {
 1919:             $symbp=&symbread();
 1920:          }            
 1921:          my $mapp=(split(/\_\_\_/,$symbp))[0];
 1922: 
 1923:          my $symbparm=$symbp.'.'.$spacequalifierrest;
 1924:          my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
 1925: 
 1926:          my $seclevel=
 1927:             $ENV{'request.course.id'}.'.['.
 1928: 		$ENV{'request.course.sec'}.'].'.$spacequalifierrest;
 1929:          my $seclevelr=
 1930:             $ENV{'request.course.id'}.'.['.
 1931: 		$ENV{'request.course.sec'}.'].'.$symbparm;
 1932:          my $seclevelm=
 1933:             $ENV{'request.course.id'}.'.['.
 1934: 		$ENV{'request.course.sec'}.'].'.$mapparm;
 1935: 
 1936:          my $courselevel=
 1937:             $ENV{'request.course.id'}.'.'.$spacequalifierrest;
 1938:          my $courselevelr=
 1939:             $ENV{'request.course.id'}.'.'.$symbparm;
 1940:          my $courselevelm=
 1941:             $ENV{'request.course.id'}.'.'.$mapparm;
 1942: 
 1943: # ----------------------------------------------------------- first, check user
 1944:          my %resourcedata=get('resourcedata',
 1945:                            [$courselevelr,$courselevelm,$courselevel]);
 1946:          if (($resourcedata{$courselevelr}!~/^error\:/) &&
 1947:              ($resourcedata{$courselevelr}!~/^con_lost/)) {
 1948: 
 1949:          if ($resourcedata{$courselevelr}) { 
 1950:             return $resourcedata{$courselevelr}; }
 1951:          if ($resourcedata{$courselevelm}) { 
 1952:             return $resourcedata{$courselevelm}; }
 1953:          if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
 1954: 
 1955:       } else {
 1956: 	  if ($resourcedata{$courselevelr}!~/No such file/) {
 1957: 	    &logthis("<font color=blue>WARNING:".
 1958: 		   " Trying to get resource data for ".$ENV{'user.name'}." at "
 1959:                    .$ENV{'user.domain'}.": ".$resourcedata{$courselevelr}.
 1960:                  "</font>");
 1961: 	  }
 1962:       }
 1963: 
 1964: # -------------------------------------------------------- second, check course
 1965: 
 1966:         my $reply=&reply('get:'.
 1967:               $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
 1968:               $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
 1969: 	      ':resourcedata:'.
 1970:    &escape($seclevelr).'&'.&escape($seclevelm).'&'.&escape($seclevel).'&'.
 1971:    &escape($courselevelr).'&'.&escape($courselevelm).'&'.&escape($courselevel),
 1972: 		   $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
 1973:       if ($reply!~/^error\:/) {
 1974: 	  map {
 1975: 	      if ($_) { return &unescape($_); }
 1976:           } split(/\&/,$reply);
 1977:       }
 1978:       if (($reply=~/^con_lost/) || ($reply=~/^error\:/)) {
 1979: 	  &logthis("<font color=blue>WARNING:".
 1980:                 " Getting ".$reply." asking for ".$varname." for ".
 1981:                 $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
 1982:                 ' at '.
 1983:                 $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.
 1984:                 ' from '.
 1985:                 $ENV{'course.'.$ENV{'request.course.id'}.'.home'}.
 1986:                  "</font>");
 1987:       }
 1988: # ------------------------------------------------------ third, check map parms
 1989:        my %parmhash=();
 1990:        my $thisparm='';       
 1991:        if (tie(%parmhash,'GDBM_File',
 1992:           $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640)) {
 1993:            $thisparm=$parmhash{$symbparm};
 1994: 	   untie(%parmhash);
 1995:        }
 1996:        if ($thisparm) { return $thisparm; }
 1997:      }
 1998:      
 1999: # --------------------------------------------- last, look in resource metadata
 2000: 
 2001:       $spacequalifierrest=~s/\./\_/;
 2002:       my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
 2003:       if ($metadata) { return $metadata; }
 2004:       $metadata=&metadata($ENV{'request.filename'},
 2005:                                          'parameter_'.$spacequalifierrest);
 2006:       if ($metadata) { return $metadata; }
 2007: 
 2008: # ------------------------------------------------------------------ Cascade up
 2009: 
 2010:       unless ($space eq '0') {
 2011:           my ($part,$id)=split(/(\.|\_)/,$space);
 2012:           if ($id) {
 2013: 	      my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
 2014:                                    $symbparm);
 2015:               if ($partgeneral) { return $partgeneral; }
 2016:           } else {
 2017:               my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
 2018:                                        $symbparm);
 2019:               if ($resourcegeneral) { return $resourcegeneral; }
 2020:           }
 2021:       }
 2022: 
 2023: # ---------------------------------------------------- Any other user namespace
 2024:     } elsif ($realm eq 'environment') {
 2025: # ----------------------------------------------------------------- environment
 2026:         return $ENV{'environment.'.$spacequalifierrest};
 2027:     } elsif ($realm eq 'system') {
 2028: # ----------------------------------------------------------------- system.time
 2029: 	if ($space eq 'time') {
 2030: 	    return time;
 2031:         }
 2032:     }
 2033:     return '';
 2034: }
 2035: 
 2036: # ---------------------------------------------------------------- Get metadata
 2037: 
 2038: sub metadata {
 2039:     my ($uri,$what)=@_;
 2040: 
 2041:     $uri=&declutter($uri);
 2042:     my $filename=$uri;
 2043:     $uri=~s/\.meta$//;
 2044:     unless ($metacache{$uri.':keys'}) {
 2045:         my %metathesekeys=();
 2046:         unless ($filename=~/\.meta$/) { $filename.='.meta'; }
 2047: 	my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
 2048:         my $parser=HTML::TokeParser->new(\$metastring);
 2049:         my $token;
 2050:         undef %metathesekeys;
 2051:         while ($token=$parser->get_token) {
 2052:            if ($token->[0] eq 'S') {
 2053: 	     if (defined($token->[2]->{'package'})) {
 2054: 	      my $package=$token->[2]->{'package'};
 2055: 	      my $keyroot='';
 2056:               if (defined($token->[2]->{'part'})) { 
 2057:                  $keyroot.='_'.$token->[2]->{'part'}; 
 2058: 	      }
 2059:               if (defined($token->[2]->{'id'})) { 
 2060:                  $keyroot.='.'.$token->[2]->{'id'}; 
 2061: 	      }
 2062:               if ($metacache{$uri.':packages'}) {
 2063:                  $metacache{$uri.':packages'}.=','.$package.$keyroot;
 2064:               } else {
 2065:                  $metacache{$uri.':packages'}=$package.$keyroot;
 2066: 	      }
 2067:               map {
 2068: 		  if ($_=~/^$package\&/) {
 2069: 		      my ($pack,$name,$subp)=split(/\&/,$_);
 2070:                       my $value=$packagetab{$_};
 2071: 		      my $part=$keyroot;
 2072:                       $part=~s/^\_//;
 2073:                       $part=~s/\./\_/g;
 2074:                       if ($subp eq 'display') {
 2075: 			  $value.=' [Part: '.$part.']';
 2076:                       }
 2077:                       my $unikey='parameter'.$keyroot.'_'.$name;
 2078:                       $metathesekeys{$unikey}=1;
 2079:                       $metacache{$uri.':'.$unikey.'.part'}=$part;
 2080:                       unless 
 2081:                        (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
 2082:                          $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
 2083: 		      }
 2084:                   }
 2085:               } keys %packagetab;
 2086:              } else {
 2087: 	      my $entry=$token->[1];
 2088:               my $unikey=$entry;
 2089:               if (defined($token->[2]->{'part'})) { 
 2090:                  $unikey.='_'.$token->[2]->{'part'}; 
 2091: 	      }
 2092:               if (defined($token->[2]->{'id'})) { 
 2093:                  $unikey.='.'.$token->[2]->{'id'}; 
 2094: 	      }
 2095:               if (defined($token->[2]->{'name'})) { 
 2096:                  $unikey.='_'.$token->[2]->{'name'}; 
 2097: 	      }
 2098:               $metathesekeys{$unikey}=1;
 2099:               map {
 2100: 		  $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
 2101:               } @{$token->[3]};
 2102:               unless (
 2103:                  $metacache{$uri.':'.$unikey}=$parser->get_text('/'.$entry)
 2104: 		      ) { $metacache{$uri.':'.$unikey}=
 2105: 			      $metacache{$uri.':'.$unikey.'.default'};
 2106: 		      }
 2107: 	    }
 2108: 	 }
 2109:        }
 2110:        $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
 2111:     }
 2112:     return $metacache{$uri.':'.$what};
 2113: }
 2114: 
 2115: # ------------------------------------------------- Update symbolic store links
 2116: 
 2117: sub symblist {
 2118:     my ($mapname,%newhash)=@_;
 2119:     $mapname=declutter($mapname);
 2120:     my %hash;
 2121:     if (($ENV{'request.course.fn'}) && (%newhash)) {
 2122:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
 2123:                       &GDBM_WRCREAT,0640)) {
 2124: 	    map {
 2125:                 $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
 2126:             } keys %newhash;
 2127:             if (untie(%hash)) {
 2128: 		return 'ok';
 2129:             }
 2130:         }
 2131:     }
 2132:     return 'error';
 2133: }
 2134: 
 2135: # ------------------------------------------------------ Return symb list entry
 2136: 
 2137: sub symbread {
 2138:     my $thisfn=shift;
 2139:     unless ($thisfn) {
 2140: 	$thisfn=$ENV{'request.filename'};
 2141:     }
 2142:     $thisfn=declutter($thisfn);
 2143:     my %hash;
 2144:     my %bighash;
 2145:     my $syval='';
 2146:     if (($ENV{'request.course.fn'}) && ($thisfn)) {
 2147:         if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
 2148:                       &GDBM_READER,0640)) {
 2149: 	    $syval=$hash{$thisfn};
 2150:             untie(%hash);
 2151:         }
 2152: # ---------------------------------------------------------- There was an entry
 2153:         if ($syval) {
 2154:            unless ($syval=~/\_\d+$/) {
 2155: 	       unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
 2156:                   &appenv('request.ambiguous' => $thisfn);
 2157:                   return '';
 2158:                }    
 2159:                $syval.=$1;
 2160: 	   }
 2161:         } else {
 2162: # ------------------------------------------------------- Was not in symb table
 2163:            if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
 2164:                             &GDBM_READER,0640)) {
 2165: # ---------------------------------------------- Get ID(s) for current resource
 2166:               my $ids=$bighash{'ids_/res/'.$thisfn};
 2167:               unless ($ids) { 
 2168:                  $ids=$bighash{'ids_/'.$thisfn};
 2169:               }
 2170:               if ($ids) {
 2171: # ------------------------------------------------------------------- Has ID(s)
 2172:                  my @possibilities=split(/\,/,$ids);
 2173:                  if ($#possibilities==0) {
 2174: # ----------------------------------------------- There is only one possibility
 2175: 		     my ($mapid,$resid)=split(/\./,$ids);
 2176:                      $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
 2177:                  } else {
 2178: # ------------------------------------------ There is more than one possibility
 2179:                      my $realpossible=0;
 2180:                      map {
 2181: 			 my $file=$bighash{'src_'.$_};
 2182:                          if (&allowed('bre',$file)) {
 2183:          		    my ($mapid,$resid)=split(/\./,$_);
 2184:                             if ($bighash{'map_type_'.$mapid} ne 'page') {
 2185: 				$realpossible++;
 2186:                                 $syval=declutter($bighash{'map_id_'.$mapid}).
 2187:                                        '___'.$resid;
 2188:                             }
 2189: 			 }
 2190:                      } @possibilities;
 2191: 		     if ($realpossible!=1) { $syval=''; }
 2192:                  }
 2193: 	      }
 2194:               untie(%bighash)
 2195:            } 
 2196:         }
 2197:         if ($syval) {
 2198:            return $syval.'___'.$thisfn; 
 2199:         }
 2200:     }
 2201:     &appenv('request.ambiguous' => $thisfn);
 2202:     return '';
 2203: }
 2204: 
 2205: # ---------------------------------------------------------- Return random seed
 2206: 
 2207: sub numval {
 2208:     my $txt=shift;
 2209:     $txt=~tr/A-J/0-9/;
 2210:     $txt=~tr/a-j/0-9/;
 2211:     $txt=~tr/K-T/0-9/;
 2212:     $txt=~tr/k-t/0-9/;
 2213:     $txt=~tr/U-Z/0-5/;
 2214:     $txt=~tr/u-z/0-5/;
 2215:     $txt=~s/\D//g;
 2216:     return int($txt);
 2217: }    
 2218: 
 2219: sub rndseed {
 2220:     my ($symb,$courseid,$domain,$username)=@_;
 2221:     if (!$symb) {
 2222:       unless ($symb=&symbread()) { return time; }
 2223:     }
 2224:     if (!$courseid) { $courseid=$ENV{'request.course.id'};}
 2225:     if (!$domain) {$domain=$ENV{'user.domain'};}
 2226:     if (!$username) {$username=$ENV{'user.name'};}
 2227:     {
 2228:       use integer;
 2229:       my $symbchck=unpack("%32C*",$symb) << 27;
 2230:       my $symbseed=numval($symb) << 22;
 2231:       my $namechck=unpack("%32C*",$username) << 17;
 2232:       my $nameseed=numval($username) << 12;
 2233:       my $domainseed=unpack("%32C*",$domain) << 7;
 2234:       my $courseseed=unpack("%32C*",$courseid);
 2235:       my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
 2236:       #uncommenting these lines can break things!
 2237:       #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
 2238:       #&Apache::lonxml::debug("rndseed :$num:$symb");
 2239:       return $num;
 2240:     }
 2241: }
 2242: 
 2243: sub ireceipt {
 2244:     my ($funame,$fudom,$fucourseid,$fusymb)=@_;
 2245:     my $cuname=unpack("%32C*",$funame);
 2246:     my $cudom=unpack("%32C*",$fudom);
 2247:     my $cucourseid=unpack("%32C*",$fucourseid);
 2248:     my $cusymb=unpack("%32C*",$fusymb);
 2249:     my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
 2250:     return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
 2251:            ($cunique%$cuname+
 2252:             $cunique%$cudom+
 2253:             $cusymb%$cuname+
 2254:             $cusymb%$cudom+
 2255:             $cucourseid%$cuname+
 2256:             $cucourseid%$cudom);
 2257: }
 2258: 
 2259: sub receipt {
 2260:     return &ireceipt($ENV{'user.name'},$ENV{'user.domain'},
 2261:                      $ENV{'request.course.id'},&symbread());
 2262: }
 2263:   
 2264: # ------------------------------------------------------------ Serves up a file
 2265: # returns either the contents of the file or a -1
 2266: sub getfile {
 2267:   my $file=shift;
 2268:   &repcopy($file);
 2269:   if (! -e $file ) { return -1; };
 2270:   my $fh=Apache::File->new($file);
 2271:   my $a='';
 2272:   while (<$fh>) { $a .=$_; }
 2273:   return $a
 2274: }
 2275: 
 2276: sub filelocation {
 2277:   my ($dir,$file) = @_;
 2278:   my $location;
 2279:   $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
 2280:   if ($file=~m:^/~:) { # is a contruction space reference
 2281:     $location = $file;
 2282:     $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
 2283:   } else {
 2284:     $file=~s/^$perlvar{'lonDocRoot'}//;
 2285:     $file=~s:^/*res::;
 2286:     if ( !( $file =~ m:^/:) ) {
 2287:       $location = $dir. '/'.$file;
 2288:     } else {
 2289:       $location = '/home/httpd/html/res'.$file;
 2290:     }
 2291:   }
 2292:   $location=~s://+:/:g; # remove duplicate /
 2293:   while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
 2294:   return $location;
 2295: }
 2296: 
 2297: sub hreflocation {
 2298:     my ($dir,$file)=@_;
 2299:     unless (($_=~/^http:\/\//i) || ($_=~/^\//)) {
 2300:        my $finalpath=filelocation($dir,$file);
 2301:        $finalpath=~s/^\/home\/httpd\/html//;
 2302:        return $finalpath;
 2303:     } else {
 2304:        return $file;
 2305:     }
 2306: }
 2307: 
 2308: # ------------------------------------------------------------- Declutters URLs
 2309: 
 2310: sub declutter {
 2311:     my $thisfn=shift;
 2312:     $thisfn=~s/^$perlvar{'lonDocRoot'}//;
 2313:     $thisfn=~s/^\///;
 2314:     $thisfn=~s/^res\///;
 2315:     return $thisfn;
 2316: }
 2317: 
 2318: # -------------------------------------------------------- Escape Special Chars
 2319: 
 2320: sub escape {
 2321:     my $str=shift;
 2322:     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
 2323:     return $str;
 2324: }
 2325: 
 2326: # ----------------------------------------------------- Un-Escape Special Chars
 2327: 
 2328: sub unescape {
 2329:     my $str=shift;
 2330:     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
 2331:     return $str;
 2332: }
 2333: 
 2334: # ================================================================ Main Program
 2335: 
 2336: sub BEGIN {
 2337: unless ($readit) {
 2338: # ------------------------------------------------------------ Read access.conf
 2339: {
 2340:     my $config=Apache::File->new("/etc/httpd/conf/access.conf");
 2341: 
 2342:     while (my $configline=<$config>) {
 2343:         if ($configline =~ /PerlSetVar/) {
 2344: 	   my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
 2345:            chomp($varvalue);
 2346:            $perlvar{$varname}=$varvalue;
 2347:         }
 2348:     }
 2349: }
 2350: 
 2351: # ------------------------------------------------------------- Read hosts file
 2352: {
 2353:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
 2354: 
 2355:     while (my $configline=<$config>) {
 2356:        chomp($configline);
 2357:        my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
 2358:        $hostname{$id}=$name;
 2359:        $hostdom{$id}=$domain;
 2360:        $hostip{$id}=$ip;
 2361:        if ($role eq 'library') { $libserv{$id}=$name; }
 2362:     }
 2363: }
 2364: 
 2365: # ------------------------------------------------------ Read spare server file
 2366: {
 2367:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
 2368: 
 2369:     while (my $configline=<$config>) {
 2370:        chomp($configline);
 2371:        if (($configline) && ($configline ne $perlvar{'lonHostID'})) {
 2372:           $spareid{$configline}=1;
 2373:        }
 2374:     }
 2375: }
 2376: # ------------------------------------------------------------ Read permissions
 2377: {
 2378:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
 2379: 
 2380:     while (my $configline=<$config>) {
 2381:        chomp($configline);
 2382:       if ($configline) {
 2383:        my ($role,$perm)=split(/ /,$configline);
 2384:        if ($perm ne '') { $pr{$role}=$perm; }
 2385:       }
 2386:     }
 2387: }
 2388: 
 2389: # -------------------------------------------- Read plain texts for permissions
 2390: {
 2391:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
 2392: 
 2393:     while (my $configline=<$config>) {
 2394:        chomp($configline);
 2395:       if ($configline) {
 2396:        my ($short,$plain)=split(/:/,$configline);
 2397:        if ($plain ne '') { $prp{$short}=$plain; }
 2398:       }
 2399:     }
 2400: }
 2401: 
 2402: # ---------------------------------------------------------- Read package table
 2403: {
 2404:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
 2405: 
 2406:     while (my $configline=<$config>) {
 2407:        chomp($configline);
 2408:        my ($short,$plain)=split(/:/,$configline);
 2409:        my ($pack,$name)=split(/\&/,$short);
 2410:        if ($plain ne '') {
 2411:           $packagetab{$pack.'&'.$name.'&name'}=$name; 
 2412:           $packagetab{$short}=$plain; 
 2413:        }
 2414:     }
 2415: }
 2416: 
 2417: # ------------------------------------------------------------- Read file types
 2418: {
 2419:     my $config=Apache::File->new("$perlvar{'lonTabDir'}/filetypes.tab");
 2420: 
 2421:     while (my $configline=<$config>) {
 2422:        chomp($configline);
 2423:        my ($ending,$emb,@descr)=split(/\s+/,$configline);
 2424:        if ($descr[0] ne '') { 
 2425:          $fe{$ending}=$emb;
 2426:          $fd{$ending}=join(' ',@descr);
 2427:        }
 2428:     }
 2429: }
 2430: 
 2431: %metacache=();
 2432: 
 2433: $readit='done';
 2434: &logtouch();
 2435: &logthis('<font color=yellow>INFO: Read configuration</font>');
 2436: }
 2437: }
 2438: 1;

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