loncom/lonnet/perl/lonnet.pm - view

File: [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.395: download - view: text, annotated - select for diffs
Tue Jul 29 05:22:56 2003 UTC (20 years, 11 months ago) by albertel
Branches: MAIN
CVS tags: HEAD

- Fixes for BUG#1991, (maybe packages.tab will finally be handled correctly? One can only hope)
- Made thes changes I said I was going to in the bugreport (copied below for conviene and commit padding)
1) stop metadata from parsing packages.tab values and sticking them in the
metadata of the problem
2) add new function get pacakages_tab_default() to lonnet, takeas a full parm
signifier (resource.partid_responseid.name) (just like EXT takes) figures out
what kind of response/part the things is and returns the proper default value
from packages.tab
3) add to EXT to check this new function for the packages.tab default for
anythings it can't find a value for
4) check that all other parmval funtions also do this

4) turned out to be assesscalc.pm and lonnavmaps.pm, and executive decision was made to leave lonparmset.pm out of the fix, as there is nothing the user can do about these values, adn they see the defaults appear in the 'Current session value' column.

(as it is it would be difficult to add these values to the parmset screen, one would need a colun at the very end that said "if ther are no other values set anywhere else, we'll use this one.)

Anyhoo.

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