loncom/lonnet/perl/lonnet.pm - view

File: [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.1052: download - view: text, annotated - select for diffs
Thu Feb 25 03:43:27 2010 UTC (14 years, 4 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Sanity checking of proposed home server for course when creating a course.
  - Use primary library server for course domain if no server specified.
  - Eliminate use of $env{'user.homeserver'} which is not in a user's %env.

1: # The LearningOnline Network 2: # TCP networking package 3: # 4: # $Id: lonnet.pm,v 1.1052 2010/02/25 03:43:27 raeburn Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: ### 29: 30: =pod 31: 32: =head1 NAME 33: 34: Apache::lonnet.pm 35: 36: =head1 SYNOPSIS 37: 38: This file is an interface to the lonc processes of 39: the LON-CAPA network as well as set of elaborated functions for handling information 40: necessary for navigating through a given cluster of LON-CAPA machines within a 41: domain. There are over 40 specialized functions in this module which handle the 42: reading and transmission of metadata, user information (ids, names, environments, roles, 43: logs), file information (storage, reading, directories, extensions, replication, embedded 44: styles and descriptors), educational resources (course descriptions, section names and 45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to 46: and from more descriptive phrases or explanations. 47: 48: This is part of the LearningOnline Network with CAPA project 49: described at http://www.lon-capa.org. 50: 51: =head1 Package Variables 52: 53: These are largely undocumented, so if you decipher one please note it here. 54: 55: =over 4 56: 57: =item $processmarker 58: 59: Contains the time this process was started and this servers host id. 60: 61: =item $dumpcount 62: 63: Counts the number of times a message log flush has been attempted (regardless 64: of success) by this process. Used as part of the filename when messages are 65: delayed. 66: 67: =back 68: 69: =cut 70: 71: package Apache::lonnet; 72: 73: use strict; 74: use LWP::UserAgent(); 75: use HTTP::Date; 76: use Image::Magick; 77: 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir 79: $_64bit %env %protocol); 80: 81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash, 82: %userrolehash, $processmarker, $dumpcount, %coursedombuf, 83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf, 84: %courseownerbuf, %coursetypebuf,$locknum); 85: 86: use IO::Socket; 87: use GDBM_File; 88: use HTML::LCParser; 89: use Fcntl qw(:flock); 90: use Storable qw(thaw nfreeze); 91: use Time::HiRes qw( gettimeofday tv_interval ); 92: use Cache::Memcached; 93: use Digest::MD5; 94: use Math::Random; 95: use File::MMagic; 96: use LONCAPA qw(:DEFAULT :match); 97: use LONCAPA::Configuration; 98: 99: my $readit; 100: my $max_connection_retries = 10; # Or some such value. 101: 102: require Exporter; 103: 104: our @ISA = qw (Exporter); 105: our @EXPORT = qw(%env); 106: 107: 108: # --------------------------------------------------------------------- Logging 109: { 110: my $logid; 111: sub instructor_log { 112: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_; 113: if (($cnum eq '') || ($cdom eq '')) { 114: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 115: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 116: } 117: $logid++; 118: my $now = time(); 119: my $id=$now.'00000'.$$.'00000'.$logid; 120: return &Apache::lonnet::put('nohist_'.$hash_name, 121: { $id => { 122: 'exe_uname' => $env{'user.name'}, 123: 'exe_udom' => $env{'user.domain'}, 124: 'exe_time' => $now, 125: 'exe_ip' => $ENV{'REMOTE_ADDR'}, 126: 'delflag' => $delflag, 127: 'logentry' => $storehash, 128: 'uname' => $uname, 129: 'udom' => $udom, 130: } 131: },$cdom,$cnum); 132: } 133: } 134: 135: sub logtouch { 136: my $execdir=$perlvar{'lonDaemons'}; 137: unless (-e "$execdir/logs/lonnet.log") { 138: open(my $fh,">>$execdir/logs/lonnet.log"); 139: close $fh; 140: } 141: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3]; 142: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log'); 143: } 144: 145: sub logthis { 146: my $message=shift; 147: my $execdir=$perlvar{'lonDaemons'}; 148: my $now=time; 149: my $local=localtime($now); 150: if (open(my $fh,">>$execdir/logs/lonnet.log")) { 151: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string. 152: print $fh $logstring; 153: close($fh); 154: } 155: return 1; 156: } 157: 158: sub logperm { 159: my $message=shift; 160: my $execdir=$perlvar{'lonDaemons'}; 161: my $now=time; 162: my $local=localtime($now); 163: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) { 164: print $fh "$now:$message:$local\n"; 165: close($fh); 166: } 167: return 1; 168: } 169: 170: sub create_connection { 171: my ($hostname,$lonid) = @_; 172: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'}, 173: Type => SOCK_STREAM, 174: Timeout => 10); 175: return 0 if (!$client); 176: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n"); 177: my $result = <$client>; 178: chomp($result); 179: return 1 if ($result eq 'done'); 180: return 0; 181: } 182: 183: sub get_server_timezone { 184: my ($cnum,$cdom) = @_; 185: my $home=&homeserver($cnum,$cdom); 186: if ($home ne 'no_host') { 187: my $cachetime = 24*3600; 188: my ($timezone,$cached)=&is_cached_new('servertimezone',$home); 189: if (defined($cached)) { 190: return $timezone; 191: } else { 192: my $timezone = &reply('servertimezone',$home); 193: return &do_cache_new('servertimezone',$home,$timezone,$cachetime); 194: } 195: } 196: } 197: 198: sub get_server_loncaparev { 199: my ($dom,$lonhost) = @_; 200: if (defined($lonhost)) { 201: if (!defined(&hostname($lonhost))) { 202: undef($lonhost); 203: } 204: } 205: if (!defined($lonhost)) { 206: if (defined(&domain($dom,'primary'))) { 207: $lonhost=&domain($dom,'primary'); 208: if ($lonhost eq 'no_host') { 209: undef($lonhost); 210: } 211: } 212: } 213: if (defined($lonhost)) { 214: my $cachetime = 24*3600; 215: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost); 216: if (defined($cached)) { 217: return $loncaparev; 218: } else { 219: my $loncaparev = &reply('serverloncaparev',$lonhost); 220: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime); 221: } 222: } 223: } 224: 225: # -------------------------------------------------- Non-critical communication 226: sub subreply { 227: my ($cmd,$server)=@_; 228: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server); 229: # 230: # With loncnew process trimming, there's a timing hole between lonc server 231: # process exit and the master server picking up the listen on the AF_UNIX 232: # socket. In that time interval, a lock file will exist: 233: 234: my $lockfile=$peerfile.".lock"; 235: while (-e $lockfile) { # Need to wait for the lockfile to disappear. 236: sleep(1); 237: } 238: # At this point, either a loncnew parent is listening or an old lonc 239: # or loncnew child is listening so we can connect or everything's dead. 240: # 241: # We'll give the connection a few tries before abandoning it. If 242: # connection is not possible, we'll con_lost back to the client. 243: # 244: my $client; 245: for (my $retries = 0; $retries < $max_connection_retries; $retries++) { 246: $client=IO::Socket::UNIX->new(Peer =>"$peerfile", 247: Type => SOCK_STREAM, 248: Timeout => 10); 249: if ($client) { 250: last; # Connected! 251: } else { 252: &create_connection(&hostname($server),$server); 253: } 254: sleep(1); # Try again later if failed connection. 255: } 256: my $answer; 257: if ($client) { 258: print $client "sethost:$server:$cmd\n"; 259: $answer=<$client>; 260: if (!$answer) { $answer="con_lost"; } 261: chomp($answer); 262: } else { 263: $answer = 'con_lost'; # Failed connection. 264: } 265: return $answer; 266: } 267: 268: sub reply { 269: my ($cmd,$server)=@_; 270: unless (defined(&hostname($server))) { return 'no_such_host'; } 271: my $answer=subreply($cmd,$server); 272: if (($answer=~/^refused/) || ($answer=~/^rejected/)) { 273: &logthis("WARNING:". 274: " $cmd to $server returned $answer"); 275: } 276: return $answer; 277: } 278: 279: # ----------------------------------------------------------- Send USR1 to lonc 280: 281: sub reconlonc { 282: my ($lonid) = @_; 283: my $hostname = &hostname($lonid); 284: if ($lonid) { 285: my $peerfile="$perlvar{'lonSockDir'}/$hostname"; 286: if ($hostname && -e $peerfile) { 287: &logthis("Trying to reconnect lonc for $lonid ($hostname)"); 288: my $client=IO::Socket::UNIX->new(Peer => $peerfile, 289: Type => SOCK_STREAM, 290: Timeout => 10); 291: if ($client) { 292: print $client ("reset_retries\n"); 293: my $answer=<$client>; 294: #reset just this one. 295: } 296: } 297: return; 298: } 299: 300: &logthis("Trying to reconnect lonc"); 301: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid"; 302: if (open(my $fh,"<$loncfile")) { 303: my $loncpid=<$fh>; 304: chomp($loncpid); 305: if (kill 0 => $loncpid) { 306: &logthis("lonc at pid $loncpid responding, sending USR1"); 307: kill USR1 => $loncpid; 308: sleep 1; 309: } else { 310: &logthis( 311: "WARNING:". 312: " lonc at pid $loncpid not responding, giving up"); 313: } 314: } else { 315: &logthis('WARNING: lonc not running, giving up'); 316: } 317: } 318: 319: # ------------------------------------------------------ Critical communication 320: 321: sub critical { 322: my ($cmd,$server)=@_; 323: unless (&hostname($server)) { 324: &logthis("WARNING:". 325: " Critical message to unknown server ($server)"); 326: return 'no_such_host'; 327: } 328: my $answer=reply($cmd,$server); 329: if ($answer eq 'con_lost') { 330: &reconlonc("$perlvar{'lonSockDir'}/$server"); 331: my $answer=reply($cmd,$server); 332: if ($answer eq 'con_lost') { 333: my $now=time; 334: my $middlename=$cmd; 335: $middlename=substr($middlename,0,16); 336: $middlename=~s/\W//g; 337: my $dfilename= 338: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server"; 339: $dumpcount++; 340: { 341: my $dfh; 342: if (open($dfh,">$dfilename")) { 343: print $dfh "$cmd\n"; 344: close($dfh); 345: } 346: } 347: sleep 2; 348: my $wcmd=''; 349: { 350: my $dfh; 351: if (open($dfh,"<$dfilename")) { 352: $wcmd=<$dfh>; 353: close($dfh); 354: } 355: } 356: chomp($wcmd); 357: if ($wcmd eq $cmd) { 358: &logthis("WARNING: ". 359: "Connection buffer $dfilename: $cmd"); 360: &logperm("D:$server:$cmd"); 361: return 'con_delayed'; 362: } else { 363: &logthis("CRITICAL:" 364: ." Critical connection failed: $server $cmd"); 365: &logperm("F:$server:$cmd"); 366: return 'con_failed'; 367: } 368: } 369: } 370: return $answer; 371: } 372: 373: # ------------------------------------------- check if return value is an error 374: 375: sub error { 376: my ($result) = @_; 377: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) { 378: if ($2 == 2) { return undef; } 379: return $1; 380: } 381: return undef; 382: } 383: 384: sub convert_and_load_session_env { 385: my ($lonidsdir,$handle)=@_; 386: my @profile; 387: { 388: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 389: if (!$opened) { 390: return 0; 391: } 392: flock($idf,LOCK_SH); 393: @profile=<$idf>; 394: close($idf); 395: } 396: my %temp_env; 397: foreach my $line (@profile) { 398: if ($line !~ m/=/) { 399: return 0; 400: } 401: chomp($line); 402: my ($envname,$envvalue)=split(/=/,$line,2); 403: $temp_env{&unescape($envname)} = &unescape($envvalue); 404: } 405: unlink("$lonidsdir/$handle.id"); 406: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(), 407: 0640)) { 408: %disk_env = %temp_env; 409: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)}; 410: untie(%disk_env); 411: } 412: return 1; 413: } 414: 415: # ------------------------------------------- Transfer profile into environment 416: my $env_loaded; 417: sub transfer_profile_to_env { 418: my ($lonidsdir,$handle,$force_transfer) = @_; 419: if (!$force_transfer && $env_loaded) { return; } 420: 421: if (!defined($lonidsdir)) { 422: $lonidsdir = $perlvar{'lonIDsDir'}; 423: } 424: if (!defined($handle)) { 425: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| ); 426: } 427: 428: my $convert; 429: { 430: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 431: if (!$opened) { 432: return; 433: } 434: flock($idf,LOCK_SH); 435: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id", 436: &GDBM_READER(),0640)) { 437: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)}; 438: untie(%disk_env); 439: } else { 440: $convert = 1; 441: } 442: } 443: if ($convert) { 444: if (!&convert_and_load_session_env($lonidsdir,$handle)) { 445: &logthis("Failed to load session, or convert session."); 446: } 447: } 448: 449: my %remove; 450: while ( my $envname = each(%env) ) { 451: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) { 452: if ($time < time-300) { 453: $remove{$key}++; 454: } 455: } 456: } 457: 458: $env{'user.environment'} = "$lonidsdir/$handle.id"; 459: $env_loaded=1; 460: foreach my $expired_key (keys(%remove)) { 461: &delenv($expired_key); 462: } 463: } 464: 465: # ---------------------------------------------------- Check for valid session 466: sub check_for_valid_session { 467: my ($r) = @_; 468: my %cookies=CGI::Cookie->parse($r->header_in('Cookie')); 469: my $lonid=$cookies{'lonID'}; 470: return undef if (!$lonid); 471: 472: my $handle=&LONCAPA::clean_handle($lonid->value); 473: my $lonidsdir=$r->dir_config('lonIDsDir'); 474: return undef if (!-e "$lonidsdir/$handle.id"); 475: 476: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 477: return undef if (!$opened); 478: 479: flock($idf,LOCK_SH); 480: my %disk_env; 481: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id", 482: &GDBM_READER(),0640)) { 483: return undef; 484: } 485: 486: if (!defined($disk_env{'user.name'}) 487: || !defined($disk_env{'user.domain'})) { 488: return undef; 489: } 490: return $handle; 491: } 492: 493: sub timed_flock { 494: my ($file,$lock_type) = @_; 495: my $failed=0; 496: eval { 497: local $SIG{__DIE__}='DEFAULT'; 498: local $SIG{ALRM}=sub { 499: $failed=1; 500: die("failed lock"); 501: }; 502: alarm(13); 503: flock($file,$lock_type); 504: alarm(0); 505: }; 506: if ($failed) { 507: return undef; 508: } else { 509: return 1; 510: } 511: } 512: 513: # ---------------------------------------------------------- Append Environment 514: 515: sub appenv { 516: my ($newenv,$roles) = @_; 517: if (ref($newenv) eq 'HASH') { 518: foreach my $key (keys(%{$newenv})) { 519: my $refused = 0; 520: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) { 521: $refused = 1; 522: if (ref($roles) eq 'ARRAY') { 523: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./); 524: if (grep(/^\Q$role\E$/,@{$roles})) { 525: $refused = 0; 526: } 527: } 528: } 529: if ($refused) { 530: &logthis("WARNING: ". 531: "Attempt to modify environment ".$key." to ".$newenv->{$key} 532: .''); 533: delete($newenv->{$key}); 534: } else { 535: $env{$key}=$newenv->{$key}; 536: } 537: } 538: my $opened = open(my $env_file,'+<',$env{'user.environment'}); 539: if ($opened 540: && &timed_flock($env_file,LOCK_EX) 541: && 542: tie(my %disk_env,'GDBM_File',$env{'user.environment'}, 543: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) { 544: while (my ($key,$value) = each(%{$newenv})) { 545: $disk_env{$key} = $value; 546: } 547: untie(%disk_env); 548: } 549: } 550: return 'ok'; 551: } 552: # ----------------------------------------------------- Delete from Environment 553: 554: sub delenv { 555: my ($delthis,$regexp) = @_; 556: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) { 557: &logthis("WARNING: ". 558: "Attempt to delete from environment ".$delthis); 559: return 'error'; 560: } 561: my $opened = open(my $env_file,'+<',$env{'user.environment'}); 562: if ($opened 563: && &timed_flock($env_file,LOCK_EX) 564: && 565: tie(my %disk_env,'GDBM_File',$env{'user.environment'}, 566: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) { 567: foreach my $key (keys(%disk_env)) { 568: if ($regexp) { 569: if ($key=~/^$delthis/) { 570: delete($env{$key}); 571: delete($disk_env{$key}); 572: } 573: } else { 574: if ($key=~/^\Q$delthis\E/) { 575: delete($env{$key}); 576: delete($disk_env{$key}); 577: } 578: } 579: } 580: untie(%disk_env); 581: } 582: return 'ok'; 583: } 584: 585: sub get_env_multiple { 586: my ($name) = @_; 587: my @values; 588: if (defined($env{$name})) { 589: # exists is it an array 590: if (ref($env{$name})) { 591: @values=@{ $env{$name} }; 592: } else { 593: $values[0]=$env{$name}; 594: } 595: } 596: return(@values); 597: } 598: 599: # ------------------------------------------------------------------- Locking 600: 601: sub set_lock { 602: my ($text)=@_; 603: $locknum++; 604: my $id=$$.'-'.$locknum; 605: &appenv({'session.locks' => $env{'session.locks'}.','.$id, 606: 'session.lock.'.$id => $text}); 607: return $id; 608: } 609: 610: sub get_locks { 611: my $num=0; 612: my %texts=(); 613: foreach my $lock (split(/\,/,$env{'session.locks'})) { 614: if ($lock=~/\w/) { 615: $num++; 616: $texts{$lock}=$env{'session.lock.'.$lock}; 617: } 618: } 619: return ($num,%texts); 620: } 621: 622: sub remove_lock { 623: my ($id)=@_; 624: my $newlocks=''; 625: foreach my $lock (split(/\,/,$env{'session.locks'})) { 626: if (($lock=~/\w/) && ($lock ne $id)) { 627: $newlocks.=','.$lock; 628: } 629: } 630: &appenv({'session.locks' => $newlocks}); 631: &delenv('session.lock.'.$id); 632: } 633: 634: sub remove_all_locks { 635: my $activelocks=$env{'session.locks'}; 636: foreach my $lock (split(/\,/,$env{'session.locks'})) { 637: if ($lock=~/\w/) { 638: &remove_lock($lock); 639: } 640: } 641: } 642: 643: 644: # ------------------------------------------ Find out current server userload 645: sub userload { 646: my $numusers=0; 647: { 648: opendir(LONIDS,$perlvar{'lonIDsDir'}); 649: my $filename; 650: my $curtime=time; 651: while ($filename=readdir(LONIDS)) { 652: next if ($filename eq '.' || $filename eq '..'); 653: next if ($filename =~ /publicuser_\d+\.id/); 654: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9]; 655: if ($curtime-$mtime < 1800) { $numusers++; } 656: } 657: closedir(LONIDS); 658: } 659: my $userloadpercent=0; 660: my $maxuserload=$perlvar{'lonUserLoadLim'}; 661: if ($maxuserload) { 662: $userloadpercent=100*$numusers/$maxuserload; 663: } 664: $userloadpercent=sprintf("%.2f",$userloadpercent); 665: return $userloadpercent; 666: } 667: 668: # ------------------------------------------ Fight off request when overloaded 669: 670: sub overloaderror { 671: my ($r,$checkserver)=@_; 672: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; } 673: my $loadavg; 674: if ($checkserver eq $perlvar{'lonHostID'}) { 675: open(my $loadfile,'/proc/loadavg'); 676: $loadavg=<$loadfile>; 677: $loadavg =~ s/\s.*//g; 678: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'}; 679: close($loadfile); 680: } else { 681: $loadavg=&reply('load',$checkserver); 682: } 683: my $overload=$loadavg-100; 684: if ($overload>0) { 685: $r->err_headers_out->{'Retry-After'}=$overload; 686: $r->log_error('Overload of '.$overload.' on '.$checkserver); 687: return 413; 688: } 689: return ''; 690: } 691: 692: # ------------------------------ Find server with least workload from spare.tab 693: 694: sub spareserver { 695: my ($loadpercent,$userloadpercent,$want_server_name) = @_; 696: my $spare_server; 697: if ($userloadpercent !~ /\d/) { $userloadpercent=0; } 698: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 699: : $userloadpercent; 700: 701: foreach my $try_server (@{ $spareid{'primary'} }) { 702: ($spare_server, $lowest_load) = 703: &compare_server_load($try_server, $spare_server, $lowest_load); 704: } 705: 706: my $found_server = ($spare_server ne '' && $lowest_load < 100); 707: 708: if (!$found_server) { 709: foreach my $try_server (@{ $spareid{'default'} }) { 710: ($spare_server, $lowest_load) = 711: &compare_server_load($try_server, $spare_server, $lowest_load); 712: } 713: } 714: 715: if (!$want_server_name) { 716: my $protocol = 'http'; 717: if ($protocol{$spare_server} eq 'https') { 718: $protocol = $protocol{$spare_server}; 719: } 720: if (defined($spare_server)) { 721: my $hostname = &hostname($spare_server); 722: if (defined($hostname)) { 723: $spare_server = $protocol.'://'.$hostname; 724: } 725: } 726: } 727: return $spare_server; 728: } 729: 730: sub compare_server_load { 731: my ($try_server, $spare_server, $lowest_load) = @_; 732: 733: my $loadans = &reply('load', $try_server); 734: my $userloadans = &reply('userload',$try_server); 735: 736: if ($loadans !~ /\d/ && $userloadans !~ /\d/) { 737: next; #didn't get a number from the server 738: } 739: 740: my $load; 741: if ($loadans =~ /\d/) { 742: if ($userloadans =~ /\d/) { 743: #both are numbers, pick the bigger one 744: $load = ($loadans > $userloadans) ? $loadans 745: : $userloadans; 746: } else { 747: $load = $loadans; 748: } 749: } else { 750: $load = $userloadans; 751: } 752: 753: if (($load =~ /\d/) && ($load < $lowest_load)) { 754: $spare_server = $try_server; 755: $lowest_load = $load; 756: } 757: return ($spare_server,$lowest_load); 758: } 759: 760: # --------------------------- ask offload servers if user already has a session 761: sub find_existing_session { 762: my ($udom,$uname) = @_; 763: foreach my $try_server (@{ $spareid{'primary'} }, 764: @{ $spareid{'default'} }) { 765: return $try_server if (&has_user_session($try_server, $udom, $uname)); 766: } 767: return; 768: } 769: 770: # -------------------------------- ask if server already has a session for user 771: sub has_user_session { 772: my ($lonid,$udom,$uname) = @_; 773: my $result = &reply(join(':','userhassession', 774: map {&escape($_)} ($udom,$uname)),$lonid); 775: return 1 if ($result eq 'ok'); 776: 777: return 0; 778: } 779: 780: # --------------------------------------------- Try to change a user's password 781: 782: sub changepass { 783: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_; 784: $currentpass = &escape($currentpass); 785: $newpass = &escape($newpass); 786: my $lonhost = $perlvar{'lonHostID'}; 787: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost", 788: $server); 789: if (! $answer) { 790: &logthis("No reply on password change request to $server ". 791: "by $uname in domain $udom."); 792: } elsif ($answer =~ "^ok") { 793: &logthis("$uname in $udom successfully changed their password ". 794: "on $server."); 795: } elsif ($answer =~ "^pwchange_failure") { 796: &logthis("$uname in $udom was unable to change their password ". 797: "on $server. The action was blocked by either lcpasswd ". 798: "or pwchange"); 799: } elsif ($answer =~ "^non_authorized") { 800: &logthis("$uname in $udom did not get their password correct when ". 801: "attempting to change it on $server."); 802: } elsif ($answer =~ "^auth_mode_error") { 803: &logthis("$uname in $udom attempted to change their password despite ". 804: "not being locally or internally authenticated on $server."); 805: } elsif ($answer =~ "^unknown_user") { 806: &logthis("$uname in $udom attempted to change their password ". 807: "on $server but were unable to because $server is not ". 808: "their home server."); 809: } elsif ($answer =~ "^refused") { 810: &logthis("$server refused to change $uname in $udom password because ". 811: "it was sent an unencrypted request to change the password."); 812: } elsif ($answer =~ "invalid_client") { 813: &logthis("$server refused to change $uname in $udom password because ". 814: "it was a reset by e-mail originating from an invalid server."); 815: } 816: return $answer; 817: } 818: 819: # ----------------------- Try to determine user's current authentication scheme 820: 821: sub queryauthenticate { 822: my ($uname,$udom)=@_; 823: my $uhome=&homeserver($uname,$udom); 824: if (!$uhome) { 825: &logthis("User $uname at $udom is unknown when looking for authentication mechanism"); 826: return 'no_host'; 827: } 828: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome); 829: if ($answer =~ /^(unknown_user|refused|con_lost)/) { 830: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 831: } 832: return $answer; 833: } 834: 835: # --------- Try to authenticate user from domain's lib servers (first this one) 836: 837: sub authenticate { 838: my ($uname,$upass,$udom,$checkdefauth)=@_; 839: $upass=&escape($upass); 840: $uname= &LONCAPA::clean_username($uname); 841: my $uhome=&homeserver($uname,$udom,1); 842: my $newhome; 843: if ((!$uhome) || ($uhome eq 'no_host')) { 844: # Maybe the machine was offline and only re-appeared again recently? 845: &reconlonc(); 846: # One more 847: $uhome=&homeserver($uname,$udom,1); 848: if (($uhome eq 'no_host') && $checkdefauth) { 849: if (defined(&domain($udom,'primary'))) { 850: $newhome=&domain($udom,'primary'); 851: } 852: if ($newhome ne '') { 853: $uhome = $newhome; 854: } 855: } 856: if ((!$uhome) || ($uhome eq 'no_host')) { 857: &logthis("User $uname at $udom is unknown in authenticate"); 858: return 'no_host'; 859: } 860: } 861: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome); 862: if ($answer eq 'authorized') { 863: if ($newhome) { 864: &logthis("User $uname at $udom authorized by $uhome, but needs account"); 865: return 'no_account_on_host'; 866: } else { 867: &logthis("User $uname at $udom authorized by $uhome"); 868: return $uhome; 869: } 870: } 871: if ($answer eq 'non_authorized') { 872: &logthis("User $uname at $udom rejected by $uhome"); 873: return 'no_host'; 874: } 875: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 876: return 'no_host'; 877: } 878: 879: # ---------------------- Find the homebase for a user from domain's lib servers 880: 881: my %homecache; 882: sub homeserver { 883: my ($uname,$udom,$ignoreBadCache)=@_; 884: my $index="$uname:$udom"; 885: 886: if (exists($homecache{$index})) { return $homecache{$index}; } 887: 888: my %servers = &get_servers($udom,'library'); 889: foreach my $tryserver (keys(%servers)) { 890: next if ($ignoreBadCache ne 'true' && 891: exists($badServerCache{$tryserver})); 892: 893: my $answer=reply("home:$udom:$uname",$tryserver); 894: if ($answer eq 'found') { 895: delete($badServerCache{$tryserver}); 896: return $homecache{$index}=$tryserver; 897: } elsif ($answer eq 'no_host') { 898: $badServerCache{$tryserver}=1; 899: } 900: } 901: return 'no_host'; 902: } 903: 904: # ------------------------------------- Find the usernames behind a list of IDs 905: 906: sub idget { 907: my ($udom,@ids)=@_; 908: my %returnhash=(); 909: 910: my %servers = &get_servers($udom,'library'); 911: foreach my $tryserver (keys(%servers)) { 912: my $idlist=join('&',@ids); 913: $idlist=~tr/A-Z/a-z/; 914: my $reply=&reply("idget:$udom:".$idlist,$tryserver); 915: my @answer=(); 916: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) { 917: @answer=split(/\&/,$reply); 918: } ; 919: my $i; 920: for ($i=0;$i<=$#ids;$i++) { 921: if ($answer[$i]) { 922: $returnhash{$ids[$i]}=$answer[$i]; 923: } 924: } 925: } 926: return %returnhash; 927: } 928: 929: # ------------------------------------- Find the IDs behind a list of usernames 930: 931: sub idrget { 932: my ($udom,@unames)=@_; 933: my %returnhash=(); 934: foreach my $uname (@unames) { 935: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1]; 936: } 937: return %returnhash; 938: } 939: 940: # ------------------------------- Store away a list of names and associated IDs 941: 942: sub idput { 943: my ($udom,%ids)=@_; 944: my %servers=(); 945: foreach my $uname (keys(%ids)) { 946: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname); 947: my $uhom=&homeserver($uname,$udom); 948: if ($uhom ne 'no_host') { 949: my $id=&escape($ids{$uname}); 950: $id=~tr/A-Z/a-z/; 951: my $esc_unam=&escape($uname); 952: if ($servers{$uhom}) { 953: $servers{$uhom}.='&'.$id.'='.$esc_unam; 954: } else { 955: $servers{$uhom}=$id.'='.$esc_unam; 956: } 957: } 958: } 959: foreach my $server (keys(%servers)) { 960: &critical('idput:'.$udom.':'.$servers{$server},$server); 961: } 962: } 963: 964: # ------------------------------dump from db file owned by domainconfig user 965: sub dump_dom { 966: my ($namespace,$udom,$regexp,$range)=@_; 967: if (!$udom) { 968: $udom=$env{'user.domain'}; 969: } 970: my %returnhash; 971: if ($udom) { 972: my $uname = &get_domainconfiguser($udom); 973: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range); 974: } 975: return %returnhash; 976: } 977: 978: # ------------------------------------------ get items from domain db files 979: 980: sub get_dom { 981: my ($namespace,$storearr,$udom,$uhome)=@_; 982: my $items=''; 983: foreach my $item (@$storearr) { 984: $items.=&escape($item).'&'; 985: } 986: $items=~s/\&$//; 987: if (!$udom) { 988: $udom=$env{'user.domain'}; 989: if (defined(&domain($udom,'primary'))) { 990: $uhome=&domain($udom,'primary'); 991: } else { 992: undef($uhome); 993: } 994: } else { 995: if (!$uhome) { 996: if (defined(&domain($udom,'primary'))) { 997: $uhome=&domain($udom,'primary'); 998: } 999: } 1000: } 1001: if ($udom && $uhome && ($uhome ne 'no_host')) { 1002: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome); 1003: my %returnhash; 1004: if ($rep eq '' || $rep =~ /^error: 2 /) { 1005: return %returnhash; 1006: } 1007: my @pairs=split(/\&/,$rep); 1008: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 1009: return @pairs; 1010: } 1011: my $i=0; 1012: foreach my $item (@$storearr) { 1013: $returnhash{$item}=&thaw_unescape($pairs[$i]); 1014: $i++; 1015: } 1016: return %returnhash; 1017: } else { 1018: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)"); 1019: } 1020: } 1021: 1022: # -------------------------------------------- put items in domain db files 1023: 1024: sub put_dom { 1025: my ($namespace,$storehash,$udom,$uhome)=@_; 1026: if (!$udom) { 1027: $udom=$env{'user.domain'}; 1028: if (defined(&domain($udom,'primary'))) { 1029: $uhome=&domain($udom,'primary'); 1030: } else { 1031: undef($uhome); 1032: } 1033: } else { 1034: if (!$uhome) { 1035: if (defined(&domain($udom,'primary'))) { 1036: $uhome=&domain($udom,'primary'); 1037: } 1038: } 1039: } 1040: if ($udom && $uhome && ($uhome ne 'no_host')) { 1041: my $items=''; 1042: foreach my $item (keys(%$storehash)) { 1043: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 1044: } 1045: $items=~s/\&$//; 1046: return &reply("putdom:$udom:$namespace:$items",$uhome); 1047: } else { 1048: &logthis("put_dom failed - no homeserver and/or domain"); 1049: } 1050: } 1051: 1052: # --------------------- newput for items in db file owned by domainconfig user 1053: sub newput_dom { 1054: my ($namespace,$storehash,$udom) = @_; 1055: my $result; 1056: if (!$udom) { 1057: $udom=$env{'user.domain'}; 1058: } 1059: if ($udom) { 1060: my $uname = &get_domainconfiguser($udom); 1061: $result = &newput($namespace,$storehash,$udom,$uname); 1062: } 1063: return $result; 1064: } 1065: 1066: # --------------------- delete for items in db file owned by domainconfig user 1067: sub del_dom { 1068: my ($namespace,$storearr,$udom)=@_; 1069: if (ref($storearr) eq 'ARRAY') { 1070: if (!$udom) { 1071: $udom=$env{'user.domain'}; 1072: } 1073: if ($udom) { 1074: my $uname = &get_domainconfiguser($udom); 1075: return &del($namespace,$storearr,$udom,$uname); 1076: } 1077: } 1078: } 1079: 1080: # ----------------------------------construct domainconfig user for a domain 1081: sub get_domainconfiguser { 1082: my ($udom) = @_; 1083: return $udom.'-domainconfig'; 1084: } 1085: 1086: sub retrieve_inst_usertypes { 1087: my ($udom) = @_; 1088: my (%returnhash,@order); 1089: my %domdefs = &Apache::lonnet::get_domain_defaults($udom); 1090: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 1091: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) { 1092: %returnhash = %{$domdefs{'inststatustypes'}}; 1093: @order = @{$domdefs{'inststatusorder'}}; 1094: } else { 1095: if (defined(&domain($udom,'primary'))) { 1096: my $uhome=&domain($udom,'primary'); 1097: my $rep=&reply("inst_usertypes:$udom",$uhome); 1098: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) { 1099: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom"); 1100: return (\%returnhash,\@order); 1101: } 1102: my ($hashitems,$orderitems) = split(/:/,$rep); 1103: my @pairs=split(/\&/,$hashitems); 1104: foreach my $item (@pairs) { 1105: my ($key,$value)=split(/=/,$item,2); 1106: $key = &unescape($key); 1107: next if ($key =~ /^error: 2 /); 1108: $returnhash{$key}=&thaw_unescape($value); 1109: } 1110: my @esc_order = split(/\&/,$orderitems); 1111: foreach my $item (@esc_order) { 1112: push(@order,&unescape($item)); 1113: } 1114: } else { 1115: &logthis("get_dom failed - no primary domain server for $udom"); 1116: } 1117: } 1118: return (\%returnhash,\@order); 1119: } 1120: 1121: sub is_domainimage { 1122: my ($url) = @_; 1123: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) { 1124: if (&domain($1) ne '') { 1125: return '1'; 1126: } 1127: } 1128: return; 1129: } 1130: 1131: sub inst_directory_query { 1132: my ($srch) = @_; 1133: my $udom = $srch->{'srchdomain'}; 1134: my %results; 1135: my $homeserver = &domain($udom,'primary'); 1136: my $outcome; 1137: if ($homeserver ne '') { 1138: my $queryid=&reply("querysend:instdirsearch:". 1139: &escape($srch->{'srchby'}).':'. 1140: &escape($srch->{'srchterm'}).':'. 1141: &escape($srch->{'srchtype'}),$homeserver); 1142: my $host=&hostname($homeserver); 1143: if ($queryid !~/^\Q$host\E\_/) { 1144: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1145: return; 1146: } 1147: my $response = &get_query_reply($queryid); 1148: my $maxtries = 5; 1149: my $tries = 1; 1150: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1151: $response = &get_query_reply($queryid); 1152: $tries ++; 1153: } 1154: 1155: if (!&error($response) && $response ne 'refused') { 1156: if ($response eq 'unavailable') { 1157: $outcome = $response; 1158: } else { 1159: $outcome = 'ok'; 1160: my @matches = split(/\n/,$response); 1161: foreach my $match (@matches) { 1162: my ($key,$value) = split(/=/,$match); 1163: $results{&unescape($key).':'.$udom} = &thaw_unescape($value); 1164: } 1165: } 1166: } 1167: } 1168: return ($outcome,%results); 1169: } 1170: 1171: sub usersearch { 1172: my ($srch) = @_; 1173: my $dom = $srch->{'srchdomain'}; 1174: my %results; 1175: my %libserv = &all_library(); 1176: my $query = 'usersearch'; 1177: foreach my $tryserver (keys(%libserv)) { 1178: if (&host_domain($tryserver) eq $dom) { 1179: my $host=&hostname($tryserver); 1180: my $queryid= 1181: &reply("querysend:".&escape($query).':'. 1182: &escape($srch->{'srchby'}).':'. 1183: &escape($srch->{'srchtype'}).':'. 1184: &escape($srch->{'srchterm'}),$tryserver); 1185: if ($queryid !~/^\Q$host\E\_/) { 1186: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver); 1187: next; 1188: } 1189: my $reply = &get_query_reply($queryid); 1190: my $maxtries = 1; 1191: my $tries = 1; 1192: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 1193: $reply = &get_query_reply($queryid); 1194: $tries ++; 1195: } 1196: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 1197: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries); 1198: } else { 1199: my @matches; 1200: if ($reply =~ /\n/) { 1201: @matches = split(/\n/,$reply); 1202: } else { 1203: @matches = split(/\&/,$reply); 1204: } 1205: foreach my $match (@matches) { 1206: my ($uname,$udom,%userhash); 1207: foreach my $entry (split(/:/,$match)) { 1208: my ($key,$value) = 1209: map {&unescape($_);} split(/=/,$entry); 1210: $userhash{$key} = $value; 1211: if ($key eq 'username') { 1212: $uname = $value; 1213: } elsif ($key eq 'domain') { 1214: $udom = $value; 1215: } 1216: } 1217: $results{$uname.':'.$udom} = \%userhash; 1218: } 1219: } 1220: } 1221: } 1222: return %results; 1223: } 1224: 1225: sub get_instuser { 1226: my ($udom,$uname,$id) = @_; 1227: my $homeserver = &domain($udom,'primary'); 1228: my ($outcome,%results); 1229: if ($homeserver ne '') { 1230: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'. 1231: &escape($id).':'.&escape($udom),$homeserver); 1232: my $host=&hostname($homeserver); 1233: if ($queryid !~/^\Q$host\E\_/) { 1234: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1235: return; 1236: } 1237: my $response = &get_query_reply($queryid); 1238: my $maxtries = 5; 1239: my $tries = 1; 1240: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1241: $response = &get_query_reply($queryid); 1242: $tries ++; 1243: } 1244: if (!&error($response) && $response ne 'refused') { 1245: if ($response eq 'unavailable') { 1246: $outcome = $response; 1247: } else { 1248: $outcome = 'ok'; 1249: my @matches = split(/\n/,$response); 1250: foreach my $match (@matches) { 1251: my ($key,$value) = split(/=/,$match); 1252: $results{&unescape($key)} = &thaw_unescape($value); 1253: } 1254: } 1255: } 1256: } 1257: my %userinfo; 1258: if (ref($results{$uname}) eq 'HASH') { 1259: %userinfo = %{$results{$uname}}; 1260: } 1261: return ($outcome,%userinfo); 1262: } 1263: 1264: sub inst_rulecheck { 1265: my ($udom,$uname,$id,$item,$rules) = @_; 1266: my %returnhash; 1267: if ($udom ne '') { 1268: if (ref($rules) eq 'ARRAY') { 1269: @{$rules} = map {&escape($_);} (@{$rules}); 1270: my $rulestr = join(':',@{$rules}); 1271: my $homeserver=&domain($udom,'primary'); 1272: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1273: my $response; 1274: if ($item eq 'username') { 1275: $response=&unescape(&reply('instrulecheck:'.&escape($udom). 1276: ':'.&escape($uname).':'.$rulestr, 1277: $homeserver)); 1278: } elsif ($item eq 'id') { 1279: $response=&unescape(&reply('instidrulecheck:'.&escape($udom). 1280: ':'.&escape($id).':'.$rulestr, 1281: $homeserver)); 1282: } elsif ($item eq 'selfcreate') { 1283: $response=&unescape(&reply('instselfcreatecheck:'. 1284: &escape($udom).':'.&escape($uname). 1285: ':'.$rulestr,$homeserver)); 1286: } 1287: if ($response ne 'refused') { 1288: my @pairs=split(/\&/,$response); 1289: foreach my $item (@pairs) { 1290: my ($key,$value)=split(/=/,$item,2); 1291: $key = &unescape($key); 1292: next if ($key =~ /^error: 2 /); 1293: $returnhash{$key}=&thaw_unescape($value); 1294: } 1295: } 1296: } 1297: } 1298: } 1299: return %returnhash; 1300: } 1301: 1302: sub inst_userrules { 1303: my ($udom,$check) = @_; 1304: my (%ruleshash,@ruleorder); 1305: if ($udom ne '') { 1306: my $homeserver=&domain($udom,'primary'); 1307: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1308: my $response; 1309: if ($check eq 'id') { 1310: $response=&reply('instidrules:'.&escape($udom), 1311: $homeserver); 1312: } elsif ($check eq 'email') { 1313: $response=&reply('instemailrules:'.&escape($udom), 1314: $homeserver); 1315: } else { 1316: $response=&reply('instuserrules:'.&escape($udom), 1317: $homeserver); 1318: } 1319: if (($response ne 'refused') && ($response ne 'error') && 1320: ($response ne 'unknown_cmd') && 1321: ($response ne 'no_such_host')) { 1322: my ($hashitems,$orderitems) = split(/:/,$response); 1323: my @pairs=split(/\&/,$hashitems); 1324: foreach my $item (@pairs) { 1325: my ($key,$value)=split(/=/,$item,2); 1326: $key = &unescape($key); 1327: next if ($key =~ /^error: 2 /); 1328: $ruleshash{$key}=&thaw_unescape($value); 1329: } 1330: my @esc_order = split(/\&/,$orderitems); 1331: foreach my $item (@esc_order) { 1332: push(@ruleorder,&unescape($item)); 1333: } 1334: } 1335: } 1336: } 1337: return (\%ruleshash,\@ruleorder); 1338: } 1339: 1340: # ------------- Get Authentication, Language and User Tools Defaults for Domain 1341: 1342: sub get_domain_defaults { 1343: my ($domain) = @_; 1344: my $cachetime = 60*60*24; 1345: my ($result,$cached)=&is_cached_new('domdefaults',$domain); 1346: if (defined($cached)) { 1347: if (ref($result) eq 'HASH') { 1348: return %{$result}; 1349: } 1350: } 1351: my %domdefaults; 1352: my %domconfig = 1353: &Apache::lonnet::get_dom('configuration',['defaults','quotas', 1354: 'requestcourses','inststatus', 1355: 'coursedefaults'],$domain); 1356: if (ref($domconfig{'defaults'}) eq 'HASH') { 1357: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 1358: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'}; 1359: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'}; 1360: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'}; 1361: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'}; 1362: } else { 1363: $domdefaults{'lang_def'} = &domain($domain,'lang_def'); 1364: $domdefaults{'auth_def'} = &domain($domain,'auth_def'); 1365: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def'); 1366: } 1367: if (ref($domconfig{'quotas'}) eq 'HASH') { 1368: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') { 1369: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'}; 1370: } else { 1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'}; 1372: } 1373: my @usertools = ('aboutme','blog','portfolio'); 1374: foreach my $item (@usertools) { 1375: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') { 1376: $domdefaults{$item} = $domconfig{'quotas'}{$item}; 1377: } 1378: } 1379: } 1380: if (ref($domconfig{'requestcourses'}) eq 'HASH') { 1381: foreach my $item ('official','unofficial','community') { 1382: $domdefaults{$item} = $domconfig{'requestcourses'}{$item}; 1383: } 1384: } 1385: if (ref($domconfig{'inststatus'}) eq 'HASH') { 1386: foreach my $item ('inststatustypes','inststatusorder') { 1387: $domdefaults{$item} = $domconfig{'inststatus'}{$item}; 1388: } 1389: } 1390: if (ref($domconfig{'coursedefaults'}) eq 'HASH') { 1391: foreach my $item ('canuse_pdfforms') { 1392: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item}; 1393: } 1394: } 1395: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults, 1396: $cachetime); 1397: return %domdefaults; 1398: } 1399: 1400: # --------------------------------------------------- Assign a key to a student 1401: 1402: sub assign_access_key { 1403: # 1404: # a valid key looks like uname:udom#comments 1405: # comments are being appended 1406: # 1407: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_; 1408: $kdom= 1409: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom)); 1410: $knum= 1411: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum)); 1412: $cdom= 1413: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1414: $cnum= 1415: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1416: $udom=$env{'user.name'} unless (defined($udom)); 1417: $uname=$env{'user.domain'} unless (defined($uname)); 1418: my %existing=&get('accesskeys',[$ckey],$kdom,$knum); 1419: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key 1420: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 1421: # assigned to this person 1422: # - this should not happen, 1423: # unless something went wrong 1424: # the first time around 1425: # ready to assign 1426: $logentry=$1.'; '.$logentry; 1427: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry}, 1428: $kdom,$knum) eq 'ok') { 1429: # key now belongs to user 1430: my $envkey='key.'.$cdom.'_'.$cnum; 1431: if (&put('environment',{$envkey => $ckey}) eq 'ok') { 1432: &appenv({'environment.'.$envkey => $ckey}); 1433: return 'ok'; 1434: } else { 1435: return 1436: 'error: Count not permanently assign key, will need to be re-entered later.'; 1437: } 1438: } else { 1439: return 'error: Could not assign key, try again later.'; 1440: } 1441: } elsif (!$existing{$ckey}) { 1442: # the key does not exist 1443: return 'error: The key does not exist'; 1444: } else { 1445: # the key is somebody else's 1446: return 'error: The key is already in use'; 1447: } 1448: } 1449: 1450: # ------------------------------------------ put an additional comment on a key 1451: 1452: sub comment_access_key { 1453: # 1454: # a valid key looks like uname:udom#comments 1455: # comments are being appended 1456: # 1457: my ($ckey,$cdom,$cnum,$logentry)=@_; 1458: $cdom= 1459: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1460: $cnum= 1461: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1462: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1463: if ($existing{$ckey}) { 1464: $existing{$ckey}.='; '.$logentry; 1465: # ready to assign 1466: if (&put('accesskeys',{$ckey=>$existing{$ckey}}, 1467: $cdom,$cnum) eq 'ok') { 1468: return 'ok'; 1469: } else { 1470: return 'error: Count not store comment.'; 1471: } 1472: } else { 1473: # the key does not exist 1474: return 'error: The key does not exist'; 1475: } 1476: } 1477: 1478: # ------------------------------------------------------ Generate a set of keys 1479: 1480: sub generate_access_keys { 1481: my ($number,$cdom,$cnum,$logentry)=@_; 1482: $cdom= 1483: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1484: $cnum= 1485: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1486: unless (&allowed('mky',$cdom)) { return 0; } 1487: unless (($cdom) && ($cnum)) { return 0; } 1488: if ($number>10000) { return 0; } 1489: sleep(2); # make sure don't get same seed twice 1490: srand(time()^($$+($$<<15))); # from "Programming Perl" 1491: my $total=0; 1492: for (my $i=1;$i<=$number;$i++) { 1493: my $newkey=sprintf("%lx",int(100000*rand)).'-'. 1494: sprintf("%lx",int(100000*rand)).'-'. 1495: sprintf("%lx",int(100000*rand)); 1496: $newkey=~s/1/g/g; # folks mix up 1 and l 1497: $newkey=~s/0/h/g; # and also 0 and O 1498: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum); 1499: if ($existing{$newkey}) { 1500: $i--; 1501: } else { 1502: if (&put('accesskeys', 1503: { $newkey => '# generated '.localtime(). 1504: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}. 1505: '; '.$logentry }, 1506: $cdom,$cnum) eq 'ok') { 1507: $total++; 1508: } 1509: } 1510: } 1511: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 1512: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom); 1513: return $total; 1514: } 1515: 1516: # ------------------------------------------------------- Validate an accesskey 1517: 1518: sub validate_access_key { 1519: my ($ckey,$cdom,$cnum,$udom,$uname)=@_; 1520: $cdom= 1521: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1522: $cnum= 1523: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1524: $udom=$env{'user.domain'} unless (defined($udom)); 1525: $uname=$env{'user.name'} unless (defined($uname)); 1526: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1527: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/); 1528: } 1529: 1530: # ------------------------------------- Find the section of student in a course 1531: sub devalidate_getsection_cache { 1532: my ($udom,$unam,$courseid)=@_; 1533: my $hashid="$udom:$unam:$courseid"; 1534: &devalidate_cache_new('getsection',$hashid); 1535: } 1536: 1537: sub courseid_to_courseurl { 1538: my ($courseid) = @_; 1539: #already url style courseid 1540: return $courseid if ($courseid =~ m{^/}); 1541: 1542: if (exists($env{'course.'.$courseid.'.num'})) { 1543: my $cnum = $env{'course.'.$courseid.'.num'}; 1544: my $cdom = $env{'course.'.$courseid.'.domain'}; 1545: return "/$cdom/$cnum"; 1546: } 1547: 1548: my %courseinfo=&Apache::lonnet::coursedescription($courseid); 1549: if (exists($courseinfo{'num'})) { 1550: return "/$courseinfo{'domain'}/$courseinfo{'num'}"; 1551: } 1552: 1553: return undef; 1554: } 1555: 1556: sub getsection { 1557: my ($udom,$unam,$courseid)=@_; 1558: my $cachetime=1800; 1559: 1560: my $hashid="$udom:$unam:$courseid"; 1561: my ($result,$cached)=&is_cached_new('getsection',$hashid); 1562: if (defined($cached)) { return $result; } 1563: 1564: my %Pending; 1565: my %Expired; 1566: # 1567: # Each role can either have not started yet (pending), be active, 1568: # or have expired. 1569: # 1570: # If there is an active role, we are done. 1571: # 1572: # If there is more than one role which has not started yet, 1573: # choose the one which will start sooner 1574: # If there is one role which has not started yet, return it. 1575: # 1576: # If there is more than one expired role, choose the one which ended last. 1577: # If there is a role which has expired, return it. 1578: # 1579: $courseid = &courseid_to_courseurl($courseid); 1580: my %roleshash = &dump('roles',$udom,$unam,$courseid); 1581: foreach my $key (keys(%roleshash)) { 1582: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/); 1583: my $section=$1; 1584: if ($key eq $courseid.'_st') { $section=''; } 1585: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key})); 1586: my $now=time; 1587: if (defined($end) && $end && ($now > $end)) { 1588: $Expired{$end}=$section; 1589: next; 1590: } 1591: if (defined($start) && $start && ($now < $start)) { 1592: $Pending{$start}=$section; 1593: next; 1594: } 1595: return &do_cache_new('getsection',$hashid,$section,$cachetime); 1596: } 1597: # 1598: # Presumedly there will be few matching roles from the above 1599: # loop and the sorting time will be negligible. 1600: if (scalar(keys(%Pending))) { 1601: my ($time) = sort {$a <=> $b} keys(%Pending); 1602: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime); 1603: } 1604: if (scalar(keys(%Expired))) { 1605: my @sorted = sort {$a <=> $b} keys(%Expired); 1606: my $time = pop(@sorted); 1607: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime); 1608: } 1609: return &do_cache_new('getsection',$hashid,'-1',$cachetime); 1610: } 1611: 1612: sub save_cache { 1613: &purge_remembered(); 1614: #&Apache::loncommon::validate_page(); 1615: undef(%env); 1616: undef($env_loaded); 1617: } 1618: 1619: my $to_remember=-1; 1620: my %remembered; 1621: my %accessed; 1622: my $kicks=0; 1623: my $hits=0; 1624: sub make_key { 1625: my ($name,$id) = @_; 1626: if (length($id) > 65 1627: && length(&escape($id)) > 200) { 1628: $id=length($id).':'.&Digest::MD5::md5_hex($id); 1629: } 1630: return &escape($name.':'.$id); 1631: } 1632: 1633: sub devalidate_cache_new { 1634: my ($name,$id,$debug) = @_; 1635: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); } 1636: $id=&make_key($name,$id); 1637: $memcache->delete($id); 1638: delete($remembered{$id}); 1639: delete($accessed{$id}); 1640: } 1641: 1642: sub is_cached_new { 1643: my ($name,$id,$debug) = @_; 1644: $id=&make_key($name,$id); 1645: if (exists($remembered{$id})) { 1646: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); } 1647: $accessed{$id}=[&gettimeofday()]; 1648: $hits++; 1649: return ($remembered{$id},1); 1650: } 1651: my $value = $memcache->get($id); 1652: if (!(defined($value))) { 1653: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); } 1654: return (undef,undef); 1655: } 1656: if ($value eq '__undef__') { 1657: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); } 1658: $value=undef; 1659: } 1660: &make_room($id,$value,$debug); 1661: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); } 1662: return ($value,1); 1663: } 1664: 1665: sub do_cache_new { 1666: my ($name,$id,$value,$time,$debug) = @_; 1667: $id=&make_key($name,$id); 1668: my $setvalue=$value; 1669: if (!defined($setvalue)) { 1670: $setvalue='__undef__'; 1671: } 1672: if (!defined($time) ) { 1673: $time=600; 1674: } 1675: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); } 1676: my $result = $memcache->set($id,$setvalue,$time); 1677: if (! $result) { 1678: &logthis("caching of id -> $id failed"); 1679: $memcache->disconnect_all(); 1680: } 1681: # need to make a copy of $value 1682: &make_room($id,$value,$debug); 1683: return $value; 1684: } 1685: 1686: sub make_room { 1687: my ($id,$value,$debug)=@_; 1688: 1689: $remembered{$id}= (ref($value)) ? &Storable::dclone($value) 1690: : $value; 1691: if ($to_remember<0) { return; } 1692: $accessed{$id}=[&gettimeofday()]; 1693: if (scalar(keys(%remembered)) <= $to_remember) { return; } 1694: my $to_kick; 1695: my $max_time=0; 1696: foreach my $other (keys(%accessed)) { 1697: if (&tv_interval($accessed{$other}) > $max_time) { 1698: $to_kick=$other; 1699: $max_time=&tv_interval($accessed{$other}); 1700: } 1701: } 1702: delete($remembered{$to_kick}); 1703: delete($accessed{$to_kick}); 1704: $kicks++; 1705: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); } 1706: return; 1707: } 1708: 1709: sub purge_remembered { 1710: #&logthis("Tossing ".scalar(keys(%remembered))); 1711: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered)))); 1712: undef(%remembered); 1713: undef(%accessed); 1714: } 1715: # ------------------------------------- Read an entry from a user's environment 1716: 1717: sub userenvironment { 1718: my ($udom,$unam,@what)=@_; 1719: my $items; 1720: foreach my $item (@what) { 1721: $items.=&escape($item).'&'; 1722: } 1723: $items=~s/\&$//; 1724: my %returnhash=(); 1725: my $uhome = &homeserver($unam,$udom); 1726: unless ($uhome eq 'no_host') { 1727: my @answer=split(/\&/, 1728: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome)); 1729: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) { 1730: return %returnhash; 1731: } 1732: my $i; 1733: for ($i=0;$i<=$#what;$i++) { 1734: $returnhash{$what[$i]}=&unescape($answer[$i]); 1735: } 1736: } 1737: return %returnhash; 1738: } 1739: 1740: # ---------------------------------------------------------- Get a studentphoto 1741: sub studentphoto { 1742: my ($udom,$unam,$ext) = @_; 1743: my $home=&Apache::lonnet::homeserver($unam,$udom); 1744: if (defined($env{'request.course.id'})) { 1745: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) { 1746: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) { 1747: return(&retrievestudentphoto($udom,$unam,$ext)); 1748: } else { 1749: my ($result,$perm_reqd)= 1750: &Apache::lonnet::auto_photo_permission($unam,$udom); 1751: if ($result eq 'ok') { 1752: if (!($perm_reqd eq 'yes')) { 1753: return(&retrievestudentphoto($udom,$unam,$ext)); 1754: } 1755: } 1756: } 1757: } 1758: } else { 1759: my ($result,$perm_reqd) = 1760: &Apache::lonnet::auto_photo_permission($unam,$udom); 1761: if ($result eq 'ok') { 1762: if (!($perm_reqd eq 'yes')) { 1763: return(&retrievestudentphoto($udom,$unam,$ext)); 1764: } 1765: } 1766: } 1767: return '/adm/lonKaputt/lonlogo_broken.gif'; 1768: } 1769: 1770: sub retrievestudentphoto { 1771: my ($udom,$unam,$ext,$type) = @_; 1772: my $home=&Apache::lonnet::homeserver($unam,$udom); 1773: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home); 1774: if ($ret eq 'ok') { 1775: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext"; 1776: if ($type eq 'thumbnail') { 1777: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 1778: } 1779: my $tokenurl=&Apache::lonnet::tokenwrapper($url); 1780: return $tokenurl; 1781: } else { 1782: if ($type eq 'thumbnail') { 1783: return '/adm/lonKaputt/genericstudent_tn.gif'; 1784: } else { 1785: return '/adm/lonKaputt/lonlogo_broken.gif'; 1786: } 1787: } 1788: } 1789: 1790: # -------------------------------------------------------------------- New chat 1791: 1792: sub chatsend { 1793: my ($newentry,$anon,$group)=@_; 1794: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'}; 1795: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 1796: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'}; 1797: &reply('chatsend:'.$cdom.':'.$cnum.':'. 1798: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'. 1799: &escape($newentry)).':'.$group,$chome); 1800: } 1801: 1802: # ------------------------------------------ Find current version of a resource 1803: 1804: sub getversion { 1805: my $fname=&clutter(shift); 1806: unless ($fname=~/^\/res\//) { return -1; } 1807: return &currentversion(&filelocation('',$fname)); 1808: } 1809: 1810: sub currentversion { 1811: my $fname=shift; 1812: my ($result,$cached)=&is_cached_new('resversion',$fname); 1813: if (defined($cached)) { return $result; } 1814: my $author=$fname; 1815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1816: my ($udom,$uname)=split(/\//,$author); 1817: my $home=homeserver($uname,$udom); 1818: if ($home eq 'no_host') { 1819: return -1; 1820: } 1821: my $answer=reply("currentversion:$fname",$home); 1822: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 1823: return -1; 1824: } 1825: return &do_cache_new('resversion',$fname,$answer,600); 1826: } 1827: 1828: # ----------------------------- Subscribe to a resource, return URL if possible 1829: 1830: sub subscribe { 1831: my $fname=shift; 1832: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; } 1833: $fname=~s/[\n\r]//g; 1834: my $author=$fname; 1835: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1836: my ($udom,$uname)=split(/\//,$author); 1837: my $home=homeserver($uname,$udom); 1838: if ($home eq 'no_host') { 1839: return 'not_found'; 1840: } 1841: my $answer=reply("sub:$fname",$home); 1842: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 1843: $answer.=' by '.$home; 1844: } 1845: return $answer; 1846: } 1847: 1848: # -------------------------------------------------------------- Replicate file 1849: 1850: sub repcopy { 1851: my $filename=shift; 1852: $filename=~s/\/+/\//g; 1853: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; } 1854: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 1855: if ($filename=~m|^/home/httpd/html/userfiles/| or 1856: $filename=~m -^/*(uploaded|editupload)/-) { 1857: return &repcopy_userfile($filename); 1858: } 1859: $filename=~s/[\n\r]//g; 1860: my $transname="$filename.in.transfer"; 1861: # FIXME: this should flock 1862: if ((-e $filename) || (-e $transname)) { return 'ok'; } 1863: my $remoteurl=subscribe($filename); 1864: if ($remoteurl =~ /^con_lost by/) { 1865: &logthis("Subscribe returned $remoteurl: $filename"); 1866: return 'unavailable'; 1867: } elsif ($remoteurl eq 'not_found') { 1868: #&logthis("Subscribe returned not_found: $filename"); 1869: return 'not_found'; 1870: } elsif ($remoteurl =~ /^rejected by/) { 1871: &logthis("Subscribe returned $remoteurl: $filename"); 1872: return 'forbidden'; 1873: } elsif ($remoteurl eq 'directory') { 1874: return 'ok'; 1875: } else { 1876: my $author=$filename; 1877: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1878: my ($udom,$uname)=split(/\//,$author); 1879: my $home=homeserver($uname,$udom); 1880: unless ($home eq $perlvar{'lonHostID'}) { 1881: my @parts=split(/\//,$filename); 1882: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]"; 1883: if ($path ne "$perlvar{'lonDocRoot'}/res") { 1884: &logthis("Malconfiguration for replication: $filename"); 1885: return 'bad_request'; 1886: } 1887: my $count; 1888: for ($count=5;$count<$#parts;$count++) { 1889: $path.="/$parts[$count]"; 1890: if ((-e $path)!=1) { 1891: mkdir($path,0777); 1892: } 1893: } 1894: my $ua=new LWP::UserAgent; 1895: my $request=new HTTP::Request('GET',"$remoteurl"); 1896: my $response=$ua->request($request,$transname); 1897: if ($response->is_error()) { 1898: unlink($transname); 1899: my $message=$response->status_line; 1900: &logthis("WARNING:" 1901: ." LWP get: $message: $filename"); 1902: return 'unavailable'; 1903: } else { 1904: if ($remoteurl!~/\.meta$/) { 1905: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta'); 1906: my $mresponse=$ua->request($mrequest,$filename.'.meta'); 1907: if ($mresponse->is_error()) { 1908: unlink($filename.'.meta'); 1909: &logthis( 1910: "INFO: No metadata: $filename"); 1911: } 1912: } 1913: rename($transname,$filename); 1914: return 'ok'; 1915: } 1916: } 1917: } 1918: } 1919: 1920: # ------------------------------------------------ Get server side include body 1921: sub ssi_body { 1922: my ($filelink,%form)=@_; 1923: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) { 1924: $form{'LONCAPA_INTERNAL_no_discussion'}='true'; 1925: } 1926: my $output=''; 1927: my $response; 1928: if ($filelink=~/^https?\:/) { 1929: ($output,$response)=&externalssi($filelink); 1930: } else { 1931: $filelink .= $filelink=~/\?/ ? '&' : '?'; 1932: $filelink .= 'inhibitmenu=yes'; 1933: ($output,$response)=&ssi($filelink,%form); 1934: } 1935: $output=~s|//(\s*)?\s||gs; 1936: $output=~s/^.*?\<body[^\>]*\>//si; 1937: $output=~s/\<\/body\s*\>.*?$//si; 1938: if (wantarray) { 1939: return ($output, $response); 1940: } else { 1941: return $output; 1942: } 1943: } 1944: 1945: # --------------------------------------------------------- Server Side Include 1946: 1947: sub absolute_url { 1948: my ($host_name) = @_; 1949: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://'); 1950: if ($host_name eq '') { 1951: $host_name = $ENV{'SERVER_NAME'}; 1952: } 1953: return $protocol.$host_name; 1954: } 1955: 1956: # 1957: # Server side include. 1958: # Parameters: 1959: # fn Possibly encrypted resource name/id. 1960: # form Hash that describes how the rendering should be done 1961: # and other things. 1962: # Returns: 1963: # Scalar context: The content of the response. 1964: # Array context: 2 element list of the content and the full response object. 1965: # 1966: sub ssi { 1967: 1968: my ($fn,%form)=@_; 1969: my $ua=new LWP::UserAgent; 1970: my $request; 1971: 1972: $form{'no_update_last_known'}=1; 1973: &Apache::lonenc::check_encrypt(\$fn); 1974: if (%form) { 1975: $request=new HTTP::Request('POST',&absolute_url().$fn); 1976: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form))); 1977: } else { 1978: $request=new HTTP::Request('GET',&absolute_url().$fn); 1979: } 1980: 1981: $request->header(Cookie => $ENV{'HTTP_COOKIE'}); 1982: my $response=$ua->request($request); 1983: 1984: if (wantarray) { 1985: return ($response->content, $response); 1986: } else { 1987: return $response->content; 1988: } 1989: } 1990: 1991: sub externalssi { 1992: my ($url)=@_; 1993: my $ua=new LWP::UserAgent; 1994: my $request=new HTTP::Request('GET',$url); 1995: my $response=$ua->request($request); 1996: if (wantarray) { 1997: return ($response->content, $response); 1998: } else { 1999: return $response->content; 2000: } 2001: } 2002: 2003: # -------------------------------- Allow a /uploaded/ URI to be vouched for 2004: 2005: sub allowuploaded { 2006: my ($srcurl,$url)=@_; 2007: $url=&clutter(&declutter($url)); 2008: my $dir=$url; 2009: $dir=~s/\/[^\/]+$//; 2010: my %httpref=(); 2011: my $httpurl=&hreflocation('',$url); 2012: $httpref{'httpref.'.$httpurl}=$srcurl; 2013: &Apache::lonnet::appenv(\%httpref); 2014: } 2015: 2016: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course 2017: # input: action, courseID, current domain, intended 2018: # path to file, source of file, instruction to parse file for objects, 2019: # ref to hash for embedded objects, 2020: # ref to hash for codebase of java objects. 2021: # 2022: # output: url to file (if action was uploaddoc), 2023: # ok if successful, or diagnostic message otherwise (if action was propagate or copy) 2024: # 2025: # Allows directory structure to be used within lonUsers/../userfiles/ for a 2026: # course. 2027: # 2028: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2029: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in 2030: # course's home server. 2031: # 2032: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will 2033: # be copied from $source (current location) to 2034: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2035: # and will then be copied to 2036: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in 2037: # course's home server. 2038: # 2039: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2040: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to 2041: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2042: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file 2043: # in course's home server. 2044: # 2045: 2046: sub process_coursefile { 2047: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_; 2048: my $fetchresult; 2049: my $home=&homeserver($docuname,$docudom); 2050: if ($action eq 'propagate') { 2051: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2052: $home); 2053: } else { 2054: my $fpath = ''; 2055: my $fname = $file; 2056: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2057: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2058: my $filepath = &build_filepath($fpath); 2059: if ($action eq 'copy') { 2060: if ($source eq '') { 2061: $fetchresult = 'no source file'; 2062: return $fetchresult; 2063: } else { 2064: my $destination = $filepath.'/'.$fname; 2065: rename($source,$destination); 2066: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2067: $home); 2068: } 2069: } elsif ($action eq 'uploaddoc') { 2070: open(my $fh,'>'.$filepath.'/'.$fname); 2071: print $fh $env{'form.'.$source}; 2072: close($fh); 2073: if ($parser eq 'parse') { 2074: my $mm = new File::MMagic; 2075: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname); 2076: if ($mime_type eq 'text/html') { 2077: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase); 2078: unless ($parse_result eq 'ok') { 2079: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result); 2080: } 2081: } 2082: } 2083: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2084: $home); 2085: if ($fetchresult eq 'ok') { 2086: return '/uploaded/'.$fpath.'/'.$fname; 2087: } else { 2088: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2089: ' to host '.$home.': '.$fetchresult); 2090: return '/adm/notfound.html'; 2091: } 2092: } 2093: } 2094: unless ( $fetchresult eq 'ok') { 2095: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2096: ' to host '.$home.': '.$fetchresult); 2097: } 2098: return $fetchresult; 2099: } 2100: 2101: sub build_filepath { 2102: my ($fpath) = @_; 2103: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles'; 2104: unless ($fpath eq '') { 2105: my @parts=split('/',$fpath); 2106: foreach my $part (@parts) { 2107: $filepath.= '/'.$part; 2108: if ((-e $filepath)!=1) { 2109: mkdir($filepath,0777); 2110: } 2111: } 2112: } 2113: return $filepath; 2114: } 2115: 2116: sub store_edited_file { 2117: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_; 2118: my $file = $primary_url; 2119: $file =~ s#^/uploaded/$docudom/$docuname/##; 2120: my $fpath = ''; 2121: my $fname = $file; 2122: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2123: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2124: my $filepath = &build_filepath($fpath); 2125: open(my $fh,'>'.$filepath.'/'.$fname); 2126: print $fh $content; 2127: close($fh); 2128: my $home=&homeserver($docuname,$docudom); 2129: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2130: $home); 2131: if ($$fetchresult eq 'ok') { 2132: return '/uploaded/'.$fpath.'/'.$fname; 2133: } else { 2134: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2135: ' to host '.$home.': '.$$fetchresult); 2136: return '/adm/notfound.html'; 2137: } 2138: } 2139: 2140: sub clean_filename { 2141: my ($fname,$args)=@_; 2142: # Replace Windows backslashes by forward slashes 2143: $fname=~s/\\/\//g; 2144: if (!$args->{'keep_path'}) { 2145: # Get rid of everything but the actual filename 2146: $fname=~s/^.*\/([^\/]+)$/$1/; 2147: } 2148: # Replace spaces by underscores 2149: $fname=~s/\s+/\_/g; 2150: # Replace all other weird characters by nothing 2151: $fname=~s{[^/\w\.\-]}{}g; 2152: # Replace all .\d. sequences with _\d. so they no longer look like version 2153: # numbers 2154: $fname=~s/\.(\d+)(?=\.)/_$1/g; 2155: return $fname; 2156: } 2157: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 2158: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 2159: # image with the same aspect ratio as the original, but with dimensions which do 2160: # not exceed $resizewidth and $resizeheight. 2161: 2162: sub resizeImage { 2163: my ($img_path,$resizewidth,$resizeheight) = @_; 2164: my $ima = Image::Magick->new; 2165: my $resized; 2166: if (-e $img_path) { 2167: $ima->Read($img_path); 2168: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) { 2169: my $width = $ima->Get('width'); 2170: my $height = $ima->Get('height'); 2171: if ($width > $resizewidth) { 2172: my $factor = $width/$resizewidth; 2173: my $newheight = $height/$factor; 2174: $ima->Scale(width=>$resizewidth,height=>$newheight); 2175: $resized = 1; 2176: } 2177: } 2178: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) { 2179: my $width = $ima->Get('width'); 2180: my $height = $ima->Get('height'); 2181: if ($height > $resizeheight) { 2182: my $factor = $height/$resizeheight; 2183: my $newwidth = $width/$factor; 2184: $ima->Scale(width=>$newwidth,height=>$resizeheight); 2185: $resized = 1; 2186: } 2187: } 2188: if ($resized) { 2189: $ima->Write($img_path); 2190: } 2191: } 2192: return; 2193: } 2194: 2195: # --------------- Take an uploaded file and put it into the userfiles directory 2196: # input: $formname - the contents of the file are in $env{"form.$formname"} 2197: # the desired filenam is in $env{"form.$formname.filename"} 2198: # $coursedoc - if true up to the current course 2199: # if false 2200: # $subdir - directory in userfile to store the file into 2201: # $parser - instruction to parse file for objects ($parser = parse) 2202: # $allfiles - reference to hash for embedded objects 2203: # $codebase - reference to hash for codebase of java objects 2204: # $desuname - username for permanent storage of uploaded file 2205: # $dsetudom - domain for permanaent storage of uploaded file 2206: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image 2207: # $thumbheight - height (pixels) of thumbnail to make for uploaded image 2208: # $resizewidth - width (pixels) to which to resize uploaded image 2209: # $resizeheight - height (pixels) to which to resize uploaded image 2210: # 2211: # output: url of file in userspace, or error: <message> 2212: # or /adm/notfound.html if failure to upload occurse 2213: 2214: sub userfileupload { 2215: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname, 2216: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_; 2217: if (!defined($subdir)) { $subdir='unknown'; } 2218: my $fname=$env{'form.'.$formname.'.filename'}; 2219: $fname=&clean_filename($fname); 2220: # See if there is anything left 2221: unless ($fname) { return 'error: no uploaded file'; } 2222: chop($env{'form.'.$formname}); 2223: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently 2224: my $now = time; 2225: my $filepath = 'tmp/helprequests/'.$now; 2226: my @parts=split(/\//,$filepath); 2227: my $fullpath = $perlvar{'lonDaemons'}; 2228: for (my $i=0;$i<@parts;$i++) { 2229: $fullpath .= '/'.$parts[$i]; 2230: if ((-e $fullpath)!=1) { 2231: mkdir($fullpath,0777); 2232: } 2233: } 2234: open(my $fh,'>'.$fullpath.'/'.$fname); 2235: print $fh $env{'form.'.$formname}; 2236: close($fh); 2237: return $fullpath.'/'.$fname; 2238: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently 2239: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}. 2240: '_'.$env{'user.domain'}.'/pending'; 2241: my @parts=split(/\//,$filepath); 2242: my $fullpath = $perlvar{'lonDaemons'}; 2243: for (my $i=0;$i<@parts;$i++) { 2244: $fullpath .= '/'.$parts[$i]; 2245: if ((-e $fullpath)!=1) { 2246: mkdir($fullpath,0777); 2247: } 2248: } 2249: open(my $fh,'>'.$fullpath.'/'.$fname); 2250: print $fh $env{'form.'.$formname}; 2251: close($fh); 2252: return $fullpath.'/'.$fname; 2253: } 2254: if ($subdir eq 'scantron') { 2255: $fname = 'scantron_orig_'.$fname; 2256: } else { 2257: # Create the directory if not present 2258: $fname="$subdir/$fname"; 2259: } 2260: if ($coursedoc) { 2261: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2262: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2263: if ($env{'form.folder'} =~ m/^(default|supplemental)/) { 2264: return &finishuserfileupload($docuname,$docudom, 2265: $formname,$fname,$parser,$allfiles, 2266: $codebase,$thumbwidth,$thumbheight, 2267: $resizewidth,$resizeheight); 2268: } else { 2269: $fname=$env{'form.folder'}.'/'.$fname; 2270: return &process_coursefile('uploaddoc',$docuname,$docudom, 2271: $fname,$formname,$parser, 2272: $allfiles,$codebase); 2273: } 2274: } elsif (defined($destuname)) { 2275: my $docuname=$destuname; 2276: my $docudom=$destudom; 2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2278: $parser,$allfiles,$codebase, 2279: $thumbwidth,$thumbheight, 2280: $resizewidth,$resizeheight); 2281: 2282: } else { 2283: my $docuname=$env{'user.name'}; 2284: my $docudom=$env{'user.domain'}; 2285: if (exists($env{'form.group'})) { 2286: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2287: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2288: } 2289: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2290: $parser,$allfiles,$codebase, 2291: $thumbwidth,$thumbheight, 2292: $resizewidth,$resizeheight); 2293: } 2294: } 2295: 2296: sub finishuserfileupload { 2297: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase, 2298: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_; 2299: my $path=$docudom.'/'.$docuname.'/'; 2300: my $filepath=$perlvar{'lonDocRoot'}; 2301: 2302: my ($fnamepath,$file,$fetchthumb); 2303: $file=$fname; 2304: if ($fname=~m|/|) { 2305: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|); 2306: $path.=$fnamepath.'/'; 2307: } 2308: my @parts=split(/\//,$filepath.'/userfiles/'.$path); 2309: my $count; 2310: for ($count=4;$count<=$#parts;$count++) { 2311: $filepath.="/$parts[$count]"; 2312: if ((-e $filepath)!=1) { 2313: mkdir($filepath,0777); 2314: } 2315: } 2316: 2317: # Save the file 2318: { 2319: if (!open(FH,'>'.$filepath.'/'.$file)) { 2320: &logthis('Failed to create '.$filepath.'/'.$file); 2321: print STDERR ('Failed to create '.$filepath.'/'.$file."\n"); 2322: return '/adm/notfound.html'; 2323: } 2324: if (!print FH ($env{'form.'.$formname})) { 2325: &logthis('Failed to write to '.$filepath.'/'.$file); 2326: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n"); 2327: return '/adm/notfound.html'; 2328: } 2329: close(FH); 2330: if ($resizewidth && $resizeheight) { 2331: my $mm = new File::MMagic; 2332: my $mime_type = $mm->checktype_filename($filepath.'/'.$file); 2333: if ($mime_type =~ m{^image/}) { 2334: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight); 2335: } 2336: } 2337: } 2338: if ($parser eq 'parse') { 2339: my $mm = new File::MMagic; 2340: my $mime_type = $mm->checktype_filename($filepath.'/'.$file); 2341: if ($mime_type eq 'text/html') { 2342: my $parse_result = &extract_embedded_items($filepath.'/'.$file, 2343: $allfiles,$codebase); 2344: unless ($parse_result eq 'ok') { 2345: &logthis('Failed to parse '.$filepath.$file. 2346: ' for embedded media: '.$parse_result); 2347: } 2348: } 2349: } 2350: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) { 2351: my $input = $filepath.'/'.$file; 2352: my $output = $filepath.'/'.'tn-'.$file; 2353: my $thumbsize = $thumbwidth.'x'.$thumbheight; 2354: system("convert -sample $thumbsize $input $output"); 2355: if (-e $filepath.'/'.'tn-'.$file) { 2356: $fetchthumb = 1; 2357: } 2358: } 2359: 2360: # Notify homeserver to grep it 2361: # 2362: my $docuhome=&homeserver($docuname,$docudom); 2363: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome); 2364: if ($fetchresult eq 'ok') { 2365: if ($fetchthumb) { 2366: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome); 2367: if ($thumbresult ne 'ok') { 2368: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '. 2369: $docuhome.': '.$thumbresult); 2370: } 2371: } 2372: # 2373: # Return the URL to it 2374: return '/uploaded/'.$path.$file; 2375: } else { 2376: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome. 2377: ': '.$fetchresult); 2378: return '/adm/notfound.html'; 2379: } 2380: } 2381: 2382: sub extract_embedded_items { 2383: my ($fullpath,$allfiles,$codebase,$content) = @_; 2384: my @state = (); 2385: my %javafiles = ( 2386: codebase => '', 2387: code => '', 2388: archive => '' 2389: ); 2390: my %mediafiles = ( 2391: src => '', 2392: movie => '', 2393: ); 2394: my $p; 2395: if ($content) { 2396: $p = HTML::LCParser->new($content); 2397: } else { 2398: $p = HTML::LCParser->new($fullpath); 2399: } 2400: while (my $t=$p->get_token()) { 2401: if ($t->[0] eq 'S') { 2402: my ($tagname, $attr) = ($t->[1],$t->[2]); 2403: push(@state, $tagname); 2404: if (lc($tagname) eq 'allow') { 2405: &add_filetype($allfiles,$attr->{'src'},'src'); 2406: } 2407: if (lc($tagname) eq 'img') { 2408: &add_filetype($allfiles,$attr->{'src'},'src'); 2409: } 2410: if (lc($tagname) eq 'a') { 2411: &add_filetype($allfiles,$attr->{'href'},'href'); 2412: } 2413: if (lc($tagname) eq 'script') { 2414: if ($attr->{'archive'} =~ /\.jar$/i) { 2415: &add_filetype($allfiles,$attr->{'archive'},'archive'); 2416: } else { 2417: &add_filetype($allfiles,$attr->{'src'},'src'); 2418: } 2419: } 2420: if (lc($tagname) eq 'link') { 2421: if (lc($attr->{'rel'}) eq 'stylesheet') { 2422: &add_filetype($allfiles,$attr->{'href'},'href'); 2423: } 2424: } 2425: if (lc($tagname) eq 'object' || 2426: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) { 2427: foreach my $item (keys(%javafiles)) { 2428: $javafiles{$item} = ''; 2429: } 2430: } 2431: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') { 2432: my $name = lc($attr->{'name'}); 2433: foreach my $item (keys(%javafiles)) { 2434: if ($name eq $item) { 2435: $javafiles{$item} = $attr->{'value'}; 2436: last; 2437: } 2438: } 2439: foreach my $item (keys(%mediafiles)) { 2440: if ($name eq $item) { 2441: &add_filetype($allfiles, $attr->{'value'}, 'value'); 2442: last; 2443: } 2444: } 2445: } 2446: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') { 2447: foreach my $item (keys(%javafiles)) { 2448: if ($attr->{$item}) { 2449: $javafiles{$item} = $attr->{$item}; 2450: last; 2451: } 2452: } 2453: foreach my $item (keys(%mediafiles)) { 2454: if ($attr->{$item}) { 2455: &add_filetype($allfiles,$attr->{$item},$item); 2456: last; 2457: } 2458: } 2459: } 2460: } elsif ($t->[0] eq 'E') { 2461: my ($tagname) = ($t->[1]); 2462: if ($javafiles{'codebase'} ne '') { 2463: $javafiles{'codebase'} .= '/'; 2464: } 2465: if (lc($tagname) eq 'applet' || 2466: lc($tagname) eq 'object' || 2467: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object') 2468: ) { 2469: foreach my $item (keys(%javafiles)) { 2470: if ($item ne 'codebase' && $javafiles{$item} ne '') { 2471: my $file=$javafiles{'codebase'}.$javafiles{$item}; 2472: &add_filetype($allfiles,$file,$item); 2473: } 2474: } 2475: } 2476: pop @state; 2477: } 2478: } 2479: return 'ok'; 2480: } 2481: 2482: sub add_filetype { 2483: my ($allfiles,$file,$type)=@_; 2484: if (exists($allfiles->{$file})) { 2485: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) { 2486: push(@{$allfiles->{$file}}, &escape($type)); 2487: } 2488: } else { 2489: @{$allfiles->{$file}} = (&escape($type)); 2490: } 2491: } 2492: 2493: sub removeuploadedurl { 2494: my ($url)=@_; 2495: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5); 2496: return &removeuserfile($uname,$udom,$fname); 2497: } 2498: 2499: sub removeuserfile { 2500: my ($docuname,$docudom,$fname)=@_; 2501: my $home=&homeserver($docuname,$docudom); 2502: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home); 2503: if ($result eq 'ok') { 2504: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) { 2505: my $metafile = $fname.'.meta'; 2506: my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 2507: my $url = "/uploaded/$docudom/$docuname/$fname"; 2508: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2509: my $sqlresult = 2510: &update_portfolio_table($docuname,$docudom,$file, 2511: 'portfolio_metadata',$group, 2512: 'delete'); 2513: } 2514: } 2515: return $result; 2516: } 2517: 2518: sub mkdiruserfile { 2519: my ($docuname,$docudom,$dir)=@_; 2520: my $home=&homeserver($docuname,$docudom); 2521: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home); 2522: } 2523: 2524: sub renameuserfile { 2525: my ($docuname,$docudom,$old,$new)=@_; 2526: my $home=&homeserver($docuname,$docudom); 2527: my $result = &reply("renameuserfile:$docudom:$docuname:". 2528: &escape("$old").':'.&escape("$new"),$home); 2529: if ($result eq 'ok') { 2530: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) { 2531: my $oldmeta = $old.'.meta'; 2532: my $newmeta = $new.'.meta'; 2533: my $metaresult = 2534: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta); 2535: my $url = "/uploaded/$docudom/$docuname/$old"; 2536: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2537: my $sqlresult = 2538: &update_portfolio_table($docuname,$docudom,$file, 2539: 'portfolio_metadata',$group, 2540: 'delete'); 2541: } 2542: } 2543: return $result; 2544: } 2545: 2546: # ------------------------------------------------------------------------- Log 2547: 2548: sub log { 2549: my ($dom,$nam,$hom,$what)=@_; 2550: return critical("log:$dom:$nam:$what",$hom); 2551: } 2552: 2553: # ------------------------------------------------------------------ Course Log 2554: # 2555: # This routine flushes several buffers of non-mission-critical nature 2556: # 2557: 2558: sub flushcourselogs { 2559: &logthis('Flushing log buffers'); 2560: # 2561: # course logs 2562: # This is a log of all transactions in a course, which can be used 2563: # for data mining purposes 2564: # 2565: # It also collects the courseid database, which lists last transaction 2566: # times and course titles for all courseids 2567: # 2568: my %courseidbuffer=(); 2569: foreach my $crsid (keys(%courselogs)) { 2570: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'. 2571: &escape($courselogs{$crsid}), 2572: $coursehombuf{$crsid}) eq 'ok') { 2573: delete $courselogs{$crsid}; 2574: } else { 2575: &logthis('Failed to flush log buffer for '.$crsid); 2576: if (length($courselogs{$crsid})>40000) { 2577: &logthis("WARNING: Buffer for ".$crsid. 2578: " exceeded maximum size, deleting."); 2579: delete $courselogs{$crsid}; 2580: } 2581: } 2582: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = { 2583: 'description' => $coursedescrbuf{$crsid}, 2584: 'inst_code' => $courseinstcodebuf{$crsid}, 2585: 'type' => $coursetypebuf{$crsid}, 2586: 'owner' => $courseownerbuf{$crsid}, 2587: }; 2588: } 2589: # 2590: # Write course id database (reverse lookup) to homeserver of courses 2591: # Is used in pickcourse 2592: # 2593: foreach my $crs_home (keys(%courseidbuffer)) { 2594: my $response = &courseidput(&host_domain($crs_home), 2595: $courseidbuffer{$crs_home}, 2596: $crs_home,'timeonly'); 2597: } 2598: # 2599: # File accesses 2600: # Writes to the dynamic metadata of resources to get hit counts, etc. 2601: # 2602: foreach my $entry (keys(%accesshash)) { 2603: if ($entry =~ /___count$/) { 2604: my ($dom,$name); 2605: ($dom,$name,undef)= 2606: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$}); 2607: if (! defined($dom) || $dom eq '' || 2608: ! defined($name) || $name eq '') { 2609: my $cid = $env{'request.course.id'}; 2610: $dom = $env{'request.'.$cid.'.domain'}; 2611: $name = $env{'request.'.$cid.'.num'}; 2612: } 2613: my $value = $accesshash{$entry}; 2614: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/); 2615: my %temphash=($url => $value); 2616: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name); 2617: if ($result eq 'ok') { 2618: delete $accesshash{$entry}; 2619: } elsif ($result eq 'unknown_cmd') { 2620: # Target server has old code running on it. 2621: my %temphash=($entry => $value); 2622: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2623: delete $accesshash{$entry}; 2624: } 2625: } 2626: } else { 2627: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$}); 2628: my %temphash=($entry => $accesshash{$entry}); 2629: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2630: delete $accesshash{$entry}; 2631: } 2632: } 2633: } 2634: # 2635: # Roles 2636: # Reverse lookup of user roles for course faculty/staff and co-authorship 2637: # 2638: foreach my $entry (keys(%userrolehash)) { 2639: my ($role,$uname,$udom,$runame,$rudom,$rsec)= 2640: split(/\:/,$entry); 2641: if (&Apache::lonnet::put('nohist_userroles', 2642: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} }, 2643: $rudom,$runame) eq 'ok') { 2644: delete $userrolehash{$entry}; 2645: } 2646: } 2647: # 2648: # Reverse lookup of domain roles (dc, ad, li, sc, au) 2649: # 2650: my %domrolebuffer = (); 2651: foreach my $entry (keys(%domainrolehash)) { 2652: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry); 2653: if ($domrolebuffer{$rudom}) { 2654: $domrolebuffer{$rudom}.='&'.&escape($entry). 2655: '='.&escape($domainrolehash{$entry}); 2656: } else { 2657: $domrolebuffer{$rudom}.=&escape($entry). 2658: '='.&escape($domainrolehash{$entry}); 2659: } 2660: delete $domainrolehash{$entry}; 2661: } 2662: foreach my $dom (keys(%domrolebuffer)) { 2663: my %servers = &get_servers($dom,'library'); 2664: foreach my $tryserver (keys(%servers)) { 2665: unless (&reply('domroleput:'.$dom.':'. 2666: $domrolebuffer{$dom},$tryserver) eq 'ok') { 2667: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver); 2668: } 2669: } 2670: } 2671: $dumpcount++; 2672: } 2673: 2674: sub courselog { 2675: my $what=shift; 2676: $what=time.':'.$what; 2677: unless ($env{'request.course.id'}) { return ''; } 2678: $coursedombuf{$env{'request.course.id'}}= 2679: $env{'course.'.$env{'request.course.id'}.'.domain'}; 2680: $coursenumbuf{$env{'request.course.id'}}= 2681: $env{'course.'.$env{'request.course.id'}.'.num'}; 2682: $coursehombuf{$env{'request.course.id'}}= 2683: $env{'course.'.$env{'request.course.id'}.'.home'}; 2684: $coursedescrbuf{$env{'request.course.id'}}= 2685: $env{'course.'.$env{'request.course.id'}.'.description'}; 2686: $courseinstcodebuf{$env{'request.course.id'}}= 2687: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}; 2688: $courseownerbuf{$env{'request.course.id'}}= 2689: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'}; 2690: $coursetypebuf{$env{'request.course.id'}}= 2691: $env{'course.'.$env{'request.course.id'}.'.type'}; 2692: if (defined $courselogs{$env{'request.course.id'}}) { 2693: $courselogs{$env{'request.course.id'}}.='&'.$what; 2694: } else { 2695: $courselogs{$env{'request.course.id'}}.=$what; 2696: } 2697: if (length($courselogs{$env{'request.course.id'}})>4048) { 2698: &flushcourselogs(); 2699: } 2700: } 2701: 2702: sub courseacclog { 2703: my $fnsymb=shift; 2704: unless ($env{'request.course.id'}) { return ''; } 2705: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'}; 2706: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) { 2707: $what.=':POST'; 2708: # FIXME: Probably ought to escape things.... 2709: foreach my $key (keys(%env)) { 2710: if ($key=~/^form\.(.*)/) { 2711: my $formitem = $1; 2712: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) { 2713: $what.=':'.$formitem.'='.$env{$key}; 2714: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) { 2715: $what.=':'.$formitem.'='.$env{$key}; 2716: } 2717: } 2718: } 2719: } elsif ($fnsymb =~ m:^/adm/searchcat:) { 2720: # FIXME: We should not be depending on a form parameter that someone 2721: # editing lonsearchcat.pm might change in the future. 2722: if ($env{'form.phase'} eq 'course_search') { 2723: $what.= ':POST'; 2724: # FIXME: Probably ought to escape things.... 2725: foreach my $element ('courseexp','crsfulltext','crsrelated', 2726: 'crsdiscuss') { 2727: $what.=':'.$element.'='.$env{'form.'.$element}; 2728: } 2729: } 2730: } 2731: &courselog($what); 2732: } 2733: 2734: sub countacc { 2735: my $url=&declutter(shift); 2736: return if (! defined($url) || $url eq ''); 2737: unless ($env{'request.course.id'}) { return ''; } 2738: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1; 2739: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count'; 2740: $accesshash{$key}++; 2741: } 2742: 2743: sub linklog { 2744: my ($from,$to)=@_; 2745: $from=&declutter($from); 2746: $to=&declutter($to); 2747: $accesshash{$from.'___'.$to.'___comefrom'}=1; 2748: $accesshash{$to.'___'.$from.'___goto'}=1; 2749: } 2750: 2751: sub userrolelog { 2752: my ($trole,$username,$domain,$area,$tstart,$tend)=@_; 2753: if (($trole=~/^ca/) || ($trole=~/^aa/) || 2754: ($trole=~/^in/) || ($trole=~/^cc/) || 2755: ($trole=~/^ep/) || ($trole=~/^cr/) || 2756: ($trole=~/^ta/) || ($trole=~/^co/)) { 2757: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 2758: $userrolehash 2759: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 2760: =$tend.':'.$tstart; 2761: } 2762: if (($env{'request.role'} =~ /dc\./) && 2763: (($trole=~/^au/) || ($trole=~/^in/) || 2764: ($trole=~/^cc/) || ($trole=~/^ep/) || 2765: ($trole=~/^cr/) || ($trole=~/^ta/) || 2766: ($trole=~/^co/))) { 2767: $userrolehash 2768: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'} 2769: =$tend.':'.$tstart; 2770: } 2771: if (($trole=~/^dc/) || ($trole=~/^ad/) || 2772: ($trole=~/^li/) || ($trole=~/^li/) || 2773: ($trole=~/^au/) || ($trole=~/^dg/) || 2774: ($trole=~/^sc/)) { 2775: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 2776: $domainrolehash 2777: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 2778: = $tend.':'.$tstart; 2779: } 2780: } 2781: 2782: sub courserolelog { 2783: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_; 2784: if (($trole eq 'cc') || ($trole eq 'in') || 2785: ($trole eq 'ep') || ($trole eq 'ad') || 2786: ($trole eq 'ta') || ($trole eq 'st') || 2787: ($trole=~/^cr/) || ($trole eq 'gr') || 2788: ($trole eq 'co')) { 2789: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) { 2790: my $cdom = $1; 2791: my $cnum = $2; 2792: my $sec = $3; 2793: my $namespace = 'rolelog'; 2794: my %storehash = ( 2795: role => $trole, 2796: start => $tstart, 2797: end => $tend, 2798: selfenroll => $selfenroll, 2799: context => $context, 2800: ); 2801: if ($trole eq 'gr') { 2802: $namespace = 'groupslog'; 2803: $storehash{'group'} = $sec; 2804: } else { 2805: $storehash{'section'} = $sec; 2806: } 2807: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom); 2808: if (($trole ne 'st') || ($sec ne '')) { 2809: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum); 2810: } 2811: } 2812: } 2813: return; 2814: } 2815: 2816: sub get_course_adv_roles { 2817: my ($cid,$codes) = @_; 2818: $cid=$env{'request.course.id'} unless (defined($cid)); 2819: my %coursehash=&coursedescription($cid); 2820: my $crstype = &Apache::loncommon::course_type($cid); 2821: my %nothide=(); 2822: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 2823: if ($user !~ /:/) { 2824: $nothide{join(':',split(/[\@]/,$user))}=1; 2825: } else { 2826: $nothide{$user}=1; 2827: } 2828: } 2829: my %returnhash=(); 2830: my %dumphash= 2831: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'}); 2832: my $now=time; 2833: my %privileged; 2834: foreach my $entry (keys(%dumphash)) { 2835: my ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 2836: if (($tstart) && ($tstart<0)) { next; } 2837: if (($tend) && ($tend<$now)) { next; } 2838: if (($tstart) && ($now<$tstart)) { next; } 2839: my ($role,$username,$domain,$section)=split(/\:/,$entry); 2840: if ($username eq '' || $domain eq '') { next; } 2841: unless (ref($privileged{$domain}) eq 'HASH') { 2842: my %dompersonnel = 2843: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 2844: $privileged{$domain} = {}; 2845: foreach my $server (keys(%dompersonnel)) { 2846: if (ref($dompersonnel{$server}) eq 'HASH') { 2847: foreach my $user (keys(%{$dompersonnel{$server}})) { 2848: my ($trole,$uname,$udom) = split(/:/,$user); 2849: $privileged{$udom}{$uname} = 1; 2850: } 2851: } 2852: } 2853: } 2854: if ((exists($privileged{$domain}{$username})) && 2855: (!$nothide{$username.':'.$domain})) { next; } 2856: if ($role eq 'cr') { next; } 2857: if ($codes) { 2858: if ($section) { $role .= ':'.$section; } 2859: if ($returnhash{$role}) { 2860: $returnhash{$role}.=','.$username.':'.$domain; 2861: } else { 2862: $returnhash{$role}=$username.':'.$domain; 2863: } 2864: } else { 2865: my $key=&plaintext($role,$crstype); 2866: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; } 2867: if ($returnhash{$key}) { 2868: $returnhash{$key}.=','.$username.':'.$domain; 2869: } else { 2870: $returnhash{$key}=$username.':'.$domain; 2871: } 2872: } 2873: } 2874: return %returnhash; 2875: } 2876: 2877: sub get_my_roles { 2878: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_; 2879: unless (defined($uname)) { $uname=$env{'user.name'}; } 2880: unless (defined($udom)) { $udom=$env{'user.domain'}; } 2881: my (%dumphash,%nothide); 2882: if ($context eq 'userroles') { 2883: %dumphash = &dump('roles',$udom,$uname); 2884: } else { 2885: %dumphash= 2886: &dump('nohist_userroles',$udom,$uname); 2887: if ($hidepriv) { 2888: my %coursehash=&coursedescription($udom.'_'.$uname); 2889: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 2890: if ($user !~ /:/) { 2891: $nothide{join(':',split(/[\@]/,$user))} = 1; 2892: } else { 2893: $nothide{$user} = 1; 2894: } 2895: } 2896: } 2897: } 2898: my %returnhash=(); 2899: my $now=time; 2900: my %privileged; 2901: foreach my $entry (keys(%dumphash)) { 2902: my ($role,$tend,$tstart); 2903: if ($context eq 'userroles') { 2904: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry}); 2905: } else { 2906: ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 2907: } 2908: if (($tstart) && ($tstart<0)) { next; } 2909: my $status = 'active'; 2910: if (($tend) && ($tend<=$now)) { 2911: $status = 'previous'; 2912: } 2913: if (($tstart) && ($now<$tstart)) { 2914: $status = 'future'; 2915: } 2916: if (ref($types) eq 'ARRAY') { 2917: if (!grep(/^\Q$status\E$/,@{$types})) { 2918: next; 2919: } 2920: } else { 2921: if ($status ne 'active') { 2922: next; 2923: } 2924: } 2925: my ($rolecode,$username,$domain,$section,$area); 2926: if ($context eq 'userroles') { 2927: ($area,$rolecode) = split(/_/,$entry); 2928: (undef,$domain,$username,$section) = split(/\//,$area); 2929: } else { 2930: ($role,$username,$domain,$section) = split(/\:/,$entry); 2931: } 2932: if (ref($roledoms) eq 'ARRAY') { 2933: if (!grep(/^\Q$domain\E$/,@{$roledoms})) { 2934: next; 2935: } 2936: } 2937: if (ref($roles) eq 'ARRAY') { 2938: if (!grep(/^\Q$role\E$/,@{$roles})) { 2939: if ($role =~ /^cr\//) { 2940: if (!grep(/^cr$/,@{$roles})) { 2941: next; 2942: } 2943: } else { 2944: next; 2945: } 2946: } 2947: } 2948: if ($hidepriv) { 2949: if ($context eq 'userroles') { 2950: if ((&privileged($username,$domain)) && 2951: (!$nothide{$username.':'.$domain})) { 2952: next; 2953: } 2954: } else { 2955: unless (ref($privileged{$domain}) eq 'HASH') { 2956: my %dompersonnel = 2957: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 2958: $privileged{$domain} = {}; 2959: if (keys(%dompersonnel)) { 2960: foreach my $server (keys(%dompersonnel)) { 2961: if (ref($dompersonnel{$server}) eq 'HASH') { 2962: foreach my $user (keys(%{$dompersonnel{$server}})) { 2963: my ($trole,$uname,$udom) = split(/:/,$user); 2964: $privileged{$udom}{$uname} = $trole; 2965: } 2966: } 2967: } 2968: } 2969: } 2970: if (exists($privileged{$domain}{$username})) { 2971: if (!$nothide{$username.':'.$domain}) { 2972: next; 2973: } 2974: } 2975: } 2976: } 2977: if ($withsec) { 2978: $returnhash{$username.':'.$domain.':'.$role.':'.$section} = 2979: $tstart.':'.$tend; 2980: } else { 2981: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend; 2982: } 2983: } 2984: return %returnhash; 2985: } 2986: 2987: # ----------------------------------------------------- Frontpage Announcements 2988: # 2989: # 2990: 2991: sub postannounce { 2992: my ($server,$text)=@_; 2993: unless (&allowed('psa',&host_domain($server))) { return 'refused'; } 2994: unless ($text=~/\w/) { $text=''; } 2995: return &reply('setannounce:'.&escape($text),$server); 2996: } 2997: 2998: sub getannounce { 2999: 3000: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) { 3001: my $announcement=''; 3002: while (my $line = <$fh>) { $announcement .= $line; } 3003: close($fh); 3004: if ($announcement=~/\w/) { 3005: return 3006: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'. 3007: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 3008: } else { 3009: return ''; 3010: } 3011: } else { 3012: return ''; 3013: } 3014: } 3015: 3016: # ---------------------------------------------------------- Course ID routines 3017: # Deal with domain's nohist_courseid.db files 3018: # 3019: 3020: sub courseidput { 3021: my ($domain,$storehash,$coursehome,$caller) = @_; 3022: my $outcome; 3023: if ($caller eq 'timeonly') { 3024: my $cids = ''; 3025: foreach my $item (keys(%$storehash)) { 3026: $cids.=&escape($item).'&'; 3027: } 3028: $cids=~s/\&$//; 3029: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids, 3030: $coursehome); 3031: } else { 3032: my $items = ''; 3033: foreach my $item (keys(%$storehash)) { 3034: $items.= &escape($item).'='. 3035: &freeze_escape($$storehash{$item}).'&'; 3036: } 3037: $items=~s/\&$//; 3038: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items, 3039: $coursehome); 3040: } 3041: if ($outcome eq 'unknown_cmd') { 3042: my $what; 3043: foreach my $cid (keys(%$storehash)) { 3044: $what .= &escape($cid).'='; 3045: foreach my $item ('description','inst_code','owner','type') { 3046: $what .= &escape($storehash->{$cid}{$item}).':'; 3047: } 3048: $what =~ s/\:$/&/; 3049: } 3050: $what =~ s/\&$//; 3051: return &reply('courseidput:'.$domain.':'.$what,$coursehome); 3052: } else { 3053: return $outcome; 3054: } 3055: } 3056: 3057: sub courseiddump { 3058: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter, 3059: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok, 3060: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone, 3061: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_; 3062: my $as_hash = 1; 3063: my %returnhash; 3064: if (!$domfilter) { $domfilter=''; } 3065: my %libserv = &all_library(); 3066: foreach my $tryserver (keys(%libserv)) { 3067: if ( ( $hostidflag == 1 3068: && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 3069: || (!defined($hostidflag)) ) { 3070: 3071: if (($domfilter eq '') || 3072: (&host_domain($tryserver) eq $domfilter)) { 3073: my $rep = 3074: &reply('courseiddump:'.&host_domain($tryserver).':'. 3075: $sincefilter.':'.&escape($descfilter).':'. 3076: &escape($instcodefilter).':'.&escape($ownerfilter). 3077: ':'.&escape($coursefilter).':'.&escape($typefilter). 3078: ':'.&escape($regexp_ok).':'.$as_hash.':'. 3079: &escape($selfenrollonly).':'.&escape($catfilter).':'. 3080: $showhidden.':'.$caller.':'.&escape($cloner).':'. 3081: &escape($cc_clone).':'.$cloneonly.':'. 3082: &escape($createdbefore).':'.&escape($createdafter).':'. 3083: &escape($creationcontext),$tryserver); 3084: my @pairs=split(/\&/,$rep); 3085: foreach my $item (@pairs) { 3086: my ($key,$value)=split(/\=/,$item,2); 3087: $key = &unescape($key); 3088: next if ($key =~ /^error: 2 /); 3089: my $result = &thaw_unescape($value); 3090: if (ref($result) eq 'HASH') { 3091: $returnhash{$key}=$result; 3092: } else { 3093: my @responses = split(/:/,$value); 3094: my @items = ('description','inst_code','owner','type'); 3095: for (my $i=0; $i<@responses; $i++) { 3096: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]); 3097: } 3098: } 3099: } 3100: } 3101: } 3102: } 3103: return %returnhash; 3104: } 3105: 3106: # ---------------------------------------------------------- DC e-mail 3107: 3108: sub dcmailput { 3109: my ($domain,$msgid,$message,$server)=@_; 3110: my $status = &Apache::lonnet::critical( 3111: 'dcmailput:'.$domain.':'.&escape($msgid).'='. 3112: &escape($message),$server); 3113: return $status; 3114: } 3115: 3116: sub dcmaildump { 3117: my ($dom,$startdate,$enddate,$senders) = @_; 3118: my %returnhash=(); 3119: 3120: if (defined(&domain($dom,'primary'))) { 3121: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'. 3122: &escape($enddate).':'; 3123: my @esc_senders=map { &escape($_)} @$senders; 3124: $cmd.=&escape(join('&',@esc_senders)); 3125: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) { 3126: my ($key,$value) = split(/\=/,$line,2); 3127: if (($key) && ($value)) { 3128: $returnhash{&unescape($key)} = &unescape($value); 3129: } 3130: } 3131: } 3132: return %returnhash; 3133: } 3134: # ---------------------------------------------------------- Domain roles 3135: 3136: sub get_domain_roles { 3137: my ($dom,$roles,$startdate,$enddate)=@_; 3138: if ((!defined($startdate)) || ($startdate eq '')) { 3139: $startdate = '.'; 3140: } 3141: if ((!defined($enddate)) || ($enddate eq '')) { 3142: $enddate = '.'; 3143: } 3144: my $rolelist; 3145: if (ref($roles) eq 'ARRAY') { 3146: $rolelist = join(':',@{$roles}); 3147: } 3148: my %personnel = (); 3149: 3150: my %servers = &get_servers($dom,'library'); 3151: foreach my $tryserver (keys(%servers)) { 3152: %{$personnel{$tryserver}}=(); 3153: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'. 3154: &escape($startdate).':'. 3155: &escape($enddate).':'. 3156: &escape($rolelist), $tryserver))) { 3157: my ($key,$value) = split(/\=/,$line,2); 3158: if (($key) && ($value)) { 3159: $personnel{$tryserver}{&unescape($key)} = &unescape($value); 3160: } 3161: } 3162: } 3163: return %personnel; 3164: } 3165: 3166: # ----------------------------------------------------------- Check out an item 3167: 3168: sub get_first_access { 3169: my ($type,$argsymb)=@_; 3170: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3171: if ($argsymb) { $symb=$argsymb; } 3172: my ($map,$id,$res)=&decode_symb($symb); 3173: if ($type eq 'course') { 3174: $res='course'; 3175: } elsif ($type eq 'map') { 3176: $res=&symbread($map); 3177: } else { 3178: $res=$symb; 3179: } 3180: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname); 3181: return $times{"$courseid\0$res"}; 3182: } 3183: 3184: sub set_first_access { 3185: my ($type)=@_; 3186: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3187: my ($map,$id,$res)=&decode_symb($symb); 3188: if ($type eq 'course') { 3189: $res='course'; 3190: } elsif ($type eq 'map') { 3191: $res=&symbread($map); 3192: } else { 3193: $res=$symb; 3194: } 3195: my $firstaccess=&get_first_access($type,$symb); 3196: if (!$firstaccess) { 3197: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname); 3198: } 3199: return 'already_set'; 3200: } 3201: 3202: sub checkout { 3203: my ($symb,$tuname,$tudom,$tcrsid)=@_; 3204: my $now=time; 3205: my $lonhost=$perlvar{'lonHostID'}; 3206: my $infostr=&escape( 3207: 'CHECKOUTTOKEN&'. 3208: $tuname.'&'. 3209: $tudom.'&'. 3210: $tcrsid.'&'. 3211: $symb.'&'. 3212: $now.'&'.$ENV{'REMOTE_ADDR'}); 3213: my $token=&reply('tmpput:'.$infostr,$lonhost); 3214: if ($token=~/^error\:/) { 3215: &logthis("WARNING: ". 3216: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb. 3217: ""); 3218: return ''; 3219: } 3220: 3221: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/; 3222: $token=~tr/a-z/A-Z/; 3223: 3224: my %infohash=('resource.0.outtoken' => $token, 3225: 'resource.0.checkouttime' => $now, 3226: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'}); 3227: 3228: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') { 3229: return ''; 3230: } else { 3231: &logthis("WARNING: ". 3232: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb. 3233: ""); 3234: } 3235: 3236: if (&log($tudom,$tuname,&homeserver($tuname,$tudom), 3237: &escape('Checkout '.$infostr.' - '. 3238: $token)) ne 'ok') { 3239: return ''; 3240: } else { 3241: &logthis("WARNING: ". 3242: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb. 3243: ""); 3244: } 3245: return $token; 3246: } 3247: 3248: # ------------------------------------------------------------ Check in an item 3249: 3250: sub checkin { 3251: my $token=shift; 3252: my $now=time; 3253: my ($ta,$tb,$lonhost)=split(/\*/,$token); 3254: $lonhost=~tr/A-Z/a-z/; 3255: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb; 3256: $dtoken=~s/\W/\_/g; 3257: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)= 3258: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost))); 3259: 3260: unless (($tuname) && ($tudom)) { 3261: &logthis('Check in '.$token.' ('.$dtoken.') failed'); 3262: return ''; 3263: } 3264: 3265: unless (&allowed('mgr',$tcrsid)) { 3266: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '. 3267: $env{'user.name'}.' - '.$env{'user.domain'}); 3268: return ''; 3269: } 3270: 3271: my %infohash=('resource.0.intoken' => $token, 3272: 'resource.0.checkintime' => $now, 3273: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'}); 3274: 3275: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') { 3276: return ''; 3277: } 3278: 3279: if (&log($tudom,$tuname,&homeserver($tuname,$tudom), 3280: &escape('Checkin - '.$token)) ne 'ok') { 3281: return ''; 3282: } 3283: 3284: return ($symb,$tuname,$tudom,$tcrsid); 3285: } 3286: 3287: # --------------------------------------------- Set Expire Date for Spreadsheet 3288: 3289: sub expirespread { 3290: my ($uname,$udom,$stype,$usymb)=@_; 3291: my $cid=$env{'request.course.id'}; 3292: if ($cid) { 3293: my $now=time; 3294: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb; 3295: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'. 3296: $env{'course.'.$cid.'.num'}. 3297: ':nohist_expirationdates:'. 3298: &escape($key).'='.$now, 3299: $env{'course.'.$cid.'.home'}) 3300: } 3301: return 'ok'; 3302: } 3303: 3304: # ----------------------------------------------------- Devalidate Spreadsheets 3305: 3306: sub devalidate { 3307: my ($symb,$uname,$udom)=@_; 3308: my $cid=$env{'request.course.id'}; 3309: if ($cid) { 3310: # delete the stored spreadsheets for 3311: # - the student level sheet of this user in course's homespace 3312: # - the assessment level sheet for this resource 3313: # for this user in user's homespace 3314: # - current conditional state info 3315: my $key=$uname.':'.$udom.':'; 3316: my $status= 3317: &del('nohist_calculatedsheets', 3318: [$key.'studentcalc:'], 3319: $env{'course.'.$cid.'.domain'}, 3320: $env{'course.'.$cid.'.num'}) 3321: .' '. 3322: &del('nohist_calculatedsheets_'.$cid, 3323: [$key.'assesscalc:'.$symb],$udom,$uname); 3324: unless ($status eq 'ok ok') { 3325: &logthis('Could not devalidate spreadsheet '. 3326: $uname.' at '.$udom.' for '. 3327: $symb.': '.$status); 3328: } 3329: &delenv('user.state.'.$cid); 3330: } 3331: } 3332: 3333: sub get_scalar { 3334: my ($string,$end) = @_; 3335: my $value; 3336: if ($$string =~ s/^([^&]*?)($end)/$2/) { 3337: $value = $1; 3338: } elsif ($$string =~ s/^([^&]*?)&//) { 3339: $value = $1; 3340: } 3341: return &unescape($value); 3342: } 3343: 3344: sub array2str { 3345: my (@array) = @_; 3346: my $result=&arrayref2str(\@array); 3347: $result=~s/^__ARRAY_REF__//; 3348: $result=~s/__END_ARRAY_REF__$//; 3349: return $result; 3350: } 3351: 3352: sub arrayref2str { 3353: my ($arrayref) = @_; 3354: my $result='__ARRAY_REF__'; 3355: foreach my $elem (@$arrayref) { 3356: if(ref($elem) eq 'ARRAY') { 3357: $result.=&arrayref2str($elem).'&'; 3358: } elsif(ref($elem) eq 'HASH') { 3359: $result.=&hashref2str($elem).'&'; 3360: } elsif(ref($elem)) { 3361: #print("Got a ref of ".(ref($elem))." skipping."); 3362: } else { 3363: $result.=&escape($elem).'&'; 3364: } 3365: } 3366: $result=~s/\&$//; 3367: $result .= '__END_ARRAY_REF__'; 3368: return $result; 3369: } 3370: 3371: sub hash2str { 3372: my (%hash) = @_; 3373: my $result=&hashref2str(\%hash); 3374: $result=~s/^__HASH_REF__//; 3375: $result=~s/__END_HASH_REF__$//; 3376: return $result; 3377: } 3378: 3379: sub hashref2str { 3380: my ($hashref)=@_; 3381: my $result='__HASH_REF__'; 3382: foreach my $key (sort(keys(%$hashref))) { 3383: if (ref($key) eq 'ARRAY') { 3384: $result.=&arrayref2str($key).'='; 3385: } elsif (ref($key) eq 'HASH') { 3386: $result.=&hashref2str($key).'='; 3387: } elsif (ref($key)) { 3388: $result.='='; 3389: #print("Got a ref of ".(ref($key))." skipping."); 3390: } else { 3391: if ($key) {$result.=&escape($key).'=';} else { last; } 3392: } 3393: 3394: if(ref($hashref->{$key}) eq 'ARRAY') { 3395: $result.=&arrayref2str($hashref->{$key}).'&'; 3396: } elsif(ref($hashref->{$key}) eq 'HASH') { 3397: $result.=&hashref2str($hashref->{$key}).'&'; 3398: } elsif(ref($hashref->{$key})) { 3399: $result.='&'; 3400: #print("Got a ref of ".(ref($hashref->{$key}))." skipping."); 3401: } else { 3402: $result.=&escape($hashref->{$key}).'&'; 3403: } 3404: } 3405: $result=~s/\&$//; 3406: $result .= '__END_HASH_REF__'; 3407: return $result; 3408: } 3409: 3410: sub str2hash { 3411: my ($string)=@_; 3412: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__'); 3413: return %$hash; 3414: } 3415: 3416: sub str2hashref { 3417: my ($string) = @_; 3418: 3419: my %hash; 3420: 3421: if($string !~ /^__HASH_REF__/) { 3422: if (! ($string eq '' || !defined($string))) { 3423: $hash{'error'}='Not hash reference'; 3424: } 3425: return (\%hash, $string); 3426: } 3427: 3428: $string =~ s/^__HASH_REF__//; 3429: 3430: while($string !~ /^__END_HASH_REF__/) { 3431: #key 3432: my $key=''; 3433: if($string =~ /^__HASH_REF__/) { 3434: ($key, $string)=&str2hashref($string); 3435: if(defined($key->{'error'})) { 3436: $hash{'error'}='Bad data'; 3437: return (\%hash, $string); 3438: } 3439: } elsif($string =~ /^__ARRAY_REF__/) { 3440: ($key, $string)=&str2arrayref($string); 3441: if($key->[0] eq 'Array reference error') { 3442: $hash{'error'}='Bad data'; 3443: return (\%hash, $string); 3444: } 3445: } else { 3446: $string =~ s/^(.*?)=//; 3447: $key=&unescape($1); 3448: } 3449: $string =~ s/^=//; 3450: 3451: #value 3452: my $value=''; 3453: if($string =~ /^__HASH_REF__/) { 3454: ($value, $string)=&str2hashref($string); 3455: if(defined($value->{'error'})) { 3456: $hash{'error'}='Bad data'; 3457: return (\%hash, $string); 3458: } 3459: } elsif($string =~ /^__ARRAY_REF__/) { 3460: ($value, $string)=&str2arrayref($string); 3461: if($value->[0] eq 'Array reference error') { 3462: $hash{'error'}='Bad data'; 3463: return (\%hash, $string); 3464: } 3465: } else { 3466: $value=&get_scalar(\$string,'__END_HASH_REF__'); 3467: } 3468: $string =~ s/^&//; 3469: 3470: $hash{$key}=$value; 3471: } 3472: 3473: $string =~ s/^__END_HASH_REF__//; 3474: 3475: return (\%hash, $string); 3476: } 3477: 3478: sub str2array { 3479: my ($string)=@_; 3480: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__'); 3481: return @$array; 3482: } 3483: 3484: sub str2arrayref { 3485: my ($string) = @_; 3486: my @array; 3487: 3488: if($string !~ /^__ARRAY_REF__/) { 3489: if (! ($string eq '' || !defined($string))) { 3490: $array[0]='Array reference error'; 3491: } 3492: return (\@array, $string); 3493: } 3494: 3495: $string =~ s/^__ARRAY_REF__//; 3496: 3497: while($string !~ /^__END_ARRAY_REF__/) { 3498: my $value=''; 3499: if($string =~ /^__HASH_REF__/) { 3500: ($value, $string)=&str2hashref($string); 3501: if(defined($value->{'error'})) { 3502: $array[0] ='Array reference error'; 3503: return (\@array, $string); 3504: } 3505: } elsif($string =~ /^__ARRAY_REF__/) { 3506: ($value, $string)=&str2arrayref($string); 3507: if($value->[0] eq 'Array reference error') { 3508: $array[0] ='Array reference error'; 3509: return (\@array, $string); 3510: } 3511: } else { 3512: $value=&get_scalar(\$string,'__END_ARRAY_REF__'); 3513: } 3514: $string =~ s/^&//; 3515: 3516: push(@array, $value); 3517: } 3518: 3519: $string =~ s/^__END_ARRAY_REF__//; 3520: 3521: return (\@array, $string); 3522: } 3523: 3524: # -------------------------------------------------------------------Temp Store 3525: 3526: sub tmpreset { 3527: my ($symb,$namespace,$domain,$stuname) = @_; 3528: if (!$symb) { 3529: $symb=&symbread(); 3530: if (!$symb) { $symb= $env{'request.url'}; } 3531: } 3532: $symb=escape($symb); 3533: 3534: if (!$namespace) { $namespace=$env{'request.state'}; } 3535: $namespace=~s/\//\_/g; 3536: $namespace=~s/\W//g; 3537: 3538: if (!$domain) { $domain=$env{'user.domain'}; } 3539: if (!$stuname) { $stuname=$env{'user.name'}; } 3540: if ($domain eq 'public' && $stuname eq 'public') { 3541: $stuname=$ENV{'REMOTE_ADDR'}; 3542: } 3543: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3544: my %hash; 3545: if (tie(%hash,'GDBM_File', 3546: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3547: &GDBM_WRCREAT(),0640)) { 3548: foreach my $key (keys(%hash)) { 3549: if ($key=~ /:$symb/) { 3550: delete($hash{$key}); 3551: } 3552: } 3553: } 3554: } 3555: 3556: sub tmpstore { 3557: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3558: 3559: if (!$symb) { 3560: $symb=&symbread(); 3561: if (!$symb) { $symb= $env{'request.url'}; } 3562: } 3563: $symb=escape($symb); 3564: 3565: if (!$namespace) { 3566: # I don't think we would ever want to store this for a course. 3567: # it seems this will only be used if we don't have a course. 3568: #$namespace=$env{'request.course.id'}; 3569: #if (!$namespace) { 3570: $namespace=$env{'request.state'}; 3571: #} 3572: } 3573: $namespace=~s/\//\_/g; 3574: $namespace=~s/\W//g; 3575: if (!$domain) { $domain=$env{'user.domain'}; } 3576: if (!$stuname) { $stuname=$env{'user.name'}; } 3577: if ($domain eq 'public' && $stuname eq 'public') { 3578: $stuname=$ENV{'REMOTE_ADDR'}; 3579: } 3580: my $now=time; 3581: my %hash; 3582: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3583: if (tie(%hash,'GDBM_File', 3584: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3585: &GDBM_WRCREAT(),0640)) { 3586: $hash{"version:$symb"}++; 3587: my $version=$hash{"version:$symb"}; 3588: my $allkeys=''; 3589: foreach my $key (keys(%$storehash)) { 3590: $allkeys.=$key.':'; 3591: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key}); 3592: } 3593: $hash{"$version:$symb:timestamp"}=$now; 3594: $allkeys.='timestamp'; 3595: $hash{"$version:keys:$symb"}=$allkeys; 3596: if (untie(%hash)) { 3597: return 'ok'; 3598: } else { 3599: return "error:$!"; 3600: } 3601: } else { 3602: return "error:$!"; 3603: } 3604: } 3605: 3606: # -----------------------------------------------------------------Temp Restore 3607: 3608: sub tmprestore { 3609: my ($symb,$namespace,$domain,$stuname) = @_; 3610: 3611: if (!$symb) { 3612: $symb=&symbread(); 3613: if (!$symb) { $symb= $env{'request.url'}; } 3614: } 3615: $symb=escape($symb); 3616: 3617: if (!$namespace) { $namespace=$env{'request.state'}; } 3618: 3619: if (!$domain) { $domain=$env{'user.domain'}; } 3620: if (!$stuname) { $stuname=$env{'user.name'}; } 3621: if ($domain eq 'public' && $stuname eq 'public') { 3622: $stuname=$ENV{'REMOTE_ADDR'}; 3623: } 3624: my %returnhash; 3625: $namespace=~s/\//\_/g; 3626: $namespace=~s/\W//g; 3627: my %hash; 3628: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3629: if (tie(%hash,'GDBM_File', 3630: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3631: &GDBM_READER(),0640)) { 3632: my $version=$hash{"version:$symb"}; 3633: $returnhash{'version'}=$version; 3634: my $scope; 3635: for ($scope=1;$scope<=$version;$scope++) { 3636: my $vkeys=$hash{"$scope:keys:$symb"}; 3637: my @keys=split(/:/,$vkeys); 3638: my $key; 3639: $returnhash{"$scope:keys"}=$vkeys; 3640: foreach $key (@keys) { 3641: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3642: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3643: } 3644: } 3645: if (!(untie(%hash))) { 3646: return "error:$!"; 3647: } 3648: } else { 3649: return "error:$!"; 3650: } 3651: return %returnhash; 3652: } 3653: 3654: # ----------------------------------------------------------------------- Store 3655: 3656: sub store { 3657: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3658: my $home=''; 3659: 3660: if ($stuname) { $home=&homeserver($stuname,$domain); } 3661: 3662: $symb=&symbclean($symb); 3663: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 3664: 3665: if (!$domain) { $domain=$env{'user.domain'}; } 3666: if (!$stuname) { $stuname=$env{'user.name'}; } 3667: 3668: &devalidate($symb,$stuname,$domain); 3669: 3670: $symb=escape($symb); 3671: if (!$namespace) { 3672: unless ($namespace=$env{'request.course.id'}) { 3673: return ''; 3674: } 3675: } 3676: if (!$home) { $home=$env{'user.home'}; } 3677: 3678: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 3679: $$storehash{'host'}=$perlvar{'lonHostID'}; 3680: 3681: my $namevalue=''; 3682: foreach my $key (keys(%$storehash)) { 3683: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 3684: } 3685: $namevalue=~s/\&$//; 3686: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue); 3687: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3688: } 3689: 3690: # -------------------------------------------------------------- Critical Store 3691: 3692: sub cstore { 3693: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3694: my $home=''; 3695: 3696: if ($stuname) { $home=&homeserver($stuname,$domain); } 3697: 3698: $symb=&symbclean($symb); 3699: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 3700: 3701: if (!$domain) { $domain=$env{'user.domain'}; } 3702: if (!$stuname) { $stuname=$env{'user.name'}; } 3703: 3704: &devalidate($symb,$stuname,$domain); 3705: 3706: $symb=escape($symb); 3707: if (!$namespace) { 3708: unless ($namespace=$env{'request.course.id'}) { 3709: return ''; 3710: } 3711: } 3712: if (!$home) { $home=$env{'user.home'}; } 3713: 3714: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 3715: $$storehash{'host'}=$perlvar{'lonHostID'}; 3716: 3717: my $namevalue=''; 3718: foreach my $key (keys(%$storehash)) { 3719: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 3720: } 3721: $namevalue=~s/\&$//; 3722: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue); 3723: return critical 3724: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3725: } 3726: 3727: # --------------------------------------------------------------------- Restore 3728: 3729: sub restore { 3730: my ($symb,$namespace,$domain,$stuname) = @_; 3731: my $home=''; 3732: 3733: if ($stuname) { $home=&homeserver($stuname,$domain); } 3734: 3735: if (!$symb) { 3736: unless ($symb=escape(&symbread())) { return ''; } 3737: } else { 3738: $symb=&escape(&symbclean($symb)); 3739: } 3740: if (!$namespace) { 3741: unless ($namespace=$env{'request.course.id'}) { 3742: return ''; 3743: } 3744: } 3745: if (!$domain) { $domain=$env{'user.domain'}; } 3746: if (!$stuname) { $stuname=$env{'user.name'}; } 3747: if (!$home) { $home=$env{'user.home'}; } 3748: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home"); 3749: 3750: my %returnhash=(); 3751: foreach my $line (split(/\&/,$answer)) { 3752: my ($name,$value)=split(/\=/,$line); 3753: $returnhash{&unescape($name)}=&thaw_unescape($value); 3754: } 3755: my $version; 3756: for ($version=1;$version<=$returnhash{'version'};$version++) { 3757: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) { 3758: $returnhash{$item}=$returnhash{$version.':'.$item}; 3759: } 3760: } 3761: return %returnhash; 3762: } 3763: 3764: # ---------------------------------------------------------- Course Description 3765: 3766: sub coursedescription { 3767: my ($courseid,$args)=@_; 3768: $courseid=~s/^\///; 3769: $courseid=~s/\_/\//g; 3770: my ($cdomain,$cnum)=split(/\//,$courseid); 3771: my $chome=&homeserver($cnum,$cdomain); 3772: my $normalid=$cdomain.'_'.$cnum; 3773: # need to always cache even if we get errors otherwise we keep 3774: # trying and trying and trying to get the course description. 3775: my %envhash=(); 3776: my %returnhash=(); 3777: 3778: my $expiretime=600; 3779: if ($env{'request.course.id'} eq $normalid) { 3780: $expiretime=120; 3781: } 3782: 3783: my $prefix='course.'.$cdomain.'_'.$cnum.'.'; 3784: if (!$args->{'freshen_cache'} 3785: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) { 3786: foreach my $key (keys(%env)) { 3787: next if ($key !~ /^\Q$prefix\E(.*)/); 3788: my ($setting) = $1; 3789: $returnhash{$setting} = $env{$key}; 3790: } 3791: return %returnhash; 3792: } 3793: 3794: # get the data agin 3795: if (!$args->{'one_time'}) { 3796: $envhash{'course.'.$normalid.'.last_cache'}=time; 3797: } 3798: 3799: if ($chome ne 'no_host') { 3800: %returnhash=&dump('environment',$cdomain,$cnum); 3801: if (!exists($returnhash{'con_lost'})) { 3802: $returnhash{'home'}= $chome; 3803: $returnhash{'domain'} = $cdomain; 3804: $returnhash{'num'} = $cnum; 3805: if (!defined($returnhash{'type'})) { 3806: $returnhash{'type'} = 'Course'; 3807: } 3808: while (my ($name,$value) = each %returnhash) { 3809: $envhash{'course.'.$normalid.'.'.$name}=$value; 3810: } 3811: $returnhash{'url'}=&clutter($returnhash{'url'}); 3812: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'. 3813: $env{'user.name'}.'_'.$cdomain.'_'.$cnum; 3814: $envhash{'course.'.$normalid.'.home'}=$chome; 3815: $envhash{'course.'.$normalid.'.domain'}=$cdomain; 3816: $envhash{'course.'.$normalid.'.num'}=$cnum; 3817: } 3818: } 3819: if (!$args->{'one_time'}) { 3820: &appenv(\%envhash); 3821: } 3822: return %returnhash; 3823: } 3824: 3825: # -------------------------------------------------See if a user is privileged 3826: 3827: sub privileged { 3828: my ($username,$domain)=@_; 3829: my $rolesdump=&reply("dump:$domain:$username:roles", 3830: &homeserver($username,$domain)); 3831: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 3832: ($rolesdump =~ /^error:/)) { 3833: return 0; 3834: } 3835: my $now=time; 3836: if ($rolesdump ne '') { 3837: foreach my $entry (split(/&/,$rolesdump)) { 3838: if ($entry!~/^rolesdef_/) { 3839: my ($area,$role)=split(/=/,$entry); 3840: $area=~s/\_\w\w$//; 3841: my ($trole,$tend,$tstart)=split(/_/,$role); 3842: if (($trole eq 'dc') || ($trole eq 'su')) { 3843: my $active=1; 3844: if ($tend) { 3845: if ($tend<$now) { $active=0; } 3846: } 3847: if ($tstart) { 3848: if ($tstart>$now) { $active=0; } 3849: } 3850: if ($active) { return 1; } 3851: } 3852: } 3853: } 3854: } 3855: return 0; 3856: } 3857: 3858: # -------------------------------------------------------- Get user privileges 3859: 3860: sub rolesinit { 3861: my ($domain,$username,$authhost)=@_; 3862: my $now=time; 3863: my %userroles = ('user.login.time' => $now); 3864: my $rolesdump=reply("dump:$domain:$username:roles",$authhost); 3865: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 3866: ($rolesdump =~ /^error:/)) { 3867: return \%userroles; 3868: } 3869: my %allroles=(); 3870: my %allgroups=(); 3871: my $group_privs; 3872: 3873: if ($rolesdump ne '') { 3874: foreach my $entry (split(/&/,$rolesdump)) { 3875: if ($entry!~/^rolesdef_/) { 3876: my ($area,$role)=split(/=/,$entry); 3877: $area=~s/\_\w\w$//; 3878: my ($trole,$tend,$tstart,$group_privs); 3879: if ($role=~/^cr/) { 3880: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) { 3881: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|); 3882: ($tend,$tstart)=split('_',$trest); 3883: } else { 3884: $trole=$role; 3885: } 3886: } elsif ($role =~ m|^gr/|) { 3887: ($trole,$tend,$tstart) = split(/_/,$role); 3888: ($trole,$group_privs) = split(/\//,$trole); 3889: $group_privs = &unescape($group_privs); 3890: } else { 3891: ($trole,$tend,$tstart)=split(/_/,$role); 3892: } 3893: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain, 3894: $username); 3895: @userroles{keys(%new_role)} = @new_role{keys(%new_role)}; 3896: if (($tend!=0) && ($tend<$now)) { $trole=''; } 3897: if (($tstart!=0) && ($tstart>$now)) { $trole=''; } 3898: if (($area ne '') && ($trole ne '')) { 3899: my $spec=$trole.'.'.$area; 3900: my ($tdummy,$tdomain,$trest)=split(/\//,$area); 3901: if ($trole =~ /^cr\//) { 3902: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 3903: } elsif ($trole eq 'gr') { 3904: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart); 3905: } else { 3906: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 3907: } 3908: } 3909: } 3910: } 3911: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups); 3912: $userroles{'user.adv'} = $adv; 3913: $userroles{'user.author'} = $author; 3914: $env{'user.adv'}=$adv; 3915: } 3916: return \%userroles; 3917: } 3918: 3919: sub set_arearole { 3920: my ($trole,$area,$tstart,$tend,$domain,$username) = @_; 3921: # log the associated role with the area 3922: &userrolelog($trole,$username,$domain,$area,$tstart,$tend); 3923: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend); 3924: } 3925: 3926: sub custom_roleprivs { 3927: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_; 3928: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole); 3929: my $homsvr=homeserver($rauthor,$rdomain); 3930: if (&hostname($homsvr) ne '') { 3931: my ($rdummy,$roledef)= 3932: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor); 3933: if (($rdummy ne 'con_lost') && ($roledef ne '')) { 3934: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef); 3935: if (defined($syspriv)) { 3936: if ($trest =~ /^$match_community$/) { 3937: $syspriv =~ s/bre\&S//; 3938: } 3939: $$allroles{'cm./'}.=':'.$syspriv; 3940: $$allroles{$spec.'./'}.=':'.$syspriv; 3941: } 3942: if ($tdomain ne '') { 3943: if (defined($dompriv)) { 3944: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv; 3945: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv; 3946: } 3947: if (($trest ne '') && (defined($coursepriv))) { 3948: $$allroles{'cm.'.$area}.=':'.$coursepriv; 3949: $$allroles{$spec.'.'.$area}.=':'.$coursepriv; 3950: } 3951: } 3952: } 3953: } 3954: } 3955: 3956: sub group_roleprivs { 3957: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_; 3958: my $access = 1; 3959: my $now = time; 3960: if (($tend!=0) && ($tend<$now)) { $access = 0; } 3961: if (($tstart!=0) && ($tstart>$now)) { $access=0; } 3962: if ($access) { 3963: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|); 3964: $$allgroups{$course}{$group} .=':'.$group_privs; 3965: } 3966: } 3967: 3968: sub standard_roleprivs { 3969: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_; 3970: if (defined($pr{$trole.':s'})) { 3971: $$allroles{'cm./'}.=':'.$pr{$trole.':s'}; 3972: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'}; 3973: } 3974: if ($tdomain ne '') { 3975: if (defined($pr{$trole.':d'})) { 3976: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 3977: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 3978: } 3979: if (($trest ne '') && (defined($pr{$trole.':c'}))) { 3980: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'}; 3981: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'}; 3982: } 3983: } 3984: } 3985: 3986: sub set_userprivs { 3987: my ($userroles,$allroles,$allgroups) = @_; 3988: my $author=0; 3989: my $adv=0; 3990: my %grouproles = (); 3991: if (keys(%{$allgroups}) > 0) { 3992: foreach my $role (keys(%{$allroles})) { 3993: my ($trole,$area,$sec,$extendedarea); 3994: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) { 3995: $trole = $1; 3996: $area = $2; 3997: $sec = $3; 3998: $extendedarea = $area.$sec; 3999: if (exists($$allgroups{$area})) { 4000: foreach my $group (keys(%{$$allgroups{$area}})) { 4001: my $spec = $trole.'.'.$extendedarea; 4002: $grouproles{$spec.'.'.$area.'/'.$group} = 4003: $$allgroups{$area}{$group}; 4004: } 4005: } 4006: } 4007: } 4008: } 4009: foreach my $group (keys(%grouproles)) { 4010: $$allroles{$group} = $grouproles{$group}; 4011: } 4012: foreach my $role (keys(%{$allroles})) { 4013: my %thesepriv; 4014: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; } 4015: foreach my $item (split(/:/,$$allroles{$role})) { 4016: if ($item ne '') { 4017: my ($privilege,$restrictions)=split(/&/,$item); 4018: if ($restrictions eq '') { 4019: $thesepriv{$privilege}='F'; 4020: } elsif ($thesepriv{$privilege} ne 'F') { 4021: $thesepriv{$privilege}.=$restrictions; 4022: } 4023: if ($thesepriv{'adv'} eq 'F') { $adv=1; } 4024: } 4025: } 4026: my $thesestr=''; 4027: foreach my $priv (keys(%thesepriv)) { 4028: $thesestr.=':'.$priv.'&'.$thesepriv{$priv}; 4029: } 4030: $userroles->{'user.priv.'.$role} = $thesestr; 4031: } 4032: return ($author,$adv); 4033: } 4034: 4035: sub role_status { 4036: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_; 4037: my @pwhere = (); 4038: if (exists($env{$rolekey}) && $env{$rolekey} ne '') { 4039: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey); 4040: unless (!defined($$role) || $$role eq '') { 4041: $$where=join('.',@pwhere); 4042: $$trolecode=$$role.'.'.$$where; 4043: ($$tstart,$$tend)=split(/\./,$env{$rolekey}); 4044: $$tstatus='is'; 4045: if ($$tstart && $$tstart>$then) { 4046: $$tstatus='future'; 4047: if ($$tstart<$now) { 4048: if ($$tstart && $$tstart>$refresh) { 4049: if (($$where ne '') && ($$role ne '')) { 4050: my (%allroles,%allgroups,$group_privs); 4051: my %userroles = ( 4052: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend 4053: ); 4054: my $spec=$$role.'.'.$$where; 4055: my ($tdummy,$tdomain,$trest)=split(/\//,$$where); 4056: if ($$role =~ /^cr\//) { 4057: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where); 4058: } elsif ($$role eq 'gr') { 4059: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'}, 4060: $env{'user.name'}); 4061: my $trole = split('_',$rolehash{$$where.'_'.$$role},1); 4062: (undef,my $group_privs) = split(/\//,$trole); 4063: $group_privs = &unescape($group_privs); 4064: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart); 4065: } else { 4066: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where); 4067: } 4068: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups); 4069: &appenv(\%userroles,[$$role,'cm']); 4070: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4071: } 4072: } 4073: $$tstatus = 'is'; 4074: } 4075: } 4076: if ($$tend) { 4077: if ($$tend<$then) { 4078: $$tstatus='expired'; 4079: } elsif ($$tend<$now) { 4080: $$tstatus='will_not'; 4081: } 4082: } 4083: } 4084: } 4085: } 4086: 4087: sub check_adhoc_privs { 4088: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_; 4089: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum; 4090: if ($env{$cckey}) { 4091: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend); 4092: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend); 4093: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) { 4094: &set_adhoc_privileges($cdom,$cnum,$checkrole); 4095: } 4096: } else { 4097: &set_adhoc_privileges($cdom,$cnum,$checkrole); 4098: } 4099: } 4100: 4101: sub set_adhoc_privileges { 4102: # role can be cc or ca 4103: my ($dcdom,$pickedcourse,$role) = @_; 4104: my $area = '/'.$dcdom.'/'.$pickedcourse; 4105: my $spec = $role.'.'.$area; 4106: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'}, 4107: $env{'user.name'}); 4108: my %ccrole = (); 4109: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area); 4110: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole); 4111: &appenv(\%userroles,[$role,'cm']); 4112: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4113: &appenv( {'request.role' => $spec, 4114: 'request.role.domain' => $dcdom, 4115: 'request.course.sec' => '' 4116: } 4117: ); 4118: my $tadv=0; 4119: if (&allowed('adv') eq 'F') { $tadv=1; } 4120: &appenv({'request.role.adv' => $tadv}); 4121: } 4122: 4123: # --------------------------------------------------------------- get interface 4124: 4125: sub get { 4126: my ($namespace,$storearr,$udomain,$uname)=@_; 4127: my $items=''; 4128: foreach my $item (@$storearr) { 4129: $items.=&escape($item).'&'; 4130: } 4131: $items=~s/\&$//; 4132: if (!$udomain) { $udomain=$env{'user.domain'}; } 4133: if (!$uname) { $uname=$env{'user.name'}; } 4134: my $uhome=&homeserver($uname,$udomain); 4135: 4136: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome); 4137: my @pairs=split(/\&/,$rep); 4138: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 4139: return @pairs; 4140: } 4141: my %returnhash=(); 4142: my $i=0; 4143: foreach my $item (@$storearr) { 4144: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4145: $i++; 4146: } 4147: return %returnhash; 4148: } 4149: 4150: # --------------------------------------------------------------- del interface 4151: 4152: sub del { 4153: my ($namespace,$storearr,$udomain,$uname)=@_; 4154: my $items=''; 4155: foreach my $item (@$storearr) { 4156: $items.=&escape($item).'&'; 4157: } 4158: 4159: $items=~s/\&$//; 4160: if (!$udomain) { $udomain=$env{'user.domain'}; } 4161: if (!$uname) { $uname=$env{'user.name'}; } 4162: my $uhome=&homeserver($uname,$udomain); 4163: return &reply("del:$udomain:$uname:$namespace:$items",$uhome); 4164: } 4165: 4166: # -------------------------------------------------------------- dump interface 4167: 4168: sub dump { 4169: my ($namespace,$udomain,$uname,$regexp,$range)=@_; 4170: if (!$udomain) { $udomain=$env{'user.domain'}; } 4171: if (!$uname) { $uname=$env{'user.name'}; } 4172: my $uhome=&homeserver($uname,$udomain); 4173: if ($regexp) { 4174: $regexp=&escape($regexp); 4175: } else { 4176: $regexp='.'; 4177: } 4178: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome); 4179: my @pairs=split(/\&/,$rep); 4180: my %returnhash=(); 4181: foreach my $item (@pairs) { 4182: my ($key,$value)=split(/=/,$item,2); 4183: $key = &unescape($key); 4184: next if ($key =~ /^error: 2 /); 4185: $returnhash{$key}=&thaw_unescape($value); 4186: } 4187: return %returnhash; 4188: } 4189: 4190: # --------------------------------------------------------- dumpstore interface 4191: 4192: sub dumpstore { 4193: my ($namespace,$udomain,$uname,$regexp,$range)=@_; 4194: if (!$udomain) { $udomain=$env{'user.domain'}; } 4195: if (!$uname) { $uname=$env{'user.name'}; } 4196: my $uhome=&homeserver($uname,$udomain); 4197: if ($regexp) { 4198: $regexp=&escape($regexp); 4199: } else { 4200: $regexp='.'; 4201: } 4202: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome); 4203: my @pairs=split(/\&/,$rep); 4204: my %returnhash=(); 4205: foreach my $item (@pairs) { 4206: my ($key,$value)=split(/=/,$item,2); 4207: next if ($key =~ /^error: 2 /); 4208: $returnhash{$key}=&thaw_unescape($value); 4209: } 4210: return %returnhash; 4211: } 4212: 4213: # -------------------------------------------------------------- keys interface 4214: 4215: sub getkeys { 4216: my ($namespace,$udomain,$uname)=@_; 4217: if (!$udomain) { $udomain=$env{'user.domain'}; } 4218: if (!$uname) { $uname=$env{'user.name'}; } 4219: my $uhome=&homeserver($uname,$udomain); 4220: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome); 4221: my @keyarray=(); 4222: foreach my $key (split(/\&/,$rep)) { 4223: next if ($key =~ /^error: 2 /); 4224: push(@keyarray,&unescape($key)); 4225: } 4226: return @keyarray; 4227: } 4228: 4229: # --------------------------------------------------------------- currentdump 4230: sub currentdump { 4231: my ($courseid,$sdom,$sname)=@_; 4232: $courseid = $env{'request.course.id'} if (! defined($courseid)); 4233: $sdom = $env{'user.domain'} if (! defined($sdom)); 4234: $sname = $env{'user.name'} if (! defined($sname)); 4235: my $uhome = &homeserver($sname,$sdom); 4236: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome); 4237: return if ($rep =~ /^(error:|no_such_host)/); 4238: # 4239: my %returnhash=(); 4240: # 4241: if ($rep eq "unknown_cmd") { 4242: # an old lond will not know currentdump 4243: # Do a dump and make it look like a currentdump 4244: my @tmp = &dumpstore($courseid,$sdom,$sname,'.'); 4245: return if ($tmp[0] =~ /^(error:|no_such_host)/); 4246: my %hash = @tmp; 4247: @tmp=(); 4248: %returnhash = %{&convert_dump_to_currentdump(\%hash)}; 4249: } else { 4250: my @pairs=split(/\&/,$rep); 4251: foreach my $pair (@pairs) { 4252: my ($key,$value)=split(/=/,$pair,2); 4253: my ($symb,$param) = split(/:/,$key); 4254: $returnhash{&unescape($symb)}->{&unescape($param)} = 4255: &thaw_unescape($value); 4256: } 4257: } 4258: return %returnhash; 4259: } 4260: 4261: sub convert_dump_to_currentdump{ 4262: my %hash = %{shift()}; 4263: my %returnhash; 4264: # Code ripped from lond, essentially. The only difference 4265: # here is the unescaping done by lonnet::dump(). Conceivably 4266: # we might run in to problems with parameter names =~ /^v\./ 4267: while (my ($key,$value) = each(%hash)) { 4268: my ($v,$symb,$param) = split(/:/,$key); 4269: $symb = &unescape($symb); 4270: $param = &unescape($param); 4271: next if ($v eq 'version' || $symb eq 'keys'); 4272: next if (exists($returnhash{$symb}) && 4273: exists($returnhash{$symb}->{$param}) && 4274: $returnhash{$symb}->{'v.'.$param} > $v); 4275: $returnhash{$symb}->{$param}=$value; 4276: $returnhash{$symb}->{'v.'.$param}=$v; 4277: } 4278: # 4279: # Remove all of the keys in the hashes which keep track of 4280: # the version of the parameter. 4281: while (my ($symb,$param_hash) = each(%returnhash)) { 4282: # use a foreach because we are going to delete from the hash. 4283: foreach my $key (keys(%$param_hash)) { 4284: delete($param_hash->{$key}) if ($key =~ /^v\./); 4285: } 4286: } 4287: return \%returnhash; 4288: } 4289: 4290: # ------------------------------------------------------ critical inc interface 4291: 4292: sub cinc { 4293: return &inc(@_,'critical'); 4294: } 4295: 4296: # --------------------------------------------------------------- inc interface 4297: 4298: sub inc { 4299: my ($namespace,$store,$udomain,$uname,$critical) = @_; 4300: if (!$udomain) { $udomain=$env{'user.domain'}; } 4301: if (!$uname) { $uname=$env{'user.name'}; } 4302: my $uhome=&homeserver($uname,$udomain); 4303: my $items=''; 4304: if (! ref($store)) { 4305: # got a single value, so use that instead 4306: $items = &escape($store).'=&'; 4307: } elsif (ref($store) eq 'SCALAR') { 4308: $items = &escape($$store).'=&'; 4309: } elsif (ref($store) eq 'ARRAY') { 4310: $items = join('=&',map {&escape($_);} @{$store}); 4311: } elsif (ref($store) eq 'HASH') { 4312: while (my($key,$value) = each(%{$store})) { 4313: $items.= &escape($key).'='.&escape($value).'&'; 4314: } 4315: } 4316: $items=~s/\&$//; 4317: if ($critical) { 4318: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome); 4319: } else { 4320: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome); 4321: } 4322: } 4323: 4324: # --------------------------------------------------------------- put interface 4325: 4326: sub put { 4327: my ($namespace,$storehash,$udomain,$uname)=@_; 4328: if (!$udomain) { $udomain=$env{'user.domain'}; } 4329: if (!$uname) { $uname=$env{'user.name'}; } 4330: my $uhome=&homeserver($uname,$udomain); 4331: my $items=''; 4332: foreach my $item (keys(%$storehash)) { 4333: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4334: } 4335: $items=~s/\&$//; 4336: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4337: } 4338: 4339: # ------------------------------------------------------------ newput interface 4340: 4341: sub newput { 4342: my ($namespace,$storehash,$udomain,$uname)=@_; 4343: if (!$udomain) { $udomain=$env{'user.domain'}; } 4344: if (!$uname) { $uname=$env{'user.name'}; } 4345: my $uhome=&homeserver($uname,$udomain); 4346: my $items=''; 4347: foreach my $key (keys(%$storehash)) { 4348: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 4349: } 4350: $items=~s/\&$//; 4351: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome); 4352: } 4353: 4354: # --------------------------------------------------------- putstore interface 4355: 4356: sub putstore { 4357: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4358: if (!$udomain) { $udomain=$env{'user.domain'}; } 4359: if (!$uname) { $uname=$env{'user.name'}; } 4360: my $uhome=&homeserver($uname,$udomain); 4361: my $items=''; 4362: foreach my $key (keys(%$storehash)) { 4363: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&'; 4364: } 4365: $items=~s/\&$//; 4366: my $esc_symb=&escape($symb); 4367: my $esc_v=&escape($version); 4368: my $reply = 4369: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items", 4370: $uhome); 4371: if ($reply eq 'unknown_cmd') { 4372: # gfall back to way things use to be done 4373: return &old_putstore($namespace,$symb,$version,$storehash,$udomain, 4374: $uname); 4375: } 4376: return $reply; 4377: } 4378: 4379: sub old_putstore { 4380: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4381: if (!$udomain) { $udomain=$env{'user.domain'}; } 4382: if (!$uname) { $uname=$env{'user.name'}; } 4383: my $uhome=&homeserver($uname,$udomain); 4384: my %newstorehash; 4385: foreach my $item (keys(%$storehash)) { 4386: my $key = $version.':'.&escape($symb).':'.$item; 4387: $newstorehash{$key} = $storehash->{$item}; 4388: } 4389: my $items=''; 4390: my %allitems = (); 4391: foreach my $item (keys(%newstorehash)) { 4392: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) { 4393: my $key = $1.':keys:'.$2; 4394: $allitems{$key} .= $3.':'; 4395: } 4396: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&'; 4397: } 4398: foreach my $item (keys(%allitems)) { 4399: $allitems{$item} =~ s/\:$//; 4400: $items.= $item.'='.$allitems{$item}.'&'; 4401: } 4402: $items=~s/\&$//; 4403: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4404: } 4405: 4406: # ------------------------------------------------------ critical put interface 4407: 4408: sub cput { 4409: my ($namespace,$storehash,$udomain,$uname)=@_; 4410: if (!$udomain) { $udomain=$env{'user.domain'}; } 4411: if (!$uname) { $uname=$env{'user.name'}; } 4412: my $uhome=&homeserver($uname,$udomain); 4413: my $items=''; 4414: foreach my $item (keys(%$storehash)) { 4415: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4416: } 4417: $items=~s/\&$//; 4418: return &critical("put:$udomain:$uname:$namespace:$items",$uhome); 4419: } 4420: 4421: # -------------------------------------------------------------- eget interface 4422: 4423: sub eget { 4424: my ($namespace,$storearr,$udomain,$uname)=@_; 4425: my $items=''; 4426: foreach my $item (@$storearr) { 4427: $items.=&escape($item).'&'; 4428: } 4429: $items=~s/\&$//; 4430: if (!$udomain) { $udomain=$env{'user.domain'}; } 4431: if (!$uname) { $uname=$env{'user.name'}; } 4432: my $uhome=&homeserver($uname,$udomain); 4433: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome); 4434: my @pairs=split(/\&/,$rep); 4435: my %returnhash=(); 4436: my $i=0; 4437: foreach my $item (@$storearr) { 4438: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4439: $i++; 4440: } 4441: return %returnhash; 4442: } 4443: 4444: # ------------------------------------------------------------ tmpput interface 4445: sub tmpput { 4446: my ($storehash,$server,$context)=@_; 4447: my $items=''; 4448: foreach my $item (keys(%$storehash)) { 4449: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4450: } 4451: $items=~s/\&$//; 4452: if (defined($context)) { 4453: $items .= ':'.&escape($context); 4454: } 4455: return &reply("tmpput:$items",$server); 4456: } 4457: 4458: # ------------------------------------------------------------ tmpget interface 4459: sub tmpget { 4460: my ($token,$server)=@_; 4461: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4462: my $rep=&reply("tmpget:$token",$server); 4463: my %returnhash; 4464: foreach my $item (split(/\&/,$rep)) { 4465: my ($key,$value)=split(/=/,$item); 4466: next if ($key =~ /^error: 2 /); 4467: $returnhash{&unescape($key)}=&thaw_unescape($value); 4468: } 4469: return %returnhash; 4470: } 4471: 4472: # ------------------------------------------------------------ tmpget interface 4473: sub tmpdel { 4474: my ($token,$server)=@_; 4475: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4476: return &reply("tmpdel:$token",$server); 4477: } 4478: 4479: # -------------------------------------------------- portfolio access checking 4480: 4481: sub portfolio_access { 4482: my ($requrl) = @_; 4483: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl); 4484: my $result = &get_portfolio_access($udom,$unum,$file_name,$group); 4485: if ($result) { 4486: my %setters; 4487: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4488: my ($startblock,$endblock) = 4489: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom); 4490: if ($startblock && $endblock) { 4491: return 'B'; 4492: } 4493: } else { 4494: my ($startblock,$endblock) = 4495: &Apache::loncommon::blockcheck(\%setters,'port'); 4496: if ($startblock && $endblock) { 4497: return 'B'; 4498: } 4499: } 4500: } 4501: if ($result eq 'ok') { 4502: return 'F'; 4503: } elsif ($result =~ /^[^:]+:guest_/) { 4504: return 'A'; 4505: } 4506: return ''; 4507: } 4508: 4509: sub get_portfolio_access { 4510: my ($udom,$unum,$file_name,$group,$access_hash) = @_; 4511: 4512: if (!ref($access_hash)) { 4513: my $current_perms = &get_portfile_permissions($udom,$unum); 4514: my %access_controls = &get_access_controls($current_perms,$group, 4515: $file_name); 4516: $access_hash = $access_controls{$file_name}; 4517: } 4518: 4519: my ($public,$guest,@domains,@users,@courses,@groups); 4520: my $now = time; 4521: if (ref($access_hash) eq 'HASH') { 4522: foreach my $key (keys(%{$access_hash})) { 4523: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 4524: if ($start > $now) { 4525: next; 4526: } 4527: if ($end && $end<$now) { 4528: next; 4529: } 4530: if ($scope eq 'public') { 4531: $public = $key; 4532: last; 4533: } elsif ($scope eq 'guest') { 4534: $guest = $key; 4535: } elsif ($scope eq 'domains') { 4536: push(@domains,$key); 4537: } elsif ($scope eq 'users') { 4538: push(@users,$key); 4539: } elsif ($scope eq 'course') { 4540: push(@courses,$key); 4541: } elsif ($scope eq 'group') { 4542: push(@groups,$key); 4543: } 4544: } 4545: if ($public) { 4546: return 'ok'; 4547: } 4548: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4549: if ($guest) { 4550: return $guest; 4551: } 4552: } else { 4553: if (@domains > 0) { 4554: foreach my $domkey (@domains) { 4555: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') { 4556: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) { 4557: return 'ok'; 4558: } 4559: } 4560: } 4561: } 4562: if (@users > 0) { 4563: foreach my $userkey (@users) { 4564: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') { 4565: foreach my $item (@{$access_hash->{$userkey}{'users'}}) { 4566: if (ref($item) eq 'HASH') { 4567: if (($item->{'uname'} eq $env{'user.name'}) && 4568: ($item->{'udom'} eq $env{'user.domain'})) { 4569: return 'ok'; 4570: } 4571: } 4572: } 4573: } 4574: } 4575: } 4576: my %roleshash; 4577: my @courses_and_groups = @courses; 4578: push(@courses_and_groups,@groups); 4579: if (@courses_and_groups > 0) { 4580: my (%allgroups,%allroles); 4581: my ($start,$end,$role,$sec,$group); 4582: foreach my $envkey (%env) { 4583: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) { 4584: my $cid = $2.'_'.$3; 4585: if ($1 eq 'gr') { 4586: $group = $4; 4587: $allgroups{$cid}{$group} = $env{$envkey}; 4588: } else { 4589: if ($4 eq '') { 4590: $sec = 'none'; 4591: } else { 4592: $sec = $4; 4593: } 4594: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4595: } 4596: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) { 4597: my $cid = $2.'_'.$3; 4598: if ($4 eq '') { 4599: $sec = 'none'; 4600: } else { 4601: $sec = $4; 4602: } 4603: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4604: } 4605: } 4606: if (keys(%allroles) == 0) { 4607: return; 4608: } 4609: foreach my $key (@courses_and_groups) { 4610: my %content = %{$$access_hash{$key}}; 4611: my $cnum = $content{'number'}; 4612: my $cdom = $content{'domain'}; 4613: my $cid = $cdom.'_'.$cnum; 4614: if (!exists($allroles{$cid})) { 4615: next; 4616: } 4617: foreach my $role_id (keys(%{$content{'roles'}})) { 4618: my @sections = @{$content{'roles'}{$role_id}{'section'}}; 4619: my @groups = @{$content{'roles'}{$role_id}{'group'}}; 4620: my @status = @{$content{'roles'}{$role_id}{'access'}}; 4621: my @roles = @{$content{'roles'}{$role_id}{'role'}}; 4622: foreach my $role (keys(%{$allroles{$cid}})) { 4623: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) { 4624: foreach my $sec (keys(%{$allroles{$cid}{$role}})) { 4625: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') { 4626: if (grep/^all$/,@sections) { 4627: return 'ok'; 4628: } else { 4629: if (grep/^$sec$/,@sections) { 4630: return 'ok'; 4631: } 4632: } 4633: } 4634: } 4635: if (keys(%{$allgroups{$cid}}) == 0) { 4636: if (grep/^none$/,@groups) { 4637: return 'ok'; 4638: } 4639: } else { 4640: if (grep/^all$/,@groups) { 4641: return 'ok'; 4642: } 4643: foreach my $group (keys(%{$allgroups{$cid}})) { 4644: if (grep/^$group$/,@groups) { 4645: return 'ok'; 4646: } 4647: } 4648: } 4649: } 4650: } 4651: } 4652: } 4653: } 4654: if ($guest) { 4655: return $guest; 4656: } 4657: } 4658: } 4659: return; 4660: } 4661: 4662: sub course_group_datechecker { 4663: my ($dates,$now,$status) = @_; 4664: my ($start,$end) = split(/\./,$dates); 4665: if (!$start && !$end) { 4666: return 'ok'; 4667: } 4668: if (grep/^active$/,@{$status}) { 4669: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) { 4670: return 'ok'; 4671: } 4672: } 4673: if (grep/^previous$/,@{$status}) { 4674: if ($end > $now ) { 4675: return 'ok'; 4676: } 4677: } 4678: if (grep/^future$/,@{$status}) { 4679: if ($start > $now) { 4680: return 'ok'; 4681: } 4682: } 4683: return; 4684: } 4685: 4686: sub parse_portfolio_url { 4687: my ($url) = @_; 4688: 4689: my ($type,$udom,$unum,$group,$file_name); 4690: 4691: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) { 4692: $type = 1; 4693: $udom = $1; 4694: $unum = $2; 4695: $file_name = $3; 4696: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) { 4697: $type = 2; 4698: $udom = $1; 4699: $unum = $2; 4700: $group = $3; 4701: $file_name = $3.'/'.$4; 4702: } 4703: if (wantarray) { 4704: return ($type,$udom,$unum,$file_name,$group); 4705: } 4706: return $type; 4707: } 4708: 4709: sub is_portfolio_url { 4710: my ($url) = @_; 4711: return scalar(&parse_portfolio_url($url)); 4712: } 4713: 4714: sub is_portfolio_file { 4715: my ($file) = @_; 4716: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) { 4717: return 1; 4718: } 4719: return; 4720: } 4721: 4722: sub usertools_access { 4723: my ($uname,$udom,$tool,$action,$context) = @_; 4724: my ($access,%tools); 4725: if ($context eq '') { 4726: $context = 'tools'; 4727: } 4728: if ($context eq 'requestcourses') { 4729: %tools = ( 4730: official => 1, 4731: unofficial => 1, 4732: community => 1, 4733: ); 4734: } else { 4735: %tools = ( 4736: aboutme => 1, 4737: blog => 1, 4738: portfolio => 1, 4739: ); 4740: } 4741: return if (!defined($tools{$tool})); 4742: 4743: if ((!defined($udom)) || (!defined($uname))) { 4744: $udom = $env{'user.domain'}; 4745: $uname = $env{'user.name'}; 4746: } 4747: 4748: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 4749: if ($action ne 'reload') { 4750: if ($context eq 'requestcourses') { 4751: return $env{'environment.canrequest.'.$tool}; 4752: } else { 4753: return $env{'environment.availabletools.'.$tool}; 4754: } 4755: } 4756: } 4757: 4758: my ($toolstatus,$inststatus); 4759: 4760: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) && 4761: ($action ne 'reload')) { 4762: $toolstatus = $env{'environment.'.$context.'.'.$tool}; 4763: $inststatus = $env{'environment.inststatus'}; 4764: } else { 4765: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus'); 4766: $toolstatus = $userenv{$context.'.'.$tool}; 4767: $inststatus = $userenv{'inststatus'}; 4768: } 4769: 4770: if ($toolstatus ne '') { 4771: if ($toolstatus) { 4772: $access = 1; 4773: } else { 4774: $access = 0; 4775: } 4776: return $access; 4777: } 4778: 4779: my $is_adv = &is_advanced_user($udom,$uname); 4780: my %domdef = &get_domain_defaults($udom); 4781: if (ref($domdef{$tool}) eq 'HASH') { 4782: if ($is_adv) { 4783: if ($domdef{$tool}{'_LC_adv'} ne '') { 4784: if ($domdef{$tool}{'_LC_adv'}) { 4785: $access = 1; 4786: } else { 4787: $access = 0; 4788: } 4789: return $access; 4790: } 4791: } 4792: if ($inststatus ne '') { 4793: my ($hasaccess,$hasnoaccess); 4794: foreach my $affiliation (split(/:/,$inststatus)) { 4795: if ($domdef{$tool}{$affiliation} ne '') { 4796: if ($domdef{$tool}{$affiliation}) { 4797: $hasaccess = 1; 4798: } else { 4799: $hasnoaccess = 1; 4800: } 4801: } 4802: } 4803: if ($hasaccess || $hasnoaccess) { 4804: if ($hasaccess) { 4805: $access = 1; 4806: } elsif ($hasnoaccess) { 4807: $access = 0; 4808: } 4809: return $access; 4810: } 4811: } else { 4812: if ($domdef{$tool}{'default'} ne '') { 4813: if ($domdef{$tool}{'default'}) { 4814: $access = 1; 4815: } elsif ($domdef{$tool}{'default'} == 0) { 4816: $access = 0; 4817: } 4818: return $access; 4819: } 4820: } 4821: } else { 4822: if ($context eq 'tools') { 4823: $access = 1; 4824: } else { 4825: $access = 0; 4826: } 4827: return $access; 4828: } 4829: } 4830: 4831: sub is_course_owner { 4832: my ($cdom,$cnum,$udom,$uname) = @_; 4833: if (($udom eq '') || ($uname eq '')) { 4834: $udom = $env{'user.domain'}; 4835: $uname = $env{'user.name'}; 4836: } 4837: unless (($udom eq '') || ($uname eq '')) { 4838: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) { 4839: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) { 4840: return 1; 4841: } else { 4842: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum); 4843: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) { 4844: return 1; 4845: } 4846: } 4847: } 4848: } 4849: return; 4850: } 4851: 4852: sub is_advanced_user { 4853: my ($udom,$uname) = @_; 4854: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1); 4855: my %allroles; 4856: my $is_adv; 4857: foreach my $role (keys(%roleshash)) { 4858: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role); 4859: my $area = '/'.$tdomain.'/'.$trest; 4860: if ($sec ne '') { 4861: $area .= '/'.$sec; 4862: } 4863: if (($area ne '') && ($trole ne '')) { 4864: my $spec=$trole.'.'.$area; 4865: if ($trole =~ /^cr\//) { 4866: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 4867: } elsif ($trole ne 'gr') { 4868: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 4869: } 4870: } 4871: } 4872: foreach my $role (keys(%allroles)) { 4873: last if ($is_adv); 4874: foreach my $item (split(/:/,$allroles{$role})) { 4875: if ($item ne '') { 4876: my ($privilege,$restrictions)=split(/&/,$item); 4877: if ($privilege eq 'adv') { 4878: $is_adv = 1; 4879: last; 4880: } 4881: } 4882: } 4883: } 4884: return $is_adv; 4885: } 4886: 4887: sub check_can_request { 4888: my ($dom,$can_request,$request_domains) = @_; 4889: my $canreq = 0; 4890: my ($types,$typename) = &Apache::loncommon::course_types(); 4891: my @options = ('approval','validate','autolimit'); 4892: my $optregex = join('|',@options); 4893: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) { 4894: foreach my $type (@{$types}) { 4895: if (&usertools_access($env{'user.name'}, 4896: $env{'user.domain'}, 4897: $type,undef,'requestcourses')) { 4898: $canreq ++; 4899: if (ref($request_domains) eq 'HASH') { 4900: push(@{$request_domains->{$type}},$env{'user.domain'}); 4901: } 4902: if ($dom eq $env{'user.domain'}) { 4903: $can_request->{$type} = 1; 4904: } 4905: } 4906: if ($env{'environment.reqcrsotherdom.'.$type} ne '') { 4907: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type}); 4908: if (@curr > 0) { 4909: foreach my $item (@curr) { 4910: if (ref($request_domains) eq 'HASH') { 4911: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/); 4912: if ($otherdom ne '') { 4913: if (ref($request_domains->{$type}) eq 'ARRAY') { 4914: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) { 4915: push(@{$request_domains->{$type}},$otherdom); 4916: } 4917: } else { 4918: push(@{$request_domains->{$type}},$otherdom); 4919: } 4920: } 4921: } 4922: } 4923: unless($dom eq $env{'user.domain'}) { 4924: $canreq ++; 4925: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) { 4926: $can_request->{$type} = 1; 4927: } 4928: } 4929: } 4930: } 4931: } 4932: } 4933: return $canreq; 4934: } 4935: 4936: # ---------------------------------------------- Custom access rule evaluation 4937: 4938: sub customaccess { 4939: my ($priv,$uri)=@_; 4940: my ($urole,$urealm)=split(/\./,$env{'request.role'},2); 4941: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm); 4942: $udom = &LONCAPA::clean_domain($udom); 4943: $ucrs = &LONCAPA::clean_username($ucrs); 4944: my $access=0; 4945: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) { 4946: my ($effect,$realm,$role,$type)=split(/\:/,$right); 4947: if ($type eq 'user') { 4948: foreach my $scope (split(/\s*\,\s*/,$realm)) { 4949: my ($tdom,$tuname)=split(m{/},$scope); 4950: if ($tdom) { 4951: if ($tdom ne $env{'user.domain'}) { next; } 4952: } 4953: if ($tuname) { 4954: if ($tuname ne $env{'user.name'}) { next; } 4955: } 4956: $access=($effect eq 'allow'); 4957: last; 4958: } 4959: } else { 4960: if ($role) { 4961: if ($role ne $urole) { next; } 4962: } 4963: foreach my $scope (split(/\s*\,\s*/,$realm)) { 4964: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope); 4965: if ($tdom) { 4966: if ($tdom ne $udom) { next; } 4967: } 4968: if ($tcrs) { 4969: if ($tcrs ne $ucrs) { next; } 4970: } 4971: if ($tsec) { 4972: if ($tsec ne $usec) { next; } 4973: } 4974: $access=($effect eq 'allow'); 4975: last; 4976: } 4977: if ($realm eq '' && $role eq '') { 4978: $access=($effect eq 'allow'); 4979: } 4980: } 4981: } 4982: return $access; 4983: } 4984: 4985: # ------------------------------------------------- Check for a user privilege 4986: 4987: sub allowed { 4988: my ($priv,$uri,$symb,$role)=@_; 4989: my $ver_orguri=$uri; 4990: $uri=&deversion($uri); 4991: my $orguri=$uri; 4992: $uri=&declutter($uri); 4993: 4994: if ($priv eq 'evb') { 4995: # Evade communication block restrictions for specified role in a course 4996: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) { 4997: return $1; 4998: } else { 4999: return; 5000: } 5001: } 5002: 5003: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; } 5004: # Free bre access to adm and meta resources 5005: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$})) 5006: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 5007: && ($priv eq 'bre')) { 5008: return 'F'; 5009: } 5010: 5011: # Free bre access to user's own portfolio contents 5012: my ($space,$domain,$name,@dir)=split('/',$uri); 5013: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 5014: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) { 5015: my %setters; 5016: my ($startblock,$endblock) = 5017: &Apache::loncommon::blockcheck(\%setters,'port'); 5018: if ($startblock && $endblock) { 5019: return 'B'; 5020: } else { 5021: return 'F'; 5022: } 5023: } 5024: 5025: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course. 5026: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 5027: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) { 5028: if (exists($env{'request.course.id'})) { 5029: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 5030: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 5031: if (($domain eq $cdom) && ($name eq $cnum)) { 5032: my $courseprivid=$env{'request.course.id'}; 5033: $courseprivid=~s/\_/\//; 5034: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid 5035: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) { 5036: return $1; 5037: } else { 5038: if ($env{'request.course.sec'}) { 5039: $courseprivid.='/'.$env{'request.course.sec'}; 5040: } 5041: if ($env{'user.priv.'.$env{'request.role'}.'./'. 5042: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) { 5043: return $2; 5044: } 5045: } 5046: } 5047: } 5048: } 5049: 5050: # Free bre to public access 5051: 5052: if ($priv eq 'bre') { 5053: my $copyright=&metadata($uri,'copyright'); 5054: if (($copyright eq 'public') && (!$env{'request.course.id'})) { 5055: return 'F'; 5056: } 5057: if ($copyright eq 'priv') { 5058: $uri=~/([^\/]+)\/([^\/]+)\//; 5059: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) { 5060: return ''; 5061: } 5062: } 5063: if ($copyright eq 'domain') { 5064: $uri=~/([^\/]+)\/([^\/]+)\//; 5065: unless (($env{'user.domain'} eq $1) || 5066: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) { 5067: return ''; 5068: } 5069: } 5070: if ($env{'request.role'}=~ /li\.\//) { 5071: # Library role, so allow browsing of resources in this domain. 5072: return 'F'; 5073: } 5074: if ($copyright eq 'custom') { 5075: unless (&customaccess($priv,$uri)) { return ''; } 5076: } 5077: } 5078: # Domain coordinator is trying to create a course 5079: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) { 5080: # uri is the requested domain in this case. 5081: # comparison to 'request.role.domain' shows if the user has selected 5082: # a role of dc for the domain in question. 5083: return 'F' if ($uri eq $env{'request.role.domain'}); 5084: } 5085: 5086: my $thisallowed=''; 5087: my $statecond=0; 5088: my $courseprivid=''; 5089: 5090: my $ownaccess; 5091: # Community Coordinator or Assistant Co-author browsing resource space. 5092: if (($priv eq 'bro') && ($env{'user.author'})) { 5093: if ($uri eq '') { 5094: $ownaccess = 1; 5095: } else { 5096: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) { 5097: my $udom = $env{'user.domain'}; 5098: my $uname = $env{'user.name'}; 5099: if ($uri =~ m{^\Q$udom\E/?$}) { 5100: $ownaccess = 1; 5101: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) { 5102: unless ($uri =~ m{\.\./}) { 5103: $ownaccess = 1; 5104: } 5105: } elsif (($udom ne 'public') && ($uname ne 'public')) { 5106: my $now = time; 5107: if ($uri =~ m{^([^/]+)/?$}) { 5108: my $adom = $1; 5109: foreach my $key (keys(%env)) { 5110: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) { 5111: my ($start,$end) = split('.',$env{$key}); 5112: if (($now >= $start) && (!$end || $end < $now)) { 5113: $ownaccess = 1; 5114: last; 5115: } 5116: } 5117: } 5118: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) { 5119: my $adom = $1; 5120: my $aname = $2; 5121: foreach my $role ('ca','aa') { 5122: if ($env{"user.role.$role./$adom/$aname"}) { 5123: my ($start,$end) = 5124: split('.',$env{"user.role.$role./$adom/$aname"}); 5125: if (($now >= $start) && (!$end || $end < $now)) { 5126: $ownaccess = 1; 5127: last; 5128: } 5129: } 5130: } 5131: } 5132: } 5133: } 5134: } 5135: } 5136: 5137: # Course 5138: 5139: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) { 5140: unless (($priv eq 'bro') && (!$ownaccess)) { 5141: $thisallowed.=$1; 5142: } 5143: } 5144: 5145: # Domain 5146: 5147: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'} 5148: =~/\Q$priv\E\&([^\:]*)/) { 5149: unless (($priv eq 'bro') && (!$ownaccess)) { 5150: $thisallowed.=$1; 5151: } 5152: } 5153: 5154: # Course: uri itself is a course 5155: my $courseuri=$uri; 5156: $courseuri=~s/\_(\d)/\/$1/; 5157: $courseuri=~s/^([^\/])/\/$1/; 5158: 5159: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri} 5160: =~/\Q$priv\E\&([^\:]*)/) { 5161: unless (($priv eq 'bro') && (!$ownaccess)) { 5162: $thisallowed.=$1; 5163: } 5164: } 5165: 5166: # URI is an uploaded document for this course, default permissions don't matter 5167: # not allowing 'edit' access (editupload) to uploaded course docs 5168: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) { 5169: $thisallowed=''; 5170: my ($match)=&is_on_map($uri); 5171: if ($match) { 5172: if ($env{'user.priv.'.$env{'request.role'}.'./'} 5173: =~/\Q$priv\E\&([^\:]*)/) { 5174: $thisallowed.=$1; 5175: } 5176: } else { 5177: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri}; 5178: if ($refuri) { 5179: if ($refuri =~ m|^/adm/|) { 5180: $thisallowed='F'; 5181: } else { 5182: $refuri=&declutter($refuri); 5183: my ($match) = &is_on_map($refuri); 5184: if ($match) { 5185: $thisallowed='F'; 5186: } 5187: } 5188: } 5189: } 5190: } 5191: 5192: if ($priv eq 'bre' 5193: && $thisallowed ne 'F' 5194: && $thisallowed ne '2' 5195: && &is_portfolio_url($uri)) { 5196: $thisallowed = &portfolio_access($uri); 5197: } 5198: 5199: # Full access at system, domain or course-wide level? Exit. 5200: if ($thisallowed=~/F/) { 5201: return 'F'; 5202: } 5203: 5204: # If this is generating or modifying users, exit with special codes 5205: 5206: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) { 5207: if (($priv eq 'cca') || ($priv eq 'caa')) { 5208: my ($audom,$auname)=split('/',$uri); 5209: # no author name given, so this just checks on the general right to make a co-author in this domain 5210: unless ($auname) { return $thisallowed; } 5211: # an author name is given, so we are about to actually make a co-author for a certain account 5212: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) || 5213: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) && 5214: ($audom ne $env{'request.role.domain'}))) { return ''; } 5215: } 5216: return $thisallowed; 5217: } 5218: # 5219: # Gathered so far: system, domain and course wide privileges 5220: # 5221: # Course: See if uri or referer is an individual resource that is part of 5222: # the course 5223: 5224: if ($env{'request.course.id'}) { 5225: 5226: $courseprivid=$env{'request.course.id'}; 5227: if ($env{'request.course.sec'}) { 5228: $courseprivid.='/'.$env{'request.course.sec'}; 5229: } 5230: $courseprivid=~s/\_/\//; 5231: my $checkreferer=1; 5232: my ($match,$cond)=&is_on_map($uri); 5233: if ($match) { 5234: $statecond=$cond; 5235: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5236: =~/\Q$priv\E\&([^\:]*)/) { 5237: $thisallowed.=$1; 5238: $checkreferer=0; 5239: } 5240: } 5241: 5242: if ($checkreferer) { 5243: my $refuri=$env{'httpref.'.$orguri}; 5244: unless ($refuri) { 5245: foreach my $key (keys(%env)) { 5246: if ($key=~/^httpref\..*\*/) { 5247: my $pattern=$key; 5248: $pattern=~s/^httpref\.\/res\///; 5249: $pattern=~s/\*/\[\^\/\]\+/g; 5250: $pattern=~s/\//\\\//g; 5251: if ($orguri=~/$pattern/) { 5252: $refuri=$env{$key}; 5253: } 5254: } 5255: } 5256: } 5257: 5258: if ($refuri) { 5259: $refuri=&declutter($refuri); 5260: my ($match,$cond)=&is_on_map($refuri); 5261: if ($match) { 5262: my $refstatecond=$cond; 5263: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5264: =~/\Q$priv\E\&([^\:]*)/) { 5265: $thisallowed.=$1; 5266: $uri=$refuri; 5267: $statecond=$refstatecond; 5268: } 5269: } 5270: } 5271: } 5272: } 5273: 5274: # 5275: # Gathered now: all privileges that could apply, and condition number 5276: # 5277: # 5278: # Full or no access? 5279: # 5280: 5281: if ($thisallowed=~/F/) { 5282: return 'F'; 5283: } 5284: 5285: unless ($thisallowed) { 5286: return ''; 5287: } 5288: 5289: # Restrictions exist, deal with them 5290: # 5291: # C:according to course preferences 5292: # R:according to resource settings 5293: # L:unless locked 5294: # X:according to user session state 5295: # 5296: 5297: # Possibly locked functionality, check all courses 5298: # Locks might take effect only after 10 minutes cache expiration for other 5299: # courses, and 2 minutes for current course 5300: 5301: my $envkey; 5302: if ($thisallowed=~/L/) { 5303: foreach $envkey (keys(%env)) { 5304: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) { 5305: my $courseid=$2; 5306: my $roleid=$1.'.'.$2; 5307: $courseid=~s/^\///; 5308: my $expiretime=600; 5309: if ($env{'request.role'} eq $roleid) { 5310: $expiretime=120; 5311: } 5312: my ($cdom,$cnum,$csec)=split(/\//,$courseid); 5313: my $prefix='course.'.$cdom.'_'.$cnum.'.'; 5314: if ((time-$env{$prefix.'last_cache'})>$expiretime) { 5315: &coursedescription($courseid,{'freshen_cache' => 1}); 5316: } 5317: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/) 5318: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) { 5319: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) { 5320: &log($env{'user.domain'},$env{'user.name'}, 5321: $env{'user.home'}, 5322: 'Locked by res: '.$priv.' for '.$uri.' due to '. 5323: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5324: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5325: return ''; 5326: } 5327: } 5328: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/) 5329: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) { 5330: if ($env{'priv.'.$priv.'.lock.expire'}>time) { 5331: &log($env{'user.domain'},$env{'user.name'}, 5332: $env{'user.home'}, 5333: 'Locked by priv: '.$priv.' for '.$uri.' due to '. 5334: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5335: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5336: return ''; 5337: } 5338: } 5339: } 5340: } 5341: } 5342: 5343: # 5344: # Rest of the restrictions depend on selected course 5345: # 5346: 5347: unless ($env{'request.course.id'}) { 5348: if ($thisallowed eq 'A') { 5349: return 'A'; 5350: } elsif ($thisallowed eq 'B') { 5351: return 'B'; 5352: } else { 5353: return '1'; 5354: } 5355: } 5356: 5357: # 5358: # Now user is definitely in a course 5359: # 5360: 5361: 5362: # Course preferences 5363: 5364: if ($thisallowed=~/C/) { 5365: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5366: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'}; 5367: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'} 5368: =~/\Q$rolecode\E/) { 5369: if ($priv ne 'pch') { 5370: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5371: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '. 5372: $env{'request.course.id'}); 5373: } 5374: return ''; 5375: } 5376: 5377: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'} 5378: =~/\Q$unamedom\E/) { 5379: if ($priv ne 'pch') { 5380: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}. 5381: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '. 5382: $env{'request.course.id'}); 5383: } 5384: return ''; 5385: } 5386: } 5387: 5388: # Resource preferences 5389: 5390: if ($thisallowed=~/R/) { 5391: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5392: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) { 5393: if ($priv ne 'pch') { 5394: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5395: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode); 5396: } 5397: return ''; 5398: } 5399: } 5400: 5401: # Restricted by state or randomout? 5402: 5403: if ($thisallowed=~/X/) { 5404: if ($env{'acc.randomout'}) { 5405: if (!$symb) { $symb=&symbread($uri,1); } 5406: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 5407: return ''; 5408: } 5409: } 5410: if (&condval($statecond)) { 5411: return '2'; 5412: } else { 5413: return ''; 5414: } 5415: } 5416: 5417: if ($thisallowed eq 'A') { 5418: return 'A'; 5419: } elsif ($thisallowed eq 'B') { 5420: return 'B'; 5421: } 5422: return 'F'; 5423: } 5424: 5425: sub split_uri_for_cond { 5426: my $uri=&deversion(&declutter(shift)); 5427: my @uriparts=split(/\//,$uri); 5428: my $filename=pop(@uriparts); 5429: my $pathname=join('/',@uriparts); 5430: return ($pathname,$filename); 5431: } 5432: # --------------------------------------------------- Is a resource on the map? 5433: 5434: sub is_on_map { 5435: my ($pathname,$filename) = &split_uri_for_cond(shift); 5436: #Trying to find the conditional for the file 5437: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~ 5438: /\&\Q$filename\E\:([\d\|]+)\&/); 5439: if ($match) { 5440: return (1,$1); 5441: } else { 5442: return (0,0); 5443: } 5444: } 5445: 5446: # --------------------------------------------------------- Get symb from alias 5447: 5448: sub get_symb_from_alias { 5449: my $symb=shift; 5450: my ($map,$resid,$url)=&decode_symb($symb); 5451: # Already is a symb 5452: if ($url) { return $symb; } 5453: # Must be an alias 5454: my $aliassymb=''; 5455: my %bighash; 5456: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 5457: &GDBM_READER(),0640)) { 5458: my $rid=$bighash{'mapalias_'.$symb}; 5459: if ($rid) { 5460: my ($mapid,$resid)=split(/\./,$rid); 5461: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid}, 5462: $resid,$bighash{'src_'.$rid}); 5463: } 5464: untie %bighash; 5465: } 5466: return $aliassymb; 5467: } 5468: 5469: # ----------------------------------------------------------------- Define Role 5470: 5471: sub definerole { 5472: if (allowed('mcr','/')) { 5473: my ($rolename,$sysrole,$domrole,$courole)=@_; 5474: foreach my $role (split(':',$sysrole)) { 5475: my ($crole,$cqual)=split(/\&/,$role); 5476: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; } 5477: if ($pr{'cr:s'}=~/\Q$crole\E\&/) { 5478: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5479: return "refused:s:$crole&$cqual"; 5480: } 5481: } 5482: } 5483: foreach my $role (split(':',$domrole)) { 5484: my ($crole,$cqual)=split(/\&/,$role); 5485: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; } 5486: if ($pr{'cr:d'}=~/\Q$crole\E\&/) { 5487: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 5488: return "refused:d:$crole&$cqual"; 5489: } 5490: } 5491: } 5492: foreach my $role (split(':',$courole)) { 5493: my ($crole,$cqual)=split(/\&/,$role); 5494: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; } 5495: if ($pr{'cr:c'}=~/\Q$crole\E\&/) { 5496: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5497: return "refused:c:$crole&$cqual"; 5498: } 5499: } 5500: } 5501: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 5502: "$env{'user.domain'}:$env{'user.name'}:". 5503: "rolesdef_$rolename=". 5504: escape($sysrole.'_'.$domrole.'_'.$courole); 5505: return reply($command,$env{'user.home'}); 5506: } else { 5507: return 'refused'; 5508: } 5509: } 5510: 5511: # ---------------- Make a metadata query against the network of library servers 5512: 5513: sub metadata_query { 5514: my ($query,$custom,$customshow,$server_array)=@_; 5515: my %rhash; 5516: my %libserv = &all_library(); 5517: my @server_list = (defined($server_array) ? @$server_array 5518: : keys(%libserv) ); 5519: for my $server (@server_list) { 5520: unless ($custom or $customshow) { 5521: my $reply=&reply("querysend:".&escape($query),$server); 5522: $rhash{$server}=$reply; 5523: } 5524: else { 5525: my $reply=&reply("querysend:".&escape($query).':'. 5526: &escape($custom).':'.&escape($customshow), 5527: $server); 5528: $rhash{$server}=$reply; 5529: } 5530: } 5531: return \%rhash; 5532: } 5533: 5534: # ----------------------------------------- Send log queries and wait for reply 5535: 5536: sub log_query { 5537: my ($uname,$udom,$query,%filters)=@_; 5538: my $uhome=&homeserver($uname,$udom); 5539: if ($uhome eq 'no_host') { return 'error: no_host'; } 5540: my $uhost=&hostname($uhome); 5541: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters))); 5542: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command, 5543: $uhome); 5544: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; } 5545: return get_query_reply($queryid); 5546: } 5547: 5548: # -------------------------- Update MySQL table for portfolio file 5549: 5550: sub update_portfolio_table { 5551: my ($uname,$udom,$file_name,$query,$group,$action) = @_; 5552: if ($group ne '') { 5553: $file_name =~s /^\Q$group\E//; 5554: } 5555: my $homeserver = &homeserver($uname,$udom); 5556: my $queryid= 5557: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group). 5558: ':'.&escape($file_name).':'.$action,$homeserver); 5559: my $reply = &get_query_reply($queryid); 5560: return $reply; 5561: } 5562: 5563: # -------------------------- Update MySQL allusers table 5564: 5565: sub update_allusers_table { 5566: my ($uname,$udom,$names) = @_; 5567: my $homeserver = &homeserver($uname,$udom); 5568: my $queryid= 5569: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'. 5570: 'lastname='.&escape($names->{'lastname'}).'%%'. 5571: 'firstname='.&escape($names->{'firstname'}).'%%'. 5572: 'middlename='.&escape($names->{'middlename'}).'%%'. 5573: 'generation='.&escape($names->{'generation'}).'%%'. 5574: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'. 5575: 'id='.&escape($names->{'id'}),$homeserver); 5576: my $reply = &get_query_reply($queryid); 5577: return $reply; 5578: } 5579: 5580: # ------- Request retrieval of institutional classlists for course(s) 5581: 5582: sub fetch_enrollment_query { 5583: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_; 5584: my $homeserver; 5585: my $maxtries = 1; 5586: if ($context eq 'automated') { 5587: $homeserver = $perlvar{'lonHostID'}; 5588: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout 5589: } else { 5590: $homeserver = &homeserver($cnum,$dom); 5591: } 5592: my $host=&hostname($homeserver); 5593: my $cmd = ''; 5594: foreach my $affiliate (keys(%{$affiliatesref})) { 5595: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 5596: } 5597: $cmd =~ s/%%$//; 5598: $cmd = &escape($cmd); 5599: my $query = 'fetchenrollment'; 5600: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver); 5601: unless ($queryid=~/^\Q$host\E\_/) { 5602: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 5603: return 'error: '.$queryid; 5604: } 5605: my $reply = &get_query_reply($queryid); 5606: my $tries = 1; 5607: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 5608: $reply = &get_query_reply($queryid); 5609: $tries ++; 5610: } 5611: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 5612: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 5613: } else { 5614: my @responses = split(/:/,$reply); 5615: if ($homeserver eq $perlvar{'lonHostID'}) { 5616: foreach my $line (@responses) { 5617: my ($key,$value) = split(/=/,$line,2); 5618: $$replyref{$key} = $value; 5619: } 5620: } else { 5621: my $pathname = $perlvar{'lonDaemons'}.'/tmp'; 5622: foreach my $line (@responses) { 5623: my ($key,$value) = split(/=/,$line); 5624: $$replyref{$key} = $value; 5625: if ($value > 0) { 5626: foreach my $item (@{$$affiliatesref{$key}}) { 5627: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml'; 5628: my $destname = $pathname.'/'.$filename; 5629: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver); 5630: if ($xml_classlist =~ /^error/) { 5631: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum); 5632: } else { 5633: if ( open(FILE,">$destname") ) { 5634: print FILE &unescape($xml_classlist); 5635: close(FILE); 5636: } else { 5637: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum); 5638: } 5639: } 5640: } 5641: } 5642: } 5643: } 5644: return 'ok'; 5645: } 5646: return 'error'; 5647: } 5648: 5649: sub get_query_reply { 5650: my $queryid=shift; 5651: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid; 5652: my $reply=''; 5653: for (1..100) { 5654: sleep 2; 5655: if (-e $replyfile.'.end') { 5656: if (open(my $fh,$replyfile)) { 5657: $reply = join('',<$fh>); 5658: close($fh); 5659: } else { return 'error: reply_file_error'; } 5660: return &unescape($reply); 5661: } 5662: } 5663: return 'timeout:'.$queryid; 5664: } 5665: 5666: sub courselog_query { 5667: # 5668: # possible filters: 5669: # url: url or symb 5670: # username 5671: # domain 5672: # action: view, submit, grade 5673: # start: timestamp 5674: # end: timestamp 5675: # 5676: my (%filters)=@_; 5677: unless ($env{'request.course.id'}) { return 'no_course'; } 5678: if ($filters{'url'}) { 5679: $filters{'url'}=&symbclean(&declutter($filters{'url'})); 5680: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/; 5681: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/; 5682: } 5683: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'}; 5684: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 5685: return &log_query($cname,$cdom,'courselog',%filters); 5686: } 5687: 5688: sub userlog_query { 5689: # 5690: # possible filters: 5691: # action: log check role 5692: # start: timestamp 5693: # end: timestamp 5694: # 5695: my ($uname,$udom,%filters)=@_; 5696: return &log_query($uname,$udom,'userlog',%filters); 5697: } 5698: 5699: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 5700: 5701: sub auto_run { 5702: my ($cnum,$cdom) = @_; 5703: my $response = 0; 5704: my $settings; 5705: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom); 5706: if (ref($domconfig{'autoenroll'}) eq 'HASH') { 5707: $settings = $domconfig{'autoenroll'}; 5708: if ($settings->{'run'} eq '1') { 5709: $response = 1; 5710: } 5711: } else { 5712: my $homeserver; 5713: if (&is_course($cdom,$cnum)) { 5714: $homeserver = &homeserver($cnum,$cdom); 5715: } else { 5716: $homeserver = &domain($cdom,'primary'); 5717: } 5718: if ($homeserver ne 'no_host') { 5719: $response = &reply('autorun:'.$cdom,$homeserver); 5720: } 5721: } 5722: return $response; 5723: } 5724: 5725: sub auto_get_sections { 5726: my ($cnum,$cdom,$inst_coursecode) = @_; 5727: my $homeserver; 5728: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 5729: $homeserver = &homeserver($cnum,$cdom); 5730: } 5731: if (!defined($homeserver)) { 5732: if ($cdom =~ /^$match_domain$/) { 5733: $homeserver = &domain($cdom,'primary'); 5734: } 5735: } 5736: my @secs; 5737: if (defined($homeserver)) { 5738: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver)); 5739: unless ($response eq 'refused') { 5740: @secs = split(/:/,$response); 5741: } 5742: } 5743: return @secs; 5744: } 5745: 5746: sub auto_new_course { 5747: my ($cnum,$cdom,$inst_course_id,$owner) = @_; 5748: my $homeserver = &homeserver($cnum,$cdom); 5749: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver)); 5750: return $response; 5751: } 5752: 5753: sub auto_validate_courseID { 5754: my ($cnum,$cdom,$inst_course_id) = @_; 5755: my $homeserver = &homeserver($cnum,$cdom); 5756: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver)); 5757: return $response; 5758: } 5759: 5760: sub auto_validate_instcode { 5761: my ($cnum,$cdom,$instcode,$owner) = @_; 5762: my ($homeserver,$response); 5763: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 5764: $homeserver = &homeserver($cnum,$cdom); 5765: } 5766: if (!defined($homeserver)) { 5767: if ($cdom =~ /^$match_domain$/) { 5768: $homeserver = &domain($cdom,'primary'); 5769: } 5770: } 5771: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'. 5772: &escape($instcode).':'.&escape($owner),$homeserver)); 5773: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2); 5774: return ($outcome,$description); 5775: } 5776: 5777: sub auto_create_password { 5778: my ($cnum,$cdom,$authparam,$udom) = @_; 5779: my ($homeserver,$response); 5780: my $create_passwd = 0; 5781: my $authchk = ''; 5782: if ($udom =~ /^$match_domain$/) { 5783: $homeserver = &domain($udom,'primary'); 5784: } 5785: if ($homeserver eq '') { 5786: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 5787: $homeserver = &homeserver($cnum,$cdom); 5788: } 5789: } 5790: if ($homeserver eq '') { 5791: $authchk = 'nodomain'; 5792: } else { 5793: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver)); 5794: if ($response eq 'refused') { 5795: $authchk = 'refused'; 5796: } else { 5797: ($authparam,$create_passwd,$authchk) = split(/:/,$response); 5798: } 5799: } 5800: return ($authparam,$create_passwd,$authchk); 5801: } 5802: 5803: sub auto_photo_permission { 5804: my ($cnum,$cdom,$students) = @_; 5805: my $homeserver = &homeserver($cnum,$cdom); 5806: my ($outcome,$perm_reqd,$conditions) = 5807: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3); 5808: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 5809: return (undef,undef); 5810: } 5811: return ($outcome,$perm_reqd,$conditions); 5812: } 5813: 5814: sub auto_checkphotos { 5815: my ($uname,$udom,$pid) = @_; 5816: my $homeserver = &homeserver($uname,$udom); 5817: my ($result,$resulttype); 5818: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'. 5819: &escape($uname).':'.&escape($pid), 5820: $homeserver)); 5821: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 5822: return (undef,undef); 5823: } 5824: if ($outcome) { 5825: ($result,$resulttype) = split(/:/,$outcome); 5826: } 5827: return ($result,$resulttype); 5828: } 5829: 5830: sub auto_photochoice { 5831: my ($cnum,$cdom) = @_; 5832: my $homeserver = &homeserver($cnum,$cdom); 5833: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'. 5834: &escape($cdom), 5835: $homeserver))); 5836: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 5837: return (undef,undef); 5838: } 5839: return ($update,$comment); 5840: } 5841: 5842: sub auto_photoupdate { 5843: my ($affiliatesref,$dom,$cnum,$photo) = @_; 5844: my $homeserver = &homeserver($cnum,$dom); 5845: my $host=&hostname($homeserver); 5846: my $cmd = ''; 5847: my $maxtries = 1; 5848: foreach my $affiliate (keys(%{$affiliatesref})) { 5849: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 5850: } 5851: $cmd =~ s/%%$//; 5852: $cmd = &escape($cmd); 5853: my $query = 'institutionalphotos'; 5854: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver); 5855: unless ($queryid=~/^\Q$host\E\_/) { 5856: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum); 5857: return 'error: '.$queryid; 5858: } 5859: my $reply = &get_query_reply($queryid); 5860: my $tries = 1; 5861: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 5862: $reply = &get_query_reply($queryid); 5863: $tries ++; 5864: } 5865: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 5866: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 5867: } else { 5868: my @responses = split(/:/,$reply); 5869: my $outcome = shift(@responses); 5870: foreach my $item (@responses) { 5871: my ($key,$value) = split(/=/,$item); 5872: $$photo{$key} = $value; 5873: } 5874: return $outcome; 5875: } 5876: return 'error'; 5877: } 5878: 5879: sub auto_instcode_format { 5880: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles, 5881: $cat_order) = @_; 5882: my $courses = ''; 5883: my @homeservers; 5884: if ($caller eq 'global') { 5885: my %servers = &get_servers($codedom,'library'); 5886: foreach my $tryserver (keys(%servers)) { 5887: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 5888: push(@homeservers,$tryserver); 5889: } 5890: } 5891: } elsif ($caller eq 'requests') { 5892: if ($codedom =~ /^$match_domain$/) { 5893: my $chome = &domain($codedom,'primary'); 5894: unless ($chome eq 'no_host') { 5895: push(@homeservers,$chome); 5896: } 5897: } 5898: } else { 5899: push(@homeservers,&homeserver($caller,$codedom)); 5900: } 5901: foreach my $code (keys(%{$instcodes})) { 5902: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&'; 5903: } 5904: chop($courses); 5905: my $ok_response = 0; 5906: my $response; 5907: while (@homeservers > 0 && $ok_response == 0) { 5908: my $server = shift(@homeservers); 5909: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server); 5910: if ($response !~ /(con_lost|error|no_such_host|refused)/) { 5911: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 5912: split(/:/,$response); 5913: %{$codes} = (%{$codes},&str2hash($codes_str)); 5914: push(@{$codetitles},&str2array($codetitles_str)); 5915: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str)); 5916: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str)); 5917: $ok_response = 1; 5918: } 5919: } 5920: if ($ok_response) { 5921: return 'ok'; 5922: } else { 5923: return $response; 5924: } 5925: } 5926: 5927: sub auto_instcode_defaults { 5928: my ($domain,$returnhash,$code_order) = @_; 5929: my @homeservers; 5930: 5931: my %servers = &get_servers($domain,'library'); 5932: foreach my $tryserver (keys(%servers)) { 5933: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 5934: push(@homeservers,$tryserver); 5935: } 5936: } 5937: 5938: my $response; 5939: foreach my $server (@homeservers) { 5940: $response=&reply('autoinstcodedefaults:'.$domain,$server); 5941: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 5942: 5943: foreach my $pair (split(/\&/,$response)) { 5944: my ($name,$value)=split(/\=/,$pair); 5945: if ($name eq 'code_order') { 5946: @{$code_order} = split(/\&/,&unescape($value)); 5947: } else { 5948: $returnhash->{&unescape($name)}=&unescape($value); 5949: } 5950: } 5951: return 'ok'; 5952: } 5953: 5954: return $response; 5955: } 5956: 5957: sub auto_possible_instcodes { 5958: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_; 5959: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 5960: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) { 5961: return; 5962: } 5963: my (@homeservers,$uhome); 5964: if (defined(&domain($domain,'primary'))) { 5965: $uhome=&domain($domain,'primary'); 5966: push(@homeservers,&domain($domain,'primary')); 5967: } else { 5968: my %servers = &get_servers($domain,'library'); 5969: foreach my $tryserver (keys(%servers)) { 5970: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 5971: push(@homeservers,$tryserver); 5972: } 5973: } 5974: } 5975: my $response; 5976: foreach my $server (@homeservers) { 5977: $response=&reply('autopossibleinstcodes:'.$domain,$server); 5978: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 5979: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 5980: split(':',$response); 5981: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr)); 5982: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr)); 5983: foreach my $item (split('&',$cat_title)) { 5984: my ($name,$value)=split('=',$item); 5985: $cat_titles->{&unescape($name)}=&thaw_unescape($value); 5986: } 5987: foreach my $item (split('&',$cat_order)) { 5988: my ($name,$value)=split('=',$item); 5989: $cat_orders->{&unescape($name)}=&thaw_unescape($value); 5990: } 5991: return 'ok'; 5992: } 5993: return $response; 5994: } 5995: 5996: sub auto_courserequest_checks { 5997: my ($dom) = @_; 5998: my ($homeserver,%validations); 5999: if ($dom =~ /^$match_domain$/) { 6000: $homeserver = &domain($dom,'primary'); 6001: } 6002: unless ($homeserver eq 'no_host') { 6003: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver); 6004: unless ($response =~ /(con_lost|error|no_such_host|refused)/) { 6005: my @items = split(/&/,$response); 6006: foreach my $item (@items) { 6007: my ($key,$value) = split('=',$item); 6008: $validations{&unescape($key)} = &thaw_unescape($value); 6009: } 6010: } 6011: } 6012: return %validations; 6013: } 6014: 6015: sub auto_courserequest_validation { 6016: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_; 6017: my ($homeserver,$response); 6018: if ($dom =~ /^$match_domain$/) { 6019: $homeserver = &domain($dom,'primary'); 6020: } 6021: unless ($homeserver eq 'no_host') { 6022: 6023: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner). 6024: ':'.&escape($crstype).':'.&escape($inststatuslist). 6025: ':'.&escape($instcode).':'.&escape($instseclist), 6026: $homeserver)); 6027: } 6028: return $response; 6029: } 6030: 6031: sub auto_validate_class_sec { 6032: my ($cdom,$cnum,$owners,$inst_class) = @_; 6033: my $homeserver = &homeserver($cnum,$cdom); 6034: my $ownerlist; 6035: if (ref($owners) eq 'ARRAY') { 6036: $ownerlist = join(',',@{$owners}); 6037: } else { 6038: $ownerlist = $owners; 6039: } 6040: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'. 6041: &escape($ownerlist).':'.$cdom,$homeserver); 6042: return $response; 6043: } 6044: 6045: # ------------------------------------------------------- Course Group routines 6046: 6047: sub get_coursegroups { 6048: my ($cdom,$cnum,$group,$namespace) = @_; 6049: return(&dump($namespace,$cdom,$cnum,$group)); 6050: } 6051: 6052: sub modify_coursegroup { 6053: my ($cdom,$cnum,$groupsettings) = @_; 6054: return(&put('coursegroups',$groupsettings,$cdom,$cnum)); 6055: } 6056: 6057: sub toggle_coursegroup_status { 6058: my ($cdom,$cnum,$group,$action) = @_; 6059: my ($from_namespace,$to_namespace); 6060: if ($action eq 'delete') { 6061: $from_namespace = 'coursegroups'; 6062: $to_namespace = 'deleted_groups'; 6063: } else { 6064: $from_namespace = 'deleted_groups'; 6065: $to_namespace = 'coursegroups'; 6066: } 6067: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace); 6068: if (my $tmp = &error(%curr_group)) { 6069: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom); 6070: return ('read error',$tmp); 6071: } else { 6072: my %savedsettings = %curr_group; 6073: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum); 6074: my $deloutcome; 6075: if ($result eq 'ok') { 6076: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum); 6077: } else { 6078: return ('write error',$result); 6079: } 6080: if ($deloutcome eq 'ok') { 6081: return 'ok'; 6082: } else { 6083: return ('delete error',$deloutcome); 6084: } 6085: } 6086: } 6087: 6088: sub modify_group_roles { 6089: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_; 6090: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id; 6091: my $role = 'gr/'.&escape($userprivs); 6092: my ($uname,$udom) = split(/:/,$user); 6093: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context); 6094: if ($result eq 'ok') { 6095: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum); 6096: } 6097: return $result; 6098: } 6099: 6100: sub modify_coursegroup_membership { 6101: my ($cdom,$cnum,$membership) = @_; 6102: my $result = &put('groupmembership',$membership,$cdom,$cnum); 6103: return $result; 6104: } 6105: 6106: sub get_active_groups { 6107: my ($udom,$uname,$cdom,$cnum) = @_; 6108: my $now = time; 6109: my %groups = (); 6110: foreach my $key (keys(%env)) { 6111: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) { 6112: my ($start,$end) = split(/\./,$env{$key}); 6113: if (($end!=0) && ($end<$now)) { next; } 6114: if (($start!=0) && ($start>$now)) { next; } 6115: if ($1 eq $cdom && $2 eq $cnum) { 6116: $groups{$3} = $env{$key} ; 6117: } 6118: } 6119: } 6120: return %groups; 6121: } 6122: 6123: sub get_group_membership { 6124: my ($cdom,$cnum,$group) = @_; 6125: return(&dump('groupmembership',$cdom,$cnum,$group)); 6126: } 6127: 6128: sub get_users_groups { 6129: my ($udom,$uname,$courseid) = @_; 6130: my @usersgroups; 6131: my $cachetime=1800; 6132: 6133: my $hashid="$udom:$uname:$courseid"; 6134: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid); 6135: if (defined($cached)) { 6136: @usersgroups = split(/:/,$grouplist); 6137: } else { 6138: $grouplist = ''; 6139: my $courseurl = &courseid_to_courseurl($courseid); 6140: my %roleshash = &dump('roles',$udom,$uname,$courseurl); 6141: my $access_end = $env{'course.'.$courseid. 6142: '.default_enrollment_end_date'}; 6143: my $now = time; 6144: foreach my $key (keys(%roleshash)) { 6145: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) { 6146: my $group = $1; 6147: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) { 6148: my $start = $2; 6149: my $end = $1; 6150: if ($start == -1) { next; } # deleted from group 6151: if (($start!=0) && ($start>$now)) { next; } 6152: if (($end!=0) && ($end<$now)) { 6153: if ($access_end && $access_end < $now) { 6154: if ($access_end - $end < 86400) { 6155: push(@usersgroups,$group); 6156: } 6157: } 6158: next; 6159: } 6160: push(@usersgroups,$group); 6161: } 6162: } 6163: } 6164: @usersgroups = &sort_course_groups($courseid,@usersgroups); 6165: $grouplist = join(':',@usersgroups); 6166: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime); 6167: } 6168: return @usersgroups; 6169: } 6170: 6171: sub devalidate_getgroups_cache { 6172: my ($udom,$uname,$cdom,$cnum)=@_; 6173: my $courseid = $cdom.'_'.$cnum; 6174: 6175: my $hashid="$udom:$uname:$courseid"; 6176: &devalidate_cache_new('getgroups',$hashid); 6177: } 6178: 6179: # ------------------------------------------------------------------ Plain Text 6180: 6181: sub plaintext { 6182: my ($short,$type,$cid,$forcedefault) = @_; 6183: if ($short =~ m{^cr/}) { 6184: return (split('/',$short))[-1]; 6185: } 6186: if (!defined($cid)) { 6187: $cid = $env{'request.course.id'}; 6188: } 6189: my %rolenames = ( 6190: Course => 'std', 6191: Community => 'alt1', 6192: ); 6193: if ($cid ne '') { 6194: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') { 6195: unless ($forcedefault) { 6196: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 6197: &Apache::lonlocal::mt_escape(\$roletext); 6198: return &Apache::lonlocal::mt($roletext); 6199: } 6200: } 6201: } 6202: if ((defined($type)) && (defined($rolenames{$type})) && 6203: (defined($rolenames{$type})) && 6204: (defined($prp{$short}{$rolenames{$type}}))) { 6205: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}}); 6206: } elsif ($cid ne '') { 6207: my $crstype = $env{'course.'.$cid.'.type'}; 6208: if (($crstype ne '') && (defined($rolenames{$crstype})) && 6209: (defined($prp{$short}{$rolenames{$crstype}}))) { 6210: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}}); 6211: } 6212: } 6213: return &Apache::lonlocal::mt($prp{$short}{'std'}); 6214: } 6215: 6216: # ----------------------------------------------------------------- Assign Role 6217: 6218: sub assignrole { 6219: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll, 6220: $context)=@_; 6221: my $mrole; 6222: if ($role =~ /^cr\//) { 6223: my $cwosec=$url; 6224: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6225: unless (&allowed('ccr',$cwosec)) { 6226: my $refused = 1; 6227: if ($context eq 'requestcourses') { 6228: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) { 6229: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) { 6230: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) { 6231: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6232: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6233: if ($crsenv{'internal.courseowner'} eq 6234: $env{'user.name'}.':'.$env{'user.domain'}) { 6235: $refused = ''; 6236: } 6237: } 6238: } 6239: } 6240: } 6241: if ($refused) { 6242: &logthis('Refused custom assignrole: '. 6243: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start. 6244: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}); 6245: return 'refused'; 6246: } 6247: } 6248: $mrole='cr'; 6249: } elsif ($role =~ /^gr\//) { 6250: my $cwogrp=$url; 6251: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2}; 6252: unless (&allowed('mdg',$cwogrp)) { 6253: &logthis('Refused group assignrole: '. 6254: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '. 6255: $env{'user.name'}.' at '.$env{'user.domain'}); 6256: return 'refused'; 6257: } 6258: $mrole='gr'; 6259: } else { 6260: my $cwosec=$url; 6261: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6262: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) { 6263: my $refused; 6264: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) { 6265: if (!(&allowed('c'.$role,$url))) { 6266: $refused = 1; 6267: } 6268: } else { 6269: $refused = 1; 6270: } 6271: if ($refused) { 6272: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6273: if (!$selfenroll && $context eq 'course') { 6274: my %crsenv; 6275: if ($role eq 'cc' || $role eq 'co') { 6276: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6277: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) { 6278: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) { 6279: if ($crsenv{'internal.courseowner'} eq 6280: $env{'user.name'}.':'.$env{'user.domain'}) { 6281: $refused = ''; 6282: } 6283: } 6284: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 6285: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) { 6286: if ($crsenv{'internal.courseowner'} eq 6287: $env{'user.name'}.':'.$env{'user.domain'}) { 6288: $refused = ''; 6289: } 6290: } 6291: } 6292: } 6293: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 6294: $refused = ''; 6295: } elsif ($context eq 'requestcourses') { 6296: my @possroles = ('st','ta','ep','in','cc','co'); 6297: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) { 6298: my $wrongcc; 6299: if ($cnum =~ /^$match_community$/) { 6300: $wrongcc = 1 if ($role eq 'cc'); 6301: } else { 6302: $wrongcc = 1 if ($role eq 'co'); 6303: } 6304: unless ($wrongcc) { 6305: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6306: if ($crsenv{'internal.courseowner'} eq 6307: $env{'user.name'}.':'.$env{'user.domain'}) { 6308: $refused = ''; 6309: } 6310: } 6311: } 6312: } 6313: if ($refused) { 6314: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url. 6315: ' '.$role.' '.$end.' '.$start.' by '. 6316: $env{'user.name'}.' at '.$env{'user.domain'}); 6317: return 'refused'; 6318: } 6319: } 6320: } 6321: $mrole=$role; 6322: } 6323: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 6324: "$udom:$uname:$url".'_'."$mrole=$role"; 6325: if ($end) { $command.='_'.$end; } 6326: if ($start) { 6327: if ($end) { 6328: $command.='_'.$start; 6329: } else { 6330: $command.='_0_'.$start; 6331: } 6332: } 6333: my $origstart = $start; 6334: my $origend = $end; 6335: my $delflag; 6336: # actually delete 6337: if ($deleteflag) { 6338: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) { 6339: # modify command to delete the role 6340: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:". 6341: "$udom:$uname:$url".'_'."$mrole"; 6342: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 6343: # set start and finish to negative values for userrolelog 6344: $start=-1; 6345: $end=-1; 6346: $delflag = 1; 6347: } 6348: } 6349: # send command 6350: my $answer=&reply($command,&homeserver($uname,$udom)); 6351: # log new user role if status is ok 6352: if ($answer eq 'ok') { 6353: &userrolelog($role,$uname,$udom,$url,$start,$end); 6354: # for course roles, perform group memberships changes triggered by role change. 6355: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context); 6356: unless ($role =~ /^gr/) { 6357: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend, 6358: $origstart,$selfenroll,$context); 6359: } 6360: } 6361: return $answer; 6362: } 6363: 6364: # -------------------------------------------------- Modify user authentication 6365: # Overrides without validation 6366: 6367: sub modifyuserauth { 6368: my ($udom,$uname,$umode,$upass)=@_; 6369: my $uhome=&homeserver($uname,$udom); 6370: unless (&allowed('mau',$udom)) { return 'refused'; } 6371: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '. 6372: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6373: ' in domain '.$env{'request.role.domain'}); 6374: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'. 6375: &escape($upass),$uhome); 6376: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 6377: 'Authentication changed for '.$udom.', '.$uname.', '.$umode. 6378: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6379: &log($udom,,$uname,$uhome, 6380: 'Authentication changed by '.$env{'user.domain'}.', '. 6381: $env{'user.name'}.', '.$umode. 6382: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6383: unless ($reply eq 'ok') { 6384: &logthis('Authentication mode error: '.$reply); 6385: return 'error: '.$reply; 6386: } 6387: return 'ok'; 6388: } 6389: 6390: # --------------------------------------------------------------- Modify a user 6391: 6392: sub modifyuser { 6393: my ($udom, $uname, $uid, 6394: $umode, $upass, $first, 6395: $middle, $last, $gene, 6396: $forceid, $desiredhome, $email, $inststatus)=@_; 6397: $udom= &LONCAPA::clean_domain($udom); 6398: $uname=&LONCAPA::clean_username($uname); 6399: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '. 6400: $umode.', '.$first.', '.$middle.', '. 6401: $last.', '.$gene.'(forceid: '.$forceid.')'. 6402: (defined($desiredhome) ? ' desiredhome = '.$desiredhome : 6403: ' desiredhome not specified'). 6404: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6405: ' in domain '.$env{'request.role.domain'}); 6406: my $uhome=&homeserver($uname,$udom,'true'); 6407: # ----------------------------------------------------------------- Create User 6408: if (($uhome eq 'no_host') && 6409: (($umode && $upass) || ($umode eq 'localauth'))) { 6410: my $unhome=''; 6411: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 6412: $unhome = $desiredhome; 6413: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) { 6414: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'}; 6415: } else { # load balancing routine for determining $unhome 6416: my $loadm=10000000; 6417: my %servers = &get_servers($udom,'library'); 6418: foreach my $tryserver (keys(%servers)) { 6419: my $answer=reply('load',$tryserver); 6420: if (($answer=~/\d+/) && ($answer<$loadm)) { 6421: $loadm=$answer; 6422: $unhome=$tryserver; 6423: } 6424: } 6425: } 6426: if (($unhome eq '') || ($unhome eq 'no_host')) { 6427: return 'error: unable to find a home server for '.$uname. 6428: ' in domain '.$udom; 6429: } 6430: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'. 6431: &escape($upass),$unhome); 6432: unless ($reply eq 'ok') { 6433: return 'error: '.$reply; 6434: } 6435: $uhome=&homeserver($uname,$udom,'true'); 6436: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) { 6437: return 'error: unable verify users home machine.'; 6438: } 6439: } # End of creation of new user 6440: # ---------------------------------------------------------------------- Add ID 6441: if ($uid) { 6442: $uid=~tr/A-Z/a-z/; 6443: my %uidhash=&idrget($udom,$uname); 6444: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 6445: && (!$forceid)) { 6446: unless ($uid eq $uidhash{$uname}) { 6447: return 'error: user id "'.$uid.'" does not match '. 6448: 'current user id "'.$uidhash{$uname}.'".'; 6449: } 6450: } else { 6451: &idput($udom,($uname => $uid)); 6452: } 6453: } 6454: # -------------------------------------------------------------- Add names, etc 6455: my @tmp=&get('environment', 6456: ['firstname','middlename','lastname','generation','id', 6457: 'permanentemail','inststatus'], 6458: $udom,$uname); 6459: my %names; 6460: if ($tmp[0] =~ m/^error:.*/) { 6461: %names=(); 6462: } else { 6463: %names = @tmp; 6464: } 6465: # 6466: # Make sure to not trash student environment if instructor does not bother 6467: # to supply name and email information 6468: # 6469: if ($first) { $names{'firstname'} = $first; } 6470: if (defined($middle)) { $names{'middlename'} = $middle; } 6471: if ($last) { $names{'lastname'} = $last; } 6472: if (defined($gene)) { $names{'generation'} = $gene; } 6473: if ($email) { 6474: $email=~s/[^\w\@\.\-\,]//gs; 6475: if ($email=~/\@/) { $names{'permanentemail'} = $email; } 6476: } 6477: if ($uid) { $names{'id'} = $uid; } 6478: if (defined($inststatus)) { 6479: $names{'inststatus'} = ''; 6480: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom); 6481: if (ref($usertypes) eq 'HASH') { 6482: my @okstatuses; 6483: foreach my $item (split(/:/,$inststatus)) { 6484: if (defined($usertypes->{$item})) { 6485: push(@okstatuses,$item); 6486: } 6487: } 6488: if (@okstatuses) { 6489: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses); 6490: } 6491: } 6492: } 6493: my $reply = &put('environment', \%names, $udom,$uname); 6494: if ($reply ne 'ok') { return 'error: '.$reply; } 6495: my $sqlresult = &update_allusers_table($uname,$udom,\%names); 6496: &devalidate_cache_new('namescache',$uname.':'.$udom); 6497: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '. 6498: $umode.', '.$first.', '.$middle.', '. 6499: $last.', '.$gene.', '.$email.', '.$inststatus; 6500: if ($env{'user.name'} ne '' && $env{'user.domain'}) { 6501: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'}; 6502: } else { 6503: $logmsg .= ' during self creation'; 6504: } 6505: &logthis($logmsg); 6506: return 'ok'; 6507: } 6508: 6509: # -------------------------------------------------------------- Modify student 6510: 6511: sub modifystudent { 6512: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec, 6513: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid, 6514: $selfenroll,$context,$inststatus)=@_; 6515: if (!$cid) { 6516: unless ($cid=$env{'request.course.id'}) { 6517: return 'not_in_class'; 6518: } 6519: } 6520: # --------------------------------------------------------------- Make the user 6521: my $reply=&modifyuser 6522: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid, 6523: $desiredhome,$email,$inststatus); 6524: unless ($reply eq 'ok') { return $reply; } 6525: # This will cause &modify_student_enrollment to get the uid from the 6526: # students environment 6527: $uid = undef if (!$forceid); 6528: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last, 6529: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context); 6530: return $reply; 6531: } 6532: 6533: sub modify_student_enrollment { 6534: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_; 6535: my ($cdom,$cnum,$chome); 6536: if (!$cid) { 6537: unless ($cid=$env{'request.course.id'}) { 6538: return 'not_in_class'; 6539: } 6540: $cdom=$env{'course.'.$cid.'.domain'}; 6541: $cnum=$env{'course.'.$cid.'.num'}; 6542: } else { 6543: ($cdom,$cnum)=split(/_/,$cid); 6544: } 6545: $chome=$env{'course.'.$cid.'.home'}; 6546: if (!$chome) { 6547: $chome=&homeserver($cnum,$cdom); 6548: } 6549: if (!$chome) { return 'unknown_course'; } 6550: # Make sure the user exists 6551: my $uhome=&homeserver($uname,$udom); 6552: if (($uhome eq '') || ($uhome eq 'no_host')) { 6553: return 'error: no such user'; 6554: } 6555: # Get student data if we were not given enough information 6556: if (!defined($first) || $first eq '' || 6557: !defined($last) || $last eq '' || 6558: !defined($uid) || $uid eq '' || 6559: !defined($middle) || $middle eq '' || 6560: !defined($gene) || $gene eq '') { 6561: # They did not supply us with enough data to enroll the student, so 6562: # we need to pick up more information. 6563: my %tmp = &get('environment', 6564: ['firstname','middlename','lastname', 'generation','id'] 6565: ,$udom,$uname); 6566: 6567: #foreach my $key (keys(%tmp)) { 6568: # &logthis("key $key = ".$tmp{$key}); 6569: #} 6570: $first = $tmp{'firstname'} if (!defined($first) || $first eq ''); 6571: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq ''); 6572: $last = $tmp{'lastname'} if (!defined($last) || $last eq ''); 6573: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq ''); 6574: $uid = $tmp{'id'} if (!defined($uid) || $uid eq ''); 6575: } 6576: my $fullname = &format_name($first,$middle,$last,$gene,'lastname'); 6577: my $reply=cput('classlist', 6578: {"$uname:$udom" => 6579: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) }, 6580: $cdom,$cnum); 6581: unless (($reply eq 'ok') || ($reply eq 'delayed')) { 6582: return 'error: '.$reply; 6583: } else { 6584: &devalidate_getsection_cache($udom,$uname,$cid); 6585: } 6586: # Add student role to user 6587: my $uurl='/'.$cid; 6588: $uurl=~s/\_/\//g; 6589: if ($usec) { 6590: $uurl.='/'.$usec; 6591: } 6592: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context); 6593: } 6594: 6595: sub format_name { 6596: my ($firstname,$middlename,$lastname,$generation,$first)=@_; 6597: my $name; 6598: if ($first ne 'lastname') { 6599: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation; 6600: } else { 6601: if ($lastname=~/\S/) { 6602: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename; 6603: $name=~s/\s+,/,/; 6604: } else { 6605: $name.= $firstname.' '.$middlename.' '.$generation; 6606: } 6607: } 6608: $name=~s/^\s+//; 6609: $name=~s/\s+$//; 6610: $name=~s/\s+/ /g; 6611: return $name; 6612: } 6613: 6614: # ------------------------------------------------- Write to course preferences 6615: 6616: sub writecoursepref { 6617: my ($courseid,%prefs)=@_; 6618: $courseid=~s/^\///; 6619: $courseid=~s/\_/\//g; 6620: my ($cdomain,$cnum)=split(/\//,$courseid); 6621: my $chome=homeserver($cnum,$cdomain); 6622: if (($chome eq '') || ($chome eq 'no_host')) { 6623: return 'error: no such course'; 6624: } 6625: my $cstring=''; 6626: foreach my $pref (keys(%prefs)) { 6627: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&'; 6628: } 6629: $cstring=~s/\&$//; 6630: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome); 6631: } 6632: 6633: # ---------------------------------------------------------- Make/modify course 6634: 6635: sub createcourse { 6636: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code, 6637: $course_owner,$crstype,$cnum,$context,$category)=@_; 6638: $url=&declutter($url); 6639: my $cid=''; 6640: if ($context eq 'requestcourses') { 6641: my $can_create = 0; 6642: my ($ownername,$ownerdom) = split(':',$course_owner); 6643: if ($udom eq $ownerdom) { 6644: if (&usertools_access($ownername,$ownerdom,$category,undef, 6645: $context)) { 6646: $can_create = 1; 6647: } 6648: } else { 6649: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'. 6650: $category); 6651: if ($userenv{'reqcrsotherdom.'.$category} ne '') { 6652: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category}); 6653: if (@curr > 0) { 6654: my @options = qw(approval validate autolimit); 6655: my $optregex = join('|',@options); 6656: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) { 6657: $can_create = 1; 6658: } 6659: } 6660: } 6661: } 6662: if ($can_create) { 6663: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) { 6664: unless (&allowed('ccc',$udom)) { 6665: return 'refused'; 6666: } 6667: } 6668: } else { 6669: return 'refused'; 6670: } 6671: } elsif (!&allowed('ccc',$udom)) { 6672: return 'refused'; 6673: } 6674: # --------------------------------------------------------------- Get Unique ID 6675: my $uname; 6676: if ($cnum =~ /^$match_courseid$/) { 6677: my $chome=&homeserver($cnum,$udom,'true'); 6678: if (($chome eq '') || ($chome eq 'no_host')) { 6679: $uname = $cnum; 6680: } else { 6681: $uname = &generate_coursenum($udom,$crstype); 6682: } 6683: } else { 6684: $uname = &generate_coursenum($udom,$crstype); 6685: } 6686: return $uname if ($uname =~ /^error/); 6687: # -------------------------------------------------- Check supplied server name 6688: if (!defined($course_server)) { 6689: if (defined(&domain($udom,'primary'))) { 6690: $course_server = &domain($udom,'primary'); 6691: } else { 6692: $course_server = $env{'user.home'}; 6693: } 6694: } 6695: my %host_servers = 6696: &Apache::lonnet::get_servers($udom,'library'); 6697: unless ($host_servers{$course_server}) { 6698: return 'error: invalid home server for course: '.$course_server; 6699: } 6700: # ------------------------------------------------------------- Make the course 6701: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::', 6702: $course_server); 6703: unless ($reply eq 'ok') { return 'error: '.$reply; } 6704: my $uhome=&homeserver($uname,$udom,'true'); 6705: if (($uhome eq '') || ($uhome eq 'no_host')) { 6706: return 'error: no such course'; 6707: } 6708: # ----------------------------------------------------------------- Course made 6709: # log existence 6710: my $now = time; 6711: my $newcourse = { 6712: $udom.'_'.$uname => { 6713: description => $description, 6714: inst_code => $inst_code, 6715: owner => $course_owner, 6716: type => $crstype, 6717: creator => $env{'user.name'}.':'. 6718: $env{'user.domain'}, 6719: created => $now, 6720: context => $context, 6721: }, 6722: }; 6723: &courseidput($udom,$newcourse,$uhome,'notime'); 6724: # set toplevel url 6725: my $topurl=$url; 6726: unless ($nonstandard) { 6727: # ------------------------------------------ For standard courses, make top url 6728: my $mapurl=&clutter($url); 6729: if ($mapurl eq '/res/') { $mapurl=''; } 6730: $env{'form.initmap'}=(<<ENDINITMAP); 6731: <map> 6732: <resource id="1" type="start"></resource> 6733: <resource id="2" src="$mapurl"></resource> 6734: <resource id="3" type="finish"></resource> 6735: <link index="1" from="1" to="2"></link> 6736: <link index="2" from="2" to="3"></link> 6737: </map> 6738: ENDINITMAP 6739: $topurl=&declutter( 6740: &finishuserfileupload($uname,$udom,'initmap','default.sequence') 6741: ); 6742: } 6743: # ----------------------------------------------------------- Write preferences 6744: &writecoursepref($udom.'_'.$uname, 6745: ('description' => $description, 6746: 'url' => $topurl)); 6747: return '/'.$udom.'/'.$uname; 6748: } 6749: 6750: # ------------------------------------------------------------------- Create ID 6751: sub generate_coursenum { 6752: my ($udom,$crstype) = @_; 6753: my $domdesc = &domain($udom); 6754: return 'error: invalid domain' if ($domdesc eq ''); 6755: my $first; 6756: if ($crstype eq 'Community') { 6757: $first = '0'; 6758: } else { 6759: $first = int(1+rand(9)); 6760: } 6761: my $uname=$first. 6762: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 6763: substr($$.time,0,5).unpack("H8",pack("I32",time)). 6764: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 6765: # ----------------------------------------------- Make sure that does not exist 6766: my $uhome=&homeserver($uname,$udom,'true'); 6767: unless (($uhome eq '') || ($uhome eq 'no_host')) { 6768: if ($crstype eq 'Community') { 6769: $first = '0'; 6770: } else { 6771: $first = int(1+rand(9)); 6772: } 6773: $uname=$first. 6774: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 6775: substr($$.time,0,5).unpack("H8",pack("I32",time)). 6776: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 6777: $uhome=&homeserver($uname,$udom,'true'); 6778: unless (($uhome eq '') || ($uhome eq 'no_host')) { 6779: return 'error: unable to generate unique course-ID'; 6780: } 6781: } 6782: return $uname; 6783: } 6784: 6785: sub is_course { 6786: my ($cdom,$cnum) = @_; 6787: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef, 6788: undef,'.'); 6789: if (exists($courses{$cdom.'_'.$cnum})) { 6790: return 1; 6791: } 6792: return 0; 6793: } 6794: 6795: sub store_userdata { 6796: my ($storehash,$datakey,$namespace,$udom,$uname) = @_; 6797: my $result; 6798: if ($datakey ne '') { 6799: if (ref($storehash) eq 'HASH') { 6800: if ($udom eq '' || $uname eq '') { 6801: $udom = $env{'user.domain'}; 6802: $uname = $env{'user.name'}; 6803: } 6804: my $uhome=&homeserver($uname,$udom); 6805: if (($uhome eq '') || ($uhome eq 'no_host')) { 6806: $result = 'error: no_host'; 6807: } else { 6808: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'}; 6809: $storehash->{'host'} = $perlvar{'lonHostID'}; 6810: 6811: my $namevalue=''; 6812: foreach my $key (keys(%{$storehash})) { 6813: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 6814: } 6815: $namevalue=~s/\&$//; 6816: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:". 6817: "$namespace:$datakey:$namevalue",$uhome); 6818: } 6819: } else { 6820: $result = 'error: data to store was not a hash reference'; 6821: } 6822: } else { 6823: $result= 'error: invalid requestkey'; 6824: } 6825: return $result; 6826: } 6827: 6828: # ---------------------------------------------------------- Assign Custom Role 6829: 6830: sub assigncustomrole { 6831: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_; 6832: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename, 6833: $end,$start,$deleteflag,$selfenroll,$context); 6834: } 6835: 6836: # ----------------------------------------------------------------- Revoke Role 6837: 6838: sub revokerole { 6839: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_; 6840: my $now=time; 6841: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context); 6842: } 6843: 6844: # ---------------------------------------------------------- Revoke Custom Role 6845: 6846: sub revokecustomrole { 6847: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_; 6848: my $now=time; 6849: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now, 6850: $deleteflag,$selfenroll,$context); 6851: } 6852: 6853: # ------------------------------------------------------------ Disk usage 6854: sub diskusage { 6855: my ($udom,$uname,$directorypath,$getpropath)=@_; 6856: $directorypath =~ s/\/$//; 6857: my $listing=&reply('du2:'.&escape($directorypath).':' 6858: .&escape($getpropath).':'.&escape($uname).':' 6859: .&escape($udom),homeserver($uname,$udom)); 6860: if ($listing eq 'unknown_cmd') { 6861: if ($getpropath) { 6862: $directorypath = &propath($udom,$uname).'/'.$directorypath; 6863: } 6864: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom)); 6865: } 6866: return $listing; 6867: } 6868: 6869: sub is_locked { 6870: my ($file_name, $domain, $user) = @_; 6871: my @check; 6872: my $is_locked; 6873: push @check, $file_name; 6874: my %locked = &get('file_permissions',\@check, 6875: $env{'user.domain'},$env{'user.name'}); 6876: my ($tmp)=keys(%locked); 6877: if ($tmp=~/^error:/) { undef(%locked); } 6878: 6879: if (ref($locked{$file_name}) eq 'ARRAY') { 6880: $is_locked = 'false'; 6881: foreach my $entry (@{$locked{$file_name}}) { 6882: if (ref($entry) eq 'ARRAY') { 6883: $is_locked = 'true'; 6884: last; 6885: } 6886: } 6887: } else { 6888: $is_locked = 'false'; 6889: } 6890: } 6891: 6892: sub declutter_portfile { 6893: my ($file) = @_; 6894: $file =~ s{^(/portfolio/|portfolio/)}{/}; 6895: return $file; 6896: } 6897: 6898: # ------------------------------------------------------------- Mark as Read Only 6899: 6900: sub mark_as_readonly { 6901: my ($domain,$user,$files,$what) = @_; 6902: my %current_permissions = &dump('file_permissions',$domain,$user); 6903: my ($tmp)=keys(%current_permissions); 6904: if ($tmp=~/^error:/) { undef(%current_permissions); } 6905: foreach my $file (@{$files}) { 6906: $file = &declutter_portfile($file); 6907: push(@{$current_permissions{$file}},$what); 6908: } 6909: &put('file_permissions',\%current_permissions,$domain,$user); 6910: return; 6911: } 6912: 6913: # ------------------------------------------------------------Save Selected Files 6914: 6915: sub save_selected_files { 6916: my ($user, $path, @files) = @_; 6917: my $filename = $user."savedfiles"; 6918: my @other_files = &files_not_in_path($user, $path); 6919: open (OUT, '>'.$tmpdir.$filename); 6920: foreach my $file (@files) { 6921: print (OUT $env{'form.currentpath'}.$file."\n"); 6922: } 6923: foreach my $file (@other_files) { 6924: print (OUT $file."\n"); 6925: } 6926: close (OUT); 6927: return 'ok'; 6928: } 6929: 6930: sub clear_selected_files { 6931: my ($user) = @_; 6932: my $filename = $user."savedfiles"; 6933: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 6934: print (OUT undef); 6935: close (OUT); 6936: return ("ok"); 6937: } 6938: 6939: sub files_in_path { 6940: my ($user, $path) = @_; 6941: my $filename = $user."savedfiles"; 6942: my %return_files; 6943: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 6944: while (my $line_in = <IN>) { 6945: chomp ($line_in); 6946: my @paths_and_file = split (m!/!, $line_in); 6947: my $file_part = pop (@paths_and_file); 6948: my $path_part = join ('/', @paths_and_file); 6949: $path_part.='/'; 6950: my $path_and_file = $path_part.$file_part; 6951: if ($path_part eq $path) { 6952: $return_files{$file_part}= 'selected'; 6953: } 6954: } 6955: close (IN); 6956: return (\%return_files); 6957: } 6958: 6959: # called in portfolio select mode, to show files selected NOT in current directory 6960: sub files_not_in_path { 6961: my ($user, $path) = @_; 6962: my $filename = $user."savedfiles"; 6963: my @return_files; 6964: my $path_part; 6965: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 6966: while (my $line = <IN>) { 6967: #ok, I know it's clunky, but I want it to work 6968: my @paths_and_file = split(m|/|, $line); 6969: my $file_part = pop(@paths_and_file); 6970: chomp($file_part); 6971: my $path_part = join('/', @paths_and_file); 6972: $path_part .= '/'; 6973: my $path_and_file = $path_part.$file_part; 6974: if ($path_part ne $path) { 6975: push(@return_files, ($path_and_file)); 6976: } 6977: } 6978: close(OUT); 6979: return (@return_files); 6980: } 6981: 6982: #----------------------------------------------Get portfolio file permissions 6983: 6984: sub get_portfile_permissions { 6985: my ($domain,$user) = @_; 6986: my %current_permissions = &dump('file_permissions',$domain,$user); 6987: my ($tmp)=keys(%current_permissions); 6988: if ($tmp=~/^error:/) { undef(%current_permissions); } 6989: return \%current_permissions; 6990: } 6991: 6992: #---------------------------------------------Get portfolio file access controls 6993: 6994: sub get_access_controls { 6995: my ($current_permissions,$group,$file) = @_; 6996: my %access; 6997: my $real_file = $file; 6998: $file =~ s/\.meta$//; 6999: if (defined($file)) { 7000: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') { 7001: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) { 7002: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control}; 7003: } 7004: } 7005: } else { 7006: foreach my $key (keys(%{$current_permissions})) { 7007: if ($key =~ /\0accesscontrol$/) { 7008: if (defined($group)) { 7009: if ($key !~ m-^\Q$group\E/-) { 7010: next; 7011: } 7012: } 7013: my ($fullpath) = split(/\0/,$key); 7014: if (ref($$current_permissions{$key}) eq 'HASH') { 7015: foreach my $control (keys(%{$$current_permissions{$key}})) { 7016: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control}; 7017: } 7018: } 7019: } 7020: } 7021: } 7022: return %access; 7023: } 7024: 7025: sub modify_access_controls { 7026: my ($file_name,$changes,$domain,$user)=@_; 7027: my ($outcome,$deloutcome); 7028: my %store_permissions; 7029: my %new_values; 7030: my %new_control; 7031: my %translation; 7032: my @deletions = (); 7033: my $now = time; 7034: if (exists($$changes{'activate'})) { 7035: if (ref($$changes{'activate'}) eq 'HASH') { 7036: my @newitems = sort(keys(%{$$changes{'activate'}})); 7037: my $numnew = scalar(@newitems); 7038: for (my $i=0; $i<$numnew; $i++) { 7039: my $newkey = $newitems[$i]; 7040: my $newid = &Apache::loncommon::get_cgi_id(); 7041: if ($newkey =~ /^\d+:/) { 7042: $newkey =~ s/^(\d+)/$newid/; 7043: $translation{$1} = $newid; 7044: } elsif ($newkey =~ /^\d+_\d+_\d+:/) { 7045: $newkey =~ s/^(\d+_\d+_\d+)/$newid/; 7046: $translation{$1} = $newid; 7047: } 7048: $new_values{$file_name."\0".$newkey} = 7049: $$changes{'activate'}{$newitems[$i]}; 7050: $new_control{$newkey} = $now; 7051: } 7052: } 7053: } 7054: my %todelete; 7055: my %changed_items; 7056: foreach my $action ('delete','update') { 7057: if (exists($$changes{$action})) { 7058: if (ref($$changes{$action}) eq 'HASH') { 7059: foreach my $key (keys(%{$$changes{$action}})) { 7060: my ($itemnum) = ($key =~ /^([^:]+):/); 7061: if ($action eq 'delete') { 7062: $todelete{$itemnum} = 1; 7063: } else { 7064: $changed_items{$itemnum} = $key; 7065: } 7066: } 7067: } 7068: } 7069: } 7070: # get lock on access controls for file. 7071: my $lockhash = { 7072: $file_name."\0".'locked_access_records' => $env{'user.name'}. 7073: ':'.$env{'user.domain'}, 7074: }; 7075: my $tries = 0; 7076: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7077: 7078: while (($gotlock ne 'ok') && $tries <3) { 7079: $tries ++; 7080: sleep 1; 7081: $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7082: } 7083: if ($gotlock eq 'ok') { 7084: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name); 7085: my ($tmp)=keys(%curr_permissions); 7086: if ($tmp=~/^error:/) { undef(%curr_permissions); } 7087: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) { 7088: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'}; 7089: if (ref($curr_controls) eq 'HASH') { 7090: foreach my $control_item (keys(%{$curr_controls})) { 7091: my ($itemnum) = ($control_item =~ /^([^:]+):/); 7092: if (defined($todelete{$itemnum})) { 7093: push(@deletions,$file_name."\0".$control_item); 7094: } else { 7095: if (defined($changed_items{$itemnum})) { 7096: $new_control{$changed_items{$itemnum}} = $now; 7097: push(@deletions,$file_name."\0".$control_item); 7098: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}}; 7099: } else { 7100: $new_control{$control_item} = $$curr_controls{$control_item}; 7101: } 7102: } 7103: } 7104: } 7105: } 7106: my ($group); 7107: if (&is_course($domain,$user)) { 7108: ($group,my $file) = split(/\//,$file_name,2); 7109: } 7110: $deloutcome = &del('file_permissions',\@deletions,$domain,$user); 7111: $new_values{$file_name."\0".'accesscontrol'} = \%new_control; 7112: $outcome = &put('file_permissions',\%new_values,$domain,$user); 7113: # remove lock 7114: my @del_lock = ($file_name."\0".'locked_access_records'); 7115: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user); 7116: my $sqlresult = 7117: &update_portfolio_table($user,$domain,$file_name,'portfolio_access', 7118: $group); 7119: } else { 7120: $outcome = "error: could not obtain lockfile\n"; 7121: } 7122: return ($outcome,$deloutcome,\%new_values,\%translation); 7123: } 7124: 7125: sub make_public_indefinitely { 7126: my ($requrl) = @_; 7127: my $now = time; 7128: my $action = 'activate'; 7129: my $aclnum = 0; 7130: if (&is_portfolio_url($requrl)) { 7131: my (undef,$udom,$unum,$file_name,$group) = 7132: &parse_portfolio_url($requrl); 7133: my $current_perms = &get_portfile_permissions($udom,$unum); 7134: my %access_controls = &get_access_controls($current_perms, 7135: $group,$file_name); 7136: foreach my $key (keys(%{$access_controls{$file_name}})) { 7137: my ($num,$scope,$end,$start) = 7138: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 7139: if ($scope eq 'public') { 7140: if ($start <= $now && $end == 0) { 7141: $action = 'none'; 7142: } else { 7143: $action = 'update'; 7144: $aclnum = $num; 7145: } 7146: last; 7147: } 7148: } 7149: if ($action eq 'none') { 7150: return 'ok'; 7151: } else { 7152: my %changes; 7153: my $newend = 0; 7154: my $newstart = $now; 7155: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart; 7156: $changes{$action}{$newkey} = { 7157: type => 'public', 7158: time => { 7159: start => $newstart, 7160: end => $newend, 7161: }, 7162: }; 7163: my ($outcome,$deloutcome,$new_values,$translation) = 7164: &modify_access_controls($file_name,\%changes,$udom,$unum); 7165: return $outcome; 7166: } 7167: } else { 7168: return 'invalid'; 7169: } 7170: } 7171: 7172: #------------------------------------------------------Get Marked as Read Only 7173: 7174: sub get_marked_as_readonly { 7175: my ($domain,$user,$what,$group) = @_; 7176: my $current_permissions = &get_portfile_permissions($domain,$user); 7177: my @readonly_files; 7178: my $cmp1=$what; 7179: if (ref($what)) { $cmp1=join('',@{$what}) }; 7180: while (my ($file_name,$value) = each(%{$current_permissions})) { 7181: if (defined($group)) { 7182: if ($file_name !~ m-^\Q$group\E/-) { 7183: next; 7184: } 7185: } 7186: if (ref($value) eq "ARRAY"){ 7187: foreach my $stored_what (@{$value}) { 7188: my $cmp2=$stored_what; 7189: if (ref($stored_what) eq 'ARRAY') { 7190: $cmp2=join('',@{$stored_what}); 7191: } 7192: if ($cmp1 eq $cmp2) { 7193: push(@readonly_files, $file_name); 7194: last; 7195: } elsif (!defined($what)) { 7196: push(@readonly_files, $file_name); 7197: last; 7198: } 7199: } 7200: } 7201: } 7202: return @readonly_files; 7203: } 7204: #-----------------------------------------------------------Get Marked as Read Only Hash 7205: 7206: sub get_marked_as_readonly_hash { 7207: my ($current_permissions,$group,$what) = @_; 7208: my %readonly_files; 7209: while (my ($file_name,$value) = each(%{$current_permissions})) { 7210: if (defined($group)) { 7211: if ($file_name !~ m-^\Q$group\E/-) { 7212: next; 7213: } 7214: } 7215: if (ref($value) eq "ARRAY"){ 7216: foreach my $stored_what (@{$value}) { 7217: if (ref($stored_what) eq 'ARRAY') { 7218: foreach my $lock_descriptor(@{$stored_what}) { 7219: if ($lock_descriptor eq 'graded') { 7220: $readonly_files{$file_name} = 'graded'; 7221: } elsif ($lock_descriptor eq 'handback') { 7222: $readonly_files{$file_name} = 'handback'; 7223: } else { 7224: if (!exists($readonly_files{$file_name})) { 7225: $readonly_files{$file_name} = 'locked'; 7226: } 7227: } 7228: } 7229: } 7230: } 7231: } 7232: } 7233: return %readonly_files; 7234: } 7235: # ------------------------------------------------------------ Unmark as Read Only 7236: 7237: sub unmark_as_readonly { 7238: # unmarks $file_name (if $file_name is defined), or all files locked by $what 7239: # for portfolio submissions, $what contains [$symb,$crsid] 7240: my ($domain,$user,$what,$file_name,$group) = @_; 7241: $file_name = &declutter_portfile($file_name); 7242: my $symb_crs = $what; 7243: if (ref($what)) { $symb_crs=join('',@$what); } 7244: my %current_permissions = &dump('file_permissions',$domain,$user,$group); 7245: my ($tmp)=keys(%current_permissions); 7246: if ($tmp=~/^error:/) { undef(%current_permissions); } 7247: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group); 7248: foreach my $file (@readonly_files) { 7249: my $clean_file = &declutter_portfile($file); 7250: if (defined($file_name) && ($file_name ne $clean_file)) { next; } 7251: my $current_locks = $current_permissions{$file}; 7252: my @new_locks; 7253: my @del_keys; 7254: if (ref($current_locks) eq "ARRAY"){ 7255: foreach my $locker (@{$current_locks}) { 7256: my $compare=$locker; 7257: if (ref($locker) eq 'ARRAY') { 7258: $compare=join('',@{$locker}); 7259: if ($compare ne $symb_crs) { 7260: push(@new_locks, $locker); 7261: } 7262: } 7263: } 7264: if (scalar(@new_locks) > 0) { 7265: $current_permissions{$file} = \@new_locks; 7266: } else { 7267: push(@del_keys, $file); 7268: &del('file_permissions',\@del_keys, $domain, $user); 7269: delete($current_permissions{$file}); 7270: } 7271: } 7272: } 7273: &put('file_permissions',\%current_permissions,$domain,$user); 7274: return; 7275: } 7276: 7277: # ------------------------------------------------------------ Directory lister 7278: 7279: sub dirlist { 7280: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_; 7281: $uri=~s/^\///; 7282: $uri=~s/\/$//; 7283: my ($udom, $uname); 7284: if ($getuserdir) { 7285: $udom = $userdomain; 7286: $uname = $username; 7287: } else { 7288: (undef,$udom,$uname)=split(/\//,$uri); 7289: if(defined($userdomain)) { 7290: $udom = $userdomain; 7291: } 7292: if(defined($username)) { 7293: $uname = $username; 7294: } 7295: } 7296: my ($dirRoot,$listing,@listing_results); 7297: 7298: $dirRoot = $perlvar{'lonDocRoot'}; 7299: if (defined($getpropath)) { 7300: $dirRoot = &propath($udom,$uname); 7301: $dirRoot =~ s/\/$//; 7302: } elsif (defined($getuserdir)) { 7303: my $subdir=$uname.'__'; 7304: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/; 7305: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'} 7306: ."/$udom/$subdir/$uname"; 7307: } elsif (defined($alternateRoot)) { 7308: $dirRoot = $alternateRoot; 7309: } 7310: 7311: if($udom) { 7312: if($uname) { 7313: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':' 7314: .$getuserdir.':'.&escape($dirRoot) 7315: .':'.&escape($uname).':'.&escape($udom), 7316: &homeserver($uname,$udom)); 7317: if ($listing eq 'unknown_cmd') { 7318: $listing = &reply('ls2:'.$dirRoot.'/'.$uri, 7319: &homeserver($uname,$udom)); 7320: } else { 7321: @listing_results = map { &unescape($_); } split(/:/,$listing); 7322: } 7323: if ($listing eq 'unknown_cmd') { 7324: $listing = &reply('ls:'.$dirRoot.'/'.$uri, 7325: &homeserver($uname,$udom)); 7326: @listing_results = split(/:/,$listing); 7327: } else { 7328: @listing_results = map { &unescape($_); } split(/:/,$listing); 7329: } 7330: return @listing_results; 7331: } elsif(!$alternateRoot) { 7332: my %allusers; 7333: my %servers = &get_servers($udom,'library'); 7334: foreach my $tryserver (keys(%servers)) { 7335: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'. 7336: &escape($udom),$tryserver); 7337: if ($listing eq 'unknown_cmd') { 7338: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'. 7339: $udom, $tryserver); 7340: } else { 7341: @listing_results = map { &unescape($_); } split(/:/,$listing); 7342: } 7343: if ($listing eq 'unknown_cmd') { 7344: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'. 7345: $udom, $tryserver); 7346: @listing_results = split(/:/,$listing); 7347: } else { 7348: @listing_results = 7349: map { &unescape($_); } split(/:/,$listing); 7350: } 7351: if ($listing_results[0] ne 'no_such_dir' && 7352: $listing_results[0] ne 'empty' && 7353: $listing_results[0] ne 'con_lost') { 7354: foreach my $line (@listing_results) { 7355: my ($entry) = split(/&/,$line,2); 7356: $allusers{$entry} = 1; 7357: } 7358: } 7359: } 7360: my $alluserstr=''; 7361: foreach my $user (sort(keys(%allusers))) { 7362: $alluserstr.=$user.'&user:'; 7363: } 7364: $alluserstr=~s/:$//; 7365: return split(/:/,$alluserstr); 7366: } else { 7367: return ('missing user name'); 7368: } 7369: } elsif(!defined($getpropath)) { 7370: my @all_domains = sort(&all_domains()); 7371: foreach my $domain (@all_domains) { 7372: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain'; 7373: } 7374: return @all_domains; 7375: } else { 7376: return ('missing domain'); 7377: } 7378: } 7379: 7380: # --------------------------------------------- GetFileTimestamp 7381: # This function utilizes dirlist and returns the date stamp for 7382: # when it was last modified. It will also return an error of -1 7383: # if an error occurs 7384: 7385: sub GetFileTimestamp { 7386: my ($studentDomain,$studentName,$filename,$getuserdir)=@_; 7387: $studentDomain = &LONCAPA::clean_domain($studentDomain); 7388: $studentName = &LONCAPA::clean_username($studentName); 7389: my ($fileStat) = 7390: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName, 7391: undef,$getuserdir); 7392: my @stats = split('&', $fileStat); 7393: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7394: # @stats contains first the filename, then the stat output 7395: return $stats[10]; # so this is 10 instead of 9. 7396: } else { 7397: return -1; 7398: } 7399: } 7400: 7401: sub stat_file { 7402: my ($uri) = @_; 7403: $uri = &clutter_with_no_wrapper($uri); 7404: 7405: my ($udom,$uname,$file); 7406: if ($uri =~ m-^/(uploaded|editupload)/-) { 7407: ($udom,$uname,$file) = 7408: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-); 7409: $file = 'userfiles/'.$file; 7410: } 7411: if ($uri =~ m-^/res/-) { 7412: ($udom,$uname) = 7413: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-); 7414: $file = $uri; 7415: } 7416: 7417: if (!$udom || !$uname || !$file) { 7418: # unable to handle the uri 7419: return (); 7420: } 7421: my $getpropath; 7422: if ($file =~ /^userfiles\//) { 7423: $getpropath = 1; 7424: } 7425: my ($result) = &dirlist($file,$udom,$uname,$getpropath); 7426: my @stats = split('&', $result); 7427: 7428: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7429: shift(@stats); #filename is first 7430: return @stats; 7431: } 7432: return (); 7433: } 7434: 7435: # -------------------------------------------------------- Value of a Condition 7436: 7437: # gets the value of a specific preevaluated condition 7438: # stored in the string $env{user.state.<cid>} 7439: # or looks up a condition reference in the bighash and if if hasn't 7440: # already been evaluated recurses into docondval to get the value of 7441: # the condition, then memoizing it to 7442: # $env{user.state.<cid>.<condition>} 7443: sub directcondval { 7444: my $number=shift; 7445: if (!defined($env{'user.state.'.$env{'request.course.id'}})) { 7446: &Apache::lonuserstate::evalstate(); 7447: } 7448: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) { 7449: return $env{'user.state.'.$env{'request.course.id'}.".$number"}; 7450: } elsif ($number =~ /^_/) { 7451: my $sub_condition; 7452: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 7453: &GDBM_READER(),0640)) { 7454: $sub_condition=$bighash{'conditions'.$number}; 7455: untie(%bighash); 7456: } 7457: my $value = &docondval($sub_condition); 7458: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value}); 7459: return $value; 7460: } 7461: if ($env{'user.state.'.$env{'request.course.id'}}) { 7462: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1); 7463: } else { 7464: return 2; 7465: } 7466: } 7467: 7468: # get the collection of conditions for this resource 7469: sub condval { 7470: my $condidx=shift; 7471: my $allpathcond=''; 7472: foreach my $cond (split(/\|/,$condidx)) { 7473: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) { 7474: $allpathcond.= 7475: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|'; 7476: } 7477: } 7478: $allpathcond=~s/\|$//; 7479: return &docondval($allpathcond); 7480: } 7481: 7482: #evaluates an expression of conditions 7483: sub docondval { 7484: my ($allpathcond) = @_; 7485: my $result=0; 7486: if ($env{'request.course.id'} 7487: && defined($allpathcond)) { 7488: my $operand='|'; 7489: my @stack; 7490: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|$|$|\&|\|)/g) { 7491: if ($chunk eq '(') { 7492: push @stack,($operand,$result); 7493: } elsif ($chunk eq ')') { 7494: my $before=pop @stack; 7495: if (pop @stack eq '&') { 7496: $result=$result>$before?$before:$result; 7497: } else { 7498: $result=$result>$before?$result:$before; 7499: } 7500: } elsif (($chunk eq '&') || ($chunk eq '|')) { 7501: $operand=$chunk; 7502: } else { 7503: my $new=directcondval($chunk); 7504: if ($operand eq '&') { 7505: $result=$result>$new?$new:$result; 7506: } else { 7507: $result=$result>$new?$result:$new; 7508: } 7509: } 7510: } 7511: } 7512: return $result; 7513: } 7514: 7515: # ---------------------------------------------------- Devalidate courseresdata 7516: 7517: sub devalidatecourseresdata { 7518: my ($coursenum,$coursedomain)=@_; 7519: my $hashid=$coursenum.':'.$coursedomain; 7520: &devalidate_cache_new('courseres',$hashid); 7521: } 7522: 7523: 7524: # --------------------------------------------------- Course Resourcedata Query 7525: # 7526: # Parameters: 7527: # $coursenum - Number of the course. 7528: # $coursedomain - Domain at which the course was created. 7529: # Returns: 7530: # A hash of the course parameters along (I think) with timestamps 7531: # and version info. 7532: 7533: sub get_courseresdata { 7534: my ($coursenum,$coursedomain)=@_; 7535: my $coursehom=&homeserver($coursenum,$coursedomain); 7536: my $hashid=$coursenum.':'.$coursedomain; 7537: my ($result,$cached)=&is_cached_new('courseres',$hashid); 7538: my %dumpreply; 7539: unless (defined($cached)) { 7540: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum); 7541: $result=\%dumpreply; 7542: my ($tmp) = keys(%dumpreply); 7543: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 7544: &do_cache_new('courseres',$hashid,$result,600); 7545: } elsif ($tmp =~ /^(con_lost|no_such_host)/) { 7546: return $tmp; 7547: } elsif ($tmp =~ /^(error)/) { 7548: $result=undef; 7549: &do_cache_new('courseres',$hashid,$result,600); 7550: } 7551: } 7552: return $result; 7553: } 7554: 7555: sub devalidateuserresdata { 7556: my ($uname,$udom)=@_; 7557: my $hashid="$udom:$uname"; 7558: &devalidate_cache_new('userres',$hashid); 7559: } 7560: 7561: sub get_userresdata { 7562: my ($uname,$udom)=@_; 7563: #most student don\'t have any data set, check if there is some data 7564: if (&EXT_cache_status($udom,$uname)) { return undef; } 7565: 7566: my $hashid="$udom:$uname"; 7567: my ($result,$cached)=&is_cached_new('userres',$hashid); 7568: if (!defined($cached)) { 7569: my %resourcedata=&dump('resourcedata',$udom,$uname); 7570: $result=\%resourcedata; 7571: &do_cache_new('userres',$hashid,$result,600); 7572: } 7573: my ($tmp)=keys(%$result); 7574: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) { 7575: return $result; 7576: } 7577: #error 2 occurs when the .db doesn't exist 7578: if ($tmp!~/error: 2 /) { 7579: &logthis("WARNING:". 7580: " Trying to get resource data for ". 7581: $uname." at ".$udom.": ". 7582: $tmp.""); 7583: } elsif ($tmp=~/error: 2 /) { 7584: #&EXT_cache_set($udom,$uname); 7585: &do_cache_new('userres',$hashid,undef,600); 7586: undef($tmp); # not really an error so don't send it back 7587: } 7588: return $tmp; 7589: } 7590: #----------------------------------------------- resdata - return resource data 7591: # Purpose: 7592: # Return resource data for either users or for a course. 7593: # Parameters: 7594: # $name - Course/user name. 7595: # $domain - Name of the domain the user/course is registered on. 7596: # $type - Type of thing $name is (must be 'course' or 'user' 7597: # @which - Array of names of resources desired. 7598: # Returns: 7599: # The value of the first reasource in @which that is found in the 7600: # resource hash. 7601: # Exceptional Conditions: 7602: # If the $type passed in is not valid (not the string 'course' or 7603: # 'user', an undefined reference is returned. 7604: # If none of the resources are found, an undef is returned 7605: sub resdata { 7606: my ($name,$domain,$type,@which)=@_; 7607: my $result; 7608: if ($type eq 'course') { 7609: $result=&get_courseresdata($name,$domain); 7610: } elsif ($type eq 'user') { 7611: $result=&get_userresdata($name,$domain); 7612: } 7613: if (!ref($result)) { return $result; } 7614: foreach my $item (@which) { 7615: if (defined($result->{$item->[0]})) { 7616: return [$result->{$item->[0]},$item->[1]]; 7617: } 7618: } 7619: return undef; 7620: } 7621: 7622: # 7623: # EXT resource caching routines 7624: # 7625: 7626: sub clear_EXT_cache_status { 7627: &delenv('cache.EXT.'); 7628: } 7629: 7630: sub EXT_cache_status { 7631: my ($target_domain,$target_user) = @_; 7632: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 7633: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) { 7634: # We know already the user has no data 7635: return 1; 7636: } else { 7637: return 0; 7638: } 7639: } 7640: 7641: sub EXT_cache_set { 7642: my ($target_domain,$target_user) = @_; 7643: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 7644: #&appenv({$cachename => time}); 7645: } 7646: 7647: # --------------------------------------------------------- Value of a Variable 7648: sub EXT { 7649: 7650: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_; 7651: unless ($varname) { return ''; } 7652: #get real user name/domain, courseid and symb 7653: my $courseid; 7654: my $publicuser; 7655: if ($symbparm) { 7656: $symbparm=&get_symb_from_alias($symbparm); 7657: } 7658: if (!($uname && $udom)) { 7659: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm); 7660: if (!$symbparm) { $symbparm=$cursymb; } 7661: } else { 7662: $courseid=$env{'request.course.id'}; 7663: } 7664: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname); 7665: my $rest; 7666: if (defined($therest[0])) { 7667: $rest=join('.',@therest); 7668: } else { 7669: $rest=''; 7670: } 7671: 7672: my $qualifierrest=$qualifier; 7673: if ($rest) { $qualifierrest.='.'.$rest; } 7674: my $spacequalifierrest=$space; 7675: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; } 7676: if ($realm eq 'user') { 7677: # --------------------------------------------------------------- user.resource 7678: if ($space eq 'resource') { 7679: if ( (defined($Apache::lonhomework::parsing_a_problem) 7680: || defined($Apache::lonhomework::parsing_a_task)) 7681: && 7682: ($symbparm eq &symbread()) ) { 7683: # if we are in the middle of processing the resource the 7684: # get the value we are planning on committing 7685: if (defined($Apache::lonhomework::results{$qualifierrest})) { 7686: return $Apache::lonhomework::results{$qualifierrest}; 7687: } else { 7688: return $Apache::lonhomework::history{$qualifierrest}; 7689: } 7690: } else { 7691: my %restored; 7692: if ($publicuser || $env{'request.state'} eq 'construct') { 7693: %restored=&tmprestore($symbparm,$courseid,$udom,$uname); 7694: } else { 7695: %restored=&restore($symbparm,$courseid,$udom,$uname); 7696: } 7697: return $restored{$qualifierrest}; 7698: } 7699: # ----------------------------------------------------------------- user.access 7700: } elsif ($space eq 'access') { 7701: # FIXME - not supporting calls for a specific user 7702: return &allowed($qualifier,$rest); 7703: # ------------------------------------------ user.preferences, user.environment 7704: } elsif (($space eq 'preferences') || ($space eq 'environment')) { 7705: if (($uname eq $env{'user.name'}) && 7706: ($udom eq $env{'user.domain'})) { 7707: return $env{join('.',('environment',$qualifierrest))}; 7708: } else { 7709: my %returnhash; 7710: if (!$publicuser) { 7711: %returnhash=&userenvironment($udom,$uname, 7712: $qualifierrest); 7713: } 7714: return $returnhash{$qualifierrest}; 7715: } 7716: # ----------------------------------------------------------------- user.course 7717: } elsif ($space eq 'course') { 7718: # FIXME - not supporting calls for a specific user 7719: return $env{join('.',('request.course',$qualifier))}; 7720: # ------------------------------------------------------------------- user.role 7721: } elsif ($space eq 'role') { 7722: # FIXME - not supporting calls for a specific user 7723: my ($role,$where)=split(/\./,$env{'request.role'}); 7724: if ($qualifier eq 'value') { 7725: return $role; 7726: } elsif ($qualifier eq 'extent') { 7727: return $where; 7728: } 7729: # ----------------------------------------------------------------- user.domain 7730: } elsif ($space eq 'domain') { 7731: return $udom; 7732: # ------------------------------------------------------------------- user.name 7733: } elsif ($space eq 'name') { 7734: return $uname; 7735: # ---------------------------------------------------- Any other user namespace 7736: } else { 7737: my %reply; 7738: if (!$publicuser) { 7739: %reply=&get($space,[$qualifierrest],$udom,$uname); 7740: } 7741: return $reply{$qualifierrest}; 7742: } 7743: } elsif ($realm eq 'query') { 7744: # ---------------------------------------------- pull stuff out of query string 7745: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 7746: [$spacequalifierrest]); 7747: return $env{'form.'.$spacequalifierrest}; 7748: } elsif ($realm eq 'request') { 7749: # ------------------------------------------------------------- request.browser 7750: if ($space eq 'browser') { 7751: if ($qualifier eq 'textremote') { 7752: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') { 7753: return 1; 7754: } else { 7755: return 0; 7756: } 7757: } else { 7758: return $env{'browser.'.$qualifier}; 7759: } 7760: # ------------------------------------------------------------ request.filename 7761: } else { 7762: return $env{'request.'.$spacequalifierrest}; 7763: } 7764: } elsif ($realm eq 'course') { 7765: # ---------------------------------------------------------- course.description 7766: return $env{'course.'.$courseid.'.'.$spacequalifierrest}; 7767: } elsif ($realm eq 'resource') { 7768: 7769: if (defined($courseid) && $courseid eq $env{'request.course.id'}) { 7770: if (!$symbparm) { $symbparm=&symbread(); } 7771: } 7772: 7773: if ($space eq 'title') { 7774: if (!$symbparm) { $symbparm = $env{'request.filename'}; } 7775: return &gettitle($symbparm); 7776: } 7777: 7778: if ($space eq 'map') { 7779: my ($map) = &decode_symb($symbparm); 7780: return &symbread($map); 7781: } 7782: if ($space eq 'filename') { 7783: if ($symbparm) { 7784: return &clutter((&decode_symb($symbparm))[2]); 7785: } 7786: return &hreflocation('',$env{'request.filename'}); 7787: } 7788: 7789: my ($section, $group, @groups); 7790: my ($courselevelm,$courselevel); 7791: if ($symbparm && defined($courseid) && 7792: $courseid eq $env{'request.course.id'}) { 7793: 7794: #print ' '.$space.' - '.$qualifier.' - '.$spacequalifierrest; 7795: 7796: # ----------------------------------------------------- Cascading lookup scheme 7797: my $symbp=$symbparm; 7798: my $mapp=&deversion((&decode_symb($symbp))[0]); 7799: 7800: my $symbparm=$symbp.'.'.$spacequalifierrest; 7801: my $mapparm=$mapp.'___(all).'.$spacequalifierrest; 7802: 7803: if (($env{'user.name'} eq $uname) && 7804: ($env{'user.domain'} eq $udom)) { 7805: $section=$env{'request.course.sec'}; 7806: @groups = split(/:/,$env{'request.course.groups'}); 7807: @groups=&sort_course_groups($courseid,@groups); 7808: } else { 7809: if (! defined($usection)) { 7810: $section=&getsection($udom,$uname,$courseid); 7811: } else { 7812: $section = $usection; 7813: } 7814: @groups = &get_users_groups($udom,$uname,$courseid); 7815: } 7816: 7817: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest; 7818: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm; 7819: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm; 7820: 7821: $courselevel=$courseid.'.'.$spacequalifierrest; 7822: my $courselevelr=$courseid.'.'.$symbparm; 7823: $courselevelm=$courseid.'.'.$mapparm; 7824: 7825: # ----------------------------------------------------------- first, check user 7826: 7827: my $userreply=&resdata($uname,$udom,'user', 7828: ([$courselevelr,'resource'], 7829: [$courselevelm,'map' ], 7830: [$courselevel, 'course' ])); 7831: if (defined($userreply)) { return &get_reply($userreply); } 7832: 7833: # ------------------------------------------------ second, check some of course 7834: my $coursereply; 7835: if (@groups > 0) { 7836: $coursereply = &check_group_parms($courseid,\@groups,$symbparm, 7837: $mapparm,$spacequalifierrest); 7838: if (defined($coursereply)) { return &get_reply($coursereply); } 7839: } 7840: 7841: $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 7842: $env{'course.'.$courseid.'.domain'}, 7843: 'course', 7844: ([$seclevelr, 'resource'], 7845: [$seclevelm, 'map' ], 7846: [$seclevel, 'course' ], 7847: [$courselevelr,'resource'])); 7848: if (defined($coursereply)) { return &get_reply($coursereply); } 7849: 7850: # ------------------------------------------------------ third, check map parms 7851: my %parmhash=(); 7852: my $thisparm=''; 7853: if (tie(%parmhash,'GDBM_File', 7854: $env{'request.course.fn'}.'_parms.db', 7855: &GDBM_READER(),0640)) { 7856: $thisparm=$parmhash{$symbparm}; 7857: untie(%parmhash); 7858: } 7859: if ($thisparm) { return &get_reply([$thisparm,'resource']); } 7860: } 7861: # ------------------------------------------ fourth, look in resource metadata 7862: 7863: $spacequalifierrest=~s/\./\_/; 7864: my $filename; 7865: if (!$symbparm) { $symbparm=&symbread(); } 7866: if ($symbparm) { 7867: $filename=(&decode_symb($symbparm))[2]; 7868: } else { 7869: $filename=$env{'request.filename'}; 7870: } 7871: my $metadata=&metadata($filename,$spacequalifierrest); 7872: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 7873: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest); 7874: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 7875: 7876: # ---------------------------------------------- fourth, look in rest of course 7877: if ($symbparm && defined($courseid) && 7878: $courseid eq $env{'request.course.id'}) { 7879: my $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 7880: $env{'course.'.$courseid.'.domain'}, 7881: 'course', 7882: ([$courselevelm,'map' ], 7883: [$courselevel, 'course'])); 7884: if (defined($coursereply)) { return &get_reply($coursereply); } 7885: } 7886: # ------------------------------------------------------------------ Cascade up 7887: unless ($space eq '0') { 7888: my @parts=split(/_/,$space); 7889: my $id=pop(@parts); 7890: my $part=join('_',@parts); 7891: if ($part eq '') { $part='0'; } 7892: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest, 7893: $symbparm,$udom,$uname,$section,1); 7894: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); } 7895: } 7896: if ($recurse) { return undef; } 7897: my $pack_def=&packages_tab_default($filename,$varname); 7898: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); } 7899: # ---------------------------------------------------- Any other user namespace 7900: } elsif ($realm eq 'environment') { 7901: # ----------------------------------------------------------------- environment 7902: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) { 7903: return $env{'environment.'.$spacequalifierrest}; 7904: } else { 7905: if ($uname eq 'anonymous' && $udom eq '') { 7906: return ''; 7907: } 7908: my %returnhash=&userenvironment($udom,$uname, 7909: $spacequalifierrest); 7910: return $returnhash{$spacequalifierrest}; 7911: } 7912: } elsif ($realm eq 'system') { 7913: # ----------------------------------------------------------------- system.time 7914: if ($space eq 'time') { 7915: return time; 7916: } 7917: } elsif ($realm eq 'server') { 7918: # ----------------------------------------------------------------- system.time 7919: if ($space eq 'name') { 7920: return $ENV{'SERVER_NAME'}; 7921: } 7922: } 7923: return ''; 7924: } 7925: 7926: sub get_reply { 7927: my ($reply_value) = @_; 7928: if (ref($reply_value) eq 'ARRAY') { 7929: if (wantarray) { 7930: return @$reply_value; 7931: } 7932: return $reply_value->[0]; 7933: } else { 7934: return $reply_value; 7935: } 7936: } 7937: 7938: sub check_group_parms { 7939: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_; 7940: my @groupitems = (); 7941: my $resultitem; 7942: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']); 7943: foreach my $group (@{$groups}) { 7944: foreach my $level (@levels) { 7945: my $item = $courseid.'.['.$group.'].'.$level->[0]; 7946: push(@groupitems,[$item,$level->[1]]); 7947: } 7948: } 7949: my $coursereply = &resdata($env{'course.'.$courseid.'.num'}, 7950: $env{'course.'.$courseid.'.domain'}, 7951: 'course',@groupitems); 7952: return $coursereply; 7953: } 7954: 7955: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort(). 7956: my ($courseid,@groups) = @_; 7957: @groups = sort(@groups); 7958: return @groups; 7959: } 7960: 7961: sub packages_tab_default { 7962: my ($uri,$varname)=@_; 7963: my (undef,$part,$name)=split(/\./,$varname); 7964: 7965: my (@extension,@specifics,$do_default); 7966: foreach my $package (split(/,/,&metadata($uri,'packages'))) { 7967: my ($pack_type,$pack_part)=split(/_/,$package,2); 7968: if ($pack_type eq 'default') { 7969: $do_default=1; 7970: } elsif ($pack_type eq 'extension') { 7971: push(@extension,[$package,$pack_type,$pack_part]); 7972: } elsif ($pack_part eq $part || $pack_type eq 'part') { 7973: # only look at packages defaults for packages that this id is 7974: push(@specifics,[$package,$pack_type,$pack_part]); 7975: } 7976: } 7977: # first look for a package that matches the requested part id 7978: foreach my $package (@specifics) { 7979: my (undef,$pack_type,$pack_part)=@{$package}; 7980: next if ($pack_part ne $part); 7981: if (defined($packagetab{"$pack_type&$name&default"})) { 7982: return $packagetab{"$pack_type&$name&default"}; 7983: } 7984: } 7985: # look for any possible matching non extension_ package 7986: foreach my $package (@specifics) { 7987: my (undef,$pack_type,$pack_part)=@{$package}; 7988: if (defined($packagetab{"$pack_type&$name&default"})) { 7989: return $packagetab{"$pack_type&$name&default"}; 7990: } 7991: if ($pack_type eq 'part') { $pack_part='0'; } 7992: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) { 7993: return $packagetab{$pack_type."_".$pack_part."&$name&default"}; 7994: } 7995: } 7996: # look for any posible extension_ match 7997: foreach my $package (@extension) { 7998: my ($package,$pack_type)=@{$package}; 7999: if (defined($packagetab{"$pack_type&$name&default"})) { 8000: return $packagetab{"$pack_type&$name&default"}; 8001: } 8002: if (defined($packagetab{$package."&$name&default"})) { 8003: return $packagetab{$package."&$name&default"}; 8004: } 8005: } 8006: # look for a global default setting 8007: if ($do_default && defined($packagetab{"default&$name&default"})) { 8008: return $packagetab{"default&$name&default"}; 8009: } 8010: return undef; 8011: } 8012: 8013: sub add_prefix_and_part { 8014: my ($prefix,$part)=@_; 8015: my $keyroot; 8016: if (defined($prefix) && $prefix !~ /^__/) { 8017: # prefix that has a part already 8018: $keyroot=$prefix; 8019: } elsif (defined($prefix)) { 8020: # prefix that is missing a part 8021: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); } 8022: } else { 8023: # no prefix at all 8024: if (defined($part)) { $keyroot='_'.$part; } 8025: } 8026: return $keyroot; 8027: } 8028: 8029: # ---------------------------------------------------------------- Get metadata 8030: 8031: my %metaentry; 8032: sub metadata { 8033: my ($uri,$what,$liburi,$prefix,$depthcount)=@_; 8034: $uri=&declutter($uri); 8035: # if it is a non metadata possible uri return quickly 8036: if (($uri eq '') || 8037: (($uri =~ m|^/*adm/|) && 8038: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) || 8039: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) { 8040: return undef; 8041: } 8042: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) 8043: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) { 8044: return undef; 8045: } 8046: my $filename=$uri; 8047: $uri=~s/\.meta$//; 8048: # 8049: # Is the metadata already cached? 8050: # Look at timestamp of caching 8051: # Everything is cached by the main uri, libraries are never directly cached 8052: # 8053: if (!defined($liburi)) { 8054: my ($result,$cached)=&is_cached_new('meta',$uri); 8055: if (defined($cached)) { return $result->{':'.$what}; } 8056: } 8057: { 8058: # 8059: # Is this a recursive call for a library? 8060: # 8061: # if (! exists($metacache{$uri})) { 8062: # $metacache{$uri}={}; 8063: # } 8064: my $cachetime = 60*60; 8065: if ($liburi) { 8066: $liburi=&declutter($liburi); 8067: $filename=$liburi; 8068: } else { 8069: &devalidate_cache_new('meta',$uri); 8070: undef(%metaentry); 8071: } 8072: my %metathesekeys=(); 8073: unless ($filename=~/\.meta$/) { $filename.='.meta'; } 8074: my $metastring; 8075: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) { 8076: my $which = &hreflocation('','/'.($liburi || $uri)); 8077: $metastring = 8078: &Apache::lonnet::ssi_body($which, 8079: ('grade_target' => 'meta')); 8080: $cachetime = 1; # only want this cached in the child not long term 8081: } elsif ($uri !~ m -^(editupload)/-) { 8082: my $file=&filelocation('',&clutter($filename)); 8083: #push(@{$metaentry{$uri.'.file'}},$file); 8084: $metastring=&getfile($file); 8085: } 8086: my $parser=HTML::LCParser->new(\$metastring); 8087: my $token; 8088: undef %metathesekeys; 8089: while ($token=$parser->get_token) { 8090: if ($token->[0] eq 'S') { 8091: if (defined($token->[2]->{'package'})) { 8092: # 8093: # This is a package - get package info 8094: # 8095: my $package=$token->[2]->{'package'}; 8096: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8097: if (defined($token->[2]->{'id'})) { 8098: $keyroot.='_'.$token->[2]->{'id'}; 8099: } 8100: if ($metaentry{':packages'}) { 8101: $metaentry{':packages'}.=','.$package.$keyroot; 8102: } else { 8103: $metaentry{':packages'}=$package.$keyroot; 8104: } 8105: foreach my $pack_entry (keys(%packagetab)) { 8106: my $part=$keyroot; 8107: $part=~s/^\_//; 8108: if ($pack_entry=~/^\Q$package\E\&/ || 8109: $pack_entry=~/^\Q$package\E_0\&/) { 8110: my ($pack,$name,$subp)=split(/\&/,$pack_entry); 8111: # ignore package.tab specified default values 8112: # here &package_tab_default() will fetch those 8113: if ($subp eq 'default') { next; } 8114: my $value=$packagetab{$pack_entry}; 8115: my $unikey; 8116: if ($pack =~ /_0$/) { 8117: $unikey='parameter_0_'.$name; 8118: $part=0; 8119: } else { 8120: $unikey='parameter'.$keyroot.'_'.$name; 8121: } 8122: if ($subp eq 'display') { 8123: $value.=' [Part: '.$part.']'; 8124: } 8125: $metaentry{':'.$unikey.'.part'}=$part; 8126: $metathesekeys{$unikey}=1; 8127: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8128: $metaentry{':'.$unikey.'.'.$subp}=$value; 8129: } 8130: if (defined($metaentry{':'.$unikey.'.default'})) { 8131: $metaentry{':'.$unikey}= 8132: $metaentry{':'.$unikey.'.default'}; 8133: } 8134: } 8135: } 8136: } else { 8137: # 8138: # This is not a package - some other kind of start tag 8139: # 8140: my $entry=$token->[1]; 8141: my $unikey; 8142: if ($entry eq 'import') { 8143: $unikey=''; 8144: } else { 8145: $unikey=$entry; 8146: } 8147: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8148: 8149: if (defined($token->[2]->{'id'})) { 8150: $unikey.='_'.$token->[2]->{'id'}; 8151: } 8152: 8153: if ($entry eq 'import') { 8154: # 8155: # Importing a library here 8156: # 8157: if ($depthcount<20) { 8158: my $location=$parser->get_text('/import'); 8159: my $dir=$filename; 8160: $dir=~s|[^/]*$||; 8161: $location=&filelocation($dir,$location); 8162: my $metadata = 8163: &metadata($uri,'keys', $location,$unikey, 8164: $depthcount+1); 8165: foreach my $meta (split(',',$metadata)) { 8166: $metaentry{':'.$meta}=$metaentry{':'.$meta}; 8167: $metathesekeys{$meta}=1; 8168: } 8169: } 8170: } else { 8171: 8172: if (defined($token->[2]->{'name'})) { 8173: $unikey.='_'.$token->[2]->{'name'}; 8174: } 8175: $metathesekeys{$unikey}=1; 8176: foreach my $param (@{$token->[3]}) { 8177: $metaentry{':'.$unikey.'.'.$param} = 8178: $token->[2]->{$param}; 8179: } 8180: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry)); 8181: my $default=$metaentry{':'.$unikey.'.default'}; 8182: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) { 8183: # only ws inside the tag, and not in default, so use default 8184: # as value 8185: $metaentry{':'.$unikey}=$default; 8186: } elsif ( $internaltext =~ /\S/ ) { 8187: # something interesting inside the tag 8188: $metaentry{':'.$unikey}=$internaltext; 8189: } else { 8190: # no interesting values, don't set a default 8191: } 8192: # end of not-a-package not-a-library import 8193: } 8194: # end of not-a-package start tag 8195: } 8196: # the next is the end of "start tag" 8197: } 8198: } 8199: my ($extension) = ($uri =~ /\.(\w+)$/); 8200: $extension = lc($extension); 8201: if ($extension eq 'htm') { $extension='html'; } 8202: 8203: foreach my $key (keys(%packagetab)) { 8204: #no specific packages #how's our extension 8205: if ($key!~/^extension_\Q$extension\E&/) { next; } 8206: &metadata_create_package_def($uri,$key,'extension_'.$extension, 8207: \%metathesekeys); 8208: } 8209: 8210: if (!exists($metaentry{':packages'}) 8211: || $packagetab{"import_defaults&extension_$extension"}) { 8212: foreach my $key (keys(%packagetab)) { 8213: #no specific packages well let's get default then 8214: if ($key!~/^default&/) { next; } 8215: &metadata_create_package_def($uri,$key,'default', 8216: \%metathesekeys); 8217: } 8218: } 8219: # are there custom rights to evaluate 8220: if ($metaentry{':copyright'} eq 'custom') { 8221: 8222: # 8223: # Importing a rights file here 8224: # 8225: unless ($depthcount) { 8226: my $location=$metaentry{':customdistributionfile'}; 8227: my $dir=$filename; 8228: $dir=~s|[^/]*$||; 8229: $location=&filelocation($dir,$location); 8230: my $rights_metadata = 8231: &metadata($uri,'keys',$location,'_rights', 8232: $depthcount+1); 8233: foreach my $rights (split(',',$rights_metadata)) { 8234: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights}; 8235: $metathesekeys{$rights}=1; 8236: } 8237: } 8238: } 8239: # uniqifiy package listing 8240: my %seen; 8241: my @uniq_packages = 8242: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'})); 8243: $metaentry{':packages'} = join(',',@uniq_packages); 8244: 8245: $metaentry{':keys'} = join(',',keys(%metathesekeys)); 8246: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri); 8247: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys); 8248: &do_cache_new('meta',$uri,\%metaentry,$cachetime); 8249: # this is the end of "was not already recently cached 8250: } 8251: return $metaentry{':'.$what}; 8252: } 8253: 8254: sub metadata_create_package_def { 8255: my ($uri,$key,$package,$metathesekeys)=@_; 8256: my ($pack,$name,$subp)=split(/\&/,$key); 8257: if ($subp eq 'default') { next; } 8258: 8259: if (defined($metaentry{':packages'})) { 8260: $metaentry{':packages'}.=','.$package; 8261: } else { 8262: $metaentry{':packages'}=$package; 8263: } 8264: my $value=$packagetab{$key}; 8265: my $unikey; 8266: $unikey='parameter_0_'.$name; 8267: $metaentry{':'.$unikey.'.part'}=0; 8268: $$metathesekeys{$unikey}=1; 8269: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8270: $metaentry{':'.$unikey.'.'.$subp}=$value; 8271: } 8272: if (defined($metaentry{':'.$unikey.'.default'})) { 8273: $metaentry{':'.$unikey}= 8274: $metaentry{':'.$unikey.'.default'}; 8275: } 8276: } 8277: 8278: sub metadata_generate_part0 { 8279: my ($metadata,$metacache,$uri) = @_; 8280: my %allnames; 8281: foreach my $metakey (keys(%$metadata)) { 8282: if ($metakey=~/^parameter\_(.*)/) { 8283: my $part=$$metacache{':'.$metakey.'.part'}; 8284: my $name=$$metacache{':'.$metakey.'.name'}; 8285: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) { 8286: $allnames{$name}=$part; 8287: } 8288: } 8289: } 8290: foreach my $name (keys(%allnames)) { 8291: $$metadata{"parameter_0_$name"}=1; 8292: my $key=":parameter_0_$name"; 8293: $$metacache{"$key.part"}='0'; 8294: $$metacache{"$key.name"}=$name; 8295: $$metacache{"$key.type"}=$$metacache{':parameter_'. 8296: $allnames{$name}.'_'.$name. 8297: '.type'}; 8298: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name. 8299: '.display'}; 8300: my $expr='[Part: '.$allnames{$name}.']'; 8301: $olddis=~s/\Q$expr\E/\[Part: 0\]/; 8302: $$metacache{"$key.display"}=$olddis; 8303: } 8304: } 8305: 8306: # ------------------------------------------------------ Devalidate title cache 8307: 8308: sub devalidate_title_cache { 8309: my ($url)=@_; 8310: if (!$env{'request.course.id'}) { return; } 8311: my $symb=&symbread($url); 8312: if (!$symb) { return; } 8313: my $key=$env{'request.course.id'}."\0".$symb; 8314: &devalidate_cache_new('title',$key); 8315: } 8316: 8317: # ------------------------------------------------- Get the title of a course 8318: 8319: sub current_course_title { 8320: return $env{ 'course.' . $env{'request.course.id'} . '.description' }; 8321: } 8322: # ------------------------------------------------- Get the title of a resource 8323: 8324: sub gettitle { 8325: my $urlsymb=shift; 8326: my $symb=&symbread($urlsymb); 8327: if ($symb) { 8328: my $key=$env{'request.course.id'}."\0".$symb; 8329: my ($result,$cached)=&is_cached_new('title',$key); 8330: if (defined($cached)) { 8331: return $result; 8332: } 8333: my ($map,$resid,$url)=&decode_symb($symb); 8334: my $title=''; 8335: if (!$map && $resid == 0 && $url =~/default\.sequence$/) { 8336: $title = $env{'course.'.$env{'request.course.id'}.'.description'}; 8337: } else { 8338: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8339: &GDBM_READER(),0640)) { 8340: my $mapid=$bighash{'map_pc_'.&clutter($map)}; 8341: $title=$bighash{'title_'.$mapid.'.'.$resid}; 8342: untie(%bighash); 8343: } 8344: } 8345: $title=~s/\&colon\;/\:/gs; 8346: if ($title) { 8347: return &do_cache_new('title',$key,$title,600); 8348: } 8349: $urlsymb=$url; 8350: } 8351: my $title=&metadata($urlsymb,'title'); 8352: if (!$title) { $title=(split('/',$urlsymb))[-1]; } 8353: return $title; 8354: } 8355: 8356: sub get_slot { 8357: my ($which,$cnum,$cdom)=@_; 8358: if (!$cnum || !$cdom) { 8359: (undef,my $courseid)=&whichuser(); 8360: $cdom=$env{'course.'.$courseid.'.domain'}; 8361: $cnum=$env{'course.'.$courseid.'.num'}; 8362: } 8363: my $key=join("\0",'slots',$cdom,$cnum,$which); 8364: my %slotinfo; 8365: if (exists($remembered{$key})) { 8366: $slotinfo{$which} = $remembered{$key}; 8367: } else { 8368: %slotinfo=&get('slots',[$which],$cdom,$cnum); 8369: &Apache::lonhomework::showhash(%slotinfo); 8370: my ($tmp)=keys(%slotinfo); 8371: if ($tmp=~/^error:/) { return (); } 8372: $remembered{$key} = $slotinfo{$which}; 8373: } 8374: if (ref($slotinfo{$which}) eq 'HASH') { 8375: return %{$slotinfo{$which}}; 8376: } 8377: return $slotinfo{$which}; 8378: } 8379: # ------------------------------------------------- Update symbolic store links 8380: 8381: sub symblist { 8382: my ($mapname,%newhash)=@_; 8383: $mapname=&deversion(&declutter($mapname)); 8384: my %hash; 8385: if (($env{'request.course.fn'}) && (%newhash)) { 8386: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 8387: &GDBM_WRCREAT(),0640)) { 8388: foreach my $url (keys(%newhash)) { 8389: next if ($url eq 'last_known' 8390: && $env{'form.no_update_last_known'}); 8391: $hash{declutter($url)}=&encode_symb($mapname, 8392: $newhash{$url}->[1], 8393: $newhash{$url}->[0]); 8394: } 8395: if (untie(%hash)) { 8396: return 'ok'; 8397: } 8398: } 8399: } 8400: return 'error'; 8401: } 8402: 8403: # --------------------------------------------------------------- Verify a symb 8404: 8405: sub symbverify { 8406: my ($symb,$thisurl)=@_; 8407: my $thisfn=$thisurl; 8408: $thisfn=&declutter($thisfn); 8409: # direct jump to resource in page or to a sequence - will construct own symbs 8410: if ($thisfn=~/\.(page|sequence)$/) { return 1; } 8411: # check URL part 8412: my ($map,$resid,$url)=&decode_symb($symb); 8413: 8414: unless ($url eq $thisfn) { return 0; } 8415: 8416: $symb=&symbclean($symb); 8417: $thisurl=&deversion($thisurl); 8418: $thisfn=&deversion($thisfn); 8419: 8420: my %bighash; 8421: my $okay=0; 8422: 8423: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8424: &GDBM_READER(),0640)) { 8425: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) { 8426: $thisurl =~ s/\?.+$//; 8427: } 8428: my $ids=$bighash{'ids_'.&clutter($thisurl)}; 8429: unless ($ids) { 8430: $ids=$bighash{'ids_/'.$thisurl}; 8431: } 8432: if ($ids) { 8433: # ------------------------------------------------------------------- Has ID(s) 8434: foreach my $id (split(/\,/,$ids)) { 8435: my ($mapid,$resid)=split(/\./,$id); 8436: if ($thisfn =~ m{^/adm/wrapper/ext/}) { 8437: $symb =~ s/\?.+$//; 8438: } 8439: if ( 8440: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn) 8441: eq $symb) { 8442: if (($env{'request.role.adv'}) || 8443: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) { 8444: $okay=1; 8445: } 8446: } 8447: } 8448: } 8449: untie(%bighash); 8450: } 8451: return $okay; 8452: } 8453: 8454: # --------------------------------------------------------------- Clean-up symb 8455: 8456: sub symbclean { 8457: my $symb=shift; 8458: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 8459: # remove version from map 8460: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/; 8461: 8462: # remove version from URL 8463: $symb=~s/\.(\d+)\.(\w+)$/\.$2/; 8464: 8465: # remove wrapper 8466: 8467: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/; 8468: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/; 8469: return $symb; 8470: } 8471: 8472: # ---------------------------------------------- Split symb to find map and url 8473: 8474: sub encode_symb { 8475: my ($map,$resid,$url)=@_; 8476: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url)); 8477: } 8478: 8479: sub decode_symb { 8480: my $symb=shift; 8481: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 8482: my ($map,$resid,$url)=split(/___/,$symb); 8483: return (&fixversion($map),$resid,&fixversion($url)); 8484: } 8485: 8486: sub fixversion { 8487: my $fn=shift; 8488: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; } 8489: my %bighash; 8490: my $uri=&clutter($fn); 8491: my $key=$env{'request.course.id'}.'_'.$uri; 8492: # is this cached? 8493: my ($result,$cached)=&is_cached_new('courseresversion',$key); 8494: if (defined($cached)) { return $result; } 8495: # unfortunately not cached, or expired 8496: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8497: &GDBM_READER(),0640)) { 8498: if ($bighash{'version_'.$uri}) { 8499: my $version=$bighash{'version_'.$uri}; 8500: unless (($version eq 'mostrecent') || 8501: ($version==&getversion($uri))) { 8502: $uri=~s/\.(\w+)$/\.$version\.$1/; 8503: } 8504: } 8505: untie %bighash; 8506: } 8507: return &do_cache_new('courseresversion',$key,&declutter($uri),600); 8508: } 8509: 8510: sub deversion { 8511: my $url=shift; 8512: $url=~s/\.\d+\.(\w+)$/\.$1/; 8513: return $url; 8514: } 8515: 8516: # ------------------------------------------------------ Return symb list entry 8517: 8518: sub symbread { 8519: my ($thisfn,$donotrecurse)=@_; 8520: my $cache_str='request.symbread.cached.'.$thisfn; 8521: if (defined($env{$cache_str})) { return $env{$cache_str}; } 8522: # no filename provided? try from environment 8523: unless ($thisfn) { 8524: if ($env{'request.symb'}) { 8525: return $env{$cache_str}=&symbclean($env{'request.symb'}); 8526: } 8527: $thisfn=$env{'request.filename'}; 8528: } 8529: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 8530: # is that filename actually a symb? Verify, clean, and return 8531: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) { 8532: if (&symbverify($thisfn,$1)) { 8533: return $env{$cache_str}=&symbclean($thisfn); 8534: } 8535: } 8536: $thisfn=declutter($thisfn); 8537: my %hash; 8538: my %bighash; 8539: my $syval=''; 8540: if (($env{'request.course.fn'}) && ($thisfn)) { 8541: my $targetfn = $thisfn; 8542: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) { 8543: $targetfn = 'adm/wrapper/'.$thisfn; 8544: } 8545: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) { 8546: $targetfn=$1; 8547: } 8548: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 8549: &GDBM_READER(),0640)) { 8550: $syval=$hash{$targetfn}; 8551: untie(%hash); 8552: } 8553: # ---------------------------------------------------------- There was an entry 8554: if ($syval) { 8555: #unless ($syval=~/\_\d+$/) { 8556: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) { 8557: #&appenv({'request.ambiguous' => $thisfn}); 8558: #return $env{$cache_str}=''; 8559: #} 8560: #$syval.=$1; 8561: #} 8562: } else { 8563: # ------------------------------------------------------- Was not in symb table 8564: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8565: &GDBM_READER(),0640)) { 8566: # ---------------------------------------------- Get ID(s) for current resource 8567: my $ids=$bighash{'ids_'.&clutter($thisfn)}; 8568: unless ($ids) { 8569: $ids=$bighash{'ids_/'.$thisfn}; 8570: } 8571: unless ($ids) { 8572: # alias? 8573: $ids=$bighash{'mapalias_'.$thisfn}; 8574: } 8575: if ($ids) { 8576: # ------------------------------------------------------------------- Has ID(s) 8577: my @possibilities=split(/\,/,$ids); 8578: if ($#possibilities==0) { 8579: # ----------------------------------------------- There is only one possibility 8580: my ($mapid,$resid)=split(/\./,$ids); 8581: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 8582: $resid,$thisfn); 8583: } elsif (!$donotrecurse) { 8584: # ------------------------------------------ There is more than one possibility 8585: my $realpossible=0; 8586: foreach my $id (@possibilities) { 8587: my $file=$bighash{'src_'.$id}; 8588: if (&allowed('bre',$file)) { 8589: my ($mapid,$resid)=split(/\./,$id); 8590: if ($bighash{'map_type_'.$mapid} ne 'page') { 8591: $realpossible++; 8592: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 8593: $resid,$thisfn); 8594: } 8595: } 8596: } 8597: if ($realpossible!=1) { $syval=''; } 8598: } else { 8599: $syval=''; 8600: } 8601: } 8602: untie(%bighash) 8603: } 8604: } 8605: if ($syval) { 8606: return $env{$cache_str}=$syval; 8607: } 8608: } 8609: &appenv({'request.ambiguous' => $thisfn}); 8610: return $env{$cache_str}=''; 8611: } 8612: 8613: # ---------------------------------------------------------- Return random seed 8614: 8615: sub numval { 8616: my $txt=shift; 8617: $txt=~tr/A-J/0-9/; 8618: $txt=~tr/a-j/0-9/; 8619: $txt=~tr/K-T/0-9/; 8620: $txt=~tr/k-t/0-9/; 8621: $txt=~tr/U-Z/0-5/; 8622: $txt=~tr/u-z/0-5/; 8623: $txt=~s/\D//g; 8624: if ($_64bit) { if ($txt > 2**32) { return -1; } } 8625: return int($txt); 8626: } 8627: 8628: sub numval2 { 8629: my $txt=shift; 8630: $txt=~tr/A-J/0-9/; 8631: $txt=~tr/a-j/0-9/; 8632: $txt=~tr/K-T/0-9/; 8633: $txt=~tr/k-t/0-9/; 8634: $txt=~tr/U-Z/0-5/; 8635: $txt=~tr/u-z/0-5/; 8636: $txt=~s/\D//g; 8637: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 8638: my $total; 8639: foreach my $val (@txts) { $total+=$val; } 8640: if ($_64bit) { if ($total > 2**32) { return -1; } } 8641: return int($total); 8642: } 8643: 8644: sub numval3 { 8645: use integer; 8646: my $txt=shift; 8647: $txt=~tr/A-J/0-9/; 8648: $txt=~tr/a-j/0-9/; 8649: $txt=~tr/K-T/0-9/; 8650: $txt=~tr/k-t/0-9/; 8651: $txt=~tr/U-Z/0-5/; 8652: $txt=~tr/u-z/0-5/; 8653: $txt=~s/\D//g; 8654: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 8655: my $total; 8656: foreach my $val (@txts) { $total+=$val; } 8657: if ($_64bit) { $total=(($total<<32)>>32); } 8658: return $total; 8659: } 8660: 8661: sub digest { 8662: my ($data)=@_; 8663: my $digest=&Digest::MD5::md5($data); 8664: my ($a,$b,$c,$d)=unpack("iiii",$digest); 8665: my ($e,$f); 8666: { 8667: use integer; 8668: $e=($a+$b); 8669: $f=($c+$d); 8670: if ($_64bit) { 8671: $e=(($e<<32)>>32); 8672: $f=(($f<<32)>>32); 8673: } 8674: } 8675: if (wantarray) { 8676: return ($e,$f); 8677: } else { 8678: my $g; 8679: { 8680: use integer; 8681: $g=($e+$f); 8682: if ($_64bit) { 8683: $g=(($g<<32)>>32); 8684: } 8685: } 8686: return $g; 8687: } 8688: } 8689: 8690: sub latest_rnd_algorithm_id { 8691: return '64bit5'; 8692: } 8693: 8694: sub get_rand_alg { 8695: my ($courseid)=@_; 8696: if (!$courseid) { $courseid=(&whichuser())[1]; } 8697: if ($courseid) { 8698: return $env{"course.$courseid.rndseed"}; 8699: } 8700: return &latest_rnd_algorithm_id(); 8701: } 8702: 8703: sub validCODE { 8704: my ($CODE)=@_; 8705: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; } 8706: return 0; 8707: } 8708: 8709: sub getCODE { 8710: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; } 8711: if ( (defined($Apache::lonhomework::parsing_a_problem) || 8712: defined($Apache::lonhomework::parsing_a_task) ) && 8713: &validCODE($Apache::lonhomework::history{'resource.CODE'})) { 8714: return $Apache::lonhomework::history{'resource.CODE'}; 8715: } 8716: return undef; 8717: } 8718: 8719: sub rndseed { 8720: my ($symb,$courseid,$domain,$username)=@_; 8721: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser(); 8722: if (!defined($symb)) { 8723: unless ($symb=$wsymb) { return time; } 8724: } 8725: if (!$courseid) { $courseid=$wcourseid; } 8726: if (!$domain) { $domain=$wdomain; } 8727: if (!$username) { $username=$wusername } 8728: my $which=&get_rand_alg(); 8729: 8730: if (defined(&getCODE())) { 8731: if ($which eq '64bit5') { 8732: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username); 8733: } elsif ($which eq '64bit4') { 8734: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username); 8735: } else { 8736: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username); 8737: } 8738: } elsif ($which eq '64bit5') { 8739: return &rndseed_64bit5($symb,$courseid,$domain,$username); 8740: } elsif ($which eq '64bit4') { 8741: return &rndseed_64bit4($symb,$courseid,$domain,$username); 8742: } elsif ($which eq '64bit3') { 8743: return &rndseed_64bit3($symb,$courseid,$domain,$username); 8744: } elsif ($which eq '64bit2') { 8745: return &rndseed_64bit2($symb,$courseid,$domain,$username); 8746: } elsif ($which eq '64bit') { 8747: return &rndseed_64bit($symb,$courseid,$domain,$username); 8748: } 8749: return &rndseed_32bit($symb,$courseid,$domain,$username); 8750: } 8751: 8752: sub rndseed_32bit { 8753: my ($symb,$courseid,$domain,$username)=@_; 8754: { 8755: use integer; 8756: my $symbchck=unpack("%32C*",$symb) << 27; 8757: my $symbseed=numval($symb) << 22; 8758: my $namechck=unpack("%32C*",$username) << 17; 8759: my $nameseed=numval($username) << 12; 8760: my $domainseed=unpack("%32C*",$domain) << 7; 8761: my $courseseed=unpack("%32C*",$courseid); 8762: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck; 8763: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 8764: #&logthis("rndseed :$num:$symb"); 8765: if ($_64bit) { $num=(($num<<32)>>32); } 8766: return $num; 8767: } 8768: } 8769: 8770: sub rndseed_64bit { 8771: my ($symb,$courseid,$domain,$username)=@_; 8772: { 8773: use integer; 8774: my $symbchck=unpack("%32S*",$symb) << 21; 8775: my $symbseed=numval($symb) << 10; 8776: my $namechck=unpack("%32S*",$username); 8777: 8778: my $nameseed=numval($username) << 21; 8779: my $domainseed=unpack("%32S*",$domain) << 10; 8780: my $courseseed=unpack("%32S*",$courseid); 8781: 8782: my $num1=$symbchck+$symbseed+$namechck; 8783: my $num2=$nameseed+$domainseed+$courseseed; 8784: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 8785: #&logthis("rndseed :$num:$symb"); 8786: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 8787: return "$num1,$num2"; 8788: } 8789: } 8790: 8791: sub rndseed_64bit2 { 8792: my ($symb,$courseid,$domain,$username)=@_; 8793: { 8794: use integer; 8795: # strings need to be an even # of cahracters long, it it is odd the 8796: # last characters gets thrown away 8797: my $symbchck=unpack("%32S*",$symb.' ') << 21; 8798: my $symbseed=numval($symb) << 10; 8799: my $namechck=unpack("%32S*",$username.' '); 8800: 8801: my $nameseed=numval($username) << 21; 8802: my $domainseed=unpack("%32S*",$domain.' ') << 10; 8803: my $courseseed=unpack("%32S*",$courseid.' '); 8804: 8805: my $num1=$symbchck+$symbseed+$namechck; 8806: my $num2=$nameseed+$domainseed+$courseseed; 8807: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 8808: #&logthis("rndseed :$num:$symb"); 8809: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 8810: return "$num1,$num2"; 8811: } 8812: } 8813: 8814: sub rndseed_64bit3 { 8815: my ($symb,$courseid,$domain,$username)=@_; 8816: { 8817: use integer; 8818: # strings need to be an even # of cahracters long, it it is odd the 8819: # last characters gets thrown away 8820: my $symbchck=unpack("%32S*",$symb.' ') << 21; 8821: my $symbseed=numval2($symb) << 10; 8822: my $namechck=unpack("%32S*",$username.' '); 8823: 8824: my $nameseed=numval2($username) << 21; 8825: my $domainseed=unpack("%32S*",$domain.' ') << 10; 8826: my $courseseed=unpack("%32S*",$courseid.' '); 8827: 8828: my $num1=$symbchck+$symbseed+$namechck; 8829: my $num2=$nameseed+$domainseed+$courseseed; 8830: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 8831: #&logthis("rndseed :$num1:$num2:$_64bit"); 8832: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 8833: 8834: return "$num1:$num2"; 8835: } 8836: } 8837: 8838: sub rndseed_64bit4 { 8839: my ($symb,$courseid,$domain,$username)=@_; 8840: { 8841: use integer; 8842: # strings need to be an even # of cahracters long, it it is odd the 8843: # last characters gets thrown away 8844: my $symbchck=unpack("%32S*",$symb.' ') << 21; 8845: my $symbseed=numval3($symb) << 10; 8846: my $namechck=unpack("%32S*",$username.' '); 8847: 8848: my $nameseed=numval3($username) << 21; 8849: my $domainseed=unpack("%32S*",$domain.' ') << 10; 8850: my $courseseed=unpack("%32S*",$courseid.' '); 8851: 8852: my $num1=$symbchck+$symbseed+$namechck; 8853: my $num2=$nameseed+$domainseed+$courseseed; 8854: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 8855: #&logthis("rndseed :$num1:$num2:$_64bit"); 8856: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 8857: 8858: return "$num1:$num2"; 8859: } 8860: } 8861: 8862: sub rndseed_64bit5 { 8863: my ($symb,$courseid,$domain,$username)=@_; 8864: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username"); 8865: return "$num1:$num2"; 8866: } 8867: 8868: sub rndseed_CODE_64bit { 8869: my ($symb,$courseid,$domain,$username)=@_; 8870: { 8871: use integer; 8872: my $symbchck=unpack("%32S*",$symb.' ') << 16; 8873: my $symbseed=numval2($symb); 8874: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 8875: my $CODEseed=numval(&getCODE()); 8876: my $courseseed=unpack("%32S*",$courseid.' '); 8877: my $num1=$symbseed+$CODEchck; 8878: my $num2=$CODEseed+$courseseed+$symbchck; 8879: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 8880: #&logthis("rndseed :$num1:$num2:$symb"); 8881: if ($_64bit) { $num1=(($num1<<32)>>32); } 8882: if ($_64bit) { $num2=(($num2<<32)>>32); } 8883: return "$num1:$num2"; 8884: } 8885: } 8886: 8887: sub rndseed_CODE_64bit4 { 8888: my ($symb,$courseid,$domain,$username)=@_; 8889: { 8890: use integer; 8891: my $symbchck=unpack("%32S*",$symb.' ') << 16; 8892: my $symbseed=numval3($symb); 8893: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 8894: my $CODEseed=numval3(&getCODE()); 8895: my $courseseed=unpack("%32S*",$courseid.' '); 8896: my $num1=$symbseed+$CODEchck; 8897: my $num2=$CODEseed+$courseseed+$symbchck; 8898: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 8899: #&logthis("rndseed :$num1:$num2:$symb"); 8900: if ($_64bit) { $num1=(($num1<<32)>>32); } 8901: if ($_64bit) { $num2=(($num2<<32)>>32); } 8902: return "$num1:$num2"; 8903: } 8904: } 8905: 8906: sub rndseed_CODE_64bit5 { 8907: my ($symb,$courseid,$domain,$username)=@_; 8908: my $code = &getCODE(); 8909: my ($num1,$num2)=&digest("$symb,$courseid,$code"); 8910: return "$num1:$num2"; 8911: } 8912: 8913: sub setup_random_from_rndseed { 8914: my ($rndseed)=@_; 8915: if ($rndseed =~/([,:])/) { 8916: my ($num1,$num2)=split(/[,:]/,$rndseed); 8917: &Math::Random::random_set_seed(abs($num1),abs($num2)); 8918: } else { 8919: &Math::Random::random_set_seed_from_phrase($rndseed); 8920: } 8921: } 8922: 8923: sub latest_receipt_algorithm_id { 8924: return 'receipt3'; 8925: } 8926: 8927: sub recunique { 8928: my $fucourseid=shift; 8929: my $unique; 8930: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' || 8931: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 8932: $unique=$env{"course.$fucourseid.internal.encseed"}; 8933: } else { 8934: $unique=$perlvar{'lonReceipt'}; 8935: } 8936: return unpack("%32C*",$unique); 8937: } 8938: 8939: sub recprefix { 8940: my $fucourseid=shift; 8941: my $prefix; 8942: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'|| 8943: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 8944: $prefix=$env{"course.$fucourseid.internal.encpref"}; 8945: } else { 8946: $prefix=$perlvar{'lonHostID'}; 8947: } 8948: return unpack("%32C*",$prefix); 8949: } 8950: 8951: sub ireceipt { 8952: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_; 8953: 8954: my $return =&recprefix($fucourseid).'-'; 8955: 8956: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' || 8957: $env{'request.state'} eq 'construct') { 8958: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000); 8959: return $return; 8960: } 8961: 8962: my $cuname=unpack("%32C*",$funame); 8963: my $cudom=unpack("%32C*",$fudom); 8964: my $cucourseid=unpack("%32C*",$fucourseid); 8965: my $cusymb=unpack("%32C*",$fusymb); 8966: my $cunique=&recunique($fucourseid); 8967: my $cpart=unpack("%32S*",$part); 8968: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') { 8969: 8970: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom)); 8971: 8972: $return.= ($cunique%$cuname+ 8973: $cunique%$cudom+ 8974: $cusymb%$cuname+ 8975: $cusymb%$cudom+ 8976: $cucourseid%$cuname+ 8977: $cucourseid%$cudom+ 8978: $cpart%$cuname+ 8979: $cpart%$cudom); 8980: } else { 8981: $return.= ($cunique%$cuname+ 8982: $cunique%$cudom+ 8983: $cusymb%$cuname+ 8984: $cusymb%$cudom+ 8985: $cucourseid%$cuname+ 8986: $cucourseid%$cudom); 8987: } 8988: return $return; 8989: } 8990: 8991: sub receipt { 8992: my ($part)=@_; 8993: my ($symb,$courseid,$domain,$name) = &whichuser(); 8994: return &ireceipt($name,$domain,$courseid,$symb,$part); 8995: } 8996: 8997: sub whichuser { 8998: my ($passedsymb)=@_; 8999: my ($symb,$courseid,$domain,$name,$publicuser); 9000: if (defined($env{'form.grade_symb'})) { 9001: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid'); 9002: my $allowed=&allowed('vgr',$tmp_courseid); 9003: if (!$allowed && 9004: exists($env{'request.course.sec'}) && 9005: $env{'request.course.sec'} !~ /^\s*$/) { 9006: $allowed=&allowed('vgr',$tmp_courseid. 9007: '/'.$env{'request.course.sec'}); 9008: } 9009: if ($allowed) { 9010: ($symb)=&get_env_multiple('form.grade_symb'); 9011: $courseid=$tmp_courseid; 9012: ($domain)=&get_env_multiple('form.grade_domain'); 9013: ($name)=&get_env_multiple('form.grade_username'); 9014: return ($symb,$courseid,$domain,$name,$publicuser); 9015: } 9016: } 9017: if (!$passedsymb) { 9018: $symb=&symbread(); 9019: } else { 9020: $symb=$passedsymb; 9021: } 9022: $courseid=$env{'request.course.id'}; 9023: $domain=$env{'user.domain'}; 9024: $name=$env{'user.name'}; 9025: if ($name eq 'public' && $domain eq 'public') { 9026: if (!defined($env{'form.username'})) { 9027: $env{'form.username'}.=time.rand(10000000); 9028: } 9029: $name.=$env{'form.username'}; 9030: } 9031: return ($symb,$courseid,$domain,$name,$publicuser); 9032: 9033: } 9034: 9035: # ------------------------------------------------------------ Serves up a file 9036: # returns either the contents of the file or 9037: # -1 if the file doesn't exist 9038: # 9039: # if the target is a file that was uploaded via DOCS, 9040: # a check will be made to see if a current copy exists on the local server, 9041: # if it does this will be served, otherwise a copy will be retrieved from 9042: # the home server for the course and stored in /home/httpd/html/userfiles on 9043: # the local server. 9044: 9045: sub getfile { 9046: my ($file) = @_; 9047: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9048: &repcopy($file); 9049: return &readfile($file); 9050: } 9051: 9052: sub repcopy_userfile { 9053: my ($file)=@_; 9054: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9055: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 9056: my ($cdom,$cnum,$filename) = 9057: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|); 9058: my $uri="/uploaded/$cdom/$cnum/$filename"; 9059: if (-e "$file") { 9060: # we already have a local copy, check it out 9061: my @fileinfo = stat($file); 9062: my $rtncode; 9063: my $info; 9064: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode); 9065: if ($lwpresp ne 'ok') { 9066: # there is no such file anymore, even though we had a local copy 9067: if ($rtncode eq '404') { 9068: unlink($file); 9069: } 9070: return -1; 9071: } 9072: if ($info < $fileinfo[9]) { 9073: # nice, the file we have is up-to-date, just say okay 9074: return 'ok'; 9075: } else { 9076: # the file is outdated, get rid of it 9077: unlink($file); 9078: } 9079: } 9080: # one way or the other, at this point, we don't have the file 9081: # construct the correct path for the file 9082: my @parts = ($cdom,$cnum); 9083: if ($filename =~ m|^(.+)/[^/]+$|) { 9084: push @parts, split(/\//,$1); 9085: } 9086: my $path = $perlvar{'lonDocRoot'}.'/userfiles'; 9087: foreach my $part (@parts) { 9088: $path .= '/'.$part; 9089: if (!-e $path) { 9090: mkdir($path,0770); 9091: } 9092: } 9093: # now the path exists for sure 9094: # get a user agent 9095: my $ua=new LWP::UserAgent; 9096: my $transferfile=$file.'.in.transfer'; 9097: # FIXME: this should flock 9098: if (-e $transferfile) { return 'ok'; } 9099: my $request; 9100: $uri=~s/^\///; 9101: my $homeserver = &homeserver($cnum,$cdom); 9102: my $protocol = $protocol{$homeserver}; 9103: $protocol = 'http' if ($protocol ne 'https'); 9104: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri); 9105: my $response=$ua->request($request,$transferfile); 9106: # did it work? 9107: if ($response->is_error()) { 9108: unlink($transferfile); 9109: &logthis("Userfile repcopy failed for $uri"); 9110: return -1; 9111: } 9112: # worked, rename the transfer file 9113: rename($transferfile,$file); 9114: return 'ok'; 9115: } 9116: 9117: sub tokenwrapper { 9118: my $uri=shift; 9119: $uri=~s|^https?\://([^/]+)||; 9120: $uri=~s|^/||; 9121: $env{'user.environment'}=~/\/([^\/]+)\.id/; 9122: my $token=$1; 9123: my (undef,$udom,$uname,$file)=split('/',$uri,4); 9124: if ($udom && $uname && $file) { 9125: $file=~s|(\?\.*)*$||; 9126: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}}); 9127: my $homeserver = &homeserver($uname,$udom); 9128: my $protocol = $protocol{$homeserver}; 9129: $protocol = 'http' if ($protocol ne 'https'); 9130: return $protocol.'://'.&hostname($homeserver).'/'.$uri. 9131: (($uri=~/\?/)?'&':'?').'token='.$token. 9132: '&tokenissued='.$perlvar{'lonHostID'}; 9133: } else { 9134: return '/adm/notfound.html'; 9135: } 9136: } 9137: 9138: # call with reqtype HEAD: get last modification time 9139: # call with reqtype GET: get the file contents 9140: # Do not call this with reqtype GET for large files! It loads everything into memory 9141: # 9142: sub getuploaded { 9143: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_; 9144: $uri=~s/^\///; 9145: my $homeserver = &homeserver($cnum,$cdom); 9146: my $protocol = $protocol{$homeserver}; 9147: $protocol = 'http' if ($protocol ne 'https'); 9148: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri; 9149: my $ua=new LWP::UserAgent; 9150: my $request=new HTTP::Request($reqtype,$uri); 9151: my $response=$ua->request($request); 9152: $$rtncode = $response->code; 9153: if (! $response->is_success()) { 9154: return 'failed'; 9155: } 9156: if ($reqtype eq 'HEAD') { 9157: $$info = &HTTP::Date::str2time( $response->header('Last-modified') ); 9158: } elsif ($reqtype eq 'GET') { 9159: $$info = $response->content; 9160: } 9161: return 'ok'; 9162: } 9163: 9164: sub readfile { 9165: my $file = shift; 9166: if ( (! -e $file ) || ($file eq '') ) { return -1; }; 9167: my $fh; 9168: open($fh,"<$file"); 9169: my $a=''; 9170: while (my $line = <$fh>) { $a .= $line; } 9171: return $a; 9172: } 9173: 9174: sub filelocation { 9175: my ($dir,$file) = @_; 9176: my $location; 9177: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces 9178: 9179: if ($file =~ m-^/adm/-) { 9180: $file=~s-^/adm/wrapper/-/-; 9181: $file=~s-^/adm/coursedocs/showdoc/-/-; 9182: } 9183: 9184: if ($file=~m:^/~:) { # is a contruction space reference 9185: $location = $file; 9186: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:; 9187: } elsif ($file=~m{^/home/$match_username/public_html/}) { 9188: # is a correct contruction space reference 9189: $location = $file; 9190: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) { 9191: $location = $file; 9192: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file 9193: my ($udom,$uname,$filename)= 9194: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-); 9195: my $home=&homeserver($uname,$udom); 9196: my $is_me=0; 9197: my @ids=&current_machine_ids(); 9198: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } } 9199: if ($is_me) { 9200: $location=&propath($udom,$uname).'/userfiles/'.$filename; 9201: } else { 9202: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'. 9203: $udom.'/'.$uname.'/'.$filename; 9204: } 9205: } elsif ($file =~ m-^/adm/-) { 9206: $location = $perlvar{'lonDocRoot'}.'/'.$file; 9207: } else { 9208: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9209: $file=~s:^/res/:/:; 9210: if ( !( $file =~ m:^/:) ) { 9211: $location = $dir. '/'.$file; 9212: } else { 9213: $location = '/home/httpd/html/res'.$file; 9214: } 9215: } 9216: $location=~s://+:/:g; # remove duplicate / 9217: while ($location=~m{/\.\./}) { 9218: if ($location =~ m{/[^/]+/\.\./}) { 9219: $location=~ s{/[^/]+/\.\./}{/}g; 9220: } else { 9221: $location=~ s{/\.\./}{/}g; 9222: } 9223: } #remove dir/.. 9224: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./ 9225: return $location; 9226: } 9227: 9228: sub hreflocation { 9229: my ($dir,$file)=@_; 9230: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) { 9231: $file=filelocation($dir,$file); 9232: } elsif ($file=~m-^/adm/-) { 9233: $file=~s-^/adm/wrapper/-/-; 9234: $file=~s-^/adm/coursedocs/showdoc/-/-; 9235: } 9236: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) { 9237: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--; 9238: } elsif ($file=~m-/home/($match_username)/public_html/-) { 9239: $file=~s-^/home/($match_username)/public_html/-/~$1/-; 9240: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) { 9241: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/ 9242: -/uploaded/$1/$2/-x; 9243: } 9244: if ($file=~ m{^/userfiles/}) { 9245: $file =~ s{^/userfiles/}{/uploaded/}; 9246: } 9247: return $file; 9248: } 9249: 9250: sub current_machine_domains { 9251: return &machine_domains(&hostname($perlvar{'lonHostID'})); 9252: } 9253: 9254: sub machine_domains { 9255: my ($hostname) = @_; 9256: my @domains; 9257: my %hostname = &all_hostnames(); 9258: while( my($id, $name) = each(%hostname)) { 9259: # &logthis("-$id-$name-$hostname-"); 9260: if ($hostname eq $name) { 9261: push(@domains,&host_domain($id)); 9262: } 9263: } 9264: return @domains; 9265: } 9266: 9267: sub current_machine_ids { 9268: return &machine_ids(&hostname($perlvar{'lonHostID'})); 9269: } 9270: 9271: sub machine_ids { 9272: my ($hostname) = @_; 9273: $hostname ||= &hostname($perlvar{'lonHostID'}); 9274: my @ids; 9275: my %name_to_host = &all_names(); 9276: if (ref($name_to_host{$hostname}) eq 'ARRAY') { 9277: return @{ $name_to_host{$hostname} }; 9278: } 9279: return; 9280: } 9281: 9282: sub additional_machine_domains { 9283: my @domains; 9284: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab"); 9285: while( my $line = <$fh>) { 9286: $line =~ s/\s//g; 9287: push(@domains,$line); 9288: } 9289: return @domains; 9290: } 9291: 9292: sub default_login_domain { 9293: my $domain = $perlvar{'lonDefDomain'}; 9294: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0]; 9295: foreach my $posdom (&current_machine_domains(), 9296: &additional_machine_domains()) { 9297: if (lc($posdom) eq lc($testdomain)) { 9298: $domain=$posdom; 9299: last; 9300: } 9301: } 9302: return $domain; 9303: } 9304: 9305: # ------------------------------------------------------------- Declutters URLs 9306: 9307: sub declutter { 9308: my $thisfn=shift; 9309: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 9310: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9311: $thisfn=~s/^\///; 9312: $thisfn=~s|^adm/wrapper/||; 9313: $thisfn=~s|^adm/coursedocs/showdoc/||; 9314: $thisfn=~s/^res\///; 9315: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) { 9316: $thisfn=~s/\?.+$//; 9317: } 9318: return $thisfn; 9319: } 9320: 9321: # ------------------------------------------------------------- Clutter up URLs 9322: 9323: sub clutter { 9324: my $thisfn='/'.&declutter(shift); 9325: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/} 9326: || $thisfn =~ m{^/adm/(includes|pages)} ) { 9327: $thisfn='/res'.$thisfn; 9328: } 9329: if ($thisfn !~m|^/adm|) { 9330: if ($thisfn =~ m|^/ext/|) { 9331: $thisfn='/adm/wrapper'.$thisfn; 9332: } else { 9333: my ($ext) = ($thisfn =~ /\.(\w+)$/); 9334: my $embstyle=&Apache::loncommon::fileembstyle($ext); 9335: if ($embstyle eq 'ssi' 9336: || ($embstyle eq 'hdn') 9337: || ($embstyle eq 'rat') 9338: || ($embstyle eq 'prv') 9339: || ($embstyle eq 'ign')) { 9340: #do nothing with these 9341: } elsif (($embstyle eq 'img') 9342: || ($embstyle eq 'emb') 9343: || ($embstyle eq 'wrp')) { 9344: $thisfn='/adm/wrapper'.$thisfn; 9345: } elsif ($embstyle eq 'unk' 9346: && $thisfn!~/\.(sequence|page)$/) { 9347: $thisfn='/adm/coursedocs/showdoc'.$thisfn; 9348: } else { 9349: # &logthis("Got a blank emb style"); 9350: } 9351: } 9352: } 9353: return $thisfn; 9354: } 9355: 9356: sub clutter_with_no_wrapper { 9357: my $uri = &clutter(shift); 9358: if ($uri =~ m-^/adm/-) { 9359: $uri =~ s-^/adm/wrapper/-/-; 9360: $uri =~ s-^/adm/coursedocs/showdoc/-/-; 9361: } 9362: return $uri; 9363: } 9364: 9365: sub freeze_escape { 9366: my ($value)=@_; 9367: if (ref($value)) { 9368: $value=&nfreeze($value); 9369: return '__FROZEN__'.&escape($value); 9370: } 9371: return &escape($value); 9372: } 9373: 9374: 9375: sub thaw_unescape { 9376: my ($value)=@_; 9377: if ($value =~ /^__FROZEN__/) { 9378: substr($value,0,10,undef); 9379: $value=&unescape($value); 9380: return &thaw($value); 9381: } 9382: return &unescape($value); 9383: } 9384: 9385: sub correct_line_ends { 9386: my ($result)=@_; 9387: $$result =~s/\r\n/\n/mg; 9388: $$result =~s/\r/\n/mg; 9389: } 9390: # ================================================================ Main Program 9391: 9392: sub goodbye { 9393: &logthis("Starting Shut down"); 9394: #not converted to using infrastruture and probably shouldn't be 9395: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache)))); 9396: #converted 9397: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache))); 9398: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache)))); 9399: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache)))); 9400: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache)))); 9401: #1.1 only 9402: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache)))); 9403: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache)))); 9404: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache)))); 9405: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache)))); 9406: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered)))); 9407: &logthis(sprintf("%-20s is %s",'kicks',$kicks)); 9408: &logthis(sprintf("%-20s is %s",'hits',$hits)); 9409: &flushcourselogs(); 9410: &logthis("Shutting down"); 9411: } 9412: 9413: sub get_dns { 9414: my ($url,$func,$ignore_cache) = @_; 9415: if (!$ignore_cache) { 9416: my ($content,$cached)= 9417: &Apache::lonnet::is_cached_new('dns',$url); 9418: if ($cached) { 9419: &$func($content); 9420: return; 9421: } 9422: } 9423: 9424: my %alldns; 9425: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 9426: foreach my $dns (<$config>) { 9427: next if ($dns !~ /^\^(\S*)/x); 9428: my $line = $1; 9429: my ($host,$protocol) = split(/:/,$line); 9430: if ($protocol ne 'https') { 9431: $protocol = 'http'; 9432: } 9433: $alldns{$host} = $protocol; 9434: } 9435: while (%alldns) { 9436: my ($dns) = keys(%alldns); 9437: my $ua=new LWP::UserAgent; 9438: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url"); 9439: my $response=$ua->request($request); 9440: delete($alldns{$dns}); 9441: next if ($response->is_error()); 9442: my @content = split("\n",$response->content); 9443: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60); 9444: &$func(\@content); 9445: return; 9446: } 9447: close($config); 9448: my $which = (split('/',$url))[3]; 9449: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n"); 9450: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab"); 9451: my @content = <$config>; 9452: &$func(\@content); 9453: return; 9454: } 9455: # ------------------------------------------------------------ Read domain file 9456: { 9457: my $loaded; 9458: my %domain; 9459: 9460: sub parse_domain_tab { 9461: my ($lines) = @_; 9462: foreach my $line (@$lines) { 9463: next if ($line =~ /^(\#|\s*$ )/x); 9464: 9465: chomp($line); 9466: my ($name,@elements) = split(/:/,$line,9); 9467: my %this_domain; 9468: foreach my $field ('description', 'auth_def', 'auth_arg_def', 9469: 'lang_def', 'city', 'longi', 'lati', 9470: 'primary') { 9471: $this_domain{$field} = shift(@elements); 9472: } 9473: $domain{$name} = \%this_domain; 9474: } 9475: } 9476: 9477: sub reset_domain_info { 9478: undef($loaded); 9479: undef(%domain); 9480: } 9481: 9482: sub load_domain_tab { 9483: my ($ignore_cache) = @_; 9484: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache); 9485: my $fh; 9486: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) { 9487: my @lines = <$fh>; 9488: &parse_domain_tab(\@lines); 9489: } 9490: close($fh); 9491: $loaded = 1; 9492: } 9493: 9494: sub domain { 9495: &load_domain_tab() if (!$loaded); 9496: 9497: my ($name,$what) = @_; 9498: return if ( !exists($domain{$name}) ); 9499: 9500: if (!$what) { 9501: return $domain{$name}{'description'}; 9502: } 9503: return $domain{$name}{$what}; 9504: } 9505: 9506: sub domain_info { 9507: &load_domain_tab() if (!$loaded); 9508: return %domain; 9509: } 9510: 9511: } 9512: 9513: 9514: # ------------------------------------------------------------- Read hosts file 9515: { 9516: my %hostname; 9517: my %hostdom; 9518: my %libserv; 9519: my $loaded; 9520: my %name_to_host; 9521: 9522: sub parse_hosts_tab { 9523: my ($file) = @_; 9524: foreach my $configline (@$file) { 9525: next if ($configline =~ /^(\#|\s*$ )/x); 9526: next if ($configline =~ /^\^/); 9527: chomp($configline); 9528: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline); 9529: $name=~s/\s//g; 9530: if ($id && $domain && $role && $name) { 9531: $hostname{$id}=$name; 9532: push(@{$name_to_host{$name}}, $id); 9533: $hostdom{$id}=$domain; 9534: if ($role eq 'library') { $libserv{$id}=$name; } 9535: if (defined($protocol)) { 9536: if ($protocol eq 'https') { 9537: $protocol{$id} = $protocol; 9538: } else { 9539: $protocol{$id} = 'http'; 9540: } 9541: } else { 9542: $protocol{$id} = 'http'; 9543: } 9544: } 9545: } 9546: } 9547: 9548: sub reset_hosts_info { 9549: &purge_remembered(); 9550: &reset_domain_info(); 9551: &reset_hosts_ip_info(); 9552: undef(%name_to_host); 9553: undef(%hostname); 9554: undef(%hostdom); 9555: undef(%libserv); 9556: undef($loaded); 9557: } 9558: 9559: sub load_hosts_tab { 9560: my ($ignore_cache) = @_; 9561: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache); 9562: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 9563: my @config = <$config>; 9564: &parse_hosts_tab(\@config); 9565: close($config); 9566: $loaded=1; 9567: } 9568: 9569: sub hostname { 9570: &load_hosts_tab() if (!$loaded); 9571: 9572: my ($lonid) = @_; 9573: return $hostname{$lonid}; 9574: } 9575: 9576: sub all_hostnames { 9577: &load_hosts_tab() if (!$loaded); 9578: 9579: return %hostname; 9580: } 9581: 9582: sub all_names { 9583: &load_hosts_tab() if (!$loaded); 9584: 9585: return %name_to_host; 9586: } 9587: 9588: sub all_host_domain { 9589: &load_hosts_tab() if (!$loaded); 9590: return %hostdom; 9591: } 9592: 9593: sub is_library { 9594: &load_hosts_tab() if (!$loaded); 9595: 9596: return exists($libserv{$_[0]}); 9597: } 9598: 9599: sub all_library { 9600: &load_hosts_tab() if (!$loaded); 9601: 9602: return %libserv; 9603: } 9604: 9605: sub get_servers { 9606: &load_hosts_tab() if (!$loaded); 9607: 9608: my ($domain,$type) = @_; 9609: my %possible_hosts = ($type eq 'library') ? %libserv 9610: : %hostname; 9611: my %result; 9612: if (ref($domain) eq 'ARRAY') { 9613: while ( my ($host,$hostname) = each(%possible_hosts)) { 9614: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) { 9615: $result{$host} = $hostname; 9616: } 9617: } 9618: } else { 9619: while ( my ($host,$hostname) = each(%possible_hosts)) { 9620: if ($hostdom{$host} eq $domain) { 9621: $result{$host} = $hostname; 9622: } 9623: } 9624: } 9625: return %result; 9626: } 9627: 9628: sub host_domain { 9629: &load_hosts_tab() if (!$loaded); 9630: 9631: my ($lonid) = @_; 9632: return $hostdom{$lonid}; 9633: } 9634: 9635: sub all_domains { 9636: &load_hosts_tab() if (!$loaded); 9637: 9638: my %seen; 9639: my @uniq = grep(!$seen{$_}++, values(%hostdom)); 9640: return @uniq; 9641: } 9642: } 9643: 9644: { 9645: my %iphost; 9646: my %name_to_ip; 9647: my %lonid_to_ip; 9648: 9649: sub get_hosts_from_ip { 9650: my ($ip) = @_; 9651: my %iphosts = &get_iphost(); 9652: if (ref($iphosts{$ip})) { 9653: return @{$iphosts{$ip}}; 9654: } 9655: return; 9656: } 9657: 9658: sub reset_hosts_ip_info { 9659: undef(%iphost); 9660: undef(%name_to_ip); 9661: undef(%lonid_to_ip); 9662: } 9663: 9664: sub get_host_ip { 9665: my ($lonid) = @_; 9666: if (exists($lonid_to_ip{$lonid})) { 9667: return $lonid_to_ip{$lonid}; 9668: } 9669: my $name=&hostname($lonid); 9670: my $ip = gethostbyname($name); 9671: return if (!$ip || length($ip) ne 4); 9672: $ip=inet_ntoa($ip); 9673: $name_to_ip{$name} = $ip; 9674: $lonid_to_ip{$lonid} = $ip; 9675: return $ip; 9676: } 9677: 9678: sub get_iphost { 9679: my ($ignore_cache) = @_; 9680: 9681: if (!$ignore_cache) { 9682: if (%iphost) { 9683: return %iphost; 9684: } 9685: my ($ip_info,$cached)= 9686: &Apache::lonnet::is_cached_new('iphost','iphost'); 9687: if ($cached) { 9688: %iphost = %{$ip_info->[0]}; 9689: %name_to_ip = %{$ip_info->[1]}; 9690: %lonid_to_ip = %{$ip_info->[2]}; 9691: return %iphost; 9692: } 9693: } 9694: 9695: # get yesterday's info for fallback 9696: my %old_name_to_ip; 9697: my ($ip_info,$cached)= 9698: &Apache::lonnet::is_cached_new('iphost','iphost'); 9699: if ($cached) { 9700: %old_name_to_ip = %{$ip_info->[1]}; 9701: } 9702: 9703: my %name_to_host = &all_names(); 9704: foreach my $name (keys(%name_to_host)) { 9705: my $ip; 9706: if (!exists($name_to_ip{$name})) { 9707: $ip = gethostbyname($name); 9708: if (!$ip || length($ip) ne 4) { 9709: if (defined($old_name_to_ip{$name})) { 9710: $ip = $old_name_to_ip{$name}; 9711: &logthis("Can't find $name defaulting to old $ip"); 9712: } else { 9713: &logthis("Name $name no IP found"); 9714: next; 9715: } 9716: } else { 9717: $ip=inet_ntoa($ip); 9718: } 9719: $name_to_ip{$name} = $ip; 9720: } else { 9721: $ip = $name_to_ip{$name}; 9722: } 9723: foreach my $id (@{ $name_to_host{$name} }) { 9724: $lonid_to_ip{$id} = $ip; 9725: } 9726: push(@{$iphost{$ip}},@{$name_to_host{$name}}); 9727: } 9728: &Apache::lonnet::do_cache_new('iphost','iphost', 9729: [\%iphost,\%name_to_ip,\%lonid_to_ip], 9730: 48*60*60); 9731: 9732: return %iphost; 9733: } 9734: 9735: # 9736: # Given a DNS returns the loncapa host name for that DNS 9737: # 9738: sub host_from_dns { 9739: my ($dns) = @_; 9740: my @hosts; 9741: my $ip; 9742: 9743: if (exists($name_to_ip{$dns})) { 9744: $ip = $name_to_ip{$dns}; 9745: } 9746: if (!$ip) { 9747: $ip = gethostbyname($dns); # Initial translation to IP is in net order. 9748: if (length($ip) == 4) { 9749: $ip = &IO::Socket::inet_ntoa($ip); 9750: } 9751: } 9752: if ($ip) { 9753: @hosts = get_hosts_from_ip($ip); 9754: return $hosts[0]; 9755: } 9756: return undef; 9757: } 9758: 9759: } 9760: 9761: BEGIN { 9762: 9763: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf 9764: unless ($readit) { 9765: { 9766: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf'); 9767: %perlvar = (%perlvar,%{$configvars}); 9768: } 9769: 9770: 9771: # ------------------------------------------------------ Read spare server file 9772: { 9773: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab"); 9774: 9775: while (my $configline=<$config>) { 9776: chomp($configline); 9777: if ($configline) { 9778: my ($host,$type) = split(':',$configline,2); 9779: if (!defined($type) || $type eq '') { $type = 'default' }; 9780: push(@{ $spareid{$type} }, $host); 9781: } 9782: } 9783: close($config); 9784: } 9785: # ------------------------------------------------------------ Read permissions 9786: { 9787: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab"); 9788: 9789: while (my $configline=<$config>) { 9790: chomp($configline); 9791: if ($configline) { 9792: my ($role,$perm)=split(/ /,$configline); 9793: if ($perm ne '') { $pr{$role}=$perm; } 9794: } 9795: } 9796: close($config); 9797: } 9798: 9799: # -------------------------------------------- Read plain texts for permissions 9800: { 9801: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab"); 9802: 9803: while (my $configline=<$config>) { 9804: chomp($configline); 9805: if ($configline) { 9806: my ($short,@plain)=split(/:/,$configline); 9807: %{$prp{$short}} = (); 9808: if (@plain > 0) { 9809: $prp{$short}{'std'} = $plain[0]; 9810: for (my $i=1; $i<@plain; $i++) { 9811: $prp{$short}{'alt'.$i} = $plain[$i]; 9812: } 9813: } 9814: } 9815: } 9816: close($config); 9817: } 9818: 9819: # ---------------------------------------------------------- Read package table 9820: { 9821: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab"); 9822: 9823: while (my $configline=<$config>) { 9824: if ($configline !~ /\S/ || $configline=~/^#/) { next; } 9825: chomp($configline); 9826: my ($short,$plain)=split(/:/,$configline); 9827: my ($pack,$name)=split(/\&/,$short); 9828: if ($plain ne '') { 9829: $packagetab{$pack.'&'.$name.'&name'}=$name; 9830: $packagetab{$short}=$plain; 9831: } 9832: } 9833: close($config); 9834: } 9835: 9836: # ------------- set up temporary directory 9837: { 9838: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/'; 9839: 9840: } 9841: 9842: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'], 9843: 'compress_threshold'=> 20_000, 9844: }); 9845: 9846: $processmarker='_'.time.'_'.$perlvar{'lonHostID'}; 9847: $dumpcount=0; 9848: $locknum=0; 9849: 9850: &logtouch(); 9851: &logthis('INFO: Read configuration'); 9852: $readit=1; 9853: { 9854: use integer; 9855: my $test=(2**32)+1; 9856: if ($test != 0) { $_64bit=1; } else { $_64bit=0; } 9857: &logthis(" Detected 64bit platform ($_64bit)"); 9858: } 9859: } 9860: } 9861: 9862: 1; 9863: __END__ 9864: 9865: =pod 9866: 9867: =head1 NAME 9868: 9869: Apache::lonnet - Subroutines to ask questions about things in the network. 9870: 9871: =head1 SYNOPSIS 9872: 9873: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network. 9874: 9875: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS); 9876: 9877: Common parameters: 9878: 9879: =over 4 9880: 9881: =item * 9882: 9883: $uname : an internal username (if $cname expecting a course Id specifically) 9884: 9885: =item * 9886: 9887: $udom : a domain (if $cdom expecting a course's domain specifically) 9888: 9889: =item * 9890: 9891: $symb : a resource instance identifier 9892: 9893: =item * 9894: 9895: $namespace : the name of a .db file that contains the data needed or 9896: being set. 9897: 9898: =back 9899: 9900: =head1 OVERVIEW 9901: 9902: lonnet provides subroutines which interact with the 9903: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask 9904: about classes, users, and resources. 9905: 9906: For many of these objects you can also use this to store data about 9907: them or modify them in various ways. 9908: 9909: =head2 Symbs 9910: 9911: To identify a specific instance of a resource, LON-CAPA uses symbols 9912: or "symbs"X<symb>. These identifiers are built from the URL of the 9913: map, the resource number of the resource in the map, and the URL of 9914: the resource itself. The latter is somewhat redundant, but might help 9915: if maps change. 9916: 9917: An example is 9918: 9919: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem 9920: 9921: The respective map entry is 9922: 9923: <resource id="19" src="/res/msu/korte/tests/part12.problem" 9924: title="Problem 2"> 9925: </resource> 9926: 9927: Symbs are used by the random number generator, as well as to store and 9928: restore data specific to a certain instance of for example a problem. 9929: 9930: =head2 Storing And Retrieving Data 9931: 9932: X<store()>X<cstore()>X<restore()>Three of the most important functions 9933: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>, 9934: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which 9935: is is the non-critical message twin of cstore. These functions are for 9936: handlers to store a perl hash to a user's permanent data space in an 9937: easy manner, and to retrieve it again on another call. It is expected 9938: that a handler would use this once at the beginning to retrieve data, 9939: and then again once at the end to send only the new data back. 9940: 9941: The data is stored in the user's data directory on the user's 9942: homeserver under the ID of the course. 9943: 9944: The hash that is returned by restore will have all of the previous 9945: value for all of the elements of the hash. 9946: 9947: Example: 9948: 9949: #creating a hash 9950: my %hash; 9951: $hash{'foo'}='bar'; 9952: 9953: #storing it 9954: &Apache::lonnet::cstore(\%hash); 9955: 9956: #changing a value 9957: $hash{'foo'}='notbar'; 9958: 9959: #adding a new value 9960: $hash{'bar'}='foo'; 9961: &Apache::lonnet::cstore(\%hash); 9962: 9963: #retrieving the hash 9964: my %history=&Apache::lonnet::restore(); 9965: 9966: #print the hash 9967: foreach my $key (sort(keys(%history))) { 9968: print("\%history{$key} = $history{$key}"); 9969: } 9970: 9971: Will print out: 9972: 9973: %history{1:foo} = bar 9974: %history{1:keys} = foo:timestamp 9975: %history{1:timestamp} = 990455579 9976: %history{2:bar} = foo 9977: %history{2:foo} = notbar 9978: %history{2:keys} = foo:bar:timestamp 9979: %history{2:timestamp} = 990455580 9980: %history{bar} = foo 9981: %history{foo} = notbar 9982: %history{timestamp} = 990455580 9983: %history{version} = 2 9984: 9985: Note that the special hash entries C<keys>, C<version> and 9986: C<timestamp> were added to the hash. C<version> will be equal to the 9987: total number of versions of the data that have been stored. The 9988: C<timestamp> attribute will be the UNIX time the hash was 9989: stored. C<keys> is available in every historical section to list which 9990: keys were added or changed at a specific historical revision of a 9991: hash. 9992: 9993: B<Warning>: do not store the hash that restore returns directly. This 9994: will cause a mess since it will restore the historical keys as if the 9995: were new keys. I.E. 1:foo will become 1:1:foo etc. 9996: 9997: Calling convention: 9998: 9999: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home); 10000: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home); 10001: 10002: For more detailed information, see lonnet specific documentation. 10003: 10004: =head1 RETURN MESSAGES 10005: 10006: =over 4 10007: 10008: =item * B<con_lost>: unable to contact remote host 10009: 10010: =item * B<con_delayed>: unable to contact remote host, message will be delivered 10011: when the connection is brought back up 10012: 10013: =item * B<con_failed>: unable to contact remote host and unable to save message 10014: for later delivery 10015: 10016: =item * B<error:>: an error a occurred, a description of the error follows the : 10017: 10018: =item * B<no_such_host>: unable to fund a host associated with the user/domain 10019: that was requested 10020: 10021: =back 10022: 10023: =head1 PUBLIC SUBROUTINES 10024: 10025: =head2 Session Environment Functions 10026: 10027: =over 4 10028: 10029: =item * 10030: X<appenv()> 10031: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to 10032: the user envirnoment file, and will be restored for each access this 10033: user makes during this session, also modifies the %env for the current 10034: process. Optional rolesarrayref - if defined contains a reference to an array 10035: of roles which are exempt from the restriction on modifying user.role entries 10036: in the user's environment.db and in %env. 10037: 10038: =item * 10039: X<delenv()> 10040: B<delenv($delthis,$regexp)>: removes all items from the session 10041: environment file that begin with $delthis. If the 10042: optional second arg - $regexp - is true, $delthis is treated as a 10043: regular expression, otherwise \Q$delthis\E is used. 10044: The values are also deleted from the current processes %env. 10045: 10046: =item * get_env_multiple($name) 10047: 10048: gets $name from the %env hash, it seemlessly handles the cases where multiple 10049: values may be defined and end up as an array ref. 10050: 10051: returns an array of values 10052: 10053: =back 10054: 10055: =head2 User Information 10056: 10057: =over 4 10058: 10059: =item * 10060: X<queryauthenticate()> 10061: B<queryauthenticate($uname,$udom)>: try to determine user's current 10062: authentication scheme 10063: 10064: =item * 10065: X<authenticate()> 10066: B<authenticate($uname,$upass,$udom)>: try to 10067: authenticate user from domain's lib servers (first use the current 10068: one). C<$upass> should be the users password. 10069: 10070: =item * 10071: X<homeserver()> 10072: B<homeserver($uname,$udom)>: find the server which has 10073: the user's directory and files (there must be only one), this caches 10074: the answer, and also caches if there is a borken connection. 10075: 10076: =item * 10077: X<idget()> 10078: B<idget($udom,@ids)>: find the usernames behind a list of IDs 10079: (IDs are a unique resource in a domain, there must be only 1 ID per 10080: username, and only 1 username per ID in a specific domain) (returns 10081: hash: id=>name,id=>name) 10082: 10083: =item * 10084: X<idrget()> 10085: B<idrget($udom,@unames)>: find the IDs behind a list of 10086: usernames (returns hash: name=>id,name=>id) 10087: 10088: =item * 10089: X<idput()> 10090: B<idput($udom,%ids)>: store away a list of names and associated IDs 10091: 10092: =item * 10093: X<rolesinit()> 10094: B<rolesinit($udom,$username,$authhost)>: get user privileges 10095: 10096: =item * 10097: X<getsection()> 10098: B<getsection($udom,$uname,$cname)>: finds the section of student in the 10099: course $cname, return section name/number or '' for "not in course" 10100: and '-1' for "no section" 10101: 10102: =item * 10103: X<userenvironment()> 10104: B<userenvironment($udom,$uname,@what)>: gets the values of the keys 10105: passed in @what from the requested user's environment, returns a hash 10106: 10107: =item * 10108: X<userlog_query()> 10109: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's 10110: activity.log file. %filters defines filters applied when parsing the 10111: log file. These can be start or end timestamps, or the type of action 10112: - log to look for Login or Logout events, check for Checkin or 10113: Checkout, role for role selection. The response is in the form 10114: timestamp1:hostid1:event1&timestamp2:hostid2:event2 where events are 10115: escaped strings of the action recorded in the activity.log file. 10116: 10117: =back 10118: 10119: =head2 User Roles 10120: 10121: =over 4 10122: 10123: =item * 10124: 10125: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions 10126: F: full access 10127: U,I,K: authentication modes (cxx only) 10128: '': forbidden 10129: 1: user needs to choose course 10130: 2: browse allowed 10131: A: passphrase authentication needed 10132: 10133: =item * 10134: 10135: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom 10136: role rolename set privileges in format of lonTabs/roles.tab for system, domain, 10137: and course level 10138: 10139: =item * 10140: 10141: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 10142: (rolesplain.tab); plain text explanation of a user role term. 10143: $type is Course (default) or Community. 10144: If $forcedefault evaluates to true, text returned will be default 10145: text for $type. Otherwise, if this is a course, the text returned 10146: will be a custom name for the role (if defined in the course's 10147: environment). If no custom name is defined the default is returned. 10148: 10149: =item * 10150: 10151: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) : 10152: All arguments are optional. Returns a hash of a roles, either for 10153: co-author/assistant author roles for a user's Construction Space 10154: (default), or if $context is 'userroles', roles for the user himself, 10155: In the hash, keys are set to colon-separated $uname,$udom,$role, and 10156: (optionally) if $withsec is true, a fourth colon-separated item - $section. 10157: For each key, value is set to colon-separated start and end times for 10158: the role. If no username and domain are specified, will default to 10159: current user/domain. Types, roles, and roledoms are references to arrays 10160: of role statuses (active, future or previous), roles 10161: (e.g., cc,in, st etc.) and domains of the roles which can be used 10162: to restrict the list of roles reported. If no array ref is 10163: provided for types, will default to return only active roles. 10164: 10165: =back 10166: 10167: =head2 User Modification 10168: 10169: =over 4 10170: 10171: =item * 10172: 10173: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a 10174: user for the level given by URL. Optional start and end dates (leave empty 10175: string or zero for "no date") 10176: 10177: =item * 10178: 10179: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to 10180: change a users, password, possible return values are: ok, 10181: pwchange_failure, non_authorized, auth_mode_error, unknown_user, 10182: refused 10183: 10184: =item * 10185: 10186: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication 10187: 10188: =item * 10189: 10190: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene, 10191: $forceid,$desiredhome,$email,$inststatus) : 10192: modify user 10193: 10194: =item * 10195: 10196: modifystudent 10197: 10198: modify a student's enrollment and identification information. 10199: The course id is resolved based on the current users environment. 10200: This means the envoking user must be a course coordinator or otherwise 10201: associated with a course. 10202: 10203: This call is essentially a wrapper for lonnet::modifyuser and 10204: lonnet::modify_student_enrollment 10205: 10206: Inputs: 10207: 10208: =over 4 10209: 10210: =item B<$udom> Student's loncapa domain 10211: 10212: =item B<$uname> Student's loncapa login name 10213: 10214: =item B<$uid> Student/Employee ID 10215: 10216: =item B<$umode> Student's authentication mode 10217: 10218: =item B<$upass> Student's password 10219: 10220: =item B<$first> Student's first name 10221: 10222: =item B<$middle> Student's middle name 10223: 10224: =item B<$last> Student's last name 10225: 10226: =item B<$gene> Student's generation 10227: 10228: =item B<$usec> Student's section in course 10229: 10230: =item B<$end> Unix time of the roles expiration 10231: 10232: =item B<$start> Unix time of the roles start date 10233: 10234: =item B<$forceid> If defined, allow $uid to be changed 10235: 10236: =item B<$desiredhome> server to use as home server for student 10237: 10238: =item B<$email> Student's permanent e-mail address 10239: 10240: =item B<$type> Type of enrollment (auto or manual) 10241: 10242: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto 10243: 10244: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC 10245: 10246: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment 10247: 10248: =item B<$context> role change context (shown in User Management Logs display in a course) 10249: 10250: =item B<$inststatus> institutional status of user - : separated string of escaped status types 10251: 10252: =back 10253: 10254: =item * 10255: 10256: modify_student_enrollment 10257: 10258: Change a students enrollment status in a class. The environment variable 10259: 'role.request.course' must be defined for this function to proceed. 10260: 10261: Inputs: 10262: 10263: =over 4 10264: 10265: =item $udom, students domain 10266: 10267: =item $uname, students name 10268: 10269: =item $uid, students user id 10270: 10271: =item $first, students first name 10272: 10273: =item $middle 10274: 10275: =item $last 10276: 10277: =item $gene 10278: 10279: =item $usec 10280: 10281: =item $end 10282: 10283: =item $start 10284: 10285: =item $type 10286: 10287: =item $locktype 10288: 10289: =item $cid 10290: 10291: =item $selfenroll 10292: 10293: =item $context 10294: 10295: =back 10296: 10297: 10298: =item * 10299: 10300: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign 10301: custom role; give a custom role to a user for the level given by URL. Specify 10302: name and domain of role author, and role name 10303: 10304: =item * 10305: 10306: revokerole($udom,$uname,$url,$role) : revoke a role for url 10307: 10308: =item * 10309: 10310: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role 10311: 10312: =back 10313: 10314: =head2 Course Infomation 10315: 10316: =over 4 10317: 10318: =item * 10319: 10320: coursedescription($courseid) : returns a hash of information about the 10321: specified course id, including all environment settings for the 10322: course, the description of the course will be in the hash under the 10323: key 'description' 10324: 10325: =item * 10326: 10327: resdata($name,$domain,$type,@which) : request for current parameter 10328: setting for a specific $type, where $type is either 'course' or 'user', 10329: @what should be a list of parameters to ask about. This routine caches 10330: answers for 5 minutes. 10331: 10332: =item * 10333: 10334: get_courseresdata($courseid, $domain) : dump the entire course resource 10335: data base, returning a hash that is keyed by the resource name and has 10336: values that are the resource value. I believe that the timestamps and 10337: versions are also returned. 10338: 10339: 10340: =back 10341: 10342: =head2 Course Modification 10343: 10344: =over 4 10345: 10346: =item * 10347: 10348: writecoursepref($courseid,%prefs) : write preferences (environment 10349: database) for a course 10350: 10351: =item * 10352: 10353: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course 10354: 10355: =item * 10356: 10357: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community). 10358: 10359: =back 10360: 10361: =head2 Resource Subroutines 10362: 10363: =over 4 10364: 10365: =item * 10366: 10367: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead) 10368: 10369: =item * 10370: 10371: repcopy($filename) : subscribes to the requested file, and attempts to 10372: replicate from the owning library server, Might return 10373: 'unavailable', 'not_found', 'forbidden', 'ok', or 10374: 'bad_request', also attempts to grab the metadata for the 10375: resource. Expects the local filesystem pathname 10376: (/home/httpd/html/res/....) 10377: 10378: =back 10379: 10380: =head2 Resource Information 10381: 10382: =over 4 10383: 10384: =item * 10385: 10386: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of 10387: a vairety of different possible values, $varname should be a request 10388: string, and the other parameters can be used to specify who and what 10389: one is asking about. 10390: 10391: Possible values for $varname are environment.lastname (or other item 10392: from the envirnment hash), user.name (or someother aspect about the 10393: user), resource.0.maxtries (or some other part and parameter of a 10394: resource) 10395: 10396: =item * 10397: 10398: directcondval($number) : get current value of a condition; reads from a state 10399: string 10400: 10401: =item * 10402: 10403: condval($condidx) : value of condition index based on state 10404: 10405: =item * 10406: 10407: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a 10408: resource's metadata, $what should be either a specific key, or either 10409: 'keys' (to get a list of possible keys) or 'packages' to get a list of 10410: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata. 10411: 10412: this function automatically caches all requests 10413: 10414: =item * 10415: 10416: metadata_query($query,$custom,$customshow) : make a metadata query against the 10417: network of library servers; returns file handle of where SQL and regex results 10418: will be stored for query 10419: 10420: =item * 10421: 10422: symbread($filename) : return symbolic list entry (filename argument optional); 10423: returns the data handle 10424: 10425: =item * 10426: 10427: symbverify($symb,$thisfn) : verifies that $symb actually exists and is 10428: a possible symb for the URL in $thisfn, and if is an encryypted 10429: resource that the user accessed using /enc/ returns a 1 on success, 0 10430: on failure, user must be in a course, as it assumes the existance of 10431: the course initial hash, and uses $env('request.course.id'} 10432: 10433: 10434: =item * 10435: 10436: symbclean($symb) : removes versions numbers from a symb, returns the 10437: cleaned symb 10438: 10439: =item * 10440: 10441: is_on_map($uri) : checks if the $uri is somewhere on the current 10442: course map, user must be in a course for it to work. 10443: 10444: =item * 10445: 10446: numval($salt) : return random seed value (addend for rndseed) 10447: 10448: =item * 10449: 10450: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns 10451: a random seed, all arguments are optional, if they aren't sent it uses the 10452: environment to derive them. Note: if symb isn't sent and it can't get one 10453: from &symbread it will use the current time as its return value 10454: 10455: =item * 10456: 10457: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique, 10458: unfakeable, receipt 10459: 10460: =item * 10461: 10462: receipt() : API to ireceipt working off of env values; given out to users 10463: 10464: =item * 10465: 10466: countacc($url) : count the number of accesses to a given URL 10467: 10468: =item * 10469: 10470: 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 10471: 10472: =item * 10473: 10474: 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) 10475: 10476: =item * 10477: 10478: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet 10479: 10480: =item * 10481: 10482: devalidate($symb) : devalidate temporary spreadsheet calculations, 10483: forcing spreadsheet to reevaluate the resource scores next time. 10484: 10485: =back 10486: 10487: =head2 Storing/Retreiving Data 10488: 10489: =over 4 10490: 10491: =item * 10492: 10493: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently 10494: for this url; hashref needs to be given and should be a \%hashname; the 10495: remaining args aren't required and if they aren't passed or are '' they will 10496: be derived from the env 10497: 10498: =item * 10499: 10500: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but 10501: uses critical subroutine 10502: 10503: =item * 10504: 10505: restore($symb,$namespace,$udom,$uname) : returns hash for this symb; 10506: all args are optional 10507: 10508: =item * 10509: 10510: dumpstore($namespace,$udom,$uname,$regexp,$range) : 10511: dumps the complete (or key matching regexp) namespace into a hash 10512: ($udom, $uname, $regexp, $range are optional) for a namespace that is 10513: normally &store()ed into 10514: 10515: $range should be either an integer '100' (give me the first 100 10516: matching records) 10517: or be two integers sperated by a - with no spaces 10518: '30-50' (give me the 30th through the 50th matching 10519: records) 10520: 10521: 10522: =item * 10523: 10524: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) : 10525: replaces a &store() version of data with a replacement set of data 10526: for a particular resource in a namespace passed in the $storehash hash 10527: reference 10528: 10529: =item * 10530: 10531: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that 10532: works very similar to store/cstore, but all data is stored in a 10533: temporary location and can be reset using tmpreset, $storehash should 10534: be a hash reference, returns nothing on success 10535: 10536: =item * 10537: 10538: tmprestore($symb,$namespace,$udom,$uname) : storage that works very 10539: similar to restore, but all data is stored in a temporary location and 10540: can be reset using tmpreset. Returns a hash of values on success, 10541: error string otherwise. 10542: 10543: =item * 10544: 10545: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset, 10546: deltes all keys for $symb form the temporary storage hash. 10547: 10548: =item * 10549: 10550: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array 10551: reference filled in from namesp ($udom and $uname are optional) 10552: 10553: =item * 10554: 10555: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from 10556: namesp ($udom and $uname are optional) 10557: 10558: =item * 10559: 10560: dump($namespace,$udom,$uname,$regexp,$range) : 10561: dumps the complete (or key matching regexp) namespace into a hash 10562: ($udom, $uname, $regexp, $range are optional) 10563: 10564: $range should be either an integer '100' (give me the first 100 10565: matching records) 10566: or be two integers sperated by a - with no spaces 10567: '30-50' (give me the 30th through the 50th matching 10568: records) 10569: =item * 10570: 10571: inc($namespace,$store,$udom,$uname) : increments $store in $namespace. 10572: $store can be a scalar, an array reference, or if the amount to be 10573: incremented is > 1, a hash reference. 10574: 10575: ($udom and $uname are optional) 10576: 10577: =item * 10578: 10579: put($namespace,$storehash,$udom,$uname) : stores hash in namesp 10580: ($udom and $uname are optional) 10581: 10582: =item * 10583: 10584: cput($namespace,$storehash,$udom,$uname) : critical put 10585: ($udom and $uname are optional) 10586: 10587: =item * 10588: 10589: newput($namespace,$storehash,$udom,$uname) : 10590: 10591: Attempts to store the items in the $storehash, but only if they don't 10592: currently exist, if this succeeds you can be certain that you have 10593: successfully created a new key value pair in the $namespace db. 10594: 10595: 10596: Args: 10597: $namespace: name of database to store values to 10598: $storehash: hashref to store to the db 10599: $udom: (optional) domain of user containing the db 10600: $uname: (optional) name of user caontaining the db 10601: 10602: Returns: 10603: 'ok' -> succeeded in storing all keys of $storehash 10604: 'key_exists: <key>' -> failed to anything out of $storehash, as at 10605: least <key> already existed in the db (other 10606: requested keys may also already exist) 10607: 'error: <msg>' -> unable to tie the DB or other error occurred 10608: 'con_lost' -> unable to contact request server 10609: 'refused' -> action was not allowed by remote machine 10610: 10611: 10612: =item * 10613: 10614: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array 10615: reference filled in from namesp (encrypts the return communication) 10616: ($udom and $uname are optional) 10617: 10618: =item * 10619: 10620: log($udom,$name,$home,$message) : write to permanent log for user; use 10621: critical subroutine 10622: 10623: =item * 10624: 10625: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from 10626: array reference filled in from namespace found in domain level on either 10627: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional). 10628: 10629: =item * 10630: 10631: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at 10632: domain level either on specified domain server ($uhome) or primary domain 10633: server ($udom and $uhome are optional) 10634: 10635: =item * 10636: 10637: get_domain_defaults($target_domain) : returns hash with defaults for 10638: authentication and language in the domain. Keys are: auth_def, auth_arg_def, 10639: lang_def; corresponsing values are authentication type (internal, krb4, krb5, 10640: or localauth), initial password or a kerberos realm, language (e.g., en-us). 10641: Values are retrieved from cache (if current), or from domain's configuration.db 10642: (if available), or lastly from values in lonTabs/dns_domain,tab, 10643: or lonTabs/domain.tab. 10644: 10645: %domdefaults = &get_auth_defaults($target_domain); 10646: 10647: =back 10648: 10649: =head2 Network Status Functions 10650: 10651: =over 4 10652: 10653: =item * 10654: 10655: dirlist($uri) : return directory list based on URI 10656: 10657: =item * 10658: 10659: spareserver() : find server with least workload from spare.tab 10660: 10661: 10662: =item * 10663: 10664: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef 10665: if there is no corresponding loncapa host. 10666: 10667: =back 10668: 10669: 10670: =head2 Apache Request 10671: 10672: =over 4 10673: 10674: =item * 10675: 10676: ssi($url,%hash) : server side include, does a complete request cycle on url to 10677: localhost, posts hash 10678: 10679: =back 10680: 10681: =head2 Data to String to Data 10682: 10683: =over 4 10684: 10685: =item * 10686: 10687: hash2str(%hash) : convert a hash into a string complete with escaping and '=' 10688: and '&' separators, supports elements that are arrayrefs and hashrefs 10689: 10690: =item * 10691: 10692: hashref2str($hashref) : convert a hashref into a string complete with 10693: escaping and '=' and '&' separators, supports elements that are 10694: arrayrefs and hashrefs 10695: 10696: =item * 10697: 10698: arrayref2str($arrayref) : convert an arrayref into a string complete 10699: with escaping and '&' separators, supports elements that are arrayrefs 10700: and hashrefs 10701: 10702: =item * 10703: 10704: str2hash($string) : convert string to hash using unescaping and 10705: splitting on '=' and '&', supports elements that are arrayrefs and 10706: hashrefs 10707: 10708: =item * 10709: 10710: str2array($string) : convert string to hash using unescaping and 10711: splitting on '&', supports elements that are arrayrefs and hashrefs 10712: 10713: =back 10714: 10715: =head2 Logging Routines 10716: 10717: =over 4 10718: 10719: These routines allow one to make log messages in the lonnet.log and 10720: lonnet.perm logfiles. 10721: 10722: =item * 10723: 10724: logtouch() : make sure the logfile, lonnet.log, exists 10725: 10726: =item * 10727: 10728: logthis() : append message to the normal lonnet.log file, it gets 10729: preiodically rolled over and deleted. 10730: 10731: =item * 10732: 10733: logperm() : append a permanent message to lonnet.perm.log, this log 10734: file never gets deleted by any automated portion of the system, only 10735: messages of critical importance should go in here. 10736: 10737: =back 10738: 10739: =head2 General File Helper Routines 10740: 10741: =over 4 10742: 10743: =item * 10744: 10745: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded. 10746: (a) files in /uploaded 10747: (i) If a local copy of the file exists - 10748: compares modification date of local copy with last-modified date for 10749: definitive version stored on home server for course. If local copy is 10750: stale, requests a new version from the home server and stores it. 10751: If the original has been removed from the home server, then local copy 10752: is unlinked. 10753: (ii) If local copy does not exist - 10754: requests the file from the home server and stores it. 10755: 10756: If $caller is 'uploadrep': 10757: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase) 10758: for request for files originally uploaded via DOCS. 10759: - returns 'ok' if fresh local copy now available, -1 otherwise. 10760: 10761: Otherwise: 10762: This indicates a call from the content generation phase of the request. 10763: - returns the entire contents of the file or -1. 10764: 10765: (b) files in /res 10766: - returns the entire contents of a file or -1; 10767: it properly subscribes to and replicates the file if neccessary. 10768: 10769: 10770: =item * 10771: 10772: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file 10773: reference 10774: 10775: returns either a stat() list of data about the file or an empty list 10776: if the file doesn't exist or couldn't find out about it (connection 10777: problems or user unknown) 10778: 10779: =item * 10780: 10781: filelocation($dir,$file) : returns file system location of a file 10782: based on URI; meant to be "fairly clean" absolute reference, $dir is a 10783: directory that relative $file lookups are to looked in ($dir of /a/dir 10784: and a file of ../bob will become /a/bob) 10785: 10786: =item * 10787: 10788: hreflocation($dir,$file) : returns file system location or a URL; same as 10789: filelocation except for hrefs 10790: 10791: =item * 10792: 10793: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc) 10794: 10795: =back 10796: 10797: =head2 Usererfile file routines (/uploaded*) 10798: 10799: =over 4 10800: 10801: =item * 10802: 10803: userfileupload(): main rotine for putting a file in a user or course's 10804: filespace, arguments are, 10805: 10806: formname - required - this is the name of the element in $env where the 10807: filename, and the contents of the file to create/modifed exist 10808: the filename is in $env{'form.'.$formname.'.filename'} and the 10809: contents of the file is located in $env{'form.'.$formname} 10810: coursedoc - if true, store the file in the course of the active role 10811: of the current user 10812: subdir - required - subdirectory to put the file in under ../userfiles/ 10813: if undefined, it will be placed in "unknown" 10814: 10815: (This routine calls clean_filename() to remove any dangerous 10816: characters from the filename, and then calls finuserfileupload() to 10817: complete the transaction) 10818: 10819: returns either the url of the uploaded file (/uploaded/....) if successful 10820: and /adm/notfound.html if unsuccessful 10821: 10822: =item * 10823: 10824: clean_filename(): routine for cleaing a filename up for storage in 10825: userfile space, argument is: 10826: 10827: filename - proposed filename 10828: 10829: returns: the new clean filename 10830: 10831: =item * 10832: 10833: finishuserfileupload(): routine that creaes and sends the file to 10834: userspace, probably shouldn't be called directly 10835: 10836: docuname: username or courseid of destination for the file 10837: docudom: domain of user/course of destination for the file 10838: formname: same as for userfileupload() 10839: fname: filename (inculding subdirectories) for the file 10840: 10841: returns either the url of the uploaded file (/uploaded/....) if successful 10842: and /adm/notfound.html if unsuccessful 10843: 10844: =item * 10845: 10846: renameuserfile(): renames an existing userfile to a new name 10847: 10848: Args: 10849: docuname: username or courseid of destination for the file 10850: docudom: domain of user/course of destination for the file 10851: old: current file name (including any subdirs under userfiles) 10852: new: desired file name (including any subdirs under userfiles) 10853: 10854: =item * 10855: 10856: mkdiruserfile(): creates a directory is a userfiles dir 10857: 10858: Args: 10859: docuname: username or courseid of destination for the file 10860: docudom: domain of user/course of destination for the file 10861: dir: dir to create (including any subdirs under userfiles) 10862: 10863: =item * 10864: 10865: removeuserfile(): removes a file that exists in userfiles 10866: 10867: Args: 10868: docuname: username or courseid of destination for the file 10869: docudom: domain of user/course of destination for the file 10870: fname: filname to delete (including any subdirs under userfiles) 10871: 10872: =item * 10873: 10874: removeuploadedurl(): convience function for removeuserfile() 10875: 10876: Args: 10877: url: a full /uploaded/... url to delete 10878: 10879: =item * 10880: 10881: get_portfile_permissions(): 10882: Args: 10883: domain: domain of user or course contain the portfolio files 10884: user: name of user or num of course contain the portfolio files 10885: Returns: 10886: hashref of a dump of the proper file_permissions.db 10887: 10888: 10889: =item * 10890: 10891: get_access_controls(): 10892: 10893: Args: 10894: current_permissions: the hash ref returned from get_portfile_permissions() 10895: group: (optional) the group you want the files associated with 10896: file: (optional) the file you want access info on 10897: 10898: Returns: 10899: a hash (keys are file names) of hashes containing 10900: keys are: path to file/file_name\0uniqueID:scope_end_start (see below) 10901: values are XML containing access control settings (see below) 10902: 10903: Internal notes: 10904: 10905: access controls are stored in file_permissions.db as key=value pairs. 10906: key -> path to file/file_name\0uniqueID:scope_end_start 10907: where scope -> public,guest,course,group,domains or users. 10908: end -> UNIX time for end of access (0 -> no end date) 10909: start -> UNIX time for start of access 10910: 10911: value -> XML description of access control 10912: <scope type=""> (type =1 of: public,guest,course,group,domains,users"> 10913: <start></start> 10914: <end></end> 10915: 10916: <password></password> for scope type = guest 10917: 10918: <domain></domain> for scope type = course or group 10919: <number></number> 10920: <roles id=""> 10921: <role></role> 10922: <access></access> 10923: <section></section> 10924: <group></group> 10925: </roles> 10926: 10927: <dom></dom> for scope type = domains 10928: 10929: <users> for scope type = users 10930: <user> 10931: <uname></uname> 10932: <udom></udom> 10933: </user> 10934: </users> 10935: </scope> 10936: 10937: Access data is also aggregated for each file in an additional key=value pair: 10938: key -> path to file/file_name\0accesscontrol 10939: value -> reference to hash 10940: hash contains key = value pairs 10941: where key = uniqueID:scope_end_start 10942: value = UNIX time record was last updated 10943: 10944: Used to improve speed of look-ups of access controls for each file. 10945: 10946: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays. 10947: 10948: modify_access_controls(): 10949: 10950: Modifies access controls for a portfolio file 10951: Args 10952: 1. file name 10953: 2. reference to hash of required changes, 10954: 3. domain 10955: 4. username 10956: where domain,username are the domain of the portfolio owner 10957: (either a user or a course) 10958: 10959: Returns: 10960: 1. result of additions or updates ('ok' or 'error', with error message). 10961: 2. result of deletions ('ok' or 'error', with error message). 10962: 3. reference to hash of any new or updated access controls. 10963: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control. 10964: key = integer (inbound ID) 10965: value = uniqueID 10966: 10967: =back 10968: 10969: =head2 HTTP Helper Routines 10970: 10971: =over 4 10972: 10973: =item * 10974: 10975: escape() : unpack non-word characters into CGI-compatible hex codes 10976: 10977: =item * 10978: 10979: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character 10980: 10981: =back 10982: 10983: =head1 PRIVATE SUBROUTINES 10984: 10985: =head2 Underlying communication routines (Shouldn't call) 10986: 10987: =over 4 10988: 10989: =item * 10990: 10991: subreply() : tries to pass a message to lonc, returns con_lost if incapable 10992: 10993: =item * 10994: 10995: reply() : uses subreply to send a message to remote machine, logs all failures 10996: 10997: =item * 10998: 10999: critical() : passes a critical message to another server; if cannot 11000: get through then place message in connection buffer directory and 11001: returns con_delayed, if incapable of saving message, returns 11002: con_failed 11003: 11004: =item * 11005: 11006: reconlonc() : tries to reconnect lonc client processes. 11007: 11008: =back 11009: 11010: =head2 Resource Access Logging 11011: 11012: =over 4 11013: 11014: =item * 11015: 11016: flushcourselogs() : flush (save) buffer logs and access logs 11017: 11018: =item * 11019: 11020: courselog($what) : save message for course in hash 11021: 11022: =item * 11023: 11024: courseacclog($what) : save message for course using &courselog(). Perform 11025: special processing for specific resource types (problems, exams, quizzes, etc). 11026: 11027: =item * 11028: 11029: goodbye() : flush course logs and log shutting down; it is called in srm.conf 11030: as a PerlChildExitHandler 11031: 11032: =back 11033: 11034: =head2 Other 11035: 11036: =over 4 11037: 11038: =item * 11039: 11040: symblist($mapname,%newhash) : update symbolic storage links 11041: 11042: =back 11043: 11044: =cut 11045: