loncom/lonnet/perl/lonnet.pm - view

File: [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.503: download - view: text, annotated - select for diffs
Thu May 27 04:25:12 2004 UTC (20 years, 1 month ago) by albertel
Branches: MAIN
CVS tags: HEAD

- fixes for randnumber generation
   - due to a error in coding the 64bit and 64bit2 rnd seeds were throwing away the second half of the seed, we now preserve this functionality and make it explicit
   - additionally 64bit3 now uses all 64bits of the seed
   - also added new function pushrandomnumber poprandomnumber to be called instead of setrandomnumber before we were crunching the Safe space random number generator state, as this function is used bu thing the <optionresponse> and <radoibuttonresponse> this meant changes in the internal randomization code could screw up later Safe space random calls the old method is preserved for blank 64bit and 64bit2 randomiztion env.

1: # The LearningOnline Network 2: # TCP networking package 3: # 4: # $Id: lonnet.pm,v 1.503 2004/05/27 04:25:12 albertel Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: ### 29: 30: package Apache::lonnet; 31: 32: use strict; 33: use LWP::UserAgent(); 34: use HTTP::Headers; 35: use HTTP::Date; 36: # use Date::Parse; 37: use vars 38: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom 39: %libserv %pr %prp %metacache %packagetab %titlecache %courseresversioncache %resversioncache 40: %courselogs %accesshash %userrolehash $processmarker $dumpcount 41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseresdatacache 42: %userresdatacache %usectioncache %domaindescription %domain_auth_def %domain_auth_arg_def 43: %domain_lang_def %domain_city %domain_longi %domain_lati $tmpdir); 44: 45: use IO::Socket; 46: use GDBM_File; 47: use Apache::Constants qw(:common :http); 48: use HTML::LCParser; 49: use Fcntl qw(:flock); 50: use Apache::loncoursedata; 51: use Apache::lonlocal; 52: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw); 53: use Time::HiRes(); 54: my $readit; 55: 56: =pod 57: 58: =head1 Package Variables 59: 60: These are largely undocumented, so if you decipher one please note it here. 61: 62: =over 4 63: 64: =item $processmarker 65: 66: Contains the time this process was started and this servers host id. 67: 68: =item $dumpcount 69: 70: Counts the number of times a message log flush has been attempted (regardless 71: of success) by this process. Used as part of the filename when messages are 72: delayed. 73: 74: =back 75: 76: =cut 77: 78: 79: # --------------------------------------------------------------------- Logging 80: 81: sub logtouch { 82: my $execdir=$perlvar{'lonDaemons'}; 83: unless (-e "$execdir/logs/lonnet.log") { 84: open(my $fh,">>$execdir/logs/lonnet.log"); 85: close $fh; 86: } 87: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3]; 88: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log'); 89: } 90: 91: sub logthis { 92: my $message=shift; 93: my $execdir=$perlvar{'lonDaemons'}; 94: my $now=time; 95: my $local=localtime($now); 96: if (open(my $fh,">>$execdir/logs/lonnet.log")) { 97: print $fh "$local ($$): $message\n"; 98: close($fh); 99: } 100: return 1; 101: } 102: 103: sub logperm { 104: my $message=shift; 105: my $execdir=$perlvar{'lonDaemons'}; 106: my $now=time; 107: my $local=localtime($now); 108: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) { 109: print $fh "$now:$message:$local\n"; 110: close($fh); 111: } 112: return 1; 113: } 114: 115: # -------------------------------------------------- Non-critical communication 116: sub subreply { 117: my ($cmd,$server)=@_; 118: my $peerfile="$perlvar{'lonSockDir'}/$server"; 119: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile", 120: Type => SOCK_STREAM, 121: Timeout => 10) 122: or return "con_lost"; 123: print $client "$cmd\n"; 124: my $answer=<$client>; 125: if (!$answer) { $answer="con_lost"; } 126: chomp($answer); 127: return $answer; 128: } 129: 130: sub reply { 131: my ($cmd,$server)=@_; 132: unless (defined($hostname{$server})) { return 'no_such_host'; } 133: my $answer=subreply($cmd,$server); 134: if ($answer eq 'con_lost') { 135: #sleep 5; 136: #$answer=subreply($cmd,$server); 137: #if ($answer eq 'con_lost') { 138: # &logthis("Second attempt con_lost on $server"); 139: # my $peerfile="$perlvar{'lonSockDir'}/$server"; 140: # my $client=IO::Socket::UNIX->new(Peer =>"$peerfile", 141: # Type => SOCK_STREAM, 142: # Timeout => 10) 143: # or return "con_lost"; 144: # &logthis("Killing socket"); 145: # print $client "close_connection_exit\n"; 146: #sleep 5; 147: # $answer=subreply($cmd,$server); 148: #} 149: } 150: if (($answer=~/^refused/) || ($answer=~/^rejected/)) { 151: &logthis("WARNING:". 152: " $cmd to $server returned $answer"); 153: } 154: return $answer; 155: } 156: 157: # ----------------------------------------------------------- Send USR1 to lonc 158: 159: sub reconlonc { 160: my $peerfile=shift; 161: &logthis("Trying to reconnect for $peerfile"); 162: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid"; 163: if (open(my $fh,"<$loncfile")) { 164: my $loncpid=<$fh>; 165: chomp($loncpid); 166: if (kill 0 => $loncpid) { 167: &logthis("lonc at pid $loncpid responding, sending USR1"); 168: kill USR1 => $loncpid; 169: sleep 1; 170: if (-e "$peerfile") { return; } 171: &logthis("$peerfile still not there, give it another try"); 172: sleep 5; 173: if (-e "$peerfile") { return; } 174: &logthis( 175: "WARNING: $peerfile still not there, giving up"); 176: } else { 177: &logthis( 178: "WARNING:". 179: " lonc at pid $loncpid not responding, giving up"); 180: } 181: } else { 182: &logthis('WARNING: lonc not running, giving up'); 183: } 184: } 185: 186: # ------------------------------------------------------ Critical communication 187: 188: sub critical { 189: my ($cmd,$server)=@_; 190: unless ($hostname{$server}) { 191: &logthis("WARNING:". 192: " Critical message to unknown server ($server)"); 193: return 'no_such_host'; 194: } 195: my $answer=reply($cmd,$server); 196: if ($answer eq 'con_lost') { 197: my $pingreply=reply('ping',$server); 198: &reconlonc("$perlvar{'lonSockDir'}/$server"); 199: my $pongreply=reply('pong',$server); 200: &logthis("Ping/Pong for $server: $pingreply/$pongreply"); 201: $answer=reply($cmd,$server); 202: if ($answer eq 'con_lost') { 203: my $now=time; 204: my $middlename=$cmd; 205: $middlename=substr($middlename,0,16); 206: $middlename=~s/\W//g; 207: my $dfilename= 208: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server"; 209: $dumpcount++; 210: { 211: my $dfh; 212: if (open($dfh,">$dfilename")) { 213: print $dfh "$cmd\n"; 214: close($dfh); 215: } 216: } 217: sleep 2; 218: my $wcmd=''; 219: { 220: my $dfh; 221: if (open($dfh,"<$dfilename")) { 222: $wcmd=<$dfh>; 223: close($dfh); 224: } 225: } 226: chomp($wcmd); 227: if ($wcmd eq $cmd) { 228: &logthis("WARNING: ". 229: "Connection buffer $dfilename: $cmd"); 230: &logperm("D:$server:$cmd"); 231: return 'con_delayed'; 232: } else { 233: &logthis("CRITICAL:" 234: ." Critical connection failed: $server $cmd"); 235: &logperm("F:$server:$cmd"); 236: return 'con_failed'; 237: } 238: } 239: } 240: return $answer; 241: } 242: 243: # 244: # -------------- Remove all key from the env that start witha lowercase letter 245: # (Which is always a lon-capa value) 246: 247: sub cleanenv { 248: # unless (defined(&Apache::exists_config_define("MODPERL2"))) { return; } 249: # unless (&Apache::exists_config_define("MODPERL2")) { return; } 250: foreach my $key (keys(%ENV)) { 251: if ($key =~ /^[a-z]/) { 252: delete($ENV{$key}); 253: } 254: } 255: } 256: 257: # ------------------------------------------- Transfer profile into environment 258: 259: sub transfer_profile_to_env { 260: my ($lonidsdir,$handle)=@_; 261: my @profile; 262: { 263: open(my $idf,"$lonidsdir/$handle.id"); 264: flock($idf,LOCK_SH); 265: @profile=<$idf>; 266: close($idf); 267: } 268: my $envi; 269: my %Remove; 270: for ($envi=0;$envi<=$#profile;$envi++) { 271: chomp($profile[$envi]); 272: my ($envname,$envvalue)=split(/=/,$profile[$envi]); 273: $ENV{$envname} = $envvalue; 274: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) { 275: if ($time < time-300) { 276: $Remove{$key}++; 277: } 278: } 279: } 280: $ENV{'user.environment'} = "$lonidsdir/$handle.id"; 281: foreach my $expired_key (keys(%Remove)) { 282: &delenv($expired_key); 283: } 284: } 285: 286: # ---------------------------------------------------------- Append Environment 287: 288: sub appenv { 289: my %newenv=@_; 290: foreach (keys %newenv) { 291: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) { 292: &logthis("WARNING: ". 293: "Attempt to modify environment ".$_." to ".$newenv{$_} 294: .''); 295: delete($newenv{$_}); 296: } else { 297: $ENV{$_}=$newenv{$_}; 298: } 299: } 300: 301: my $lockfh; 302: unless (open($lockfh,"$ENV{'user.environment'}")) { 303: return 'error: '.$!; 304: } 305: unless (flock($lockfh,LOCK_EX)) { 306: &logthis("WARNING: ". 307: 'Could not obtain exclusive lock in appenv: '.$!); 308: close($lockfh); 309: return 'error: '.$!; 310: } 311: 312: my @oldenv; 313: { 314: my $fh; 315: unless (open($fh,"$ENV{'user.environment'}")) { 316: return 'error: '.$!; 317: } 318: @oldenv=<$fh>; 319: close($fh); 320: } 321: for (my $i=0; $i<=$#oldenv; $i++) { 322: chomp($oldenv[$i]); 323: if ($oldenv[$i] ne '') { 324: my ($name,$value)=split(/=/,$oldenv[$i]); 325: unless (defined($newenv{$name})) { 326: $newenv{$name}=$value; 327: } 328: } 329: } 330: { 331: my $fh; 332: unless (open($fh,">$ENV{'user.environment'}")) { 333: return 'error'; 334: } 335: my $newname; 336: foreach $newname (keys %newenv) { 337: print $fh "$newname=$newenv{$newname}\n"; 338: } 339: close($fh); 340: } 341: 342: close($lockfh); 343: return 'ok'; 344: } 345: # ----------------------------------------------------- Delete from Environment 346: 347: sub delenv { 348: my $delthis=shift; 349: my %newenv=(); 350: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) { 351: &logthis("WARNING: ". 352: "Attempt to delete from environment ".$delthis); 353: return 'error'; 354: } 355: my @oldenv; 356: { 357: my $fh; 358: unless (open($fh,"$ENV{'user.environment'}")) { 359: return 'error'; 360: } 361: unless (flock($fh,LOCK_SH)) { 362: &logthis("WARNING: ". 363: 'Could not obtain shared lock in delenv: '.$!); 364: close($fh); 365: return 'error: '.$!; 366: } 367: @oldenv=<$fh>; 368: close($fh); 369: } 370: { 371: my $fh; 372: unless (open($fh,">$ENV{'user.environment'}")) { 373: return 'error'; 374: } 375: unless (flock($fh,LOCK_EX)) { 376: &logthis("WARNING: ". 377: 'Could not obtain exclusive lock in delenv: '.$!); 378: close($fh); 379: return 'error: '.$!; 380: } 381: foreach (@oldenv) { 382: if ($_=~/^$delthis/) { 383: my ($key,undef) = split('=',$_); 384: delete($ENV{$key}); 385: } else { 386: print $fh $_; 387: } 388: } 389: close($fh); 390: } 391: return 'ok'; 392: } 393: 394: # ------------------------------------------ Find out current server userload 395: # there is a copy in lond 396: sub userload { 397: my $numusers=0; 398: { 399: opendir(LONIDS,$perlvar{'lonIDsDir'}); 400: my $filename; 401: my $curtime=time; 402: while ($filename=readdir(LONIDS)) { 403: if ($filename eq '.' || $filename eq '..') {next;} 404: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9]; 405: if ($curtime-$mtime < 1800) { $numusers++; } 406: } 407: closedir(LONIDS); 408: } 409: my $userloadpercent=0; 410: my $maxuserload=$perlvar{'lonUserLoadLim'}; 411: if ($maxuserload) { 412: $userloadpercent=100*$numusers/$maxuserload; 413: } 414: $userloadpercent=sprintf("%.2f",$userloadpercent); 415: return $userloadpercent; 416: } 417: 418: # ------------------------------------------ Fight off request when overloaded 419: 420: sub overloaderror { 421: my ($r,$checkserver)=@_; 422: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; } 423: my $loadavg; 424: if ($checkserver eq $perlvar{'lonHostID'}) { 425: open(my $loadfile,'/proc/loadavg'); 426: $loadavg=<$loadfile>; 427: $loadavg =~ s/\s.*//g; 428: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'}; 429: close($loadfile); 430: } else { 431: $loadavg=&reply('load',$checkserver); 432: } 433: my $overload=$loadavg-100; 434: if ($overload>0) { 435: $r->err_headers_out->{'Retry-After'}=$overload; 436: $r->log_error('Overload of '.$overload.' on '.$checkserver); 437: return 409; 438: } 439: return ''; 440: } 441: 442: # ------------------------------ Find server with least workload from spare.tab 443: 444: sub spareserver { 445: my ($loadpercent,$userloadpercent) = @_; 446: my $tryserver; 447: my $spareserver=''; 448: if ($userloadpercent !~ /\d/) { $userloadpercent=0; } 449: my $lowestserver=$loadpercent > $userloadpercent? 450: $loadpercent : $userloadpercent; 451: foreach $tryserver (keys %spareid) { 452: my $loadans=reply('load',$tryserver); 453: my $userloadans=reply('userload',$tryserver); 454: if ($loadans !~ /\d/ && $userloadans !~ /\d/) { 455: next; #didn't get a number from the server 456: } 457: my $answer; 458: if ($loadans =~ /\d/) { 459: if ($userloadans =~ /\d/) { 460: #both are numbers, pick the bigger one 461: $answer=$loadans > $userloadans? 462: $loadans : $userloadans; 463: } else { 464: $answer = $loadans; 465: } 466: } else { 467: $answer = $userloadans; 468: } 469: if (($answer =~ /\d/) && ($answer<$lowestserver)) { 470: $spareserver="http://$hostname{$tryserver}"; 471: $lowestserver=$answer; 472: } 473: } 474: return $spareserver; 475: } 476: 477: # --------------------------------------------- Try to change a user's password 478: 479: sub changepass { 480: my ($uname,$udom,$currentpass,$newpass,$server)=@_; 481: $currentpass = &escape($currentpass); 482: $newpass = &escape($newpass); 483: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass", 484: $server); 485: if (! $answer) { 486: &logthis("No reply on password change request to $server ". 487: "by $uname in domain $udom."); 488: } elsif ($answer =~ "^ok") { 489: &logthis("$uname in $udom successfully changed their password ". 490: "on $server."); 491: } elsif ($answer =~ "^pwchange_failure") { 492: &logthis("$uname in $udom was unable to change their password ". 493: "on $server. The action was blocked by either lcpasswd ". 494: "or pwchange"); 495: } elsif ($answer =~ "^non_authorized") { 496: &logthis("$uname in $udom did not get their password correct when ". 497: "attempting to change it on $server."); 498: } elsif ($answer =~ "^auth_mode_error") { 499: &logthis("$uname in $udom attempted to change their password despite ". 500: "not being locally or internally authenticated on $server."); 501: } elsif ($answer =~ "^unknown_user") { 502: &logthis("$uname in $udom attempted to change their password ". 503: "on $server but were unable to because $server is not ". 504: "their home server."); 505: } elsif ($answer =~ "^refused") { 506: &logthis("$server refused to change $uname in $udom password because ". 507: "it was sent an unencrypted request to change the password."); 508: } 509: return $answer; 510: } 511: 512: # ----------------------- Try to determine user's current authentication scheme 513: 514: sub queryauthenticate { 515: my ($uname,$udom)=@_; 516: my $uhome=&homeserver($uname,$udom); 517: if (!$uhome) { 518: &logthis("User $uname at $udom is unknown when looking for authentication mechanism"); 519: return 'no_host'; 520: } 521: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome); 522: if ($answer =~ /^(unknown_user|refused|con_lost)/) { 523: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 524: } 525: return $answer; 526: } 527: 528: # --------- Try to authenticate user from domain's lib servers (first this one) 529: 530: sub authenticate { 531: my ($uname,$upass,$udom)=@_; 532: $upass=escape($upass); 533: $uname=~s/\W//g; 534: my $uhome=&homeserver($uname,$udom); 535: if (!$uhome) { 536: &logthis("User $uname at $udom is unknown in authenticate"); 537: return 'no_host'; 538: } 539: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome); 540: if ($answer eq 'authorized') { 541: &logthis("User $uname at $udom authorized by $uhome"); 542: return $uhome; 543: } 544: if ($answer eq 'non_authorized') { 545: &logthis("User $uname at $udom rejected by $uhome"); 546: return 'no_host'; 547: } 548: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 549: return 'no_host'; 550: } 551: 552: # ---------------------- Find the homebase for a user from domain's lib servers 553: 554: sub homeserver { 555: my ($uname,$udom,$ignoreBadCache)=@_; 556: my $index="$uname:$udom"; 557: 558: my ($result,$cached)=&is_cached(\%homecache,$index,'home',86400); 559: if (defined($cached)) { return $result; } 560: my $tryserver; 561: foreach $tryserver (keys %libserv) { 562: next if ($ignoreBadCache ne 'true' && 563: exists($badServerCache{$tryserver})); 564: if ($hostdom{$tryserver} eq $udom) { 565: my $answer=reply("home:$udom:$uname",$tryserver); 566: if ($answer eq 'found') { 567: return &do_cache(\%homecache,$index,$tryserver,'home'); 568: } elsif ($answer eq 'no_host') { 569: $badServerCache{$tryserver}=1; 570: } 571: } 572: } 573: return 'no_host'; 574: } 575: 576: # ------------------------------------- Find the usernames behind a list of IDs 577: 578: sub idget { 579: my ($udom,@ids)=@_; 580: my %returnhash=(); 581: 582: my $tryserver; 583: foreach $tryserver (keys %libserv) { 584: if ($hostdom{$tryserver} eq $udom) { 585: my $idlist=join('&',@ids); 586: $idlist=~tr/A-Z/a-z/; 587: my $reply=&reply("idget:$udom:".$idlist,$tryserver); 588: my @answer=(); 589: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) { 590: @answer=split(/\&/,$reply); 591: } ; 592: my $i; 593: for ($i=0;$i<=$#ids;$i++) { 594: if ($answer[$i]) { 595: $returnhash{$ids[$i]}=$answer[$i]; 596: } 597: } 598: } 599: } 600: return %returnhash; 601: } 602: 603: # ------------------------------------- Find the IDs behind a list of usernames 604: 605: sub idrget { 606: my ($udom,@unames)=@_; 607: my %returnhash=(); 608: foreach (@unames) { 609: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1]; 610: } 611: return %returnhash; 612: } 613: 614: # ------------------------------- Store away a list of names and associated IDs 615: 616: sub idput { 617: my ($udom,%ids)=@_; 618: my %servers=(); 619: foreach (keys %ids) { 620: &cput('environment',{'id'=>$ids{$_}},$udom,$_); 621: my $uhom=&homeserver($_,$udom); 622: if ($uhom ne 'no_host') { 623: my $id=&escape($ids{$_}); 624: $id=~tr/A-Z/a-z/; 625: my $unam=&escape($_); 626: if ($servers{$uhom}) { 627: $servers{$uhom}.='&'.$id.'='.$unam; 628: } else { 629: $servers{$uhom}=$id.'='.$unam; 630: } 631: } 632: } 633: foreach (keys %servers) { 634: &critical('idput:'.$udom.':'.$servers{$_},$_); 635: } 636: } 637: 638: # --------------------------------------------------- Assign a key to a student 639: 640: sub assign_access_key { 641: # 642: # a valid key looks like uname:udom#comments 643: # comments are being appended 644: # 645: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_; 646: $kdom= 647: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($kdom)); 648: $knum= 649: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($knum)); 650: $cdom= 651: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom)); 652: $cnum= 653: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum)); 654: $udom=$ENV{'user.name'} unless (defined($udom)); 655: $uname=$ENV{'user.domain'} unless (defined($uname)); 656: my %existing=&get('accesskeys',[$ckey],$kdom,$knum); 657: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key 658: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 659: # assigned to this person 660: # - this should not happen, 661: # unless something went wrong 662: # the first time around 663: # ready to assign 664: $logentry=$1.'; '.$logentry; 665: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry}, 666: $kdom,$knum) eq 'ok') { 667: # key now belongs to user 668: my $envkey='key.'.$cdom.'_'.$cnum; 669: if (&put('environment',{$envkey => $ckey}) eq 'ok') { 670: &appenv('environment.'.$envkey => $ckey); 671: return 'ok'; 672: } else { 673: return 674: 'error: Count not permanently assign key, will need to be re-entered later.'; 675: } 676: } else { 677: return 'error: Could not assign key, try again later.'; 678: } 679: } elsif (!$existing{$ckey}) { 680: # the key does not exist 681: return 'error: The key does not exist'; 682: } else { 683: # the key is somebody else's 684: return 'error: The key is already in use'; 685: } 686: } 687: 688: # ------------------------------------------ put an additional comment on a key 689: 690: sub comment_access_key { 691: # 692: # a valid key looks like uname:udom#comments 693: # comments are being appended 694: # 695: my ($ckey,$cdom,$cnum,$logentry)=@_; 696: $cdom= 697: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom)); 698: $cnum= 699: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum)); 700: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 701: if ($existing{$ckey}) { 702: $existing{$ckey}.='; '.$logentry; 703: # ready to assign 704: if (&put('accesskeys',{$ckey=>$existing{$ckey}}, 705: $cdom,$cnum) eq 'ok') { 706: return 'ok'; 707: } else { 708: return 'error: Count not store comment.'; 709: } 710: } else { 711: # the key does not exist 712: return 'error: The key does not exist'; 713: } 714: } 715: 716: # ------------------------------------------------------ Generate a set of keys 717: 718: sub generate_access_keys { 719: my ($number,$cdom,$cnum,$logentry)=@_; 720: $cdom= 721: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom)); 722: $cnum= 723: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum)); 724: unless (&allowed('mky',$cdom)) { return 0; } 725: unless (($cdom) && ($cnum)) { return 0; } 726: if ($number>10000) { return 0; } 727: sleep(2); # make sure don't get same seed twice 728: srand(time()^($$+($$<<15))); # from "Programming Perl" 729: my $total=0; 730: for (my $i=1;$i<=$number;$i++) { 731: my $newkey=sprintf("%lx",int(100000*rand)).'-'. 732: sprintf("%lx",int(100000*rand)).'-'. 733: sprintf("%lx",int(100000*rand)); 734: $newkey=~s/1/g/g; # folks mix up 1 and l 735: $newkey=~s/0/h/g; # and also 0 and O 736: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum); 737: if ($existing{$newkey}) { 738: $i--; 739: } else { 740: if (&put('accesskeys', 741: { $newkey => '# generated '.localtime(). 742: ' by '.$ENV{'user.name'}.'@'.$ENV{'user.domain'}. 743: '; '.$logentry }, 744: $cdom,$cnum) eq 'ok') { 745: $total++; 746: } 747: } 748: } 749: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'}, 750: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom); 751: return $total; 752: } 753: 754: # ------------------------------------------------------- Validate an accesskey 755: 756: sub validate_access_key { 757: my ($ckey,$cdom,$cnum,$udom,$uname)=@_; 758: $cdom= 759: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'} unless (defined($cdom)); 760: $cnum= 761: $ENV{'course.'.$ENV{'request.course.id'}.'.num'} unless (defined($cnum)); 762: $udom=$ENV{'user.domain'} unless (defined($udom)); 763: $uname=$ENV{'user.name'} unless (defined($uname)); 764: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 765: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/); 766: } 767: 768: # ------------------------------------- Find the section of student in a course 769: 770: sub getsection { 771: my ($udom,$unam,$courseid)=@_; 772: $courseid=~s/\_/\//g; 773: $courseid=~s/^(\w)/\/$1/; 774: my %Pending; 775: my %Expired; 776: # 777: # Each role can either have not started yet (pending), be active, 778: # or have expired. 779: # 780: # If there is an active role, we are done. 781: # 782: # If there is more than one role which has not started yet, 783: # choose the one which will start sooner 784: # If there is one role which has not started yet, return it. 785: # 786: # If there is more than one expired role, choose the one which ended last. 787: # If there is a role which has expired, return it. 788: # 789: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles', 790: &homeserver($unam,$udom)))) { 791: my ($key,$value)=split(/\=/,$_); 792: $key=&unescape($key); 793: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/); 794: my $section=$1; 795: if ($key eq $courseid.'_st') { $section=''; } 796: my ($dummy,$end,$start)=split(/\_/,&unescape($value)); 797: my $now=time; 798: if (defined($end) && ($now > $end)) { 799: $Expired{$end}=$section; 800: next; 801: } 802: if (defined($start) && ($now < $start)) { 803: $Pending{$start}=$section; 804: next; 805: } 806: return $section; 807: } 808: # 809: # Presumedly there will be few matching roles from the above 810: # loop and the sorting time will be negligible. 811: if (scalar(keys(%Pending))) { 812: my ($time) = sort {$a <=> $b} keys(%Pending); 813: return $Pending{$time}; 814: } 815: if (scalar(keys(%Expired))) { 816: my @sorted = sort {$a <=> $b} keys(%Expired); 817: my $time = pop(@sorted); 818: return $Expired{$time}; 819: } 820: return '-1'; 821: } 822: 823: 824: my $disk_caching_disabled=1; 825: 826: sub devalidate_cache { 827: my ($cache,$id,$name) = @_; 828: delete $$cache{$id.'.time'}; 829: delete $$cache{$id}; 830: if ($disk_caching_disabled) { return; } 831: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db"; 832: open(DB,"$filename.lock"); 833: flock(DB,LOCK_EX); 834: my %hash; 835: if (tie(%hash,'GDBM_File',$filename,&GDBM_WRCREAT(),0640)) { 836: eval <<'EVALBLOCK'; 837: delete($hash{$id}); 838: delete($hash{$id.'.time'}); 839: EVALBLOCK 840: if ($@) { 841: &logthis("devalidate_cache blew up :$@:$name"); 842: unlink($filename); 843: } 844: } else { 845: if (-e $filename) { 846: &logthis("Unable to tie hash (devalidate cache): $name"); 847: unlink($filename); 848: } 849: } 850: untie(%hash); 851: flock(DB,LOCK_UN); 852: close(DB); 853: } 854: 855: sub is_cached { 856: my ($cache,$id,$name,$time) = @_; 857: if (!$time) { $time=300; } 858: if (!exists($$cache{$id.'.time'})) { 859: &load_cache_item($cache,$name,$id); 860: } 861: if (!exists($$cache{$id.'.time'})) { 862: # &logthis("Didn't find $id"); 863: return (undef,undef); 864: } else { 865: if (time-($$cache{$id.'.time'})>$time) { 866: # &logthis("Devalidating $id - ".time-($$cache{$id.'.time'})); 867: &devalidate_cache($cache,$id,$name); 868: return (undef,undef); 869: } 870: } 871: return ($$cache{$id},1); 872: } 873: 874: sub do_cache { 875: my ($cache,$id,$value,$name) = @_; 876: $$cache{$id.'.time'}=time; 877: $$cache{$id}=$value; 878: # &logthis("Caching $id as :$value:"); 879: &save_cache_item($cache,$name,$id); 880: # do_cache implictly return the set value 881: $$cache{$id}; 882: } 883: 884: sub save_cache_item { 885: my ($cache,$name,$id)=@_; 886: if ($disk_caching_disabled) { return; } 887: my $starttime=&Time::HiRes::time(); 888: # &logthis("Saving :$name:$id"); 889: my %hash; 890: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db"; 891: open(DB,"$filename.lock"); 892: flock(DB,LOCK_EX); 893: if (tie(%hash,'GDBM_File',$filename,&GDBM_WRCREAT(),0640)) { 894: eval <<'EVALBLOCK'; 895: $hash{$id.'.time'}=$$cache{$id.'.time'}; 896: $hash{$id}=freeze({'item'=>$$cache{$id}}); 897: EVALBLOCK 898: if ($@) { 899: &logthis("save_cache blew up :$@:$name"); 900: unlink($filename); 901: } 902: } else { 903: if (-e $filename) { 904: &logthis("Unable to tie hash (save cache item): $name ($!)"); 905: unlink($filename); 906: } 907: } 908: untie(%hash); 909: flock(DB,LOCK_UN); 910: close(DB); 911: # &logthis("save_cache_item $name took ".(&Time::HiRes::time()-$starttime)); 912: } 913: 914: sub load_cache_item { 915: my ($cache,$name,$id)=@_; 916: if ($disk_caching_disabled) { return; } 917: my $starttime=&Time::HiRes::time(); 918: # &logthis("Before Loading $name for $id size is ".scalar(%$cache)); 919: my %hash; 920: my $filename=$perlvar{'lonDaemons'}.'/tmp/lonnet_internal_cache_'.$name.".db"; 921: open(DB,"$filename.lock"); 922: flock(DB,LOCK_SH); 923: if (tie(%hash,'GDBM_File',$filename,&GDBM_READER(),0640)) { 924: eval <<'EVALBLOCK'; 925: if (!%$cache) { 926: my $count; 927: while (my ($key,$value)=each(%hash)) { 928: $count++; 929: if ($key =~ /\.time$/) { 930: $$cache{$key}=$value; 931: } else { 932: my $hashref=thaw($value); 933: $$cache{$key}=$hashref->{'item'}; 934: } 935: } 936: # &logthis("Initial load: $count"); 937: } else { 938: my $hashref=thaw($hash{$id}); 939: $$cache{$id}=$hashref->{'item'}; 940: $$cache{$id.'.time'}=$hash{$id.'.time'}; 941: } 942: EVALBLOCK 943: if ($@) { 944: &logthis("load_cache blew up :$@:$name"); 945: unlink($filename); 946: } 947: } else { 948: if (-e $filename) { 949: &logthis("Unable to tie hash (load cache item): $name ($!)"); 950: unlink($filename); 951: } 952: } 953: untie(%hash); 954: flock(DB,LOCK_UN); 955: close(DB); 956: # &logthis("After Loading $name size is ".scalar(%$cache)); 957: # &logthis("load_cache_item $name took ".(&Time::HiRes::time()-$starttime)); 958: } 959: 960: sub usection { 961: my ($udom,$unam,$courseid)=@_; 962: my $hashid="$udom:$unam:$courseid"; 963: 964: my ($result,$cached)=&is_cached(\%usectioncache,$hashid,'usection'); 965: if (defined($cached)) { return $result; } 966: $courseid=~s/\_/\//g; 967: $courseid=~s/^(\w)/\/$1/; 968: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles', 969: &homeserver($unam,$udom)))) { 970: my ($key,$value)=split(/\=/,$_); 971: $key=&unescape($key); 972: if ($key=~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/) { 973: my $section=$1; 974: if ($key eq $courseid.'_st') { $section=''; } 975: my ($dummy,$end,$start)=split(/\_/,&unescape($value)); 976: my $now=time; 977: my $notactive=0; 978: if ($start) { 979: if ($now<$start) { $notactive=1; } 980: } 981: if ($end) { 982: if ($now>$end) { $notactive=1; } 983: } 984: unless ($notactive) { 985: return &do_cache(\%usectioncache,$hashid,$section,'usection'); 986: } 987: } 988: } 989: return &do_cache(\%usectioncache,$hashid,'-1','usection'); 990: } 991: 992: # ------------------------------------- Read an entry from a user's environment 993: 994: sub userenvironment { 995: my ($udom,$unam,@what)=@_; 996: my %returnhash=(); 997: my @answer=split(/\&/, 998: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what), 999: &homeserver($unam,$udom))); 1000: my $i; 1001: for ($i=0;$i<=$#what;$i++) { 1002: $returnhash{$what[$i]}=&unescape($answer[$i]); 1003: } 1004: return %returnhash; 1005: } 1006: 1007: # -------------------------------------------------------------------- New chat 1008: 1009: sub chatsend { 1010: my ($newentry,$anon)=@_; 1011: my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'}; 1012: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; 1013: my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'}; 1014: &reply('chatsend:'.$cdom.':'.$cnum.':'. 1015: &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'. 1016: &escape($newentry)),$chome); 1017: } 1018: 1019: # ------------------------------------------ Find current version of a resource 1020: 1021: sub getversion { 1022: my $fname=&clutter(shift); 1023: unless ($fname=~/^\/res\//) { return -1; } 1024: return &currentversion(&filelocation('',$fname)); 1025: } 1026: 1027: sub currentversion { 1028: my $fname=shift; 1029: my ($result,$cached)=&is_cached(\%resversioncache,$fname,'resversion',600); 1030: if (defined($cached)) { return $result; } 1031: my $author=$fname; 1032: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1033: my ($udom,$uname)=split(/\//,$author); 1034: my $home=homeserver($uname,$udom); 1035: if ($home eq 'no_host') { 1036: return -1; 1037: } 1038: my $answer=reply("currentversion:$fname",$home); 1039: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 1040: return -1; 1041: } 1042: return &do_cache(\%resversioncache,$fname,$answer,'resversion'); 1043: } 1044: 1045: # ----------------------------- Subscribe to a resource, return URL if possible 1046: 1047: sub subscribe { 1048: my $fname=shift; 1049: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; } 1050: my $author=$fname; 1051: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1052: my ($udom,$uname)=split(/\//,$author); 1053: my $home=homeserver($uname,$udom); 1054: if ($home eq 'no_host') { 1055: return 'not_found'; 1056: } 1057: my $answer=reply("sub:$fname",$home); 1058: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 1059: $answer.=' by '.$home; 1060: } 1061: return $answer; 1062: } 1063: 1064: # -------------------------------------------------------------- Replicate file 1065: 1066: sub repcopy { 1067: my $filename=shift; 1068: $filename=~s/\/+/\//g; 1069: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; } 1070: my $transname="$filename.in.transfer"; 1071: if ((-e $filename) || (-e $transname)) { return OK; } 1072: my $remoteurl=subscribe($filename); 1073: if ($remoteurl =~ /^con_lost by/) { 1074: &logthis("Subscribe returned $remoteurl: $filename"); 1075: return HTTP_SERVICE_UNAVAILABLE; 1076: } elsif ($remoteurl eq 'not_found') { 1077: #&logthis("Subscribe returned not_found: $filename"); 1078: return HTTP_NOT_FOUND; 1079: } elsif ($remoteurl =~ /^rejected by/) { 1080: &logthis("Subscribe returned $remoteurl: $filename"); 1081: return FORBIDDEN; 1082: } elsif ($remoteurl eq 'directory') { 1083: return OK; 1084: } else { 1085: my $author=$filename; 1086: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1087: my ($udom,$uname)=split(/\//,$author); 1088: my $home=homeserver($uname,$udom); 1089: unless ($home eq $perlvar{'lonHostID'}) { 1090: my @parts=split(/\//,$filename); 1091: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]"; 1092: if ($path ne "$perlvar{'lonDocRoot'}/res") { 1093: &logthis("Malconfiguration for replication: $filename"); 1094: return HTTP_BAD_REQUEST; 1095: } 1096: my $count; 1097: for ($count=5;$count<$#parts;$count++) { 1098: $path.="/$parts[$count]"; 1099: if ((-e $path)!=1) { 1100: mkdir($path,0777); 1101: } 1102: } 1103: my $ua=new LWP::UserAgent; 1104: my $request=new HTTP::Request('GET',"$remoteurl"); 1105: my $response=$ua->request($request,$transname); 1106: if ($response->is_error()) { 1107: unlink($transname); 1108: my $message=$response->status_line; 1109: &logthis("WARNING:" 1110: ." LWP get: $message: $filename"); 1111: return HTTP_SERVICE_UNAVAILABLE; 1112: } else { 1113: if ($remoteurl!~/\.meta$/) { 1114: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta'); 1115: my $mresponse=$ua->request($mrequest,$filename.'.meta'); 1116: if ($mresponse->is_error()) { 1117: unlink($filename.'.meta'); 1118: &logthis( 1119: "INFO: No metadata: $filename"); 1120: } 1121: } 1122: rename($transname,$filename); 1123: return OK; 1124: } 1125: } 1126: } 1127: } 1128: 1129: # ------------------------------------------------ Get server side include body 1130: sub ssi_body { 1131: my ($filelink,%form)=@_; 1132: my $output=($filelink=~/^http\:/?&externalssi($filelink): 1133: &ssi($filelink,%form)); 1134: $output=~s/^.*?\<body[^\>]*\>//si; 1135: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si; 1136: $output=~ 1137: s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs; 1138: return $output; 1139: } 1140: 1141: # --------------------------------------------------------- Server Side Include 1142: 1143: sub ssi { 1144: 1145: my ($fn,%form)=@_; 1146: 1147: my $ua=new LWP::UserAgent; 1148: 1149: my $request; 1150: 1151: if (%form) { 1152: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn); 1153: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form)); 1154: } else { 1155: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn); 1156: } 1157: 1158: $request->header(Cookie => $ENV{'HTTP_COOKIE'}); 1159: my $response=$ua->request($request); 1160: 1161: return $response->content; 1162: } 1163: 1164: sub externalssi { 1165: my ($url)=@_; 1166: my $ua=new LWP::UserAgent; 1167: my $request=new HTTP::Request('GET',$url); 1168: my $response=$ua->request($request); 1169: return $response->content; 1170: } 1171: 1172: # -------------------------------- Allow a /uploaded/ URI to be vouched for 1173: 1174: sub allowuploaded { 1175: my ($srcurl,$url)=@_; 1176: $url=&clutter(&declutter($url)); 1177: my $dir=$url; 1178: $dir=~s/\/[^\/]+$//; 1179: my %httpref=(); 1180: my $httpurl=&hreflocation('',$url); 1181: $httpref{'httpref.'.$httpurl}=$srcurl; 1182: &Apache::lonnet::appenv(%httpref); 1183: } 1184: 1185: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course 1186: # input: action, courseID, current domain, home server for course, intended 1187: # path to file, source of file. 1188: # output: url to file (if action was uploaddoc), 1189: # ok if successful, or diagnostic message otherwise (if action was propagate or copy) 1190: # 1191: # Allows directory structure to be used within lonUsers/../userfiles/ for a 1192: # course. 1193: # 1194: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 1195: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in 1196: # course's home server. 1197: # 1198: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will 1199: # be copied from $source (current location) to 1200: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 1201: # and will then be copied to 1202: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in 1203: # course's home server. 1204: # 1205: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 1206: # will be retrived from $ENV{form.uploaddoc} (from DOCS interface) to 1207: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 1208: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file 1209: # in course's home server. 1210: 1211: 1212: sub process_coursefile { 1213: my ($action,$docuname,$docudom,$docuhome,$file,$source)=@_; 1214: my $fetchresult; 1215: if ($action eq 'propagate') { 1216: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file 1217: ,$docuhome); 1218: } else { 1219: my $fetchresult = ''; 1220: my $fpath = ''; 1221: my $fname = $file; 1222: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 1223: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 1224: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles'; 1225: unless ($fpath eq '') { 1226: my @parts=split('/',$fpath); 1227: foreach my $part (@parts) { 1228: $filepath.= '/'.$part; 1229: if ((-e $filepath)!=1) { 1230: mkdir($filepath,0777); 1231: } 1232: } 1233: } 1234: if ($action eq 'copy') { 1235: if ($source eq '') { 1236: $fetchresult = 'no source file'; 1237: return $fetchresult; 1238: } else { 1239: my $destination = $filepath.'/'.$fname; 1240: rename($source,$destination); 1241: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 1242: $docuhome); 1243: } 1244: } elsif ($action eq 'uploaddoc') { 1245: open(my $fh,'>'.$filepath.'/'.$fname); 1246: print $fh $ENV{'form.'.$source}; 1247: close($fh); 1248: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 1249: $docuhome); 1250: if ($fetchresult eq 'ok') { 1251: return '/uploaded/'.$fpath.'/'.$fname; 1252: } else { 1253: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 1254: ' to host '.$docuhome.': '.$fetchresult); 1255: return '/adm/notfound.html'; 1256: } 1257: } 1258: } 1259: unless ( $fetchresult eq 'ok') { 1260: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 1261: ' to host '.$docuhome.': '.$fetchresult); 1262: } 1263: return $fetchresult; 1264: } 1265: 1266: # --------------- Take an uploaded file and put it into the userfiles directory 1267: # input: name of form element, coursedoc=1 means this is for the course 1268: # output: url of file in userspace 1269: 1270: sub userfileupload { 1271: my ($formname,$coursedoc,$subdir)=@_; 1272: if (!defined($subdir)) { $subdir='unknown'; } 1273: my $fname=$ENV{'form.'.$formname.'.filename'}; 1274: # Replace Windows backslashes by forward slashes 1275: $fname=~s/\\/\//g; 1276: # Get rid of everything but the actual filename 1277: $fname=~s/^.*\/([^\/]+)$/$1/; 1278: # Replace spaces by underscores 1279: $fname=~s/\s+/\_/g; 1280: # Replace all other weird characters by nothing 1281: $fname=~s/[^\w\.\-]//g; 1282: # See if there is anything left 1283: unless ($fname) { return 'error: no uploaded file'; } 1284: chop($ENV{'form.'.$formname}); 1285: # Create the directory if not present 1286: my $docuname=''; 1287: my $docudom=''; 1288: my $docuhome=''; 1289: $fname="$subdir/$fname"; 1290: if ($coursedoc) { 1291: $docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'}; 1292: $docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; 1293: $docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'}; 1294: if ($ENV{'form.folder'} =~ m/^default/) { 1295: return &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname); 1296: } else { 1297: $fname=$ENV{'form.folder'}.'/'.$fname; 1298: return &process_coursefile('uploaddoc',$docuname,$docudom,$docuhome,$fname,$formname); 1299: } 1300: } else { 1301: $docuname=$ENV{'user.name'}; 1302: $docudom=$ENV{'user.domain'}; 1303: $docuhome=$ENV{'user.home'}; 1304: return &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname); 1305: } 1306: } 1307: 1308: sub finishuserfileupload { 1309: my ($docuname,$docudom,$docuhome,$formname,$fname)=@_; 1310: my $path=$docudom.'/'.$docuname.'/'; 1311: my $filepath=$perlvar{'lonDocRoot'}; 1312: my ($fnamepath,$file); 1313: $file=$fname; 1314: if ($fname=~m|/|) { 1315: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|); 1316: $path.=$fnamepath.'/'; 1317: } 1318: my @parts=split(/\//,$filepath.'/userfiles/'.$path); 1319: my $count; 1320: for ($count=4;$count<=$#parts;$count++) { 1321: $filepath.="/$parts[$count]"; 1322: if ((-e $filepath)!=1) { 1323: mkdir($filepath,0777); 1324: } 1325: } 1326: # Save the file 1327: { 1328: #&Apache::lonnet::logthis("Saving to $filepath $file"); 1329: open(my $fh,'>'.$filepath.'/'.$file); 1330: print $fh $ENV{'form.'.$formname}; 1331: close($fh); 1332: } 1333: # Notify homeserver to grep it 1334: # 1335: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome); 1336: if ($fetchresult eq 'ok') { 1337: # 1338: # Return the URL to it 1339: return '/uploaded/'.$path.$file; 1340: } else { 1341: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome. 1342: ': '.$fetchresult); 1343: return '/adm/notfound.html'; 1344: } 1345: } 1346: 1347: sub removeuploadedurl { 1348: my ($url)=@_; 1349: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5); 1350: return &Apache::lonnet::removeuserfile($uname,$udom,$fname); 1351: } 1352: 1353: sub removeuserfile { 1354: my ($docuname,$docudom,$fname)=@_; 1355: my $home=&homeserver($docuname,$docudom); 1356: return &reply("removeuserfile:$docudom/$docuname/$fname",$home); 1357: } 1358: 1359: # ------------------------------------------------------------------------- Log 1360: 1361: sub log { 1362: my ($dom,$nam,$hom,$what)=@_; 1363: return critical("log:$dom:$nam:$what",$hom); 1364: } 1365: 1366: # ------------------------------------------------------------------ Course Log 1367: # 1368: # This routine flushes several buffers of non-mission-critical nature 1369: # 1370: 1371: sub flushcourselogs { 1372: &logthis('Flushing log buffers'); 1373: # 1374: # course logs 1375: # This is a log of all transactions in a course, which can be used 1376: # for data mining purposes 1377: # 1378: # It also collects the courseid database, which lists last transaction 1379: # times and course titles for all courseids 1380: # 1381: my %courseidbuffer=(); 1382: foreach (keys %courselogs) { 1383: my $crsid=$_; 1384: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'. 1385: &escape($courselogs{$crsid}), 1386: $coursehombuf{$crsid}) eq 'ok') { 1387: delete $courselogs{$crsid}; 1388: } else { 1389: &logthis('Failed to flush log buffer for '.$crsid); 1390: if (length($courselogs{$crsid})>40000) { 1391: &logthis("WARNING: Buffer for ".$crsid. 1392: " exceeded maximum size, deleting."); 1393: delete $courselogs{$crsid}; 1394: } 1395: } 1396: if ($courseidbuffer{$coursehombuf{$crsid}}) { 1397: $courseidbuffer{$coursehombuf{$crsid}}.='&'. 1398: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}); 1399: } else { 1400: $courseidbuffer{$coursehombuf{$crsid}}= 1401: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}); 1402: } 1403: } 1404: # 1405: # Write course id database (reverse lookup) to homeserver of courses 1406: # Is used in pickcourse 1407: # 1408: foreach (keys %courseidbuffer) { 1409: &courseidput($hostdom{$_},$courseidbuffer{$_},$_); 1410: } 1411: # 1412: # File accesses 1413: # Writes to the dynamic metadata of resources to get hit counts, etc. 1414: # 1415: foreach my $entry (keys(%accesshash)) { 1416: if ($entry =~ /___count$/) { 1417: my ($dom,$name); 1418: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:); 1419: if (! defined($dom) || $dom eq '' || 1420: ! defined($name) || $name eq '') { 1421: my $cid = $ENV{'request.course.id'}; 1422: $dom = $ENV{'request.'.$cid.'.domain'}; 1423: $name = $ENV{'request.'.$cid.'.num'}; 1424: } 1425: my $value = $accesshash{$entry}; 1426: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/); 1427: my %temphash=($url => $value); 1428: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name); 1429: if ($result eq 'ok') { 1430: delete $accesshash{$entry}; 1431: } elsif ($result eq 'unknown_cmd') { 1432: # Target server has old code running on it. 1433: my %temphash=($entry => $value); 1434: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 1435: delete $accesshash{$entry}; 1436: } 1437: } 1438: } else { 1439: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:); 1440: my %temphash=($entry => $accesshash{$entry}); 1441: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 1442: delete $accesshash{$entry}; 1443: } 1444: } 1445: } 1446: # 1447: # Roles 1448: # Reverse lookup of user roles for course faculty/staff and co-authorship 1449: # 1450: foreach (keys %userrolehash) { 1451: my $entry=$_; 1452: my ($role,$uname,$udom,$runame,$rudom,$rsec)= 1453: split(/\:/,$entry); 1454: if (&Apache::lonnet::put('nohist_userroles', 1455: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} }, 1456: $rudom,$runame) eq 'ok') { 1457: delete $userrolehash{$entry}; 1458: } 1459: } 1460: $dumpcount++; 1461: } 1462: 1463: sub courselog { 1464: my $what=shift; 1465: $what=time.':'.$what; 1466: unless ($ENV{'request.course.id'}) { return ''; } 1467: $coursedombuf{$ENV{'request.course.id'}}= 1468: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; 1469: $coursenumbuf{$ENV{'request.course.id'}}= 1470: $ENV{'course.'.$ENV{'request.course.id'}.'.num'}; 1471: $coursehombuf{$ENV{'request.course.id'}}= 1472: $ENV{'course.'.$ENV{'request.course.id'}.'.home'}; 1473: $coursedescrbuf{$ENV{'request.course.id'}}= 1474: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; 1475: if (defined $courselogs{$ENV{'request.course.id'}}) { 1476: $courselogs{$ENV{'request.course.id'}}.='&'.$what; 1477: } else { 1478: $courselogs{$ENV{'request.course.id'}}.=$what; 1479: } 1480: if (length($courselogs{$ENV{'request.course.id'}})>4048) { 1481: &flushcourselogs(); 1482: } 1483: } 1484: 1485: sub courseacclog { 1486: my $fnsymb=shift; 1487: unless ($ENV{'request.course.id'}) { return ''; } 1488: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'}; 1489: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|page)$/) { 1490: $what.=':POST'; 1491: foreach (keys %ENV) { 1492: if ($_=~/^form\.(.*)/) { 1493: $what.=':'.$1.'='.$ENV{$_}; 1494: } 1495: } 1496: } 1497: &courselog($what); 1498: } 1499: 1500: sub countacc { 1501: my $url=&declutter(shift); 1502: return if (! defined($url) || $url eq ''); 1503: unless ($ENV{'request.course.id'}) { return ''; } 1504: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1; 1505: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count'; 1506: $accesshash{$key}++; 1507: } 1508: 1509: sub linklog { 1510: my ($from,$to)=@_; 1511: $from=&declutter($from); 1512: $to=&declutter($to); 1513: $accesshash{$from.'___'.$to.'___comefrom'}=1; 1514: $accesshash{$to.'___'.$from.'___goto'}=1; 1515: } 1516: 1517: sub userrolelog { 1518: my ($trole,$username,$domain,$area,$tstart,$tend)=@_; 1519: if (($trole=~/^ca/) || ($trole=~/^in/) || 1520: ($trole=~/^cc/) || ($trole=~/^ep/) || 1521: ($trole=~/^cr/) || ($trole=~/^ta/)) { 1522: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 1523: $userrolehash 1524: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 1525: =$tend.':'.$tstart; 1526: } 1527: } 1528: 1529: sub get_course_adv_roles { 1530: my $cid=shift; 1531: $cid=$ENV{'request.course.id'} unless (defined($cid)); 1532: my %coursehash=&coursedescription($cid); 1533: my %nothide=(); 1534: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 1535: $nothide{join(':',split(/[\@\:]/,$_))}=1; 1536: } 1537: my %returnhash=(); 1538: my %dumphash= 1539: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'}); 1540: my $now=time; 1541: foreach (keys %dumphash) { 1542: my ($tend,$tstart)=split(/\:/,$dumphash{$_}); 1543: if (($tstart) && ($tstart<0)) { next; } 1544: if (($tend) && ($tend<$now)) { next; } 1545: if (($tstart) && ($now<$tstart)) { next; } 1546: my ($role,$username,$domain,$section)=split(/\:/,$_); 1547: if ((&privileged($username,$domain)) && 1548: (!$nothide{$username.':'.$domain})) { next; } 1549: my $key=&plaintext($role); 1550: if ($section) { $key.=' (Sec/Grp '.$section.')'; } 1551: if ($returnhash{$key}) { 1552: $returnhash{$key}.=','.$username.':'.$domain; 1553: } else { 1554: $returnhash{$key}=$username.':'.$domain; 1555: } 1556: } 1557: return %returnhash; 1558: } 1559: 1560: sub get_my_roles { 1561: my ($uname,$udom)=@_; 1562: unless (defined($uname)) { $uname=$ENV{'user.name'}; } 1563: unless (defined($udom)) { $udom=$ENV{'user.domain'}; } 1564: my %dumphash= 1565: &dump('nohist_userroles',$udom,$uname); 1566: my %returnhash=(); 1567: my $now=time; 1568: foreach (keys %dumphash) { 1569: my ($tend,$tstart)=split(/\:/,$dumphash{$_}); 1570: if (($tstart) && ($tstart<0)) { next; } 1571: if (($tend) && ($tend<$now)) { next; } 1572: if (($tstart) && ($now<$tstart)) { next; } 1573: my ($role,$username,$domain,$section)=split(/\:/,$_); 1574: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend; 1575: } 1576: return %returnhash; 1577: } 1578: 1579: # ----------------------------------------------------- Frontpage Announcements 1580: # 1581: # 1582: 1583: sub postannounce { 1584: my ($server,$text)=@_; 1585: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; } 1586: unless ($text=~/\w/) { $text=''; } 1587: return &reply('setannounce:'.&escape($text),$server); 1588: } 1589: 1590: sub getannounce { 1591: 1592: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) { 1593: my $announcement=''; 1594: while (<$fh>) { $announcement .=$_; } 1595: close($fh); 1596: if ($announcement=~/\w/) { 1597: return 1598: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'. 1599: '<tr><td bgcolor="#FFFFFF"><pre>'.$announcement.'</pre></td></tr></table>'; 1600: } else { 1601: return ''; 1602: } 1603: } else { 1604: return ''; 1605: } 1606: } 1607: 1608: # ---------------------------------------------------------- Course ID routines 1609: # Deal with domain's nohist_courseid.db files 1610: # 1611: 1612: sub courseidput { 1613: my ($domain,$what,$coursehome)=@_; 1614: return &reply('courseidput:'.$domain.':'.$what,$coursehome); 1615: } 1616: 1617: sub courseiddump { 1618: my ($domfilter,$descfilter,$sincefilter)=@_; 1619: my %returnhash=(); 1620: unless ($domfilter) { $domfilter=''; } 1621: foreach my $tryserver (keys %libserv) { 1622: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) { 1623: foreach ( 1624: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'. 1625: $sincefilter.':'.&escape($descfilter), 1626: $tryserver))) { 1627: my ($key,$value)=split(/\=/,$_); 1628: if (($key) && ($value)) { 1629: $returnhash{&unescape($key)}=&unescape($value); 1630: } 1631: } 1632: 1633: } 1634: } 1635: return %returnhash; 1636: } 1637: 1638: # 1639: # ----------------------------------------------------------- Check out an item 1640: 1641: sub checkout { 1642: my ($symb,$tuname,$tudom,$tcrsid)=@_; 1643: my $now=time; 1644: my $lonhost=$perlvar{'lonHostID'}; 1645: my $infostr=&escape( 1646: 'CHECKOUTTOKEN&'. 1647: $tuname.'&'. 1648: $tudom.'&'. 1649: $tcrsid.'&'. 1650: $symb.'&'. 1651: $now.'&'.$ENV{'REMOTE_ADDR'}); 1652: my $token=&reply('tmpput:'.$infostr,$lonhost); 1653: if ($token=~/^error\:/) { 1654: &logthis("WARNING: ". 1655: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb. 1656: ""); 1657: return ''; 1658: } 1659: 1660: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/; 1661: $token=~tr/a-z/A-Z/; 1662: 1663: my %infohash=('resource.0.outtoken' => $token, 1664: 'resource.0.checkouttime' => $now, 1665: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'}); 1666: 1667: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') { 1668: return ''; 1669: } else { 1670: &logthis("WARNING: ". 1671: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb. 1672: ""); 1673: } 1674: 1675: if (&log($tudom,$tuname,&homeserver($tuname,$tudom), 1676: &escape('Checkout '.$infostr.' - '. 1677: $token)) ne 'ok') { 1678: return ''; 1679: } else { 1680: &logthis("WARNING: ". 1681: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb. 1682: ""); 1683: } 1684: return $token; 1685: } 1686: 1687: # ------------------------------------------------------------ Check in an item 1688: 1689: sub checkin { 1690: my $token=shift; 1691: my $now=time; 1692: my ($ta,$tb,$lonhost)=split(/\*/,$token); 1693: $lonhost=~tr/A-Z/a-z/; 1694: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb; 1695: $dtoken=~s/\W/\_/g; 1696: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)= 1697: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost))); 1698: 1699: unless (($tuname) && ($tudom)) { 1700: &logthis('Check in '.$token.' ('.$dtoken.') failed'); 1701: return ''; 1702: } 1703: 1704: unless (&allowed('mgr',$tcrsid)) { 1705: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '. 1706: $ENV{'user.name'}.' - '.$ENV{'user.domain'}); 1707: return ''; 1708: } 1709: 1710: my %infohash=('resource.0.intoken' => $token, 1711: 'resource.0.checkintime' => $now, 1712: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'}); 1713: 1714: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') { 1715: return ''; 1716: } 1717: 1718: if (&log($tudom,$tuname,&homeserver($tuname,$tudom), 1719: &escape('Checkin - '.$token)) ne 'ok') { 1720: return ''; 1721: } 1722: 1723: return ($symb,$tuname,$tudom,$tcrsid); 1724: } 1725: 1726: # --------------------------------------------- Set Expire Date for Spreadsheet 1727: 1728: sub expirespread { 1729: my ($uname,$udom,$stype,$usymb)=@_; 1730: my $cid=$ENV{'request.course.id'}; 1731: if ($cid) { 1732: my $now=time; 1733: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb; 1734: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'. 1735: $ENV{'course.'.$cid.'.num'}. 1736: ':nohist_expirationdates:'. 1737: &escape($key).'='.$now, 1738: $ENV{'course.'.$cid.'.home'}) 1739: } 1740: return 'ok'; 1741: } 1742: 1743: # ----------------------------------------------------- Devalidate Spreadsheets 1744: 1745: sub devalidate { 1746: my ($symb,$uname,$udom)=@_; 1747: my $cid=$ENV{'request.course.id'}; 1748: if ($cid) { 1749: # delete the stored spreadsheets for 1750: # - the student level sheet of this user in course's homespace 1751: # - the assessment level sheet for this resource 1752: # for this user in user's homespace 1753: my $key=$uname.':'.$udom.':'; 1754: my $status= 1755: &del('nohist_calculatedsheets', 1756: [$key.'studentcalc:'], 1757: $ENV{'course.'.$cid.'.domain'}, 1758: $ENV{'course.'.$cid.'.num'}) 1759: .' '. 1760: &del('nohist_calculatedsheets_'.$cid, 1761: [$key.'assesscalc:'.$symb],$udom,$uname); 1762: unless ($status eq 'ok ok') { 1763: &logthis('Could not devalidate spreadsheet '. 1764: $uname.' at '.$udom.' for '. 1765: $symb.': '.$status); 1766: } 1767: } 1768: } 1769: 1770: sub get_scalar { 1771: my ($string,$end) = @_; 1772: my $value; 1773: if ($$string =~ s/^([^&]*?)($end)/$2/) { 1774: $value = $1; 1775: } elsif ($$string =~ s/^([^&]*?)&//) { 1776: $value = $1; 1777: } 1778: return &unescape($value); 1779: } 1780: 1781: sub array2str { 1782: my (@array) = @_; 1783: my $result=&arrayref2str(\@array); 1784: $result=~s/^__ARRAY_REF__//; 1785: $result=~s/__END_ARRAY_REF__$//; 1786: return $result; 1787: } 1788: 1789: sub arrayref2str { 1790: my ($arrayref) = @_; 1791: my $result='__ARRAY_REF__'; 1792: foreach my $elem (@$arrayref) { 1793: if(ref($elem) eq 'ARRAY') { 1794: $result.=&arrayref2str($elem).'&'; 1795: } elsif(ref($elem) eq 'HASH') { 1796: $result.=&hashref2str($elem).'&'; 1797: } elsif(ref($elem)) { 1798: #print("Got a ref of ".(ref($elem))." skipping."); 1799: } else { 1800: $result.=&escape($elem).'&'; 1801: } 1802: } 1803: $result=~s/\&$//; 1804: $result .= '__END_ARRAY_REF__'; 1805: return $result; 1806: } 1807: 1808: sub hash2str { 1809: my (%hash) = @_; 1810: my $result=&hashref2str(\%hash); 1811: $result=~s/^__HASH_REF__//; 1812: $result=~s/__END_HASH_REF__$//; 1813: return $result; 1814: } 1815: 1816: sub hashref2str { 1817: my ($hashref)=@_; 1818: my $result='__HASH_REF__'; 1819: foreach (sort(keys(%$hashref))) { 1820: if (ref($_) eq 'ARRAY') { 1821: $result.=&arrayref2str($_).'='; 1822: } elsif (ref($_) eq 'HASH') { 1823: $result.=&hashref2str($_).'='; 1824: } elsif (ref($_)) { 1825: $result.='='; 1826: #print("Got a ref of ".(ref($_))." skipping."); 1827: } else { 1828: if ($_) {$result.=&escape($_).'=';} else { last; } 1829: } 1830: 1831: if(ref($hashref->{$_}) eq 'ARRAY') { 1832: $result.=&arrayref2str($hashref->{$_}).'&'; 1833: } elsif(ref($hashref->{$_}) eq 'HASH') { 1834: $result.=&hashref2str($hashref->{$_}).'&'; 1835: } elsif(ref($hashref->{$_})) { 1836: $result.='&'; 1837: #print("Got a ref of ".(ref($hashref->{$_}))." skipping."); 1838: } else { 1839: $result.=&escape($hashref->{$_}).'&'; 1840: } 1841: } 1842: $result=~s/\&$//; 1843: $result .= '__END_HASH_REF__'; 1844: return $result; 1845: } 1846: 1847: sub str2hash { 1848: my ($string)=@_; 1849: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__'); 1850: return %$hash; 1851: } 1852: 1853: sub str2hashref { 1854: my ($string) = @_; 1855: 1856: my %hash; 1857: 1858: if($string !~ /^__HASH_REF__/) { 1859: if (! ($string eq '' || !defined($string))) { 1860: $hash{'error'}='Not hash reference'; 1861: } 1862: return (\%hash, $string); 1863: } 1864: 1865: $string =~ s/^__HASH_REF__//; 1866: 1867: while($string !~ /^__END_HASH_REF__/) { 1868: #key 1869: my $key=''; 1870: if($string =~ /^__HASH_REF__/) { 1871: ($key, $string)=&str2hashref($string); 1872: if(defined($key->{'error'})) { 1873: $hash{'error'}='Bad data'; 1874: return (\%hash, $string); 1875: } 1876: } elsif($string =~ /^__ARRAY_REF__/) { 1877: ($key, $string)=&str2arrayref($string); 1878: if($key->[0] eq 'Array reference error') { 1879: $hash{'error'}='Bad data'; 1880: return (\%hash, $string); 1881: } 1882: } else { 1883: $string =~ s/^(.*?)=//; 1884: $key=&unescape($1); 1885: } 1886: $string =~ s/^=//; 1887: 1888: #value 1889: my $value=''; 1890: if($string =~ /^__HASH_REF__/) { 1891: ($value, $string)=&str2hashref($string); 1892: if(defined($value->{'error'})) { 1893: $hash{'error'}='Bad data'; 1894: return (\%hash, $string); 1895: } 1896: } elsif($string =~ /^__ARRAY_REF__/) { 1897: ($value, $string)=&str2arrayref($string); 1898: if($value->[0] eq 'Array reference error') { 1899: $hash{'error'}='Bad data'; 1900: return (\%hash, $string); 1901: } 1902: } else { 1903: $value=&get_scalar(\$string,'__END_HASH_REF__'); 1904: } 1905: $string =~ s/^&//; 1906: 1907: $hash{$key}=$value; 1908: } 1909: 1910: $string =~ s/^__END_HASH_REF__//; 1911: 1912: return (\%hash, $string); 1913: } 1914: 1915: sub str2array { 1916: my ($string)=@_; 1917: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__'); 1918: return @$array; 1919: } 1920: 1921: sub str2arrayref { 1922: my ($string) = @_; 1923: my @array; 1924: 1925: if($string !~ /^__ARRAY_REF__/) { 1926: if (! ($string eq '' || !defined($string))) { 1927: $array[0]='Array reference error'; 1928: } 1929: return (\@array, $string); 1930: } 1931: 1932: $string =~ s/^__ARRAY_REF__//; 1933: 1934: while($string !~ /^__END_ARRAY_REF__/) { 1935: my $value=''; 1936: if($string =~ /^__HASH_REF__/) { 1937: ($value, $string)=&str2hashref($string); 1938: if(defined($value->{'error'})) { 1939: $array[0] ='Array reference error'; 1940: return (\@array, $string); 1941: } 1942: } elsif($string =~ /^__ARRAY_REF__/) { 1943: ($value, $string)=&str2arrayref($string); 1944: if($value->[0] eq 'Array reference error') { 1945: $array[0] ='Array reference error'; 1946: return (\@array, $string); 1947: } 1948: } else { 1949: $value=&get_scalar(\$string,'__END_ARRAY_REF__'); 1950: } 1951: $string =~ s/^&//; 1952: 1953: push(@array, $value); 1954: } 1955: 1956: $string =~ s/^__END_ARRAY_REF__//; 1957: 1958: return (\@array, $string); 1959: } 1960: 1961: # -------------------------------------------------------------------Temp Store 1962: 1963: sub tmpreset { 1964: my ($symb,$namespace,$domain,$stuname) = @_; 1965: if (!$symb) { 1966: $symb=&symbread(); 1967: if (!$symb) { $symb= $ENV{'request.url'}; } 1968: } 1969: $symb=escape($symb); 1970: 1971: if (!$namespace) { $namespace=$ENV{'request.state'}; } 1972: $namespace=~s/\//\_/g; 1973: $namespace=~s/\W//g; 1974: 1975: #FIXME needs to do something for /pub resources 1976: if (!$domain) { $domain=$ENV{'user.domain'}; } 1977: if (!$stuname) { $stuname=$ENV{'user.name'}; } 1978: my $path=$perlvar{'lonDaemons'}.'/tmp'; 1979: my %hash; 1980: if (tie(%hash,'GDBM_File', 1981: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 1982: &GDBM_WRCREAT(),0640)) { 1983: foreach my $key (keys %hash) { 1984: if ($key=~ /:$symb/) { 1985: delete($hash{$key}); 1986: } 1987: } 1988: } 1989: } 1990: 1991: sub tmpstore { 1992: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 1993: 1994: if (!$symb) { 1995: $symb=&symbread(); 1996: if (!$symb) { $symb= $ENV{'request.url'}; } 1997: } 1998: $symb=escape($symb); 1999: 2000: if (!$namespace) { 2001: # I don't think we would ever want to store this for a course. 2002: # it seems this will only be used if we don't have a course. 2003: #$namespace=$ENV{'request.course.id'}; 2004: #if (!$namespace) { 2005: $namespace=$ENV{'request.state'}; 2006: #} 2007: } 2008: $namespace=~s/\//\_/g; 2009: $namespace=~s/\W//g; 2010: #FIXME needs to do something for /pub resources 2011: if (!$domain) { $domain=$ENV{'user.domain'}; } 2012: if (!$stuname) { $stuname=$ENV{'user.name'}; } 2013: my $now=time; 2014: my %hash; 2015: my $path=$perlvar{'lonDaemons'}.'/tmp'; 2016: if (tie(%hash,'GDBM_File', 2017: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 2018: &GDBM_WRCREAT(),0640)) { 2019: $hash{"version:$symb"}++; 2020: my $version=$hash{"version:$symb"}; 2021: my $allkeys=''; 2022: foreach my $key (keys(%$storehash)) { 2023: $allkeys.=$key.':'; 2024: $hash{"$version:$symb:$key"}=$$storehash{$key}; 2025: } 2026: $hash{"$version:$symb:timestamp"}=$now; 2027: $allkeys.='timestamp'; 2028: $hash{"$version:keys:$symb"}=$allkeys; 2029: if (untie(%hash)) { 2030: return 'ok'; 2031: } else { 2032: return "error:$!"; 2033: } 2034: } else { 2035: return "error:$!"; 2036: } 2037: } 2038: 2039: # -----------------------------------------------------------------Temp Restore 2040: 2041: sub tmprestore { 2042: my ($symb,$namespace,$domain,$stuname) = @_; 2043: 2044: if (!$symb) { 2045: $symb=&symbread(); 2046: if (!$symb) { $symb= $ENV{'request.url'}; } 2047: } 2048: $symb=escape($symb); 2049: 2050: if (!$namespace) { $namespace=$ENV{'request.state'}; } 2051: #FIXME needs to do something for /pub resources 2052: if (!$domain) { $domain=$ENV{'user.domain'}; } 2053: if (!$stuname) { $stuname=$ENV{'user.name'}; } 2054: 2055: my %returnhash; 2056: $namespace=~s/\//\_/g; 2057: $namespace=~s/\W//g; 2058: my %hash; 2059: my $path=$perlvar{'lonDaemons'}.'/tmp'; 2060: if (tie(%hash,'GDBM_File', 2061: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 2062: &GDBM_READER(),0640)) { 2063: my $version=$hash{"version:$symb"}; 2064: $returnhash{'version'}=$version; 2065: my $scope; 2066: for ($scope=1;$scope<=$version;$scope++) { 2067: my $vkeys=$hash{"$scope:keys:$symb"}; 2068: my @keys=split(/:/,$vkeys); 2069: my $key; 2070: $returnhash{"$scope:keys"}=$vkeys; 2071: foreach $key (@keys) { 2072: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"}; 2073: $returnhash{"$key"}=$hash{"$scope:$symb:$key"}; 2074: } 2075: } 2076: if (!(untie(%hash))) { 2077: return "error:$!"; 2078: } 2079: } else { 2080: return "error:$!"; 2081: } 2082: return %returnhash; 2083: } 2084: 2085: # ----------------------------------------------------------------------- Store 2086: 2087: sub store { 2088: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 2089: my $home=''; 2090: 2091: if ($stuname) { $home=&homeserver($stuname,$domain); } 2092: 2093: $symb=&symbclean($symb); 2094: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 2095: 2096: if (!$domain) { $domain=$ENV{'user.domain'}; } 2097: if (!$stuname) { $stuname=$ENV{'user.name'}; } 2098: 2099: &devalidate($symb,$stuname,$domain); 2100: 2101: $symb=escape($symb); 2102: if (!$namespace) { 2103: unless ($namespace=$ENV{'request.course.id'}) { 2104: return ''; 2105: } 2106: } 2107: if (!$home) { $home=$ENV{'user.home'}; } 2108: 2109: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 2110: $$storehash{'host'}=$perlvar{'lonHostID'}; 2111: 2112: my $namevalue=''; 2113: foreach (keys %$storehash) { 2114: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&'; 2115: } 2116: $namevalue=~s/\&$//; 2117: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue); 2118: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 2119: } 2120: 2121: # -------------------------------------------------------------- Critical Store 2122: 2123: sub cstore { 2124: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 2125: my $home=''; 2126: 2127: if ($stuname) { $home=&homeserver($stuname,$domain); } 2128: 2129: $symb=&symbclean($symb); 2130: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 2131: 2132: if (!$domain) { $domain=$ENV{'user.domain'}; } 2133: if (!$stuname) { $stuname=$ENV{'user.name'}; } 2134: 2135: &devalidate($symb,$stuname,$domain); 2136: 2137: $symb=escape($symb); 2138: if (!$namespace) { 2139: unless ($namespace=$ENV{'request.course.id'}) { 2140: return ''; 2141: } 2142: } 2143: if (!$home) { $home=$ENV{'user.home'}; } 2144: 2145: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 2146: $$storehash{'host'}=$perlvar{'lonHostID'}; 2147: 2148: my $namevalue=''; 2149: foreach (keys %$storehash) { 2150: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&'; 2151: } 2152: $namevalue=~s/\&$//; 2153: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue); 2154: return critical 2155: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 2156: } 2157: 2158: # --------------------------------------------------------------------- Restore 2159: 2160: sub restore { 2161: my ($symb,$namespace,$domain,$stuname) = @_; 2162: my $home=''; 2163: 2164: if ($stuname) { $home=&homeserver($stuname,$domain); } 2165: 2166: if (!$symb) { 2167: unless ($symb=escape(&symbread())) { return ''; } 2168: } else { 2169: $symb=&escape(&symbclean($symb)); 2170: } 2171: if (!$namespace) { 2172: unless ($namespace=$ENV{'request.course.id'}) { 2173: return ''; 2174: } 2175: } 2176: if (!$domain) { $domain=$ENV{'user.domain'}; } 2177: if (!$stuname) { $stuname=$ENV{'user.name'}; } 2178: if (!$home) { $home=$ENV{'user.home'}; } 2179: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home"); 2180: 2181: my %returnhash=(); 2182: foreach (split(/\&/,$answer)) { 2183: my ($name,$value)=split(/\=/,$_); 2184: $returnhash{&unescape($name)}=&unescape($value); 2185: } 2186: my $version; 2187: for ($version=1;$version<=$returnhash{'version'};$version++) { 2188: foreach (split(/\:/,$returnhash{$version.':keys'})) { 2189: $returnhash{$_}=$returnhash{$version.':'.$_}; 2190: } 2191: } 2192: return %returnhash; 2193: } 2194: 2195: # ---------------------------------------------------------- Course Description 2196: 2197: sub coursedescription { 2198: my $courseid=shift; 2199: $courseid=~s/^\///; 2200: $courseid=~s/\_/\//g; 2201: my ($cdomain,$cnum)=split(/\//,$courseid); 2202: my $chome=&homeserver($cnum,$cdomain); 2203: my $normalid=$cdomain.'_'.$cnum; 2204: # need to always cache even if we get errors otherwise we keep 2205: # trying and trying and trying to get the course description. 2206: my %envhash=(); 2207: my %returnhash=(); 2208: $envhash{'course.'.$normalid.'.last_cache'}=time; 2209: if ($chome ne 'no_host') { 2210: %returnhash=&dump('environment',$cdomain,$cnum); 2211: if (!exists($returnhash{'con_lost'})) { 2212: $returnhash{'home'}= $chome; 2213: $returnhash{'domain'} = $cdomain; 2214: $returnhash{'num'} = $cnum; 2215: while (my ($name,$value) = each %returnhash) { 2216: $envhash{'course.'.$normalid.'.'.$name}=$value; 2217: } 2218: $returnhash{'url'}=&clutter($returnhash{'url'}); 2219: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'. 2220: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum; 2221: $envhash{'course.'.$normalid.'.home'}=$chome; 2222: $envhash{'course.'.$normalid.'.domain'}=$cdomain; 2223: $envhash{'course.'.$normalid.'.num'}=$cnum; 2224: } 2225: } 2226: &appenv(%envhash); 2227: return %returnhash; 2228: } 2229: 2230: # -------------------------------------------------See if a user is privileged 2231: 2232: sub privileged { 2233: my ($username,$domain)=@_; 2234: my $rolesdump=&reply("dump:$domain:$username:roles", 2235: &homeserver($username,$domain)); 2236: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; } 2237: my $now=time; 2238: if ($rolesdump ne '') { 2239: foreach (split(/&/,$rolesdump)) { 2240: if ($_!~/^rolesdef\&/) { 2241: my ($area,$role)=split(/=/,$_); 2242: $area=~s/\_\w\w$//; 2243: my ($trole,$tend,$tstart)=split(/_/,$role); 2244: if (($trole eq 'dc') || ($trole eq 'su')) { 2245: my $active=1; 2246: if ($tend) { 2247: if ($tend<$now) { $active=0; } 2248: } 2249: if ($tstart) { 2250: if ($tstart>$now) { $active=0; } 2251: } 2252: if ($active) { return 1; } 2253: } 2254: } 2255: } 2256: } 2257: return 0; 2258: } 2259: 2260: # -------------------------------------------------------- Get user privileges 2261: 2262: sub rolesinit { 2263: my ($domain,$username,$authhost)=@_; 2264: my $rolesdump=reply("dump:$domain:$username:roles",$authhost); 2265: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; } 2266: my %allroles=(); 2267: my %thesepriv=(); 2268: my $now=time; 2269: my $userroles="user.login.time=$now\n"; 2270: my $thesestr; 2271: 2272: if ($rolesdump ne '') { 2273: foreach (split(/&/,$rolesdump)) { 2274: if ($_!~/^rolesdef\&/) { 2275: my ($area,$role)=split(/=/,$_); 2276: $area=~s/\_\w\w$//; 2277: my ($trole,$tend,$tstart)=split(/_/,$role); 2278: $userroles.='user.role.'.$trole.'.'.$area.'='. 2279: $tstart.'.'.$tend."\n"; 2280: # log the associated role with the area 2281: &userrolelog($trole,$username,$domain,$area,$tstart,$tend); 2282: if ($tend!=0) { 2283: if ($tend<$now) { 2284: $trole=''; 2285: } 2286: } 2287: if ($tstart!=0) { 2288: if ($tstart>$now) { 2289: $trole=''; 2290: } 2291: } 2292: if (($area ne '') && ($trole ne '')) { 2293: my $spec=$trole.'.'.$area; 2294: my ($tdummy,$tdomain,$trest)=split(/\//,$area); 2295: if ($trole =~ /^cr\//) { 2296: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole); 2297: my $homsvr=homeserver($rauthor,$rdomain); 2298: if ($hostname{$homsvr} ne '') { 2299: my ($rdummy,$roledef)= 2300: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor); 2301: 2302: if (($rdummy ne 'con_lost') && ($roledef ne '')) { 2303: my ($syspriv,$dompriv,$coursepriv)= 2304: split(/\_/,$roledef); 2305: if (defined($syspriv)) { 2306: $allroles{'cm./'}.=':'.$syspriv; 2307: $allroles{$spec.'./'}.=':'.$syspriv; 2308: } 2309: if ($tdomain ne '') { 2310: if (defined($dompriv)) { 2311: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv; 2312: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv; 2313: } 2314: if ($trest ne '') { 2315: if (defined($coursepriv)) { 2316: $allroles{'cm.'.$area}.=':'.$coursepriv; 2317: $allroles{$spec.'.'.$area}.=':'.$coursepriv; 2318: } 2319: } 2320: } 2321: } 2322: } 2323: } else { 2324: if (defined($pr{$trole.':s'})) { 2325: $allroles{'cm./'}.=':'.$pr{$trole.':s'}; 2326: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'}; 2327: } 2328: if ($tdomain ne '') { 2329: if (defined($pr{$trole.':d'})) { 2330: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 2331: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 2332: } 2333: if ($trest ne '') { 2334: if (defined($pr{$trole.':c'})) { 2335: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'}; 2336: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'}; 2337: } 2338: } 2339: } 2340: } 2341: } 2342: } 2343: } 2344: my $adv=0; 2345: my $author=0; 2346: foreach (keys %allroles) { 2347: %thesepriv=(); 2348: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; } 2349: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; } 2350: foreach (split(/:/,$allroles{$_})) { 2351: if ($_ ne '') { 2352: my ($privilege,$restrictions)=split(/&/,$_); 2353: if ($restrictions eq '') { 2354: $thesepriv{$privilege}='F'; 2355: } else { 2356: if ($thesepriv{$privilege} ne 'F') { 2357: $thesepriv{$privilege}.=$restrictions; 2358: } 2359: } 2360: } 2361: } 2362: $thesestr=''; 2363: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; } 2364: $userroles.='user.priv.'.$_.'='.$thesestr."\n"; 2365: } 2366: $userroles.='user.adv='.$adv."\n". 2367: 'user.author='.$author."\n"; 2368: $ENV{'user.adv'}=$adv; 2369: } 2370: return $userroles; 2371: } 2372: 2373: # --------------------------------------------------------------- get interface 2374: 2375: sub get { 2376: my ($namespace,$storearr,$udomain,$uname)=@_; 2377: my $items=''; 2378: foreach (@$storearr) { 2379: $items.=escape($_).'&'; 2380: } 2381: $items=~s/\&$//; 2382: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2383: if (!$uname) { $uname=$ENV{'user.name'}; } 2384: my $uhome=&homeserver($uname,$udomain); 2385: 2386: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome); 2387: my @pairs=split(/\&/,$rep); 2388: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 2389: return @pairs; 2390: } 2391: my %returnhash=(); 2392: my $i=0; 2393: foreach (@$storearr) { 2394: $returnhash{$_}=unescape($pairs[$i]); 2395: $i++; 2396: } 2397: return %returnhash; 2398: } 2399: 2400: # --------------------------------------------------------------- del interface 2401: 2402: sub del { 2403: my ($namespace,$storearr,$udomain,$uname)=@_; 2404: my $items=''; 2405: foreach (@$storearr) { 2406: $items.=escape($_).'&'; 2407: } 2408: $items=~s/\&$//; 2409: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2410: if (!$uname) { $uname=$ENV{'user.name'}; } 2411: my $uhome=&homeserver($uname,$udomain); 2412: 2413: return &reply("del:$udomain:$uname:$namespace:$items",$uhome); 2414: } 2415: 2416: # -------------------------------------------------------------- dump interface 2417: 2418: sub dump { 2419: my ($namespace,$udomain,$uname,$regexp)=@_; 2420: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2421: if (!$uname) { $uname=$ENV{'user.name'}; } 2422: my $uhome=&homeserver($uname,$udomain); 2423: if ($regexp) { 2424: $regexp=&escape($regexp); 2425: } else { 2426: $regexp='.'; 2427: } 2428: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome); 2429: my @pairs=split(/\&/,$rep); 2430: my %returnhash=(); 2431: foreach (@pairs) { 2432: my ($key,$value)=split(/=/,$_); 2433: $returnhash{unescape($key)}=unescape($value); 2434: } 2435: return %returnhash; 2436: } 2437: 2438: # -------------------------------------------------------------- keys interface 2439: 2440: sub getkeys { 2441: my ($namespace,$udomain,$uname)=@_; 2442: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2443: if (!$uname) { $uname=$ENV{'user.name'}; } 2444: my $uhome=&homeserver($uname,$udomain); 2445: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome); 2446: my @keyarray=(); 2447: foreach (split(/\&/,$rep)) { 2448: push (@keyarray,&unescape($_)); 2449: } 2450: return @keyarray; 2451: } 2452: 2453: # --------------------------------------------------------------- currentdump 2454: sub currentdump { 2455: my ($courseid,$sdom,$sname)=@_; 2456: $courseid = $ENV{'request.course.id'} if (! defined($courseid)); 2457: $sdom = $ENV{'user.domain'} if (! defined($sdom)); 2458: $sname = $ENV{'user.name'} if (! defined($sname)); 2459: my $uhome = &homeserver($sname,$sdom); 2460: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome); 2461: return if ($rep =~ /^(error:|no_such_host)/); 2462: # 2463: my %returnhash=(); 2464: # 2465: if ($rep eq "unknown_cmd") { 2466: # an old lond will not know currentdump 2467: # Do a dump and make it look like a currentdump 2468: my @tmp = &dump($courseid,$sdom,$sname,'.'); 2469: return if ($tmp[0] =~ /^(error:|no_such_host)/); 2470: my %hash = @tmp; 2471: @tmp=(); 2472: %returnhash = %{&convert_dump_to_currentdump(\%hash)}; 2473: } else { 2474: my @pairs=split(/\&/,$rep); 2475: foreach (@pairs) { 2476: my ($key,$value)=split(/=/,$_); 2477: my ($symb,$param) = split(/:/,$key); 2478: $returnhash{&unescape($symb)}->{&unescape($param)} = 2479: &unescape($value); 2480: } 2481: } 2482: return %returnhash; 2483: } 2484: 2485: sub convert_dump_to_currentdump{ 2486: my %hash = %{shift()}; 2487: my %returnhash; 2488: # Code ripped from lond, essentially. The only difference 2489: # here is the unescaping done by lonnet::dump(). Conceivably 2490: # we might run in to problems with parameter names =~ /^v\./ 2491: while (my ($key,$value) = each(%hash)) { 2492: my ($v,$symb,$param) = split(/:/,$key); 2493: next if ($v eq 'version' || $symb eq 'keys'); 2494: next if (exists($returnhash{$symb}) && 2495: exists($returnhash{$symb}->{$param}) && 2496: $returnhash{$symb}->{'v.'.$param} > $v); 2497: $returnhash{$symb}->{$param}=$value; 2498: $returnhash{$symb}->{'v.'.$param}=$v; 2499: } 2500: # 2501: # Remove all of the keys in the hashes which keep track of 2502: # the version of the parameter. 2503: while (my ($symb,$param_hash) = each(%returnhash)) { 2504: # use a foreach because we are going to delete from the hash. 2505: foreach my $key (keys(%$param_hash)) { 2506: delete($param_hash->{$key}) if ($key =~ /^v\./); 2507: } 2508: } 2509: return \%returnhash; 2510: } 2511: 2512: # --------------------------------------------------------------- inc interface 2513: 2514: sub inc { 2515: my ($namespace,$store,$udomain,$uname) = @_; 2516: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2517: if (!$uname) { $uname=$ENV{'user.name'}; } 2518: my $uhome=&homeserver($uname,$udomain); 2519: my $items=''; 2520: if (! ref($store)) { 2521: # got a single value, so use that instead 2522: $items = &escape($store).'=&'; 2523: } elsif (ref($store) eq 'SCALAR') { 2524: $items = &escape($$store).'=&'; 2525: } elsif (ref($store) eq 'ARRAY') { 2526: $items = join('=&',map {&escape($_);} @{$store}); 2527: } elsif (ref($store) eq 'HASH') { 2528: while (my($key,$value) = each(%{$store})) { 2529: $items.= &escape($key).'='.&escape($value).'&'; 2530: } 2531: } 2532: $items=~s/\&$//; 2533: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome); 2534: } 2535: 2536: # --------------------------------------------------------------- put interface 2537: 2538: sub put { 2539: my ($namespace,$storehash,$udomain,$uname)=@_; 2540: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2541: if (!$uname) { $uname=$ENV{'user.name'}; } 2542: my $uhome=&homeserver($uname,$udomain); 2543: my $items=''; 2544: foreach (keys %$storehash) { 2545: $items.=&escape($_).'='.&escape($$storehash{$_}).'&'; 2546: } 2547: $items=~s/\&$//; 2548: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 2549: } 2550: 2551: # ------------------------------------------------------ critical put interface 2552: 2553: sub cput { 2554: my ($namespace,$storehash,$udomain,$uname)=@_; 2555: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2556: if (!$uname) { $uname=$ENV{'user.name'}; } 2557: my $uhome=&homeserver($uname,$udomain); 2558: my $items=''; 2559: foreach (keys %$storehash) { 2560: $items.=escape($_).'='.escape($$storehash{$_}).'&'; 2561: } 2562: $items=~s/\&$//; 2563: return &critical("put:$udomain:$uname:$namespace:$items",$uhome); 2564: } 2565: 2566: # -------------------------------------------------------------- eget interface 2567: 2568: sub eget { 2569: my ($namespace,$storearr,$udomain,$uname)=@_; 2570: my $items=''; 2571: foreach (@$storearr) { 2572: $items.=escape($_).'&'; 2573: } 2574: $items=~s/\&$//; 2575: if (!$udomain) { $udomain=$ENV{'user.domain'}; } 2576: if (!$uname) { $uname=$ENV{'user.name'}; } 2577: my $uhome=&homeserver($uname,$udomain); 2578: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome); 2579: my @pairs=split(/\&/,$rep); 2580: my %returnhash=(); 2581: my $i=0; 2582: foreach (@$storearr) { 2583: $returnhash{$_}=unescape($pairs[$i]); 2584: $i++; 2585: } 2586: return %returnhash; 2587: } 2588: 2589: # ---------------------------------------------- Custom access rule evaluation 2590: 2591: sub customaccess { 2592: my ($priv,$uri)=@_; 2593: my ($urole,$urealm)=split(/\./,$ENV{'request.role'}); 2594: $urealm=~s/^\W//; 2595: my ($udom,$ucrs,$usec)=split(/\//,$urealm); 2596: my $access=0; 2597: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) { 2598: my ($effect,$realm,$role)=split(/\:/,$_); 2599: if ($role) { 2600: if ($role ne $urole) { next; } 2601: } 2602: foreach (split(/\s*\,\s*/,$realm)) { 2603: my ($tdom,$tcrs,$tsec)=split(/\_/,$_); 2604: if ($tdom) { 2605: if ($tdom ne $udom) { next; } 2606: } 2607: if ($tcrs) { 2608: if ($tcrs ne $ucrs) { next; } 2609: } 2610: if ($tsec) { 2611: if ($tsec ne $usec) { next; } 2612: } 2613: $access=($effect eq 'allow'); 2614: last; 2615: } 2616: if ($realm eq '' && $role eq '') { 2617: $access=($effect eq 'allow'); 2618: } 2619: } 2620: return $access; 2621: } 2622: 2623: # ------------------------------------------------- Check for a user privilege 2624: 2625: sub allowed { 2626: my ($priv,$uri)=@_; 2627: $uri=&deversion($uri); 2628: my $orguri=$uri; 2629: $uri=&declutter($uri); 2630: 2631: if (defined($ENV{'allowed.'.$priv})) { return $ENV{'allowed.'.$priv}; } 2632: # Free bre access to adm and meta resources 2633: 2634: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) { 2635: return 'F'; 2636: } 2637: 2638: # Free bre to public access 2639: 2640: if ($priv eq 'bre') { 2641: my $copyright=&metadata($uri,'copyright'); 2642: if (($copyright eq 'public') && (!$ENV{'request.course.id'})) { 2643: return 'F'; 2644: } 2645: if ($copyright eq 'priv') { 2646: $uri=~/([^\/]+)\/([^\/]+)\//; 2647: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) { 2648: return ''; 2649: } 2650: } 2651: if ($copyright eq 'domain') { 2652: $uri=~/([^\/]+)\/([^\/]+)\//; 2653: unless (($ENV{'user.domain'} eq $1) || 2654: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) { 2655: return ''; 2656: } 2657: } 2658: if ($ENV{'request.role'}=~ /li\.\//) { 2659: # Library role, so allow browsing of resources in this domain. 2660: return 'F'; 2661: } 2662: if ($copyright eq 'custom') { 2663: unless (&customaccess($priv,$uri)) { return ''; } 2664: } 2665: } 2666: # Domain coordinator is trying to create a course 2667: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) { 2668: # uri is the requested domain in this case. 2669: # comparison to 'request.role.domain' shows if the user has selected 2670: # a role of dc for the domain in question. 2671: return 'F' if ($uri eq $ENV{'request.role.domain'}); 2672: } 2673: 2674: my $thisallowed=''; 2675: my $statecond=0; 2676: my $courseprivid=''; 2677: 2678: # Course 2679: 2680: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) { 2681: $thisallowed.=$1; 2682: } 2683: 2684: # Domain 2685: 2686: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'} 2687: =~/\Q$priv\E\&([^\:]*)/) { 2688: $thisallowed.=$1; 2689: } 2690: 2691: # Course: uri itself is a course 2692: my $courseuri=$uri; 2693: $courseuri=~s/\_(\d)/\/$1/; 2694: $courseuri=~s/^([^\/])/\/$1/; 2695: 2696: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri} 2697: =~/\Q$priv\E\&([^\:]*)/) { 2698: $thisallowed.=$1; 2699: } 2700: 2701: # URI is an uploaded document for this course 2702: 2703: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) { 2704: my $refuri=$ENV{'httpref.'.$orguri}; 2705: if ($refuri) { 2706: if ($refuri =~ m|^/adm/|) { 2707: $thisallowed='F'; 2708: } 2709: } 2710: } 2711: 2712: # Full access at system, domain or course-wide level? Exit. 2713: 2714: if ($thisallowed=~/F/) { 2715: return 'F'; 2716: } 2717: 2718: # If this is generating or modifying users, exit with special codes 2719: 2720: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:\Q$priv\E\:/) { 2721: return $thisallowed; 2722: } 2723: # 2724: # Gathered so far: system, domain and course wide privileges 2725: # 2726: # Course: See if uri or referer is an individual resource that is part of 2727: # the course 2728: 2729: if ($ENV{'request.course.id'}) { 2730: 2731: $courseprivid=$ENV{'request.course.id'}; 2732: if ($ENV{'request.course.sec'}) { 2733: $courseprivid.='/'.$ENV{'request.course.sec'}; 2734: } 2735: $courseprivid=~s/\_/\//; 2736: my $checkreferer=1; 2737: my ($match,$cond)=&is_on_map($uri); 2738: if ($match) { 2739: $statecond=$cond; 2740: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid} 2741: =~/\Q$priv\E\&([^\:]*)/) { 2742: $thisallowed.=$1; 2743: $checkreferer=0; 2744: } 2745: } 2746: 2747: if ($checkreferer) { 2748: my $refuri=$ENV{'httpref.'.$orguri}; 2749: unless ($refuri) { 2750: foreach (keys %ENV) { 2751: if ($_=~/^httpref\..*\*/) { 2752: my $pattern=$_; 2753: $pattern=~s/^httpref\.\/res\///; 2754: $pattern=~s/\*/\[\^\/\]\+/g; 2755: $pattern=~s/\//\\\//g; 2756: if ($orguri=~/$pattern/) { 2757: $refuri=$ENV{$_}; 2758: } 2759: } 2760: } 2761: } 2762: 2763: if ($refuri) { 2764: $refuri=&declutter($refuri); 2765: my ($match,$cond)=&is_on_map($refuri); 2766: if ($match) { 2767: my $refstatecond=$cond; 2768: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid} 2769: =~/\Q$priv\E\&([^\:]*)/) { 2770: $thisallowed.=$1; 2771: $uri=$refuri; 2772: $statecond=$refstatecond; 2773: } 2774: } 2775: } 2776: } 2777: } 2778: 2779: # 2780: # Gathered now: all privileges that could apply, and condition number 2781: # 2782: # 2783: # Full or no access? 2784: # 2785: 2786: if ($thisallowed=~/F/) { 2787: return 'F'; 2788: } 2789: 2790: unless ($thisallowed) { 2791: return ''; 2792: } 2793: 2794: # Restrictions exist, deal with them 2795: # 2796: # C:according to course preferences 2797: # R:according to resource settings 2798: # L:unless locked 2799: # X:according to user session state 2800: # 2801: 2802: # Possibly locked functionality, check all courses 2803: # Locks might take effect only after 10 minutes cache expiration for other 2804: # courses, and 2 minutes for current course 2805: 2806: my $envkey; 2807: if ($thisallowed=~/L/) { 2808: foreach $envkey (keys %ENV) { 2809: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) { 2810: my $courseid=$2; 2811: my $roleid=$1.'.'.$2; 2812: $courseid=~s/^\///; 2813: my $expiretime=600; 2814: if ($ENV{'request.role'} eq $roleid) { 2815: $expiretime=120; 2816: } 2817: my ($cdom,$cnum,$csec)=split(/\//,$courseid); 2818: my $prefix='course.'.$cdom.'_'.$cnum.'.'; 2819: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) { 2820: &coursedescription($courseid); 2821: } 2822: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/) 2823: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) { 2824: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) { 2825: &log($ENV{'user.domain'},$ENV{'user.name'}, 2826: $ENV{'user.home'}, 2827: 'Locked by res: '.$priv.' for '.$uri.' due to '. 2828: $cdom.'/'.$cnum.'/'.$csec.' expire '. 2829: $ENV{$prefix.'priv.'.$priv.'.lock.expire'}); 2830: return ''; 2831: } 2832: } 2833: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/) 2834: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) { 2835: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) { 2836: &log($ENV{'user.domain'},$ENV{'user.name'}, 2837: $ENV{'user.home'}, 2838: 'Locked by priv: '.$priv.' for '.$uri.' due to '. 2839: $cdom.'/'.$cnum.'/'.$csec.' expire '. 2840: $ENV{$prefix.'priv.'.$priv.'.lock.expire'}); 2841: return ''; 2842: } 2843: } 2844: } 2845: } 2846: } 2847: 2848: # 2849: # Rest of the restrictions depend on selected course 2850: # 2851: 2852: unless ($ENV{'request.course.id'}) { 2853: return '1'; 2854: } 2855: 2856: # 2857: # Now user is definitely in a course 2858: # 2859: 2860: 2861: # Course preferences 2862: 2863: if ($thisallowed=~/C/) { 2864: my $rolecode=(split(/\./,$ENV{'request.role'}))[0]; 2865: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'}; 2866: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'} 2867: =~/\Q$rolecode\E/) { 2868: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'}, 2869: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '. 2870: $ENV{'request.course.id'}); 2871: return ''; 2872: } 2873: 2874: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'} 2875: =~/\Q$unamedom\E/) { 2876: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'}, 2877: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '. 2878: $ENV{'request.course.id'}); 2879: return ''; 2880: } 2881: } 2882: 2883: # Resource preferences 2884: 2885: if ($thisallowed=~/R/) { 2886: my $rolecode=(split(/\./,$ENV{'request.role'}))[0]; 2887: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) { 2888: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'}, 2889: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode); 2890: return ''; 2891: } 2892: } 2893: 2894: # Restricted by state or randomout? 2895: 2896: if ($thisallowed=~/X/) { 2897: if ($ENV{'acc.randomout'}) { 2898: my $symb=&symbread($uri,1); 2899: if (($symb) && ($ENV{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 2900: return ''; 2901: } 2902: } 2903: if (&condval($statecond)) { 2904: return '2'; 2905: } else { 2906: return ''; 2907: } 2908: } 2909: 2910: return 'F'; 2911: } 2912: 2913: # --------------------------------------------------- Is a resource on the map? 2914: 2915: sub is_on_map { 2916: my $uri=&declutter(shift); 2917: $uri=~s/\.\d+\.(\w+)$/\.$1/; 2918: my @uriparts=split(/\//,$uri); 2919: my $filename=$uriparts[$#uriparts]; 2920: my $pathname=$uri; 2921: $pathname=~s|/\Q$filename\E$||; 2922: $pathname=~s/^adm\/wrapper\///; 2923: #Trying to find the conditional for the file 2924: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~ 2925: /\&\Q$filename\E\:([\d\|]+)\&/); 2926: if ($match) { 2927: return (1,$1); 2928: } else { 2929: return (0,0); 2930: } 2931: } 2932: 2933: # --------------------------------------------------------- Get symb from alias 2934: 2935: sub get_symb_from_alias { 2936: my $symb=shift; 2937: my ($map,$resid,$url)=&decode_symb($symb); 2938: # Already is a symb 2939: if ($url) { return $symb; } 2940: # Must be an alias 2941: my $aliassymb=''; 2942: my %bighash; 2943: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', 2944: &GDBM_READER(),0640)) { 2945: my $rid=$bighash{'mapalias_'.$symb}; 2946: if ($rid) { 2947: my ($mapid,$resid)=split(/\./,$rid); 2948: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid}, 2949: $resid,$bighash{'src_'.$rid}); 2950: } 2951: untie %bighash; 2952: } 2953: return $aliassymb; 2954: } 2955: 2956: # ----------------------------------------------------------------- Define Role 2957: 2958: sub definerole { 2959: if (allowed('mcr','/')) { 2960: my ($rolename,$sysrole,$domrole,$courole)=@_; 2961: foreach (split(':',$sysrole)) { 2962: my ($crole,$cqual)=split(/\&/,$_); 2963: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; } 2964: if ($pr{'cr:s'}=~/\Q$crole\E\&/) { 2965: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 2966: return "refused:s:$crole&$cqual"; 2967: } 2968: } 2969: } 2970: foreach (split(':',$domrole)) { 2971: my ($crole,$cqual)=split(/\&/,$_); 2972: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; } 2973: if ($pr{'cr:d'}=~/\Q$crole\E\&/) { 2974: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 2975: return "refused:d:$crole&$cqual"; 2976: } 2977: } 2978: } 2979: foreach (split(':',$courole)) { 2980: my ($crole,$cqual)=split(/\&/,$_); 2981: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; } 2982: if ($pr{'cr:c'}=~/\Q$crole\E\&/) { 2983: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 2984: return "refused:c:$crole&$cqual"; 2985: } 2986: } 2987: } 2988: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:". 2989: "$ENV{'user.domain'}:$ENV{'user.name'}:". 2990: "rolesdef_$rolename=". 2991: escape($sysrole.'_'.$domrole.'_'.$courole); 2992: return reply($command,$ENV{'user.home'}); 2993: } else { 2994: return 'refused'; 2995: } 2996: } 2997: 2998: # ---------------- Make a metadata query against the network of library servers 2999: 3000: sub metadata_query { 3001: my ($query,$custom,$customshow,$server_array)=@_; 3002: my %rhash; 3003: my @server_list = (defined($server_array) ? @$server_array 3004: : keys(%libserv) ); 3005: for my $server (@server_list) { 3006: unless ($custom or $customshow) { 3007: my $reply=&reply("querysend:".&escape($query),$server); 3008: $rhash{$server}=$reply; 3009: } 3010: else { 3011: my $reply=&reply("querysend:".&escape($query).':'. 3012: &escape($custom).':'.&escape($customshow), 3013: $server); 3014: $rhash{$server}=$reply; 3015: } 3016: } 3017: return \%rhash; 3018: } 3019: 3020: # ----------------------------------------- Send log queries and wait for reply 3021: 3022: sub log_query { 3023: my ($uname,$udom,$query,%filters)=@_; 3024: my $uhome=&homeserver($uname,$udom); 3025: if ($uhome eq 'no_host') { return 'error: no_host'; } 3026: my $uhost=$hostname{$uhome}; 3027: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters)); 3028: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command, 3029: $uhome); 3030: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; } 3031: return get_query_reply($queryid); 3032: } 3033: 3034: sub get_query_reply { 3035: my $queryid=shift; 3036: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid; 3037: my $reply=''; 3038: for (1..100) { 3039: sleep 2; 3040: if (-e $replyfile.'.end') { 3041: if (open(my $fh,$replyfile)) { 3042: $reply.=<$fh>; 3043: close($fh); 3044: } else { return 'error: reply_file_error'; } 3045: return &unescape($reply); 3046: } 3047: } 3048: return 'timeout:'.$queryid; 3049: } 3050: 3051: sub courselog_query { 3052: # 3053: # possible filters: 3054: # url: url or symb 3055: # username 3056: # domain 3057: # action: view, submit, grade 3058: # start: timestamp 3059: # end: timestamp 3060: # 3061: my (%filters)=@_; 3062: unless ($ENV{'request.course.id'}) { return 'no_course'; } 3063: if ($filters{'url'}) { 3064: $filters{'url'}=&symbclean(&declutter($filters{'url'})); 3065: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/; 3066: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/; 3067: } 3068: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'}; 3069: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}; 3070: return &log_query($cname,$cdom,'courselog',%filters); 3071: } 3072: 3073: sub userlog_query { 3074: my ($uname,$udom,%filters)=@_; 3075: return &log_query($uname,$udom,'userlog',%filters); 3076: } 3077: 3078: # ------------------------------------------------------------------ Plain Text 3079: 3080: sub plaintext { 3081: my $short=shift; 3082: return &mt($prp{$short}); 3083: } 3084: 3085: # ----------------------------------------------------------------- Assign Role 3086: 3087: sub assignrole { 3088: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_; 3089: my $mrole; 3090: if ($role =~ /^cr\//) { 3091: my $cwosec=$url; 3092: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/; 3093: unless (&allowed('ccr',$cwosec)) { 3094: &logthis('Refused custom assignrole: '. 3095: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '. 3096: $ENV{'user.name'}.' at '.$ENV{'user.domain'}); 3097: return 'refused'; 3098: } 3099: $mrole='cr'; 3100: } else { 3101: my $cwosec=$url; 3102: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/; 3103: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) { 3104: &logthis('Refused assignrole: '. 3105: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '. 3106: $ENV{'user.name'}.' at '.$ENV{'user.domain'}); 3107: return 'refused'; 3108: } 3109: $mrole=$role; 3110: } 3111: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:". 3112: "$udom:$uname:$url".'_'."$mrole=$role"; 3113: if ($end) { $command.='_'.$end; } 3114: if ($start) { 3115: if ($end) { 3116: $command.='_'.$start; 3117: } else { 3118: $command.='_0_'.$start; 3119: } 3120: } 3121: # actually delete 3122: if ($deleteflag) { 3123: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) { 3124: # modify command to delete the role 3125: $command="encrypt:rolesdel:$ENV{'user.domain'}:$ENV{'user.name'}:". 3126: "$udom:$uname:$url".'_'."$mrole"; 3127: &logthis("$ENV{'user.name'} at $ENV{'user.domain'} deletes $mrole in $url for $uname at $udom"); 3128: # set start and finish to negative values for userrolelog 3129: $start=-1; 3130: $end=-1; 3131: } 3132: } 3133: # send command 3134: my $answer=&reply($command,&homeserver($uname,$udom)); 3135: # log new user role if status is ok 3136: if ($answer eq 'ok') { 3137: &userrolelog($mrole,$uname,$udom,$url,$start,$end); 3138: } 3139: return $answer; 3140: } 3141: 3142: # -------------------------------------------------- Modify user authentication 3143: # Overrides without validation 3144: 3145: sub modifyuserauth { 3146: my ($udom,$uname,$umode,$upass)=@_; 3147: my $uhome=&homeserver($uname,$udom); 3148: unless (&allowed('mau',$udom)) { return 'refused'; } 3149: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '. 3150: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}. 3151: ' in domain '.$ENV{'request.role.domain'}); 3152: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'. 3153: &escape($upass),$uhome); 3154: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'}, 3155: 'Authentication changed for '.$udom.', '.$uname.', '.$umode. 3156: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 3157: &log($udom,,$uname,$uhome, 3158: 'Authentication changed by '.$ENV{'user.domain'}.', '. 3159: $ENV{'user.name'}.', '.$umode. 3160: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 3161: unless ($reply eq 'ok') { 3162: &logthis('Authentication mode error: '.$reply); 3163: return 'error: '.$reply; 3164: } 3165: return 'ok'; 3166: } 3167: 3168: # --------------------------------------------------------------- Modify a user 3169: 3170: sub modifyuser { 3171: my ($udom, $uname, $uid, 3172: $umode, $upass, $first, 3173: $middle, $last, $gene, 3174: $forceid, $desiredhome, $email)=@_; 3175: $udom=~s/\W//g; 3176: $uname=~s/\W//g; 3177: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '. 3178: $umode.', '.$first.', '.$middle.', '. 3179: $last.', '.$gene.'(forceid: '.$forceid.')'. 3180: (defined($desiredhome) ? ' desiredhome = '.$desiredhome : 3181: ' desiredhome not specified'). 3182: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}. 3183: ' in domain '.$ENV{'request.role.domain'}); 3184: my $uhome=&homeserver($uname,$udom,'true'); 3185: # ----------------------------------------------------------------- Create User 3186: if (($uhome eq 'no_host') && 3187: (($umode && $upass) || ($umode eq 'localauth'))) { 3188: my $unhome=''; 3189: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) { 3190: $unhome = $desiredhome; 3191: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) { 3192: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'}; 3193: } else { # load balancing routine for determining $unhome 3194: my $tryserver; 3195: my $loadm=10000000; 3196: foreach $tryserver (keys %libserv) { 3197: if ($hostdom{$tryserver} eq $udom) { 3198: my $answer=reply('load',$tryserver); 3199: if (($answer=~/\d+/) && ($answer<$loadm)) { 3200: $loadm=$answer; 3201: $unhome=$tryserver; 3202: } 3203: } 3204: } 3205: } 3206: if (($unhome eq '') || ($unhome eq 'no_host')) { 3207: return 'error: unable to find a home server for '.$uname. 3208: ' in domain '.$udom; 3209: } 3210: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'. 3211: &escape($upass),$unhome); 3212: unless ($reply eq 'ok') { 3213: return 'error: '.$reply; 3214: } 3215: $uhome=&homeserver($uname,$udom,'true'); 3216: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) { 3217: return 'error: unable verify users home machine.'; 3218: } 3219: } # End of creation of new user 3220: # ---------------------------------------------------------------------- Add ID 3221: if ($uid) { 3222: $uid=~tr/A-Z/a-z/; 3223: my %uidhash=&idrget($udom,$uname); 3224: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 3225: && (!$forceid)) { 3226: unless ($uid eq $uidhash{$uname}) { 3227: return 'error: user id "'.$uid.'" does not match '. 3228: 'current user id "'.$uidhash{$uname}.'".'; 3229: } 3230: } else { 3231: &idput($udom,($uname => $uid)); 3232: } 3233: } 3234: # -------------------------------------------------------------- Add names, etc 3235: my @tmp=&get('environment', 3236: ['firstname','middlename','lastname','generation'], 3237: $udom,$uname); 3238: my %names; 3239: if ($tmp[0] =~ m/^error:.*/) { 3240: %names=(); 3241: } else { 3242: %names = @tmp; 3243: } 3244: # 3245: # Make sure to not trash student environment if instructor does not bother 3246: # to supply name and email information 3247: # 3248: if ($first) { $names{'firstname'} = $first; } 3249: if (defined($middle)) { $names{'middlename'} = $middle; } 3250: if ($last) { $names{'lastname'} = $last; } 3251: if (defined($gene)) { $names{'generation'} = $gene; } 3252: if ($email) { $names{'notification'} = $email; 3253: $names{'critnotification'} = $email; } 3254: 3255: my $reply = &put('environment', \%names, $udom,$uname); 3256: if ($reply ne 'ok') { return 'error: '.$reply; } 3257: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '. 3258: $umode.', '.$first.', '.$middle.', '. 3259: $last.', '.$gene.' by '. 3260: $ENV{'user.name'}.' at '.$ENV{'user.domain'}); 3261: return 'ok'; 3262: } 3263: 3264: # -------------------------------------------------------------- Modify student 3265: 3266: sub modifystudent { 3267: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec, 3268: $end,$start,$forceid,$desiredhome,$email,$type,$cid)=@_; 3269: if (!$cid) { 3270: unless ($cid=$ENV{'request.course.id'}) { 3271: return 'not_in_class'; 3272: } 3273: } 3274: # --------------------------------------------------------------- Make the user 3275: my $reply=&modifyuser 3276: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid, 3277: $desiredhome,$email); 3278: unless ($reply eq 'ok') { return $reply; } 3279: # This will cause &modify_student_enrollment to get the uid from the 3280: # students environment 3281: $uid = undef if (!$forceid); 3282: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last, 3283: $gene,$usec,$end,$start,$type,$cid); 3284: return $reply; 3285: } 3286: 3287: sub modify_student_enrollment { 3288: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type, 3289: $cid) = @_; 3290: my ($cdom,$cnum,$chome); 3291: if (!$cid) { 3292: unless ($cid=$ENV{'request.course.id'}) { 3293: return 'not_in_class'; 3294: } 3295: $cdom=$ENV{'course.'.$cid.'.domain'}; 3296: $cnum=$ENV{'course.'.$cid.'.num'}; 3297: } else { 3298: ($cdom,$cnum)=split(/_/,$cid); 3299: } 3300: $chome=$ENV{'course.'.$cid.'.home'}; 3301: if (!$chome) { 3302: $chome=&homeserver($cnum,$cdom); 3303: } 3304: if (!$chome) { return 'unknown_course'; } 3305: # Make sure the user exists 3306: my $uhome=&homeserver($uname,$udom); 3307: if (($uhome eq '') || ($uhome eq 'no_host')) { 3308: return 'error: no such user'; 3309: } 3310: # Get student data if we were not given enough information 3311: if (!defined($first) || $first eq '' || 3312: !defined($last) || $last eq '' || 3313: !defined($uid) || $uid eq '' || 3314: !defined($middle) || $middle eq '' || 3315: !defined($gene) || $gene eq '') { 3316: # They did not supply us with enough data to enroll the student, so 3317: # we need to pick up more information. 3318: my %tmp = &get('environment', 3319: ['firstname','middlename','lastname', 'generation','id'] 3320: ,$udom,$uname); 3321: 3322: #foreach (keys(%tmp)) { 3323: # &logthis("key $_ = ".$tmp{$_}); 3324: #} 3325: $first = $tmp{'firstname'} if (!defined($first) || $first eq ''); 3326: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq ''); 3327: $last = $tmp{'lastname'} if (!defined($last) || $last eq ''); 3328: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq ''); 3329: $uid = $tmp{'id'} if (!defined($uid) || $uid eq ''); 3330: } 3331: my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene, 3332: $first,$middle); 3333: my $reply=cput('classlist', 3334: {"$uname:$udom" => 3335: join(':',$end,$start,$uid,$usec,$fullname,$type) }, 3336: $cdom,$cnum); 3337: unless (($reply eq 'ok') || ($reply eq 'delayed')) { 3338: return 'error: '.$reply; 3339: } 3340: # Add student role to user 3341: my $uurl='/'.$cid; 3342: $uurl=~s/\_/\//g; 3343: if ($usec) { 3344: $uurl.='/'.$usec; 3345: } 3346: return &assignrole($udom,$uname,$uurl,'st',$end,$start); 3347: } 3348: 3349: # ------------------------------------------------- Write to course preferences 3350: 3351: sub writecoursepref { 3352: my ($courseid,%prefs)=@_; 3353: $courseid=~s/^\///; 3354: $courseid=~s/\_/\//g; 3355: my ($cdomain,$cnum)=split(/\//,$courseid); 3356: my $chome=homeserver($cnum,$cdomain); 3357: if (($chome eq '') || ($chome eq 'no_host')) { 3358: return 'error: no such course'; 3359: } 3360: my $cstring=''; 3361: foreach (keys %prefs) { 3362: $cstring.=escape($_).'='.escape($prefs{$_}).'&'; 3363: } 3364: $cstring=~s/\&$//; 3365: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome); 3366: } 3367: 3368: # ---------------------------------------------------------- Make/modify course 3369: 3370: sub createcourse { 3371: my ($udom,$description,$url,$course_server,$nonstandard)=@_; 3372: $url=&declutter($url); 3373: my $cid=''; 3374: unless (&allowed('ccc',$udom)) { 3375: return 'refused'; 3376: } 3377: # ------------------------------------------------------------------- Create ID 3378: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)). 3379: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 3380: # ----------------------------------------------- Make sure that does not exist 3381: my $uhome=&homeserver($uname,$udom,'true'); 3382: unless (($uhome eq '') || ($uhome eq 'no_host')) { 3383: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)). 3384: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 3385: $uhome=&homeserver($uname,$udom,'true'); 3386: unless (($uhome eq '') || ($uhome eq 'no_host')) { 3387: return 'error: unable to generate unique course-ID'; 3388: } 3389: } 3390: # ------------------------------------------------ Check supplied server name 3391: $course_server = $ENV{'user.homeserver'} if (! defined($course_server)); 3392: if (! exists($libserv{$course_server})) { 3393: return 'error:bad server name '.$course_server; 3394: } 3395: # ------------------------------------------------------------- Make the course 3396: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::', 3397: $course_server); 3398: unless ($reply eq 'ok') { return 'error: '.$reply; } 3399: $uhome=&homeserver($uname,$udom,'true'); 3400: if (($uhome eq '') || ($uhome eq 'no_host')) { 3401: return 'error: no such course'; 3402: } 3403: # ----------------------------------------------------------------- Course made 3404: # log existance 3405: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description), 3406: $uhome); 3407: &flushcourselogs(); 3408: # set toplevel url 3409: my $topurl=$url; 3410: unless ($nonstandard) { 3411: # ------------------------------------------ For standard courses, make top url 3412: my $mapurl=&clutter($url); 3413: if ($mapurl eq '/res/') { $mapurl=''; } 3414: $ENV{'form.initmap'}=(<<ENDINITMAP); 3415: <map> 3416: <resource id="1" type="start"></resource> 3417: <resource id="2" src="$mapurl"></resource> 3418: <resource id="3" type="finish"></resource> 3419: <link index="1" from="1" to="2"></link> 3420: <link index="2" from="2" to="3"></link> 3421: </map> 3422: ENDINITMAP 3423: $topurl=&declutter( 3424: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence') 3425: ); 3426: } 3427: # ----------------------------------------------------------- Write preferences 3428: &writecoursepref($udom.'_'.$uname, 3429: ('description' => $description, 3430: 'url' => $topurl)); 3431: return '/'.$udom.'/'.$uname; 3432: } 3433: 3434: # ---------------------------------------------------------- Assign Custom Role 3435: 3436: sub assigncustomrole { 3437: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_; 3438: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename, 3439: $end,$start,$deleteflag); 3440: } 3441: 3442: # ----------------------------------------------------------------- Revoke Role 3443: 3444: sub revokerole { 3445: my ($udom,$uname,$url,$role,$deleteflag)=@_; 3446: my $now=time; 3447: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag); 3448: } 3449: 3450: # ---------------------------------------------------------- Revoke Custom Role 3451: 3452: sub revokecustomrole { 3453: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_; 3454: my $now=time; 3455: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now, 3456: $deleteflag); 3457: } 3458: 3459: # ------------------------------------------------------------ Directory lister 3460: 3461: sub dirlist { 3462: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_; 3463: 3464: $uri=~s/^\///; 3465: $uri=~s/\/$//; 3466: my ($udom, $uname); 3467: (undef,$udom,$uname)=split(/\//,$uri); 3468: if(defined($userdomain)) { 3469: $udom = $userdomain; 3470: } 3471: if(defined($username)) { 3472: $uname = $username; 3473: } 3474: 3475: my $dirRoot = $perlvar{'lonDocRoot'}; 3476: if(defined($alternateDirectoryRoot)) { 3477: $dirRoot = $alternateDirectoryRoot; 3478: $dirRoot =~ s/\/$//; 3479: } 3480: 3481: if($udom) { 3482: if($uname) { 3483: my $listing=reply('ls:'.$dirRoot.'/'.$uri, 3484: homeserver($uname,$udom)); 3485: return split(/:/,$listing); 3486: } elsif(!defined($alternateDirectoryRoot)) { 3487: my $tryserver; 3488: my %allusers=(); 3489: foreach $tryserver (keys %libserv) { 3490: if($hostdom{$tryserver} eq $udom) { 3491: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'. 3492: $udom, $tryserver); 3493: if (($listing ne 'no_such_dir') && ($listing ne 'empty') 3494: && ($listing ne 'con_lost')) { 3495: foreach (split(/:/,$listing)) { 3496: my ($entry,@stat)=split(/&/,$_); 3497: $allusers{$entry}=1; 3498: } 3499: } 3500: } 3501: } 3502: my $alluserstr=''; 3503: foreach (sort keys %allusers) { 3504: $alluserstr.=$_.'&user:'; 3505: } 3506: $alluserstr=~s/:$//; 3507: return split(/:/,$alluserstr); 3508: } else { 3509: my @emptyResults = (); 3510: push(@emptyResults, 'missing user name'); 3511: return split(':',@emptyResults); 3512: } 3513: } elsif(!defined($alternateDirectoryRoot)) { 3514: my $tryserver; 3515: my %alldom=(); 3516: foreach $tryserver (keys %libserv) { 3517: $alldom{$hostdom{$tryserver}}=1; 3518: } 3519: my $alldomstr=''; 3520: foreach (sort keys %alldom) { 3521: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:'; 3522: } 3523: $alldomstr=~s/:$//; 3524: return split(/:/,$alldomstr); 3525: } else { 3526: my @emptyResults = (); 3527: push(@emptyResults, 'missing domain'); 3528: return split(':',@emptyResults); 3529: } 3530: } 3531: 3532: # --------------------------------------------- GetFileTimestamp 3533: # This function utilizes dirlist and returns the date stamp for 3534: # when it was last modified. It will also return an error of -1 3535: # if an error occurs 3536: 3537: ## 3538: ## FIXME: This subroutine assumes its caller knows something about the 3539: ## directory structure of the home server for the student ($root). 3540: ## Not a good assumption to make. Since this is for looking up files 3541: ## in user directories, the full path should be constructed by lond, not 3542: ## whatever machine we request data from. 3543: ## 3544: sub GetFileTimestamp { 3545: my ($studentDomain,$studentName,$filename,$root)=@_; 3546: $studentDomain=~s/\W//g; 3547: $studentName=~s/\W//g; 3548: my $subdir=$studentName.'__'; 3549: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/; 3550: my $proname="$studentDomain/$subdir/$studentName"; 3551: $proname .= '/'.$filename; 3552: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain, 3553: $studentName, $root); 3554: my @stats = split('&', $fileStat); 3555: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 3556: # @stats contains first the filename, then the stat output 3557: return $stats[10]; # so this is 10 instead of 9. 3558: } else { 3559: return -1; 3560: } 3561: } 3562: 3563: # -------------------------------------------------------- Value of a Condition 3564: 3565: sub directcondval { 3566: my $number=shift; 3567: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) { 3568: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1); 3569: } else { 3570: return 2; 3571: } 3572: } 3573: 3574: sub condval { 3575: my $condidx=shift; 3576: my $result=0; 3577: my $allpathcond=''; 3578: foreach (split(/\|/,$condidx)) { 3579: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) { 3580: $allpathcond.= 3581: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|'; 3582: } 3583: } 3584: $allpathcond=~s/\|$//; 3585: if ($ENV{'request.course.id'}) { 3586: if ($allpathcond) { 3587: my $operand='|'; 3588: my @stack; 3589: foreach ($allpathcond=~/(\d+|$|$|\&|\|)/g) { 3590: if ($_ eq '(') { 3591: push @stack,($operand,$result) 3592: } elsif ($_ eq ')') { 3593: my $before=pop @stack; 3594: if (pop @stack eq '&') { 3595: $result=$result>$before?$before:$result; 3596: } else { 3597: $result=$result>$before?$result:$before; 3598: } 3599: } elsif (($_ eq '&') || ($_ eq '|')) { 3600: $operand=$_; 3601: } else { 3602: my $new=directcondval($_); 3603: if ($operand eq '&') { 3604: $result=$result>$new?$new:$result; 3605: } else { 3606: $result=$result>$new?$result:$new; 3607: } 3608: } 3609: } 3610: } 3611: } 3612: return $result; 3613: } 3614: 3615: # ---------------------------------------------------- Devalidate courseresdata 3616: 3617: sub devalidatecourseresdata { 3618: my ($coursenum,$coursedomain)=@_; 3619: my $hashid=$coursenum.':'.$coursedomain; 3620: &devalidate_cache(\%courseresdatacache,$hashid,'courseres'); 3621: } 3622: 3623: # --------------------------------------------------- Course Resourcedata Query 3624: 3625: sub courseresdata { 3626: my ($coursenum,$coursedomain,@which)=@_; 3627: my $coursehom=&homeserver($coursenum,$coursedomain); 3628: my $hashid=$coursenum.':'.$coursedomain; 3629: my ($result,$cached)=&is_cached(\%courseresdatacache,$hashid,'courseres'); 3630: unless (defined($cached)) { 3631: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum); 3632: $result=\%dumpreply; 3633: my ($tmp) = keys(%dumpreply); 3634: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 3635: &do_cache(\%courseresdatacache,$hashid,$result,'courseres'); 3636: } elsif ($tmp =~ /^(con_lost|no_such_host)/) { 3637: return $tmp; 3638: } elsif ($tmp =~ /^(error)/) { 3639: $result=undef; 3640: &do_cache(\%courseresdatacache,$hashid,$result,'courseres'); 3641: } 3642: } 3643: foreach my $item (@which) { 3644: if (defined($result->{$item})) { 3645: return $result->{$item}; 3646: } 3647: } 3648: return undef; 3649: } 3650: 3651: # 3652: # EXT resource caching routines 3653: # 3654: 3655: sub clear_EXT_cache_status { 3656: &delenv('cache.EXT.'); 3657: } 3658: 3659: sub EXT_cache_status { 3660: my ($target_domain,$target_user) = @_; 3661: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 3662: if (exists($ENV{$cachename}) && ($ENV{$cachename}+600) > time) { 3663: # We know already the user has no data 3664: return 1; 3665: } else { 3666: return 0; 3667: } 3668: } 3669: 3670: sub EXT_cache_set { 3671: my ($target_domain,$target_user) = @_; 3672: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 3673: &appenv($cachename => time); 3674: } 3675: 3676: # --------------------------------------------------------- Value of a Variable 3677: sub EXT { 3678: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_; 3679: 3680: unless ($varname) { return ''; } 3681: #get real user name/domain, courseid and symb 3682: my $courseid; 3683: my $publicuser; 3684: if ($symbparm) { 3685: $symbparm=&get_symb_from_alias($symbparm); 3686: } 3687: if (!($uname && $udom)) { 3688: (my $cursymb,$courseid,$udom,$uname,$publicuser)= 3689: &Apache::lonxml::whichuser($symbparm); 3690: if (!$symbparm) { $symbparm=$cursymb; } 3691: } else { 3692: $courseid=$ENV{'request.course.id'}; 3693: } 3694: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname); 3695: my $rest; 3696: if (defined($therest[0])) { 3697: $rest=join('.',@therest); 3698: } else { 3699: $rest=''; 3700: } 3701: 3702: my $qualifierrest=$qualifier; 3703: if ($rest) { $qualifierrest.='.'.$rest; } 3704: my $spacequalifierrest=$space; 3705: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; } 3706: if ($realm eq 'user') { 3707: # --------------------------------------------------------------- user.resource 3708: if ($space eq 'resource') { 3709: if (defined($Apache::lonhomework::parsing_a_problem)) { 3710: return $Apache::lonhomework::history{$qualifierrest}; 3711: } else { 3712: my %restored; 3713: if ($publicuser || $ENV{'request.state'} eq 'construct') { 3714: %restored=&tmprestore($symbparm,$courseid,$udom,$uname); 3715: } else { 3716: %restored=&restore($symbparm,$courseid,$udom,$uname); 3717: } 3718: return $restored{$qualifierrest}; 3719: } 3720: # ----------------------------------------------------------------- user.access 3721: } elsif ($space eq 'access') { 3722: # FIXME - not supporting calls for a specific user 3723: return &allowed($qualifier,$rest); 3724: # ------------------------------------------ user.preferences, user.environment 3725: } elsif (($space eq 'preferences') || ($space eq 'environment')) { 3726: if (($uname eq $ENV{'user.name'}) && 3727: ($udom eq $ENV{'user.domain'})) { 3728: return $ENV{join('.',('environment',$qualifierrest))}; 3729: } else { 3730: my %returnhash; 3731: if (!$publicuser) { 3732: %returnhash=&userenvironment($udom,$uname, 3733: $qualifierrest); 3734: } 3735: return $returnhash{$qualifierrest}; 3736: } 3737: # ----------------------------------------------------------------- user.course 3738: } elsif ($space eq 'course') { 3739: # FIXME - not supporting calls for a specific user 3740: return $ENV{join('.',('request.course',$qualifier))}; 3741: # ------------------------------------------------------------------- user.role 3742: } elsif ($space eq 'role') { 3743: # FIXME - not supporting calls for a specific user 3744: my ($role,$where)=split(/\./,$ENV{'request.role'}); 3745: if ($qualifier eq 'value') { 3746: return $role; 3747: } elsif ($qualifier eq 'extent') { 3748: return $where; 3749: } 3750: # ----------------------------------------------------------------- user.domain 3751: } elsif ($space eq 'domain') { 3752: return $udom; 3753: # ------------------------------------------------------------------- user.name 3754: } elsif ($space eq 'name') { 3755: return $uname; 3756: # ---------------------------------------------------- Any other user namespace 3757: } else { 3758: my %reply; 3759: if (!$publicuser) { 3760: %reply=&get($space,[$qualifierrest],$udom,$uname); 3761: } 3762: return $reply{$qualifierrest}; 3763: } 3764: } elsif ($realm eq 'query') { 3765: # ---------------------------------------------- pull stuff out of query string 3766: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 3767: [$spacequalifierrest]); 3768: return $ENV{'form.'.$spacequalifierrest}; 3769: } elsif ($realm eq 'request') { 3770: # ------------------------------------------------------------- request.browser 3771: if ($space eq 'browser') { 3772: if ($qualifier eq 'textremote') { 3773: if (&mt('textual_remote_display') eq 'on') { 3774: return 1; 3775: } else { 3776: return 0; 3777: } 3778: } else { 3779: return $ENV{'browser.'.$qualifier}; 3780: } 3781: # ------------------------------------------------------------ request.filename 3782: } else { 3783: return $ENV{'request.'.$spacequalifierrest}; 3784: } 3785: } elsif ($realm eq 'course') { 3786: # ---------------------------------------------------------- course.description 3787: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest}; 3788: } elsif ($realm eq 'resource') { 3789: 3790: my $section; 3791: if (defined($courseid) && $courseid eq $ENV{'request.course.id'}) { 3792: 3793: #print ' '.$space.' - '.$qualifier.' - '.$spacequalifierrest; 3794: 3795: # ----------------------------------------------------- Cascading lookup scheme 3796: if (!$symbparm) { $symbparm=&symbread(); } 3797: my $symbp=$symbparm; 3798: my $mapp=(&decode_symb($symbp))[0]; 3799: 3800: my $symbparm=$symbp.'.'.$spacequalifierrest; 3801: my $mapparm=$mapp.'___(all).'.$spacequalifierrest; 3802: 3803: if (($ENV{'user.name'} eq $uname) && 3804: ($ENV{'user.domain'} eq $udom)) { 3805: $section=$ENV{'request.course.sec'}; 3806: } else { 3807: if (! defined($usection)) { 3808: $section=&usection($udom,$uname,$courseid); 3809: } else { 3810: $section = $usection; 3811: } 3812: } 3813: 3814: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest; 3815: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm; 3816: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm; 3817: 3818: my $courselevel=$courseid.'.'.$spacequalifierrest; 3819: my $courselevelr=$courseid.'.'.$symbparm; 3820: my $courselevelm=$courseid.'.'.$mapparm; 3821: 3822: # ----------------------------------------------------------- first, check user 3823: #most student don\'t have any data set, check if there is some data 3824: if (! &EXT_cache_status($udom,$uname)) { 3825: my $hashid="$udom:$uname"; 3826: my ($result,$cached)=&is_cached(\%userresdatacache,$hashid, 3827: 'userres'); 3828: if (!defined($cached)) { 3829: my %resourcedata=&dump('resourcedata',$udom,$uname); 3830: $result=\%resourcedata; 3831: &do_cache(\%userresdatacache,$hashid,$result,'userres'); 3832: } 3833: my ($tmp)=keys(%$result); 3834: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) { 3835: if ($$result{$courselevelr}) { 3836: return $$result{$courselevelr}; } 3837: if ($$result{$courselevelm}) { 3838: return $$result{$courselevelm}; } 3839: if ($$result{$courselevel}) { 3840: return $$result{$courselevel}; } 3841: } else { 3842: #error 2 occurs when the .db doesn't exist 3843: if ($tmp!~/error: 2 /) { 3844: &logthis("WARNING:". 3845: " Trying to get resource data for ". 3846: $uname." at ".$udom.": ". 3847: $tmp.""); 3848: } elsif ($tmp=~/error: 2 /) { 3849: &EXT_cache_set($udom,$uname); 3850: } elsif ($tmp =~ /^(con_lost|no_such_host)/) { 3851: return $tmp; 3852: } 3853: } 3854: } 3855: 3856: # -------------------------------------------------------- second, check course 3857: 3858: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'}, 3859: $ENV{'course.'.$courseid.'.domain'}, 3860: ($seclevelr,$seclevelm,$seclevel, 3861: $courselevelr,$courselevelm, 3862: $courselevel)); 3863: if (defined($coursereply)) { return $coursereply; } 3864: 3865: # ------------------------------------------------------ third, check map parms 3866: my %parmhash=(); 3867: my $thisparm=''; 3868: if (tie(%parmhash,'GDBM_File', 3869: $ENV{'request.course.fn'}.'_parms.db', 3870: &GDBM_READER(),0640)) { 3871: $thisparm=$parmhash{$symbparm}; 3872: untie(%parmhash); 3873: } 3874: if ($thisparm) { return $thisparm; } 3875: } 3876: # --------------------------------------------- last, look in resource metadata 3877: 3878: $spacequalifierrest=~s/\./\_/; 3879: my $filename; 3880: if (!$symbparm) { $symbparm=&symbread(); } 3881: if ($symbparm) { 3882: $filename=(&decode_symb($symbparm))[2]; 3883: } else { 3884: $filename=$ENV{'request.filename'}; 3885: } 3886: my $metadata=&metadata($filename,$spacequalifierrest); 3887: if (defined($metadata)) { return $metadata; } 3888: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest); 3889: if (defined($metadata)) { return $metadata; } 3890: 3891: # ------------------------------------------------------------------ Cascade up 3892: unless ($space eq '0') { 3893: my @parts=split(/_/,$space); 3894: my $id=pop(@parts); 3895: my $part=join('_',@parts); 3896: if ($part eq '') { $part='0'; } 3897: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest, 3898: $symbparm,$udom,$uname,$section,1); 3899: if (defined($partgeneral)) { return $partgeneral; } 3900: } 3901: if ($recurse) { return undef; } 3902: my $pack_def=&packages_tab_default($filename,$varname); 3903: if (defined($pack_def)) { return $pack_def; } 3904: 3905: # ---------------------------------------------------- Any other user namespace 3906: } elsif ($realm eq 'environment') { 3907: # ----------------------------------------------------------------- environment 3908: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) { 3909: return $ENV{'environment.'.$spacequalifierrest}; 3910: } else { 3911: my %returnhash=&userenvironment($udom,$uname, 3912: $spacequalifierrest); 3913: return $returnhash{$spacequalifierrest}; 3914: } 3915: } elsif ($realm eq 'system') { 3916: # ----------------------------------------------------------------- system.time 3917: if ($space eq 'time') { 3918: return time; 3919: } 3920: } 3921: return ''; 3922: } 3923: 3924: sub packages_tab_default { 3925: my ($uri,$varname)=@_; 3926: my (undef,$part,$name)=split(/\./,$varname); 3927: my $packages=&metadata($uri,'packages'); 3928: foreach my $package (split(/,/,$packages)) { 3929: my ($pack_type,$pack_part)=split(/_/,$package,2); 3930: if (defined($packagetab{"$pack_type&$name&default"})) { 3931: return $packagetab{"$pack_type&$name&default"}; 3932: } 3933: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) { 3934: return $packagetab{$pack_type."_".$pack_part."&$name&default"}; 3935: } 3936: } 3937: return undef; 3938: } 3939: 3940: sub add_prefix_and_part { 3941: my ($prefix,$part)=@_; 3942: my $keyroot; 3943: if (defined($prefix) && $prefix !~ /^__/) { 3944: # prefix that has a part already 3945: $keyroot=$prefix; 3946: } elsif (defined($prefix)) { 3947: # prefix that is missing a part 3948: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); } 3949: } else { 3950: # no prefix at all 3951: if (defined($part)) { $keyroot='_'.$part; } 3952: } 3953: return $keyroot; 3954: } 3955: 3956: # ---------------------------------------------------------------- Get metadata 3957: 3958: sub metadata { 3959: my ($uri,$what,$liburi,$prefix,$depthcount)=@_; 3960: $uri=&declutter($uri); 3961: # if it is a non metadata possible uri return quickly 3962: if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) || 3963: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) || 3964: ($uri =~ m|home/[^/]+/public_html/|)) { 3965: return undef; 3966: } 3967: my $filename=$uri; 3968: $uri=~s/\.meta$//; 3969: # 3970: # Is the metadata already cached? 3971: # Look at timestamp of caching 3972: # Everything is cached by the main uri, libraries are never directly cached 3973: # 3974: if (!defined($liburi)) { 3975: my ($result,$cached)=&is_cached(\%metacache,$uri,'meta'); 3976: if (defined($cached)) { return $result->{':'.$what}; } 3977: } 3978: { 3979: # 3980: # Is this a recursive call for a library? 3981: # 3982: if (! exists($metacache{$uri})) { 3983: $metacache{$uri}={}; 3984: } 3985: if ($liburi) { 3986: $liburi=&declutter($liburi); 3987: $filename=$liburi; 3988: } else { 3989: &devalidate_cache(\%metacache,$uri,'meta'); 3990: } 3991: my %metathesekeys=(); 3992: unless ($filename=~/\.meta$/) { $filename.='.meta'; } 3993: my $metastring; 3994: if ($uri !~ m|^uploaded/|) { 3995: $metastring=&getfile(&filelocation('',&clutter($filename))); 3996: } 3997: my $parser=HTML::LCParser->new(\$metastring); 3998: my $token; 3999: undef %metathesekeys; 4000: while ($token=$parser->get_token) { 4001: if ($token->[0] eq 'S') { 4002: if (defined($token->[2]->{'package'})) { 4003: # 4004: # This is a package - get package info 4005: # 4006: my $package=$token->[2]->{'package'}; 4007: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 4008: if (defined($token->[2]->{'id'})) { 4009: $keyroot.='_'.$token->[2]->{'id'}; 4010: } 4011: if ($metacache{$uri}->{':packages'}) { 4012: $metacache{$uri}->{':packages'}.=','.$package.$keyroot; 4013: } else { 4014: $metacache{$uri}->{':packages'}=$package.$keyroot; 4015: } 4016: foreach (keys %packagetab) { 4017: my $part=$keyroot; 4018: $part=~s/^\_//; 4019: if ($_=~/^\Q$package\E\&/ || 4020: $_=~/^\Q$package\E_0\&/) { 4021: my ($pack,$name,$subp)=split(/\&/,$_); 4022: # ignore package.tab specified default values 4023: # here &package_tab_default() will fetch those 4024: if ($subp eq 'default') { next; } 4025: my $value=$packagetab{$_}; 4026: my $unikey; 4027: if ($pack =~ /_0$/) { 4028: $unikey='parameter_0_'.$name; 4029: $part=0; 4030: } else { 4031: $unikey='parameter'.$keyroot.'_'.$name; 4032: } 4033: if ($subp eq 'display') { 4034: $value.=' [Part: '.$part.']'; 4035: } 4036: $metacache{$uri}->{':'.$unikey.'.part'}=$part; 4037: $metathesekeys{$unikey}=1; 4038: unless (defined($metacache{$uri}->{':'.$unikey.'.'.$subp})) { 4039: $metacache{$uri}->{':'.$unikey.'.'.$subp}=$value; 4040: } 4041: if (defined($metacache{$uri}->{':'.$unikey.'.default'})) { 4042: $metacache{$uri}->{':'.$unikey}= 4043: $metacache{$uri}->{':'.$unikey.'.default'}; 4044: } 4045: } 4046: } 4047: } else { 4048: # 4049: # This is not a package - some other kind of start tag 4050: # 4051: my $entry=$token->[1]; 4052: my $unikey; 4053: if ($entry eq 'import') { 4054: $unikey=''; 4055: } else { 4056: $unikey=$entry; 4057: } 4058: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 4059: 4060: if (defined($token->[2]->{'id'})) { 4061: $unikey.='_'.$token->[2]->{'id'}; 4062: } 4063: 4064: if ($entry eq 'import') { 4065: # 4066: # Importing a library here 4067: # 4068: if ($depthcount<20) { 4069: my $location=$parser->get_text('/import'); 4070: my $dir=$filename; 4071: $dir=~s|[^/]*$||; 4072: $location=&filelocation($dir,$location); 4073: foreach (sort(split(/\,/,&metadata($uri,'keys', 4074: $location,$unikey, 4075: $depthcount+1)))) { 4076: $metacache{$uri}->{':'.$_}=$metacache{$uri}->{':'.$_}; 4077: $metathesekeys{$_}=1; 4078: } 4079: } 4080: } else { 4081: 4082: if (defined($token->[2]->{'name'})) { 4083: $unikey.='_'.$token->[2]->{'name'}; 4084: } 4085: $metathesekeys{$unikey}=1; 4086: foreach (@{$token->[3]}) { 4087: $metacache{$uri}->{':'.$unikey.'.'.$_}=$token->[2]->{$_}; 4088: } 4089: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry)); 4090: my $default=$metacache{$uri}->{':'.$unikey.'.default'}; 4091: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) { 4092: # only ws inside the tag, and not in default, so use default 4093: # as value 4094: $metacache{$uri}->{':'.$unikey}=$default; 4095: } else { 4096: # either something interesting inside the tag or default 4097: # uninteresting 4098: $metacache{$uri}->{':'.$unikey}=$internaltext; 4099: } 4100: # end of not-a-package not-a-library import 4101: } 4102: # end of not-a-package start tag 4103: } 4104: # the next is the end of "start tag" 4105: } 4106: } 4107: my ($extension) = ($uri =~ /\.(\w+)$/); 4108: foreach my $key (sort(keys(%packagetab))) { 4109: #&logthis("extsion1 $extension $key !!"); 4110: #no specific packages #how's our extension 4111: if ($key!~/^extension_\Q$extension\E&/) { next; } 4112: &metadata_create_package_def($uri,$key,'extension_'.$extension, 4113: \%metathesekeys); 4114: } 4115: if (!exists($metacache{$uri}->{':packages'})) { 4116: foreach my $key (sort(keys(%packagetab))) { 4117: #no specific packages well let's get default then 4118: if ($key!~/^default&/) { next; } 4119: &metadata_create_package_def($uri,$key,'default', 4120: \%metathesekeys); 4121: } 4122: } 4123: # are there custom rights to evaluate 4124: if ($metacache{$uri}->{':copyright'} eq 'custom') { 4125: 4126: # 4127: # Importing a rights file here 4128: # 4129: unless ($depthcount) { 4130: my $location=$metacache{$uri}->{':customdistributionfile'}; 4131: my $dir=$filename; 4132: $dir=~s|[^/]*$||; 4133: $location=&filelocation($dir,$location); 4134: foreach (sort(split(/\,/,&metadata($uri,'keys', 4135: $location,'_rights', 4136: $depthcount+1)))) { 4137: $metacache{$uri}->{':'.$_}=$metacache{$uri}->{':'.$_}; 4138: $metathesekeys{$_}=1; 4139: } 4140: } 4141: } 4142: $metacache{$uri}->{':keys'}=join(',',keys %metathesekeys); 4143: &metadata_generate_part0(\%metathesekeys,$metacache{$uri},$uri); 4144: $metacache{$uri}->{':allpossiblekeys'}=join(',',keys %metathesekeys); 4145: &do_cache(\%metacache,$uri,$metacache{$uri},'meta'); 4146: # this is the end of "was not already recently cached 4147: } 4148: return $metacache{$uri}->{':'.$what}; 4149: } 4150: 4151: sub metadata_create_package_def { 4152: my ($uri,$key,$package,$metathesekeys)=@_; 4153: my ($pack,$name,$subp)=split(/\&/,$key); 4154: if ($subp eq 'default') { next; } 4155: 4156: if (defined($metacache{$uri}->{':packages'})) { 4157: $metacache{$uri}->{':packages'}.=','.$package; 4158: } else { 4159: $metacache{$uri}->{':packages'}=$package; 4160: } 4161: my $value=$packagetab{$key}; 4162: my $unikey; 4163: $unikey='parameter_0_'.$name; 4164: $metacache{$uri}->{':'.$unikey.'.part'}=0; 4165: $$metathesekeys{$unikey}=1; 4166: unless (defined($metacache{$uri}->{':'.$unikey.'.'.$subp})) { 4167: $metacache{$uri}->{':'.$unikey.'.'.$subp}=$value; 4168: } 4169: if (defined($metacache{$uri}->{':'.$unikey.'.default'})) { 4170: $metacache{$uri}->{':'.$unikey}= 4171: $metacache{$uri}->{':'.$unikey.'.default'}; 4172: } 4173: } 4174: 4175: sub metadata_generate_part0 { 4176: my ($metadata,$metacache,$uri) = @_; 4177: my %allnames; 4178: foreach my $metakey (sort keys %$metadata) { 4179: if ($metakey=~/^parameter\_(.*)/) { 4180: my $part=$$metacache{':'.$metakey.'.part'}; 4181: my $name=$$metacache{':'.$metakey.'.name'}; 4182: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) { 4183: $allnames{$name}=$part; 4184: } 4185: } 4186: } 4187: foreach my $name (keys(%allnames)) { 4188: $$metadata{"parameter_0_$name"}=1; 4189: my $key=":parameter_0_$name"; 4190: $$metacache{"$key.part"}='0'; 4191: $$metacache{"$key.name"}=$name; 4192: $$metacache{"$key.type"}=$$metacache{':parameter_'. 4193: $allnames{$name}.'_'.$name. 4194: '.type'}; 4195: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name. 4196: '.display'}; 4197: my $expr='\\[Part: '.$allnames{$name}.'\\]'; 4198: $olddis=~s/\Q$expr\E/\[Part: 0\]/; 4199: $$metacache{"$key.display"}=$olddis; 4200: } 4201: } 4202: 4203: # ------------------------------------------------- Get the title of a resource 4204: 4205: sub gettitle { 4206: my $urlsymb=shift; 4207: my $symb=&symbread($urlsymb); 4208: unless ($symb) { 4209: unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; } 4210: return &metadata($urlsymb,'title'); 4211: } 4212: my ($result,$cached)=&is_cached(\%titlecache,$symb,'title',600); 4213: if (defined($cached)) { return $result; } 4214: my ($map,$resid,$url)=&decode_symb($symb); 4215: my $title=''; 4216: my %bighash; 4217: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', 4218: &GDBM_READER(),0640)) { 4219: my $mapid=$bighash{'map_pc_'.&clutter($map)}; 4220: $title=$bighash{'title_'.$mapid.'.'.$resid}; 4221: untie %bighash; 4222: } 4223: $title=~s/\&colon\;/\:/gs; 4224: if ($title) { 4225: return &do_cache(\%titlecache,$symb,$title,'title'); 4226: } else { 4227: return &metadata($urlsymb,'title'); 4228: } 4229: } 4230: 4231: # ------------------------------------------------- Update symbolic store links 4232: 4233: sub symblist { 4234: my ($mapname,%newhash)=@_; 4235: $mapname=&deversion(&declutter($mapname)); 4236: my %hash; 4237: if (($ENV{'request.course.fn'}) && (%newhash)) { 4238: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db', 4239: &GDBM_WRCREAT(),0640)) { 4240: foreach (keys %newhash) { 4241: $hash{declutter($_)}=$mapname.'___'.&deversion($newhash{$_}); 4242: } 4243: if (untie(%hash)) { 4244: return 'ok'; 4245: } 4246: } 4247: } 4248: return 'error'; 4249: } 4250: 4251: # --------------------------------------------------------------- Verify a symb 4252: 4253: sub symbverify { 4254: my ($symb,$thisfn)=@_; 4255: $thisfn=&declutter($thisfn); 4256: # direct jump to resource in page or to a sequence - will construct own symbs 4257: if ($thisfn=~/\.(page|sequence)$/) { return 1; } 4258: # check URL part 4259: my ($map,$resid,$url)=&decode_symb($symb); 4260: 4261: unless ($url eq $thisfn) { return 0; } 4262: 4263: $symb=&symbclean($symb); 4264: $thisfn=&deversion($thisfn); 4265: 4266: my %bighash; 4267: my $okay=0; 4268: 4269: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', 4270: &GDBM_READER(),0640)) { 4271: my $ids=$bighash{'ids_'.&clutter($thisfn)}; 4272: unless ($ids) { 4273: $ids=$bighash{'ids_/'.$thisfn}; 4274: } 4275: if ($ids) { 4276: # ------------------------------------------------------------------- Has ID(s) 4277: foreach (split(/\,/,$ids)) { 4278: my ($mapid,$resid)=split(/\./,$_); 4279: if ( 4280: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn) 4281: eq $symb) { 4282: $okay=1; 4283: } 4284: } 4285: } 4286: untie(%bighash); 4287: } 4288: return $okay; 4289: } 4290: 4291: # --------------------------------------------------------------- Clean-up symb 4292: 4293: sub symbclean { 4294: my $symb=shift; 4295: 4296: # remove version from map 4297: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/; 4298: 4299: # remove version from URL 4300: $symb=~s/\.(\d+)\.(\w+)$/\.$2/; 4301: 4302: return $symb; 4303: } 4304: 4305: # ---------------------------------------------- Split symb to find map and url 4306: 4307: sub encode_symb { 4308: my ($map,$resid,$url)=@_; 4309: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url)); 4310: } 4311: 4312: sub decode_symb { 4313: my ($map,$resid,$url)=split(/\_\_\_/,shift); 4314: return (&fixversion($map),$resid,&fixversion($url)); 4315: } 4316: 4317: sub fixversion { 4318: my $fn=shift; 4319: if ($fn=~/^(adm|uploaded|public)/) { return $fn; } 4320: my %bighash; 4321: my $uri=&clutter($fn); 4322: my $key=$ENV{'request.course.id'}.'_'.$uri; 4323: # is this cached? 4324: my ($result,$cached)=&is_cached(\%courseresversioncache,$key, 4325: 'courseresversion',600); 4326: if (defined($cached)) { return $result; } 4327: # unfortunately not cached, or expired 4328: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', 4329: &GDBM_READER(),0640)) { 4330: if ($bighash{'version_'.$uri}) { 4331: my $version=$bighash{'version_'.$uri}; 4332: unless (($version eq 'mostrecent') || 4333: ($version==&getversion($uri))) { 4334: $uri=~s/\.(\w+)$/\.$version\.$1/; 4335: } 4336: } 4337: untie %bighash; 4338: } 4339: return &do_cache 4340: (\%courseresversioncache,$key,&declutter($uri),'courseresversion'); 4341: } 4342: 4343: sub deversion { 4344: my $url=shift; 4345: $url=~s/\.\d+\.(\w+)$/\.$1/; 4346: return $url; 4347: } 4348: 4349: # ------------------------------------------------------ Return symb list entry 4350: 4351: sub symbread { 4352: my ($thisfn,$donotrecurse)=@_; 4353: # no filename provided? try from environment 4354: unless ($thisfn) { 4355: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); } 4356: $thisfn=$ENV{'request.filename'}; 4357: } 4358: # is that filename actually a symb? Verify, clean, and return 4359: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) { 4360: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); } 4361: } 4362: $thisfn=declutter($thisfn); 4363: my %hash; 4364: my %bighash; 4365: my $syval=''; 4366: if (($ENV{'request.course.fn'}) && ($thisfn)) { 4367: my $targetfn = $thisfn; 4368: if ( ($thisfn =~ m/^uploaded\//) && ($thisfn !~ m/\.(page|sequence)$/) ) { 4369: $targetfn = 'adm/wrapper/'.$thisfn; 4370: } 4371: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db', 4372: &GDBM_READER(),0640)) { 4373: $syval=$hash{$targetfn}; 4374: untie(%hash); 4375: } 4376: # ---------------------------------------------------------- There was an entry 4377: if ($syval) { 4378: unless ($syval=~/\_\d+$/) { 4379: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) { 4380: &appenv('request.ambiguous' => $thisfn); 4381: return ''; 4382: } 4383: $syval.=$1; 4384: } 4385: } else { 4386: # ------------------------------------------------------- Was not in symb table 4387: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', 4388: &GDBM_READER(),0640)) { 4389: # ---------------------------------------------- Get ID(s) for current resource 4390: my $ids=$bighash{'ids_'.&clutter($thisfn)}; 4391: unless ($ids) { 4392: $ids=$bighash{'ids_/'.$thisfn}; 4393: } 4394: unless ($ids) { 4395: # alias? 4396: $ids=$bighash{'mapalias_'.$thisfn}; 4397: } 4398: if ($ids) { 4399: # ------------------------------------------------------------------- Has ID(s) 4400: my @possibilities=split(/\,/,$ids); 4401: if ($#possibilities==0) { 4402: # ----------------------------------------------- There is only one possibility 4403: my ($mapid,$resid)=split(/\./,$ids); 4404: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid; 4405: } elsif (!$donotrecurse) { 4406: # ------------------------------------------ There is more than one possibility 4407: my $realpossible=0; 4408: foreach (@possibilities) { 4409: my $file=$bighash{'src_'.$_}; 4410: if (&allowed('bre',$file)) { 4411: my ($mapid,$resid)=split(/\./,$_); 4412: if ($bighash{'map_type_'.$mapid} ne 'page') { 4413: $realpossible++; 4414: $syval=declutter($bighash{'map_id_'.$mapid}). 4415: '___'.$resid; 4416: } 4417: } 4418: } 4419: if ($realpossible!=1) { $syval=''; } 4420: } else { 4421: $syval=''; 4422: } 4423: } 4424: untie(%bighash) 4425: } 4426: } 4427: if ($syval) { 4428: return &symbclean($syval.'___'.$thisfn); 4429: } 4430: } 4431: &appenv('request.ambiguous' => $thisfn); 4432: return ''; 4433: } 4434: 4435: # ---------------------------------------------------------- Return random seed 4436: 4437: sub numval { 4438: my $txt=shift; 4439: $txt=~tr/A-J/0-9/; 4440: $txt=~tr/a-j/0-9/; 4441: $txt=~tr/K-T/0-9/; 4442: $txt=~tr/k-t/0-9/; 4443: $txt=~tr/U-Z/0-5/; 4444: $txt=~tr/u-z/0-5/; 4445: $txt=~s/\D//g; 4446: return int($txt); 4447: } 4448: 4449: sub numval2 { 4450: my $txt=shift; 4451: $txt=~tr/A-J/0-9/; 4452: $txt=~tr/a-j/0-9/; 4453: $txt=~tr/K-T/0-9/; 4454: $txt=~tr/k-t/0-9/; 4455: $txt=~tr/U-Z/0-5/; 4456: $txt=~tr/u-z/0-5/; 4457: $txt=~s/\D//g; 4458: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 4459: my $total; 4460: foreach my $val (@txts) { $total+=$val; } 4461: return int($total); 4462: } 4463: 4464: sub latest_rnd_algorithm_id { 4465: return '64bit3'; 4466: } 4467: 4468: sub get_rand_alg { 4469: my ($courseid)=@_; 4470: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; } 4471: if ($courseid) { 4472: return $ENV{"course.$courseid.rndseed"}; 4473: } 4474: return &latest_rnd_algorithm_id(); 4475: } 4476: 4477: sub getCODE { 4478: if (defined($ENV{'form.CODE'})) { return $ENV{'form.CODE'}; } 4479: if (defined($Apache::lonhomework::parsing_a_problem) && 4480: defined($Apache::lonhomework::history{'resource.CODE'})) { 4481: return $Apache::lonhomework::history{'resource.CODE'}; 4482: } 4483: return undef; 4484: } 4485: 4486: sub rndseed { 4487: my ($symb,$courseid,$domain,$username)=@_; 4488: 4489: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser(); 4490: if (!$symb) { 4491: unless ($symb=$wsymb) { return time; } 4492: } 4493: if (!$courseid) { $courseid=$wcourseid; } 4494: if (!$domain) { $domain=$wdomain; } 4495: if (!$username) { $username=$wusername } 4496: my $which=&get_rand_alg(); 4497: if (defined(&getCODE())) { 4498: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username); 4499: } elsif ($which eq '64bit3') { 4500: return &rndseed_64bit3($symb,$courseid,$domain,$username); 4501: } elsif ($which eq '64bit2') { 4502: return &rndseed_64bit2($symb,$courseid,$domain,$username); 4503: } elsif ($which eq '64bit') { 4504: return &rndseed_64bit($symb,$courseid,$domain,$username); 4505: } 4506: return &rndseed_32bit($symb,$courseid,$domain,$username); 4507: } 4508: 4509: sub rndseed_32bit { 4510: my ($symb,$courseid,$domain,$username)=@_; 4511: { 4512: use integer; 4513: my $symbchck=unpack("%32C*",$symb) << 27; 4514: my $symbseed=numval($symb) << 22; 4515: my $namechck=unpack("%32C*",$username) << 17; 4516: my $nameseed=numval($username) << 12; 4517: my $domainseed=unpack("%32C*",$domain) << 7; 4518: my $courseseed=unpack("%32C*",$courseid); 4519: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck; 4520: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 4521: #&Apache::lonxml::debug("rndseed :$num:$symb"); 4522: return $num; 4523: } 4524: } 4525: 4526: sub rndseed_64bit { 4527: my ($symb,$courseid,$domain,$username)=@_; 4528: { 4529: use integer; 4530: my $symbchck=unpack("%32S*",$symb) << 21; 4531: my $symbseed=numval($symb) << 10; 4532: my $namechck=unpack("%32S*",$username); 4533: 4534: my $nameseed=numval($username) << 21; 4535: my $domainseed=unpack("%32S*",$domain) << 10; 4536: my $courseseed=unpack("%32S*",$courseid); 4537: 4538: my $num1=$symbchck+$symbseed+$namechck; 4539: my $num2=$nameseed+$domainseed+$courseseed; 4540: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 4541: #&Apache::lonxml::debug("rndseed :$num:$symb"); 4542: return "$num1,$num2"; 4543: } 4544: } 4545: 4546: sub rndseed_64bit2 { 4547: my ($symb,$courseid,$domain,$username)=@_; 4548: { 4549: use integer; 4550: # strings need to be an even # of cahracters long, it it is odd the 4551: # last characters gets thrown away 4552: my $symbchck=unpack("%32S*",$symb.' ') << 21; 4553: my $symbseed=numval($symb) << 10; 4554: my $namechck=unpack("%32S*",$username.' '); 4555: 4556: my $nameseed=numval($username) << 21; 4557: my $domainseed=unpack("%32S*",$domain.' ') << 10; 4558: my $courseseed=unpack("%32S*",$courseid.' '); 4559: 4560: my $num1=$symbchck+$symbseed+$namechck; 4561: my $num2=$nameseed+$domainseed+$courseseed; 4562: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 4563: #&Apache::lonxml::debug("rndseed :$num:$symb"); 4564: return "$num1,$num2"; 4565: } 4566: } 4567: 4568: sub rndseed_64bit3 { 4569: my ($symb,$courseid,$domain,$username)=@_; 4570: { 4571: use integer; 4572: # strings need to be an even # of cahracters long, it it is odd the 4573: # last characters gets thrown away 4574: my $symbchck=unpack("%32S*",$symb.' ') << 21; 4575: my $symbseed=numval2($symb) << 10; 4576: my $namechck=unpack("%32S*",$username.' '); 4577: 4578: my $nameseed=numval2($username) << 21; 4579: my $domainseed=unpack("%32S*",$domain.' ') << 10; 4580: my $courseseed=unpack("%32S*",$courseid.' '); 4581: 4582: my $num1=$symbchck+$symbseed+$namechck; 4583: my $num2=$nameseed+$domainseed+$courseseed; 4584: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 4585: #&Apache::lonxml::debug("rndseed :$num:$symb"); 4586: return "$num1:$num2"; 4587: } 4588: } 4589: 4590: sub rndseed_CODE_64bit { 4591: my ($symb,$courseid,$domain,$username)=@_; 4592: { 4593: use integer; 4594: my $symbchck=unpack("%32S*",$symb.' ') << 16; 4595: my $symbseed=numval2($symb); 4596: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 4597: my $CODEseed=numval(&getCODE()); 4598: my $courseseed=unpack("%32S*",$courseid.' '); 4599: my $num1=$symbseed+$CODEchck; 4600: my $num2=$CODEseed+$courseseed+$symbchck; 4601: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 4602: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb"); 4603: return "$num1:$num2"; 4604: } 4605: } 4606: 4607: sub setup_random_from_rndseed { 4608: my ($rndseed)=@_; 4609: if ($rndseed =~/([,:])/) { 4610: my ($num1,$num2)=split(/[,:]/,$rndseed); 4611: &Math::Random::random_set_seed(abs($num1),abs($num2)); 4612: } else { 4613: &Math::Random::random_set_seed_from_phrase($rndseed); 4614: } 4615: } 4616: 4617: sub latest_receipt_algorithm_id { 4618: return 'receipt2'; 4619: } 4620: 4621: sub recunique { 4622: my $fucourseid=shift; 4623: my $unique; 4624: if ($ENV{"course.$fucourseid.receiptalg"} eq 'receipt2') { 4625: $unique=$ENV{"course.$fucourseid.internal.encseed"}; 4626: } else { 4627: $unique=$perlvar{'lonReceipt'}; 4628: } 4629: return unpack("%32C*",$unique); 4630: } 4631: 4632: sub recprefix { 4633: my $fucourseid=shift; 4634: my $prefix; 4635: if ($ENV{"course.$fucourseid.receiptalg"} eq 'receipt2') { 4636: $prefix=$ENV{"course.$fucourseid.internal.encpref"}; 4637: } else { 4638: $prefix=$perlvar{'lonHostID'}; 4639: } 4640: return unpack("%32C*",$prefix); 4641: } 4642: 4643: sub ireceipt { 4644: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_; 4645: my $cuname=unpack("%32C*",$funame); 4646: my $cudom=unpack("%32C*",$fudom); 4647: my $cucourseid=unpack("%32C*",$fucourseid); 4648: my $cusymb=unpack("%32C*",$fusymb); 4649: my $cunique=&recunique($fucourseid); 4650: my $cpart=unpack("%32S*",$part); 4651: my $return =&recprefix($fucourseid).'-'; 4652: if ($ENV{"course.$fucourseid.receiptalg"} eq 'receipt2' || 4653: $ENV{'request.state'} eq 'construct') { 4654: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname). 4655: " and ".($cpart%$cudom)); 4656: 4657: $return.= ($cunique%$cuname+ 4658: $cunique%$cudom+ 4659: $cusymb%$cuname+ 4660: $cusymb%$cudom+ 4661: $cucourseid%$cuname+ 4662: $cucourseid%$cudom+ 4663: $cpart%$cuname+ 4664: $cpart%$cudom); 4665: } else { 4666: $return.= ($cunique%$cuname+ 4667: $cunique%$cudom+ 4668: $cusymb%$cuname+ 4669: $cusymb%$cudom+ 4670: $cucourseid%$cuname+ 4671: $cucourseid%$cudom); 4672: } 4673: return $return; 4674: } 4675: 4676: sub receipt { 4677: my ($part)=@_; 4678: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser(); 4679: return &ireceipt($name,$domain,$courseid,$symb,$part); 4680: } 4681: 4682: # ------------------------------------------------------------ Serves up a file 4683: # returns either the contents of the file or 4684: # -1 if the file doesn't exist 4685: # 4686: # if the target is a file that was uploaded via DOCS, 4687: # a check will be made to see if a current copy exists on the local server, 4688: # if it does this will be served, otherwise a copy will be retrieved from 4689: # the home server for the course and stored in /home/httpd/html/userfiles on 4690: # the local server. 4691: 4692: sub getfile { 4693: my ($file,$caller) = @_; 4694: 4695: if ($file !~ m|^/*uploaded/(\w+)/(\w+)/(.+)$|) { 4696: # normal file from res space 4697: &repcopy($file); 4698: return &readfile($file); 4699: } 4700: 4701: my $info; 4702: my $cdom = $1; 4703: my $cnum = $2; 4704: my $filename = $3; 4705: my $path = $Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles'; 4706: my ($lwpresp,$rtncode); 4707: my $localfile = $path.'/'.$cdom.'/'.$cnum.'/'.$filename; 4708: if (-e "$localfile") { 4709: my @fileinfo = stat($localfile); 4710: $lwpresp = &getuploaded('HEAD',$file,$cdom,$cnum,\$info,\$rtncode); 4711: if ($lwpresp ne 'ok') { 4712: if ($rtncode eq '404') { 4713: unlink($localfile); 4714: } 4715: return -1; 4716: } 4717: if ($info < $fileinfo[9]) { 4718: return &readfile($localfile); 4719: } 4720: $info = ''; 4721: $lwpresp = &getuploaded('GET',$file,$cdom,$cnum,\$info,\$rtncode); 4722: if ($lwpresp ne 'ok') { 4723: return -1; 4724: } 4725: } else { 4726: $lwpresp = &getuploaded('GET',$file,$cdom,$cnum,\$info,\$rtncode); 4727: if ($lwpresp ne 'ok') { 4728: return -1; 4729: } 4730: my @parts = ($cdom,$cnum); 4731: if ($filename =~ m|^(.+)/[^/]+$|) { 4732: push @parts, split(/\//,$1); 4733: } 4734: foreach my $part (@parts) { 4735: $path .= '/'.$part; 4736: if (!-e $path) { 4737: mkdir($path,0770); 4738: } 4739: } 4740: } 4741: open (FILE,">$localfile"); 4742: print FILE $info; 4743: close(FILE); 4744: if ($caller eq 'uploadrep') { 4745: return 'ok'; 4746: } 4747: return $info; 4748: } 4749: 4750: sub getuploaded { 4751: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_; 4752: $uri=~s/^\///; 4753: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri; 4754: my $ua=new LWP::UserAgent; 4755: my $request=new HTTP::Request($reqtype,$uri); 4756: my $response=$ua->request($request); 4757: $$rtncode = $response->code; 4758: if (! $response->is_success()) { 4759: return 'failed'; 4760: } 4761: if ($reqtype eq 'HEAD') { 4762: $$info = &HTTP::Date::str2time( $response->header('Last-modified') ); 4763: } elsif ($reqtype eq 'GET') { 4764: $$info = $response->content; 4765: } 4766: return 'ok'; 4767: } 4768: 4769: sub readfile { 4770: my $file = shift; 4771: if ( (! -e $file ) || ($file eq '') ) { return -1; }; 4772: my $fh; 4773: open($fh,"<$file"); 4774: my $a=''; 4775: while (<$fh>) { $a .=$_; } 4776: return $a; 4777: } 4778: 4779: sub filelocation { 4780: my ($dir,$file) = @_; 4781: my $location; 4782: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces 4783: if ($file=~m:^/~:) { # is a contruction space reference 4784: $location = $file; 4785: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:; 4786: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file 4787: $location=$file; 4788: } else { 4789: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//; 4790: $file=~s:^/res/:/:; 4791: if ( !( $file =~ m:^/:) ) { 4792: $location = $dir. '/'.$file; 4793: } else { 4794: $location = '/home/httpd/html/res'.$file; 4795: } 4796: } 4797: $location=~s://+:/:g; # remove duplicate / 4798: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/.. 4799: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./ 4800: return $location; 4801: } 4802: 4803: sub hreflocation { 4804: my ($dir,$file)=@_; 4805: unless (($file=~m-^http://-i) || ($file=~m-^/-)) { 4806: my $finalpath=filelocation($dir,$file); 4807: $finalpath=~s-^/home/httpd/html--; 4808: $finalpath=~s-^/home/(\w+)/public_html/-/~$1/-; 4809: return $finalpath; 4810: } elsif ($file=~m-^/home-) { 4811: $file=~s-^/home/httpd/html--; 4812: $file=~s-^/home/(\w+)/public_html/-/~$1/-; 4813: return $file; 4814: } 4815: return $file; 4816: } 4817: 4818: sub current_machine_domains { 4819: my $hostname=$hostname{$perlvar{'lonHostID'}}; 4820: my @domains; 4821: while( my($id, $name) = each(%hostname)) { 4822: # &logthis("-$id-$name-$hostname-"); 4823: if ($hostname eq $name) { 4824: push(@domains,$hostdom{$id}); 4825: } 4826: } 4827: return @domains; 4828: } 4829: 4830: sub current_machine_ids { 4831: my $hostname=$hostname{$perlvar{'lonHostID'}}; 4832: my @ids; 4833: while( my($id, $name) = each(%hostname)) { 4834: # &logthis("-$id-$name-$hostname-"); 4835: if ($hostname eq $name) { 4836: push(@ids,$id); 4837: } 4838: } 4839: return @ids; 4840: } 4841: 4842: # ------------------------------------------------------------- Declutters URLs 4843: 4844: sub declutter { 4845: my $thisfn=shift; 4846: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//; 4847: $thisfn=~s/^\///; 4848: $thisfn=~s/^res\///; 4849: $thisfn=~s/\?.+$//; 4850: return $thisfn; 4851: } 4852: 4853: # ------------------------------------------------------------- Clutter up URLs 4854: 4855: sub clutter { 4856: my $thisfn='/'.&declutter(shift); 4857: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) { 4858: $thisfn='/res'.$thisfn; 4859: } 4860: return $thisfn; 4861: } 4862: 4863: # -------------------------------------------------------- Escape Special Chars 4864: 4865: sub escape { 4866: my $str=shift; 4867: $str =~ s/(\W)/"%".unpack('H2',$1)/eg; 4868: return $str; 4869: } 4870: 4871: # ----------------------------------------------------- Un-Escape Special Chars 4872: 4873: sub unescape { 4874: my $str=shift; 4875: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; 4876: return $str; 4877: } 4878: 4879: sub mod_perl_version { 4880: if (defined($perlvar{'MODPERL2'})) { 4881: return 2; 4882: } 4883: return 1; 4884: } 4885: 4886: sub correct_line_ends { 4887: my ($result)=@_; 4888: $$result =~s/\r\n/\n/mg; 4889: $$result =~s/\r/\n/mg; 4890: } 4891: # ================================================================ Main Program 4892: 4893: sub goodbye { 4894: &logthis("Starting Shut down"); 4895: #not converted to using infrastruture and probably shouldn't be 4896: &logthis(sprintf("%-20s is %s",'%badServerCache',scalar(%badServerCache))); 4897: #converted 4898: &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache))); 4899: &logthis(sprintf("%-20s is %s",'%homecache',scalar(%homecache))); 4900: &logthis(sprintf("%-20s is %s",'%titlecache',scalar(%titlecache))); 4901: &logthis(sprintf("%-20s is %s",'%courseresdatacache',scalar(%courseresdatacache))); 4902: #1.1 only 4903: &logthis(sprintf("%-20s is %s",'%userresdatacache',scalar(%userresdatacache))); 4904: &logthis(sprintf("%-20s is %s",'%usectioncache',scalar(%usectioncache))); 4905: &logthis(sprintf("%-20s is %s",'%courseresversioncache',scalar(%courseresversioncache))); 4906: &logthis(sprintf("%-20s is %s",'%resversioncache',scalar(%resversioncache))); 4907: &flushcourselogs(); 4908: &logthis("Shutting down"); 4909: return DONE; 4910: } 4911: 4912: BEGIN { 4913: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf 4914: unless ($readit) { 4915: { 4916: open(my $config,"</etc/httpd/conf/loncapa.conf"); 4917: 4918: while (my $configline=<$config>) { 4919: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) { 4920: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline); 4921: chomp($varvalue); 4922: $perlvar{$varname}=$varvalue; 4923: } 4924: } 4925: close($config); 4926: } 4927: { 4928: open(my $config,"</etc/httpd/conf/loncapa_apache.conf"); 4929: 4930: while (my $configline=<$config>) { 4931: if ($configline =~ /^[^\#]*PerlSetVar/) { 4932: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline); 4933: chomp($varvalue); 4934: $perlvar{$varname}=$varvalue; 4935: } 4936: } 4937: close($config); 4938: } 4939: 4940: # ------------------------------------------------------------ Read domain file 4941: { 4942: %domaindescription = (); 4943: %domain_auth_def = (); 4944: %domain_auth_arg_def = (); 4945: my $fh; 4946: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) { 4947: while (<$fh>) { 4948: next if (/^(\#|\s*$)/); 4949: # next if /^\#/; 4950: chomp; 4951: my ($domain, $domain_description, $def_auth, $def_auth_arg, 4952: $def_lang, $city, $longi, $lati) = split(/:/,$_); 4953: $domain_auth_def{$domain}=$def_auth; 4954: $domain_auth_arg_def{$domain}=$def_auth_arg; 4955: $domaindescription{$domain}=$domain_description; 4956: $domain_lang_def{$domain}=$def_lang; 4957: $domain_city{$domain}=$city; 4958: $domain_longi{$domain}=$longi; 4959: $domain_lati{$domain}=$lati; 4960: 4961: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}"); 4962: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} ); 4963: } 4964: } 4965: close ($fh); 4966: } 4967: 4968: 4969: # ------------------------------------------------------------- Read hosts file 4970: { 4971: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 4972: 4973: while (my $configline=<$config>) { 4974: next if ($configline =~ /^(\#|\s*$)/); 4975: chomp($configline); 4976: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline); 4977: if ($id && $domain && $role && $name && $ip) { 4978: $hostname{$id}=$name; 4979: $hostdom{$id}=$domain; 4980: $hostip{$id}=$ip; 4981: $iphost{$ip}=$id; 4982: if ($role eq 'library') { $libserv{$id}=$name; } 4983: } else { 4984: if ($configline) { 4985: &logthis("Skipping hosts.tab line -$configline-"); 4986: } 4987: } 4988: } 4989: close($config); 4990: } 4991: 4992: # ------------------------------------------------------ Read spare server file 4993: { 4994: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab"); 4995: 4996: while (my $configline=<$config>) { 4997: chomp($configline); 4998: if ($configline) { 4999: $spareid{$configline}=1; 5000: } 5001: } 5002: close($config); 5003: } 5004: # ------------------------------------------------------------ Read permissions 5005: { 5006: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab"); 5007: 5008: while (my $configline=<$config>) { 5009: chomp($configline); 5010: if ($configline) { 5011: my ($role,$perm)=split(/ /,$configline); 5012: if ($perm ne '') { $pr{$role}=$perm; } 5013: } 5014: } 5015: close($config); 5016: } 5017: 5018: # -------------------------------------------- Read plain texts for permissions 5019: { 5020: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab"); 5021: 5022: while (my $configline=<$config>) { 5023: chomp($configline); 5024: if ($configline) { 5025: my ($short,$plain)=split(/:/,$configline); 5026: if ($plain ne '') { $prp{$short}=$plain; } 5027: } 5028: } 5029: close($config); 5030: } 5031: 5032: # ---------------------------------------------------------- Read package table 5033: { 5034: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab"); 5035: 5036: while (my $configline=<$config>) { 5037: if ($configline !~ /\S/ || $configline=~/^#/) { next; } 5038: chomp($configline); 5039: my ($short,$plain)=split(/:/,$configline); 5040: my ($pack,$name)=split(/\&/,$short); 5041: if ($plain ne '') { 5042: $packagetab{$pack.'&'.$name.'&name'}=$name; 5043: $packagetab{$short}=$plain; 5044: } 5045: } 5046: close($config); 5047: } 5048: 5049: # ------------- set up temporary directory 5050: { 5051: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/'; 5052: 5053: } 5054: 5055: %metacache=(); 5056: 5057: $processmarker='_'.time.'_'.$perlvar{'lonHostID'}; 5058: $dumpcount=0; 5059: 5060: &logtouch(); 5061: &logthis('INFO: Read configuration'); 5062: $readit=1; 5063: } 5064: } 5065: 5066: 1; 5067: __END__ 5068: 5069: =pod 5070: 5071: =head1 NAME 5072: 5073: Apache::lonnet - Subroutines to ask questions about things in the network. 5074: 5075: =head1 SYNOPSIS 5076: 5077: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network. 5078: 5079: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS); 5080: 5081: Common parameters: 5082: 5083: =over 4 5084: 5085: =item * 5086: 5087: $uname : an internal username (if $cname expecting a course Id specifically) 5088: 5089: =item * 5090: 5091: $udom : a domain (if $cdom expecting a course's domain specifically) 5092: 5093: =item * 5094: 5095: $symb : a resource instance identifier 5096: 5097: =item * 5098: 5099: $namespace : the name of a .db file that contains the data needed or 5100: being set. 5101: 5102: =back 5103: 5104: =head1 OVERVIEW 5105: 5106: lonnet provides subroutines which interact with the 5107: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask 5108: about classes, users, and resources. 5109: 5110: For many of these objects you can also use this to store data about 5111: them or modify them in various ways. 5112: 5113: =head2 Symbs 5114: 5115: To identify a specific instance of a resource, LON-CAPA uses symbols 5116: or "symbs"X<symb>. These identifiers are built from the URL of the 5117: map, the resource number of the resource in the map, and the URL of 5118: the resource itself. The latter is somewhat redundant, but might help 5119: if maps change. 5120: 5121: An example is 5122: 5123: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem 5124: 5125: The respective map entry is 5126: 5127: <resource id="19" src="/res/msu/korte/tests/part12.problem" 5128: title="Problem 2"> 5129: </resource> 5130: 5131: Symbs are used by the random number generator, as well as to store and 5132: restore data specific to a certain instance of for example a problem. 5133: 5134: =head2 Storing And Retrieving Data 5135: 5136: X<store()>X<cstore()>X<restore()>Three of the most important functions 5137: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>, 5138: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which 5139: is is the non-critical message twin of cstore. These functions are for 5140: handlers to store a perl hash to a user's permanent data space in an 5141: easy manner, and to retrieve it again on another call. It is expected 5142: that a handler would use this once at the beginning to retrieve data, 5143: and then again once at the end to send only the new data back. 5144: 5145: The data is stored in the user's data directory on the user's 5146: homeserver under the ID of the course. 5147: 5148: The hash that is returned by restore will have all of the previous 5149: value for all of the elements of the hash. 5150: 5151: Example: 5152: 5153: #creating a hash 5154: my %hash; 5155: $hash{'foo'}='bar'; 5156: 5157: #storing it 5158: &Apache::lonnet::cstore(\%hash); 5159: 5160: #changing a value 5161: $hash{'foo'}='notbar'; 5162: 5163: #adding a new value 5164: $hash{'bar'}='foo'; 5165: &Apache::lonnet::cstore(\%hash); 5166: 5167: #retrieving the hash 5168: my %history=&Apache::lonnet::restore(); 5169: 5170: #print the hash 5171: foreach my $key (sort(keys(%history))) { 5172: print("\%history{$key} = $history{$key}"); 5173: } 5174: 5175: Will print out: 5176: 5177: %history{1:foo} = bar 5178: %history{1:keys} = foo:timestamp 5179: %history{1:timestamp} = 990455579 5180: %history{2:bar} = foo 5181: %history{2:foo} = notbar 5182: %history{2:keys} = foo:bar:timestamp 5183: %history{2:timestamp} = 990455580 5184: %history{bar} = foo 5185: %history{foo} = notbar 5186: %history{timestamp} = 990455580 5187: %history{version} = 2 5188: 5189: Note that the special hash entries C<keys>, C<version> and 5190: C<timestamp> were added to the hash. C<version> will be equal to the 5191: total number of versions of the data that have been stored. The 5192: C<timestamp> attribute will be the UNIX time the hash was 5193: stored. C<keys> is available in every historical section to list which 5194: keys were added or changed at a specific historical revision of a 5195: hash. 5196: 5197: B<Warning>: do not store the hash that restore returns directly. This 5198: will cause a mess since it will restore the historical keys as if the 5199: were new keys. I.E. 1:foo will become 1:1:foo etc. 5200: 5201: Calling convention: 5202: 5203: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home); 5204: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home); 5205: 5206: For more detailed information, see lonnet specific documentation. 5207: 5208: =head1 RETURN MESSAGES 5209: 5210: =over 4 5211: 5212: =item * B<con_lost>: unable to contact remote host 5213: 5214: =item * B<con_delayed>: unable to contact remote host, message will be delivered 5215: when the connection is brought back up 5216: 5217: =item * B<con_failed>: unable to contact remote host and unable to save message 5218: for later delivery 5219: 5220: =item * B<error:>: an error a occured, a description of the error follows the : 5221: 5222: =item * B<no_such_host>: unable to fund a host associated with the user/domain 5223: that was requested 5224: 5225: =back 5226: 5227: =head1 PUBLIC SUBROUTINES 5228: 5229: =head2 Session Environment Functions 5230: 5231: =over 4 5232: 5233: =item * 5234: X<appenv()> 5235: B<appenv(%hash)>: the value of %hash is written to 5236: the user envirnoment file, and will be restored for each access this 5237: user makes during this session, also modifies the %ENV for the current 5238: process 5239: 5240: =item * 5241: X<delenv()> 5242: B<delenv($regexp)>: removes all items from the session 5243: environment file that matches the regular expression in $regexp. The 5244: values are also delted from the current processes %ENV. 5245: 5246: =back 5247: 5248: =head2 User Information 5249: 5250: =over 4 5251: 5252: =item * 5253: X<queryauthenticate()> 5254: B<queryauthenticate($uname,$udom)>: try to determine user's current 5255: authentication scheme 5256: 5257: =item * 5258: X<authenticate()> 5259: B<authenticate($uname,$upass,$udom)>: try to 5260: authenticate user from domain's lib servers (first use the current 5261: one). C<$upass> should be the users password. 5262: 5263: =item * 5264: X<homeserver()> 5265: B<homeserver($uname,$udom)>: find the server which has 5266: the user's directory and files (there must be only one), this caches 5267: the answer, and also caches if there is a borken connection. 5268: 5269: =item * 5270: X<idget()> 5271: B<idget($udom,@ids)>: find the usernames behind a list of IDs 5272: (IDs are a unique resource in a domain, there must be only 1 ID per 5273: username, and only 1 username per ID in a specific domain) (returns 5274: hash: id=>name,id=>name) 5275: 5276: =item * 5277: X<idrget()> 5278: B<idrget($udom,@unames)>: find the IDs behind a list of 5279: usernames (returns hash: name=>id,name=>id) 5280: 5281: =item * 5282: X<idput()> 5283: B<idput($udom,%ids)>: store away a list of names and associated IDs 5284: 5285: =item * 5286: X<rolesinit()> 5287: B<rolesinit($udom,$username,$authhost)>: get user privileges 5288: 5289: =item * 5290: X<usection()> 5291: B<usection($udom,$uname,$cname)>: finds the section of student in the 5292: course $cname, return section name/number or '' for "not in course" 5293: and '-1' for "no section" 5294: 5295: =item * 5296: X<userenvironment()> 5297: B<userenvironment($udom,$uname,@what)>: gets the values of the keys 5298: passed in @what from the requested user's environment, returns a hash 5299: 5300: =back 5301: 5302: =head2 User Roles 5303: 5304: =over 4 5305: 5306: =item * 5307: 5308: allowed($priv,$uri) : check for a user privilege; returns codes for allowed 5309: actions 5310: F: full access 5311: U,I,K: authentication modes (cxx only) 5312: '': forbidden 5313: 1: user needs to choose course 5314: 2: browse allowed 5315: 5316: =item * 5317: 5318: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom 5319: role rolename set privileges in format of lonTabs/roles.tab for system, domain, 5320: and course level 5321: 5322: =item * 5323: 5324: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text 5325: explanation of a user role term 5326: 5327: =back 5328: 5329: =head2 User Modification 5330: 5331: =over 4 5332: 5333: =item * 5334: 5335: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a 5336: user for the level given by URL. Optional start and end dates (leave empty 5337: string or zero for "no date") 5338: 5339: =item * 5340: 5341: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to 5342: change a users, password, possible return values are: ok, 5343: pwchange_failure, non_authorized, auth_mode_error, unknown_user, 5344: refused 5345: 5346: =item * 5347: 5348: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication 5349: 5350: =item * 5351: 5352: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) : 5353: modify user 5354: 5355: =item * 5356: 5357: modifystudent 5358: 5359: modify a students enrollment and identification information. 5360: The course id is resolved based on the current users environment. 5361: This means the envoking user must be a course coordinator or otherwise 5362: associated with a course. 5363: 5364: This call is essentially a wrapper for lonnet::modifyuser and 5365: lonnet::modify_student_enrollment 5366: 5367: Inputs: 5368: 5369: =over 4 5370: 5371: =item B<$udom> Students loncapa domain 5372: 5373: =item B<$uname> Students loncapa login name 5374: 5375: =item B<$uid> Students id/student number 5376: 5377: =item B<$umode> Students authentication mode 5378: 5379: =item B<$upass> Students password 5380: 5381: =item B<$first> Students first name 5382: 5383: =item B<$middle> Students middle name 5384: 5385: =item B<$last> Students last name 5386: 5387: =item B<$gene> Students generation 5388: 5389: =item B<$usec> Students section in course 5390: 5391: =item B<$end> Unix time of the roles expiration 5392: 5393: =item B<$start> Unix time of the roles start date 5394: 5395: =item B<$forceid> If defined, allow $uid to be changed 5396: 5397: =item B<$desiredhome> server to use as home server for student 5398: 5399: =back 5400: 5401: =item * 5402: 5403: modify_student_enrollment 5404: 5405: Change a students enrollment status in a class. The environment variable 5406: 'role.request.course' must be defined for this function to proceed. 5407: 5408: Inputs: 5409: 5410: =over 4 5411: 5412: =item $udom, students domain 5413: 5414: =item $uname, students name 5415: 5416: =item $uid, students user id 5417: 5418: =item $first, students first name 5419: 5420: =item $middle 5421: 5422: =item $last 5423: 5424: =item $gene 5425: 5426: =item $usec 5427: 5428: =item $end 5429: 5430: =item $start 5431: 5432: =back 5433: 5434: 5435: =item * 5436: 5437: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign 5438: custom role; give a custom role to a user for the level given by URL. Specify 5439: name and domain of role author, and role name 5440: 5441: =item * 5442: 5443: revokerole($udom,$uname,$url,$role) : revoke a role for url 5444: 5445: =item * 5446: 5447: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role 5448: 5449: =back 5450: 5451: =head2 Course Infomation 5452: 5453: =over 4 5454: 5455: =item * 5456: 5457: coursedescription($courseid) : course description 5458: 5459: =item * 5460: 5461: courseresdata($coursenum,$coursedomain,@which) : request for current 5462: parameter setting for a specific course, @what should be a list of 5463: parameters to ask about. This routine caches answers for 5 minutes. 5464: 5465: =back 5466: 5467: =head2 Course Modification 5468: 5469: =over 4 5470: 5471: =item * 5472: 5473: writecoursepref($courseid,%prefs) : write preferences (environment 5474: database) for a course 5475: 5476: =item * 5477: 5478: createcourse($udom,$description,$url) : make/modify course 5479: 5480: =back 5481: 5482: =head2 Resource Subroutines 5483: 5484: =over 4 5485: 5486: =item * 5487: 5488: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead) 5489: 5490: =item * 5491: 5492: repcopy($filename) : subscribes to the requested file, and attempts to 5493: replicate from the owning library server, Might return 5494: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or 5495: HTTP_BAD_REQUEST, also attempts to grab the metadata for the 5496: resource. Expects the local filesystem pathname 5497: (/home/httpd/html/res/....) 5498: 5499: =back 5500: 5501: =head2 Resource Information 5502: 5503: =over 4 5504: 5505: =item * 5506: 5507: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of 5508: a vairety of different possible values, $varname should be a request 5509: string, and the other parameters can be used to specify who and what 5510: one is asking about. 5511: 5512: Possible values for $varname are environment.lastname (or other item 5513: from the envirnment hash), user.name (or someother aspect about the 5514: user), resource.0.maxtries (or some other part and parameter of a 5515: resource) 5516: 5517: =item * 5518: 5519: directcondval($number) : get current value of a condition; reads from a state 5520: string 5521: 5522: =item * 5523: 5524: condval($condidx) : value of condition index based on state 5525: 5526: =item * 5527: 5528: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a 5529: resource's metadata, $what should be either a specific key, or either 5530: 'keys' (to get a list of possible keys) or 'packages' to get a list of 5531: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata. 5532: 5533: this function automatically caches all requests 5534: 5535: =item * 5536: 5537: metadata_query($query,$custom,$customshow) : make a metadata query against the 5538: network of library servers; returns file handle of where SQL and regex results 5539: will be stored for query 5540: 5541: =item * 5542: 5543: symbread($filename) : return symbolic list entry (filename argument optional); 5544: returns the data handle 5545: 5546: =item * 5547: 5548: symbverify($symb,$thisfn) : verifies that $symb actually exists and is 5549: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on 5550: failure, user must be in a course, as it assumes the existance of the 5551: course initi hash, and uses $ENV('request.course.id'} 5552: 5553: 5554: =item * 5555: 5556: symbclean($symb) : removes versions numbers from a symb, returns the 5557: cleaned symb 5558: 5559: =item * 5560: 5561: is_on_map($uri) : checks if the $uri is somewhere on the current 5562: course map, user must be in a course for it to work. 5563: 5564: =item * 5565: 5566: numval($salt) : return random seed value (addend for rndseed) 5567: 5568: =item * 5569: 5570: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns 5571: a random seed, all arguments are optional, if they aren't sent it uses the 5572: environment to derive them. Note: if symb isn't sent and it can't get one 5573: from &symbread it will use the current time as its return value 5574: 5575: =item * 5576: 5577: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique, 5578: unfakeable, receipt 5579: 5580: =item * 5581: 5582: receipt() : API to ireceipt working off of ENV values; given out to users 5583: 5584: =item * 5585: 5586: countacc($url) : count the number of accesses to a given URL 5587: 5588: =item * 5589: 5590: checkout($symb,$tuname,$tudom,$tcrsid) : creates a record of a user having looked at an item, most likely printed out or otherwise using a resource 5591: 5592: =item * 5593: 5594: checkin($token) : updates that a resource has beeen returned (a hard copy version for instance) and returns the data that $token was Checkout with ($symb, $tuname, $tudom, and $tcrsid) 5595: 5596: =item * 5597: 5598: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet 5599: 5600: =item * 5601: 5602: devalidate($symb) : devalidate temporary spreadsheet calculations, 5603: forcing spreadsheet to reevaluate the resource scores next time. 5604: 5605: =back 5606: 5607: =head2 Storing/Retreiving Data 5608: 5609: =over 4 5610: 5611: =item * 5612: 5613: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently 5614: for this url; hashref needs to be given and should be a \%hashname; the 5615: remaining args aren't required and if they aren't passed or are '' they will 5616: be derived from the ENV 5617: 5618: =item * 5619: 5620: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but 5621: uses critical subroutine 5622: 5623: =item * 5624: 5625: restore($symb,$namespace,$udom,$uname) : returns hash for this symb; 5626: all args are optional 5627: 5628: =item * 5629: 5630: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that 5631: works very similar to store/cstore, but all data is stored in a 5632: temporary location and can be reset using tmpreset, $storehash should 5633: be a hash reference, returns nothing on success 5634: 5635: =item * 5636: 5637: tmprestore($symb,$namespace,$udom,$uname) : storage that works very 5638: similar to restore, but all data is stored in a temporary location and 5639: can be reset using tmpreset. Returns a hash of values on success, 5640: error string otherwise. 5641: 5642: =item * 5643: 5644: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset, 5645: deltes all keys for $symb form the temporary storage hash. 5646: 5647: =item * 5648: 5649: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array 5650: reference filled in from namesp ($udom and $uname are optional) 5651: 5652: =item * 5653: 5654: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from 5655: namesp ($udom and $uname are optional) 5656: 5657: =item * 5658: 5659: dump($namespace,$udom,$uname,$regexp) : 5660: dumps the complete (or key matching regexp) namespace into a hash 5661: ($udom, $uname and $regexp are optional) 5662: 5663: =item * 5664: 5665: inc($namespace,$store,$udom,$uname) : increments $store in $namespace. 5666: $store can be a scalar, an array reference, or if the amount to be 5667: incremented is > 1, a hash reference. 5668: 5669: ($udom and $uname are optional) 5670: 5671: =item * 5672: 5673: put($namespace,$storehash,$udom,$uname) : stores hash in namesp 5674: ($udom and $uname are optional) 5675: 5676: =item * 5677: 5678: cput($namespace,$storehash,$udom,$uname) : critical put 5679: ($udom and $uname are optional) 5680: 5681: =item * 5682: 5683: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array 5684: reference filled in from namesp (encrypts the return communication) 5685: ($udom and $uname are optional) 5686: 5687: =item * 5688: 5689: log($udom,$name,$home,$message) : write to permanent log for user; use 5690: critical subroutine 5691: 5692: =back 5693: 5694: =head2 Network Status Functions 5695: 5696: =over 4 5697: 5698: =item * 5699: 5700: dirlist($uri) : return directory list based on URI 5701: 5702: =item * 5703: 5704: spareserver() : find server with least workload from spare.tab 5705: 5706: =back 5707: 5708: =head2 Apache Request 5709: 5710: =over 4 5711: 5712: =item * 5713: 5714: ssi($url,%hash) : server side include, does a complete request cycle on url to 5715: localhost, posts hash 5716: 5717: =back 5718: 5719: =head2 Data to String to Data 5720: 5721: =over 4 5722: 5723: =item * 5724: 5725: hash2str(%hash) : convert a hash into a string complete with escaping and '=' 5726: and '&' separators, supports elements that are arrayrefs and hashrefs 5727: 5728: =item * 5729: 5730: hashref2str($hashref) : convert a hashref into a string complete with 5731: escaping and '=' and '&' separators, supports elements that are 5732: arrayrefs and hashrefs 5733: 5734: =item * 5735: 5736: arrayref2str($arrayref) : convert an arrayref into a string complete 5737: with escaping and '&' separators, supports elements that are arrayrefs 5738: and hashrefs 5739: 5740: =item * 5741: 5742: str2hash($string) : convert string to hash using unescaping and 5743: splitting on '=' and '&', supports elements that are arrayrefs and 5744: hashrefs 5745: 5746: =item * 5747: 5748: str2array($string) : convert string to hash using unescaping and 5749: splitting on '&', supports elements that are arrayrefs and hashrefs 5750: 5751: =back 5752: 5753: =head2 Logging Routines 5754: 5755: =over 4 5756: 5757: These routines allow one to make log messages in the lonnet.log and 5758: lonnet.perm logfiles. 5759: 5760: =item * 5761: 5762: logtouch() : make sure the logfile, lonnet.log, exists 5763: 5764: =item * 5765: 5766: logthis() : append message to the normal lonnet.log file, it gets 5767: preiodically rolled over and deleted. 5768: 5769: =item * 5770: 5771: logperm() : append a permanent message to lonnet.perm.log, this log 5772: file never gets deleted by any automated portion of the system, only 5773: messages of critical importance should go in here. 5774: 5775: =back 5776: 5777: =head2 General File Helper Routines 5778: 5779: =over 4 5780: 5781: =item * 5782: 5783: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded. 5784: (a) files in /uploaded 5785: (i) If a local copy of the file exists - 5786: compares modification date of local copy with last-modified date for 5787: definitive version stored on home server for course. If local copy is 5788: stale, requests a new version from the home server and stores it. 5789: If the original has been removed from the home server, then local copy 5790: is unlinked. 5791: (ii) If local copy does not exist - 5792: requests the file from the home server and stores it. 5793: 5794: If $caller is 'uploadrep': 5795: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase) 5796: for request for files originally uploaded via DOCS. 5797: - returns 'ok' if fresh local copy now available, -1 otherwise. 5798: 5799: Otherwise: 5800: This indicates a call from the content generation phase of the request. 5801: - returns the entire contents of the file or -1. 5802: 5803: (b) files in /res 5804: - returns the entire contents of a file or -1; 5805: it properly subscribes to and replicates the file if neccessary. 5806: 5807: =item * 5808: 5809: filelocation($dir,$file) : returns file system location of a file 5810: based on URI; meant to be "fairly clean" absolute reference, $dir is a 5811: directory that relative $file lookups are to looked in ($dir of /a/dir 5812: and a file of ../bob will become /a/bob) 5813: 5814: =item * 5815: 5816: hreflocation($dir,$file) : returns file system location or a URL; same as 5817: filelocation except for hrefs 5818: 5819: =item * 5820: 5821: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc) 5822: 5823: =back 5824: 5825: =head2 HTTP Helper Routines 5826: 5827: =over 4 5828: 5829: =item * 5830: 5831: escape() : unpack non-word characters into CGI-compatible hex codes 5832: 5833: =item * 5834: 5835: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character 5836: 5837: =back 5838: 5839: =head1 PRIVATE SUBROUTINES 5840: 5841: =head2 Underlying communication routines (Shouldn't call) 5842: 5843: =over 4 5844: 5845: =item * 5846: 5847: subreply() : tries to pass a message to lonc, returns con_lost if incapable 5848: 5849: =item * 5850: 5851: reply() : uses subreply to send a message to remote machine, logs all failures 5852: 5853: =item * 5854: 5855: critical() : passes a critical message to another server; if cannot 5856: get through then place message in connection buffer directory and 5857: returns con_delayed, if incapable of saving message, returns 5858: con_failed 5859: 5860: =item * 5861: 5862: reconlonc() : tries to reconnect lonc client processes. 5863: 5864: =back 5865: 5866: =head2 Resource Access Logging 5867: 5868: =over 4 5869: 5870: =item * 5871: 5872: flushcourselogs() : flush (save) buffer logs and access logs 5873: 5874: =item * 5875: 5876: courselog($what) : save message for course in hash 5877: 5878: =item * 5879: 5880: courseacclog($what) : save message for course using &courselog(). Perform 5881: special processing for specific resource types (problems, exams, quizzes, etc). 5882: 5883: =item * 5884: 5885: goodbye() : flush course logs and log shutting down; it is called in srm.conf 5886: as a PerlChildExitHandler 5887: 5888: =back 5889: 5890: =head2 Other 5891: 5892: =over 4 5893: 5894: =item * 5895: 5896: symblist($mapname,%newhash) : update symbolic storage links 5897: 5898: =back 5899: 5900: =cut