![]() ![]() | ![]() |
Bug #6476: storing maxtries and random seed
1: # The LearningOnline Network 2: # TCP networking package 3: # 4: # $Id: lonnet.pm,v 1.1109 2011/06/06 16:48:44 www 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 %loncaparevs %serverhomeIDs %needsrelease); 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: use File::Copy; 99: 100: my $readit; 101: my $max_connection_retries = 10; # Or some such value. 102: 103: require Exporter; 104: 105: our @ISA = qw (Exporter); 106: our @EXPORT = qw(%env); 107: 108: 109: # --------------------------------------------------------------------- Logging 110: { 111: my $logid; 112: sub instructor_log { 113: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_; 114: if (($cnum eq '') || ($cdom eq '')) { 115: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 116: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 117: } 118: $logid++; 119: my $now = time(); 120: my $id=$now.'00000'.$$.'00000'.$logid; 121: return &Apache::lonnet::put('nohist_'.$hash_name, 122: { $id => { 123: 'exe_uname' => $env{'user.name'}, 124: 'exe_udom' => $env{'user.domain'}, 125: 'exe_time' => $now, 126: 'exe_ip' => $ENV{'REMOTE_ADDR'}, 127: 'delflag' => $delflag, 128: 'logentry' => $storehash, 129: 'uname' => $uname, 130: 'udom' => $udom, 131: } 132: },$cdom,$cnum); 133: } 134: } 135: 136: sub logtouch { 137: my $execdir=$perlvar{'lonDaemons'}; 138: unless (-e "$execdir/logs/lonnet.log") { 139: open(my $fh,">>$execdir/logs/lonnet.log"); 140: close $fh; 141: } 142: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3]; 143: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log'); 144: } 145: 146: sub logthis { 147: my $message=shift; 148: my $execdir=$perlvar{'lonDaemons'}; 149: my $now=time; 150: my $local=localtime($now); 151: if (open(my $fh,">>$execdir/logs/lonnet.log")) { 152: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string. 153: print $fh $logstring; 154: close($fh); 155: } 156: return 1; 157: } 158: 159: sub logperm { 160: my $message=shift; 161: my $execdir=$perlvar{'lonDaemons'}; 162: my $now=time; 163: my $local=localtime($now); 164: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) { 165: print $fh "$now:$message:$local\n"; 166: close($fh); 167: } 168: return 1; 169: } 170: 171: sub create_connection { 172: my ($hostname,$lonid) = @_; 173: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'}, 174: Type => SOCK_STREAM, 175: Timeout => 10); 176: return 0 if (!$client); 177: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n"); 178: my $result = <$client>; 179: chomp($result); 180: return 1 if ($result eq 'done'); 181: return 0; 182: } 183: 184: sub get_server_timezone { 185: my ($cnum,$cdom) = @_; 186: my $home=&homeserver($cnum,$cdom); 187: if ($home ne 'no_host') { 188: my $cachetime = 24*3600; 189: my ($timezone,$cached)=&is_cached_new('servertimezone',$home); 190: if (defined($cached)) { 191: return $timezone; 192: } else { 193: my $timezone = &reply('servertimezone',$home); 194: return &do_cache_new('servertimezone',$home,$timezone,$cachetime); 195: } 196: } 197: } 198: 199: sub get_server_distarch { 200: my ($lonhost,$ignore_cache) = @_; 201: if (defined($lonhost)) { 202: if (!defined(&hostname($lonhost))) { 203: return; 204: } 205: my $cachetime = 12*3600; 206: if (!$ignore_cache) { 207: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost); 208: if (defined($cached)) { 209: return $distarch; 210: } 211: } 212: my $rep = &reply('serverdistarch',$lonhost); 213: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 214: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' || 215: $rep eq '') { 216: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime); 217: } 218: } 219: return; 220: } 221: 222: sub get_server_loncaparev { 223: my ($dom,$lonhost,$ignore_cache,$caller) = @_; 224: if (defined($lonhost)) { 225: if (!defined(&hostname($lonhost))) { 226: undef($lonhost); 227: } 228: } 229: if (!defined($lonhost)) { 230: if (defined(&domain($dom,'primary'))) { 231: $lonhost=&domain($dom,'primary'); 232: if ($lonhost eq 'no_host') { 233: undef($lonhost); 234: } 235: } 236: } 237: if (defined($lonhost)) { 238: my $cachetime = 12*3600; 239: if (!$ignore_cache) { 240: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost); 241: if (defined($cached)) { 242: return $loncaparev; 243: } 244: } 245: my ($answer,$loncaparev); 246: my @ids=¤t_machine_ids(); 247: if (grep(/^\Q$lonhost\E$/,@ids)) { 248: $answer = $perlvar{'lonVersion'}; 249: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) { 250: $loncaparev = $1; 251: } 252: } else { 253: $answer = &reply('serverloncaparev',$lonhost); 254: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) { 255: if ($caller eq 'loncron') { 256: my $ua=new LWP::UserAgent; 257: $ua->timeout(4); 258: my $protocol = $protocol{$lonhost}; 259: $protocol = 'http' if ($protocol ne 'https'); 260: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html'; 261: my $request=new HTTP::Request('GET',$url); 262: my $response=$ua->request($request); 263: unless ($response->is_error()) { 264: my $content = $response->content; 265: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) { 266: $loncaparev = $1; 267: } 268: } 269: } else { 270: $loncaparev = $loncaparevs{$lonhost}; 271: } 272: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) { 273: $loncaparev = $1; 274: } 275: } 276: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime); 277: } 278: } 279: 280: sub get_server_homeID { 281: my ($hostname,$ignore_cache,$caller) = @_; 282: unless ($ignore_cache) { 283: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname); 284: if (defined($cached)) { 285: return $serverhomeID; 286: } 287: } 288: my $cachetime = 12*3600; 289: my $serverhomeID; 290: if ($caller eq 'loncron') { 291: my @machine_ids = &machine_ids($hostname); 292: foreach my $id (@machine_ids) { 293: my $response = &reply('serverhomeID',$id); 294: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) { 295: $serverhomeID = $response; 296: last; 297: } 298: } 299: if ($serverhomeID eq '') { 300: $serverhomeID = $machine_ids[-1]; 301: } 302: } else { 303: $serverhomeID = $serverhomeIDs{$hostname}; 304: } 305: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime); 306: } 307: 308: # -------------------------------------------------- Non-critical communication 309: sub subreply { 310: my ($cmd,$server)=@_; 311: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server); 312: # 313: # With loncnew process trimming, there's a timing hole between lonc server 314: # process exit and the master server picking up the listen on the AF_UNIX 315: # socket. In that time interval, a lock file will exist: 316: 317: my $lockfile=$peerfile.".lock"; 318: while (-e $lockfile) { # Need to wait for the lockfile to disappear. 319: sleep(1); 320: } 321: # At this point, either a loncnew parent is listening or an old lonc 322: # or loncnew child is listening so we can connect or everything's dead. 323: # 324: # We'll give the connection a few tries before abandoning it. If 325: # connection is not possible, we'll con_lost back to the client. 326: # 327: my $client; 328: for (my $retries = 0; $retries < $max_connection_retries; $retries++) { 329: $client=IO::Socket::UNIX->new(Peer =>"$peerfile", 330: Type => SOCK_STREAM, 331: Timeout => 10); 332: if ($client) { 333: last; # Connected! 334: } else { 335: &create_connection(&hostname($server),$server); 336: } 337: sleep(1); # Try again later if failed connection. 338: } 339: my $answer; 340: if ($client) { 341: print $client "sethost:$server:$cmd\n"; 342: $answer=<$client>; 343: if (!$answer) { $answer="con_lost"; } 344: chomp($answer); 345: } else { 346: $answer = 'con_lost'; # Failed connection. 347: } 348: return $answer; 349: } 350: 351: sub reply { 352: my ($cmd,$server)=@_; 353: unless (defined(&hostname($server))) { return 'no_such_host'; } 354: my $answer=subreply($cmd,$server); 355: if (($answer=~/^refused/) || ($answer=~/^rejected/)) { 356: &logthis("<font color=\"blue\">WARNING:". 357: " $cmd to $server returned $answer</font>"); 358: } 359: return $answer; 360: } 361: 362: # ----------------------------------------------------------- Send USR1 to lonc 363: 364: sub reconlonc { 365: my ($lonid) = @_; 366: my $hostname = &hostname($lonid); 367: if ($lonid) { 368: my $peerfile="$perlvar{'lonSockDir'}/$hostname"; 369: if ($hostname && -e $peerfile) { 370: &logthis("Trying to reconnect lonc for $lonid ($hostname)"); 371: my $client=IO::Socket::UNIX->new(Peer => $peerfile, 372: Type => SOCK_STREAM, 373: Timeout => 10); 374: if ($client) { 375: print $client ("reset_retries\n"); 376: my $answer=<$client>; 377: #reset just this one. 378: } 379: } 380: return; 381: } 382: 383: &logthis("Trying to reconnect lonc"); 384: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid"; 385: if (open(my $fh,"<$loncfile")) { 386: my $loncpid=<$fh>; 387: chomp($loncpid); 388: if (kill 0 => $loncpid) { 389: &logthis("lonc at pid $loncpid responding, sending USR1"); 390: kill USR1 => $loncpid; 391: sleep 1; 392: } else { 393: &logthis( 394: "<font color=\"blue\">WARNING:". 395: " lonc at pid $loncpid not responding, giving up</font>"); 396: } 397: } else { 398: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>'); 399: } 400: } 401: 402: # ------------------------------------------------------ Critical communication 403: 404: sub critical { 405: my ($cmd,$server)=@_; 406: unless (&hostname($server)) { 407: &logthis("<font color=\"blue\">WARNING:". 408: " Critical message to unknown server ($server)</font>"); 409: return 'no_such_host'; 410: } 411: my $answer=reply($cmd,$server); 412: if ($answer eq 'con_lost') { 413: &reconlonc("$perlvar{'lonSockDir'}/$server"); 414: my $answer=reply($cmd,$server); 415: if ($answer eq 'con_lost') { 416: my $now=time; 417: my $middlename=$cmd; 418: $middlename=substr($middlename,0,16); 419: $middlename=~s/\W//g; 420: my $dfilename= 421: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server"; 422: $dumpcount++; 423: { 424: my $dfh; 425: if (open($dfh,">$dfilename")) { 426: print $dfh "$cmd\n"; 427: close($dfh); 428: } 429: } 430: sleep 2; 431: my $wcmd=''; 432: { 433: my $dfh; 434: if (open($dfh,"<$dfilename")) { 435: $wcmd=<$dfh>; 436: close($dfh); 437: } 438: } 439: chomp($wcmd); 440: if ($wcmd eq $cmd) { 441: &logthis("<font color=\"blue\">WARNING: ". 442: "Connection buffer $dfilename: $cmd</font>"); 443: &logperm("D:$server:$cmd"); 444: return 'con_delayed'; 445: } else { 446: &logthis("<font color=\"red\">CRITICAL:" 447: ." Critical connection failed: $server $cmd</font>"); 448: &logperm("F:$server:$cmd"); 449: return 'con_failed'; 450: } 451: } 452: } 453: return $answer; 454: } 455: 456: # ------------------------------------------- check if return value is an error 457: 458: sub error { 459: my ($result) = @_; 460: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) { 461: if ($2 == 2) { return undef; } 462: return $1; 463: } 464: return undef; 465: } 466: 467: sub convert_and_load_session_env { 468: my ($lonidsdir,$handle)=@_; 469: my @profile; 470: { 471: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 472: if (!$opened) { 473: return 0; 474: } 475: flock($idf,LOCK_SH); 476: @profile=<$idf>; 477: close($idf); 478: } 479: my %temp_env; 480: foreach my $line (@profile) { 481: if ($line !~ m/=/) { 482: return 0; 483: } 484: chomp($line); 485: my ($envname,$envvalue)=split(/=/,$line,2); 486: $temp_env{&unescape($envname)} = &unescape($envvalue); 487: } 488: unlink("$lonidsdir/$handle.id"); 489: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(), 490: 0640)) { 491: %disk_env = %temp_env; 492: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)}; 493: untie(%disk_env); 494: } 495: return 1; 496: } 497: 498: # ------------------------------------------- Transfer profile into environment 499: my $env_loaded; 500: sub transfer_profile_to_env { 501: my ($lonidsdir,$handle,$force_transfer) = @_; 502: if (!$force_transfer && $env_loaded) { return; } 503: 504: if (!defined($lonidsdir)) { 505: $lonidsdir = $perlvar{'lonIDsDir'}; 506: } 507: if (!defined($handle)) { 508: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| ); 509: } 510: 511: my $convert; 512: { 513: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 514: if (!$opened) { 515: return; 516: } 517: flock($idf,LOCK_SH); 518: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id", 519: &GDBM_READER(),0640)) { 520: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)}; 521: untie(%disk_env); 522: } else { 523: $convert = 1; 524: } 525: } 526: if ($convert) { 527: if (!&convert_and_load_session_env($lonidsdir,$handle)) { 528: &logthis("Failed to load session, or convert session."); 529: } 530: } 531: 532: my %remove; 533: while ( my $envname = each(%env) ) { 534: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) { 535: if ($time < time-300) { 536: $remove{$key}++; 537: } 538: } 539: } 540: 541: $env{'user.environment'} = "$lonidsdir/$handle.id"; 542: $env_loaded=1; 543: foreach my $expired_key (keys(%remove)) { 544: &delenv($expired_key); 545: } 546: } 547: 548: # ---------------------------------------------------- Check for valid session 549: sub check_for_valid_session { 550: my ($r) = @_; 551: my %cookies=CGI::Cookie->parse($r->header_in('Cookie')); 552: my $lonid=$cookies{'lonID'}; 553: return undef if (!$lonid); 554: 555: my $handle=&LONCAPA::clean_handle($lonid->value); 556: my $lonidsdir=$r->dir_config('lonIDsDir'); 557: return undef if (!-e "$lonidsdir/$handle.id"); 558: 559: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 560: return undef if (!$opened); 561: 562: flock($idf,LOCK_SH); 563: my %disk_env; 564: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id", 565: &GDBM_READER(),0640)) { 566: return undef; 567: } 568: 569: if (!defined($disk_env{'user.name'}) 570: || !defined($disk_env{'user.domain'})) { 571: return undef; 572: } 573: return $handle; 574: } 575: 576: sub timed_flock { 577: my ($file,$lock_type) = @_; 578: my $failed=0; 579: eval { 580: local $SIG{__DIE__}='DEFAULT'; 581: local $SIG{ALRM}=sub { 582: $failed=1; 583: die("failed lock"); 584: }; 585: alarm(13); 586: flock($file,$lock_type); 587: alarm(0); 588: }; 589: if ($failed) { 590: return undef; 591: } else { 592: return 1; 593: } 594: } 595: 596: # ---------------------------------------------------------- Append Environment 597: 598: sub appenv { 599: my ($newenv,$roles) = @_; 600: if (ref($newenv) eq 'HASH') { 601: foreach my $key (keys(%{$newenv})) { 602: my $refused = 0; 603: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) { 604: $refused = 1; 605: if (ref($roles) eq 'ARRAY') { 606: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./); 607: if (grep(/^\Q$role\E$/,@{$roles})) { 608: $refused = 0; 609: } 610: } 611: } 612: if ($refused) { 613: &logthis("<font color=\"blue\">WARNING: ". 614: "Attempt to modify environment ".$key." to ".$newenv->{$key} 615: .'</font>'); 616: delete($newenv->{$key}); 617: } else { 618: $env{$key}=$newenv->{$key}; 619: } 620: } 621: my $opened = open(my $env_file,'+<',$env{'user.environment'}); 622: if ($opened 623: && &timed_flock($env_file,LOCK_EX) 624: && 625: tie(my %disk_env,'GDBM_File',$env{'user.environment'}, 626: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) { 627: while (my ($key,$value) = each(%{$newenv})) { 628: $disk_env{$key} = $value; 629: } 630: untie(%disk_env); 631: } 632: } 633: return 'ok'; 634: } 635: # ----------------------------------------------------- Delete from Environment 636: 637: sub delenv { 638: my ($delthis,$regexp,$roles) = @_; 639: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) { 640: my $refused = 1; 641: if (ref($roles) eq 'ARRAY') { 642: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./); 643: if (grep(/^\Q$role\E$/,@{$roles})) { 644: $refused = 0; 645: } 646: } 647: if ($refused) { 648: &logthis("<font color=\"blue\">WARNING: ". 649: "Attempt to delete from environment ".$delthis); 650: return 'error'; 651: } 652: } 653: my $opened = open(my $env_file,'+<',$env{'user.environment'}); 654: if ($opened 655: && &timed_flock($env_file,LOCK_EX) 656: && 657: tie(my %disk_env,'GDBM_File',$env{'user.environment'}, 658: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) { 659: foreach my $key (keys(%disk_env)) { 660: if ($regexp) { 661: if ($key=~/^$delthis/) { 662: delete($env{$key}); 663: delete($disk_env{$key}); 664: } 665: } else { 666: if ($key=~/^\Q$delthis\E/) { 667: delete($env{$key}); 668: delete($disk_env{$key}); 669: } 670: } 671: } 672: untie(%disk_env); 673: } 674: return 'ok'; 675: } 676: 677: sub get_env_multiple { 678: my ($name) = @_; 679: my @values; 680: if (defined($env{$name})) { 681: # exists is it an array 682: if (ref($env{$name})) { 683: @values=@{ $env{$name} }; 684: } else { 685: $values[0]=$env{$name}; 686: } 687: } 688: return(@values); 689: } 690: 691: # ------------------------------------------------------------------- Locking 692: 693: sub set_lock { 694: my ($text)=@_; 695: $locknum++; 696: my $id=$$.'-'.$locknum; 697: &appenv({'session.locks' => $env{'session.locks'}.','.$id, 698: 'session.lock.'.$id => $text}); 699: return $id; 700: } 701: 702: sub get_locks { 703: my $num=0; 704: my %texts=(); 705: foreach my $lock (split(/\,/,$env{'session.locks'})) { 706: if ($lock=~/\w/) { 707: $num++; 708: $texts{$lock}=$env{'session.lock.'.$lock}; 709: } 710: } 711: return ($num,%texts); 712: } 713: 714: sub remove_lock { 715: my ($id)=@_; 716: my $newlocks=''; 717: foreach my $lock (split(/\,/,$env{'session.locks'})) { 718: if (($lock=~/\w/) && ($lock ne $id)) { 719: $newlocks.=','.$lock; 720: } 721: } 722: &appenv({'session.locks' => $newlocks}); 723: &delenv('session.lock.'.$id); 724: } 725: 726: sub remove_all_locks { 727: my $activelocks=$env{'session.locks'}; 728: foreach my $lock (split(/\,/,$env{'session.locks'})) { 729: if ($lock=~/\w/) { 730: &remove_lock($lock); 731: } 732: } 733: } 734: 735: 736: # ------------------------------------------ Find out current server userload 737: sub userload { 738: my $numusers=0; 739: { 740: opendir(LONIDS,$perlvar{'lonIDsDir'}); 741: my $filename; 742: my $curtime=time; 743: while ($filename=readdir(LONIDS)) { 744: next if ($filename eq '.' || $filename eq '..'); 745: next if ($filename =~ /publicuser_\d+\.id/); 746: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9]; 747: if ($curtime-$mtime < 1800) { $numusers++; } 748: } 749: closedir(LONIDS); 750: } 751: my $userloadpercent=0; 752: my $maxuserload=$perlvar{'lonUserLoadLim'}; 753: if ($maxuserload) { 754: $userloadpercent=100*$numusers/$maxuserload; 755: } 756: $userloadpercent=sprintf("%.2f",$userloadpercent); 757: return $userloadpercent; 758: } 759: 760: # ------------------------------ Find server with least workload from spare.tab 761: 762: sub spareserver { 763: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_; 764: my $spare_server; 765: if ($userloadpercent !~ /\d/) { $userloadpercent=0; } 766: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 767: : $userloadpercent; 768: my ($uint_dom,$remotesessions); 769: if (($udom ne '') && (&domain($udom) ne '')) { 770: my $uprimary_id = &Apache::lonnet::domain($udom,'primary'); 771: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id); 772: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom); 773: $remotesessions = $udomdefaults{'remotesessions'}; 774: } 775: foreach my $try_server (@{ $spareid{'primary'} }) { 776: if ($uint_dom) { 777: next unless (&spare_can_host($udom,$uint_dom,$remotesessions, 778: $try_server)); 779: } 780: ($spare_server, $lowest_load) = 781: &compare_server_load($try_server, $spare_server, $lowest_load); 782: } 783: 784: my $found_server = ($spare_server ne '' && $lowest_load < 100); 785: 786: if (!$found_server) { 787: foreach my $try_server (@{ $spareid{'default'} }) { 788: if ($uint_dom) { 789: next unless (&spare_can_host($udom,$uint_dom,$remotesessions, 790: $try_server)); 791: } 792: ($spare_server, $lowest_load) = 793: &compare_server_load($try_server, $spare_server, $lowest_load); 794: } 795: } 796: 797: if (!$want_server_name) { 798: my $protocol = 'http'; 799: if ($protocol{$spare_server} eq 'https') { 800: $protocol = $protocol{$spare_server}; 801: } 802: if (defined($spare_server)) { 803: my $hostname = &hostname($spare_server); 804: if (defined($hostname)) { 805: $spare_server = $protocol.'://'.$hostname; 806: } 807: } 808: } 809: return $spare_server; 810: } 811: 812: sub compare_server_load { 813: my ($try_server, $spare_server, $lowest_load) = @_; 814: 815: my $loadans = &reply('load', $try_server); 816: my $userloadans = &reply('userload',$try_server); 817: 818: if ($loadans !~ /\d/ && $userloadans !~ /\d/) { 819: return; #didn't get a number from the server 820: } 821: 822: my $load; 823: if ($loadans =~ /\d/) { 824: if ($userloadans =~ /\d/) { 825: #both are numbers, pick the bigger one 826: $load = ($loadans > $userloadans) ? $loadans 827: : $userloadans; 828: } else { 829: $load = $loadans; 830: } 831: } else { 832: $load = $userloadans; 833: } 834: 835: if (($load =~ /\d/) && ($load < $lowest_load)) { 836: $spare_server = $try_server; 837: $lowest_load = $load; 838: } 839: return ($spare_server,$lowest_load); 840: } 841: 842: # --------------------------- ask offload servers if user already has a session 843: sub find_existing_session { 844: my ($udom,$uname) = @_; 845: foreach my $try_server (@{ $spareid{'primary'} }, 846: @{ $spareid{'default'} }) { 847: return $try_server if (&has_user_session($try_server, $udom, $uname)); 848: } 849: return; 850: } 851: 852: # -------------------------------- ask if server already has a session for user 853: sub has_user_session { 854: my ($lonid,$udom,$uname) = @_; 855: my $result = &reply(join(':','userhassession', 856: map {&escape($_)} ($udom,$uname)),$lonid); 857: return 1 if ($result eq 'ok'); 858: 859: return 0; 860: } 861: 862: # --------- determine least loaded server in a user's domain which allows login 863: 864: sub choose_server { 865: my ($udom) = @_; 866: my %domconfhash = &Apache::loncommon::get_domainconf($udom); 867: my %servers = &get_servers($udom); 868: my $lowest_load = 30000; 869: my ($login_host,$hostname); 870: foreach my $lonhost (keys(%servers)) { 871: my $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost}; 872: if ($loginvia eq '') { 873: ($login_host, $lowest_load) = 874: &compare_server_load($lonhost, $login_host, $lowest_load); 875: } 876: } 877: if ($login_host ne '') { 878: $hostname = $servers{$login_host}; 879: } 880: return ($login_host,$hostname); 881: } 882: 883: # --------------------------------------------- Try to change a user's password 884: 885: sub changepass { 886: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_; 887: $currentpass = &escape($currentpass); 888: $newpass = &escape($newpass); 889: my $lonhost = $perlvar{'lonHostID'}; 890: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost", 891: $server); 892: if (! $answer) { 893: &logthis("No reply on password change request to $server ". 894: "by $uname in domain $udom."); 895: } elsif ($answer =~ "^ok") { 896: &logthis("$uname in $udom successfully changed their password ". 897: "on $server."); 898: } elsif ($answer =~ "^pwchange_failure") { 899: &logthis("$uname in $udom was unable to change their password ". 900: "on $server. The action was blocked by either lcpasswd ". 901: "or pwchange"); 902: } elsif ($answer =~ "^non_authorized") { 903: &logthis("$uname in $udom did not get their password correct when ". 904: "attempting to change it on $server."); 905: } elsif ($answer =~ "^auth_mode_error") { 906: &logthis("$uname in $udom attempted to change their password despite ". 907: "not being locally or internally authenticated on $server."); 908: } elsif ($answer =~ "^unknown_user") { 909: &logthis("$uname in $udom attempted to change their password ". 910: "on $server but were unable to because $server is not ". 911: "their home server."); 912: } elsif ($answer =~ "^refused") { 913: &logthis("$server refused to change $uname in $udom password because ". 914: "it was sent an unencrypted request to change the password."); 915: } elsif ($answer =~ "invalid_client") { 916: &logthis("$server refused to change $uname in $udom password because ". 917: "it was a reset by e-mail originating from an invalid server."); 918: } 919: return $answer; 920: } 921: 922: # ----------------------- Try to determine user's current authentication scheme 923: 924: sub queryauthenticate { 925: my ($uname,$udom)=@_; 926: my $uhome=&homeserver($uname,$udom); 927: if (!$uhome) { 928: &logthis("User $uname at $udom is unknown when looking for authentication mechanism"); 929: return 'no_host'; 930: } 931: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome); 932: if ($answer =~ /^(unknown_user|refused|con_lost)/) { 933: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 934: } 935: return $answer; 936: } 937: 938: # --------- Try to authenticate user from domain's lib servers (first this one) 939: 940: sub authenticate { 941: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_; 942: $upass=&escape($upass); 943: $uname= &LONCAPA::clean_username($uname); 944: my $uhome=&homeserver($uname,$udom,1); 945: my $newhome; 946: if ((!$uhome) || ($uhome eq 'no_host')) { 947: # Maybe the machine was offline and only re-appeared again recently? 948: &reconlonc(); 949: # One more 950: $uhome=&homeserver($uname,$udom,1); 951: if (($uhome eq 'no_host') && $checkdefauth) { 952: if (defined(&domain($udom,'primary'))) { 953: $newhome=&domain($udom,'primary'); 954: } 955: if ($newhome ne '') { 956: $uhome = $newhome; 957: } 958: } 959: if ((!$uhome) || ($uhome eq 'no_host')) { 960: &logthis("User $uname at $udom is unknown in authenticate"); 961: return 'no_host'; 962: } 963: } 964: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome); 965: if ($answer eq 'authorized') { 966: if ($newhome) { 967: &logthis("User $uname at $udom authorized by $uhome, but needs account"); 968: return 'no_account_on_host'; 969: } else { 970: &logthis("User $uname at $udom authorized by $uhome"); 971: return $uhome; 972: } 973: } 974: if ($answer eq 'non_authorized') { 975: &logthis("User $uname at $udom rejected by $uhome"); 976: return 'no_host'; 977: } 978: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 979: return 'no_host'; 980: } 981: 982: sub can_host_session { 983: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_; 984: my $canhost = 1; 985: my $host_idn = &Apache::lonnet::internet_dom($lonhost); 986: if (ref($remotesessions) eq 'HASH') { 987: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') { 988: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) { 989: $canhost = 0; 990: } else { 991: $canhost = 1; 992: } 993: } 994: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') { 995: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) { 996: $canhost = 1; 997: } else { 998: $canhost = 0; 999: } 1000: } 1001: if ($canhost) { 1002: if ($remotesessions->{'version'} ne '') { 1003: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/); 1004: if ($reqmajor ne '' && $reqminor ne '') { 1005: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) { 1006: my $major = $1; 1007: my $minor = $2; 1008: if (($major < $reqmajor ) || 1009: (($major == $reqmajor) && ($minor < $reqminor))) { 1010: $canhost = 0; 1011: } 1012: } else { 1013: $canhost = 0; 1014: } 1015: } 1016: } 1017: } 1018: } 1019: if ($canhost) { 1020: if (ref($hostedsessions) eq 'HASH') { 1021: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') { 1022: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'excludedomain'}})) { 1023: $canhost = 0; 1024: } else { 1025: $canhost = 1; 1026: } 1027: } 1028: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') { 1029: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'includedomain'}})) { 1030: $canhost = 1; 1031: } else { 1032: $canhost = 0; 1033: } 1034: } 1035: } 1036: } 1037: return $canhost; 1038: } 1039: 1040: sub spare_can_host { 1041: my ($udom,$uint_dom,$remotesessions,$try_server)=@_; 1042: my $canhost=1; 1043: my @intdoms; 1044: my $internet_names = &Apache::lonnet::get_internet_names($try_server); 1045: if (ref($internet_names) eq 'ARRAY') { 1046: @intdoms = @{$internet_names}; 1047: } 1048: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) { 1049: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server); 1050: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID); 1051: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom); 1052: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server); 1053: $canhost = &can_host_session($udom,$try_server,$remoterev, 1054: $remotesessions, 1055: $defdomdefaults{'hostedsessions'}); 1056: } 1057: return $canhost; 1058: } 1059: 1060: # ---------------------- Find the homebase for a user from domain's lib servers 1061: 1062: my %homecache; 1063: sub homeserver { 1064: my ($uname,$udom,$ignoreBadCache)=@_; 1065: my $index="$uname:$udom"; 1066: 1067: if (exists($homecache{$index})) { return $homecache{$index}; } 1068: 1069: my %servers = &get_servers($udom,'library'); 1070: foreach my $tryserver (keys(%servers)) { 1071: next if ($ignoreBadCache ne 'true' && 1072: exists($badServerCache{$tryserver})); 1073: 1074: my $answer=reply("home:$udom:$uname",$tryserver); 1075: if ($answer eq 'found') { 1076: delete($badServerCache{$tryserver}); 1077: return $homecache{$index}=$tryserver; 1078: } elsif ($answer eq 'no_host') { 1079: $badServerCache{$tryserver}=1; 1080: } 1081: } 1082: return 'no_host'; 1083: } 1084: 1085: # ------------------------------------- Find the usernames behind a list of IDs 1086: 1087: sub idget { 1088: my ($udom,@ids)=@_; 1089: my %returnhash=(); 1090: 1091: my %servers = &get_servers($udom,'library'); 1092: foreach my $tryserver (keys(%servers)) { 1093: my $idlist=join('&',@ids); 1094: $idlist=~tr/A-Z/a-z/; 1095: my $reply=&reply("idget:$udom:".$idlist,$tryserver); 1096: my @answer=(); 1097: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) { 1098: @answer=split(/\&/,$reply); 1099: } ; 1100: my $i; 1101: for ($i=0;$i<=$#ids;$i++) { 1102: if ($answer[$i]) { 1103: $returnhash{$ids[$i]}=$answer[$i]; 1104: } 1105: } 1106: } 1107: return %returnhash; 1108: } 1109: 1110: # ------------------------------------- Find the IDs behind a list of usernames 1111: 1112: sub idrget { 1113: my ($udom,@unames)=@_; 1114: my %returnhash=(); 1115: foreach my $uname (@unames) { 1116: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1]; 1117: } 1118: return %returnhash; 1119: } 1120: 1121: # ------------------------------- Store away a list of names and associated IDs 1122: 1123: sub idput { 1124: my ($udom,%ids)=@_; 1125: my %servers=(); 1126: foreach my $uname (keys(%ids)) { 1127: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname); 1128: my $uhom=&homeserver($uname,$udom); 1129: if ($uhom ne 'no_host') { 1130: my $id=&escape($ids{$uname}); 1131: $id=~tr/A-Z/a-z/; 1132: my $esc_unam=&escape($uname); 1133: if ($servers{$uhom}) { 1134: $servers{$uhom}.='&'.$id.'='.$esc_unam; 1135: } else { 1136: $servers{$uhom}=$id.'='.$esc_unam; 1137: } 1138: } 1139: } 1140: foreach my $server (keys(%servers)) { 1141: &critical('idput:'.$udom.':'.$servers{$server},$server); 1142: } 1143: } 1144: 1145: # ------------------------------dump from db file owned by domainconfig user 1146: sub dump_dom { 1147: my ($namespace,$udom,$regexp,$range)=@_; 1148: if (!$udom) { 1149: $udom=$env{'user.domain'}; 1150: } 1151: my %returnhash; 1152: if ($udom) { 1153: my $uname = &get_domainconfiguser($udom); 1154: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range); 1155: } 1156: return %returnhash; 1157: } 1158: 1159: # ------------------------------------------ get items from domain db files 1160: 1161: sub get_dom { 1162: my ($namespace,$storearr,$udom,$uhome)=@_; 1163: my $items=''; 1164: foreach my $item (@$storearr) { 1165: $items.=&escape($item).'&'; 1166: } 1167: $items=~s/\&$//; 1168: if (!$udom) { 1169: $udom=$env{'user.domain'}; 1170: if (defined(&domain($udom,'primary'))) { 1171: $uhome=&domain($udom,'primary'); 1172: } else { 1173: undef($uhome); 1174: } 1175: } else { 1176: if (!$uhome) { 1177: if (defined(&domain($udom,'primary'))) { 1178: $uhome=&domain($udom,'primary'); 1179: } 1180: } 1181: } 1182: if ($udom && $uhome && ($uhome ne 'no_host')) { 1183: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome); 1184: my %returnhash; 1185: if ($rep eq '' || $rep =~ /^error: 2 /) { 1186: return %returnhash; 1187: } 1188: my @pairs=split(/\&/,$rep); 1189: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 1190: return @pairs; 1191: } 1192: my $i=0; 1193: foreach my $item (@$storearr) { 1194: $returnhash{$item}=&thaw_unescape($pairs[$i]); 1195: $i++; 1196: } 1197: return %returnhash; 1198: } else { 1199: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)"); 1200: } 1201: } 1202: 1203: # -------------------------------------------- put items in domain db files 1204: 1205: sub put_dom { 1206: my ($namespace,$storehash,$udom,$uhome)=@_; 1207: if (!$udom) { 1208: $udom=$env{'user.domain'}; 1209: if (defined(&domain($udom,'primary'))) { 1210: $uhome=&domain($udom,'primary'); 1211: } else { 1212: undef($uhome); 1213: } 1214: } else { 1215: if (!$uhome) { 1216: if (defined(&domain($udom,'primary'))) { 1217: $uhome=&domain($udom,'primary'); 1218: } 1219: } 1220: } 1221: if ($udom && $uhome && ($uhome ne 'no_host')) { 1222: my $items=''; 1223: foreach my $item (keys(%$storehash)) { 1224: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 1225: } 1226: $items=~s/\&$//; 1227: return &reply("putdom:$udom:$namespace:$items",$uhome); 1228: } else { 1229: &logthis("put_dom failed - no homeserver and/or domain"); 1230: } 1231: } 1232: 1233: # --------------------- newput for items in db file owned by domainconfig user 1234: sub newput_dom { 1235: my ($namespace,$storehash,$udom) = @_; 1236: my $result; 1237: if (!$udom) { 1238: $udom=$env{'user.domain'}; 1239: } 1240: if ($udom) { 1241: my $uname = &get_domainconfiguser($udom); 1242: $result = &newput($namespace,$storehash,$udom,$uname); 1243: } 1244: return $result; 1245: } 1246: 1247: # --------------------- delete for items in db file owned by domainconfig user 1248: sub del_dom { 1249: my ($namespace,$storearr,$udom)=@_; 1250: if (ref($storearr) eq 'ARRAY') { 1251: if (!$udom) { 1252: $udom=$env{'user.domain'}; 1253: } 1254: if ($udom) { 1255: my $uname = &get_domainconfiguser($udom); 1256: return &del($namespace,$storearr,$udom,$uname); 1257: } 1258: } 1259: } 1260: 1261: # ----------------------------------construct domainconfig user for a domain 1262: sub get_domainconfiguser { 1263: my ($udom) = @_; 1264: return $udom.'-domainconfig'; 1265: } 1266: 1267: sub retrieve_inst_usertypes { 1268: my ($udom) = @_; 1269: my (%returnhash,@order); 1270: my %domdefs = &Apache::lonnet::get_domain_defaults($udom); 1271: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 1272: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) { 1273: %returnhash = %{$domdefs{'inststatustypes'}}; 1274: @order = @{$domdefs{'inststatusorder'}}; 1275: } else { 1276: if (defined(&domain($udom,'primary'))) { 1277: my $uhome=&domain($udom,'primary'); 1278: my $rep=&reply("inst_usertypes:$udom",$uhome); 1279: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) { 1280: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom"); 1281: return (\%returnhash,\@order); 1282: } 1283: my ($hashitems,$orderitems) = split(/:/,$rep); 1284: my @pairs=split(/\&/,$hashitems); 1285: foreach my $item (@pairs) { 1286: my ($key,$value)=split(/=/,$item,2); 1287: $key = &unescape($key); 1288: next if ($key =~ /^error: 2 /); 1289: $returnhash{$key}=&thaw_unescape($value); 1290: } 1291: my @esc_order = split(/\&/,$orderitems); 1292: foreach my $item (@esc_order) { 1293: push(@order,&unescape($item)); 1294: } 1295: } else { 1296: &logthis("get_dom failed - no primary domain server for $udom"); 1297: } 1298: } 1299: return (\%returnhash,\@order); 1300: } 1301: 1302: sub is_domainimage { 1303: my ($url) = @_; 1304: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) { 1305: if (&domain($1) ne '') { 1306: return '1'; 1307: } 1308: } 1309: return; 1310: } 1311: 1312: sub inst_directory_query { 1313: my ($srch) = @_; 1314: my $udom = $srch->{'srchdomain'}; 1315: my %results; 1316: my $homeserver = &domain($udom,'primary'); 1317: my $outcome; 1318: if ($homeserver ne '') { 1319: my $queryid=&reply("querysend:instdirsearch:". 1320: &escape($srch->{'srchby'}).':'. 1321: &escape($srch->{'srchterm'}).':'. 1322: &escape($srch->{'srchtype'}),$homeserver); 1323: my $host=&hostname($homeserver); 1324: if ($queryid !~/^\Q$host\E\_/) { 1325: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1326: return; 1327: } 1328: my $response = &get_query_reply($queryid); 1329: my $maxtries = 5; 1330: my $tries = 1; 1331: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1332: $response = &get_query_reply($queryid); 1333: $tries ++; 1334: } 1335: 1336: if (!&error($response) && $response ne 'refused') { 1337: if ($response eq 'unavailable') { 1338: $outcome = $response; 1339: } else { 1340: $outcome = 'ok'; 1341: my @matches = split(/\n/,$response); 1342: foreach my $match (@matches) { 1343: my ($key,$value) = split(/=/,$match); 1344: $results{&unescape($key).':'.$udom} = &thaw_unescape($value); 1345: } 1346: } 1347: } 1348: } 1349: return ($outcome,%results); 1350: } 1351: 1352: sub usersearch { 1353: my ($srch) = @_; 1354: my $dom = $srch->{'srchdomain'}; 1355: my %results; 1356: my %libserv = &all_library(); 1357: my $query = 'usersearch'; 1358: foreach my $tryserver (keys(%libserv)) { 1359: if (&host_domain($tryserver) eq $dom) { 1360: my $host=&hostname($tryserver); 1361: my $queryid= 1362: &reply("querysend:".&escape($query).':'. 1363: &escape($srch->{'srchby'}).':'. 1364: &escape($srch->{'srchtype'}).':'. 1365: &escape($srch->{'srchterm'}),$tryserver); 1366: if ($queryid !~/^\Q$host\E\_/) { 1367: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver); 1368: next; 1369: } 1370: my $reply = &get_query_reply($queryid); 1371: my $maxtries = 1; 1372: my $tries = 1; 1373: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 1374: $reply = &get_query_reply($queryid); 1375: $tries ++; 1376: } 1377: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 1378: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries); 1379: } else { 1380: my @matches; 1381: if ($reply =~ /\n/) { 1382: @matches = split(/\n/,$reply); 1383: } else { 1384: @matches = split(/\&/,$reply); 1385: } 1386: foreach my $match (@matches) { 1387: my ($uname,$udom,%userhash); 1388: foreach my $entry (split(/:/,$match)) { 1389: my ($key,$value) = 1390: map {&unescape($_);} split(/=/,$entry); 1391: $userhash{$key} = $value; 1392: if ($key eq 'username') { 1393: $uname = $value; 1394: } elsif ($key eq 'domain') { 1395: $udom = $value; 1396: } 1397: } 1398: $results{$uname.':'.$udom} = \%userhash; 1399: } 1400: } 1401: } 1402: } 1403: return %results; 1404: } 1405: 1406: sub get_instuser { 1407: my ($udom,$uname,$id) = @_; 1408: my $homeserver = &domain($udom,'primary'); 1409: my ($outcome,%results); 1410: if ($homeserver ne '') { 1411: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'. 1412: &escape($id).':'.&escape($udom),$homeserver); 1413: my $host=&hostname($homeserver); 1414: if ($queryid !~/^\Q$host\E\_/) { 1415: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1416: return; 1417: } 1418: my $response = &get_query_reply($queryid); 1419: my $maxtries = 5; 1420: my $tries = 1; 1421: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1422: $response = &get_query_reply($queryid); 1423: $tries ++; 1424: } 1425: if (!&error($response) && $response ne 'refused') { 1426: if ($response eq 'unavailable') { 1427: $outcome = $response; 1428: } else { 1429: $outcome = 'ok'; 1430: my @matches = split(/\n/,$response); 1431: foreach my $match (@matches) { 1432: my ($key,$value) = split(/=/,$match); 1433: $results{&unescape($key)} = &thaw_unescape($value); 1434: } 1435: } 1436: } 1437: } 1438: my %userinfo; 1439: if (ref($results{$uname}) eq 'HASH') { 1440: %userinfo = %{$results{$uname}}; 1441: } 1442: return ($outcome,%userinfo); 1443: } 1444: 1445: sub inst_rulecheck { 1446: my ($udom,$uname,$id,$item,$rules) = @_; 1447: my %returnhash; 1448: if ($udom ne '') { 1449: if (ref($rules) eq 'ARRAY') { 1450: @{$rules} = map {&escape($_);} (@{$rules}); 1451: my $rulestr = join(':',@{$rules}); 1452: my $homeserver=&domain($udom,'primary'); 1453: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1454: my $response; 1455: if ($item eq 'username') { 1456: $response=&unescape(&reply('instrulecheck:'.&escape($udom). 1457: ':'.&escape($uname).':'.$rulestr, 1458: $homeserver)); 1459: } elsif ($item eq 'id') { 1460: $response=&unescape(&reply('instidrulecheck:'.&escape($udom). 1461: ':'.&escape($id).':'.$rulestr, 1462: $homeserver)); 1463: } elsif ($item eq 'selfcreate') { 1464: $response=&unescape(&reply('instselfcreatecheck:'. 1465: &escape($udom).':'.&escape($uname). 1466: ':'.$rulestr,$homeserver)); 1467: } 1468: if ($response ne 'refused') { 1469: my @pairs=split(/\&/,$response); 1470: foreach my $item (@pairs) { 1471: my ($key,$value)=split(/=/,$item,2); 1472: $key = &unescape($key); 1473: next if ($key =~ /^error: 2 /); 1474: $returnhash{$key}=&thaw_unescape($value); 1475: } 1476: } 1477: } 1478: } 1479: } 1480: return %returnhash; 1481: } 1482: 1483: sub inst_userrules { 1484: my ($udom,$check) = @_; 1485: my (%ruleshash,@ruleorder); 1486: if ($udom ne '') { 1487: my $homeserver=&domain($udom,'primary'); 1488: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1489: my $response; 1490: if ($check eq 'id') { 1491: $response=&reply('instidrules:'.&escape($udom), 1492: $homeserver); 1493: } elsif ($check eq 'email') { 1494: $response=&reply('instemailrules:'.&escape($udom), 1495: $homeserver); 1496: } else { 1497: $response=&reply('instuserrules:'.&escape($udom), 1498: $homeserver); 1499: } 1500: if (($response ne 'refused') && ($response ne 'error') && 1501: ($response ne 'unknown_cmd') && 1502: ($response ne 'no_such_host')) { 1503: my ($hashitems,$orderitems) = split(/:/,$response); 1504: my @pairs=split(/\&/,$hashitems); 1505: foreach my $item (@pairs) { 1506: my ($key,$value)=split(/=/,$item,2); 1507: $key = &unescape($key); 1508: next if ($key =~ /^error: 2 /); 1509: $ruleshash{$key}=&thaw_unescape($value); 1510: } 1511: my @esc_order = split(/\&/,$orderitems); 1512: foreach my $item (@esc_order) { 1513: push(@ruleorder,&unescape($item)); 1514: } 1515: } 1516: } 1517: } 1518: return (\%ruleshash,\@ruleorder); 1519: } 1520: 1521: # ------------- Get Authentication, Language and User Tools Defaults for Domain 1522: 1523: sub get_domain_defaults { 1524: my ($domain) = @_; 1525: my $cachetime = 60*60*24; 1526: my ($result,$cached)=&is_cached_new('domdefaults',$domain); 1527: if (defined($cached)) { 1528: if (ref($result) eq 'HASH') { 1529: return %{$result}; 1530: } 1531: } 1532: my %domdefaults; 1533: my %domconfig = 1534: &Apache::lonnet::get_dom('configuration',['defaults','quotas', 1535: 'requestcourses','inststatus', 1536: 'coursedefaults','usersessions'],$domain); 1537: if (ref($domconfig{'defaults'}) eq 'HASH') { 1538: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 1539: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'}; 1540: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'}; 1541: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'}; 1542: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'}; 1543: } else { 1544: $domdefaults{'lang_def'} = &domain($domain,'lang_def'); 1545: $domdefaults{'auth_def'} = &domain($domain,'auth_def'); 1546: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def'); 1547: } 1548: if (ref($domconfig{'quotas'}) eq 'HASH') { 1549: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') { 1550: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'}; 1551: } else { 1552: $domdefaults{'defaultquota'} = $domconfig{'quotas'}; 1553: } 1554: my @usertools = ('aboutme','blog','portfolio'); 1555: foreach my $item (@usertools) { 1556: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') { 1557: $domdefaults{$item} = $domconfig{'quotas'}{$item}; 1558: } 1559: } 1560: } 1561: if (ref($domconfig{'requestcourses'}) eq 'HASH') { 1562: foreach my $item ('official','unofficial','community') { 1563: $domdefaults{$item} = $domconfig{'requestcourses'}{$item}; 1564: } 1565: } 1566: if (ref($domconfig{'inststatus'}) eq 'HASH') { 1567: foreach my $item ('inststatustypes','inststatusorder') { 1568: $domdefaults{$item} = $domconfig{'inststatus'}{$item}; 1569: } 1570: } 1571: if (ref($domconfig{'coursedefaults'}) eq 'HASH') { 1572: foreach my $item ('canuse_pdfforms') { 1573: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item}; 1574: } 1575: } 1576: if (ref($domconfig{'usersessions'}) eq 'HASH') { 1577: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') { 1578: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'}; 1579: } 1580: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') { 1581: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'}; 1582: } 1583: } 1584: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults, 1585: $cachetime); 1586: return %domdefaults; 1587: } 1588: 1589: # --------------------------------------------------- Assign a key to a student 1590: 1591: sub assign_access_key { 1592: # 1593: # a valid key looks like uname:udom#comments 1594: # comments are being appended 1595: # 1596: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_; 1597: $kdom= 1598: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom)); 1599: $knum= 1600: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum)); 1601: $cdom= 1602: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1603: $cnum= 1604: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1605: $udom=$env{'user.name'} unless (defined($udom)); 1606: $uname=$env{'user.domain'} unless (defined($uname)); 1607: my %existing=&get('accesskeys',[$ckey],$kdom,$knum); 1608: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key 1609: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 1610: # assigned to this person 1611: # - this should not happen, 1612: # unless something went wrong 1613: # the first time around 1614: # ready to assign 1615: $logentry=$1.'; '.$logentry; 1616: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry}, 1617: $kdom,$knum) eq 'ok') { 1618: # key now belongs to user 1619: my $envkey='key.'.$cdom.'_'.$cnum; 1620: if (&put('environment',{$envkey => $ckey}) eq 'ok') { 1621: &appenv({'environment.'.$envkey => $ckey}); 1622: return 'ok'; 1623: } else { 1624: return 1625: 'error: Count not permanently assign key, will need to be re-entered later.'; 1626: } 1627: } else { 1628: return 'error: Could not assign key, try again later.'; 1629: } 1630: } elsif (!$existing{$ckey}) { 1631: # the key does not exist 1632: return 'error: The key does not exist'; 1633: } else { 1634: # the key is somebody else's 1635: return 'error: The key is already in use'; 1636: } 1637: } 1638: 1639: # ------------------------------------------ put an additional comment on a key 1640: 1641: sub comment_access_key { 1642: # 1643: # a valid key looks like uname:udom#comments 1644: # comments are being appended 1645: # 1646: my ($ckey,$cdom,$cnum,$logentry)=@_; 1647: $cdom= 1648: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1649: $cnum= 1650: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1651: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1652: if ($existing{$ckey}) { 1653: $existing{$ckey}.='; '.$logentry; 1654: # ready to assign 1655: if (&put('accesskeys',{$ckey=>$existing{$ckey}}, 1656: $cdom,$cnum) eq 'ok') { 1657: return 'ok'; 1658: } else { 1659: return 'error: Count not store comment.'; 1660: } 1661: } else { 1662: # the key does not exist 1663: return 'error: The key does not exist'; 1664: } 1665: } 1666: 1667: # ------------------------------------------------------ Generate a set of keys 1668: 1669: sub generate_access_keys { 1670: my ($number,$cdom,$cnum,$logentry)=@_; 1671: $cdom= 1672: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1673: $cnum= 1674: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1675: unless (&allowed('mky',$cdom)) { return 0; } 1676: unless (($cdom) && ($cnum)) { return 0; } 1677: if ($number>10000) { return 0; } 1678: sleep(2); # make sure don't get same seed twice 1679: srand(time()^($$+($$<<15))); # from "Programming Perl" 1680: my $total=0; 1681: for (my $i=1;$i<=$number;$i++) { 1682: my $newkey=sprintf("%lx",int(100000*rand)).'-'. 1683: sprintf("%lx",int(100000*rand)).'-'. 1684: sprintf("%lx",int(100000*rand)); 1685: $newkey=~s/1/g/g; # folks mix up 1 and l 1686: $newkey=~s/0/h/g; # and also 0 and O 1687: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum); 1688: if ($existing{$newkey}) { 1689: $i--; 1690: } else { 1691: if (&put('accesskeys', 1692: { $newkey => '# generated '.localtime(). 1693: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}. 1694: '; '.$logentry }, 1695: $cdom,$cnum) eq 'ok') { 1696: $total++; 1697: } 1698: } 1699: } 1700: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 1701: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom); 1702: return $total; 1703: } 1704: 1705: # ------------------------------------------------------- Validate an accesskey 1706: 1707: sub validate_access_key { 1708: my ($ckey,$cdom,$cnum,$udom,$uname)=@_; 1709: $cdom= 1710: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1711: $cnum= 1712: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1713: $udom=$env{'user.domain'} unless (defined($udom)); 1714: $uname=$env{'user.name'} unless (defined($uname)); 1715: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1716: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/); 1717: } 1718: 1719: # ------------------------------------- Find the section of student in a course 1720: sub devalidate_getsection_cache { 1721: my ($udom,$unam,$courseid)=@_; 1722: my $hashid="$udom:$unam:$courseid"; 1723: &devalidate_cache_new('getsection',$hashid); 1724: } 1725: 1726: sub courseid_to_courseurl { 1727: my ($courseid) = @_; 1728: #already url style courseid 1729: return $courseid if ($courseid =~ m{^/}); 1730: 1731: if (exists($env{'course.'.$courseid.'.num'})) { 1732: my $cnum = $env{'course.'.$courseid.'.num'}; 1733: my $cdom = $env{'course.'.$courseid.'.domain'}; 1734: return "/$cdom/$cnum"; 1735: } 1736: 1737: my %courseinfo=&Apache::lonnet::coursedescription($courseid); 1738: if (exists($courseinfo{'num'})) { 1739: return "/$courseinfo{'domain'}/$courseinfo{'num'}"; 1740: } 1741: 1742: return undef; 1743: } 1744: 1745: sub getsection { 1746: my ($udom,$unam,$courseid)=@_; 1747: my $cachetime=1800; 1748: 1749: my $hashid="$udom:$unam:$courseid"; 1750: my ($result,$cached)=&is_cached_new('getsection',$hashid); 1751: if (defined($cached)) { return $result; } 1752: 1753: my %Pending; 1754: my %Expired; 1755: # 1756: # Each role can either have not started yet (pending), be active, 1757: # or have expired. 1758: # 1759: # If there is an active role, we are done. 1760: # 1761: # If there is more than one role which has not started yet, 1762: # choose the one which will start sooner 1763: # If there is one role which has not started yet, return it. 1764: # 1765: # If there is more than one expired role, choose the one which ended last. 1766: # If there is a role which has expired, return it. 1767: # 1768: $courseid = &courseid_to_courseurl($courseid); 1769: my $extra = &freeze_escape({'skipcheck' => 1}); 1770: my %roleshash = &dump('roles',$udom,$unam,$courseid,undef,$extra); 1771: foreach my $key (keys(%roleshash)) { 1772: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/); 1773: my $section=$1; 1774: if ($key eq $courseid.'_st') { $section=''; } 1775: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key})); 1776: my $now=time; 1777: if (defined($end) && $end && ($now > $end)) { 1778: $Expired{$end}=$section; 1779: next; 1780: } 1781: if (defined($start) && $start && ($now < $start)) { 1782: $Pending{$start}=$section; 1783: next; 1784: } 1785: return &do_cache_new('getsection',$hashid,$section,$cachetime); 1786: } 1787: # 1788: # Presumedly there will be few matching roles from the above 1789: # loop and the sorting time will be negligible. 1790: if (scalar(keys(%Pending))) { 1791: my ($time) = sort {$a <=> $b} keys(%Pending); 1792: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime); 1793: } 1794: if (scalar(keys(%Expired))) { 1795: my @sorted = sort {$a <=> $b} keys(%Expired); 1796: my $time = pop(@sorted); 1797: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime); 1798: } 1799: return &do_cache_new('getsection',$hashid,'-1',$cachetime); 1800: } 1801: 1802: sub save_cache { 1803: &purge_remembered(); 1804: #&Apache::loncommon::validate_page(); 1805: undef(%env); 1806: undef($env_loaded); 1807: } 1808: 1809: my $to_remember=-1; 1810: my %remembered; 1811: my %accessed; 1812: my $kicks=0; 1813: my $hits=0; 1814: sub make_key { 1815: my ($name,$id) = @_; 1816: if (length($id) > 65 1817: && length(&escape($id)) > 200) { 1818: $id=length($id).':'.&Digest::MD5::md5_hex($id); 1819: } 1820: return &escape($name.':'.$id); 1821: } 1822: 1823: sub devalidate_cache_new { 1824: my ($name,$id,$debug) = @_; 1825: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); } 1826: $id=&make_key($name,$id); 1827: $memcache->delete($id); 1828: delete($remembered{$id}); 1829: delete($accessed{$id}); 1830: } 1831: 1832: sub is_cached_new { 1833: my ($name,$id,$debug) = @_; 1834: $id=&make_key($name,$id); 1835: if (exists($remembered{$id})) { 1836: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); } 1837: $accessed{$id}=[&gettimeofday()]; 1838: $hits++; 1839: return ($remembered{$id},1); 1840: } 1841: my $value = $memcache->get($id); 1842: if (!(defined($value))) { 1843: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); } 1844: return (undef,undef); 1845: } 1846: if ($value eq '__undef__') { 1847: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); } 1848: $value=undef; 1849: } 1850: &make_room($id,$value,$debug); 1851: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); } 1852: return ($value,1); 1853: } 1854: 1855: sub do_cache_new { 1856: my ($name,$id,$value,$time,$debug) = @_; 1857: $id=&make_key($name,$id); 1858: my $setvalue=$value; 1859: if (!defined($setvalue)) { 1860: $setvalue='__undef__'; 1861: } 1862: if (!defined($time) ) { 1863: $time=600; 1864: } 1865: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); } 1866: my $result = $memcache->set($id,$setvalue,$time); 1867: if (! $result) { 1868: &logthis("caching of id -> $id failed"); 1869: $memcache->disconnect_all(); 1870: } 1871: # need to make a copy of $value 1872: &make_room($id,$value,$debug); 1873: return $value; 1874: } 1875: 1876: sub make_room { 1877: my ($id,$value,$debug)=@_; 1878: 1879: $remembered{$id}= (ref($value)) ? &Storable::dclone($value) 1880: : $value; 1881: if ($to_remember<0) { return; } 1882: $accessed{$id}=[&gettimeofday()]; 1883: if (scalar(keys(%remembered)) <= $to_remember) { return; } 1884: my $to_kick; 1885: my $max_time=0; 1886: foreach my $other (keys(%accessed)) { 1887: if (&tv_interval($accessed{$other}) > $max_time) { 1888: $to_kick=$other; 1889: $max_time=&tv_interval($accessed{$other}); 1890: } 1891: } 1892: delete($remembered{$to_kick}); 1893: delete($accessed{$to_kick}); 1894: $kicks++; 1895: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); } 1896: return; 1897: } 1898: 1899: sub purge_remembered { 1900: #&logthis("Tossing ".scalar(keys(%remembered))); 1901: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered)))); 1902: undef(%remembered); 1903: undef(%accessed); 1904: } 1905: # ------------------------------------- Read an entry from a user's environment 1906: 1907: sub userenvironment { 1908: my ($udom,$unam,@what)=@_; 1909: my $items; 1910: foreach my $item (@what) { 1911: $items.=&escape($item).'&'; 1912: } 1913: $items=~s/\&$//; 1914: my %returnhash=(); 1915: my $uhome = &homeserver($unam,$udom); 1916: unless ($uhome eq 'no_host') { 1917: my @answer=split(/\&/, 1918: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome)); 1919: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) { 1920: return %returnhash; 1921: } 1922: my $i; 1923: for ($i=0;$i<=$#what;$i++) { 1924: $returnhash{$what[$i]}=&unescape($answer[$i]); 1925: } 1926: } 1927: return %returnhash; 1928: } 1929: 1930: # ---------------------------------------------------------- Get a studentphoto 1931: sub studentphoto { 1932: my ($udom,$unam,$ext) = @_; 1933: my $home=&Apache::lonnet::homeserver($unam,$udom); 1934: if (defined($env{'request.course.id'})) { 1935: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) { 1936: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) { 1937: return(&retrievestudentphoto($udom,$unam,$ext)); 1938: } else { 1939: my ($result,$perm_reqd)= 1940: &Apache::lonnet::auto_photo_permission($unam,$udom); 1941: if ($result eq 'ok') { 1942: if (!($perm_reqd eq 'yes')) { 1943: return(&retrievestudentphoto($udom,$unam,$ext)); 1944: } 1945: } 1946: } 1947: } 1948: } else { 1949: my ($result,$perm_reqd) = 1950: &Apache::lonnet::auto_photo_permission($unam,$udom); 1951: if ($result eq 'ok') { 1952: if (!($perm_reqd eq 'yes')) { 1953: return(&retrievestudentphoto($udom,$unam,$ext)); 1954: } 1955: } 1956: } 1957: return '/adm/lonKaputt/lonlogo_broken.gif'; 1958: } 1959: 1960: sub retrievestudentphoto { 1961: my ($udom,$unam,$ext,$type) = @_; 1962: my $home=&Apache::lonnet::homeserver($unam,$udom); 1963: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home); 1964: if ($ret eq 'ok') { 1965: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext"; 1966: if ($type eq 'thumbnail') { 1967: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 1968: } 1969: my $tokenurl=&Apache::lonnet::tokenwrapper($url); 1970: return $tokenurl; 1971: } else { 1972: if ($type eq 'thumbnail') { 1973: return '/adm/lonKaputt/genericstudent_tn.gif'; 1974: } else { 1975: return '/adm/lonKaputt/lonlogo_broken.gif'; 1976: } 1977: } 1978: } 1979: 1980: # -------------------------------------------------------------------- New chat 1981: 1982: sub chatsend { 1983: my ($newentry,$anon,$group)=@_; 1984: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'}; 1985: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 1986: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'}; 1987: &reply('chatsend:'.$cdom.':'.$cnum.':'. 1988: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'. 1989: &escape($newentry)).':'.$group,$chome); 1990: } 1991: 1992: # ------------------------------------------ Find current version of a resource 1993: 1994: sub getversion { 1995: my $fname=&clutter(shift); 1996: unless ($fname=~/^\/res\//) { return -1; } 1997: return ¤tversion(&filelocation('',$fname)); 1998: } 1999: 2000: sub currentversion { 2001: my $fname=shift; 2002: my ($result,$cached)=&is_cached_new('resversion',$fname); 2003: if (defined($cached)) { return $result; } 2004: my $author=$fname; 2005: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 2006: my ($udom,$uname)=split(/\//,$author); 2007: my $home=homeserver($uname,$udom); 2008: if ($home eq 'no_host') { 2009: return -1; 2010: } 2011: my $answer=reply("currentversion:$fname",$home); 2012: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 2013: return -1; 2014: } 2015: return &do_cache_new('resversion',$fname,$answer,600); 2016: } 2017: 2018: # ----------------------------- Subscribe to a resource, return URL if possible 2019: 2020: sub subscribe { 2021: my $fname=shift; 2022: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; } 2023: $fname=~s/[\n\r]//g; 2024: my $author=$fname; 2025: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 2026: my ($udom,$uname)=split(/\//,$author); 2027: my $home=homeserver($uname,$udom); 2028: if ($home eq 'no_host') { 2029: return 'not_found'; 2030: } 2031: my $answer=reply("sub:$fname",$home); 2032: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 2033: $answer.=' by '.$home; 2034: } 2035: return $answer; 2036: } 2037: 2038: # -------------------------------------------------------------- Replicate file 2039: 2040: sub repcopy { 2041: my $filename=shift; 2042: $filename=~s/\/+/\//g; 2043: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; } 2044: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 2045: if ($filename=~m|^/home/httpd/html/userfiles/| or 2046: $filename=~m -^/*(uploaded|editupload)/-) { 2047: return &repcopy_userfile($filename); 2048: } 2049: $filename=~s/[\n\r]//g; 2050: my $transname="$filename.in.transfer"; 2051: # FIXME: this should flock 2052: if ((-e $filename) || (-e $transname)) { return 'ok'; } 2053: my $remoteurl=subscribe($filename); 2054: if ($remoteurl =~ /^con_lost by/) { 2055: &logthis("Subscribe returned $remoteurl: $filename"); 2056: return 'unavailable'; 2057: } elsif ($remoteurl eq 'not_found') { 2058: #&logthis("Subscribe returned not_found: $filename"); 2059: return 'not_found'; 2060: } elsif ($remoteurl =~ /^rejected by/) { 2061: &logthis("Subscribe returned $remoteurl: $filename"); 2062: return 'forbidden'; 2063: } elsif ($remoteurl eq 'directory') { 2064: return 'ok'; 2065: } else { 2066: my $author=$filename; 2067: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 2068: my ($udom,$uname)=split(/\//,$author); 2069: my $home=homeserver($uname,$udom); 2070: unless ($home eq $perlvar{'lonHostID'}) { 2071: my @parts=split(/\//,$filename); 2072: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]"; 2073: if ($path ne "$perlvar{'lonDocRoot'}/res") { 2074: &logthis("Malconfiguration for replication: $filename"); 2075: return 'bad_request'; 2076: } 2077: my $count; 2078: for ($count=5;$count<$#parts;$count++) { 2079: $path.="/$parts[$count]"; 2080: if ((-e $path)!=1) { 2081: mkdir($path,0777); 2082: } 2083: } 2084: my $ua=new LWP::UserAgent; 2085: my $request=new HTTP::Request('GET',"$remoteurl"); 2086: my $response=$ua->request($request,$transname); 2087: if ($response->is_error()) { 2088: unlink($transname); 2089: my $message=$response->status_line; 2090: &logthis("<font color=\"blue\">WARNING:" 2091: ." LWP get: $message: $filename</font>"); 2092: return 'unavailable'; 2093: } else { 2094: if ($remoteurl!~/\.meta$/) { 2095: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta'); 2096: my $mresponse=$ua->request($mrequest,$filename.'.meta'); 2097: if ($mresponse->is_error()) { 2098: unlink($filename.'.meta'); 2099: &logthis( 2100: "<font color=\"yellow\">INFO: No metadata: $filename</font>"); 2101: } 2102: } 2103: rename($transname,$filename); 2104: return 'ok'; 2105: } 2106: } 2107: } 2108: } 2109: 2110: # ------------------------------------------------ Get server side include body 2111: sub ssi_body { 2112: my ($filelink,%form)=@_; 2113: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) { 2114: $form{'LONCAPA_INTERNAL_no_discussion'}='true'; 2115: } 2116: my $output=''; 2117: my $response; 2118: if ($filelink=~/^https?\:/) { 2119: ($output,$response)=&externalssi($filelink); 2120: } else { 2121: $filelink .= $filelink=~/\?/ ? '&' : '?'; 2122: $filelink .= 'inhibitmenu=yes'; 2123: ($output,$response)=&ssi($filelink,%form); 2124: } 2125: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs; 2126: $output=~s/^.*?\<body[^\>]*\>//si; 2127: $output=~s/\<\/body\s*\>.*?$//si; 2128: if (wantarray) { 2129: return ($output, $response); 2130: } else { 2131: return $output; 2132: } 2133: } 2134: 2135: # --------------------------------------------------------- Server Side Include 2136: 2137: sub absolute_url { 2138: my ($host_name) = @_; 2139: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://'); 2140: if ($host_name eq '') { 2141: $host_name = $ENV{'SERVER_NAME'}; 2142: } 2143: return $protocol.$host_name; 2144: } 2145: 2146: # 2147: # Server side include. 2148: # Parameters: 2149: # fn Possibly encrypted resource name/id. 2150: # form Hash that describes how the rendering should be done 2151: # and other things. 2152: # Returns: 2153: # Scalar context: The content of the response. 2154: # Array context: 2 element list of the content and the full response object. 2155: # 2156: sub ssi { 2157: 2158: my ($fn,%form)=@_; 2159: my $ua=new LWP::UserAgent; 2160: my $request; 2161: 2162: $form{'no_update_last_known'}=1; 2163: &Apache::lonenc::check_encrypt(\$fn); 2164: if (%form) { 2165: $request=new HTTP::Request('POST',&absolute_url().$fn); 2166: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form))); 2167: } else { 2168: $request=new HTTP::Request('GET',&absolute_url().$fn); 2169: } 2170: 2171: $request->header(Cookie => $ENV{'HTTP_COOKIE'}); 2172: my $response=$ua->request($request); 2173: 2174: if (wantarray) { 2175: return ($response->content, $response); 2176: } else { 2177: return $response->content; 2178: } 2179: } 2180: 2181: sub externalssi { 2182: my ($url)=@_; 2183: my $ua=new LWP::UserAgent; 2184: my $request=new HTTP::Request('GET',$url); 2185: my $response=$ua->request($request); 2186: if (wantarray) { 2187: return ($response->content, $response); 2188: } else { 2189: return $response->content; 2190: } 2191: } 2192: 2193: # -------------------------------- Allow a /uploaded/ URI to be vouched for 2194: 2195: sub allowuploaded { 2196: my ($srcurl,$url)=@_; 2197: $url=&clutter(&declutter($url)); 2198: my $dir=$url; 2199: $dir=~s/\/[^\/]+$//; 2200: my %httpref=(); 2201: my $httpurl=&hreflocation('',$url); 2202: $httpref{'httpref.'.$httpurl}=$srcurl; 2203: &Apache::lonnet::appenv(\%httpref); 2204: } 2205: 2206: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course 2207: # input: action, courseID, current domain, intended 2208: # path to file, source of file, instruction to parse file for objects, 2209: # ref to hash for embedded objects, 2210: # ref to hash for codebase of java objects. 2211: # reference to scalar to accommodate mime type determined 2212: # from File::MMagic if $parser = parse. 2213: # 2214: # output: url to file (if action was uploaddoc), 2215: # ok if successful, or diagnostic message otherwise (if action was propagate or copy) 2216: # 2217: # Allows directory structure to be used within lonUsers/../userfiles/ for a 2218: # course. 2219: # 2220: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2221: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in 2222: # course's home server. 2223: # 2224: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will 2225: # be copied from $source (current location) to 2226: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2227: # and will then be copied to 2228: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in 2229: # course's home server. 2230: # 2231: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2232: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to 2233: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2234: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file 2235: # in course's home server. 2236: # 2237: 2238: sub process_coursefile { 2239: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase, 2240: $mimetype)=@_; 2241: my $fetchresult; 2242: my $home=&homeserver($docuname,$docudom); 2243: if ($action eq 'propagate') { 2244: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2245: $home); 2246: } else { 2247: my $fpath = ''; 2248: my $fname = $file; 2249: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2250: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2251: my $filepath = &build_filepath($fpath); 2252: if ($action eq 'copy') { 2253: if ($source eq '') { 2254: $fetchresult = 'no source file'; 2255: return $fetchresult; 2256: } else { 2257: my $destination = $filepath.'/'.$fname; 2258: rename($source,$destination); 2259: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2260: $home); 2261: } 2262: } elsif ($action eq 'uploaddoc') { 2263: open(my $fh,'>'.$filepath.'/'.$fname); 2264: print $fh $env{'form.'.$source}; 2265: close($fh); 2266: if ($parser eq 'parse') { 2267: my $mm = new File::MMagic; 2268: my $type = $mm->checktype_filename($filepath.'/'.$fname); 2269: if ($type eq 'text/html') { 2270: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase); 2271: unless ($parse_result eq 'ok') { 2272: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result); 2273: } 2274: } 2275: if (ref($mimetype)) { 2276: $$mimetype = $type; 2277: } 2278: } 2279: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2280: $home); 2281: if ($fetchresult eq 'ok') { 2282: return '/uploaded/'.$fpath.'/'.$fname; 2283: } else { 2284: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2285: ' to host '.$home.': '.$fetchresult); 2286: return '/adm/notfound.html'; 2287: } 2288: } 2289: } 2290: unless ( $fetchresult eq 'ok') { 2291: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2292: ' to host '.$home.': '.$fetchresult); 2293: } 2294: return $fetchresult; 2295: } 2296: 2297: sub build_filepath { 2298: my ($fpath) = @_; 2299: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles'; 2300: unless ($fpath eq '') { 2301: my @parts=split('/',$fpath); 2302: foreach my $part (@parts) { 2303: $filepath.= '/'.$part; 2304: if ((-e $filepath)!=1) { 2305: mkdir($filepath,0777); 2306: } 2307: } 2308: } 2309: return $filepath; 2310: } 2311: 2312: sub store_edited_file { 2313: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_; 2314: my $file = $primary_url; 2315: $file =~ s#^/uploaded/$docudom/$docuname/##; 2316: my $fpath = ''; 2317: my $fname = $file; 2318: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2319: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2320: my $filepath = &build_filepath($fpath); 2321: open(my $fh,'>'.$filepath.'/'.$fname); 2322: print $fh $content; 2323: close($fh); 2324: my $home=&homeserver($docuname,$docudom); 2325: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2326: $home); 2327: if ($$fetchresult eq 'ok') { 2328: return '/uploaded/'.$fpath.'/'.$fname; 2329: } else { 2330: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2331: ' to host '.$home.': '.$$fetchresult); 2332: return '/adm/notfound.html'; 2333: } 2334: } 2335: 2336: sub clean_filename { 2337: my ($fname,$args)=@_; 2338: # Replace Windows backslashes by forward slashes 2339: $fname=~s/\\/\//g; 2340: if (!$args->{'keep_path'}) { 2341: # Get rid of everything but the actual filename 2342: $fname=~s/^.*\/([^\/]+)$/$1/; 2343: } 2344: # Replace spaces by underscores 2345: $fname=~s/\s+/\_/g; 2346: # Replace all other weird characters by nothing 2347: $fname=~s{[^/\w\.\-]}{}g; 2348: # Replace all .\d. sequences with _\d. so they no longer look like version 2349: # numbers 2350: $fname=~s/\.(\d+)(?=\.)/_$1/g; 2351: return $fname; 2352: } 2353: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 2354: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 2355: # image with the same aspect ratio as the original, but with dimensions which do 2356: # not exceed $resizewidth and $resizeheight. 2357: 2358: sub resizeImage { 2359: my ($img_path,$resizewidth,$resizeheight) = @_; 2360: my $ima = Image::Magick->new; 2361: my $resized; 2362: if (-e $img_path) { 2363: $ima->Read($img_path); 2364: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) { 2365: my $width = $ima->Get('width'); 2366: my $height = $ima->Get('height'); 2367: if ($width > $resizewidth) { 2368: my $factor = $width/$resizewidth; 2369: my $newheight = $height/$factor; 2370: $ima->Scale(width=>$resizewidth,height=>$newheight); 2371: $resized = 1; 2372: } 2373: } 2374: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) { 2375: my $width = $ima->Get('width'); 2376: my $height = $ima->Get('height'); 2377: if ($height > $resizeheight) { 2378: my $factor = $height/$resizeheight; 2379: my $newwidth = $width/$factor; 2380: $ima->Scale(width=>$newwidth,height=>$resizeheight); 2381: $resized = 1; 2382: } 2383: } 2384: if ($resized) { 2385: $ima->Write($img_path); 2386: } 2387: } 2388: return; 2389: } 2390: 2391: # --------------- Take an uploaded file and put it into the userfiles directory 2392: # input: $formname - the contents of the file are in $env{"form.$formname"} 2393: # the desired filename is in $env{"form.$formname.filename"} 2394: # $context - possible values: coursedoc, existingfile, overwrite, 2395: # canceloverwrite, or ''. 2396: # if 'coursedoc': upload to the current course 2397: # if 'existingfile': write file to tmp/overwrites directory 2398: # if 'canceloverwrite': delete file written to tmp/overwrites directory 2399: # $context is passed as argument to &finishuserfileupload 2400: # $subdir - directory in userfile to store the file into 2401: # $parser - instruction to parse file for objects ($parser = parse) 2402: # $allfiles - reference to hash for embedded objects 2403: # $codebase - reference to hash for codebase of java objects 2404: # $desuname - username for permanent storage of uploaded file 2405: # $dsetudom - domain for permanaent storage of uploaded file 2406: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image 2407: # $thumbheight - height (pixels) of thumbnail to make for uploaded image 2408: # $resizewidth - width (pixels) to which to resize uploaded image 2409: # $resizeheight - height (pixels) to which to resize uploaded image 2410: # $mimetype - reference to scalar to accommodate mime type determined 2411: # from File::MMagic if $parser = parse. 2412: # 2413: # output: url of file in userspace, or error: <message> 2414: # or /adm/notfound.html if failure to upload occurse 2415: 2416: sub userfileupload { 2417: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname, 2418: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_; 2419: if (!defined($subdir)) { $subdir='unknown'; } 2420: my $fname=$env{'form.'.$formname.'.filename'}; 2421: $fname=&clean_filename($fname); 2422: # See if there is anything left 2423: unless ($fname) { return 'error: no uploaded file'; } 2424: # Files uploaded to help request form, or uploaded to "create course" page are handled differently 2425: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) || 2426: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) || 2427: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) { 2428: my $now = time; 2429: my $filepath; 2430: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { 2431: $filepath = 'tmp/helprequests/'.$now; 2432: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { 2433: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}. 2434: '_'.$env{'user.domain'}.'/pending'; 2435: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) { 2436: my ($docuname,$docudom); 2437: if ($destudom) { 2438: $docudom = $destudom; 2439: } else { 2440: $docudom = $env{'user.domain'}; 2441: } 2442: if ($destuname) { 2443: $docuname = $destuname; 2444: } else { 2445: $docuname = $env{'user.name'}; 2446: } 2447: if (exists($env{'form.group'})) { 2448: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2449: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2450: } 2451: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir; 2452: if ($context eq 'canceloverwrite') { 2453: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname; 2454: if (-e $tempfile) { 2455: my @info = stat($tempfile); 2456: if ($info[9] eq $env{'form.timestamp'}) { 2457: unlink($tempfile); 2458: } 2459: } 2460: return; 2461: } 2462: } 2463: # Create the directory if not present 2464: my @parts=split(/\//,$filepath); 2465: my $fullpath = $perlvar{'lonDaemons'}; 2466: for (my $i=0;$i<@parts;$i++) { 2467: $fullpath .= '/'.$parts[$i]; 2468: if ((-e $fullpath)!=1) { 2469: mkdir($fullpath,0777); 2470: } 2471: } 2472: open(my $fh,'>'.$fullpath.'/'.$fname); 2473: print $fh $env{'form.'.$formname}; 2474: close($fh); 2475: if ($context eq 'existingfile') { 2476: my @info = stat($fullpath.'/'.$fname); 2477: return ($fullpath.'/'.$fname,$info[9]); 2478: } else { 2479: return $fullpath.'/'.$fname; 2480: } 2481: } 2482: if ($subdir eq 'scantron') { 2483: $fname = 'scantron_orig_'.$fname; 2484: } else { 2485: $fname="$subdir/$fname"; 2486: } 2487: if ($context eq 'coursedoc') { 2488: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2489: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2490: if ($env{'form.folder'} =~ m/^(default|supplemental)/) { 2491: return &finishuserfileupload($docuname,$docudom, 2492: $formname,$fname,$parser,$allfiles, 2493: $codebase,$thumbwidth,$thumbheight, 2494: $resizewidth,$resizeheight,$context,$mimetype); 2495: } else { 2496: $fname=$env{'form.folder'}.'/'.$fname; 2497: return &process_coursefile('uploaddoc',$docuname,$docudom, 2498: $fname,$formname,$parser, 2499: $allfiles,$codebase,$mimetype); 2500: } 2501: } elsif (defined($destuname)) { 2502: my $docuname=$destuname; 2503: my $docudom=$destudom; 2504: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2505: $parser,$allfiles,$codebase, 2506: $thumbwidth,$thumbheight, 2507: $resizewidth,$resizeheight,$context,$mimetype); 2508: } else { 2509: my $docuname=$env{'user.name'}; 2510: my $docudom=$env{'user.domain'}; 2511: if (exists($env{'form.group'})) { 2512: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2513: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2514: } 2515: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2516: $parser,$allfiles,$codebase, 2517: $thumbwidth,$thumbheight, 2518: $resizewidth,$resizeheight,$context,$mimetype); 2519: } 2520: } 2521: 2522: sub finishuserfileupload { 2523: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase, 2524: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_; 2525: my $path=$docudom.'/'.$docuname.'/'; 2526: my $filepath=$perlvar{'lonDocRoot'}; 2527: 2528: my ($fnamepath,$file,$fetchthumb); 2529: $file=$fname; 2530: if ($fname=~m|/|) { 2531: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|); 2532: $path.=$fnamepath.'/'; 2533: } 2534: my @parts=split(/\//,$filepath.'/userfiles/'.$path); 2535: my $count; 2536: for ($count=4;$count<=$#parts;$count++) { 2537: $filepath.="/$parts[$count]"; 2538: if ((-e $filepath)!=1) { 2539: mkdir($filepath,0777); 2540: } 2541: } 2542: 2543: # Save the file 2544: { 2545: if (!open(FH,'>'.$filepath.'/'.$file)) { 2546: &logthis('Failed to create '.$filepath.'/'.$file); 2547: print STDERR ('Failed to create '.$filepath.'/'.$file."\n"); 2548: return '/adm/notfound.html'; 2549: } 2550: if ($context eq 'overwrite') { 2551: my $source = $perlvar{'lonDaemons'}.'/tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$fname; 2552: my $target = $filepath.'/'.$file; 2553: if (-e $source) { 2554: my @info = stat($source); 2555: if ($info[9] eq $env{'form.timestamp'}) { 2556: unless (&File::Copy::move($source,$target)) { 2557: &logthis('Failed to overwrite '.$filepath.'/'.$file); 2558: return "Moving from $source failed"; 2559: } 2560: } else { 2561: return "Temporary file: $source had unexpected date/time for last modification"; 2562: } 2563: } else { 2564: return "Temporary file: $source missing"; 2565: } 2566: } elsif (!print FH ($env{'form.'.$formname})) { 2567: &logthis('Failed to write to '.$filepath.'/'.$file); 2568: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n"); 2569: return '/adm/notfound.html'; 2570: } 2571: close(FH); 2572: if ($resizewidth && $resizeheight) { 2573: my $mm = new File::MMagic; 2574: my $mime_type = $mm->checktype_filename($filepath.'/'.$file); 2575: if ($mime_type =~ m{^image/}) { 2576: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight); 2577: } 2578: } 2579: } 2580: if ($parser eq 'parse') { 2581: my $mm = new File::MMagic; 2582: my $type = $mm->checktype_filename($filepath.'/'.$file); 2583: if ($type eq 'text/html') { 2584: my $parse_result = &extract_embedded_items($filepath.'/'.$file, 2585: $allfiles,$codebase); 2586: unless ($parse_result eq 'ok') { 2587: &logthis('Failed to parse '.$filepath.$file. 2588: ' for embedded media: '.$parse_result); 2589: } 2590: } 2591: if (ref($mimetype)) { 2592: $$mimetype = $type; 2593: } 2594: } 2595: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) { 2596: my $input = $filepath.'/'.$file; 2597: my $output = $filepath.'/'.'tn-'.$file; 2598: my $thumbsize = $thumbwidth.'x'.$thumbheight; 2599: system("convert -sample $thumbsize $input $output"); 2600: if (-e $filepath.'/'.'tn-'.$file) { 2601: $fetchthumb = 1; 2602: } 2603: } 2604: 2605: # Notify homeserver to grep it 2606: # 2607: my $docuhome=&homeserver($docuname,$docudom); 2608: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome); 2609: if ($fetchresult eq 'ok') { 2610: if ($fetchthumb) { 2611: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome); 2612: if ($thumbresult ne 'ok') { 2613: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '. 2614: $docuhome.': '.$thumbresult); 2615: } 2616: } 2617: # 2618: # Return the URL to it 2619: return '/uploaded/'.$path.$file; 2620: } else { 2621: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome. 2622: ': '.$fetchresult); 2623: return '/adm/notfound.html'; 2624: } 2625: } 2626: 2627: sub extract_embedded_items { 2628: my ($fullpath,$allfiles,$codebase,$content) = @_; 2629: my @state = (); 2630: my %javafiles = ( 2631: codebase => '', 2632: code => '', 2633: archive => '' 2634: ); 2635: my %mediafiles = ( 2636: src => '', 2637: movie => '', 2638: ); 2639: my $p; 2640: if ($content) { 2641: $p = HTML::LCParser->new($content); 2642: } else { 2643: $p = HTML::LCParser->new($fullpath); 2644: } 2645: while (my $t=$p->get_token()) { 2646: if ($t->[0] eq 'S') { 2647: my ($tagname, $attr) = ($t->[1],$t->[2]); 2648: push(@state, $tagname); 2649: if (lc($tagname) eq 'allow') { 2650: &add_filetype($allfiles,$attr->{'src'},'src'); 2651: } 2652: if (lc($tagname) eq 'img') { 2653: &add_filetype($allfiles,$attr->{'src'},'src'); 2654: } 2655: if (lc($tagname) eq 'a') { 2656: &add_filetype($allfiles,$attr->{'href'},'href'); 2657: } 2658: if (lc($tagname) eq 'script') { 2659: if ($attr->{'archive'} =~ /\.jar$/i) { 2660: &add_filetype($allfiles,$attr->{'archive'},'archive'); 2661: } else { 2662: &add_filetype($allfiles,$attr->{'src'},'src'); 2663: } 2664: } 2665: if (lc($tagname) eq 'link') { 2666: if (lc($attr->{'rel'}) eq 'stylesheet') { 2667: &add_filetype($allfiles,$attr->{'href'},'href'); 2668: } 2669: } 2670: if (lc($tagname) eq 'object' || 2671: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) { 2672: foreach my $item (keys(%javafiles)) { 2673: $javafiles{$item} = ''; 2674: } 2675: } 2676: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') { 2677: my $name = lc($attr->{'name'}); 2678: foreach my $item (keys(%javafiles)) { 2679: if ($name eq $item) { 2680: $javafiles{$item} = $attr->{'value'}; 2681: last; 2682: } 2683: } 2684: foreach my $item (keys(%mediafiles)) { 2685: if ($name eq $item) { 2686: &add_filetype($allfiles, $attr->{'value'}, 'value'); 2687: last; 2688: } 2689: } 2690: } 2691: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') { 2692: foreach my $item (keys(%javafiles)) { 2693: if ($attr->{$item}) { 2694: $javafiles{$item} = $attr->{$item}; 2695: last; 2696: } 2697: } 2698: foreach my $item (keys(%mediafiles)) { 2699: if ($attr->{$item}) { 2700: &add_filetype($allfiles,$attr->{$item},$item); 2701: last; 2702: } 2703: } 2704: } 2705: } elsif ($t->[0] eq 'E') { 2706: my ($tagname) = ($t->[1]); 2707: if ($javafiles{'codebase'} ne '') { 2708: $javafiles{'codebase'} .= '/'; 2709: } 2710: if (lc($tagname) eq 'applet' || 2711: lc($tagname) eq 'object' || 2712: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object') 2713: ) { 2714: foreach my $item (keys(%javafiles)) { 2715: if ($item ne 'codebase' && $javafiles{$item} ne '') { 2716: my $file=$javafiles{'codebase'}.$javafiles{$item}; 2717: &add_filetype($allfiles,$file,$item); 2718: } 2719: } 2720: } 2721: pop @state; 2722: } 2723: } 2724: return 'ok'; 2725: } 2726: 2727: sub add_filetype { 2728: my ($allfiles,$file,$type)=@_; 2729: if (exists($allfiles->{$file})) { 2730: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) { 2731: push(@{$allfiles->{$file}}, &escape($type)); 2732: } 2733: } else { 2734: @{$allfiles->{$file}} = (&escape($type)); 2735: } 2736: } 2737: 2738: sub removeuploadedurl { 2739: my ($url)=@_; 2740: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5); 2741: return &removeuserfile($uname,$udom,$fname); 2742: } 2743: 2744: sub removeuserfile { 2745: my ($docuname,$docudom,$fname)=@_; 2746: my $home=&homeserver($docuname,$docudom); 2747: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home); 2748: if ($result eq 'ok') { 2749: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) { 2750: my $metafile = $fname.'.meta'; 2751: my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 2752: my $url = "/uploaded/$docudom/$docuname/$fname"; 2753: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2754: my $sqlresult = 2755: &update_portfolio_table($docuname,$docudom,$file, 2756: 'portfolio_metadata',$group, 2757: 'delete'); 2758: } 2759: } 2760: return $result; 2761: } 2762: 2763: sub mkdiruserfile { 2764: my ($docuname,$docudom,$dir)=@_; 2765: my $home=&homeserver($docuname,$docudom); 2766: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home); 2767: } 2768: 2769: sub renameuserfile { 2770: my ($docuname,$docudom,$old,$new)=@_; 2771: my $home=&homeserver($docuname,$docudom); 2772: my $result = &reply("renameuserfile:$docudom:$docuname:". 2773: &escape("$old").':'.&escape("$new"),$home); 2774: if ($result eq 'ok') { 2775: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) { 2776: my $oldmeta = $old.'.meta'; 2777: my $newmeta = $new.'.meta'; 2778: my $metaresult = 2779: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta); 2780: my $url = "/uploaded/$docudom/$docuname/$old"; 2781: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2782: my $sqlresult = 2783: &update_portfolio_table($docuname,$docudom,$file, 2784: 'portfolio_metadata',$group, 2785: 'delete'); 2786: } 2787: } 2788: return $result; 2789: } 2790: 2791: # ------------------------------------------------------------------------- Log 2792: 2793: sub log { 2794: my ($dom,$nam,$hom,$what)=@_; 2795: return critical("log:$dom:$nam:$what",$hom); 2796: } 2797: 2798: # ------------------------------------------------------------------ Course Log 2799: # 2800: # This routine flushes several buffers of non-mission-critical nature 2801: # 2802: 2803: sub flushcourselogs { 2804: &logthis('Flushing log buffers'); 2805: # 2806: # course logs 2807: # This is a log of all transactions in a course, which can be used 2808: # for data mining purposes 2809: # 2810: # It also collects the courseid database, which lists last transaction 2811: # times and course titles for all courseids 2812: # 2813: my %courseidbuffer=(); 2814: foreach my $crsid (keys(%courselogs)) { 2815: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'. 2816: &escape($courselogs{$crsid}), 2817: $coursehombuf{$crsid}) eq 'ok') { 2818: delete $courselogs{$crsid}; 2819: } else { 2820: &logthis('Failed to flush log buffer for '.$crsid); 2821: if (length($courselogs{$crsid})>40000) { 2822: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid. 2823: " exceeded maximum size, deleting.</font>"); 2824: delete $courselogs{$crsid}; 2825: } 2826: } 2827: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = { 2828: 'description' => $coursedescrbuf{$crsid}, 2829: 'inst_code' => $courseinstcodebuf{$crsid}, 2830: 'type' => $coursetypebuf{$crsid}, 2831: 'owner' => $courseownerbuf{$crsid}, 2832: }; 2833: } 2834: # 2835: # Write course id database (reverse lookup) to homeserver of courses 2836: # Is used in pickcourse 2837: # 2838: foreach my $crs_home (keys(%courseidbuffer)) { 2839: my $response = &courseidput(&host_domain($crs_home), 2840: $courseidbuffer{$crs_home}, 2841: $crs_home,'timeonly'); 2842: } 2843: # 2844: # File accesses 2845: # Writes to the dynamic metadata of resources to get hit counts, etc. 2846: # 2847: foreach my $entry (keys(%accesshash)) { 2848: if ($entry =~ /___count$/) { 2849: my ($dom,$name); 2850: ($dom,$name,undef)= 2851: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$}); 2852: if (! defined($dom) || $dom eq '' || 2853: ! defined($name) || $name eq '') { 2854: my $cid = $env{'request.course.id'}; 2855: $dom = $env{'request.'.$cid.'.domain'}; 2856: $name = $env{'request.'.$cid.'.num'}; 2857: } 2858: my $value = $accesshash{$entry}; 2859: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/); 2860: my %temphash=($url => $value); 2861: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name); 2862: if ($result eq 'ok') { 2863: delete $accesshash{$entry}; 2864: } elsif ($result eq 'unknown_cmd') { 2865: # Target server has old code running on it. 2866: my %temphash=($entry => $value); 2867: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2868: delete $accesshash{$entry}; 2869: } 2870: } 2871: } else { 2872: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$}); 2873: my %temphash=($entry => $accesshash{$entry}); 2874: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2875: delete $accesshash{$entry}; 2876: } 2877: } 2878: } 2879: # 2880: # Roles 2881: # Reverse lookup of user roles for course faculty/staff and co-authorship 2882: # 2883: foreach my $entry (keys(%userrolehash)) { 2884: my ($role,$uname,$udom,$runame,$rudom,$rsec)= 2885: split(/\:/,$entry); 2886: if (&Apache::lonnet::put('nohist_userroles', 2887: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} }, 2888: $rudom,$runame) eq 'ok') { 2889: delete $userrolehash{$entry}; 2890: } 2891: } 2892: # 2893: # Reverse lookup of domain roles (dc, ad, li, sc, au) 2894: # 2895: my %domrolebuffer = (); 2896: foreach my $entry (keys(%domainrolehash)) { 2897: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry); 2898: if ($domrolebuffer{$rudom}) { 2899: $domrolebuffer{$rudom}.='&'.&escape($entry). 2900: '='.&escape($domainrolehash{$entry}); 2901: } else { 2902: $domrolebuffer{$rudom}.=&escape($entry). 2903: '='.&escape($domainrolehash{$entry}); 2904: } 2905: delete $domainrolehash{$entry}; 2906: } 2907: foreach my $dom (keys(%domrolebuffer)) { 2908: my %servers = &get_servers($dom,'library'); 2909: foreach my $tryserver (keys(%servers)) { 2910: unless (&reply('domroleput:'.$dom.':'. 2911: $domrolebuffer{$dom},$tryserver) eq 'ok') { 2912: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver); 2913: } 2914: } 2915: } 2916: $dumpcount++; 2917: } 2918: 2919: sub courselog { 2920: my $what=shift; 2921: $what=time.':'.$what; 2922: unless ($env{'request.course.id'}) { return ''; } 2923: $coursedombuf{$env{'request.course.id'}}= 2924: $env{'course.'.$env{'request.course.id'}.'.domain'}; 2925: $coursenumbuf{$env{'request.course.id'}}= 2926: $env{'course.'.$env{'request.course.id'}.'.num'}; 2927: $coursehombuf{$env{'request.course.id'}}= 2928: $env{'course.'.$env{'request.course.id'}.'.home'}; 2929: $coursedescrbuf{$env{'request.course.id'}}= 2930: $env{'course.'.$env{'request.course.id'}.'.description'}; 2931: $courseinstcodebuf{$env{'request.course.id'}}= 2932: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}; 2933: $courseownerbuf{$env{'request.course.id'}}= 2934: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'}; 2935: $coursetypebuf{$env{'request.course.id'}}= 2936: $env{'course.'.$env{'request.course.id'}.'.type'}; 2937: if (defined $courselogs{$env{'request.course.id'}}) { 2938: $courselogs{$env{'request.course.id'}}.='&'.$what; 2939: } else { 2940: $courselogs{$env{'request.course.id'}}.=$what; 2941: } 2942: if (length($courselogs{$env{'request.course.id'}})>4048) { 2943: &flushcourselogs(); 2944: } 2945: } 2946: 2947: sub courseacclog { 2948: my $fnsymb=shift; 2949: unless ($env{'request.course.id'}) { return ''; } 2950: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'}; 2951: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) { 2952: $what.=':POST'; 2953: # FIXME: Probably ought to escape things.... 2954: foreach my $key (keys(%env)) { 2955: if ($key=~/^form\.(.*)/) { 2956: my $formitem = $1; 2957: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) { 2958: $what.=':'.$formitem.'='.$env{$key}; 2959: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) { 2960: $what.=':'.$formitem.'='.$env{$key}; 2961: } 2962: } 2963: } 2964: } elsif ($fnsymb =~ m:^/adm/searchcat:) { 2965: # FIXME: We should not be depending on a form parameter that someone 2966: # editing lonsearchcat.pm might change in the future. 2967: if ($env{'form.phase'} eq 'course_search') { 2968: $what.= ':POST'; 2969: # FIXME: Probably ought to escape things.... 2970: foreach my $element ('courseexp','crsfulltext','crsrelated', 2971: 'crsdiscuss') { 2972: $what.=':'.$element.'='.$env{'form.'.$element}; 2973: } 2974: } 2975: } 2976: &courselog($what); 2977: } 2978: 2979: sub countacc { 2980: my $url=&declutter(shift); 2981: return if (! defined($url) || $url eq ''); 2982: unless ($env{'request.course.id'}) { return ''; } 2983: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1; 2984: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count'; 2985: $accesshash{$key}++; 2986: } 2987: 2988: sub linklog { 2989: my ($from,$to)=@_; 2990: $from=&declutter($from); 2991: $to=&declutter($to); 2992: $accesshash{$from.'___'.$to.'___comefrom'}=1; 2993: $accesshash{$to.'___'.$from.'___goto'}=1; 2994: } 2995: 2996: sub userrolelog { 2997: my ($trole,$username,$domain,$area,$tstart,$tend)=@_; 2998: if (($trole=~/^ca/) || ($trole=~/^aa/) || 2999: ($trole=~/^in/) || ($trole=~/^cc/) || 3000: ($trole=~/^ep/) || ($trole=~/^cr/) || 3001: ($trole=~/^ta/) || ($trole=~/^co/)) { 3002: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 3003: $userrolehash 3004: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 3005: =$tend.':'.$tstart; 3006: } 3007: if (($env{'request.role'} =~ /dc\./) && 3008: (($trole=~/^au/) || ($trole=~/^in/) || 3009: ($trole=~/^cc/) || ($trole=~/^ep/) || 3010: ($trole=~/^cr/) || ($trole=~/^ta/) || 3011: ($trole=~/^co/))) { 3012: $userrolehash 3013: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'} 3014: =$tend.':'.$tstart; 3015: } 3016: if (($trole=~/^dc/) || ($trole=~/^ad/) || 3017: ($trole=~/^li/) || ($trole=~/^li/) || 3018: ($trole=~/^au/) || ($trole=~/^dg/) || 3019: ($trole=~/^sc/)) { 3020: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 3021: $domainrolehash 3022: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 3023: = $tend.':'.$tstart; 3024: } 3025: } 3026: 3027: sub courserolelog { 3028: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_; 3029: if (($trole eq 'cc') || ($trole eq 'in') || 3030: ($trole eq 'ep') || ($trole eq 'ad') || 3031: ($trole eq 'ta') || ($trole eq 'st') || 3032: ($trole=~/^cr/) || ($trole eq 'gr') || 3033: ($trole eq 'co')) { 3034: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) { 3035: my $cdom = $1; 3036: my $cnum = $2; 3037: my $sec = $3; 3038: my $namespace = 'rolelog'; 3039: my %storehash = ( 3040: role => $trole, 3041: start => $tstart, 3042: end => $tend, 3043: selfenroll => $selfenroll, 3044: context => $context, 3045: ); 3046: if ($trole eq 'gr') { 3047: $namespace = 'groupslog'; 3048: $storehash{'group'} = $sec; 3049: } else { 3050: $storehash{'section'} = $sec; 3051: } 3052: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom); 3053: if (($trole ne 'st') || ($sec ne '')) { 3054: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum); 3055: } 3056: } 3057: } 3058: return; 3059: } 3060: 3061: sub get_course_adv_roles { 3062: my ($cid,$codes) = @_; 3063: $cid=$env{'request.course.id'} unless (defined($cid)); 3064: my %coursehash=&coursedescription($cid); 3065: my $crstype = &Apache::loncommon::course_type($cid); 3066: my %nothide=(); 3067: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 3068: if ($user !~ /:/) { 3069: $nothide{join(':',split(/[\@]/,$user))}=1; 3070: } else { 3071: $nothide{$user}=1; 3072: } 3073: } 3074: my %returnhash=(); 3075: my %dumphash= 3076: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'}); 3077: my $now=time; 3078: my %privileged; 3079: foreach my $entry (keys(%dumphash)) { 3080: my ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 3081: if (($tstart) && ($tstart<0)) { next; } 3082: if (($tend) && ($tend<$now)) { next; } 3083: if (($tstart) && ($now<$tstart)) { next; } 3084: my ($role,$username,$domain,$section)=split(/\:/,$entry); 3085: if ($username eq '' || $domain eq '') { next; } 3086: unless (ref($privileged{$domain}) eq 'HASH') { 3087: my %dompersonnel = 3088: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 3089: $privileged{$domain} = {}; 3090: foreach my $server (keys(%dompersonnel)) { 3091: if (ref($dompersonnel{$server}) eq 'HASH') { 3092: foreach my $user (keys(%{$dompersonnel{$server}})) { 3093: my ($trole,$uname,$udom) = split(/:/,$user); 3094: $privileged{$udom}{$uname} = 1; 3095: } 3096: } 3097: } 3098: } 3099: if ((exists($privileged{$domain}{$username})) && 3100: (!$nothide{$username.':'.$domain})) { next; } 3101: if ($role eq 'cr') { next; } 3102: if ($codes) { 3103: if ($section) { $role .= ':'.$section; } 3104: if ($returnhash{$role}) { 3105: $returnhash{$role}.=','.$username.':'.$domain; 3106: } else { 3107: $returnhash{$role}=$username.':'.$domain; 3108: } 3109: } else { 3110: my $key=&plaintext($role,$crstype); 3111: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; } 3112: if ($returnhash{$key}) { 3113: $returnhash{$key}.=','.$username.':'.$domain; 3114: } else { 3115: $returnhash{$key}=$username.':'.$domain; 3116: } 3117: } 3118: } 3119: return %returnhash; 3120: } 3121: 3122: sub get_my_roles { 3123: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_; 3124: unless (defined($uname)) { $uname=$env{'user.name'}; } 3125: unless (defined($udom)) { $udom=$env{'user.domain'}; } 3126: my (%dumphash,%nothide); 3127: if ($context eq 'userroles') { 3128: my $extra = &freeze_escape({'skipcheck' => 1}); 3129: %dumphash = &dump('roles',$udom,$uname,'.',undef,$extra); 3130: } else { 3131: %dumphash= 3132: &dump('nohist_userroles',$udom,$uname); 3133: if ($hidepriv) { 3134: my %coursehash=&coursedescription($udom.'_'.$uname); 3135: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 3136: if ($user !~ /:/) { 3137: $nothide{join(':',split(/[\@]/,$user))} = 1; 3138: } else { 3139: $nothide{$user} = 1; 3140: } 3141: } 3142: } 3143: } 3144: my %returnhash=(); 3145: my $now=time; 3146: my %privileged; 3147: foreach my $entry (keys(%dumphash)) { 3148: my ($role,$tend,$tstart); 3149: if ($context eq 'userroles') { 3150: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry}); 3151: } else { 3152: ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 3153: } 3154: if (($tstart) && ($tstart<0)) { next; } 3155: my $status = 'active'; 3156: if (($tend) && ($tend<=$now)) { 3157: $status = 'previous'; 3158: } 3159: if (($tstart) && ($now<$tstart)) { 3160: $status = 'future'; 3161: } 3162: if (ref($types) eq 'ARRAY') { 3163: if (!grep(/^\Q$status\E$/,@{$types})) { 3164: next; 3165: } 3166: } else { 3167: if ($status ne 'active') { 3168: next; 3169: } 3170: } 3171: my ($rolecode,$username,$domain,$section,$area); 3172: if ($context eq 'userroles') { 3173: ($area,$rolecode) = split(/_/,$entry); 3174: (undef,$domain,$username,$section) = split(/\//,$area); 3175: } else { 3176: ($role,$username,$domain,$section) = split(/\:/,$entry); 3177: } 3178: if (ref($roledoms) eq 'ARRAY') { 3179: if (!grep(/^\Q$domain\E$/,@{$roledoms})) { 3180: next; 3181: } 3182: } 3183: if (ref($roles) eq 'ARRAY') { 3184: if (!grep(/^\Q$role\E$/,@{$roles})) { 3185: if ($role =~ /^cr\//) { 3186: if (!grep(/^cr$/,@{$roles})) { 3187: next; 3188: } 3189: } elsif ($role =~ /^gr\//) { 3190: if (!grep(/^gr$/,@{$roles})) { 3191: next; 3192: } 3193: } else { 3194: next; 3195: } 3196: } 3197: } 3198: if ($hidepriv) { 3199: if ($context eq 'userroles') { 3200: if ((&privileged($username,$domain)) && 3201: (!$nothide{$username.':'.$domain})) { 3202: next; 3203: } 3204: } else { 3205: unless (ref($privileged{$domain}) eq 'HASH') { 3206: my %dompersonnel = 3207: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 3208: $privileged{$domain} = {}; 3209: if (keys(%dompersonnel)) { 3210: foreach my $server (keys(%dompersonnel)) { 3211: if (ref($dompersonnel{$server}) eq 'HASH') { 3212: foreach my $user (keys(%{$dompersonnel{$server}})) { 3213: my ($trole,$uname,$udom) = split(/:/,$user); 3214: $privileged{$udom}{$uname} = $trole; 3215: } 3216: } 3217: } 3218: } 3219: } 3220: if (exists($privileged{$domain}{$username})) { 3221: if (!$nothide{$username.':'.$domain}) { 3222: next; 3223: } 3224: } 3225: } 3226: } 3227: if ($withsec) { 3228: $returnhash{$username.':'.$domain.':'.$role.':'.$section} = 3229: $tstart.':'.$tend; 3230: } else { 3231: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend; 3232: } 3233: } 3234: return %returnhash; 3235: } 3236: 3237: # ----------------------------------------------------- Frontpage Announcements 3238: # 3239: # 3240: 3241: sub postannounce { 3242: my ($server,$text)=@_; 3243: unless (&allowed('psa',&host_domain($server))) { return 'refused'; } 3244: unless ($text=~/\w/) { $text=''; } 3245: return &reply('setannounce:'.&escape($text),$server); 3246: } 3247: 3248: sub getannounce { 3249: 3250: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) { 3251: my $announcement=''; 3252: while (my $line = <$fh>) { $announcement .= $line; } 3253: close($fh); 3254: if ($announcement=~/\w/) { 3255: return 3256: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'. 3257: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 3258: } else { 3259: return ''; 3260: } 3261: } else { 3262: return ''; 3263: } 3264: } 3265: 3266: # ---------------------------------------------------------- Course ID routines 3267: # Deal with domain's nohist_courseid.db files 3268: # 3269: 3270: sub courseidput { 3271: my ($domain,$storehash,$coursehome,$caller) = @_; 3272: return unless (ref($storehash) eq 'HASH'); 3273: my $outcome; 3274: if ($caller eq 'timeonly') { 3275: my $cids = ''; 3276: foreach my $item (keys(%$storehash)) { 3277: $cids.=&escape($item).'&'; 3278: } 3279: $cids=~s/\&$//; 3280: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids, 3281: $coursehome); 3282: } else { 3283: my $items = ''; 3284: foreach my $item (keys(%$storehash)) { 3285: $items.= &escape($item).'='. 3286: &freeze_escape($$storehash{$item}).'&'; 3287: } 3288: $items=~s/\&$//; 3289: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items, 3290: $coursehome); 3291: } 3292: if ($outcome eq 'unknown_cmd') { 3293: my $what; 3294: foreach my $cid (keys(%$storehash)) { 3295: $what .= &escape($cid).'='; 3296: foreach my $item ('description','inst_code','owner','type') { 3297: $what .= &escape($storehash->{$cid}{$item}).':'; 3298: } 3299: $what =~ s/\:$/&/; 3300: } 3301: $what =~ s/\&$//; 3302: return &reply('courseidput:'.$domain.':'.$what,$coursehome); 3303: } else { 3304: return $outcome; 3305: } 3306: } 3307: 3308: sub courseiddump { 3309: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter, 3310: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok, 3311: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone, 3312: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_; 3313: my $as_hash = 1; 3314: my %returnhash; 3315: if (!$domfilter) { $domfilter=''; } 3316: my %libserv = &all_library(); 3317: foreach my $tryserver (keys(%libserv)) { 3318: if ( ( $hostidflag == 1 3319: && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 3320: || (!defined($hostidflag)) ) { 3321: 3322: if (($domfilter eq '') || 3323: (&host_domain($tryserver) eq $domfilter)) { 3324: my $rep = 3325: &reply('courseiddump:'.&host_domain($tryserver).':'. 3326: $sincefilter.':'.&escape($descfilter).':'. 3327: &escape($instcodefilter).':'.&escape($ownerfilter). 3328: ':'.&escape($coursefilter).':'.&escape($typefilter). 3329: ':'.&escape($regexp_ok).':'.$as_hash.':'. 3330: &escape($selfenrollonly).':'.&escape($catfilter).':'. 3331: $showhidden.':'.$caller.':'.&escape($cloner).':'. 3332: &escape($cc_clone).':'.$cloneonly.':'. 3333: &escape($createdbefore).':'.&escape($createdafter).':'. 3334: &escape($creationcontext).':'.$domcloner, 3335: $tryserver); 3336: my @pairs=split(/\&/,$rep); 3337: foreach my $item (@pairs) { 3338: my ($key,$value)=split(/\=/,$item,2); 3339: $key = &unescape($key); 3340: next if ($key =~ /^error: 2 /); 3341: my $result = &thaw_unescape($value); 3342: if (ref($result) eq 'HASH') { 3343: $returnhash{$key}=$result; 3344: } else { 3345: my @responses = split(/:/,$value); 3346: my @items = ('description','inst_code','owner','type'); 3347: for (my $i=0; $i<@responses; $i++) { 3348: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]); 3349: } 3350: } 3351: } 3352: } 3353: } 3354: } 3355: return %returnhash; 3356: } 3357: 3358: sub courselastaccess { 3359: my ($cdom,$cnum,$hostidref) = @_; 3360: my %returnhash; 3361: if ($cdom && $cnum) { 3362: my $chome = &homeserver($cnum,$cdom); 3363: if ($chome ne 'no_host') { 3364: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome); 3365: &extract_lastaccess(\%returnhash,$rep); 3366: } 3367: } else { 3368: if (!$cdom) { $cdom=''; } 3369: my %libserv = &all_library(); 3370: foreach my $tryserver (keys(%libserv)) { 3371: if (ref($hostidref) eq 'ARRAY') { 3372: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref})); 3373: } 3374: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) { 3375: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver); 3376: &extract_lastaccess(\%returnhash,$rep); 3377: } 3378: } 3379: } 3380: return %returnhash; 3381: } 3382: 3383: sub extract_lastaccess { 3384: my ($returnhash,$rep) = @_; 3385: if (ref($returnhash) eq 'HASH') { 3386: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 3387: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' || 3388: $rep eq '') { 3389: my @pairs=split(/\&/,$rep); 3390: foreach my $item (@pairs) { 3391: my ($key,$value)=split(/\=/,$item,2); 3392: $key = &unescape($key); 3393: next if ($key =~ /^error: 2 /); 3394: $returnhash->{$key} = &thaw_unescape($value); 3395: } 3396: } 3397: } 3398: return; 3399: } 3400: 3401: # ---------------------------------------------------------- DC e-mail 3402: 3403: sub dcmailput { 3404: my ($domain,$msgid,$message,$server)=@_; 3405: my $status = &Apache::lonnet::critical( 3406: 'dcmailput:'.$domain.':'.&escape($msgid).'='. 3407: &escape($message),$server); 3408: return $status; 3409: } 3410: 3411: sub dcmaildump { 3412: my ($dom,$startdate,$enddate,$senders) = @_; 3413: my %returnhash=(); 3414: 3415: if (defined(&domain($dom,'primary'))) { 3416: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'. 3417: &escape($enddate).':'; 3418: my @esc_senders=map { &escape($_)} @$senders; 3419: $cmd.=&escape(join('&',@esc_senders)); 3420: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) { 3421: my ($key,$value) = split(/\=/,$line,2); 3422: if (($key) && ($value)) { 3423: $returnhash{&unescape($key)} = &unescape($value); 3424: } 3425: } 3426: } 3427: return %returnhash; 3428: } 3429: # ---------------------------------------------------------- Domain roles 3430: 3431: sub get_domain_roles { 3432: my ($dom,$roles,$startdate,$enddate)=@_; 3433: if ((!defined($startdate)) || ($startdate eq '')) { 3434: $startdate = '.'; 3435: } 3436: if ((!defined($enddate)) || ($enddate eq '')) { 3437: $enddate = '.'; 3438: } 3439: my $rolelist; 3440: if (ref($roles) eq 'ARRAY') { 3441: $rolelist = join(':',@{$roles}); 3442: } 3443: my %personnel = (); 3444: 3445: my %servers = &get_servers($dom,'library'); 3446: foreach my $tryserver (keys(%servers)) { 3447: %{$personnel{$tryserver}}=(); 3448: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'. 3449: &escape($startdate).':'. 3450: &escape($enddate).':'. 3451: &escape($rolelist), $tryserver))) { 3452: my ($key,$value) = split(/\=/,$line,2); 3453: if (($key) && ($value)) { 3454: $personnel{$tryserver}{&unescape($key)} = &unescape($value); 3455: } 3456: } 3457: } 3458: return %personnel; 3459: } 3460: 3461: # ----------------------------------------------------------- Interval timing 3462: 3463: sub get_first_access { 3464: my ($type,$argsymb)=@_; 3465: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3466: if ($argsymb) { $symb=$argsymb; } 3467: my ($map,$id,$res)=&decode_symb($symb); 3468: if ($type eq 'course') { 3469: $res='course'; 3470: } elsif ($type eq 'map') { 3471: $res=&symbread($map); 3472: } else { 3473: $res=$symb; 3474: } 3475: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname); 3476: return $times{"$courseid\0$res"}; 3477: } 3478: 3479: sub set_first_access { 3480: my ($type)=@_; 3481: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3482: my ($map,$id,$res)=&decode_symb($symb); 3483: if ($type eq 'course') { 3484: $res='course'; 3485: } elsif ($type eq 'map') { 3486: $res=&symbread($map); 3487: } else { 3488: $res=$symb; 3489: } 3490: my $firstaccess=&get_first_access($type,$symb); 3491: if (!$firstaccess) { 3492: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname); 3493: } 3494: return 'already_set'; 3495: } 3496: 3497: # --------------------------------------------- Set Expire Date for Spreadsheet 3498: 3499: sub expirespread { 3500: my ($uname,$udom,$stype,$usymb)=@_; 3501: my $cid=$env{'request.course.id'}; 3502: if ($cid) { 3503: my $now=time; 3504: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb; 3505: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'. 3506: $env{'course.'.$cid.'.num'}. 3507: ':nohist_expirationdates:'. 3508: &escape($key).'='.$now, 3509: $env{'course.'.$cid.'.home'}) 3510: } 3511: return 'ok'; 3512: } 3513: 3514: # ----------------------------------------------------- Devalidate Spreadsheets 3515: 3516: sub devalidate { 3517: my ($symb,$uname,$udom)=@_; 3518: my $cid=$env{'request.course.id'}; 3519: if ($cid) { 3520: # delete the stored spreadsheets for 3521: # - the student level sheet of this user in course's homespace 3522: # - the assessment level sheet for this resource 3523: # for this user in user's homespace 3524: # - current conditional state info 3525: my $key=$uname.':'.$udom.':'; 3526: my $status= 3527: &del('nohist_calculatedsheets', 3528: [$key.'studentcalc:'], 3529: $env{'course.'.$cid.'.domain'}, 3530: $env{'course.'.$cid.'.num'}) 3531: .' '. 3532: &del('nohist_calculatedsheets_'.$cid, 3533: [$key.'assesscalc:'.$symb],$udom,$uname); 3534: unless ($status eq 'ok ok') { 3535: &logthis('Could not devalidate spreadsheet '. 3536: $uname.' at '.$udom.' for '. 3537: $symb.': '.$status); 3538: } 3539: &delenv('user.state.'.$cid); 3540: } 3541: } 3542: 3543: sub get_scalar { 3544: my ($string,$end) = @_; 3545: my $value; 3546: if ($$string =~ s/^([^&]*?)($end)/$2/) { 3547: $value = $1; 3548: } elsif ($$string =~ s/^([^&]*?)&//) { 3549: $value = $1; 3550: } 3551: return &unescape($value); 3552: } 3553: 3554: sub array2str { 3555: my (@array) = @_; 3556: my $result=&arrayref2str(\@array); 3557: $result=~s/^__ARRAY_REF__//; 3558: $result=~s/__END_ARRAY_REF__$//; 3559: return $result; 3560: } 3561: 3562: sub arrayref2str { 3563: my ($arrayref) = @_; 3564: my $result='__ARRAY_REF__'; 3565: foreach my $elem (@$arrayref) { 3566: if(ref($elem) eq 'ARRAY') { 3567: $result.=&arrayref2str($elem).'&'; 3568: } elsif(ref($elem) eq 'HASH') { 3569: $result.=&hashref2str($elem).'&'; 3570: } elsif(ref($elem)) { 3571: #print("Got a ref of ".(ref($elem))." skipping."); 3572: } else { 3573: $result.=&escape($elem).'&'; 3574: } 3575: } 3576: $result=~s/\&$//; 3577: $result .= '__END_ARRAY_REF__'; 3578: return $result; 3579: } 3580: 3581: sub hash2str { 3582: my (%hash) = @_; 3583: my $result=&hashref2str(\%hash); 3584: $result=~s/^__HASH_REF__//; 3585: $result=~s/__END_HASH_REF__$//; 3586: return $result; 3587: } 3588: 3589: sub hashref2str { 3590: my ($hashref)=@_; 3591: my $result='__HASH_REF__'; 3592: foreach my $key (sort(keys(%$hashref))) { 3593: if (ref($key) eq 'ARRAY') { 3594: $result.=&arrayref2str($key).'='; 3595: } elsif (ref($key) eq 'HASH') { 3596: $result.=&hashref2str($key).'='; 3597: } elsif (ref($key)) { 3598: $result.='='; 3599: #print("Got a ref of ".(ref($key))." skipping."); 3600: } else { 3601: if ($key) {$result.=&escape($key).'=';} else { last; } 3602: } 3603: 3604: if(ref($hashref->{$key}) eq 'ARRAY') { 3605: $result.=&arrayref2str($hashref->{$key}).'&'; 3606: } elsif(ref($hashref->{$key}) eq 'HASH') { 3607: $result.=&hashref2str($hashref->{$key}).'&'; 3608: } elsif(ref($hashref->{$key})) { 3609: $result.='&'; 3610: #print("Got a ref of ".(ref($hashref->{$key}))." skipping."); 3611: } else { 3612: $result.=&escape($hashref->{$key}).'&'; 3613: } 3614: } 3615: $result=~s/\&$//; 3616: $result .= '__END_HASH_REF__'; 3617: return $result; 3618: } 3619: 3620: sub str2hash { 3621: my ($string)=@_; 3622: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__'); 3623: return %$hash; 3624: } 3625: 3626: sub str2hashref { 3627: my ($string) = @_; 3628: 3629: my %hash; 3630: 3631: if($string !~ /^__HASH_REF__/) { 3632: if (! ($string eq '' || !defined($string))) { 3633: $hash{'error'}='Not hash reference'; 3634: } 3635: return (\%hash, $string); 3636: } 3637: 3638: $string =~ s/^__HASH_REF__//; 3639: 3640: while($string !~ /^__END_HASH_REF__/) { 3641: #key 3642: my $key=''; 3643: if($string =~ /^__HASH_REF__/) { 3644: ($key, $string)=&str2hashref($string); 3645: if(defined($key->{'error'})) { 3646: $hash{'error'}='Bad data'; 3647: return (\%hash, $string); 3648: } 3649: } elsif($string =~ /^__ARRAY_REF__/) { 3650: ($key, $string)=&str2arrayref($string); 3651: if($key->[0] eq 'Array reference error') { 3652: $hash{'error'}='Bad data'; 3653: return (\%hash, $string); 3654: } 3655: } else { 3656: $string =~ s/^(.*?)=//; 3657: $key=&unescape($1); 3658: } 3659: $string =~ s/^=//; 3660: 3661: #value 3662: my $value=''; 3663: if($string =~ /^__HASH_REF__/) { 3664: ($value, $string)=&str2hashref($string); 3665: if(defined($value->{'error'})) { 3666: $hash{'error'}='Bad data'; 3667: return (\%hash, $string); 3668: } 3669: } elsif($string =~ /^__ARRAY_REF__/) { 3670: ($value, $string)=&str2arrayref($string); 3671: if($value->[0] eq 'Array reference error') { 3672: $hash{'error'}='Bad data'; 3673: return (\%hash, $string); 3674: } 3675: } else { 3676: $value=&get_scalar(\$string,'__END_HASH_REF__'); 3677: } 3678: $string =~ s/^&//; 3679: 3680: $hash{$key}=$value; 3681: } 3682: 3683: $string =~ s/^__END_HASH_REF__//; 3684: 3685: return (\%hash, $string); 3686: } 3687: 3688: sub str2array { 3689: my ($string)=@_; 3690: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__'); 3691: return @$array; 3692: } 3693: 3694: sub str2arrayref { 3695: my ($string) = @_; 3696: my @array; 3697: 3698: if($string !~ /^__ARRAY_REF__/) { 3699: if (! ($string eq '' || !defined($string))) { 3700: $array[0]='Array reference error'; 3701: } 3702: return (\@array, $string); 3703: } 3704: 3705: $string =~ s/^__ARRAY_REF__//; 3706: 3707: while($string !~ /^__END_ARRAY_REF__/) { 3708: my $value=''; 3709: if($string =~ /^__HASH_REF__/) { 3710: ($value, $string)=&str2hashref($string); 3711: if(defined($value->{'error'})) { 3712: $array[0] ='Array reference error'; 3713: return (\@array, $string); 3714: } 3715: } elsif($string =~ /^__ARRAY_REF__/) { 3716: ($value, $string)=&str2arrayref($string); 3717: if($value->[0] eq 'Array reference error') { 3718: $array[0] ='Array reference error'; 3719: return (\@array, $string); 3720: } 3721: } else { 3722: $value=&get_scalar(\$string,'__END_ARRAY_REF__'); 3723: } 3724: $string =~ s/^&//; 3725: 3726: push(@array, $value); 3727: } 3728: 3729: $string =~ s/^__END_ARRAY_REF__//; 3730: 3731: return (\@array, $string); 3732: } 3733: 3734: # -------------------------------------------------------------------Temp Store 3735: 3736: sub tmpreset { 3737: my ($symb,$namespace,$domain,$stuname) = @_; 3738: if (!$symb) { 3739: $symb=&symbread(); 3740: if (!$symb) { $symb= $env{'request.url'}; } 3741: } 3742: $symb=escape($symb); 3743: 3744: if (!$namespace) { $namespace=$env{'request.state'}; } 3745: $namespace=~s/\//\_/g; 3746: $namespace=~s/\W//g; 3747: 3748: if (!$domain) { $domain=$env{'user.domain'}; } 3749: if (!$stuname) { $stuname=$env{'user.name'}; } 3750: if ($domain eq 'public' && $stuname eq 'public') { 3751: $stuname=$ENV{'REMOTE_ADDR'}; 3752: } 3753: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3754: my %hash; 3755: if (tie(%hash,'GDBM_File', 3756: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3757: &GDBM_WRCREAT(),0640)) { 3758: foreach my $key (keys(%hash)) { 3759: if ($key=~ /:$symb/) { 3760: delete($hash{$key}); 3761: } 3762: } 3763: } 3764: } 3765: 3766: sub tmpstore { 3767: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3768: 3769: if (!$symb) { 3770: $symb=&symbread(); 3771: if (!$symb) { $symb= $env{'request.url'}; } 3772: } 3773: $symb=escape($symb); 3774: 3775: if (!$namespace) { 3776: # I don't think we would ever want to store this for a course. 3777: # it seems this will only be used if we don't have a course. 3778: #$namespace=$env{'request.course.id'}; 3779: #if (!$namespace) { 3780: $namespace=$env{'request.state'}; 3781: #} 3782: } 3783: $namespace=~s/\//\_/g; 3784: $namespace=~s/\W//g; 3785: if (!$domain) { $domain=$env{'user.domain'}; } 3786: if (!$stuname) { $stuname=$env{'user.name'}; } 3787: if ($domain eq 'public' && $stuname eq 'public') { 3788: $stuname=$ENV{'REMOTE_ADDR'}; 3789: } 3790: my $now=time; 3791: my %hash; 3792: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3793: if (tie(%hash,'GDBM_File', 3794: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3795: &GDBM_WRCREAT(),0640)) { 3796: $hash{"version:$symb"}++; 3797: my $version=$hash{"version:$symb"}; 3798: my $allkeys=''; 3799: foreach my $key (keys(%$storehash)) { 3800: $allkeys.=$key.':'; 3801: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key}); 3802: } 3803: $hash{"$version:$symb:timestamp"}=$now; 3804: $allkeys.='timestamp'; 3805: $hash{"$version:keys:$symb"}=$allkeys; 3806: if (untie(%hash)) { 3807: return 'ok'; 3808: } else { 3809: return "error:$!"; 3810: } 3811: } else { 3812: return "error:$!"; 3813: } 3814: } 3815: 3816: # -----------------------------------------------------------------Temp Restore 3817: 3818: sub tmprestore { 3819: my ($symb,$namespace,$domain,$stuname) = @_; 3820: 3821: if (!$symb) { 3822: $symb=&symbread(); 3823: if (!$symb) { $symb= $env{'request.url'}; } 3824: } 3825: $symb=escape($symb); 3826: 3827: if (!$namespace) { $namespace=$env{'request.state'}; } 3828: 3829: if (!$domain) { $domain=$env{'user.domain'}; } 3830: if (!$stuname) { $stuname=$env{'user.name'}; } 3831: if ($domain eq 'public' && $stuname eq 'public') { 3832: $stuname=$ENV{'REMOTE_ADDR'}; 3833: } 3834: my %returnhash; 3835: $namespace=~s/\//\_/g; 3836: $namespace=~s/\W//g; 3837: my %hash; 3838: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3839: if (tie(%hash,'GDBM_File', 3840: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3841: &GDBM_READER(),0640)) { 3842: my $version=$hash{"version:$symb"}; 3843: $returnhash{'version'}=$version; 3844: my $scope; 3845: for ($scope=1;$scope<=$version;$scope++) { 3846: my $vkeys=$hash{"$scope:keys:$symb"}; 3847: my @keys=split(/:/,$vkeys); 3848: my $key; 3849: $returnhash{"$scope:keys"}=$vkeys; 3850: foreach $key (@keys) { 3851: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3852: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3853: } 3854: } 3855: if (!(untie(%hash))) { 3856: return "error:$!"; 3857: } 3858: } else { 3859: return "error:$!"; 3860: } 3861: return %returnhash; 3862: } 3863: 3864: # ----------------------------------------------------------------------- Store 3865: 3866: sub store { 3867: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3868: my $home=''; 3869: 3870: if ($stuname) { $home=&homeserver($stuname,$domain); } 3871: 3872: $symb=&symbclean($symb); 3873: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 3874: 3875: if (!$domain) { $domain=$env{'user.domain'}; } 3876: if (!$stuname) { $stuname=$env{'user.name'}; } 3877: 3878: &devalidate($symb,$stuname,$domain); 3879: 3880: $symb=escape($symb); 3881: if (!$namespace) { 3882: unless ($namespace=$env{'request.course.id'}) { 3883: return ''; 3884: } 3885: } 3886: if (!$home) { $home=$env{'user.home'}; } 3887: 3888: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 3889: $$storehash{'host'}=$perlvar{'lonHostID'}; 3890: 3891: my $namevalue=''; 3892: foreach my $key (keys(%$storehash)) { 3893: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 3894: } 3895: $namevalue=~s/\&$//; 3896: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue); 3897: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3898: } 3899: 3900: # -------------------------------------------------------------- Critical Store 3901: 3902: sub cstore { 3903: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3904: my $home=''; 3905: 3906: if ($stuname) { $home=&homeserver($stuname,$domain); } 3907: 3908: $symb=&symbclean($symb); 3909: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 3910: 3911: if (!$domain) { $domain=$env{'user.domain'}; } 3912: if (!$stuname) { $stuname=$env{'user.name'}; } 3913: 3914: &devalidate($symb,$stuname,$domain); 3915: 3916: $symb=escape($symb); 3917: if (!$namespace) { 3918: unless ($namespace=$env{'request.course.id'}) { 3919: return ''; 3920: } 3921: } 3922: if (!$home) { $home=$env{'user.home'}; } 3923: 3924: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 3925: $$storehash{'host'}=$perlvar{'lonHostID'}; 3926: 3927: my $namevalue=''; 3928: foreach my $key (keys(%$storehash)) { 3929: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 3930: } 3931: $namevalue=~s/\&$//; 3932: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue); 3933: return critical 3934: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3935: } 3936: 3937: # --------------------------------------------------------------------- Restore 3938: 3939: sub restore { 3940: my ($symb,$namespace,$domain,$stuname) = @_; 3941: my $home=''; 3942: 3943: if ($stuname) { $home=&homeserver($stuname,$domain); } 3944: 3945: if (!$symb) { 3946: unless ($symb=escape(&symbread())) { return ''; } 3947: } else { 3948: $symb=&escape(&symbclean($symb)); 3949: } 3950: if (!$namespace) { 3951: unless ($namespace=$env{'request.course.id'}) { 3952: return ''; 3953: } 3954: } 3955: if (!$domain) { $domain=$env{'user.domain'}; } 3956: if (!$stuname) { $stuname=$env{'user.name'}; } 3957: if (!$home) { $home=$env{'user.home'}; } 3958: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home"); 3959: 3960: my %returnhash=(); 3961: foreach my $line (split(/\&/,$answer)) { 3962: my ($name,$value)=split(/\=/,$line); 3963: $returnhash{&unescape($name)}=&thaw_unescape($value); 3964: } 3965: my $version; 3966: for ($version=1;$version<=$returnhash{'version'};$version++) { 3967: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) { 3968: $returnhash{$item}=$returnhash{$version.':'.$item}; 3969: } 3970: } 3971: return %returnhash; 3972: } 3973: 3974: # ---------------------------------------------------------- Course Description 3975: 3976: sub coursedescription { 3977: my ($courseid,$args)=@_; 3978: $courseid=~s/^\///; 3979: $courseid=~s/\_/\//g; 3980: my ($cdomain,$cnum)=split(/\//,$courseid); 3981: my $chome=&homeserver($cnum,$cdomain); 3982: my $normalid=$cdomain.'_'.$cnum; 3983: # need to always cache even if we get errors otherwise we keep 3984: # trying and trying and trying to get the course description. 3985: my %envhash=(); 3986: my %returnhash=(); 3987: 3988: my $expiretime=600; 3989: if ($env{'request.course.id'} eq $normalid) { 3990: $expiretime=120; 3991: } 3992: 3993: my $prefix='course.'.$cdomain.'_'.$cnum.'.'; 3994: if (!$args->{'freshen_cache'} 3995: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) { 3996: foreach my $key (keys(%env)) { 3997: next if ($key !~ /^\Q$prefix\E(.*)/); 3998: my ($setting) = $1; 3999: $returnhash{$setting} = $env{$key}; 4000: } 4001: return %returnhash; 4002: } 4003: 4004: # get the data agin 4005: if (!$args->{'one_time'}) { 4006: $envhash{'course.'.$normalid.'.last_cache'}=time; 4007: } 4008: 4009: if ($chome ne 'no_host') { 4010: %returnhash=&dump('environment',$cdomain,$cnum); 4011: if (!exists($returnhash{'con_lost'})) { 4012: $returnhash{'home'}= $chome; 4013: $returnhash{'domain'} = $cdomain; 4014: $returnhash{'num'} = $cnum; 4015: if (!defined($returnhash{'type'})) { 4016: $returnhash{'type'} = 'Course'; 4017: } 4018: while (my ($name,$value) = each %returnhash) { 4019: $envhash{'course.'.$normalid.'.'.$name}=$value; 4020: } 4021: $returnhash{'url'}=&clutter($returnhash{'url'}); 4022: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'. 4023: $env{'user.name'}.'_'.$cdomain.'_'.$cnum; 4024: $envhash{'course.'.$normalid.'.home'}=$chome; 4025: $envhash{'course.'.$normalid.'.domain'}=$cdomain; 4026: $envhash{'course.'.$normalid.'.num'}=$cnum; 4027: } 4028: } 4029: if (!$args->{'one_time'}) { 4030: &appenv(\%envhash); 4031: } 4032: return %returnhash; 4033: } 4034: 4035: sub update_released_required { 4036: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_; 4037: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') { 4038: $cid = $env{'request.course.id'}; 4039: $cdom = $env{'course.'.$cid.'.domain'}; 4040: $cnum = $env{'course.'.$cid.'.num'}; 4041: $chome = $env{'course.'.$cid.'.home'}; 4042: } 4043: if ($needsrelease) { 4044: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired'); 4045: my $needsupdate; 4046: if ($curr_reqd_hash{'internal.releaserequired'} eq '') { 4047: $needsupdate = 1; 4048: } else { 4049: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'}); 4050: my ($needsmajor,$needsminor) = split(/\./,$needsrelease); 4051: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) { 4052: $needsupdate = 1; 4053: } 4054: } 4055: if ($needsupdate) { 4056: my %needshash = ( 4057: 'internal.releaserequired' => $needsrelease, 4058: ); 4059: my $putresult = &put('environment',\%needshash,$cdom,$cnum); 4060: if ($putresult eq 'ok') { 4061: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease}); 4062: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.'); 4063: if (ref($crsinfo{$cid}) eq 'HASH') { 4064: $crsinfo{$cid}{'releaserequired'} = $needsrelease; 4065: &courseidput($cdom,\%crsinfo,$chome,'notime'); 4066: } 4067: } 4068: } 4069: } 4070: return; 4071: } 4072: 4073: # -------------------------------------------------See if a user is privileged 4074: 4075: sub privileged { 4076: my ($username,$domain)=@_; 4077: my $rolesdump=&reply("dump:$domain:$username:roles", 4078: &homeserver($username,$domain)); 4079: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 4080: ($rolesdump =~ /^error:/)) { 4081: return 0; 4082: } 4083: my $now=time; 4084: if ($rolesdump ne '') { 4085: foreach my $entry (split(/&/,$rolesdump)) { 4086: if ($entry!~/^rolesdef_/) { 4087: my ($area,$role)=split(/=/,$entry); 4088: $area=~s/\_\w\w$//; 4089: my ($trole,$tend,$tstart)=split(/_/,$role); 4090: if (($trole eq 'dc') || ($trole eq 'su')) { 4091: my $active=1; 4092: if ($tend) { 4093: if ($tend<$now) { $active=0; } 4094: } 4095: if ($tstart) { 4096: if ($tstart>$now) { $active=0; } 4097: } 4098: if ($active) { return 1; } 4099: } 4100: } 4101: } 4102: } 4103: return 0; 4104: } 4105: 4106: # -------------------------------------------------------- Get user privileges 4107: 4108: sub rolesinit { 4109: my ($domain,$username,$authhost)=@_; 4110: my $now=time; 4111: my %userroles = ('user.login.time' => $now); 4112: my $extra = &freeze_escape({'skipcheck' => 1}); 4113: my $rolesdump=reply("dump:$domain:$username:roles:.::$extra",$authhost); 4114: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 4115: ($rolesdump =~ /^error:/)) { 4116: return \%userroles; 4117: } 4118: my %allroles=(); 4119: my %allgroups=(); 4120: 4121: if ($rolesdump ne '') { 4122: foreach my $entry (split(/&/,$rolesdump)) { 4123: if ($entry!~/^rolesdef_/) { 4124: my ($area,$role)=split(/=/,$entry); 4125: $area=~s/\_\w\w$//; 4126: my ($trole,$tend,$tstart,$group_privs); 4127: if ($role=~/^cr/) { 4128: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) { 4129: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|); 4130: ($tend,$tstart)=split('_',$trest); 4131: } else { 4132: $trole=$role; 4133: } 4134: } elsif ($role =~ m|^gr/|) { 4135: ($trole,$tend,$tstart) = split(/_/,$role); 4136: next if ($tstart eq '-1'); 4137: ($trole,$group_privs) = split(/\//,$trole); 4138: $group_privs = &unescape($group_privs); 4139: } else { 4140: ($trole,$tend,$tstart)=split(/_/,$role); 4141: } 4142: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain, 4143: $username); 4144: @userroles{keys(%new_role)} = @new_role{keys(%new_role)}; 4145: if (($tend!=0) && ($tend<$now)) { $trole=''; } 4146: if (($tstart!=0) && ($tstart>$now)) { $trole=''; } 4147: if (($area ne '') && ($trole ne '')) { 4148: my $spec=$trole.'.'.$area; 4149: my ($tdummy,$tdomain,$trest)=split(/\//,$area); 4150: if ($trole =~ /^cr\//) { 4151: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 4152: } elsif ($trole eq 'gr') { 4153: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart); 4154: } else { 4155: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 4156: } 4157: } 4158: } 4159: } 4160: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups); 4161: $userroles{'user.adv'} = $adv; 4162: $userroles{'user.author'} = $author; 4163: $env{'user.adv'}=$adv; 4164: } 4165: return \%userroles; 4166: } 4167: 4168: sub set_arearole { 4169: my ($trole,$area,$tstart,$tend,$domain,$username) = @_; 4170: # log the associated role with the area 4171: &userrolelog($trole,$username,$domain,$area,$tstart,$tend); 4172: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend); 4173: } 4174: 4175: sub custom_roleprivs { 4176: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_; 4177: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole); 4178: my $homsvr=homeserver($rauthor,$rdomain); 4179: if (&hostname($homsvr) ne '') { 4180: my ($rdummy,$roledef)= 4181: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor); 4182: if (($rdummy ne 'con_lost') && ($roledef ne '')) { 4183: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef); 4184: if (defined($syspriv)) { 4185: if ($trest =~ /^$match_community$/) { 4186: $syspriv =~ s/bre\&S//; 4187: } 4188: $$allroles{'cm./'}.=':'.$syspriv; 4189: $$allroles{$spec.'./'}.=':'.$syspriv; 4190: } 4191: if ($tdomain ne '') { 4192: if (defined($dompriv)) { 4193: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv; 4194: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv; 4195: } 4196: if (($trest ne '') && (defined($coursepriv))) { 4197: $$allroles{'cm.'.$area}.=':'.$coursepriv; 4198: $$allroles{$spec.'.'.$area}.=':'.$coursepriv; 4199: } 4200: } 4201: } 4202: } 4203: } 4204: 4205: sub group_roleprivs { 4206: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_; 4207: my $access = 1; 4208: my $now = time; 4209: if (($tend!=0) && ($tend<$now)) { $access = 0; } 4210: if (($tstart!=0) && ($tstart>$now)) { $access=0; } 4211: if ($access) { 4212: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|); 4213: $$allgroups{$course}{$group} .=':'.$group_privs; 4214: } 4215: } 4216: 4217: sub standard_roleprivs { 4218: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_; 4219: if (defined($pr{$trole.':s'})) { 4220: $$allroles{'cm./'}.=':'.$pr{$trole.':s'}; 4221: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'}; 4222: } 4223: if ($tdomain ne '') { 4224: if (defined($pr{$trole.':d'})) { 4225: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 4226: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 4227: } 4228: if (($trest ne '') && (defined($pr{$trole.':c'}))) { 4229: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'}; 4230: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'}; 4231: } 4232: } 4233: } 4234: 4235: sub set_userprivs { 4236: my ($userroles,$allroles,$allgroups,$groups_roles) = @_; 4237: my $author=0; 4238: my $adv=0; 4239: my %grouproles = (); 4240: if (keys(%{$allgroups}) > 0) { 4241: my @groupkeys; 4242: foreach my $role (keys(%{$allroles})) { 4243: push(@groupkeys,$role); 4244: } 4245: if (ref($groups_roles) eq 'HASH') { 4246: foreach my $key (keys(%{$groups_roles})) { 4247: unless (grep(/^\Q$key\E$/,@groupkeys)) { 4248: push(@groupkeys,$key); 4249: } 4250: } 4251: } 4252: if (@groupkeys > 0) { 4253: foreach my $role (@groupkeys) { 4254: my ($trole,$area,$sec,$extendedarea); 4255: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) { 4256: $trole = $1; 4257: $area = $2; 4258: $sec = $3; 4259: $extendedarea = $area.$sec; 4260: if (exists($$allgroups{$area})) { 4261: foreach my $group (keys(%{$$allgroups{$area}})) { 4262: my $spec = $trole.'.'.$extendedarea; 4263: $grouproles{$spec.'.'.$area.'/'.$group} = 4264: $$allgroups{$area}{$group}; 4265: } 4266: } 4267: } 4268: } 4269: } 4270: } 4271: foreach my $group (keys(%grouproles)) { 4272: $$allroles{$group} = $grouproles{$group}; 4273: } 4274: foreach my $role (keys(%{$allroles})) { 4275: my %thesepriv; 4276: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; } 4277: foreach my $item (split(/:/,$$allroles{$role})) { 4278: if ($item ne '') { 4279: my ($privilege,$restrictions)=split(/&/,$item); 4280: if ($restrictions eq '') { 4281: $thesepriv{$privilege}='F'; 4282: } elsif ($thesepriv{$privilege} ne 'F') { 4283: $thesepriv{$privilege}.=$restrictions; 4284: } 4285: if ($thesepriv{'adv'} eq 'F') { $adv=1; } 4286: } 4287: } 4288: my $thesestr=''; 4289: foreach my $priv (sort(keys(%thesepriv))) { 4290: $thesestr.=':'.$priv.'&'.$thesepriv{$priv}; 4291: } 4292: $userroles->{'user.priv.'.$role} = $thesestr; 4293: } 4294: return ($author,$adv); 4295: } 4296: 4297: sub role_status { 4298: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_; 4299: my @pwhere = (); 4300: if (exists($env{$rolekey}) && $env{$rolekey} ne '') { 4301: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey); 4302: unless (!defined($$role) || $$role eq '') { 4303: $$where=join('.',@pwhere); 4304: $$trolecode=$$role.'.'.$$where; 4305: ($$tstart,$$tend)=split(/\./,$env{$rolekey}); 4306: $$tstatus='is'; 4307: if ($$tstart && $$tstart>$update) { 4308: $$tstatus='future'; 4309: if ($$tstart<$now) { 4310: if ($$tstart && $$tstart>$refresh) { 4311: if (($$where ne '') && ($$role ne '')) { 4312: my (%allroles,%allgroups,$group_privs, 4313: %groups_roles,@rolecodes); 4314: my %userroles = ( 4315: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend 4316: ); 4317: @rolecodes = ('cm'); 4318: my $spec=$$role.'.'.$$where; 4319: my ($tdummy,$tdomain,$trest)=split(/\//,$$where); 4320: if ($$role =~ /^cr\//) { 4321: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where); 4322: push(@rolecodes,'cr'); 4323: } elsif ($$role eq 'gr') { 4324: push(@rolecodes,$$role); 4325: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'}, 4326: $env{'user.name'}); 4327: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2); 4328: (undef,my $group_privs) = split(/\//,$trole); 4329: $group_privs = &unescape($group_privs); 4330: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart); 4331: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1); 4332: &get_groups_roles($tdomain,$trest, 4333: \%course_roles,\@rolecodes, 4334: \%groups_roles); 4335: } else { 4336: push(@rolecodes,$$role); 4337: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where); 4338: } 4339: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles); 4340: &appenv(\%userroles,\@rolecodes); 4341: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4342: } 4343: } 4344: $$tstatus = 'is'; 4345: } 4346: } 4347: if ($$tend) { 4348: if ($$tend<$update) { 4349: $$tstatus='expired'; 4350: } elsif ($$tend<$now) { 4351: $$tstatus='will_not'; 4352: } 4353: } 4354: } 4355: } 4356: } 4357: 4358: sub get_groups_roles { 4359: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_; 4360: return unless((ref($cdom_courseroles) eq 'HASH') && 4361: (ref($rolecodes) eq 'ARRAY') && 4362: (ref($groups_roles) eq 'HASH')); 4363: if (keys(%{$cdom_courseroles}) > 0) { 4364: my ($cnum) = ($rest =~ /^($match_courseid)/); 4365: if ($cdom ne '' && $cnum ne '') { 4366: foreach my $key (keys(%{$cdom_courseroles})) { 4367: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) { 4368: my $crsrole = $1; 4369: my $crssec = $2; 4370: if ($crsrole =~ /^cr/) { 4371: unless (grep(/^cr$/,@{$rolecodes})) { 4372: push(@{$rolecodes},'cr'); 4373: } 4374: } else { 4375: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) { 4376: push(@{$rolecodes},$crsrole); 4377: } 4378: } 4379: my $rolekey = "$crsrole./$cdom/$cnum"; 4380: if ($crssec ne '') { 4381: $rolekey .= "/$crssec"; 4382: } 4383: $rolekey .= './'; 4384: $groups_roles->{$rolekey} = $rolecodes; 4385: } 4386: } 4387: } 4388: } 4389: return; 4390: } 4391: 4392: sub delete_env_groupprivs { 4393: my ($where,$courseroles,$possroles) = @_; 4394: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY')); 4395: my ($dummy,$udom,$uname,$group) = split(/\//,$where); 4396: unless (ref($courseroles->{$udom}) eq 'HASH') { 4397: %{$courseroles->{$udom}} = 4398: &get_my_roles('','','userroles',['active'], 4399: $possroles,[$udom],1); 4400: } 4401: if (ref($courseroles->{$udom}) eq 'HASH') { 4402: foreach my $item (keys(%{$courseroles->{$udom}})) { 4403: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item); 4404: my $area = '/'.$cdom.'/'.$cnum; 4405: my $privkey = "user.priv.$crsrole.$area"; 4406: if ($crssec ne '') { 4407: $privkey .= '/'.$crssec; 4408: } 4409: $privkey .= ".$area/$group"; 4410: &Apache::lonnet::delenv($privkey,undef,[$crsrole]); 4411: } 4412: } 4413: return; 4414: } 4415: 4416: sub check_adhoc_privs { 4417: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_; 4418: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum; 4419: if ($env{$cckey}) { 4420: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend); 4421: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend); 4422: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) { 4423: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller); 4424: } 4425: } else { 4426: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller); 4427: } 4428: } 4429: 4430: sub set_adhoc_privileges { 4431: # role can be cc or ca 4432: my ($dcdom,$pickedcourse,$role,$caller) = @_; 4433: my $area = '/'.$dcdom.'/'.$pickedcourse; 4434: my $spec = $role.'.'.$area; 4435: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'}, 4436: $env{'user.name'}); 4437: my %ccrole = (); 4438: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area); 4439: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole); 4440: &appenv(\%userroles,[$role,'cm']); 4441: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4442: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) { 4443: &appenv( {'request.role' => $spec, 4444: 'request.role.domain' => $dcdom, 4445: 'request.course.sec' => '' 4446: } 4447: ); 4448: my $tadv=0; 4449: if (&allowed('adv') eq 'F') { $tadv=1; } 4450: &appenv({'request.role.adv' => $tadv}); 4451: } 4452: } 4453: 4454: # --------------------------------------------------------------- get interface 4455: 4456: sub get { 4457: my ($namespace,$storearr,$udomain,$uname)=@_; 4458: my $items=''; 4459: foreach my $item (@$storearr) { 4460: $items.=&escape($item).'&'; 4461: } 4462: $items=~s/\&$//; 4463: if (!$udomain) { $udomain=$env{'user.domain'}; } 4464: if (!$uname) { $uname=$env{'user.name'}; } 4465: my $uhome=&homeserver($uname,$udomain); 4466: 4467: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome); 4468: my @pairs=split(/\&/,$rep); 4469: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 4470: return @pairs; 4471: } 4472: my %returnhash=(); 4473: my $i=0; 4474: foreach my $item (@$storearr) { 4475: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4476: $i++; 4477: } 4478: return %returnhash; 4479: } 4480: 4481: # --------------------------------------------------------------- del interface 4482: 4483: sub del { 4484: my ($namespace,$storearr,$udomain,$uname)=@_; 4485: my $items=''; 4486: foreach my $item (@$storearr) { 4487: $items.=&escape($item).'&'; 4488: } 4489: 4490: $items=~s/\&$//; 4491: if (!$udomain) { $udomain=$env{'user.domain'}; } 4492: if (!$uname) { $uname=$env{'user.name'}; } 4493: my $uhome=&homeserver($uname,$udomain); 4494: return &reply("del:$udomain:$uname:$namespace:$items",$uhome); 4495: } 4496: 4497: # -------------------------------------------------------------- dump interface 4498: 4499: sub dump { 4500: my ($namespace,$udomain,$uname,$regexp,$range,$extra)=@_; 4501: if (!$udomain) { $udomain=$env{'user.domain'}; } 4502: if (!$uname) { $uname=$env{'user.name'}; } 4503: my $uhome=&homeserver($uname,$udomain); 4504: if ($regexp) { 4505: $regexp=&escape($regexp); 4506: } else { 4507: $regexp='.'; 4508: } 4509: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range:$extra",$uhome); 4510: my @pairs=split(/\&/,$rep); 4511: my %returnhash=(); 4512: if (!($rep =~ /^error/ )) { 4513: foreach my $item (@pairs) { 4514: my ($key,$value)=split(/=/,$item,2); 4515: $key = &unescape($key); 4516: next if ($key =~ /^error: 2 /); 4517: $returnhash{$key}=&thaw_unescape($value); 4518: } 4519: } 4520: return %returnhash; 4521: } 4522: 4523: 4524: # --------------------------------------------------------- dumpstore interface 4525: 4526: sub dumpstore { 4527: my ($namespace,$udomain,$uname,$regexp,$range)=@_; 4528: if (!$udomain) { $udomain=$env{'user.domain'}; } 4529: if (!$uname) { $uname=$env{'user.name'}; } 4530: my $uhome=&homeserver($uname,$udomain); 4531: if ($regexp) { 4532: $regexp=&escape($regexp); 4533: } else { 4534: $regexp='.'; 4535: } 4536: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome); 4537: my @pairs=split(/\&/,$rep); 4538: my %returnhash=(); 4539: foreach my $item (@pairs) { 4540: my ($key,$value)=split(/=/,$item,2); 4541: next if ($key =~ /^error: 2 /); 4542: $returnhash{$key}=&thaw_unescape($value); 4543: } 4544: return %returnhash; 4545: } 4546: 4547: # -------------------------------------------------------------- keys interface 4548: 4549: sub getkeys { 4550: my ($namespace,$udomain,$uname)=@_; 4551: if (!$udomain) { $udomain=$env{'user.domain'}; } 4552: if (!$uname) { $uname=$env{'user.name'}; } 4553: my $uhome=&homeserver($uname,$udomain); 4554: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome); 4555: my @keyarray=(); 4556: foreach my $key (split(/\&/,$rep)) { 4557: next if ($key =~ /^error: 2 /); 4558: push(@keyarray,&unescape($key)); 4559: } 4560: return @keyarray; 4561: } 4562: 4563: # --------------------------------------------------------------- currentdump 4564: sub currentdump { 4565: my ($courseid,$sdom,$sname)=@_; 4566: $courseid = $env{'request.course.id'} if (! defined($courseid)); 4567: $sdom = $env{'user.domain'} if (! defined($sdom)); 4568: $sname = $env{'user.name'} if (! defined($sname)); 4569: my $uhome = &homeserver($sname,$sdom); 4570: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome); 4571: return if ($rep =~ /^(error:|no_such_host)/); 4572: # 4573: my %returnhash=(); 4574: # 4575: if ($rep eq "unknown_cmd") { 4576: # an old lond will not know currentdump 4577: # Do a dump and make it look like a currentdump 4578: my @tmp = &dumpstore($courseid,$sdom,$sname,'.'); 4579: return if ($tmp[0] =~ /^(error:|no_such_host)/); 4580: my %hash = @tmp; 4581: @tmp=(); 4582: %returnhash = %{&convert_dump_to_currentdump(\%hash)}; 4583: } else { 4584: my @pairs=split(/\&/,$rep); 4585: foreach my $pair (@pairs) { 4586: my ($key,$value)=split(/=/,$pair,2); 4587: my ($symb,$param) = split(/:/,$key); 4588: $returnhash{&unescape($symb)}->{&unescape($param)} = 4589: &thaw_unescape($value); 4590: } 4591: } 4592: return %returnhash; 4593: } 4594: 4595: sub convert_dump_to_currentdump{ 4596: my %hash = %{shift()}; 4597: my %returnhash; 4598: # Code ripped from lond, essentially. The only difference 4599: # here is the unescaping done by lonnet::dump(). Conceivably 4600: # we might run in to problems with parameter names =~ /^v\./ 4601: while (my ($key,$value) = each(%hash)) { 4602: my ($v,$symb,$param) = split(/:/,$key); 4603: $symb = &unescape($symb); 4604: $param = &unescape($param); 4605: next if ($v eq 'version' || $symb eq 'keys'); 4606: next if (exists($returnhash{$symb}) && 4607: exists($returnhash{$symb}->{$param}) && 4608: $returnhash{$symb}->{'v.'.$param} > $v); 4609: $returnhash{$symb}->{$param}=$value; 4610: $returnhash{$symb}->{'v.'.$param}=$v; 4611: } 4612: # 4613: # Remove all of the keys in the hashes which keep track of 4614: # the version of the parameter. 4615: while (my ($symb,$param_hash) = each(%returnhash)) { 4616: # use a foreach because we are going to delete from the hash. 4617: foreach my $key (keys(%$param_hash)) { 4618: delete($param_hash->{$key}) if ($key =~ /^v\./); 4619: } 4620: } 4621: return \%returnhash; 4622: } 4623: 4624: # ------------------------------------------------------ critical inc interface 4625: 4626: sub cinc { 4627: return &inc(@_,'critical'); 4628: } 4629: 4630: # --------------------------------------------------------------- inc interface 4631: 4632: sub inc { 4633: my ($namespace,$store,$udomain,$uname,$critical) = @_; 4634: if (!$udomain) { $udomain=$env{'user.domain'}; } 4635: if (!$uname) { $uname=$env{'user.name'}; } 4636: my $uhome=&homeserver($uname,$udomain); 4637: my $items=''; 4638: if (! ref($store)) { 4639: # got a single value, so use that instead 4640: $items = &escape($store).'=&'; 4641: } elsif (ref($store) eq 'SCALAR') { 4642: $items = &escape($$store).'=&'; 4643: } elsif (ref($store) eq 'ARRAY') { 4644: $items = join('=&',map {&escape($_);} @{$store}); 4645: } elsif (ref($store) eq 'HASH') { 4646: while (my($key,$value) = each(%{$store})) { 4647: $items.= &escape($key).'='.&escape($value).'&'; 4648: } 4649: } 4650: $items=~s/\&$//; 4651: if ($critical) { 4652: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome); 4653: } else { 4654: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome); 4655: } 4656: } 4657: 4658: # --------------------------------------------------------------- put interface 4659: 4660: sub put { 4661: my ($namespace,$storehash,$udomain,$uname)=@_; 4662: if (!$udomain) { $udomain=$env{'user.domain'}; } 4663: if (!$uname) { $uname=$env{'user.name'}; } 4664: my $uhome=&homeserver($uname,$udomain); 4665: my $items=''; 4666: foreach my $item (keys(%$storehash)) { 4667: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4668: } 4669: $items=~s/\&$//; 4670: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4671: } 4672: 4673: # ------------------------------------------------------------ newput interface 4674: 4675: sub newput { 4676: my ($namespace,$storehash,$udomain,$uname)=@_; 4677: if (!$udomain) { $udomain=$env{'user.domain'}; } 4678: if (!$uname) { $uname=$env{'user.name'}; } 4679: my $uhome=&homeserver($uname,$udomain); 4680: my $items=''; 4681: foreach my $key (keys(%$storehash)) { 4682: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 4683: } 4684: $items=~s/\&$//; 4685: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome); 4686: } 4687: 4688: # --------------------------------------------------------- putstore interface 4689: 4690: sub putstore { 4691: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4692: if (!$udomain) { $udomain=$env{'user.domain'}; } 4693: if (!$uname) { $uname=$env{'user.name'}; } 4694: my $uhome=&homeserver($uname,$udomain); 4695: my $items=''; 4696: foreach my $key (keys(%$storehash)) { 4697: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&'; 4698: } 4699: $items=~s/\&$//; 4700: my $esc_symb=&escape($symb); 4701: my $esc_v=&escape($version); 4702: my $reply = 4703: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items", 4704: $uhome); 4705: if ($reply eq 'unknown_cmd') { 4706: # gfall back to way things use to be done 4707: return &old_putstore($namespace,$symb,$version,$storehash,$udomain, 4708: $uname); 4709: } 4710: return $reply; 4711: } 4712: 4713: sub old_putstore { 4714: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4715: if (!$udomain) { $udomain=$env{'user.domain'}; } 4716: if (!$uname) { $uname=$env{'user.name'}; } 4717: my $uhome=&homeserver($uname,$udomain); 4718: my %newstorehash; 4719: foreach my $item (keys(%$storehash)) { 4720: my $key = $version.':'.&escape($symb).':'.$item; 4721: $newstorehash{$key} = $storehash->{$item}; 4722: } 4723: my $items=''; 4724: my %allitems = (); 4725: foreach my $item (keys(%newstorehash)) { 4726: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) { 4727: my $key = $1.':keys:'.$2; 4728: $allitems{$key} .= $3.':'; 4729: } 4730: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&'; 4731: } 4732: foreach my $item (keys(%allitems)) { 4733: $allitems{$item} =~ s/\:$//; 4734: $items.= $item.'='.$allitems{$item}.'&'; 4735: } 4736: $items=~s/\&$//; 4737: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4738: } 4739: 4740: # ------------------------------------------------------ critical put interface 4741: 4742: sub cput { 4743: my ($namespace,$storehash,$udomain,$uname)=@_; 4744: if (!$udomain) { $udomain=$env{'user.domain'}; } 4745: if (!$uname) { $uname=$env{'user.name'}; } 4746: my $uhome=&homeserver($uname,$udomain); 4747: my $items=''; 4748: foreach my $item (keys(%$storehash)) { 4749: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4750: } 4751: $items=~s/\&$//; 4752: return &critical("put:$udomain:$uname:$namespace:$items",$uhome); 4753: } 4754: 4755: # -------------------------------------------------------------- eget interface 4756: 4757: sub eget { 4758: my ($namespace,$storearr,$udomain,$uname)=@_; 4759: my $items=''; 4760: foreach my $item (@$storearr) { 4761: $items.=&escape($item).'&'; 4762: } 4763: $items=~s/\&$//; 4764: if (!$udomain) { $udomain=$env{'user.domain'}; } 4765: if (!$uname) { $uname=$env{'user.name'}; } 4766: my $uhome=&homeserver($uname,$udomain); 4767: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome); 4768: my @pairs=split(/\&/,$rep); 4769: my %returnhash=(); 4770: my $i=0; 4771: foreach my $item (@$storearr) { 4772: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4773: $i++; 4774: } 4775: return %returnhash; 4776: } 4777: 4778: # ------------------------------------------------------------ tmpput interface 4779: sub tmpput { 4780: my ($storehash,$server,$context)=@_; 4781: my $items=''; 4782: foreach my $item (keys(%$storehash)) { 4783: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4784: } 4785: $items=~s/\&$//; 4786: if (defined($context)) { 4787: $items .= ':'.&escape($context); 4788: } 4789: return &reply("tmpput:$items",$server); 4790: } 4791: 4792: # ------------------------------------------------------------ tmpget interface 4793: sub tmpget { 4794: my ($token,$server)=@_; 4795: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4796: my $rep=&reply("tmpget:$token",$server); 4797: my %returnhash; 4798: foreach my $item (split(/\&/,$rep)) { 4799: my ($key,$value)=split(/=/,$item); 4800: next if ($key =~ /^error: 2 /); 4801: $returnhash{&unescape($key)}=&thaw_unescape($value); 4802: } 4803: return %returnhash; 4804: } 4805: 4806: # ------------------------------------------------------------ tmpget interface 4807: sub tmpdel { 4808: my ($token,$server)=@_; 4809: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4810: return &reply("tmpdel:$token",$server); 4811: } 4812: 4813: # -------------------------------------------------- portfolio access checking 4814: 4815: sub portfolio_access { 4816: my ($requrl) = @_; 4817: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl); 4818: my $result = &get_portfolio_access($udom,$unum,$file_name,$group); 4819: if ($result) { 4820: my %setters; 4821: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4822: my ($startblock,$endblock) = 4823: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom); 4824: if ($startblock && $endblock) { 4825: return 'B'; 4826: } 4827: } else { 4828: my ($startblock,$endblock) = 4829: &Apache::loncommon::blockcheck(\%setters,'port'); 4830: if ($startblock && $endblock) { 4831: return 'B'; 4832: } 4833: } 4834: } 4835: if ($result eq 'ok') { 4836: return 'F'; 4837: } elsif ($result =~ /^[^:]+:guest_/) { 4838: return 'A'; 4839: } 4840: return ''; 4841: } 4842: 4843: sub get_portfolio_access { 4844: my ($udom,$unum,$file_name,$group,$access_hash) = @_; 4845: 4846: if (!ref($access_hash)) { 4847: my $current_perms = &get_portfile_permissions($udom,$unum); 4848: my %access_controls = &get_access_controls($current_perms,$group, 4849: $file_name); 4850: $access_hash = $access_controls{$file_name}; 4851: } 4852: 4853: my ($public,$guest,@domains,@users,@courses,@groups); 4854: my $now = time; 4855: if (ref($access_hash) eq 'HASH') { 4856: foreach my $key (keys(%{$access_hash})) { 4857: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 4858: if ($start > $now) { 4859: next; 4860: } 4861: if ($end && $end<$now) { 4862: next; 4863: } 4864: if ($scope eq 'public') { 4865: $public = $key; 4866: last; 4867: } elsif ($scope eq 'guest') { 4868: $guest = $key; 4869: } elsif ($scope eq 'domains') { 4870: push(@domains,$key); 4871: } elsif ($scope eq 'users') { 4872: push(@users,$key); 4873: } elsif ($scope eq 'course') { 4874: push(@courses,$key); 4875: } elsif ($scope eq 'group') { 4876: push(@groups,$key); 4877: } 4878: } 4879: if ($public) { 4880: return 'ok'; 4881: } 4882: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4883: if ($guest) { 4884: return $guest; 4885: } 4886: } else { 4887: if (@domains > 0) { 4888: foreach my $domkey (@domains) { 4889: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') { 4890: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) { 4891: return 'ok'; 4892: } 4893: } 4894: } 4895: } 4896: if (@users > 0) { 4897: foreach my $userkey (@users) { 4898: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') { 4899: foreach my $item (@{$access_hash->{$userkey}{'users'}}) { 4900: if (ref($item) eq 'HASH') { 4901: if (($item->{'uname'} eq $env{'user.name'}) && 4902: ($item->{'udom'} eq $env{'user.domain'})) { 4903: return 'ok'; 4904: } 4905: } 4906: } 4907: } 4908: } 4909: } 4910: my %roleshash; 4911: my @courses_and_groups = @courses; 4912: push(@courses_and_groups,@groups); 4913: if (@courses_and_groups > 0) { 4914: my (%allgroups,%allroles); 4915: my ($start,$end,$role,$sec,$group); 4916: foreach my $envkey (%env) { 4917: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) { 4918: my $cid = $2.'_'.$3; 4919: if ($1 eq 'gr') { 4920: $group = $4; 4921: $allgroups{$cid}{$group} = $env{$envkey}; 4922: } else { 4923: if ($4 eq '') { 4924: $sec = 'none'; 4925: } else { 4926: $sec = $4; 4927: } 4928: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4929: } 4930: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) { 4931: my $cid = $2.'_'.$3; 4932: if ($4 eq '') { 4933: $sec = 'none'; 4934: } else { 4935: $sec = $4; 4936: } 4937: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4938: } 4939: } 4940: if (keys(%allroles) == 0) { 4941: return; 4942: } 4943: foreach my $key (@courses_and_groups) { 4944: my %content = %{$$access_hash{$key}}; 4945: my $cnum = $content{'number'}; 4946: my $cdom = $content{'domain'}; 4947: my $cid = $cdom.'_'.$cnum; 4948: if (!exists($allroles{$cid})) { 4949: next; 4950: } 4951: foreach my $role_id (keys(%{$content{'roles'}})) { 4952: my @sections = @{$content{'roles'}{$role_id}{'section'}}; 4953: my @groups = @{$content{'roles'}{$role_id}{'group'}}; 4954: my @status = @{$content{'roles'}{$role_id}{'access'}}; 4955: my @roles = @{$content{'roles'}{$role_id}{'role'}}; 4956: foreach my $role (keys(%{$allroles{$cid}})) { 4957: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) { 4958: foreach my $sec (keys(%{$allroles{$cid}{$role}})) { 4959: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') { 4960: if (grep/^all$/,@sections) { 4961: return 'ok'; 4962: } else { 4963: if (grep/^$sec$/,@sections) { 4964: return 'ok'; 4965: } 4966: } 4967: } 4968: } 4969: if (keys(%{$allgroups{$cid}}) == 0) { 4970: if (grep/^none$/,@groups) { 4971: return 'ok'; 4972: } 4973: } else { 4974: if (grep/^all$/,@groups) { 4975: return 'ok'; 4976: } 4977: foreach my $group (keys(%{$allgroups{$cid}})) { 4978: if (grep/^$group$/,@groups) { 4979: return 'ok'; 4980: } 4981: } 4982: } 4983: } 4984: } 4985: } 4986: } 4987: } 4988: if ($guest) { 4989: return $guest; 4990: } 4991: } 4992: } 4993: return; 4994: } 4995: 4996: sub course_group_datechecker { 4997: my ($dates,$now,$status) = @_; 4998: my ($start,$end) = split(/\./,$dates); 4999: if (!$start && !$end) { 5000: return 'ok'; 5001: } 5002: if (grep/^active$/,@{$status}) { 5003: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) { 5004: return 'ok'; 5005: } 5006: } 5007: if (grep/^previous$/,@{$status}) { 5008: if ($end > $now ) { 5009: return 'ok'; 5010: } 5011: } 5012: if (grep/^future$/,@{$status}) { 5013: if ($start > $now) { 5014: return 'ok'; 5015: } 5016: } 5017: return; 5018: } 5019: 5020: sub parse_portfolio_url { 5021: my ($url) = @_; 5022: 5023: my ($type,$udom,$unum,$group,$file_name); 5024: 5025: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) { 5026: $type = 1; 5027: $udom = $1; 5028: $unum = $2; 5029: $file_name = $3; 5030: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) { 5031: $type = 2; 5032: $udom = $1; 5033: $unum = $2; 5034: $group = $3; 5035: $file_name = $3.'/'.$4; 5036: } 5037: if (wantarray) { 5038: return ($type,$udom,$unum,$file_name,$group); 5039: } 5040: return $type; 5041: } 5042: 5043: sub is_portfolio_url { 5044: my ($url) = @_; 5045: return scalar(&parse_portfolio_url($url)); 5046: } 5047: 5048: sub is_portfolio_file { 5049: my ($file) = @_; 5050: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) { 5051: return 1; 5052: } 5053: return; 5054: } 5055: 5056: sub usertools_access { 5057: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_; 5058: my ($access,%tools); 5059: if ($context eq '') { 5060: $context = 'tools'; 5061: } 5062: if ($context eq 'requestcourses') { 5063: %tools = ( 5064: official => 1, 5065: unofficial => 1, 5066: community => 1, 5067: ); 5068: } else { 5069: %tools = ( 5070: aboutme => 1, 5071: blog => 1, 5072: portfolio => 1, 5073: ); 5074: } 5075: return if (!defined($tools{$tool})); 5076: 5077: if ((!defined($udom)) || (!defined($uname))) { 5078: $udom = $env{'user.domain'}; 5079: $uname = $env{'user.name'}; 5080: } 5081: 5082: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 5083: if ($action ne 'reload') { 5084: if ($context eq 'requestcourses') { 5085: return $env{'environment.canrequest.'.$tool}; 5086: } else { 5087: return $env{'environment.availabletools.'.$tool}; 5088: } 5089: } 5090: } 5091: 5092: my ($toolstatus,$inststatus); 5093: 5094: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) && 5095: ($action ne 'reload')) { 5096: $toolstatus = $env{'environment.'.$context.'.'.$tool}; 5097: $inststatus = $env{'environment.inststatus'}; 5098: } else { 5099: if (ref($userenvref) eq 'HASH') { 5100: $toolstatus = $userenvref->{$context.'.'.$tool}; 5101: $inststatus = $userenvref->{'inststatus'}; 5102: } else { 5103: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus'); 5104: $toolstatus = $userenv{$context.'.'.$tool}; 5105: $inststatus = $userenv{'inststatus'}; 5106: } 5107: } 5108: 5109: if ($toolstatus ne '') { 5110: if ($toolstatus) { 5111: $access = 1; 5112: } else { 5113: $access = 0; 5114: } 5115: return $access; 5116: } 5117: 5118: my ($is_adv,%domdef); 5119: if (ref($is_advref) eq 'HASH') { 5120: $is_adv = $is_advref->{'is_adv'}; 5121: } else { 5122: $is_adv = &is_advanced_user($udom,$uname); 5123: } 5124: if (ref($domdefref) eq 'HASH') { 5125: %domdef = %{$domdefref}; 5126: } else { 5127: %domdef = &get_domain_defaults($udom); 5128: } 5129: if (ref($domdef{$tool}) eq 'HASH') { 5130: if ($is_adv) { 5131: if ($domdef{$tool}{'_LC_adv'} ne '') { 5132: if ($domdef{$tool}{'_LC_adv'}) { 5133: $access = 1; 5134: } else { 5135: $access = 0; 5136: } 5137: return $access; 5138: } 5139: } 5140: if ($inststatus ne '') { 5141: my ($hasaccess,$hasnoaccess); 5142: foreach my $affiliation (split(/:/,$inststatus)) { 5143: if ($domdef{$tool}{$affiliation} ne '') { 5144: if ($domdef{$tool}{$affiliation}) { 5145: $hasaccess = 1; 5146: } else { 5147: $hasnoaccess = 1; 5148: } 5149: } 5150: } 5151: if ($hasaccess || $hasnoaccess) { 5152: if ($hasaccess) { 5153: $access = 1; 5154: } elsif ($hasnoaccess) { 5155: $access = 0; 5156: } 5157: return $access; 5158: } 5159: } else { 5160: if ($domdef{$tool}{'default'} ne '') { 5161: if ($domdef{$tool}{'default'}) { 5162: $access = 1; 5163: } elsif ($domdef{$tool}{'default'} == 0) { 5164: $access = 0; 5165: } 5166: return $access; 5167: } 5168: } 5169: } else { 5170: if ($context eq 'tools') { 5171: $access = 1; 5172: } else { 5173: $access = 0; 5174: } 5175: return $access; 5176: } 5177: } 5178: 5179: sub is_course_owner { 5180: my ($cdom,$cnum,$udom,$uname) = @_; 5181: if (($udom eq '') || ($uname eq '')) { 5182: $udom = $env{'user.domain'}; 5183: $uname = $env{'user.name'}; 5184: } 5185: unless (($udom eq '') || ($uname eq '')) { 5186: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) { 5187: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) { 5188: return 1; 5189: } else { 5190: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum); 5191: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) { 5192: return 1; 5193: } 5194: } 5195: } 5196: } 5197: return; 5198: } 5199: 5200: sub is_advanced_user { 5201: my ($udom,$uname) = @_; 5202: if ($udom ne '' && $uname ne '') { 5203: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 5204: return $env{'user.adv'}; 5205: } 5206: } 5207: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1); 5208: my %allroles; 5209: my $is_adv; 5210: foreach my $role (keys(%roleshash)) { 5211: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role); 5212: my $area = '/'.$tdomain.'/'.$trest; 5213: if ($sec ne '') { 5214: $area .= '/'.$sec; 5215: } 5216: if (($area ne '') && ($trole ne '')) { 5217: my $spec=$trole.'.'.$area; 5218: if ($trole =~ /^cr\//) { 5219: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 5220: } elsif ($trole ne 'gr') { 5221: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 5222: } 5223: } 5224: } 5225: foreach my $role (keys(%allroles)) { 5226: last if ($is_adv); 5227: foreach my $item (split(/:/,$allroles{$role})) { 5228: if ($item ne '') { 5229: my ($privilege,$restrictions)=split(/&/,$item); 5230: if ($privilege eq 'adv') { 5231: $is_adv = 1; 5232: last; 5233: } 5234: } 5235: } 5236: } 5237: return $is_adv; 5238: } 5239: 5240: sub check_can_request { 5241: my ($dom,$can_request,$request_domains) = @_; 5242: my $canreq = 0; 5243: my ($types,$typename) = &Apache::loncommon::course_types(); 5244: my @options = ('approval','validate','autolimit'); 5245: my $optregex = join('|',@options); 5246: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) { 5247: foreach my $type (@{$types}) { 5248: if (&usertools_access($env{'user.name'}, 5249: $env{'user.domain'}, 5250: $type,undef,'requestcourses')) { 5251: $canreq ++; 5252: if (ref($request_domains) eq 'HASH') { 5253: push(@{$request_domains->{$type}},$env{'user.domain'}); 5254: } 5255: if ($dom eq $env{'user.domain'}) { 5256: $can_request->{$type} = 1; 5257: } 5258: } 5259: if ($env{'environment.reqcrsotherdom.'.$type} ne '') { 5260: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type}); 5261: if (@curr > 0) { 5262: foreach my $item (@curr) { 5263: if (ref($request_domains) eq 'HASH') { 5264: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/); 5265: if ($otherdom ne '') { 5266: if (ref($request_domains->{$type}) eq 'ARRAY') { 5267: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) { 5268: push(@{$request_domains->{$type}},$otherdom); 5269: } 5270: } else { 5271: push(@{$request_domains->{$type}},$otherdom); 5272: } 5273: } 5274: } 5275: } 5276: unless($dom eq $env{'user.domain'}) { 5277: $canreq ++; 5278: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) { 5279: $can_request->{$type} = 1; 5280: } 5281: } 5282: } 5283: } 5284: } 5285: } 5286: return $canreq; 5287: } 5288: 5289: # ---------------------------------------------- Custom access rule evaluation 5290: 5291: sub customaccess { 5292: my ($priv,$uri)=@_; 5293: my ($urole,$urealm)=split(/\./,$env{'request.role'},2); 5294: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm); 5295: $udom = &LONCAPA::clean_domain($udom); 5296: $ucrs = &LONCAPA::clean_username($ucrs); 5297: my $access=0; 5298: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) { 5299: my ($effect,$realm,$role,$type)=split(/\:/,$right); 5300: if ($type eq 'user') { 5301: foreach my $scope (split(/\s*\,\s*/,$realm)) { 5302: my ($tdom,$tuname)=split(m{/},$scope); 5303: if ($tdom) { 5304: if ($tdom ne $env{'user.domain'}) { next; } 5305: } 5306: if ($tuname) { 5307: if ($tuname ne $env{'user.name'}) { next; } 5308: } 5309: $access=($effect eq 'allow'); 5310: last; 5311: } 5312: } else { 5313: if ($role) { 5314: if ($role ne $urole) { next; } 5315: } 5316: foreach my $scope (split(/\s*\,\s*/,$realm)) { 5317: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope); 5318: if ($tdom) { 5319: if ($tdom ne $udom) { next; } 5320: } 5321: if ($tcrs) { 5322: if ($tcrs ne $ucrs) { next; } 5323: } 5324: if ($tsec) { 5325: if ($tsec ne $usec) { next; } 5326: } 5327: $access=($effect eq 'allow'); 5328: last; 5329: } 5330: if ($realm eq '' && $role eq '') { 5331: $access=($effect eq 'allow'); 5332: } 5333: } 5334: } 5335: return $access; 5336: } 5337: 5338: # ------------------------------------------------- Check for a user privilege 5339: 5340: sub allowed { 5341: my ($priv,$uri,$symb,$role)=@_; 5342: my $ver_orguri=$uri; 5343: $uri=&deversion($uri); 5344: my $orguri=$uri; 5345: $uri=&declutter($uri); 5346: 5347: if ($priv eq 'evb') { 5348: # Evade communication block restrictions for specified role in a course 5349: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) { 5350: return $1; 5351: } else { 5352: return; 5353: } 5354: } 5355: 5356: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; } 5357: # Free bre access to adm and meta resources 5358: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$})) 5359: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 5360: && ($priv eq 'bre')) { 5361: return 'F'; 5362: } 5363: 5364: # Free bre access to user's own portfolio contents 5365: my ($space,$domain,$name,@dir)=split('/',$uri); 5366: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 5367: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) { 5368: my %setters; 5369: my ($startblock,$endblock) = 5370: &Apache::loncommon::blockcheck(\%setters,'port'); 5371: if ($startblock && $endblock) { 5372: return 'B'; 5373: } else { 5374: return 'F'; 5375: } 5376: } 5377: 5378: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course. 5379: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 5380: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) { 5381: if (exists($env{'request.course.id'})) { 5382: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 5383: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 5384: if (($domain eq $cdom) && ($name eq $cnum)) { 5385: my $courseprivid=$env{'request.course.id'}; 5386: $courseprivid=~s/\_/\//; 5387: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid 5388: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) { 5389: return $1; 5390: } else { 5391: if ($env{'request.course.sec'}) { 5392: $courseprivid.='/'.$env{'request.course.sec'}; 5393: } 5394: if ($env{'user.priv.'.$env{'request.role'}.'./'. 5395: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) { 5396: return $2; 5397: } 5398: } 5399: } 5400: } 5401: } 5402: 5403: # Free bre to public access 5404: 5405: if ($priv eq 'bre') { 5406: my $copyright=&metadata($uri,'copyright'); 5407: if (($copyright eq 'public') && (!$env{'request.course.id'})) { 5408: return 'F'; 5409: } 5410: if ($copyright eq 'priv') { 5411: $uri=~/([^\/]+)\/([^\/]+)\//; 5412: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) { 5413: return ''; 5414: } 5415: } 5416: if ($copyright eq 'domain') { 5417: $uri=~/([^\/]+)\/([^\/]+)\//; 5418: unless (($env{'user.domain'} eq $1) || 5419: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) { 5420: return ''; 5421: } 5422: } 5423: if ($env{'request.role'}=~ /li\.\//) { 5424: # Library role, so allow browsing of resources in this domain. 5425: return 'F'; 5426: } 5427: if ($copyright eq 'custom') { 5428: unless (&customaccess($priv,$uri)) { return ''; } 5429: } 5430: } 5431: # Domain coordinator is trying to create a course 5432: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) { 5433: # uri is the requested domain in this case. 5434: # comparison to 'request.role.domain' shows if the user has selected 5435: # a role of dc for the domain in question. 5436: return 'F' if ($uri eq $env{'request.role.domain'}); 5437: } 5438: 5439: my $thisallowed=''; 5440: my $statecond=0; 5441: my $courseprivid=''; 5442: 5443: my $ownaccess; 5444: # Community Coordinator or Assistant Co-author browsing resource space. 5445: if (($priv eq 'bro') && ($env{'user.author'})) { 5446: if ($uri eq '') { 5447: $ownaccess = 1; 5448: } else { 5449: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) { 5450: my $udom = $env{'user.domain'}; 5451: my $uname = $env{'user.name'}; 5452: if ($uri =~ m{^\Q$udom\E/?$}) { 5453: $ownaccess = 1; 5454: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) { 5455: unless ($uri =~ m{\.\./}) { 5456: $ownaccess = 1; 5457: } 5458: } elsif (($udom ne 'public') && ($uname ne 'public')) { 5459: my $now = time; 5460: if ($uri =~ m{^([^/]+)/?$}) { 5461: my $adom = $1; 5462: foreach my $key (keys(%env)) { 5463: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) { 5464: my ($start,$end) = split('.',$env{$key}); 5465: if (($now >= $start) && (!$end || $end < $now)) { 5466: $ownaccess = 1; 5467: last; 5468: } 5469: } 5470: } 5471: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) { 5472: my $adom = $1; 5473: my $aname = $2; 5474: foreach my $role ('ca','aa') { 5475: if ($env{"user.role.$role./$adom/$aname"}) { 5476: my ($start,$end) = 5477: split('.',$env{"user.role.$role./$adom/$aname"}); 5478: if (($now >= $start) && (!$end || $end < $now)) { 5479: $ownaccess = 1; 5480: last; 5481: } 5482: } 5483: } 5484: } 5485: } 5486: } 5487: } 5488: } 5489: 5490: # Course 5491: 5492: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) { 5493: unless (($priv eq 'bro') && (!$ownaccess)) { 5494: $thisallowed.=$1; 5495: } 5496: } 5497: 5498: # Domain 5499: 5500: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'} 5501: =~/\Q$priv\E\&([^\:]*)/) { 5502: unless (($priv eq 'bro') && (!$ownaccess)) { 5503: $thisallowed.=$1; 5504: } 5505: } 5506: 5507: # Course: uri itself is a course 5508: my $courseuri=$uri; 5509: $courseuri=~s/\_(\d)/\/$1/; 5510: $courseuri=~s/^([^\/])/\/$1/; 5511: 5512: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri} 5513: =~/\Q$priv\E\&([^\:]*)/) { 5514: unless (($priv eq 'bro') && (!$ownaccess)) { 5515: $thisallowed.=$1; 5516: } 5517: } 5518: 5519: # URI is an uploaded document for this course, default permissions don't matter 5520: # not allowing 'edit' access (editupload) to uploaded course docs 5521: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) { 5522: $thisallowed=''; 5523: my ($match)=&is_on_map($uri); 5524: if ($match) { 5525: if ($env{'user.priv.'.$env{'request.role'}.'./'} 5526: =~/\Q$priv\E\&([^\:]*)/) { 5527: $thisallowed.=$1; 5528: } 5529: } else { 5530: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri}; 5531: if ($refuri) { 5532: if ($refuri =~ m|^/adm/|) { 5533: $thisallowed='F'; 5534: } else { 5535: $refuri=&declutter($refuri); 5536: my ($match) = &is_on_map($refuri); 5537: if ($match) { 5538: $thisallowed='F'; 5539: } 5540: } 5541: } 5542: } 5543: } 5544: 5545: if ($priv eq 'bre' 5546: && $thisallowed ne 'F' 5547: && $thisallowed ne '2' 5548: && &is_portfolio_url($uri)) { 5549: $thisallowed = &portfolio_access($uri); 5550: } 5551: 5552: # Full access at system, domain or course-wide level? Exit. 5553: if ($thisallowed=~/F/) { 5554: return 'F'; 5555: } 5556: 5557: # If this is generating or modifying users, exit with special codes 5558: 5559: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) { 5560: if (($priv eq 'cca') || ($priv eq 'caa')) { 5561: my ($audom,$auname)=split('/',$uri); 5562: # no author name given, so this just checks on the general right to make a co-author in this domain 5563: unless ($auname) { return $thisallowed; } 5564: # an author name is given, so we are about to actually make a co-author for a certain account 5565: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) || 5566: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) && 5567: ($audom ne $env{'request.role.domain'}))) { return ''; } 5568: } 5569: return $thisallowed; 5570: } 5571: # 5572: # Gathered so far: system, domain and course wide privileges 5573: # 5574: # Course: See if uri or referer is an individual resource that is part of 5575: # the course 5576: 5577: if ($env{'request.course.id'}) { 5578: 5579: $courseprivid=$env{'request.course.id'}; 5580: if ($env{'request.course.sec'}) { 5581: $courseprivid.='/'.$env{'request.course.sec'}; 5582: } 5583: $courseprivid=~s/\_/\//; 5584: my $checkreferer=1; 5585: my ($match,$cond)=&is_on_map($uri); 5586: if ($match) { 5587: $statecond=$cond; 5588: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5589: =~/\Q$priv\E\&([^\:]*)/) { 5590: $thisallowed.=$1; 5591: $checkreferer=0; 5592: } 5593: } 5594: 5595: if ($checkreferer) { 5596: my $refuri=$env{'httpref.'.$orguri}; 5597: unless ($refuri) { 5598: foreach my $key (keys(%env)) { 5599: if ($key=~/^httpref\..*\*/) { 5600: my $pattern=$key; 5601: $pattern=~s/^httpref\.\/res\///; 5602: $pattern=~s/\*/\[\^\/\]\+/g; 5603: $pattern=~s/\//\\\//g; 5604: if ($orguri=~/$pattern/) { 5605: $refuri=$env{$key}; 5606: } 5607: } 5608: } 5609: } 5610: 5611: if ($refuri) { 5612: $refuri=&declutter($refuri); 5613: my ($match,$cond)=&is_on_map($refuri); 5614: if ($match) { 5615: my $refstatecond=$cond; 5616: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5617: =~/\Q$priv\E\&([^\:]*)/) { 5618: $thisallowed.=$1; 5619: $uri=$refuri; 5620: $statecond=$refstatecond; 5621: } 5622: } 5623: } 5624: } 5625: } 5626: 5627: # 5628: # Gathered now: all privileges that could apply, and condition number 5629: # 5630: # 5631: # Full or no access? 5632: # 5633: 5634: if ($thisallowed=~/F/) { 5635: return 'F'; 5636: } 5637: 5638: unless ($thisallowed) { 5639: return ''; 5640: } 5641: 5642: # Restrictions exist, deal with them 5643: # 5644: # C:according to course preferences 5645: # R:according to resource settings 5646: # L:unless locked 5647: # X:according to user session state 5648: # 5649: 5650: # Possibly locked functionality, check all courses 5651: # Locks might take effect only after 10 minutes cache expiration for other 5652: # courses, and 2 minutes for current course 5653: 5654: my $envkey; 5655: if ($thisallowed=~/L/) { 5656: foreach $envkey (keys(%env)) { 5657: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) { 5658: my $courseid=$2; 5659: my $roleid=$1.'.'.$2; 5660: $courseid=~s/^\///; 5661: my $expiretime=600; 5662: if ($env{'request.role'} eq $roleid) { 5663: $expiretime=120; 5664: } 5665: my ($cdom,$cnum,$csec)=split(/\//,$courseid); 5666: my $prefix='course.'.$cdom.'_'.$cnum.'.'; 5667: if ((time-$env{$prefix.'last_cache'})>$expiretime) { 5668: &coursedescription($courseid,{'freshen_cache' => 1}); 5669: } 5670: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/) 5671: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) { 5672: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) { 5673: &log($env{'user.domain'},$env{'user.name'}, 5674: $env{'user.home'}, 5675: 'Locked by res: '.$priv.' for '.$uri.' due to '. 5676: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5677: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5678: return ''; 5679: } 5680: } 5681: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/) 5682: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) { 5683: if ($env{'priv.'.$priv.'.lock.expire'}>time) { 5684: &log($env{'user.domain'},$env{'user.name'}, 5685: $env{'user.home'}, 5686: 'Locked by priv: '.$priv.' for '.$uri.' due to '. 5687: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5688: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5689: return ''; 5690: } 5691: } 5692: } 5693: } 5694: } 5695: 5696: # 5697: # Rest of the restrictions depend on selected course 5698: # 5699: 5700: unless ($env{'request.course.id'}) { 5701: if ($thisallowed eq 'A') { 5702: return 'A'; 5703: } elsif ($thisallowed eq 'B') { 5704: return 'B'; 5705: } else { 5706: return '1'; 5707: } 5708: } 5709: 5710: # 5711: # Now user is definitely in a course 5712: # 5713: 5714: 5715: # Course preferences 5716: 5717: if ($thisallowed=~/C/) { 5718: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5719: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'}; 5720: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'} 5721: =~/\Q$rolecode\E/) { 5722: if (($priv ne 'pch') && ($priv ne 'plc')) { 5723: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5724: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '. 5725: $env{'request.course.id'}); 5726: } 5727: return ''; 5728: } 5729: 5730: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'} 5731: =~/\Q$unamedom\E/) { 5732: if (($priv ne 'pch') && ($priv ne 'plc')) { 5733: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}. 5734: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '. 5735: $env{'request.course.id'}); 5736: } 5737: return ''; 5738: } 5739: } 5740: 5741: # Resource preferences 5742: 5743: if ($thisallowed=~/R/) { 5744: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5745: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) { 5746: if (($priv ne 'pch') && ($priv ne 'plc')) { 5747: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5748: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode); 5749: } 5750: return ''; 5751: } 5752: } 5753: 5754: # Restricted by state or randomout? 5755: 5756: if ($thisallowed=~/X/) { 5757: if ($env{'acc.randomout'}) { 5758: if (!$symb) { $symb=&symbread($uri,1); } 5759: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 5760: return ''; 5761: } 5762: } 5763: if (&condval($statecond)) { 5764: return '2'; 5765: } else { 5766: return ''; 5767: } 5768: } 5769: 5770: if ($thisallowed eq 'A') { 5771: return 'A'; 5772: } elsif ($thisallowed eq 'B') { 5773: return 'B'; 5774: } 5775: return 'F'; 5776: } 5777: 5778: sub split_uri_for_cond { 5779: my $uri=&deversion(&declutter(shift)); 5780: my @uriparts=split(/\//,$uri); 5781: my $filename=pop(@uriparts); 5782: my $pathname=join('/',@uriparts); 5783: return ($pathname,$filename); 5784: } 5785: # --------------------------------------------------- Is a resource on the map? 5786: 5787: sub is_on_map { 5788: my ($pathname,$filename) = &split_uri_for_cond(shift); 5789: #Trying to find the conditional for the file 5790: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~ 5791: /\&\Q$filename\E\:([\d\|]+)\&/); 5792: if ($match) { 5793: return (1,$1); 5794: } else { 5795: return (0,0); 5796: } 5797: } 5798: 5799: # --------------------------------------------------------- Get symb from alias 5800: 5801: sub get_symb_from_alias { 5802: my $symb=shift; 5803: my ($map,$resid,$url)=&decode_symb($symb); 5804: # Already is a symb 5805: if ($url) { return $symb; } 5806: # Must be an alias 5807: my $aliassymb=''; 5808: my %bighash; 5809: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 5810: &GDBM_READER(),0640)) { 5811: my $rid=$bighash{'mapalias_'.$symb}; 5812: if ($rid) { 5813: my ($mapid,$resid)=split(/\./,$rid); 5814: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid}, 5815: $resid,$bighash{'src_'.$rid}); 5816: } 5817: untie %bighash; 5818: } 5819: return $aliassymb; 5820: } 5821: 5822: # ----------------------------------------------------------------- Define Role 5823: 5824: sub definerole { 5825: if (allowed('mcr','/')) { 5826: my ($rolename,$sysrole,$domrole,$courole)=@_; 5827: foreach my $role (split(':',$sysrole)) { 5828: my ($crole,$cqual)=split(/\&/,$role); 5829: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; } 5830: if ($pr{'cr:s'}=~/\Q$crole\E\&/) { 5831: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5832: return "refused:s:$crole&$cqual"; 5833: } 5834: } 5835: } 5836: foreach my $role (split(':',$domrole)) { 5837: my ($crole,$cqual)=split(/\&/,$role); 5838: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; } 5839: if ($pr{'cr:d'}=~/\Q$crole\E\&/) { 5840: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 5841: return "refused:d:$crole&$cqual"; 5842: } 5843: } 5844: } 5845: foreach my $role (split(':',$courole)) { 5846: my ($crole,$cqual)=split(/\&/,$role); 5847: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; } 5848: if ($pr{'cr:c'}=~/\Q$crole\E\&/) { 5849: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5850: return "refused:c:$crole&$cqual"; 5851: } 5852: } 5853: } 5854: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 5855: "$env{'user.domain'}:$env{'user.name'}:". 5856: "rolesdef_$rolename=". 5857: escape($sysrole.'_'.$domrole.'_'.$courole); 5858: return reply($command,$env{'user.home'}); 5859: } else { 5860: return 'refused'; 5861: } 5862: } 5863: 5864: # ---------------- Make a metadata query against the network of library servers 5865: 5866: sub metadata_query { 5867: my ($query,$custom,$customshow,$server_array)=@_; 5868: my %rhash; 5869: my %libserv = &all_library(); 5870: my @server_list = (defined($server_array) ? @$server_array 5871: : keys(%libserv) ); 5872: for my $server (@server_list) { 5873: unless ($custom or $customshow) { 5874: my $reply=&reply("querysend:".&escape($query),$server); 5875: $rhash{$server}=$reply; 5876: } 5877: else { 5878: my $reply=&reply("querysend:".&escape($query).':'. 5879: &escape($custom).':'.&escape($customshow), 5880: $server); 5881: $rhash{$server}=$reply; 5882: } 5883: } 5884: return \%rhash; 5885: } 5886: 5887: # ----------------------------------------- Send log queries and wait for reply 5888: 5889: sub log_query { 5890: my ($uname,$udom,$query,%filters)=@_; 5891: my $uhome=&homeserver($uname,$udom); 5892: if ($uhome eq 'no_host') { return 'error: no_host'; } 5893: my $uhost=&hostname($uhome); 5894: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters))); 5895: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command, 5896: $uhome); 5897: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; } 5898: return get_query_reply($queryid); 5899: } 5900: 5901: # -------------------------- Update MySQL table for portfolio file 5902: 5903: sub update_portfolio_table { 5904: my ($uname,$udom,$file_name,$query,$group,$action) = @_; 5905: if ($group ne '') { 5906: $file_name =~s /^\Q$group\E//; 5907: } 5908: my $homeserver = &homeserver($uname,$udom); 5909: my $queryid= 5910: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group). 5911: ':'.&escape($file_name).':'.$action,$homeserver); 5912: my $reply = &get_query_reply($queryid); 5913: return $reply; 5914: } 5915: 5916: # -------------------------- Update MySQL allusers table 5917: 5918: sub update_allusers_table { 5919: my ($uname,$udom,$names) = @_; 5920: my $homeserver = &homeserver($uname,$udom); 5921: my $queryid= 5922: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'. 5923: 'lastname='.&escape($names->{'lastname'}).'%%'. 5924: 'firstname='.&escape($names->{'firstname'}).'%%'. 5925: 'middlename='.&escape($names->{'middlename'}).'%%'. 5926: 'generation='.&escape($names->{'generation'}).'%%'. 5927: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'. 5928: 'id='.&escape($names->{'id'}),$homeserver); 5929: return; 5930: } 5931: 5932: # ------- Request retrieval of institutional classlists for course(s) 5933: 5934: sub fetch_enrollment_query { 5935: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_; 5936: my $homeserver; 5937: my $maxtries = 1; 5938: if ($context eq 'automated') { 5939: $homeserver = $perlvar{'lonHostID'}; 5940: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout 5941: } else { 5942: $homeserver = &homeserver($cnum,$dom); 5943: } 5944: my $host=&hostname($homeserver); 5945: my $cmd = ''; 5946: foreach my $affiliate (keys(%{$affiliatesref})) { 5947: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 5948: } 5949: $cmd =~ s/%%$//; 5950: $cmd = &escape($cmd); 5951: my $query = 'fetchenrollment'; 5952: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver); 5953: unless ($queryid=~/^\Q$host\E\_/) { 5954: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 5955: return 'error: '.$queryid; 5956: } 5957: my $reply = &get_query_reply($queryid); 5958: my $tries = 1; 5959: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 5960: $reply = &get_query_reply($queryid); 5961: $tries ++; 5962: } 5963: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 5964: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 5965: } else { 5966: my @responses = split(/:/,$reply); 5967: if ($homeserver eq $perlvar{'lonHostID'}) { 5968: foreach my $line (@responses) { 5969: my ($key,$value) = split(/=/,$line,2); 5970: $$replyref{$key} = $value; 5971: } 5972: } else { 5973: my $pathname = $perlvar{'lonDaemons'}.'/tmp'; 5974: foreach my $line (@responses) { 5975: my ($key,$value) = split(/=/,$line); 5976: $$replyref{$key} = $value; 5977: if ($value > 0) { 5978: foreach my $item (@{$$affiliatesref{$key}}) { 5979: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml'; 5980: my $destname = $pathname.'/'.$filename; 5981: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver); 5982: if ($xml_classlist =~ /^error/) { 5983: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum); 5984: } else { 5985: if ( open(FILE,">$destname") ) { 5986: print FILE &unescape($xml_classlist); 5987: close(FILE); 5988: } else { 5989: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum); 5990: } 5991: } 5992: } 5993: } 5994: } 5995: } 5996: return 'ok'; 5997: } 5998: return 'error'; 5999: } 6000: 6001: sub get_query_reply { 6002: my $queryid=shift; 6003: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid; 6004: my $reply=''; 6005: for (1..100) { 6006: sleep 2; 6007: if (-e $replyfile.'.end') { 6008: if (open(my $fh,$replyfile)) { 6009: $reply = join('',<$fh>); 6010: close($fh); 6011: } else { return 'error: reply_file_error'; } 6012: return &unescape($reply); 6013: } 6014: } 6015: return 'timeout:'.$queryid; 6016: } 6017: 6018: sub courselog_query { 6019: # 6020: # possible filters: 6021: # url: url or symb 6022: # username 6023: # domain 6024: # action: view, submit, grade 6025: # start: timestamp 6026: # end: timestamp 6027: # 6028: my (%filters)=@_; 6029: unless ($env{'request.course.id'}) { return 'no_course'; } 6030: if ($filters{'url'}) { 6031: $filters{'url'}=&symbclean(&declutter($filters{'url'})); 6032: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/; 6033: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/; 6034: } 6035: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'}; 6036: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 6037: return &log_query($cname,$cdom,'courselog',%filters); 6038: } 6039: 6040: sub userlog_query { 6041: # 6042: # possible filters: 6043: # action: log check role 6044: # start: timestamp 6045: # end: timestamp 6046: # 6047: my ($uname,$udom,%filters)=@_; 6048: return &log_query($uname,$udom,'userlog',%filters); 6049: } 6050: 6051: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 6052: 6053: sub auto_run { 6054: my ($cnum,$cdom) = @_; 6055: my $response = 0; 6056: my $settings; 6057: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom); 6058: if (ref($domconfig{'autoenroll'}) eq 'HASH') { 6059: $settings = $domconfig{'autoenroll'}; 6060: if ($settings->{'run'} eq '1') { 6061: $response = 1; 6062: } 6063: } else { 6064: my $homeserver; 6065: if (&is_course($cdom,$cnum)) { 6066: $homeserver = &homeserver($cnum,$cdom); 6067: } else { 6068: $homeserver = &domain($cdom,'primary'); 6069: } 6070: if ($homeserver ne 'no_host') { 6071: $response = &reply('autorun:'.$cdom,$homeserver); 6072: } 6073: } 6074: return $response; 6075: } 6076: 6077: sub auto_get_sections { 6078: my ($cnum,$cdom,$inst_coursecode) = @_; 6079: my $homeserver; 6080: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6081: $homeserver = &homeserver($cnum,$cdom); 6082: } 6083: if (!defined($homeserver)) { 6084: if ($cdom =~ /^$match_domain$/) { 6085: $homeserver = &domain($cdom,'primary'); 6086: } 6087: } 6088: my @secs; 6089: if (defined($homeserver)) { 6090: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver)); 6091: unless ($response eq 'refused') { 6092: @secs = split(/:/,$response); 6093: } 6094: } 6095: return @secs; 6096: } 6097: 6098: sub auto_new_course { 6099: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_; 6100: my $homeserver = &homeserver($cnum,$cdom); 6101: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver)); 6102: return $response; 6103: } 6104: 6105: sub auto_validate_courseID { 6106: my ($cnum,$cdom,$inst_course_id) = @_; 6107: my $homeserver = &homeserver($cnum,$cdom); 6108: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver)); 6109: return $response; 6110: } 6111: 6112: sub auto_validate_instcode { 6113: my ($cnum,$cdom,$instcode,$owner) = @_; 6114: my ($homeserver,$response); 6115: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6116: $homeserver = &homeserver($cnum,$cdom); 6117: } 6118: if (!defined($homeserver)) { 6119: if ($cdom =~ /^$match_domain$/) { 6120: $homeserver = &domain($cdom,'primary'); 6121: } 6122: } 6123: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'. 6124: &escape($instcode).':'.&escape($owner),$homeserver)); 6125: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2); 6126: return ($outcome,$description); 6127: } 6128: 6129: sub auto_create_password { 6130: my ($cnum,$cdom,$authparam,$udom) = @_; 6131: my ($homeserver,$response); 6132: my $create_passwd = 0; 6133: my $authchk = ''; 6134: if ($udom =~ /^$match_domain$/) { 6135: $homeserver = &domain($udom,'primary'); 6136: } 6137: if ($homeserver eq '') { 6138: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6139: $homeserver = &homeserver($cnum,$cdom); 6140: } 6141: } 6142: if ($homeserver eq '') { 6143: $authchk = 'nodomain'; 6144: } else { 6145: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver)); 6146: if ($response eq 'refused') { 6147: $authchk = 'refused'; 6148: } else { 6149: ($authparam,$create_passwd,$authchk) = split(/:/,$response); 6150: } 6151: } 6152: return ($authparam,$create_passwd,$authchk); 6153: } 6154: 6155: sub auto_photo_permission { 6156: my ($cnum,$cdom,$students) = @_; 6157: my $homeserver = &homeserver($cnum,$cdom); 6158: my ($outcome,$perm_reqd,$conditions) = 6159: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3); 6160: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6161: return (undef,undef); 6162: } 6163: return ($outcome,$perm_reqd,$conditions); 6164: } 6165: 6166: sub auto_checkphotos { 6167: my ($uname,$udom,$pid) = @_; 6168: my $homeserver = &homeserver($uname,$udom); 6169: my ($result,$resulttype); 6170: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'. 6171: &escape($uname).':'.&escape($pid), 6172: $homeserver)); 6173: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6174: return (undef,undef); 6175: } 6176: if ($outcome) { 6177: ($result,$resulttype) = split(/:/,$outcome); 6178: } 6179: return ($result,$resulttype); 6180: } 6181: 6182: sub auto_photochoice { 6183: my ($cnum,$cdom) = @_; 6184: my $homeserver = &homeserver($cnum,$cdom); 6185: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'. 6186: &escape($cdom), 6187: $homeserver))); 6188: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6189: return (undef,undef); 6190: } 6191: return ($update,$comment); 6192: } 6193: 6194: sub auto_photoupdate { 6195: my ($affiliatesref,$dom,$cnum,$photo) = @_; 6196: my $homeserver = &homeserver($cnum,$dom); 6197: my $host=&hostname($homeserver); 6198: my $cmd = ''; 6199: my $maxtries = 1; 6200: foreach my $affiliate (keys(%{$affiliatesref})) { 6201: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 6202: } 6203: $cmd =~ s/%%$//; 6204: $cmd = &escape($cmd); 6205: my $query = 'institutionalphotos'; 6206: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver); 6207: unless ($queryid=~/^\Q$host\E\_/) { 6208: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum); 6209: return 'error: '.$queryid; 6210: } 6211: my $reply = &get_query_reply($queryid); 6212: my $tries = 1; 6213: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 6214: $reply = &get_query_reply($queryid); 6215: $tries ++; 6216: } 6217: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 6218: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 6219: } else { 6220: my @responses = split(/:/,$reply); 6221: my $outcome = shift(@responses); 6222: foreach my $item (@responses) { 6223: my ($key,$value) = split(/=/,$item); 6224: $$photo{$key} = $value; 6225: } 6226: return $outcome; 6227: } 6228: return 'error'; 6229: } 6230: 6231: sub auto_instcode_format { 6232: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles, 6233: $cat_order) = @_; 6234: my $courses = ''; 6235: my @homeservers; 6236: if ($caller eq 'global') { 6237: my %servers = &get_servers($codedom,'library'); 6238: foreach my $tryserver (keys(%servers)) { 6239: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6240: push(@homeservers,$tryserver); 6241: } 6242: } 6243: } elsif ($caller eq 'requests') { 6244: if ($codedom =~ /^$match_domain$/) { 6245: my $chome = &domain($codedom,'primary'); 6246: unless ($chome eq 'no_host') { 6247: push(@homeservers,$chome); 6248: } 6249: } 6250: } else { 6251: push(@homeservers,&homeserver($caller,$codedom)); 6252: } 6253: foreach my $code (keys(%{$instcodes})) { 6254: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&'; 6255: } 6256: chop($courses); 6257: my $ok_response = 0; 6258: my $response; 6259: while (@homeservers > 0 && $ok_response == 0) { 6260: my $server = shift(@homeservers); 6261: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server); 6262: if ($response !~ /(con_lost|error|no_such_host|refused)/) { 6263: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 6264: split(/:/,$response); 6265: %{$codes} = (%{$codes},&str2hash($codes_str)); 6266: push(@{$codetitles},&str2array($codetitles_str)); 6267: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str)); 6268: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str)); 6269: $ok_response = 1; 6270: } 6271: } 6272: if ($ok_response) { 6273: return 'ok'; 6274: } else { 6275: return $response; 6276: } 6277: } 6278: 6279: sub auto_instcode_defaults { 6280: my ($domain,$returnhash,$code_order) = @_; 6281: my @homeservers; 6282: 6283: my %servers = &get_servers($domain,'library'); 6284: foreach my $tryserver (keys(%servers)) { 6285: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6286: push(@homeservers,$tryserver); 6287: } 6288: } 6289: 6290: my $response; 6291: foreach my $server (@homeservers) { 6292: $response=&reply('autoinstcodedefaults:'.$domain,$server); 6293: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 6294: 6295: foreach my $pair (split(/\&/,$response)) { 6296: my ($name,$value)=split(/\=/,$pair); 6297: if ($name eq 'code_order') { 6298: @{$code_order} = split(/\&/,&unescape($value)); 6299: } else { 6300: $returnhash->{&unescape($name)}=&unescape($value); 6301: } 6302: } 6303: return 'ok'; 6304: } 6305: 6306: return $response; 6307: } 6308: 6309: sub auto_possible_instcodes { 6310: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_; 6311: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 6312: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) { 6313: return; 6314: } 6315: my (@homeservers,$uhome); 6316: if (defined(&domain($domain,'primary'))) { 6317: $uhome=&domain($domain,'primary'); 6318: push(@homeservers,&domain($domain,'primary')); 6319: } else { 6320: my %servers = &get_servers($domain,'library'); 6321: foreach my $tryserver (keys(%servers)) { 6322: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6323: push(@homeservers,$tryserver); 6324: } 6325: } 6326: } 6327: my $response; 6328: foreach my $server (@homeservers) { 6329: $response=&reply('autopossibleinstcodes:'.$domain,$server); 6330: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 6331: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 6332: split(':',$response); 6333: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr)); 6334: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr)); 6335: foreach my $item (split('&',$cat_title)) { 6336: my ($name,$value)=split('=',$item); 6337: $cat_titles->{&unescape($name)}=&thaw_unescape($value); 6338: } 6339: foreach my $item (split('&',$cat_order)) { 6340: my ($name,$value)=split('=',$item); 6341: $cat_orders->{&unescape($name)}=&thaw_unescape($value); 6342: } 6343: return 'ok'; 6344: } 6345: return $response; 6346: } 6347: 6348: sub auto_courserequest_checks { 6349: my ($dom) = @_; 6350: my ($homeserver,%validations); 6351: if ($dom =~ /^$match_domain$/) { 6352: $homeserver = &domain($dom,'primary'); 6353: } 6354: unless ($homeserver eq 'no_host') { 6355: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver); 6356: unless ($response =~ /(con_lost|error|no_such_host|refused)/) { 6357: my @items = split(/&/,$response); 6358: foreach my $item (@items) { 6359: my ($key,$value) = split('=',$item); 6360: $validations{&unescape($key)} = &thaw_unescape($value); 6361: } 6362: } 6363: } 6364: return %validations; 6365: } 6366: 6367: sub auto_courserequest_validation { 6368: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_; 6369: my ($homeserver,$response); 6370: if ($dom =~ /^$match_domain$/) { 6371: $homeserver = &domain($dom,'primary'); 6372: } 6373: unless ($homeserver eq 'no_host') { 6374: 6375: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner). 6376: ':'.&escape($crstype).':'.&escape($inststatuslist). 6377: ':'.&escape($instcode).':'.&escape($instseclist), 6378: $homeserver)); 6379: } 6380: return $response; 6381: } 6382: 6383: sub auto_validate_class_sec { 6384: my ($cdom,$cnum,$owners,$inst_class) = @_; 6385: my $homeserver = &homeserver($cnum,$cdom); 6386: my $ownerlist; 6387: if (ref($owners) eq 'ARRAY') { 6388: $ownerlist = join(',',@{$owners}); 6389: } else { 6390: $ownerlist = $owners; 6391: } 6392: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'. 6393: &escape($ownerlist).':'.$cdom,$homeserver); 6394: return $response; 6395: } 6396: 6397: # ------------------------------------------------------- Course Group routines 6398: 6399: sub get_coursegroups { 6400: my ($cdom,$cnum,$group,$namespace) = @_; 6401: return(&dump($namespace,$cdom,$cnum,$group)); 6402: } 6403: 6404: sub modify_coursegroup { 6405: my ($cdom,$cnum,$groupsettings) = @_; 6406: return(&put('coursegroups',$groupsettings,$cdom,$cnum)); 6407: } 6408: 6409: sub toggle_coursegroup_status { 6410: my ($cdom,$cnum,$group,$action) = @_; 6411: my ($from_namespace,$to_namespace); 6412: if ($action eq 'delete') { 6413: $from_namespace = 'coursegroups'; 6414: $to_namespace = 'deleted_groups'; 6415: } else { 6416: $from_namespace = 'deleted_groups'; 6417: $to_namespace = 'coursegroups'; 6418: } 6419: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace); 6420: if (my $tmp = &error(%curr_group)) { 6421: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom); 6422: return ('read error',$tmp); 6423: } else { 6424: my %savedsettings = %curr_group; 6425: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum); 6426: my $deloutcome; 6427: if ($result eq 'ok') { 6428: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum); 6429: } else { 6430: return ('write error',$result); 6431: } 6432: if ($deloutcome eq 'ok') { 6433: return 'ok'; 6434: } else { 6435: return ('delete error',$deloutcome); 6436: } 6437: } 6438: } 6439: 6440: sub modify_group_roles { 6441: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_; 6442: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id; 6443: my $role = 'gr/'.&escape($userprivs); 6444: my ($uname,$udom) = split(/:/,$user); 6445: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context); 6446: if ($result eq 'ok') { 6447: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum); 6448: } 6449: return $result; 6450: } 6451: 6452: sub modify_coursegroup_membership { 6453: my ($cdom,$cnum,$membership) = @_; 6454: my $result = &put('groupmembership',$membership,$cdom,$cnum); 6455: return $result; 6456: } 6457: 6458: sub get_active_groups { 6459: my ($udom,$uname,$cdom,$cnum) = @_; 6460: my $now = time; 6461: my %groups = (); 6462: foreach my $key (keys(%env)) { 6463: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) { 6464: my ($start,$end) = split(/\./,$env{$key}); 6465: if (($end!=0) && ($end<$now)) { next; } 6466: if (($start!=0) && ($start>$now)) { next; } 6467: if ($1 eq $cdom && $2 eq $cnum) { 6468: $groups{$3} = $env{$key} ; 6469: } 6470: } 6471: } 6472: return %groups; 6473: } 6474: 6475: sub get_group_membership { 6476: my ($cdom,$cnum,$group) = @_; 6477: return(&dump('groupmembership',$cdom,$cnum,$group)); 6478: } 6479: 6480: sub get_users_groups { 6481: my ($udom,$uname,$courseid) = @_; 6482: my @usersgroups; 6483: my $cachetime=1800; 6484: 6485: my $hashid="$udom:$uname:$courseid"; 6486: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid); 6487: if (defined($cached)) { 6488: @usersgroups = split(/:/,$grouplist); 6489: } else { 6490: $grouplist = ''; 6491: my $courseurl = &courseid_to_courseurl($courseid); 6492: my $extra = &freeze_escape({'skipcheck' => 1}); 6493: my %roleshash = &dump('roles',$udom,$uname,$courseurl,undef,$extra); 6494: my $access_end = $env{'course.'.$courseid. 6495: '.default_enrollment_end_date'}; 6496: my $now = time; 6497: foreach my $key (keys(%roleshash)) { 6498: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) { 6499: my $group = $1; 6500: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) { 6501: my $start = $2; 6502: my $end = $1; 6503: if ($start == -1) { next; } # deleted from group 6504: if (($start!=0) && ($start>$now)) { next; } 6505: if (($end!=0) && ($end<$now)) { 6506: if ($access_end && $access_end < $now) { 6507: if ($access_end - $end < 86400) { 6508: push(@usersgroups,$group); 6509: } 6510: } 6511: next; 6512: } 6513: push(@usersgroups,$group); 6514: } 6515: } 6516: } 6517: @usersgroups = &sort_course_groups($courseid,@usersgroups); 6518: $grouplist = join(':',@usersgroups); 6519: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime); 6520: } 6521: return @usersgroups; 6522: } 6523: 6524: sub devalidate_getgroups_cache { 6525: my ($udom,$uname,$cdom,$cnum)=@_; 6526: my $courseid = $cdom.'_'.$cnum; 6527: 6528: my $hashid="$udom:$uname:$courseid"; 6529: &devalidate_cache_new('getgroups',$hashid); 6530: } 6531: 6532: # ------------------------------------------------------------------ Plain Text 6533: 6534: sub plaintext { 6535: my ($short,$type,$cid,$forcedefault) = @_; 6536: if ($short =~ m{^cr/}) { 6537: return (split('/',$short))[-1]; 6538: } 6539: if (!defined($cid)) { 6540: $cid = $env{'request.course.id'}; 6541: } 6542: my %rolenames = ( 6543: Course => 'std', 6544: Community => 'alt1', 6545: ); 6546: if ($cid ne '') { 6547: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') { 6548: unless ($forcedefault) { 6549: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 6550: &Apache::lonlocal::mt_escape(\$roletext); 6551: return &Apache::lonlocal::mt($roletext); 6552: } 6553: } 6554: } 6555: if ((defined($type)) && (defined($rolenames{$type})) && 6556: (defined($rolenames{$type})) && 6557: (defined($prp{$short}{$rolenames{$type}}))) { 6558: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}}); 6559: } elsif ($cid ne '') { 6560: my $crstype = $env{'course.'.$cid.'.type'}; 6561: if (($crstype ne '') && (defined($rolenames{$crstype})) && 6562: (defined($prp{$short}{$rolenames{$crstype}}))) { 6563: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}}); 6564: } 6565: } 6566: return &Apache::lonlocal::mt($prp{$short}{'std'}); 6567: } 6568: 6569: # ----------------------------------------------------------------- Assign Role 6570: 6571: sub assignrole { 6572: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll, 6573: $context)=@_; 6574: my $mrole; 6575: if ($role =~ /^cr\//) { 6576: my $cwosec=$url; 6577: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6578: unless (&allowed('ccr',$cwosec)) { 6579: my $refused = 1; 6580: if ($context eq 'requestcourses') { 6581: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) { 6582: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) { 6583: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) { 6584: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6585: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6586: if ($crsenv{'internal.courseowner'} eq 6587: $env{'user.name'}.':'.$env{'user.domain'}) { 6588: $refused = ''; 6589: } 6590: } 6591: } 6592: } 6593: } 6594: if ($refused) { 6595: &logthis('Refused custom assignrole: '. 6596: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start. 6597: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}); 6598: return 'refused'; 6599: } 6600: } 6601: $mrole='cr'; 6602: } elsif ($role =~ /^gr\//) { 6603: my $cwogrp=$url; 6604: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2}; 6605: unless (&allowed('mdg',$cwogrp)) { 6606: &logthis('Refused group assignrole: '. 6607: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '. 6608: $env{'user.name'}.' at '.$env{'user.domain'}); 6609: return 'refused'; 6610: } 6611: $mrole='gr'; 6612: } else { 6613: my $cwosec=$url; 6614: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6615: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) { 6616: my $refused; 6617: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) { 6618: if (!(&allowed('c'.$role,$url))) { 6619: $refused = 1; 6620: } 6621: } else { 6622: $refused = 1; 6623: } 6624: if ($refused) { 6625: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6626: if (!$selfenroll && $context eq 'course') { 6627: my %crsenv; 6628: if ($role eq 'cc' || $role eq 'co') { 6629: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6630: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) { 6631: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) { 6632: if ($crsenv{'internal.courseowner'} eq 6633: $env{'user.name'}.':'.$env{'user.domain'}) { 6634: $refused = ''; 6635: } 6636: } 6637: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 6638: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) { 6639: if ($crsenv{'internal.courseowner'} eq 6640: $env{'user.name'}.':'.$env{'user.domain'}) { 6641: $refused = ''; 6642: } 6643: } 6644: } 6645: } 6646: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 6647: $refused = ''; 6648: } elsif ($context eq 'requestcourses') { 6649: my @possroles = ('st','ta','ep','in','cc','co'); 6650: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) { 6651: my $wrongcc; 6652: if ($cnum =~ /^$match_community$/) { 6653: $wrongcc = 1 if ($role eq 'cc'); 6654: } else { 6655: $wrongcc = 1 if ($role eq 'co'); 6656: } 6657: unless ($wrongcc) { 6658: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6659: if ($crsenv{'internal.courseowner'} eq 6660: $env{'user.name'}.':'.$env{'user.domain'}) { 6661: $refused = ''; 6662: } 6663: } 6664: } 6665: } 6666: if ($refused) { 6667: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url. 6668: ' '.$role.' '.$end.' '.$start.' by '. 6669: $env{'user.name'}.' at '.$env{'user.domain'}); 6670: return 'refused'; 6671: } 6672: } 6673: } 6674: $mrole=$role; 6675: } 6676: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 6677: "$udom:$uname:$url".'_'."$mrole=$role"; 6678: if ($end) { $command.='_'.$end; } 6679: if ($start) { 6680: if ($end) { 6681: $command.='_'.$start; 6682: } else { 6683: $command.='_0_'.$start; 6684: } 6685: } 6686: my $origstart = $start; 6687: my $origend = $end; 6688: my $delflag; 6689: # actually delete 6690: if ($deleteflag) { 6691: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) { 6692: # modify command to delete the role 6693: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:". 6694: "$udom:$uname:$url".'_'."$mrole"; 6695: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 6696: # set start and finish to negative values for userrolelog 6697: $start=-1; 6698: $end=-1; 6699: $delflag = 1; 6700: } 6701: } 6702: # send command 6703: my $answer=&reply($command,&homeserver($uname,$udom)); 6704: # log new user role if status is ok 6705: if ($answer eq 'ok') { 6706: &userrolelog($role,$uname,$udom,$url,$start,$end); 6707: # for course roles, perform group memberships changes triggered by role change. 6708: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context); 6709: unless ($role =~ /^gr/) { 6710: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend, 6711: $origstart,$selfenroll,$context); 6712: } 6713: if ($role eq 'cc') { 6714: &autoupdate_coowners($url,$end,$start,$uname,$udom); 6715: } 6716: } 6717: return $answer; 6718: } 6719: 6720: sub autoupdate_coowners { 6721: my ($url,$end,$start,$uname,$udom) = @_; 6722: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)}); 6723: if (($cdom ne '') && ($cnum ne '')) { 6724: my $now = time; 6725: my %domdesign = &Apache::loncommon::get_domainconf($cdom); 6726: if ($domdesign{$cdom.'.autoassign.co-owners'}) { 6727: my %coursehash = &coursedescription($cdom.'_'.$cnum); 6728: my $instcode = $coursehash{'internal.coursecode'}; 6729: if ($instcode ne '') { 6730: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) { 6731: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) { 6732: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners); 6733: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom); 6734: if ($result eq 'valid') { 6735: if ($coursehash{'internal.co-owners'}) { 6736: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) { 6737: push(@newcoowners,$coowner); 6738: } 6739: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) { 6740: push(@newcoowners,$uname.':'.$udom); 6741: } 6742: @newcoowners = sort(@newcoowners); 6743: } else { 6744: push(@newcoowners,$uname.':'.$udom); 6745: } 6746: } else { 6747: if ($coursehash{'internal.co-owners'}) { 6748: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) { 6749: unless ($coowner eq $uname.':'.$udom) { 6750: push(@newcoowners,$coowner); 6751: } 6752: } 6753: unless (@newcoowners > 0) { 6754: $delcoowners = 1; 6755: $coowners = ''; 6756: } 6757: } 6758: } 6759: if (@newcoowners || $delcoowners) { 6760: &store_coowners($cdom,$cnum,$coursehash{'home'}, 6761: $delcoowners,@newcoowners); 6762: } 6763: } 6764: } 6765: } 6766: } 6767: } 6768: } 6769: 6770: sub store_coowners { 6771: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_; 6772: my $cid = $cdom.'_'.$cnum; 6773: my ($coowners,$delresult,$putresult); 6774: if (@newcoowners) { 6775: $coowners = join(',',@newcoowners); 6776: my %coownershash = ( 6777: 'internal.co-owners' => $coowners, 6778: ); 6779: $putresult = &put('environment',\%coownershash,$cdom,$cnum); 6780: if ($putresult eq 'ok') { 6781: if ($env{'course.'.$cid.'.num'} eq $cnum) { 6782: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners}); 6783: } 6784: } 6785: } 6786: if ($delcoowners) { 6787: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum); 6788: if ($delresult eq 'ok') { 6789: if ($env{'course.'.$cid.'.internal.co-owners'}) { 6790: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners'); 6791: } 6792: } 6793: } 6794: if (($putresult eq 'ok') || ($delresult eq 'ok')) { 6795: my %crsinfo = 6796: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.'); 6797: if (ref($crsinfo{$cid}) eq 'HASH') { 6798: $crsinfo{$cid}{'co-owners'} = \@newcoowners; 6799: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime'); 6800: } 6801: } 6802: } 6803: 6804: # -------------------------------------------------- Modify user authentication 6805: # Overrides without validation 6806: 6807: sub modifyuserauth { 6808: my ($udom,$uname,$umode,$upass)=@_; 6809: my $uhome=&homeserver($uname,$udom); 6810: unless (&allowed('mau',$udom)) { return 'refused'; } 6811: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '. 6812: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6813: ' in domain '.$env{'request.role.domain'}); 6814: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'. 6815: &escape($upass),$uhome); 6816: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 6817: 'Authentication changed for '.$udom.', '.$uname.', '.$umode. 6818: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6819: &log($udom,,$uname,$uhome, 6820: 'Authentication changed by '.$env{'user.domain'}.', '. 6821: $env{'user.name'}.', '.$umode. 6822: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6823: unless ($reply eq 'ok') { 6824: &logthis('Authentication mode error: '.$reply); 6825: return 'error: '.$reply; 6826: } 6827: return 'ok'; 6828: } 6829: 6830: # --------------------------------------------------------------- Modify a user 6831: 6832: sub modifyuser { 6833: my ($udom, $uname, $uid, 6834: $umode, $upass, $first, 6835: $middle, $last, $gene, 6836: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_; 6837: $udom= &LONCAPA::clean_domain($udom); 6838: $uname=&LONCAPA::clean_username($uname); 6839: my $showcandelete = 'none'; 6840: if (ref($candelete) eq 'ARRAY') { 6841: if (@{$candelete} > 0) { 6842: $showcandelete = join(', ',@{$candelete}); 6843: } 6844: } 6845: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '. 6846: $umode.', '.$first.', '.$middle.', '. 6847: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'. 6848: (defined($desiredhome) ? ' desiredhome = '.$desiredhome : 6849: ' desiredhome not specified'). 6850: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6851: ' in domain '.$env{'request.role.domain'}); 6852: my $uhome=&homeserver($uname,$udom,'true'); 6853: my $newuser; 6854: if ($uhome eq 'no_host') { 6855: $newuser = 1; 6856: } 6857: # ----------------------------------------------------------------- Create User 6858: if (($uhome eq 'no_host') && 6859: (($umode && $upass) || ($umode eq 'localauth'))) { 6860: my $unhome=''; 6861: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 6862: $unhome = $desiredhome; 6863: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) { 6864: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'}; 6865: } else { # load balancing routine for determining $unhome 6866: my $loadm=10000000; 6867: my %servers = &get_servers($udom,'library'); 6868: foreach my $tryserver (keys(%servers)) { 6869: my $answer=reply('load',$tryserver); 6870: if (($answer=~/\d+/) && ($answer<$loadm)) { 6871: $loadm=$answer; 6872: $unhome=$tryserver; 6873: } 6874: } 6875: } 6876: if (($unhome eq '') || ($unhome eq 'no_host')) { 6877: return 'error: unable to find a home server for '.$uname. 6878: ' in domain '.$udom; 6879: } 6880: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'. 6881: &escape($upass),$unhome); 6882: unless ($reply eq 'ok') { 6883: return 'error: '.$reply; 6884: } 6885: $uhome=&homeserver($uname,$udom,'true'); 6886: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) { 6887: return 'error: unable verify users home machine.'; 6888: } 6889: } # End of creation of new user 6890: # ---------------------------------------------------------------------- Add ID 6891: if ($uid) { 6892: $uid=~tr/A-Z/a-z/; 6893: my %uidhash=&idrget($udom,$uname); 6894: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 6895: && (!$forceid)) { 6896: unless ($uid eq $uidhash{$uname}) { 6897: return 'error: user id "'.$uid.'" does not match '. 6898: 'current user id "'.$uidhash{$uname}.'".'; 6899: } 6900: } else { 6901: &idput($udom,($uname => $uid)); 6902: } 6903: } 6904: # -------------------------------------------------------------- Add names, etc 6905: my @tmp=&get('environment', 6906: ['firstname','middlename','lastname','generation','id', 6907: 'permanentemail','inststatus'], 6908: $udom,$uname); 6909: my (%names,%oldnames); 6910: if ($tmp[0] =~ m/^error:.*/) { 6911: %names=(); 6912: } else { 6913: %names = @tmp; 6914: %oldnames = %names; 6915: } 6916: # 6917: # If name, email and/or uid are blank (e.g., because an uploaded file 6918: # of users did not contain them), do not overwrite existing values 6919: # unless field is in $candelete array ref. 6920: # 6921: 6922: my @fields = ('firstname','middlename','lastname','generation', 6923: 'permanentemail','id'); 6924: my %newvalues; 6925: if (ref($candelete) eq 'ARRAY') { 6926: foreach my $field (@fields) { 6927: if (grep(/^\Q$field\E$/,@{$candelete})) { 6928: if ($field eq 'firstname') { 6929: $names{$field} = $first; 6930: } elsif ($field eq 'middlename') { 6931: $names{$field} = $middle; 6932: } elsif ($field eq 'lastname') { 6933: $names{$field} = $last; 6934: } elsif ($field eq 'generation') { 6935: $names{$field} = $gene; 6936: } elsif ($field eq 'permanentemail') { 6937: $names{$field} = $email; 6938: } elsif ($field eq 'id') { 6939: $names{$field} = $uid; 6940: } 6941: } 6942: } 6943: } 6944: if ($first) { $names{'firstname'} = $first; } 6945: if (defined($middle)) { $names{'middlename'} = $middle; } 6946: if ($last) { $names{'lastname'} = $last; } 6947: if (defined($gene)) { $names{'generation'} = $gene; } 6948: if ($email) { 6949: $email=~s/[^\w\@\.\-\,]//gs; 6950: if ($email=~/\@/) { $names{'permanentemail'} = $email; } 6951: } 6952: if ($uid) { $names{'id'} = $uid; } 6953: if (defined($inststatus)) { 6954: $names{'inststatus'} = ''; 6955: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom); 6956: if (ref($usertypes) eq 'HASH') { 6957: my @okstatuses; 6958: foreach my $item (split(/:/,$inststatus)) { 6959: if (defined($usertypes->{$item})) { 6960: push(@okstatuses,$item); 6961: } 6962: } 6963: if (@okstatuses) { 6964: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses); 6965: } 6966: } 6967: } 6968: my $logmsg = $udom.', '.$uname.', '.$uid.', '. 6969: $umode.', '.$first.', '.$middle.', '. 6970: $last.', '.$gene.', '.$email.', '.$inststatus; 6971: if ($env{'user.name'} ne '' && $env{'user.domain'}) { 6972: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'}; 6973: } else { 6974: $logmsg .= ' during self creation'; 6975: } 6976: my $changed; 6977: if ($newuser) { 6978: $changed = 1; 6979: } else { 6980: foreach my $field (@fields) { 6981: if ($names{$field} ne $oldnames{$field}) { 6982: $changed = 1; 6983: last; 6984: } 6985: } 6986: } 6987: unless ($changed) { 6988: $logmsg = 'No changes in user information needed for: '.$logmsg; 6989: &logthis($logmsg); 6990: return 'ok'; 6991: } 6992: my $reply = &put('environment', \%names, $udom,$uname); 6993: if ($reply ne 'ok') { 6994: return 'error: '.$reply; 6995: } 6996: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) { 6997: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom); 6998: } 6999: my $sqlresult = &update_allusers_table($uname,$udom,\%names); 7000: &devalidate_cache_new('namescache',$uname.':'.$udom); 7001: $logmsg = 'Success modifying user '.$logmsg; 7002: &logthis($logmsg); 7003: return 'ok'; 7004: } 7005: 7006: # -------------------------------------------------------------- Modify student 7007: 7008: sub modifystudent { 7009: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec, 7010: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid, 7011: $selfenroll,$context,$inststatus)=@_; 7012: if (!$cid) { 7013: unless ($cid=$env{'request.course.id'}) { 7014: return 'not_in_class'; 7015: } 7016: } 7017: # --------------------------------------------------------------- Make the user 7018: my $reply=&modifyuser 7019: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid, 7020: $desiredhome,$email,$inststatus); 7021: unless ($reply eq 'ok') { return $reply; } 7022: # This will cause &modify_student_enrollment to get the uid from the 7023: # students environment 7024: $uid = undef if (!$forceid); 7025: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last, 7026: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context); 7027: return $reply; 7028: } 7029: 7030: sub modify_student_enrollment { 7031: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_; 7032: my ($cdom,$cnum,$chome); 7033: if (!$cid) { 7034: unless ($cid=$env{'request.course.id'}) { 7035: return 'not_in_class'; 7036: } 7037: $cdom=$env{'course.'.$cid.'.domain'}; 7038: $cnum=$env{'course.'.$cid.'.num'}; 7039: } else { 7040: ($cdom,$cnum)=split(/_/,$cid); 7041: } 7042: $chome=$env{'course.'.$cid.'.home'}; 7043: if (!$chome) { 7044: $chome=&homeserver($cnum,$cdom); 7045: } 7046: if (!$chome) { return 'unknown_course'; } 7047: # Make sure the user exists 7048: my $uhome=&homeserver($uname,$udom); 7049: if (($uhome eq '') || ($uhome eq 'no_host')) { 7050: return 'error: no such user'; 7051: } 7052: # Get student data if we were not given enough information 7053: if (!defined($first) || $first eq '' || 7054: !defined($last) || $last eq '' || 7055: !defined($uid) || $uid eq '' || 7056: !defined($middle) || $middle eq '' || 7057: !defined($gene) || $gene eq '') { 7058: # They did not supply us with enough data to enroll the student, so 7059: # we need to pick up more information. 7060: my %tmp = &get('environment', 7061: ['firstname','middlename','lastname', 'generation','id'] 7062: ,$udom,$uname); 7063: 7064: #foreach my $key (keys(%tmp)) { 7065: # &logthis("key $key = ".$tmp{$key}); 7066: #} 7067: $first = $tmp{'firstname'} if (!defined($first) || $first eq ''); 7068: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq ''); 7069: $last = $tmp{'lastname'} if (!defined($last) || $last eq ''); 7070: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq ''); 7071: $uid = $tmp{'id'} if (!defined($uid) || $uid eq ''); 7072: } 7073: my $fullname = &format_name($first,$middle,$last,$gene,'lastname'); 7074: my $reply=cput('classlist', 7075: {"$uname:$udom" => 7076: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) }, 7077: $cdom,$cnum); 7078: unless (($reply eq 'ok') || ($reply eq 'delayed')) { 7079: return 'error: '.$reply; 7080: } else { 7081: &devalidate_getsection_cache($udom,$uname,$cid); 7082: } 7083: # Add student role to user 7084: my $uurl='/'.$cid; 7085: $uurl=~s/\_/\//g; 7086: if ($usec) { 7087: $uurl.='/'.$usec; 7088: } 7089: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context); 7090: } 7091: 7092: sub format_name { 7093: my ($firstname,$middlename,$lastname,$generation,$first)=@_; 7094: my $name; 7095: if ($first ne 'lastname') { 7096: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation; 7097: } else { 7098: if ($lastname=~/\S/) { 7099: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename; 7100: $name=~s/\s+,/,/; 7101: } else { 7102: $name.= $firstname.' '.$middlename.' '.$generation; 7103: } 7104: } 7105: $name=~s/^\s+//; 7106: $name=~s/\s+$//; 7107: $name=~s/\s+/ /g; 7108: return $name; 7109: } 7110: 7111: # ------------------------------------------------- Write to course preferences 7112: 7113: sub writecoursepref { 7114: my ($courseid,%prefs)=@_; 7115: $courseid=~s/^\///; 7116: $courseid=~s/\_/\//g; 7117: my ($cdomain,$cnum)=split(/\//,$courseid); 7118: my $chome=homeserver($cnum,$cdomain); 7119: if (($chome eq '') || ($chome eq 'no_host')) { 7120: return 'error: no such course'; 7121: } 7122: my $cstring=''; 7123: foreach my $pref (keys(%prefs)) { 7124: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&'; 7125: } 7126: $cstring=~s/\&$//; 7127: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome); 7128: } 7129: 7130: # ---------------------------------------------------------- Make/modify course 7131: 7132: sub createcourse { 7133: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code, 7134: $course_owner,$crstype,$cnum,$context,$category)=@_; 7135: $url=&declutter($url); 7136: my $cid=''; 7137: if ($context eq 'requestcourses') { 7138: my $can_create = 0; 7139: my ($ownername,$ownerdom) = split(':',$course_owner); 7140: if ($udom eq $ownerdom) { 7141: if (&usertools_access($ownername,$ownerdom,$category,undef, 7142: $context)) { 7143: $can_create = 1; 7144: } 7145: } else { 7146: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'. 7147: $category); 7148: if ($userenv{'reqcrsotherdom.'.$category} ne '') { 7149: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category}); 7150: if (@curr > 0) { 7151: my @options = qw(approval validate autolimit); 7152: my $optregex = join('|',@options); 7153: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) { 7154: $can_create = 1; 7155: } 7156: } 7157: } 7158: } 7159: if ($can_create) { 7160: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) { 7161: unless (&allowed('ccc',$udom)) { 7162: return 'refused'; 7163: } 7164: } 7165: } else { 7166: return 'refused'; 7167: } 7168: } elsif (!&allowed('ccc',$udom)) { 7169: return 'refused'; 7170: } 7171: # --------------------------------------------------------------- Get Unique ID 7172: my $uname; 7173: if ($cnum =~ /^$match_courseid$/) { 7174: my $chome=&homeserver($cnum,$udom,'true'); 7175: if (($chome eq '') || ($chome eq 'no_host')) { 7176: $uname = $cnum; 7177: } else { 7178: $uname = &generate_coursenum($udom,$crstype); 7179: } 7180: } else { 7181: $uname = &generate_coursenum($udom,$crstype); 7182: } 7183: return $uname if ($uname =~ /^error/); 7184: # -------------------------------------------------- Check supplied server name 7185: if (!defined($course_server)) { 7186: if (defined(&domain($udom,'primary'))) { 7187: $course_server = &domain($udom,'primary'); 7188: } else { 7189: $course_server = $env{'user.home'}; 7190: } 7191: } 7192: my %host_servers = 7193: &Apache::lonnet::get_servers($udom,'library'); 7194: unless ($host_servers{$course_server}) { 7195: return 'error: invalid home server for course: '.$course_server; 7196: } 7197: # ------------------------------------------------------------- Make the course 7198: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::', 7199: $course_server); 7200: unless ($reply eq 'ok') { return 'error: '.$reply; } 7201: my $uhome=&homeserver($uname,$udom,'true'); 7202: if (($uhome eq '') || ($uhome eq 'no_host')) { 7203: return 'error: no such course'; 7204: } 7205: # ----------------------------------------------------------------- Course made 7206: # log existence 7207: my $now = time; 7208: my $newcourse = { 7209: $udom.'_'.$uname => { 7210: description => $description, 7211: inst_code => $inst_code, 7212: owner => $course_owner, 7213: type => $crstype, 7214: creator => $env{'user.name'}.':'. 7215: $env{'user.domain'}, 7216: created => $now, 7217: context => $context, 7218: }, 7219: }; 7220: &courseidput($udom,$newcourse,$uhome,'notime'); 7221: # set toplevel url 7222: my $topurl=$url; 7223: unless ($nonstandard) { 7224: # ------------------------------------------ For standard courses, make top url 7225: my $mapurl=&clutter($url); 7226: if ($mapurl eq '/res/') { $mapurl=''; } 7227: $env{'form.initmap'}=(<<ENDINITMAP); 7228: <map> 7229: <resource id="1" type="start"></resource> 7230: <resource id="2" src="$mapurl"></resource> 7231: <resource id="3" type="finish"></resource> 7232: <link index="1" from="1" to="2"></link> 7233: <link index="2" from="2" to="3"></link> 7234: </map> 7235: ENDINITMAP 7236: $topurl=&declutter( 7237: &finishuserfileupload($uname,$udom,'initmap','default.sequence') 7238: ); 7239: } 7240: # ----------------------------------------------------------- Write preferences 7241: &writecoursepref($udom.'_'.$uname, 7242: ('description' => $description, 7243: 'url' => $topurl, 7244: 'internal.creator' => $env{'user.name'}.':'. 7245: $env{'user.domain'}, 7246: 'internal.created' => $now, 7247: 'internal.creationcontext' => $context) 7248: ); 7249: return '/'.$udom.'/'.$uname; 7250: } 7251: 7252: # ------------------------------------------------------------------- Create ID 7253: sub generate_coursenum { 7254: my ($udom,$crstype) = @_; 7255: my $domdesc = &domain($udom); 7256: return 'error: invalid domain' if ($domdesc eq ''); 7257: my $first; 7258: if ($crstype eq 'Community') { 7259: $first = '0'; 7260: } else { 7261: $first = int(1+rand(9)); 7262: } 7263: my $uname=$first. 7264: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 7265: substr($$.time,0,5).unpack("H8",pack("I32",time)). 7266: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 7267: # ----------------------------------------------- Make sure that does not exist 7268: my $uhome=&homeserver($uname,$udom,'true'); 7269: unless (($uhome eq '') || ($uhome eq 'no_host')) { 7270: if ($crstype eq 'Community') { 7271: $first = '0'; 7272: } else { 7273: $first = int(1+rand(9)); 7274: } 7275: $uname=$first. 7276: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 7277: substr($$.time,0,5).unpack("H8",pack("I32",time)). 7278: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 7279: $uhome=&homeserver($uname,$udom,'true'); 7280: unless (($uhome eq '') || ($uhome eq 'no_host')) { 7281: return 'error: unable to generate unique course-ID'; 7282: } 7283: } 7284: return $uname; 7285: } 7286: 7287: sub is_course { 7288: my ($cdom,$cnum) = @_; 7289: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef, 7290: undef,'.'); 7291: if (exists($courses{$cdom.'_'.$cnum})) { 7292: return 1; 7293: } 7294: return 0; 7295: } 7296: 7297: sub store_userdata { 7298: my ($storehash,$datakey,$namespace,$udom,$uname) = @_; 7299: my $result; 7300: if ($datakey ne '') { 7301: if (ref($storehash) eq 'HASH') { 7302: if ($udom eq '' || $uname eq '') { 7303: $udom = $env{'user.domain'}; 7304: $uname = $env{'user.name'}; 7305: } 7306: my $uhome=&homeserver($uname,$udom); 7307: if (($uhome eq '') || ($uhome eq 'no_host')) { 7308: $result = 'error: no_host'; 7309: } else { 7310: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'}; 7311: $storehash->{'host'} = $perlvar{'lonHostID'}; 7312: 7313: my $namevalue=''; 7314: foreach my $key (keys(%{$storehash})) { 7315: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 7316: } 7317: $namevalue=~s/\&$//; 7318: $result = &reply("store:$udom:$uname:$namespace:$datakey:". 7319: $namevalue,$uhome); 7320: } 7321: } else { 7322: $result = 'error: data to store was not a hash reference'; 7323: } 7324: } else { 7325: $result= 'error: invalid requestkey'; 7326: } 7327: return $result; 7328: } 7329: 7330: # ---------------------------------------------------------- Assign Custom Role 7331: 7332: sub assigncustomrole { 7333: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_; 7334: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename, 7335: $end,$start,$deleteflag,$selfenroll,$context); 7336: } 7337: 7338: # ----------------------------------------------------------------- Revoke Role 7339: 7340: sub revokerole { 7341: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_; 7342: my $now=time; 7343: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context); 7344: } 7345: 7346: # ---------------------------------------------------------- Revoke Custom Role 7347: 7348: sub revokecustomrole { 7349: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_; 7350: my $now=time; 7351: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now, 7352: $deleteflag,$selfenroll,$context); 7353: } 7354: 7355: # ------------------------------------------------------------ Disk usage 7356: sub diskusage { 7357: my ($udom,$uname,$directorypath,$getpropath)=@_; 7358: $directorypath =~ s/\/$//; 7359: my $listing=&reply('du2:'.&escape($directorypath).':' 7360: .&escape($getpropath).':'.&escape($uname).':' 7361: .&escape($udom),homeserver($uname,$udom)); 7362: if ($listing eq 'unknown_cmd') { 7363: if ($getpropath) { 7364: $directorypath = &propath($udom,$uname).'/'.$directorypath; 7365: } 7366: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom)); 7367: } 7368: return $listing; 7369: } 7370: 7371: sub is_locked { 7372: my ($file_name, $domain, $user, $which) = @_; 7373: my @check; 7374: my $is_locked; 7375: push (@check,$file_name); 7376: my %locked = &get('file_permissions',\@check, 7377: $env{'user.domain'},$env{'user.name'}); 7378: my ($tmp)=keys(%locked); 7379: if ($tmp=~/^error:/) { undef(%locked); } 7380: 7381: if (ref($locked{$file_name}) eq 'ARRAY') { 7382: $is_locked = 'false'; 7383: foreach my $entry (@{$locked{$file_name}}) { 7384: if (ref($entry) eq 'ARRAY') { 7385: $is_locked = 'true'; 7386: if (ref($which) eq 'ARRAY') { 7387: push(@{$which},$entry); 7388: } else { 7389: last; 7390: } 7391: } 7392: } 7393: } else { 7394: $is_locked = 'false'; 7395: } 7396: return $is_locked; 7397: } 7398: 7399: sub declutter_portfile { 7400: my ($file) = @_; 7401: $file =~ s{^(/portfolio/|portfolio/)}{/}; 7402: return $file; 7403: } 7404: 7405: # ------------------------------------------------------------- Mark as Read Only 7406: 7407: sub mark_as_readonly { 7408: my ($domain,$user,$files,$what) = @_; 7409: my %current_permissions = &dump('file_permissions',$domain,$user); 7410: my ($tmp)=keys(%current_permissions); 7411: if ($tmp=~/^error:/) { undef(%current_permissions); } 7412: foreach my $file (@{$files}) { 7413: $file = &declutter_portfile($file); 7414: push(@{$current_permissions{$file}},$what); 7415: } 7416: &put('file_permissions',\%current_permissions,$domain,$user); 7417: return; 7418: } 7419: 7420: # ------------------------------------------------------------Save Selected Files 7421: 7422: sub save_selected_files { 7423: my ($user, $path, @files) = @_; 7424: my $filename = $user."savedfiles"; 7425: my @other_files = &files_not_in_path($user, $path); 7426: open (OUT, '>'.$tmpdir.$filename); 7427: foreach my $file (@files) { 7428: print (OUT $env{'form.currentpath'}.$file."\n"); 7429: } 7430: foreach my $file (@other_files) { 7431: print (OUT $file."\n"); 7432: } 7433: close (OUT); 7434: return 'ok'; 7435: } 7436: 7437: sub clear_selected_files { 7438: my ($user) = @_; 7439: my $filename = $user."savedfiles"; 7440: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7441: print (OUT undef); 7442: close (OUT); 7443: return ("ok"); 7444: } 7445: 7446: sub files_in_path { 7447: my ($user, $path) = @_; 7448: my $filename = $user."savedfiles"; 7449: my %return_files; 7450: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7451: while (my $line_in = <IN>) { 7452: chomp ($line_in); 7453: my @paths_and_file = split (m!/!, $line_in); 7454: my $file_part = pop (@paths_and_file); 7455: my $path_part = join ('/', @paths_and_file); 7456: $path_part.='/'; 7457: my $path_and_file = $path_part.$file_part; 7458: if ($path_part eq $path) { 7459: $return_files{$file_part}= 'selected'; 7460: } 7461: } 7462: close (IN); 7463: return (\%return_files); 7464: } 7465: 7466: # called in portfolio select mode, to show files selected NOT in current directory 7467: sub files_not_in_path { 7468: my ($user, $path) = @_; 7469: my $filename = $user."savedfiles"; 7470: my @return_files; 7471: my $path_part; 7472: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7473: while (my $line = <IN>) { 7474: #ok, I know it's clunky, but I want it to work 7475: my @paths_and_file = split(m|/|, $line); 7476: my $file_part = pop(@paths_and_file); 7477: chomp($file_part); 7478: my $path_part = join('/', @paths_and_file); 7479: $path_part .= '/'; 7480: my $path_and_file = $path_part.$file_part; 7481: if ($path_part ne $path) { 7482: push(@return_files, ($path_and_file)); 7483: } 7484: } 7485: close(OUT); 7486: return (@return_files); 7487: } 7488: 7489: #----------------------------------------------Get portfolio file permissions 7490: 7491: sub get_portfile_permissions { 7492: my ($domain,$user) = @_; 7493: my %current_permissions = &dump('file_permissions',$domain,$user); 7494: my ($tmp)=keys(%current_permissions); 7495: if ($tmp=~/^error:/) { undef(%current_permissions); } 7496: return \%current_permissions; 7497: } 7498: 7499: #---------------------------------------------Get portfolio file access controls 7500: 7501: sub get_access_controls { 7502: my ($current_permissions,$group,$file) = @_; 7503: my %access; 7504: my $real_file = $file; 7505: $file =~ s/\.meta$//; 7506: if (defined($file)) { 7507: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') { 7508: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) { 7509: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control}; 7510: } 7511: } 7512: } else { 7513: foreach my $key (keys(%{$current_permissions})) { 7514: if ($key =~ /\0accesscontrol$/) { 7515: if (defined($group)) { 7516: if ($key !~ m-^\Q$group\E/-) { 7517: next; 7518: } 7519: } 7520: my ($fullpath) = split(/\0/,$key); 7521: if (ref($$current_permissions{$key}) eq 'HASH') { 7522: foreach my $control (keys(%{$$current_permissions{$key}})) { 7523: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control}; 7524: } 7525: } 7526: } 7527: } 7528: } 7529: return %access; 7530: } 7531: 7532: sub modify_access_controls { 7533: my ($file_name,$changes,$domain,$user)=@_; 7534: my ($outcome,$deloutcome); 7535: my %store_permissions; 7536: my %new_values; 7537: my %new_control; 7538: my %translation; 7539: my @deletions = (); 7540: my $now = time; 7541: if (exists($$changes{'activate'})) { 7542: if (ref($$changes{'activate'}) eq 'HASH') { 7543: my @newitems = sort(keys(%{$$changes{'activate'}})); 7544: my $numnew = scalar(@newitems); 7545: for (my $i=0; $i<$numnew; $i++) { 7546: my $newkey = $newitems[$i]; 7547: my $newid = &Apache::loncommon::get_cgi_id(); 7548: if ($newkey =~ /^\d+:/) { 7549: $newkey =~ s/^(\d+)/$newid/; 7550: $translation{$1} = $newid; 7551: } elsif ($newkey =~ /^\d+_\d+_\d+:/) { 7552: $newkey =~ s/^(\d+_\d+_\d+)/$newid/; 7553: $translation{$1} = $newid; 7554: } 7555: $new_values{$file_name."\0".$newkey} = 7556: $$changes{'activate'}{$newitems[$i]}; 7557: $new_control{$newkey} = $now; 7558: } 7559: } 7560: } 7561: my %todelete; 7562: my %changed_items; 7563: foreach my $action ('delete','update') { 7564: if (exists($$changes{$action})) { 7565: if (ref($$changes{$action}) eq 'HASH') { 7566: foreach my $key (keys(%{$$changes{$action}})) { 7567: my ($itemnum) = ($key =~ /^([^:]+):/); 7568: if ($action eq 'delete') { 7569: $todelete{$itemnum} = 1; 7570: } else { 7571: $changed_items{$itemnum} = $key; 7572: } 7573: } 7574: } 7575: } 7576: } 7577: # get lock on access controls for file. 7578: my $lockhash = { 7579: $file_name."\0".'locked_access_records' => $env{'user.name'}. 7580: ':'.$env{'user.domain'}, 7581: }; 7582: my $tries = 0; 7583: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7584: 7585: while (($gotlock ne 'ok') && $tries <3) { 7586: $tries ++; 7587: sleep 1; 7588: $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7589: } 7590: if ($gotlock eq 'ok') { 7591: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name); 7592: my ($tmp)=keys(%curr_permissions); 7593: if ($tmp=~/^error:/) { undef(%curr_permissions); } 7594: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) { 7595: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'}; 7596: if (ref($curr_controls) eq 'HASH') { 7597: foreach my $control_item (keys(%{$curr_controls})) { 7598: my ($itemnum) = ($control_item =~ /^([^:]+):/); 7599: if (defined($todelete{$itemnum})) { 7600: push(@deletions,$file_name."\0".$control_item); 7601: } else { 7602: if (defined($changed_items{$itemnum})) { 7603: $new_control{$changed_items{$itemnum}} = $now; 7604: push(@deletions,$file_name."\0".$control_item); 7605: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}}; 7606: } else { 7607: $new_control{$control_item} = $$curr_controls{$control_item}; 7608: } 7609: } 7610: } 7611: } 7612: } 7613: my ($group); 7614: if (&is_course($domain,$user)) { 7615: ($group,my $file) = split(/\//,$file_name,2); 7616: } 7617: $deloutcome = &del('file_permissions',\@deletions,$domain,$user); 7618: $new_values{$file_name."\0".'accesscontrol'} = \%new_control; 7619: $outcome = &put('file_permissions',\%new_values,$domain,$user); 7620: # remove lock 7621: my @del_lock = ($file_name."\0".'locked_access_records'); 7622: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user); 7623: my $sqlresult = 7624: &update_portfolio_table($user,$domain,$file_name,'portfolio_access', 7625: $group); 7626: } else { 7627: $outcome = "error: could not obtain lockfile\n"; 7628: } 7629: return ($outcome,$deloutcome,\%new_values,\%translation); 7630: } 7631: 7632: sub make_public_indefinitely { 7633: my ($requrl) = @_; 7634: my $now = time; 7635: my $action = 'activate'; 7636: my $aclnum = 0; 7637: if (&is_portfolio_url($requrl)) { 7638: my (undef,$udom,$unum,$file_name,$group) = 7639: &parse_portfolio_url($requrl); 7640: my $current_perms = &get_portfile_permissions($udom,$unum); 7641: my %access_controls = &get_access_controls($current_perms, 7642: $group,$file_name); 7643: foreach my $key (keys(%{$access_controls{$file_name}})) { 7644: my ($num,$scope,$end,$start) = 7645: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 7646: if ($scope eq 'public') { 7647: if ($start <= $now && $end == 0) { 7648: $action = 'none'; 7649: } else { 7650: $action = 'update'; 7651: $aclnum = $num; 7652: } 7653: last; 7654: } 7655: } 7656: if ($action eq 'none') { 7657: return 'ok'; 7658: } else { 7659: my %changes; 7660: my $newend = 0; 7661: my $newstart = $now; 7662: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart; 7663: $changes{$action}{$newkey} = { 7664: type => 'public', 7665: time => { 7666: start => $newstart, 7667: end => $newend, 7668: }, 7669: }; 7670: my ($outcome,$deloutcome,$new_values,$translation) = 7671: &modify_access_controls($file_name,\%changes,$udom,$unum); 7672: return $outcome; 7673: } 7674: } else { 7675: return 'invalid'; 7676: } 7677: } 7678: 7679: #------------------------------------------------------Get Marked as Read Only 7680: 7681: sub get_marked_as_readonly { 7682: my ($domain,$user,$what,$group) = @_; 7683: my $current_permissions = &get_portfile_permissions($domain,$user); 7684: my @readonly_files; 7685: my $cmp1=$what; 7686: if (ref($what)) { $cmp1=join('',@{$what}) }; 7687: while (my ($file_name,$value) = each(%{$current_permissions})) { 7688: if (defined($group)) { 7689: if ($file_name !~ m-^\Q$group\E/-) { 7690: next; 7691: } 7692: } 7693: if (ref($value) eq "ARRAY"){ 7694: foreach my $stored_what (@{$value}) { 7695: my $cmp2=$stored_what; 7696: if (ref($stored_what) eq 'ARRAY') { 7697: $cmp2=join('',@{$stored_what}); 7698: } 7699: if ($cmp1 eq $cmp2) { 7700: push(@readonly_files, $file_name); 7701: last; 7702: } elsif (!defined($what)) { 7703: push(@readonly_files, $file_name); 7704: last; 7705: } 7706: } 7707: } 7708: } 7709: return @readonly_files; 7710: } 7711: #-----------------------------------------------------------Get Marked as Read Only Hash 7712: 7713: sub get_marked_as_readonly_hash { 7714: my ($current_permissions,$group,$what) = @_; 7715: my %readonly_files; 7716: while (my ($file_name,$value) = each(%{$current_permissions})) { 7717: if (defined($group)) { 7718: if ($file_name !~ m-^\Q$group\E/-) { 7719: next; 7720: } 7721: } 7722: if (ref($value) eq "ARRAY"){ 7723: foreach my $stored_what (@{$value}) { 7724: if (ref($stored_what) eq 'ARRAY') { 7725: foreach my $lock_descriptor(@{$stored_what}) { 7726: if ($lock_descriptor eq 'graded') { 7727: $readonly_files{$file_name} = 'graded'; 7728: } elsif ($lock_descriptor eq 'handback') { 7729: $readonly_files{$file_name} = 'handback'; 7730: } else { 7731: if (!exists($readonly_files{$file_name})) { 7732: $readonly_files{$file_name} = 'locked'; 7733: } 7734: } 7735: } 7736: } 7737: } 7738: } 7739: } 7740: return %readonly_files; 7741: } 7742: # ------------------------------------------------------------ Unmark as Read Only 7743: 7744: sub unmark_as_readonly { 7745: # unmarks $file_name (if $file_name is defined), or all files locked by $what 7746: # for portfolio submissions, $what contains [$symb,$crsid] 7747: my ($domain,$user,$what,$file_name,$group) = @_; 7748: $file_name = &declutter_portfile($file_name); 7749: my $symb_crs = $what; 7750: if (ref($what)) { $symb_crs=join('',@$what); } 7751: my %current_permissions = &dump('file_permissions',$domain,$user,$group); 7752: my ($tmp)=keys(%current_permissions); 7753: if ($tmp=~/^error:/) { undef(%current_permissions); } 7754: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group); 7755: foreach my $file (@readonly_files) { 7756: my $clean_file = &declutter_portfile($file); 7757: if (defined($file_name) && ($file_name ne $clean_file)) { next; } 7758: my $current_locks = $current_permissions{$file}; 7759: my @new_locks; 7760: my @del_keys; 7761: if (ref($current_locks) eq "ARRAY"){ 7762: foreach my $locker (@{$current_locks}) { 7763: my $compare=$locker; 7764: if (ref($locker) eq 'ARRAY') { 7765: $compare=join('',@{$locker}); 7766: if ($compare ne $symb_crs) { 7767: push(@new_locks, $locker); 7768: } 7769: } 7770: } 7771: if (scalar(@new_locks) > 0) { 7772: $current_permissions{$file} = \@new_locks; 7773: } else { 7774: push(@del_keys, $file); 7775: &del('file_permissions',\@del_keys, $domain, $user); 7776: delete($current_permissions{$file}); 7777: } 7778: } 7779: } 7780: &put('file_permissions',\%current_permissions,$domain,$user); 7781: return; 7782: } 7783: 7784: # ------------------------------------------------------------ Directory lister 7785: 7786: sub dirlist { 7787: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_; 7788: $uri=~s/^\///; 7789: $uri=~s/\/$//; 7790: my ($udom, $uname); 7791: if ($getuserdir) { 7792: $udom = $userdomain; 7793: $uname = $username; 7794: } else { 7795: (undef,$udom,$uname)=split(/\//,$uri); 7796: if(defined($userdomain)) { 7797: $udom = $userdomain; 7798: } 7799: if(defined($username)) { 7800: $uname = $username; 7801: } 7802: } 7803: my ($dirRoot,$listing,@listing_results); 7804: 7805: $dirRoot = $perlvar{'lonDocRoot'}; 7806: if (defined($getpropath)) { 7807: $dirRoot = &propath($udom,$uname); 7808: $dirRoot =~ s/\/$//; 7809: } elsif (defined($getuserdir)) { 7810: my $subdir=$uname.'__'; 7811: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/; 7812: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'} 7813: ."/$udom/$subdir/$uname"; 7814: } elsif (defined($alternateRoot)) { 7815: $dirRoot = $alternateRoot; 7816: } 7817: 7818: if($udom) { 7819: if($uname) { 7820: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':' 7821: .$getuserdir.':'.&escape($dirRoot) 7822: .':'.&escape($uname).':'.&escape($udom), 7823: &homeserver($uname,$udom)); 7824: if ($listing eq 'unknown_cmd') { 7825: $listing = &reply('ls2:'.$dirRoot.'/'.$uri, 7826: &homeserver($uname,$udom)); 7827: } else { 7828: @listing_results = map { &unescape($_); } split(/:/,$listing); 7829: } 7830: if ($listing eq 'unknown_cmd') { 7831: $listing = &reply('ls:'.$dirRoot.'/'.$uri, 7832: &homeserver($uname,$udom)); 7833: @listing_results = split(/:/,$listing); 7834: } else { 7835: @listing_results = map { &unescape($_); } split(/:/,$listing); 7836: } 7837: return @listing_results; 7838: } elsif(!$alternateRoot) { 7839: my %allusers; 7840: my %servers = &get_servers($udom,'library'); 7841: foreach my $tryserver (keys(%servers)) { 7842: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'. 7843: &escape($udom),$tryserver); 7844: if ($listing eq 'unknown_cmd') { 7845: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'. 7846: $udom, $tryserver); 7847: } else { 7848: @listing_results = map { &unescape($_); } split(/:/,$listing); 7849: } 7850: if ($listing eq 'unknown_cmd') { 7851: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'. 7852: $udom, $tryserver); 7853: @listing_results = split(/:/,$listing); 7854: } else { 7855: @listing_results = 7856: map { &unescape($_); } split(/:/,$listing); 7857: } 7858: if ($listing_results[0] ne 'no_such_dir' && 7859: $listing_results[0] ne 'empty' && 7860: $listing_results[0] ne 'con_lost') { 7861: foreach my $line (@listing_results) { 7862: my ($entry) = split(/&/,$line,2); 7863: $allusers{$entry} = 1; 7864: } 7865: } 7866: } 7867: my $alluserstr=''; 7868: foreach my $user (sort(keys(%allusers))) { 7869: $alluserstr.=$user.'&user:'; 7870: } 7871: $alluserstr=~s/:$//; 7872: return split(/:/,$alluserstr); 7873: } else { 7874: return ('missing user name'); 7875: } 7876: } elsif(!defined($getpropath)) { 7877: my @all_domains = sort(&all_domains()); 7878: foreach my $domain (@all_domains) { 7879: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain'; 7880: } 7881: return @all_domains; 7882: } else { 7883: return ('missing domain'); 7884: } 7885: } 7886: 7887: # --------------------------------------------- GetFileTimestamp 7888: # This function utilizes dirlist and returns the date stamp for 7889: # when it was last modified. It will also return an error of -1 7890: # if an error occurs 7891: 7892: sub GetFileTimestamp { 7893: my ($studentDomain,$studentName,$filename,$getuserdir)=@_; 7894: $studentDomain = &LONCAPA::clean_domain($studentDomain); 7895: $studentName = &LONCAPA::clean_username($studentName); 7896: my ($fileStat) = 7897: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName, 7898: undef,$getuserdir); 7899: my @stats = split('&', $fileStat); 7900: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7901: # @stats contains first the filename, then the stat output 7902: return $stats[10]; # so this is 10 instead of 9. 7903: } else { 7904: return -1; 7905: } 7906: } 7907: 7908: sub stat_file { 7909: my ($uri) = @_; 7910: $uri = &clutter_with_no_wrapper($uri); 7911: 7912: my ($udom,$uname,$file); 7913: if ($uri =~ m-^/(uploaded|editupload)/-) { 7914: ($udom,$uname,$file) = 7915: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-); 7916: $file = 'userfiles/'.$file; 7917: } 7918: if ($uri =~ m-^/res/-) { 7919: ($udom,$uname) = 7920: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-); 7921: $file = $uri; 7922: } 7923: 7924: if (!$udom || !$uname || !$file) { 7925: # unable to handle the uri 7926: return (); 7927: } 7928: my $getpropath; 7929: if ($file =~ /^userfiles\//) { 7930: $getpropath = 1; 7931: } 7932: my ($result) = &dirlist($file,$udom,$uname,$getpropath); 7933: my @stats = split('&', $result); 7934: 7935: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7936: shift(@stats); #filename is first 7937: return @stats; 7938: } 7939: return (); 7940: } 7941: 7942: # -------------------------------------------------------- Value of a Condition 7943: 7944: # gets the value of a specific preevaluated condition 7945: # stored in the string $env{user.state.<cid>} 7946: # or looks up a condition reference in the bighash and if if hasn't 7947: # already been evaluated recurses into docondval to get the value of 7948: # the condition, then memoizing it to 7949: # $env{user.state.<cid>.<condition>} 7950: sub directcondval { 7951: my $number=shift; 7952: if (!defined($env{'user.state.'.$env{'request.course.id'}})) { 7953: &Apache::lonuserstate::evalstate(); 7954: } 7955: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) { 7956: return $env{'user.state.'.$env{'request.course.id'}.".$number"}; 7957: } elsif ($number =~ /^_/) { 7958: my $sub_condition; 7959: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 7960: &GDBM_READER(),0640)) { 7961: $sub_condition=$bighash{'conditions'.$number}; 7962: untie(%bighash); 7963: } 7964: my $value = &docondval($sub_condition); 7965: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value}); 7966: return $value; 7967: } 7968: if ($env{'user.state.'.$env{'request.course.id'}}) { 7969: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1); 7970: } else { 7971: return 2; 7972: } 7973: } 7974: 7975: # get the collection of conditions for this resource 7976: sub condval { 7977: my $condidx=shift; 7978: my $allpathcond=''; 7979: foreach my $cond (split(/\|/,$condidx)) { 7980: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) { 7981: $allpathcond.= 7982: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|'; 7983: } 7984: } 7985: $allpathcond=~s/\|$//; 7986: return &docondval($allpathcond); 7987: } 7988: 7989: #evaluates an expression of conditions 7990: sub docondval { 7991: my ($allpathcond) = @_; 7992: my $result=0; 7993: if ($env{'request.course.id'} 7994: && defined($allpathcond)) { 7995: my $operand='|'; 7996: my @stack; 7997: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) { 7998: if ($chunk eq '(') { 7999: push @stack,($operand,$result); 8000: } elsif ($chunk eq ')') { 8001: my $before=pop @stack; 8002: if (pop @stack eq '&') { 8003: $result=$result>$before?$before:$result; 8004: } else { 8005: $result=$result>$before?$result:$before; 8006: } 8007: } elsif (($chunk eq '&') || ($chunk eq '|')) { 8008: $operand=$chunk; 8009: } else { 8010: my $new=directcondval($chunk); 8011: if ($operand eq '&') { 8012: $result=$result>$new?$new:$result; 8013: } else { 8014: $result=$result>$new?$result:$new; 8015: } 8016: } 8017: } 8018: } 8019: return $result; 8020: } 8021: 8022: # ---------------------------------------------------- Devalidate courseresdata 8023: 8024: sub devalidatecourseresdata { 8025: my ($coursenum,$coursedomain)=@_; 8026: my $hashid=$coursenum.':'.$coursedomain; 8027: &devalidate_cache_new('courseres',$hashid); 8028: } 8029: 8030: 8031: # --------------------------------------------------- Course Resourcedata Query 8032: # 8033: # Parameters: 8034: # $coursenum - Number of the course. 8035: # $coursedomain - Domain at which the course was created. 8036: # Returns: 8037: # A hash of the course parameters along (I think) with timestamps 8038: # and version info. 8039: 8040: sub get_courseresdata { 8041: my ($coursenum,$coursedomain)=@_; 8042: my $coursehom=&homeserver($coursenum,$coursedomain); 8043: my $hashid=$coursenum.':'.$coursedomain; 8044: my ($result,$cached)=&is_cached_new('courseres',$hashid); 8045: my %dumpreply; 8046: unless (defined($cached)) { 8047: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum); 8048: $result=\%dumpreply; 8049: my ($tmp) = keys(%dumpreply); 8050: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 8051: &do_cache_new('courseres',$hashid,$result,600); 8052: } elsif ($tmp =~ /^(con_lost|no_such_host)/) { 8053: return $tmp; 8054: } elsif ($tmp =~ /^(error)/) { 8055: $result=undef; 8056: &do_cache_new('courseres',$hashid,$result,600); 8057: } 8058: } 8059: return $result; 8060: } 8061: 8062: sub devalidateuserresdata { 8063: my ($uname,$udom)=@_; 8064: my $hashid="$udom:$uname"; 8065: &devalidate_cache_new('userres',$hashid); 8066: } 8067: 8068: sub get_userresdata { 8069: my ($uname,$udom)=@_; 8070: #most student don\'t have any data set, check if there is some data 8071: if (&EXT_cache_status($udom,$uname)) { return undef; } 8072: 8073: my $hashid="$udom:$uname"; 8074: my ($result,$cached)=&is_cached_new('userres',$hashid); 8075: if (!defined($cached)) { 8076: my %resourcedata=&dump('resourcedata',$udom,$uname); 8077: $result=\%resourcedata; 8078: &do_cache_new('userres',$hashid,$result,600); 8079: } 8080: my ($tmp)=keys(%$result); 8081: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) { 8082: return $result; 8083: } 8084: #error 2 occurs when the .db doesn't exist 8085: if ($tmp!~/error: 2 /) { 8086: &logthis("<font color=\"blue\">WARNING:". 8087: " Trying to get resource data for ". 8088: $uname." at ".$udom.": ". 8089: $tmp."</font>"); 8090: } elsif ($tmp=~/error: 2 /) { 8091: #&EXT_cache_set($udom,$uname); 8092: &do_cache_new('userres',$hashid,undef,600); 8093: undef($tmp); # not really an error so don't send it back 8094: } 8095: return $tmp; 8096: } 8097: #----------------------------------------------- resdata - return resource data 8098: # Purpose: 8099: # Return resource data for either users or for a course. 8100: # Parameters: 8101: # $name - Course/user name. 8102: # $domain - Name of the domain the user/course is registered on. 8103: # $type - Type of thing $name is (must be 'course' or 'user' 8104: # @which - Array of names of resources desired. 8105: # Returns: 8106: # The value of the first reasource in @which that is found in the 8107: # resource hash. 8108: # Exceptional Conditions: 8109: # If the $type passed in is not valid (not the string 'course' or 8110: # 'user', an undefined reference is returned. 8111: # If none of the resources are found, an undef is returned 8112: sub resdata { 8113: my ($name,$domain,$type,@which)=@_; 8114: my $result; 8115: if ($type eq 'course') { 8116: $result=&get_courseresdata($name,$domain); 8117: } elsif ($type eq 'user') { 8118: $result=&get_userresdata($name,$domain); 8119: } 8120: if (!ref($result)) { return $result; } 8121: foreach my $item (@which) { 8122: if (defined($result->{$item->[0]})) { 8123: return [$result->{$item->[0]},$item->[1]]; 8124: } 8125: } 8126: return undef; 8127: } 8128: 8129: # 8130: # EXT resource caching routines 8131: # 8132: 8133: sub clear_EXT_cache_status { 8134: &delenv('cache.EXT.'); 8135: } 8136: 8137: sub EXT_cache_status { 8138: my ($target_domain,$target_user) = @_; 8139: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 8140: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) { 8141: # We know already the user has no data 8142: return 1; 8143: } else { 8144: return 0; 8145: } 8146: } 8147: 8148: sub EXT_cache_set { 8149: my ($target_domain,$target_user) = @_; 8150: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 8151: #&appenv({$cachename => time}); 8152: } 8153: 8154: # --------------------------------------------------------- Value of a Variable 8155: sub EXT { 8156: 8157: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_; 8158: unless ($varname) { return ''; } 8159: #get real user name/domain, courseid and symb 8160: my $courseid; 8161: my $publicuser; 8162: if ($symbparm) { 8163: $symbparm=&get_symb_from_alias($symbparm); 8164: } 8165: if (!($uname && $udom)) { 8166: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm); 8167: if (!$symbparm) { $symbparm=$cursymb; } 8168: } else { 8169: $courseid=$env{'request.course.id'}; 8170: } 8171: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname); 8172: my $rest; 8173: if (defined($therest[0])) { 8174: $rest=join('.',@therest); 8175: } else { 8176: $rest=''; 8177: } 8178: 8179: my $qualifierrest=$qualifier; 8180: if ($rest) { $qualifierrest.='.'.$rest; } 8181: my $spacequalifierrest=$space; 8182: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; } 8183: if ($realm eq 'user') { 8184: # --------------------------------------------------------------- user.resource 8185: if ($space eq 'resource') { 8186: if ( (defined($Apache::lonhomework::parsing_a_problem) 8187: || defined($Apache::lonhomework::parsing_a_task)) 8188: && 8189: ($symbparm eq &symbread()) ) { 8190: # if we are in the middle of processing the resource the 8191: # get the value we are planning on committing 8192: if (defined($Apache::lonhomework::results{$qualifierrest})) { 8193: return $Apache::lonhomework::results{$qualifierrest}; 8194: } else { 8195: return $Apache::lonhomework::history{$qualifierrest}; 8196: } 8197: } else { 8198: my %restored; 8199: if ($publicuser || $env{'request.state'} eq 'construct') { 8200: %restored=&tmprestore($symbparm,$courseid,$udom,$uname); 8201: } else { 8202: %restored=&restore($symbparm,$courseid,$udom,$uname); 8203: } 8204: return $restored{$qualifierrest}; 8205: } 8206: # ----------------------------------------------------------------- user.access 8207: } elsif ($space eq 'access') { 8208: # FIXME - not supporting calls for a specific user 8209: return &allowed($qualifier,$rest); 8210: # ------------------------------------------ user.preferences, user.environment 8211: } elsif (($space eq 'preferences') || ($space eq 'environment')) { 8212: if (($uname eq $env{'user.name'}) && 8213: ($udom eq $env{'user.domain'})) { 8214: return $env{join('.',('environment',$qualifierrest))}; 8215: } else { 8216: my %returnhash; 8217: if (!$publicuser) { 8218: %returnhash=&userenvironment($udom,$uname, 8219: $qualifierrest); 8220: } 8221: return $returnhash{$qualifierrest}; 8222: } 8223: # ----------------------------------------------------------------- user.course 8224: } elsif ($space eq 'course') { 8225: # FIXME - not supporting calls for a specific user 8226: return $env{join('.',('request.course',$qualifier))}; 8227: # ------------------------------------------------------------------- user.role 8228: } elsif ($space eq 'role') { 8229: # FIXME - not supporting calls for a specific user 8230: my ($role,$where)=split(/\./,$env{'request.role'}); 8231: if ($qualifier eq 'value') { 8232: return $role; 8233: } elsif ($qualifier eq 'extent') { 8234: return $where; 8235: } 8236: # ----------------------------------------------------------------- user.domain 8237: } elsif ($space eq 'domain') { 8238: return $udom; 8239: # ------------------------------------------------------------------- user.name 8240: } elsif ($space eq 'name') { 8241: return $uname; 8242: # ---------------------------------------------------- Any other user namespace 8243: } else { 8244: my %reply; 8245: if (!$publicuser) { 8246: %reply=&get($space,[$qualifierrest],$udom,$uname); 8247: } 8248: return $reply{$qualifierrest}; 8249: } 8250: } elsif ($realm eq 'query') { 8251: # ---------------------------------------------- pull stuff out of query string 8252: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 8253: [$spacequalifierrest]); 8254: return $env{'form.'.$spacequalifierrest}; 8255: } elsif ($realm eq 'request') { 8256: # ------------------------------------------------------------- request.browser 8257: if ($space eq 'browser') { 8258: if ($qualifier eq 'textremote') { 8259: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') { 8260: return 1; 8261: } else { 8262: return 0; 8263: } 8264: } else { 8265: return $env{'browser.'.$qualifier}; 8266: } 8267: # ------------------------------------------------------------ request.filename 8268: } else { 8269: return $env{'request.'.$spacequalifierrest}; 8270: } 8271: } elsif ($realm eq 'course') { 8272: # ---------------------------------------------------------- course.description 8273: return $env{'course.'.$courseid.'.'.$spacequalifierrest}; 8274: } elsif ($realm eq 'resource') { 8275: 8276: if (defined($courseid) && $courseid eq $env{'request.course.id'}) { 8277: if (!$symbparm) { $symbparm=&symbread(); } 8278: } 8279: 8280: if ($space eq 'title') { 8281: if (!$symbparm) { $symbparm = $env{'request.filename'}; } 8282: return &gettitle($symbparm); 8283: } 8284: 8285: if ($space eq 'map') { 8286: my ($map) = &decode_symb($symbparm); 8287: return &symbread($map); 8288: } 8289: if ($space eq 'filename') { 8290: if ($symbparm) { 8291: return &clutter((&decode_symb($symbparm))[2]); 8292: } 8293: return &hreflocation('',$env{'request.filename'}); 8294: } 8295: 8296: my ($section, $group, @groups); 8297: my ($courselevelm,$courselevel); 8298: if ($symbparm && defined($courseid) && 8299: $courseid eq $env{'request.course.id'}) { 8300: 8301: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest; 8302: 8303: # ----------------------------------------------------- Cascading lookup scheme 8304: my $symbp=$symbparm; 8305: my $mapp=&deversion((&decode_symb($symbp))[0]); 8306: 8307: my $symbparm=$symbp.'.'.$spacequalifierrest; 8308: my $mapparm=$mapp.'___(all).'.$spacequalifierrest; 8309: 8310: if (($env{'user.name'} eq $uname) && 8311: ($env{'user.domain'} eq $udom)) { 8312: $section=$env{'request.course.sec'}; 8313: @groups = split(/:/,$env{'request.course.groups'}); 8314: @groups=&sort_course_groups($courseid,@groups); 8315: } else { 8316: if (! defined($usection)) { 8317: $section=&getsection($udom,$uname,$courseid); 8318: } else { 8319: $section = $usection; 8320: } 8321: @groups = &get_users_groups($udom,$uname,$courseid); 8322: } 8323: 8324: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest; 8325: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm; 8326: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm; 8327: 8328: $courselevel=$courseid.'.'.$spacequalifierrest; 8329: my $courselevelr=$courseid.'.'.$symbparm; 8330: $courselevelm=$courseid.'.'.$mapparm; 8331: 8332: # ----------------------------------------------------------- first, check user 8333: 8334: my $userreply=&resdata($uname,$udom,'user', 8335: ([$courselevelr,'resource'], 8336: [$courselevelm,'map' ], 8337: [$courselevel, 'course' ])); 8338: if (defined($userreply)) { return &get_reply($userreply); } 8339: 8340: # ------------------------------------------------ second, check some of course 8341: my $coursereply; 8342: if (@groups > 0) { 8343: $coursereply = &check_group_parms($courseid,\@groups,$symbparm, 8344: $mapparm,$spacequalifierrest); 8345: if (defined($coursereply)) { return &get_reply($coursereply); } 8346: } 8347: 8348: $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 8349: $env{'course.'.$courseid.'.domain'}, 8350: 'course', 8351: ([$seclevelr, 'resource'], 8352: [$seclevelm, 'map' ], 8353: [$seclevel, 'course' ], 8354: [$courselevelr,'resource'])); 8355: if (defined($coursereply)) { return &get_reply($coursereply); } 8356: 8357: # ------------------------------------------------------ third, check map parms 8358: my %parmhash=(); 8359: my $thisparm=''; 8360: if (tie(%parmhash,'GDBM_File', 8361: $env{'request.course.fn'}.'_parms.db', 8362: &GDBM_READER(),0640)) { 8363: $thisparm=$parmhash{$symbparm}; 8364: untie(%parmhash); 8365: } 8366: if ($thisparm) { return &get_reply([$thisparm,'resource']); } 8367: } 8368: # ------------------------------------------ fourth, look in resource metadata 8369: 8370: $spacequalifierrest=~s/\./\_/; 8371: my $filename; 8372: if (!$symbparm) { $symbparm=&symbread(); } 8373: if ($symbparm) { 8374: $filename=(&decode_symb($symbparm))[2]; 8375: } else { 8376: $filename=$env{'request.filename'}; 8377: } 8378: my $metadata=&metadata($filename,$spacequalifierrest); 8379: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 8380: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest); 8381: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 8382: 8383: # ---------------------------------------------- fourth, look in rest of course 8384: if ($symbparm && defined($courseid) && 8385: $courseid eq $env{'request.course.id'}) { 8386: my $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 8387: $env{'course.'.$courseid.'.domain'}, 8388: 'course', 8389: ([$courselevelm,'map' ], 8390: [$courselevel, 'course'])); 8391: if (defined($coursereply)) { return &get_reply($coursereply); } 8392: } 8393: # ------------------------------------------------------------------ Cascade up 8394: unless ($space eq '0') { 8395: my @parts=split(/_/,$space); 8396: my $id=pop(@parts); 8397: my $part=join('_',@parts); 8398: if ($part eq '') { $part='0'; } 8399: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest, 8400: $symbparm,$udom,$uname,$section,1); 8401: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); } 8402: } 8403: if ($recurse) { return undef; } 8404: my $pack_def=&packages_tab_default($filename,$varname); 8405: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); } 8406: # ---------------------------------------------------- Any other user namespace 8407: } elsif ($realm eq 'environment') { 8408: # ----------------------------------------------------------------- environment 8409: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) { 8410: return $env{'environment.'.$spacequalifierrest}; 8411: } else { 8412: if ($uname eq 'anonymous' && $udom eq '') { 8413: return ''; 8414: } 8415: my %returnhash=&userenvironment($udom,$uname, 8416: $spacequalifierrest); 8417: return $returnhash{$spacequalifierrest}; 8418: } 8419: } elsif ($realm eq 'system') { 8420: # ----------------------------------------------------------------- system.time 8421: if ($space eq 'time') { 8422: return time; 8423: } 8424: } elsif ($realm eq 'server') { 8425: # ----------------------------------------------------------------- system.time 8426: if ($space eq 'name') { 8427: return $ENV{'SERVER_NAME'}; 8428: } 8429: } 8430: return ''; 8431: } 8432: 8433: sub get_reply { 8434: my ($reply_value) = @_; 8435: if (ref($reply_value) eq 'ARRAY') { 8436: if (wantarray) { 8437: return @$reply_value; 8438: } 8439: return $reply_value->[0]; 8440: } else { 8441: return $reply_value; 8442: } 8443: } 8444: 8445: sub check_group_parms { 8446: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_; 8447: my @groupitems = (); 8448: my $resultitem; 8449: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']); 8450: foreach my $group (@{$groups}) { 8451: foreach my $level (@levels) { 8452: my $item = $courseid.'.['.$group.'].'.$level->[0]; 8453: push(@groupitems,[$item,$level->[1]]); 8454: } 8455: } 8456: my $coursereply = &resdata($env{'course.'.$courseid.'.num'}, 8457: $env{'course.'.$courseid.'.domain'}, 8458: 'course',@groupitems); 8459: return $coursereply; 8460: } 8461: 8462: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort(). 8463: my ($courseid,@groups) = @_; 8464: @groups = sort(@groups); 8465: return @groups; 8466: } 8467: 8468: sub packages_tab_default { 8469: my ($uri,$varname)=@_; 8470: my (undef,$part,$name)=split(/\./,$varname); 8471: 8472: my (@extension,@specifics,$do_default); 8473: foreach my $package (split(/,/,&metadata($uri,'packages'))) { 8474: my ($pack_type,$pack_part)=split(/_/,$package,2); 8475: if ($pack_type eq 'default') { 8476: $do_default=1; 8477: } elsif ($pack_type eq 'extension') { 8478: push(@extension,[$package,$pack_type,$pack_part]); 8479: } elsif ($pack_part eq $part || $pack_type eq 'part') { 8480: # only look at packages defaults for packages that this id is 8481: push(@specifics,[$package,$pack_type,$pack_part]); 8482: } 8483: } 8484: # first look for a package that matches the requested part id 8485: foreach my $package (@specifics) { 8486: my (undef,$pack_type,$pack_part)=@{$package}; 8487: next if ($pack_part ne $part); 8488: if (defined($packagetab{"$pack_type&$name&default"})) { 8489: return $packagetab{"$pack_type&$name&default"}; 8490: } 8491: } 8492: # look for any possible matching non extension_ package 8493: foreach my $package (@specifics) { 8494: my (undef,$pack_type,$pack_part)=@{$package}; 8495: if (defined($packagetab{"$pack_type&$name&default"})) { 8496: return $packagetab{"$pack_type&$name&default"}; 8497: } 8498: if ($pack_type eq 'part') { $pack_part='0'; } 8499: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) { 8500: return $packagetab{$pack_type."_".$pack_part."&$name&default"}; 8501: } 8502: } 8503: # look for any posible extension_ match 8504: foreach my $package (@extension) { 8505: my ($package,$pack_type)=@{$package}; 8506: if (defined($packagetab{"$pack_type&$name&default"})) { 8507: return $packagetab{"$pack_type&$name&default"}; 8508: } 8509: if (defined($packagetab{$package."&$name&default"})) { 8510: return $packagetab{$package."&$name&default"}; 8511: } 8512: } 8513: # look for a global default setting 8514: if ($do_default && defined($packagetab{"default&$name&default"})) { 8515: return $packagetab{"default&$name&default"}; 8516: } 8517: return undef; 8518: } 8519: 8520: sub add_prefix_and_part { 8521: my ($prefix,$part)=@_; 8522: my $keyroot; 8523: if (defined($prefix) && $prefix !~ /^__/) { 8524: # prefix that has a part already 8525: $keyroot=$prefix; 8526: } elsif (defined($prefix)) { 8527: # prefix that is missing a part 8528: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); } 8529: } else { 8530: # no prefix at all 8531: if (defined($part)) { $keyroot='_'.$part; } 8532: } 8533: return $keyroot; 8534: } 8535: 8536: # ---------------------------------------------------------------- Get metadata 8537: 8538: my %metaentry; 8539: my %importedpartids; 8540: sub metadata { 8541: my ($uri,$what,$liburi,$prefix,$depthcount)=@_; 8542: $uri=&declutter($uri); 8543: # if it is a non metadata possible uri return quickly 8544: if (($uri eq '') || 8545: (($uri =~ m|^/*adm/|) && 8546: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) || 8547: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) { 8548: return undef; 8549: } 8550: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) 8551: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) { 8552: return undef; 8553: } 8554: my $filename=$uri; 8555: $uri=~s/\.meta$//; 8556: # 8557: # Is the metadata already cached? 8558: # Look at timestamp of caching 8559: # Everything is cached by the main uri, libraries are never directly cached 8560: # 8561: if (!defined($liburi)) { 8562: my ($result,$cached)=&is_cached_new('meta',$uri); 8563: if (defined($cached)) { return $result->{':'.$what}; } 8564: } 8565: { 8566: # Imported parts would go here 8567: my %importedids=(); 8568: my @origfileimportpartids=(); 8569: my $importedparts=0; 8570: # 8571: # Is this a recursive call for a library? 8572: # 8573: # if (! exists($metacache{$uri})) { 8574: # $metacache{$uri}={}; 8575: # } 8576: my $cachetime = 60*60; 8577: if ($liburi) { 8578: $liburi=&declutter($liburi); 8579: $filename=$liburi; 8580: } else { 8581: &devalidate_cache_new('meta',$uri); 8582: undef(%metaentry); 8583: } 8584: my %metathesekeys=(); 8585: unless ($filename=~/\.meta$/) { $filename.='.meta'; } 8586: my $metastring; 8587: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) { 8588: my $which = &hreflocation('','/'.($liburi || $uri)); 8589: $metastring = 8590: &Apache::lonnet::ssi_body($which, 8591: ('grade_target' => 'meta')); 8592: $cachetime = 1; # only want this cached in the child not long term 8593: } elsif (($uri !~ m -^(editupload)/-) && 8594: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) { 8595: my $file=&filelocation('',&clutter($filename)); 8596: #push(@{$metaentry{$uri.'.file'}},$file); 8597: $metastring=&getfile($file); 8598: } 8599: my $parser=HTML::LCParser->new(\$metastring); 8600: my $token; 8601: undef %metathesekeys; 8602: while ($token=$parser->get_token) { 8603: if ($token->[0] eq 'S') { 8604: if (defined($token->[2]->{'package'})) { 8605: # 8606: # This is a package - get package info 8607: # 8608: my $package=$token->[2]->{'package'}; 8609: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8610: if (defined($token->[2]->{'id'})) { 8611: $keyroot.='_'.$token->[2]->{'id'}; 8612: } 8613: if ($metaentry{':packages'}) { 8614: $metaentry{':packages'}.=','.$package.$keyroot; 8615: } else { 8616: $metaentry{':packages'}=$package.$keyroot; 8617: } 8618: foreach my $pack_entry (keys(%packagetab)) { 8619: my $part=$keyroot; 8620: $part=~s/^\_//; 8621: if ($pack_entry=~/^\Q$package\E\&/ || 8622: $pack_entry=~/^\Q$package\E_0\&/) { 8623: my ($pack,$name,$subp)=split(/\&/,$pack_entry); 8624: # ignore package.tab specified default values 8625: # here &package_tab_default() will fetch those 8626: if ($subp eq 'default') { next; } 8627: my $value=$packagetab{$pack_entry}; 8628: my $unikey; 8629: if ($pack =~ /_0$/) { 8630: $unikey='parameter_0_'.$name; 8631: $part=0; 8632: } else { 8633: $unikey='parameter'.$keyroot.'_'.$name; 8634: } 8635: if ($subp eq 'display') { 8636: $value.=' [Part: '.$part.']'; 8637: } 8638: $metaentry{':'.$unikey.'.part'}=$part; 8639: $metathesekeys{$unikey}=1; 8640: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8641: $metaentry{':'.$unikey.'.'.$subp}=$value; 8642: } 8643: if (defined($metaentry{':'.$unikey.'.default'})) { 8644: $metaentry{':'.$unikey}= 8645: $metaentry{':'.$unikey.'.default'}; 8646: } 8647: } 8648: } 8649: } else { 8650: # 8651: # This is not a package - some other kind of start tag 8652: # 8653: my $entry=$token->[1]; 8654: my $unikey=''; 8655: 8656: if ($entry eq 'import') { 8657: # 8658: # Importing a library here 8659: # 8660: my $location=$parser->get_text('/import'); 8661: my $dir=$filename; 8662: $dir=~s|[^/]*$||; 8663: $location=&filelocation($dir,$location); 8664: 8665: my $importmode=$token->[2]->{'importmode'}; 8666: if ($importmode eq 'problem') { 8667: # Import as problem/response 8668: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8669: } elsif ($importmode eq 'part') { 8670: # Import as part(s) 8671: $importedparts=1; 8672: # We need to get the original file and the imported file to get the part order correct 8673: # Good news: we do not need to worry about nested libraries, since parts cannot be nested 8674: # Load and inspect original file 8675: if ($#origfileimportpartids<0) { 8676: undef(%importedpartids); 8677: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri); 8678: my $origfile=&getfile($origfilelocation); 8679: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs); 8680: } 8681: 8682: # Load and inspect imported file 8683: my $impfile=&getfile($location); 8684: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs); 8685: if ($#impfilepartids>=0) { 8686: # This problem had parts 8687: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids); 8688: } else { 8689: # Importing by turning a single problem into a problem part 8690: # It gets the import-tags ID as part-ID 8691: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'}); 8692: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'}; 8693: } 8694: } else { 8695: # Normal import 8696: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8697: if (defined($token->[2]->{'id'})) { 8698: $unikey.='_'.$token->[2]->{'id'}; 8699: } 8700: } 8701: 8702: if ($depthcount<20) { 8703: my $metadata = 8704: &metadata($uri,'keys', $location,$unikey, 8705: $depthcount+1); 8706: foreach my $meta (split(',',$metadata)) { 8707: $metaentry{':'.$meta}=$metaentry{':'.$meta}; 8708: $metathesekeys{$meta}=1; 8709: } 8710: 8711: } 8712: } else { 8713: # 8714: # Not importing, some other kind of non-package, non-library start tag 8715: # 8716: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8717: if (defined($token->[2]->{'id'})) { 8718: $unikey.='_'.$token->[2]->{'id'}; 8719: } 8720: if (defined($token->[2]->{'name'})) { 8721: $unikey.='_'.$token->[2]->{'name'}; 8722: } 8723: $metathesekeys{$unikey}=1; 8724: foreach my $param (@{$token->[3]}) { 8725: $metaentry{':'.$unikey.'.'.$param} = 8726: $token->[2]->{$param}; 8727: } 8728: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry)); 8729: my $default=$metaentry{':'.$unikey.'.default'}; 8730: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) { 8731: # only ws inside the tag, and not in default, so use default 8732: # as value 8733: $metaentry{':'.$unikey}=$default; 8734: } elsif ( $internaltext =~ /\S/ ) { 8735: # something interesting inside the tag 8736: $metaentry{':'.$unikey}=$internaltext; 8737: } else { 8738: # no interesting values, don't set a default 8739: } 8740: # end of not-a-package not-a-library import 8741: } 8742: # end of not-a-package start tag 8743: } 8744: # the next is the end of "start tag" 8745: } 8746: } 8747: my ($extension) = ($uri =~ /\.(\w+)$/); 8748: $extension = lc($extension); 8749: if ($extension eq 'htm') { $extension='html'; } 8750: 8751: foreach my $key (keys(%packagetab)) { 8752: #no specific packages #how's our extension 8753: if ($key!~/^extension_\Q$extension\E&/) { next; } 8754: &metadata_create_package_def($uri,$key,'extension_'.$extension, 8755: \%metathesekeys); 8756: } 8757: 8758: if (!exists($metaentry{':packages'}) 8759: || $packagetab{"import_defaults&extension_$extension"}) { 8760: foreach my $key (keys(%packagetab)) { 8761: #no specific packages well let's get default then 8762: if ($key!~/^default&/) { next; } 8763: &metadata_create_package_def($uri,$key,'default', 8764: \%metathesekeys); 8765: } 8766: } 8767: # are there custom rights to evaluate 8768: if ($metaentry{':copyright'} eq 'custom') { 8769: 8770: # 8771: # Importing a rights file here 8772: # 8773: unless ($depthcount) { 8774: my $location=$metaentry{':customdistributionfile'}; 8775: my $dir=$filename; 8776: $dir=~s|[^/]*$||; 8777: $location=&filelocation($dir,$location); 8778: my $rights_metadata = 8779: &metadata($uri,'keys',$location,'_rights', 8780: $depthcount+1); 8781: foreach my $rights (split(',',$rights_metadata)) { 8782: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights}; 8783: $metathesekeys{$rights}=1; 8784: } 8785: } 8786: } 8787: # uniqifiy package listing 8788: my %seen; 8789: my @uniq_packages = 8790: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'})); 8791: $metaentry{':packages'} = join(',',@uniq_packages); 8792: 8793: if ($importedparts) { 8794: # We had imported parts and need to rebuild partorder 8795: $metaentry{':partorder'}=''; 8796: $metathesekeys{'partorder'}=1; 8797: for (my $index=0;$index<$#origfileimportpartids;$index+=2) { 8798: if ($origfileimportpartids[$index] eq 'part') { 8799: # original part, part of the problem 8800: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1]; 8801: } else { 8802: # we have imported parts at this position 8803: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]}; 8804: } 8805: } 8806: $metaentry{':partorder'}=~s/^\,//; 8807: } 8808: 8809: $metaentry{':keys'} = join(',',keys(%metathesekeys)); 8810: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri); 8811: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys); 8812: &do_cache_new('meta',$uri,\%metaentry,$cachetime); 8813: # this is the end of "was not already recently cached 8814: } 8815: return $metaentry{':'.$what}; 8816: } 8817: 8818: sub metadata_create_package_def { 8819: my ($uri,$key,$package,$metathesekeys)=@_; 8820: my ($pack,$name,$subp)=split(/\&/,$key); 8821: if ($subp eq 'default') { next; } 8822: 8823: if (defined($metaentry{':packages'})) { 8824: $metaentry{':packages'}.=','.$package; 8825: } else { 8826: $metaentry{':packages'}=$package; 8827: } 8828: my $value=$packagetab{$key}; 8829: my $unikey; 8830: $unikey='parameter_0_'.$name; 8831: $metaentry{':'.$unikey.'.part'}=0; 8832: $$metathesekeys{$unikey}=1; 8833: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8834: $metaentry{':'.$unikey.'.'.$subp}=$value; 8835: } 8836: if (defined($metaentry{':'.$unikey.'.default'})) { 8837: $metaentry{':'.$unikey}= 8838: $metaentry{':'.$unikey.'.default'}; 8839: } 8840: } 8841: 8842: sub metadata_generate_part0 { 8843: my ($metadata,$metacache,$uri) = @_; 8844: my %allnames; 8845: foreach my $metakey (keys(%$metadata)) { 8846: if ($metakey=~/^parameter\_(.*)/) { 8847: my $part=$$metacache{':'.$metakey.'.part'}; 8848: my $name=$$metacache{':'.$metakey.'.name'}; 8849: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) { 8850: $allnames{$name}=$part; 8851: } 8852: } 8853: } 8854: foreach my $name (keys(%allnames)) { 8855: $$metadata{"parameter_0_$name"}=1; 8856: my $key=":parameter_0_$name"; 8857: $$metacache{"$key.part"}='0'; 8858: $$metacache{"$key.name"}=$name; 8859: $$metacache{"$key.type"}=$$metacache{':parameter_'. 8860: $allnames{$name}.'_'.$name. 8861: '.type'}; 8862: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name. 8863: '.display'}; 8864: my $expr='[Part: '.$allnames{$name}.']'; 8865: $olddis=~s/\Q$expr\E/\[Part: 0\]/; 8866: $$metacache{"$key.display"}=$olddis; 8867: } 8868: } 8869: 8870: # ------------------------------------------------------ Devalidate title cache 8871: 8872: sub devalidate_title_cache { 8873: my ($url)=@_; 8874: if (!$env{'request.course.id'}) { return; } 8875: my $symb=&symbread($url); 8876: if (!$symb) { return; } 8877: my $key=$env{'request.course.id'}."\0".$symb; 8878: &devalidate_cache_new('title',$key); 8879: } 8880: 8881: # ------------------------------------------------- Get the title of a course 8882: 8883: sub current_course_title { 8884: return $env{ 'course.' . $env{'request.course.id'} . '.description' }; 8885: } 8886: # ------------------------------------------------- Get the title of a resource 8887: 8888: sub gettitle { 8889: my $urlsymb=shift; 8890: my $symb=&symbread($urlsymb); 8891: if ($symb) { 8892: my $key=$env{'request.course.id'}."\0".$symb; 8893: my ($result,$cached)=&is_cached_new('title',$key); 8894: if (defined($cached)) { 8895: return $result; 8896: } 8897: my ($map,$resid,$url)=&decode_symb($symb); 8898: my $title=''; 8899: if (!$map && $resid == 0 && $url =~/default\.sequence$/) { 8900: $title = $env{'course.'.$env{'request.course.id'}.'.description'}; 8901: } else { 8902: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8903: &GDBM_READER(),0640)) { 8904: my $mapid=$bighash{'map_pc_'.&clutter($map)}; 8905: $title=$bighash{'title_'.$mapid.'.'.$resid}; 8906: untie(%bighash); 8907: } 8908: } 8909: $title=~s/\&colon\;/\:/gs; 8910: if ($title) { 8911: return &do_cache_new('title',$key,$title,600); 8912: } 8913: $urlsymb=$url; 8914: } 8915: my $title=&metadata($urlsymb,'title'); 8916: if (!$title) { $title=(split('/',$urlsymb))[-1]; } 8917: return $title; 8918: } 8919: 8920: sub get_slot { 8921: my ($which,$cnum,$cdom)=@_; 8922: if (!$cnum || !$cdom) { 8923: (undef,my $courseid)=&whichuser(); 8924: $cdom=$env{'course.'.$courseid.'.domain'}; 8925: $cnum=$env{'course.'.$courseid.'.num'}; 8926: } 8927: my $key=join("\0",'slots',$cdom,$cnum,$which); 8928: my %slotinfo; 8929: if (exists($remembered{$key})) { 8930: $slotinfo{$which} = $remembered{$key}; 8931: } else { 8932: %slotinfo=&get('slots',[$which],$cdom,$cnum); 8933: &Apache::lonhomework::showhash(%slotinfo); 8934: my ($tmp)=keys(%slotinfo); 8935: if ($tmp=~/^error:/) { return (); } 8936: $remembered{$key} = $slotinfo{$which}; 8937: } 8938: if (ref($slotinfo{$which}) eq 'HASH') { 8939: return %{$slotinfo{$which}}; 8940: } 8941: return $slotinfo{$which}; 8942: } 8943: # ------------------------------------------------- Update symbolic store links 8944: 8945: sub symblist { 8946: my ($mapname,%newhash)=@_; 8947: $mapname=&deversion(&declutter($mapname)); 8948: my %hash; 8949: if (($env{'request.course.fn'}) && (%newhash)) { 8950: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 8951: &GDBM_WRCREAT(),0640)) { 8952: foreach my $url (keys(%newhash)) { 8953: next if ($url eq 'last_known' 8954: && $env{'form.no_update_last_known'}); 8955: $hash{declutter($url)}=&encode_symb($mapname, 8956: $newhash{$url}->[1], 8957: $newhash{$url}->[0]); 8958: } 8959: if (untie(%hash)) { 8960: return 'ok'; 8961: } 8962: } 8963: } 8964: return 'error'; 8965: } 8966: 8967: # --------------------------------------------------------------- Verify a symb 8968: 8969: sub symbverify { 8970: my ($symb,$thisurl)=@_; 8971: my $thisfn=$thisurl; 8972: $thisfn=&declutter($thisfn); 8973: # direct jump to resource in page or to a sequence - will construct own symbs 8974: if ($thisfn=~/\.(page|sequence)$/) { return 1; } 8975: # check URL part 8976: my ($map,$resid,$url)=&decode_symb($symb); 8977: 8978: unless ($url eq $thisfn) { return 0; } 8979: 8980: $symb=&symbclean($symb); 8981: $thisurl=&deversion($thisurl); 8982: $thisfn=&deversion($thisfn); 8983: 8984: my %bighash; 8985: my $okay=0; 8986: 8987: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8988: &GDBM_READER(),0640)) { 8989: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) { 8990: $thisurl =~ s/\?.+$//; 8991: } 8992: my $ids=$bighash{'ids_'.&clutter($thisurl)}; 8993: unless ($ids) { 8994: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl; 8995: $ids=$bighash{$idkey}; 8996: } 8997: if ($ids) { 8998: # ------------------------------------------------------------------- Has ID(s) 8999: foreach my $id (split(/\,/,$ids)) { 9000: my ($mapid,$resid)=split(/\./,$id); 9001: if ($thisfn =~ m{^/adm/wrapper/ext/}) { 9002: $symb =~ s/\?.+$//; 9003: } 9004: if ( 9005: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn) 9006: eq $symb) { 9007: if (($env{'request.role.adv'}) || 9008: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) || 9009: ($thisurl eq '/adm/navmaps')) { 9010: $okay=1; 9011: } 9012: } 9013: } 9014: } 9015: untie(%bighash); 9016: } 9017: return $okay; 9018: } 9019: 9020: # --------------------------------------------------------------- Clean-up symb 9021: 9022: sub symbclean { 9023: my $symb=shift; 9024: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 9025: # remove version from map 9026: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/; 9027: 9028: # remove version from URL 9029: $symb=~s/\.(\d+)\.(\w+)$/\.$2/; 9030: 9031: # remove wrapper 9032: 9033: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/; 9034: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/; 9035: return $symb; 9036: } 9037: 9038: # ---------------------------------------------- Split symb to find map and url 9039: 9040: sub encode_symb { 9041: my ($map,$resid,$url)=@_; 9042: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url)); 9043: } 9044: 9045: sub decode_symb { 9046: my $symb=shift; 9047: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 9048: my ($map,$resid,$url)=split(/___/,$symb); 9049: return (&fixversion($map),$resid,&fixversion($url)); 9050: } 9051: 9052: sub fixversion { 9053: my $fn=shift; 9054: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; } 9055: my %bighash; 9056: my $uri=&clutter($fn); 9057: my $key=$env{'request.course.id'}.'_'.$uri; 9058: # is this cached? 9059: my ($result,$cached)=&is_cached_new('courseresversion',$key); 9060: if (defined($cached)) { return $result; } 9061: # unfortunately not cached, or expired 9062: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 9063: &GDBM_READER(),0640)) { 9064: if ($bighash{'version_'.$uri}) { 9065: my $version=$bighash{'version_'.$uri}; 9066: unless (($version eq 'mostrecent') || 9067: ($version==&getversion($uri))) { 9068: $uri=~s/\.(\w+)$/\.$version\.$1/; 9069: } 9070: } 9071: untie %bighash; 9072: } 9073: return &do_cache_new('courseresversion',$key,&declutter($uri),600); 9074: } 9075: 9076: sub deversion { 9077: my $url=shift; 9078: $url=~s/\.\d+\.(\w+)$/\.$1/; 9079: return $url; 9080: } 9081: 9082: # ------------------------------------------------------ Return symb list entry 9083: 9084: sub symbread { 9085: my ($thisfn,$donotrecurse)=@_; 9086: my $cache_str='request.symbread.cached.'.$thisfn; 9087: if (defined($env{$cache_str})) { return $env{$cache_str}; } 9088: # no filename provided? try from environment 9089: unless ($thisfn) { 9090: if ($env{'request.symb'}) { 9091: return $env{$cache_str}=&symbclean($env{'request.symb'}); 9092: } 9093: $thisfn=$env{'request.filename'}; 9094: } 9095: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 9096: # is that filename actually a symb? Verify, clean, and return 9097: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) { 9098: if (&symbverify($thisfn,$1)) { 9099: return $env{$cache_str}=&symbclean($thisfn); 9100: } 9101: } 9102: $thisfn=declutter($thisfn); 9103: my %hash; 9104: my %bighash; 9105: my $syval=''; 9106: if (($env{'request.course.fn'}) && ($thisfn)) { 9107: my $targetfn = $thisfn; 9108: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) { 9109: $targetfn = 'adm/wrapper/'.$thisfn; 9110: } 9111: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) { 9112: $targetfn=$1; 9113: } 9114: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 9115: &GDBM_READER(),0640)) { 9116: $syval=$hash{$targetfn}; 9117: untie(%hash); 9118: } 9119: # ---------------------------------------------------------- There was an entry 9120: if ($syval) { 9121: #unless ($syval=~/\_\d+$/) { 9122: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) { 9123: #&appenv({'request.ambiguous' => $thisfn}); 9124: #return $env{$cache_str}=''; 9125: #} 9126: #$syval.=$1; 9127: #} 9128: } else { 9129: # ------------------------------------------------------- Was not in symb table 9130: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 9131: &GDBM_READER(),0640)) { 9132: # ---------------------------------------------- Get ID(s) for current resource 9133: my $ids=$bighash{'ids_'.&clutter($thisfn)}; 9134: unless ($ids) { 9135: $ids=$bighash{'ids_/'.$thisfn}; 9136: } 9137: unless ($ids) { 9138: # alias? 9139: $ids=$bighash{'mapalias_'.$thisfn}; 9140: } 9141: if ($ids) { 9142: # ------------------------------------------------------------------- Has ID(s) 9143: my @possibilities=split(/\,/,$ids); 9144: if ($#possibilities==0) { 9145: # ----------------------------------------------- There is only one possibility 9146: my ($mapid,$resid)=split(/\./,$ids); 9147: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 9148: $resid,$thisfn); 9149: } elsif (!$donotrecurse) { 9150: # ------------------------------------------ There is more than one possibility 9151: my $realpossible=0; 9152: foreach my $id (@possibilities) { 9153: my $file=$bighash{'src_'.$id}; 9154: if (&allowed('bre',$file)) { 9155: my ($mapid,$resid)=split(/\./,$id); 9156: if ($bighash{'map_type_'.$mapid} ne 'page') { 9157: $realpossible++; 9158: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 9159: $resid,$thisfn); 9160: } 9161: } 9162: } 9163: if ($realpossible!=1) { $syval=''; } 9164: } else { 9165: $syval=''; 9166: } 9167: } 9168: untie(%bighash) 9169: } 9170: } 9171: if ($syval) { 9172: return $env{$cache_str}=$syval; 9173: } 9174: } 9175: &appenv({'request.ambiguous' => $thisfn}); 9176: return $env{$cache_str}=''; 9177: } 9178: 9179: # ---------------------------------------------------------- Return random seed 9180: 9181: sub numval { 9182: my $txt=shift; 9183: $txt=~tr/A-J/0-9/; 9184: $txt=~tr/a-j/0-9/; 9185: $txt=~tr/K-T/0-9/; 9186: $txt=~tr/k-t/0-9/; 9187: $txt=~tr/U-Z/0-5/; 9188: $txt=~tr/u-z/0-5/; 9189: $txt=~s/\D//g; 9190: if ($_64bit) { if ($txt > 2**32) { return -1; } } 9191: return int($txt); 9192: } 9193: 9194: sub numval2 { 9195: my $txt=shift; 9196: $txt=~tr/A-J/0-9/; 9197: $txt=~tr/a-j/0-9/; 9198: $txt=~tr/K-T/0-9/; 9199: $txt=~tr/k-t/0-9/; 9200: $txt=~tr/U-Z/0-5/; 9201: $txt=~tr/u-z/0-5/; 9202: $txt=~s/\D//g; 9203: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 9204: my $total; 9205: foreach my $val (@txts) { $total+=$val; } 9206: if ($_64bit) { if ($total > 2**32) { return -1; } } 9207: return int($total); 9208: } 9209: 9210: sub numval3 { 9211: use integer; 9212: my $txt=shift; 9213: $txt=~tr/A-J/0-9/; 9214: $txt=~tr/a-j/0-9/; 9215: $txt=~tr/K-T/0-9/; 9216: $txt=~tr/k-t/0-9/; 9217: $txt=~tr/U-Z/0-5/; 9218: $txt=~tr/u-z/0-5/; 9219: $txt=~s/\D//g; 9220: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 9221: my $total; 9222: foreach my $val (@txts) { $total+=$val; } 9223: if ($_64bit) { $total=(($total<<32)>>32); } 9224: return $total; 9225: } 9226: 9227: sub digest { 9228: my ($data)=@_; 9229: my $digest=&Digest::MD5::md5($data); 9230: my ($a,$b,$c,$d)=unpack("iiii",$digest); 9231: my ($e,$f); 9232: { 9233: use integer; 9234: $e=($a+$b); 9235: $f=($c+$d); 9236: if ($_64bit) { 9237: $e=(($e<<32)>>32); 9238: $f=(($f<<32)>>32); 9239: } 9240: } 9241: if (wantarray) { 9242: return ($e,$f); 9243: } else { 9244: my $g; 9245: { 9246: use integer; 9247: $g=($e+$f); 9248: if ($_64bit) { 9249: $g=(($g<<32)>>32); 9250: } 9251: } 9252: return $g; 9253: } 9254: } 9255: 9256: sub latest_rnd_algorithm_id { 9257: return '64bit5'; 9258: } 9259: 9260: sub get_rand_alg { 9261: my ($courseid)=@_; 9262: if (!$courseid) { $courseid=(&whichuser())[1]; } 9263: if ($courseid) { 9264: return $env{"course.$courseid.rndseed"}; 9265: } 9266: return &latest_rnd_algorithm_id(); 9267: } 9268: 9269: sub validCODE { 9270: my ($CODE)=@_; 9271: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; } 9272: return 0; 9273: } 9274: 9275: sub getCODE { 9276: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; } 9277: if ( (defined($Apache::lonhomework::parsing_a_problem) || 9278: defined($Apache::lonhomework::parsing_a_task) ) && 9279: &validCODE($Apache::lonhomework::history{'resource.CODE'})) { 9280: return $Apache::lonhomework::history{'resource.CODE'}; 9281: } 9282: return undef; 9283: } 9284: 9285: sub rndseed { 9286: my ($symb,$courseid,$domain,$username)=@_; 9287: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser(); 9288: if (!defined($symb)) { 9289: unless ($symb=$wsymb) { return time; } 9290: } 9291: if (!$courseid) { $courseid=$wcourseid; } 9292: if (!$domain) { $domain=$wdomain; } 9293: if (!$username) { $username=$wusername } 9294: my $which=&get_rand_alg(); 9295: if (defined(&getCODE())) { 9296: if ($which eq '64bit5') { 9297: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username); 9298: } elsif ($which eq '64bit4') { 9299: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username); 9300: } else { 9301: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username); 9302: } 9303: } elsif ($which eq '64bit5') { 9304: return &rndseed_64bit5($symb,$courseid,$domain,$username); 9305: } elsif ($which eq '64bit4') { 9306: return &rndseed_64bit4($symb,$courseid,$domain,$username); 9307: } elsif ($which eq '64bit3') { 9308: return &rndseed_64bit3($symb,$courseid,$domain,$username); 9309: } elsif ($which eq '64bit2') { 9310: return &rndseed_64bit2($symb,$courseid,$domain,$username); 9311: } elsif ($which eq '64bit') { 9312: return &rndseed_64bit($symb,$courseid,$domain,$username); 9313: } 9314: return &rndseed_32bit($symb,$courseid,$domain,$username); 9315: } 9316: 9317: sub rndseed_32bit { 9318: my ($symb,$courseid,$domain,$username)=@_; 9319: { 9320: use integer; 9321: my $symbchck=unpack("%32C*",$symb) << 27; 9322: my $symbseed=numval($symb) << 22; 9323: my $namechck=unpack("%32C*",$username) << 17; 9324: my $nameseed=numval($username) << 12; 9325: my $domainseed=unpack("%32C*",$domain) << 7; 9326: my $courseseed=unpack("%32C*",$courseid); 9327: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck; 9328: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9329: #&logthis("rndseed :$num:$symb"); 9330: if ($_64bit) { $num=(($num<<32)>>32); } 9331: $Apache::lonhomework::results{'resource.0.rndseed'}=$num; 9332: return $num; 9333: } 9334: } 9335: 9336: sub rndseed_64bit { 9337: my ($symb,$courseid,$domain,$username)=@_; 9338: { 9339: use integer; 9340: my $symbchck=unpack("%32S*",$symb) << 21; 9341: my $symbseed=numval($symb) << 10; 9342: my $namechck=unpack("%32S*",$username); 9343: 9344: my $nameseed=numval($username) << 21; 9345: my $domainseed=unpack("%32S*",$domain) << 10; 9346: my $courseseed=unpack("%32S*",$courseid); 9347: 9348: my $num1=$symbchck+$symbseed+$namechck; 9349: my $num2=$nameseed+$domainseed+$courseseed; 9350: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9351: #&logthis("rndseed :$num:$symb"); 9352: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9353: $Apache::lonhomework::results{'resource.0.rndseed'}="$num1:$num2"; 9354: return "$num1,$num2"; 9355: } 9356: } 9357: 9358: sub rndseed_64bit2 { 9359: my ($symb,$courseid,$domain,$username)=@_; 9360: { 9361: use integer; 9362: # strings need to be an even # of cahracters long, it it is odd the 9363: # last characters gets thrown away 9364: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9365: my $symbseed=numval($symb) << 10; 9366: my $namechck=unpack("%32S*",$username.' '); 9367: 9368: my $nameseed=numval($username) << 21; 9369: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9370: my $courseseed=unpack("%32S*",$courseid.' '); 9371: 9372: my $num1=$symbchck+$symbseed+$namechck; 9373: my $num2=$nameseed+$domainseed+$courseseed; 9374: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9375: #&logthis("rndseed :$num:$symb"); 9376: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9377: $Apache::lonhomework::results{'resource.0.rndseed'}="$num1:$num2"; 9378: return "$num1,$num2"; 9379: } 9380: } 9381: 9382: sub rndseed_64bit3 { 9383: my ($symb,$courseid,$domain,$username)=@_; 9384: { 9385: use integer; 9386: # strings need to be an even # of cahracters long, it it is odd the 9387: # last characters gets thrown away 9388: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9389: my $symbseed=numval2($symb) << 10; 9390: my $namechck=unpack("%32S*",$username.' '); 9391: 9392: my $nameseed=numval2($username) << 21; 9393: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9394: my $courseseed=unpack("%32S*",$courseid.' '); 9395: 9396: my $num1=$symbchck+$symbseed+$namechck; 9397: my $num2=$nameseed+$domainseed+$courseseed; 9398: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9399: #&logthis("rndseed :$num1:$num2:$_64bit"); 9400: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9401: $Apache::lonhomework::results{'resource.0.rndseed'}="$num1:$num2"; 9402: return "$num1:$num2"; 9403: } 9404: } 9405: 9406: sub rndseed_64bit4 { 9407: my ($symb,$courseid,$domain,$username)=@_; 9408: { 9409: use integer; 9410: # strings need to be an even # of cahracters long, it it is odd the 9411: # last characters gets thrown away 9412: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9413: my $symbseed=numval3($symb) << 10; 9414: my $namechck=unpack("%32S*",$username.' '); 9415: 9416: my $nameseed=numval3($username) << 21; 9417: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9418: my $courseseed=unpack("%32S*",$courseid.' '); 9419: 9420: my $num1=$symbchck+$symbseed+$namechck; 9421: my $num2=$nameseed+$domainseed+$courseseed; 9422: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9423: #&logthis("rndseed :$num1:$num2:$_64bit"); 9424: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9425: $Apache::lonhomework::results{'resource.0.rndseed'}="$num1:$num2"; 9426: return "$num1:$num2"; 9427: } 9428: } 9429: 9430: sub rndseed_64bit5 { 9431: my ($symb,$courseid,$domain,$username)=@_; 9432: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username"); 9433: $Apache::lonhomework::results{'resource.0.rndseed'}="$num1:$num2"; 9434: return "$num1:$num2"; 9435: } 9436: 9437: sub rndseed_CODE_64bit { 9438: my ($symb,$courseid,$domain,$username)=@_; 9439: { 9440: use integer; 9441: my $symbchck=unpack("%32S*",$symb.' ') << 16; 9442: my $symbseed=numval2($symb); 9443: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 9444: my $CODEseed=numval(&getCODE()); 9445: my $courseseed=unpack("%32S*",$courseid.' '); 9446: my $num1=$symbseed+$CODEchck; 9447: my $num2=$CODEseed+$courseseed+$symbchck; 9448: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 9449: #&logthis("rndseed :$num1:$num2:$symb"); 9450: if ($_64bit) { $num1=(($num1<<32)>>32); } 9451: if ($_64bit) { $num2=(($num2<<32)>>32); } 9452: return "$num1:$num2"; 9453: } 9454: } 9455: 9456: sub rndseed_CODE_64bit4 { 9457: my ($symb,$courseid,$domain,$username)=@_; 9458: { 9459: use integer; 9460: my $symbchck=unpack("%32S*",$symb.' ') << 16; 9461: my $symbseed=numval3($symb); 9462: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 9463: my $CODEseed=numval3(&getCODE()); 9464: my $courseseed=unpack("%32S*",$courseid.' '); 9465: my $num1=$symbseed+$CODEchck; 9466: my $num2=$CODEseed+$courseseed+$symbchck; 9467: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 9468: #&logthis("rndseed :$num1:$num2:$symb"); 9469: if ($_64bit) { $num1=(($num1<<32)>>32); } 9470: if ($_64bit) { $num2=(($num2<<32)>>32); } 9471: return "$num1:$num2"; 9472: } 9473: } 9474: 9475: sub rndseed_CODE_64bit5 { 9476: my ($symb,$courseid,$domain,$username)=@_; 9477: my $code = &getCODE(); 9478: my ($num1,$num2)=&digest("$symb,$courseid,$code"); 9479: return "$num1:$num2"; 9480: } 9481: 9482: sub setup_random_from_rndseed { 9483: my ($rndseed)=@_; 9484: if ($rndseed =~/([,:])/) { 9485: my ($num1,$num2)=split(/[,:]/,$rndseed); 9486: &Math::Random::random_set_seed(abs($num1),abs($num2)); 9487: } else { 9488: &Math::Random::random_set_seed_from_phrase($rndseed); 9489: } 9490: } 9491: 9492: sub latest_receipt_algorithm_id { 9493: return 'receipt3'; 9494: } 9495: 9496: sub recunique { 9497: my $fucourseid=shift; 9498: my $unique; 9499: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' || 9500: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 9501: $unique=$env{"course.$fucourseid.internal.encseed"}; 9502: } else { 9503: $unique=$perlvar{'lonReceipt'}; 9504: } 9505: return unpack("%32C*",$unique); 9506: } 9507: 9508: sub recprefix { 9509: my $fucourseid=shift; 9510: my $prefix; 9511: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'|| 9512: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 9513: $prefix=$env{"course.$fucourseid.internal.encpref"}; 9514: } else { 9515: $prefix=$perlvar{'lonHostID'}; 9516: } 9517: return unpack("%32C*",$prefix); 9518: } 9519: 9520: sub ireceipt { 9521: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_; 9522: 9523: my $return =&recprefix($fucourseid).'-'; 9524: 9525: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' || 9526: $env{'request.state'} eq 'construct') { 9527: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000); 9528: return $return; 9529: } 9530: 9531: my $cuname=unpack("%32C*",$funame); 9532: my $cudom=unpack("%32C*",$fudom); 9533: my $cucourseid=unpack("%32C*",$fucourseid); 9534: my $cusymb=unpack("%32C*",$fusymb); 9535: my $cunique=&recunique($fucourseid); 9536: my $cpart=unpack("%32S*",$part); 9537: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') { 9538: 9539: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom)); 9540: 9541: $return.= ($cunique%$cuname+ 9542: $cunique%$cudom+ 9543: $cusymb%$cuname+ 9544: $cusymb%$cudom+ 9545: $cucourseid%$cuname+ 9546: $cucourseid%$cudom+ 9547: $cpart%$cuname+ 9548: $cpart%$cudom); 9549: } else { 9550: $return.= ($cunique%$cuname+ 9551: $cunique%$cudom+ 9552: $cusymb%$cuname+ 9553: $cusymb%$cudom+ 9554: $cucourseid%$cuname+ 9555: $cucourseid%$cudom); 9556: } 9557: return $return; 9558: } 9559: 9560: sub receipt { 9561: my ($part)=@_; 9562: my ($symb,$courseid,$domain,$name) = &whichuser(); 9563: return &ireceipt($name,$domain,$courseid,$symb,$part); 9564: } 9565: 9566: sub whichuser { 9567: my ($passedsymb)=@_; 9568: my ($symb,$courseid,$domain,$name,$publicuser); 9569: if (defined($env{'form.grade_symb'})) { 9570: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid'); 9571: my $allowed=&allowed('vgr',$tmp_courseid); 9572: if (!$allowed && 9573: exists($env{'request.course.sec'}) && 9574: $env{'request.course.sec'} !~ /^\s*$/) { 9575: $allowed=&allowed('vgr',$tmp_courseid. 9576: '/'.$env{'request.course.sec'}); 9577: } 9578: if ($allowed) { 9579: ($symb)=&get_env_multiple('form.grade_symb'); 9580: $courseid=$tmp_courseid; 9581: ($domain)=&get_env_multiple('form.grade_domain'); 9582: ($name)=&get_env_multiple('form.grade_username'); 9583: return ($symb,$courseid,$domain,$name,$publicuser); 9584: } 9585: } 9586: if (!$passedsymb) { 9587: $symb=&symbread(); 9588: } else { 9589: $symb=$passedsymb; 9590: } 9591: $courseid=$env{'request.course.id'}; 9592: $domain=$env{'user.domain'}; 9593: $name=$env{'user.name'}; 9594: if ($name eq 'public' && $domain eq 'public') { 9595: if (!defined($env{'form.username'})) { 9596: $env{'form.username'}.=time.rand(10000000); 9597: } 9598: $name.=$env{'form.username'}; 9599: } 9600: return ($symb,$courseid,$domain,$name,$publicuser); 9601: 9602: } 9603: 9604: # ------------------------------------------------------------ Serves up a file 9605: # returns either the contents of the file or 9606: # -1 if the file doesn't exist 9607: # 9608: # if the target is a file that was uploaded via DOCS, 9609: # a check will be made to see if a current copy exists on the local server, 9610: # if it does this will be served, otherwise a copy will be retrieved from 9611: # the home server for the course and stored in /home/httpd/html/userfiles on 9612: # the local server. 9613: 9614: sub getfile { 9615: my ($file) = @_; 9616: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9617: &repcopy($file); 9618: return &readfile($file); 9619: } 9620: 9621: sub repcopy_userfile { 9622: my ($file)=@_; 9623: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9624: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 9625: my ($cdom,$cnum,$filename) = 9626: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|); 9627: my $uri="/uploaded/$cdom/$cnum/$filename"; 9628: if (-e "$file") { 9629: # we already have a local copy, check it out 9630: my @fileinfo = stat($file); 9631: my $rtncode; 9632: my $info; 9633: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode); 9634: if ($lwpresp ne 'ok') { 9635: # there is no such file anymore, even though we had a local copy 9636: if ($rtncode eq '404') { 9637: unlink($file); 9638: } 9639: return -1; 9640: } 9641: if ($info < $fileinfo[9]) { 9642: # nice, the file we have is up-to-date, just say okay 9643: return 'ok'; 9644: } else { 9645: # the file is outdated, get rid of it 9646: unlink($file); 9647: } 9648: } 9649: # one way or the other, at this point, we don't have the file 9650: # construct the correct path for the file 9651: my @parts = ($cdom,$cnum); 9652: if ($filename =~ m|^(.+)/[^/]+$|) { 9653: push @parts, split(/\//,$1); 9654: } 9655: my $path = $perlvar{'lonDocRoot'}.'/userfiles'; 9656: foreach my $part (@parts) { 9657: $path .= '/'.$part; 9658: if (!-e $path) { 9659: mkdir($path,0770); 9660: } 9661: } 9662: # now the path exists for sure 9663: # get a user agent 9664: my $ua=new LWP::UserAgent; 9665: my $transferfile=$file.'.in.transfer'; 9666: # FIXME: this should flock 9667: if (-e $transferfile) { return 'ok'; } 9668: my $request; 9669: $uri=~s/^\///; 9670: my $homeserver = &homeserver($cnum,$cdom); 9671: my $protocol = $protocol{$homeserver}; 9672: $protocol = 'http' if ($protocol ne 'https'); 9673: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri); 9674: my $response=$ua->request($request,$transferfile); 9675: # did it work? 9676: if ($response->is_error()) { 9677: unlink($transferfile); 9678: &logthis("Userfile repcopy failed for $uri"); 9679: return -1; 9680: } 9681: # worked, rename the transfer file 9682: rename($transferfile,$file); 9683: return 'ok'; 9684: } 9685: 9686: sub tokenwrapper { 9687: my $uri=shift; 9688: $uri=~s|^https?\://([^/]+)||; 9689: $uri=~s|^/||; 9690: $env{'user.environment'}=~/\/([^\/]+)\.id/; 9691: my $token=$1; 9692: my (undef,$udom,$uname,$file)=split('/',$uri,4); 9693: if ($udom && $uname && $file) { 9694: $file=~s|(\?\.*)*$||; 9695: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}}); 9696: my $homeserver = &homeserver($uname,$udom); 9697: my $protocol = $protocol{$homeserver}; 9698: $protocol = 'http' if ($protocol ne 'https'); 9699: return $protocol.'://'.&hostname($homeserver).'/'.$uri. 9700: (($uri=~/\?/)?'&':'?').'token='.$token. 9701: '&tokenissued='.$perlvar{'lonHostID'}; 9702: } else { 9703: return '/adm/notfound.html'; 9704: } 9705: } 9706: 9707: # call with reqtype HEAD: get last modification time 9708: # call with reqtype GET: get the file contents 9709: # Do not call this with reqtype GET for large files! It loads everything into memory 9710: # 9711: sub getuploaded { 9712: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_; 9713: $uri=~s/^\///; 9714: my $homeserver = &homeserver($cnum,$cdom); 9715: my $protocol = $protocol{$homeserver}; 9716: $protocol = 'http' if ($protocol ne 'https'); 9717: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri; 9718: my $ua=new LWP::UserAgent; 9719: my $request=new HTTP::Request($reqtype,$uri); 9720: my $response=$ua->request($request); 9721: $$rtncode = $response->code; 9722: if (! $response->is_success()) { 9723: return 'failed'; 9724: } 9725: if ($reqtype eq 'HEAD') { 9726: $$info = &HTTP::Date::str2time( $response->header('Last-modified') ); 9727: } elsif ($reqtype eq 'GET') { 9728: $$info = $response->content; 9729: } 9730: return 'ok'; 9731: } 9732: 9733: sub readfile { 9734: my $file = shift; 9735: if ( (! -e $file ) || ($file eq '') ) { return -1; }; 9736: my $fh; 9737: open($fh,"<$file"); 9738: my $a=''; 9739: while (my $line = <$fh>) { $a .= $line; } 9740: return $a; 9741: } 9742: 9743: sub filelocation { 9744: my ($dir,$file) = @_; 9745: my $location; 9746: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces 9747: 9748: if ($file =~ m-^/adm/-) { 9749: $file=~s-^/adm/wrapper/-/-; 9750: $file=~s-^/adm/coursedocs/showdoc/-/-; 9751: } 9752: 9753: if ($file=~m:^/~:) { # is a contruction space reference 9754: $location = $file; 9755: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:; 9756: } elsif ($file=~m{^/home/$match_username/public_html/}) { 9757: # is a correct contruction space reference 9758: $location = $file; 9759: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) { 9760: $location = $file; 9761: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file 9762: my ($udom,$uname,$filename)= 9763: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-); 9764: my $home=&homeserver($uname,$udom); 9765: my $is_me=0; 9766: my @ids=¤t_machine_ids(); 9767: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } } 9768: if ($is_me) { 9769: $location=&propath($udom,$uname).'/userfiles/'.$filename; 9770: } else { 9771: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'. 9772: $udom.'/'.$uname.'/'.$filename; 9773: } 9774: } elsif ($file =~ m-^/adm/-) { 9775: $location = $perlvar{'lonDocRoot'}.'/'.$file; 9776: } else { 9777: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9778: $file=~s:^/res/:/:; 9779: if ( !( $file =~ m:^/:) ) { 9780: $location = $dir. '/'.$file; 9781: } else { 9782: $location = '/home/httpd/html/res'.$file; 9783: } 9784: } 9785: $location=~s://+:/:g; # remove duplicate / 9786: while ($location=~m{/\.\./}) { 9787: if ($location =~ m{/[^/]+/\.\./}) { 9788: $location=~ s{/[^/]+/\.\./}{/}g; 9789: } else { 9790: $location=~ s{/\.\./}{/}g; 9791: } 9792: } #remove dir/.. 9793: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./ 9794: return $location; 9795: } 9796: 9797: sub hreflocation { 9798: my ($dir,$file)=@_; 9799: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) { 9800: $file=filelocation($dir,$file); 9801: } elsif ($file=~m-^/adm/-) { 9802: $file=~s-^/adm/wrapper/-/-; 9803: $file=~s-^/adm/coursedocs/showdoc/-/-; 9804: } 9805: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) { 9806: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--; 9807: } elsif ($file=~m-/home/($match_username)/public_html/-) { 9808: $file=~s-^/home/($match_username)/public_html/-/~$1/-; 9809: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) { 9810: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/ 9811: -/uploaded/$1/$2/-x; 9812: } 9813: if ($file=~ m{^/userfiles/}) { 9814: $file =~ s{^/userfiles/}{/uploaded/}; 9815: } 9816: return $file; 9817: } 9818: 9819: sub current_machine_domains { 9820: return &machine_domains(&hostname($perlvar{'lonHostID'})); 9821: } 9822: 9823: sub machine_domains { 9824: my ($hostname) = @_; 9825: my @domains; 9826: my %hostname = &all_hostnames(); 9827: while( my($id, $name) = each(%hostname)) { 9828: # &logthis("-$id-$name-$hostname-"); 9829: if ($hostname eq $name) { 9830: push(@domains,&host_domain($id)); 9831: } 9832: } 9833: return @domains; 9834: } 9835: 9836: sub current_machine_ids { 9837: return &machine_ids(&hostname($perlvar{'lonHostID'})); 9838: } 9839: 9840: sub machine_ids { 9841: my ($hostname) = @_; 9842: $hostname ||= &hostname($perlvar{'lonHostID'}); 9843: my @ids; 9844: my %name_to_host = &all_names(); 9845: if (ref($name_to_host{$hostname}) eq 'ARRAY') { 9846: return @{ $name_to_host{$hostname} }; 9847: } 9848: return; 9849: } 9850: 9851: sub additional_machine_domains { 9852: my @domains; 9853: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab"); 9854: while( my $line = <$fh>) { 9855: $line =~ s/\s//g; 9856: push(@domains,$line); 9857: } 9858: return @domains; 9859: } 9860: 9861: sub default_login_domain { 9862: my $domain = $perlvar{'lonDefDomain'}; 9863: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0]; 9864: foreach my $posdom (¤t_machine_domains(), 9865: &additional_machine_domains()) { 9866: if (lc($posdom) eq lc($testdomain)) { 9867: $domain=$posdom; 9868: last; 9869: } 9870: } 9871: return $domain; 9872: } 9873: 9874: # ------------------------------------------------------------- Declutters URLs 9875: 9876: sub declutter { 9877: my $thisfn=shift; 9878: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 9879: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9880: $thisfn=~s/^\///; 9881: $thisfn=~s|^adm/wrapper/||; 9882: $thisfn=~s|^adm/coursedocs/showdoc/||; 9883: $thisfn=~s/^res\///; 9884: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) { 9885: $thisfn=~s/\?.+$//; 9886: } 9887: return $thisfn; 9888: } 9889: 9890: # ------------------------------------------------------------- Clutter up URLs 9891: 9892: sub clutter { 9893: my $thisfn='/'.&declutter(shift); 9894: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/} 9895: || $thisfn =~ m{^/adm/(includes|pages)} ) { 9896: $thisfn='/res'.$thisfn; 9897: } 9898: if ($thisfn !~m|^/adm|) { 9899: if ($thisfn =~ m|^/ext/|) { 9900: $thisfn='/adm/wrapper'.$thisfn; 9901: } else { 9902: my ($ext) = ($thisfn =~ /\.(\w+)$/); 9903: my $embstyle=&Apache::loncommon::fileembstyle($ext); 9904: if ($embstyle eq 'ssi' 9905: || ($embstyle eq 'hdn') 9906: || ($embstyle eq 'rat') 9907: || ($embstyle eq 'prv') 9908: || ($embstyle eq 'ign')) { 9909: #do nothing with these 9910: } elsif (($embstyle eq 'img') 9911: || ($embstyle eq 'emb') 9912: || ($embstyle eq 'wrp')) { 9913: $thisfn='/adm/wrapper'.$thisfn; 9914: } elsif ($embstyle eq 'unk' 9915: && $thisfn!~/\.(sequence|page)$/) { 9916: $thisfn='/adm/coursedocs/showdoc'.$thisfn; 9917: } else { 9918: # &logthis("Got a blank emb style"); 9919: } 9920: } 9921: } 9922: return $thisfn; 9923: } 9924: 9925: sub clutter_with_no_wrapper { 9926: my $uri = &clutter(shift); 9927: if ($uri =~ m-^/adm/-) { 9928: $uri =~ s-^/adm/wrapper/-/-; 9929: $uri =~ s-^/adm/coursedocs/showdoc/-/-; 9930: } 9931: return $uri; 9932: } 9933: 9934: sub freeze_escape { 9935: my ($value)=@_; 9936: if (ref($value)) { 9937: $value=&nfreeze($value); 9938: return '__FROZEN__'.&escape($value); 9939: } 9940: return &escape($value); 9941: } 9942: 9943: 9944: sub thaw_unescape { 9945: my ($value)=@_; 9946: if ($value =~ /^__FROZEN__/) { 9947: substr($value,0,10,undef); 9948: $value=&unescape($value); 9949: return &thaw($value); 9950: } 9951: return &unescape($value); 9952: } 9953: 9954: sub correct_line_ends { 9955: my ($result)=@_; 9956: $$result =~s/\r\n/\n/mg; 9957: $$result =~s/\r/\n/mg; 9958: } 9959: # ================================================================ Main Program 9960: 9961: sub goodbye { 9962: &logthis("Starting Shut down"); 9963: #not converted to using infrastruture and probably shouldn't be 9964: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache)))); 9965: #converted 9966: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache))); 9967: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache)))); 9968: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache)))); 9969: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache)))); 9970: #1.1 only 9971: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache)))); 9972: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache)))); 9973: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache)))); 9974: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache)))); 9975: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered)))); 9976: &logthis(sprintf("%-20s is %s",'kicks',$kicks)); 9977: &logthis(sprintf("%-20s is %s",'hits',$hits)); 9978: &flushcourselogs(); 9979: &logthis("Shutting down"); 9980: } 9981: 9982: sub get_dns { 9983: my ($url,$func,$ignore_cache) = @_; 9984: if (!$ignore_cache) { 9985: my ($content,$cached)= 9986: &Apache::lonnet::is_cached_new('dns',$url); 9987: if ($cached) { 9988: &$func($content); 9989: return; 9990: } 9991: } 9992: 9993: my %alldns; 9994: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 9995: foreach my $dns (<$config>) { 9996: next if ($dns !~ /^\^(\S*)/x); 9997: my $line = $1; 9998: my ($host,$protocol) = split(/:/,$line); 9999: if ($protocol ne 'https') { 10000: $protocol = 'http'; 10001: } 10002: $alldns{$host} = $protocol; 10003: } 10004: while (%alldns) { 10005: my ($dns) = keys(%alldns); 10006: my $ua=new LWP::UserAgent; 10007: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url"); 10008: my $response=$ua->request($request); 10009: delete($alldns{$dns}); 10010: next if ($response->is_error()); 10011: my @content = split("\n",$response->content); 10012: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60); 10013: &$func(\@content); 10014: return; 10015: } 10016: close($config); 10017: my $which = (split('/',$url))[3]; 10018: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n"); 10019: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab"); 10020: my @content = <$config>; 10021: &$func(\@content); 10022: return; 10023: } 10024: # ------------------------------------------------------------ Read domain file 10025: { 10026: my $loaded; 10027: my %domain; 10028: 10029: sub parse_domain_tab { 10030: my ($lines) = @_; 10031: foreach my $line (@$lines) { 10032: next if ($line =~ /^(\#|\s*$ )/x); 10033: 10034: chomp($line); 10035: my ($name,@elements) = split(/:/,$line,9); 10036: my %this_domain; 10037: foreach my $field ('description', 'auth_def', 'auth_arg_def', 10038: 'lang_def', 'city', 'longi', 'lati', 10039: 'primary') { 10040: $this_domain{$field} = shift(@elements); 10041: } 10042: $domain{$name} = \%this_domain; 10043: } 10044: } 10045: 10046: sub reset_domain_info { 10047: undef($loaded); 10048: undef(%domain); 10049: } 10050: 10051: sub load_domain_tab { 10052: my ($ignore_cache) = @_; 10053: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache); 10054: my $fh; 10055: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) { 10056: my @lines = <$fh>; 10057: &parse_domain_tab(\@lines); 10058: } 10059: close($fh); 10060: $loaded = 1; 10061: } 10062: 10063: sub domain { 10064: &load_domain_tab() if (!$loaded); 10065: 10066: my ($name,$what) = @_; 10067: return if ( !exists($domain{$name}) ); 10068: 10069: if (!$what) { 10070: return $domain{$name}{'description'}; 10071: } 10072: return $domain{$name}{$what}; 10073: } 10074: 10075: sub domain_info { 10076: &load_domain_tab() if (!$loaded); 10077: return %domain; 10078: } 10079: 10080: } 10081: 10082: 10083: # ------------------------------------------------------------- Read hosts file 10084: { 10085: my %hostname; 10086: my %hostdom; 10087: my %libserv; 10088: my $loaded; 10089: my %name_to_host; 10090: my %internetdom; 10091: my %LC_dns_serv; 10092: 10093: sub parse_hosts_tab { 10094: my ($file) = @_; 10095: foreach my $configline (@$file) { 10096: next if ($configline =~ /^(\#|\s*$ )/x); 10097: chomp($configline); 10098: if ($configline =~ /^\^/) { 10099: if ($configline =~ /^\^([\w.\-]+)/) { 10100: $LC_dns_serv{$1} = 1; 10101: } 10102: next; 10103: } 10104: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline); 10105: $name=~s/\s//g; 10106: if ($id && $domain && $role && $name) { 10107: $hostname{$id}=$name; 10108: push(@{$name_to_host{$name}}, $id); 10109: $hostdom{$id}=$domain; 10110: if ($role eq 'library') { $libserv{$id}=$name; } 10111: if (defined($protocol)) { 10112: if ($protocol eq 'https') { 10113: $protocol{$id} = $protocol; 10114: } else { 10115: $protocol{$id} = 'http'; 10116: } 10117: } else { 10118: $protocol{$id} = 'http'; 10119: } 10120: if (defined($intdom)) { 10121: $internetdom{$id} = $intdom; 10122: } 10123: } 10124: } 10125: } 10126: 10127: sub reset_hosts_info { 10128: &purge_remembered(); 10129: &reset_domain_info(); 10130: &reset_hosts_ip_info(); 10131: undef(%name_to_host); 10132: undef(%hostname); 10133: undef(%hostdom); 10134: undef(%libserv); 10135: undef($loaded); 10136: } 10137: 10138: sub load_hosts_tab { 10139: my ($ignore_cache) = @_; 10140: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache); 10141: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 10142: my @config = <$config>; 10143: &parse_hosts_tab(\@config); 10144: close($config); 10145: $loaded=1; 10146: } 10147: 10148: sub hostname { 10149: &load_hosts_tab() if (!$loaded); 10150: 10151: my ($lonid) = @_; 10152: return $hostname{$lonid}; 10153: } 10154: 10155: sub all_hostnames { 10156: &load_hosts_tab() if (!$loaded); 10157: 10158: return %hostname; 10159: } 10160: 10161: sub all_names { 10162: &load_hosts_tab() if (!$loaded); 10163: 10164: return %name_to_host; 10165: } 10166: 10167: sub all_host_domain { 10168: &load_hosts_tab() if (!$loaded); 10169: return %hostdom; 10170: } 10171: 10172: sub is_library { 10173: &load_hosts_tab() if (!$loaded); 10174: 10175: return exists($libserv{$_[0]}); 10176: } 10177: 10178: sub all_library { 10179: &load_hosts_tab() if (!$loaded); 10180: 10181: return %libserv; 10182: } 10183: 10184: sub unique_library { 10185: #2x reverse removes all hostnames that appear more than once 10186: my %unique = reverse &all_library(); 10187: return reverse %unique; 10188: } 10189: 10190: sub get_servers { 10191: &load_hosts_tab() if (!$loaded); 10192: 10193: my ($domain,$type) = @_; 10194: my %possible_hosts = ($type eq 'library') ? %libserv 10195: : %hostname; 10196: my %result; 10197: if (ref($domain) eq 'ARRAY') { 10198: while ( my ($host,$hostname) = each(%possible_hosts)) { 10199: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) { 10200: $result{$host} = $hostname; 10201: } 10202: } 10203: } else { 10204: while ( my ($host,$hostname) = each(%possible_hosts)) { 10205: if ($hostdom{$host} eq $domain) { 10206: $result{$host} = $hostname; 10207: } 10208: } 10209: } 10210: return %result; 10211: } 10212: 10213: sub get_unique_servers { 10214: my %unique = reverse &get_servers(@_); 10215: return reverse %unique; 10216: } 10217: 10218: sub host_domain { 10219: &load_hosts_tab() if (!$loaded); 10220: 10221: my ($lonid) = @_; 10222: return $hostdom{$lonid}; 10223: } 10224: 10225: sub all_domains { 10226: &load_hosts_tab() if (!$loaded); 10227: 10228: my %seen; 10229: my @uniq = grep(!$seen{$_}++, values(%hostdom)); 10230: return @uniq; 10231: } 10232: 10233: sub internet_dom { 10234: &load_hosts_tab() if (!$loaded); 10235: 10236: my ($lonid) = @_; 10237: return $internetdom{$lonid}; 10238: } 10239: 10240: sub is_LC_dns { 10241: &load_hosts_tab() if (!$loaded); 10242: 10243: my ($hostname) = @_; 10244: return exists($LC_dns_serv{$hostname}); 10245: } 10246: 10247: } 10248: 10249: { 10250: my %iphost; 10251: my %name_to_ip; 10252: my %lonid_to_ip; 10253: 10254: sub get_hosts_from_ip { 10255: my ($ip) = @_; 10256: my %iphosts = &get_iphost(); 10257: if (ref($iphosts{$ip})) { 10258: return @{$iphosts{$ip}}; 10259: } 10260: return; 10261: } 10262: 10263: sub reset_hosts_ip_info { 10264: undef(%iphost); 10265: undef(%name_to_ip); 10266: undef(%lonid_to_ip); 10267: } 10268: 10269: sub get_host_ip { 10270: my ($lonid) = @_; 10271: if (exists($lonid_to_ip{$lonid})) { 10272: return $lonid_to_ip{$lonid}; 10273: } 10274: my $name=&hostname($lonid); 10275: my $ip = gethostbyname($name); 10276: return if (!$ip || length($ip) ne 4); 10277: $ip=inet_ntoa($ip); 10278: $name_to_ip{$name} = $ip; 10279: $lonid_to_ip{$lonid} = $ip; 10280: return $ip; 10281: } 10282: 10283: sub get_iphost { 10284: my ($ignore_cache) = @_; 10285: 10286: if (!$ignore_cache) { 10287: if (%iphost) { 10288: return %iphost; 10289: } 10290: my ($ip_info,$cached)= 10291: &Apache::lonnet::is_cached_new('iphost','iphost'); 10292: if ($cached) { 10293: %iphost = %{$ip_info->[0]}; 10294: %name_to_ip = %{$ip_info->[1]}; 10295: %lonid_to_ip = %{$ip_info->[2]}; 10296: return %iphost; 10297: } 10298: } 10299: 10300: # get yesterday's info for fallback 10301: my %old_name_to_ip; 10302: my ($ip_info,$cached)= 10303: &Apache::lonnet::is_cached_new('iphost','iphost'); 10304: if ($cached) { 10305: %old_name_to_ip = %{$ip_info->[1]}; 10306: } 10307: 10308: my %name_to_host = &all_names(); 10309: foreach my $name (keys(%name_to_host)) { 10310: my $ip; 10311: if (!exists($name_to_ip{$name})) { 10312: $ip = gethostbyname($name); 10313: if (!$ip || length($ip) ne 4) { 10314: if (defined($old_name_to_ip{$name})) { 10315: $ip = $old_name_to_ip{$name}; 10316: &logthis("Can't find $name defaulting to old $ip"); 10317: } else { 10318: &logthis("Name $name no IP found"); 10319: next; 10320: } 10321: } else { 10322: $ip=inet_ntoa($ip); 10323: } 10324: $name_to_ip{$name} = $ip; 10325: } else { 10326: $ip = $name_to_ip{$name}; 10327: } 10328: foreach my $id (@{ $name_to_host{$name} }) { 10329: $lonid_to_ip{$id} = $ip; 10330: } 10331: push(@{$iphost{$ip}},@{$name_to_host{$name}}); 10332: } 10333: &Apache::lonnet::do_cache_new('iphost','iphost', 10334: [\%iphost,\%name_to_ip,\%lonid_to_ip], 10335: 48*60*60); 10336: 10337: return %iphost; 10338: } 10339: 10340: # 10341: # Given a DNS returns the loncapa host name for that DNS 10342: # 10343: sub host_from_dns { 10344: my ($dns) = @_; 10345: my @hosts; 10346: my $ip; 10347: 10348: if (exists($name_to_ip{$dns})) { 10349: $ip = $name_to_ip{$dns}; 10350: } 10351: if (!$ip) { 10352: $ip = gethostbyname($dns); # Initial translation to IP is in net order. 10353: if (length($ip) == 4) { 10354: $ip = &IO::Socket::inet_ntoa($ip); 10355: } 10356: } 10357: if ($ip) { 10358: @hosts = get_hosts_from_ip($ip); 10359: return $hosts[0]; 10360: } 10361: return undef; 10362: } 10363: 10364: sub get_internet_names { 10365: my ($lonid) = @_; 10366: return if ($lonid eq ''); 10367: my ($idnref,$cached)= 10368: &Apache::lonnet::is_cached_new('internetnames',$lonid); 10369: if ($cached) { 10370: return $idnref; 10371: } 10372: my $ip = &get_host_ip($lonid); 10373: my @hosts = &get_hosts_from_ip($ip); 10374: my %iphost = &get_iphost(); 10375: my (@idns,%seen); 10376: foreach my $id (@hosts) { 10377: my $dom = &host_domain($id); 10378: my $prim_id = &domain($dom,'primary'); 10379: my $prim_ip = &get_host_ip($prim_id); 10380: next if ($seen{$prim_ip}); 10381: if (ref($iphost{$prim_ip}) eq 'ARRAY') { 10382: foreach my $id (@{$iphost{$prim_ip}}) { 10383: my $intdom = &internet_dom($id); 10384: unless (grep(/^\Q$intdom\E$/,@idns)) { 10385: push(@idns,$intdom); 10386: } 10387: } 10388: } 10389: $seen{$prim_ip} = 1; 10390: } 10391: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60); 10392: } 10393: 10394: } 10395: 10396: sub all_loncaparevs { 10397: return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10); 10398: } 10399: 10400: BEGIN { 10401: 10402: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf 10403: unless ($readit) { 10404: { 10405: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf'); 10406: %perlvar = (%perlvar,%{$configvars}); 10407: } 10408: 10409: 10410: # ------------------------------------------------------ Read spare server file 10411: { 10412: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab"); 10413: 10414: while (my $configline=<$config>) { 10415: chomp($configline); 10416: if ($configline) { 10417: my ($host,$type) = split(':',$configline,2); 10418: if (!defined($type) || $type eq '') { $type = 'default' }; 10419: push(@{ $spareid{$type} }, $host); 10420: } 10421: } 10422: close($config); 10423: } 10424: # ------------------------------------------------------------ Read permissions 10425: { 10426: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab"); 10427: 10428: while (my $configline=<$config>) { 10429: chomp($configline); 10430: if ($configline) { 10431: my ($role,$perm)=split(/ /,$configline); 10432: if ($perm ne '') { $pr{$role}=$perm; } 10433: } 10434: } 10435: close($config); 10436: } 10437: 10438: # -------------------------------------------- Read plain texts for permissions 10439: { 10440: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab"); 10441: 10442: while (my $configline=<$config>) { 10443: chomp($configline); 10444: if ($configline) { 10445: my ($short,@plain)=split(/:/,$configline); 10446: %{$prp{$short}} = (); 10447: if (@plain > 0) { 10448: $prp{$short}{'std'} = $plain[0]; 10449: for (my $i=1; $i<@plain; $i++) { 10450: $prp{$short}{'alt'.$i} = $plain[$i]; 10451: } 10452: } 10453: } 10454: } 10455: close($config); 10456: } 10457: 10458: # ---------------------------------------------------------- Read package table 10459: { 10460: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab"); 10461: 10462: while (my $configline=<$config>) { 10463: if ($configline !~ /\S/ || $configline=~/^#/) { next; } 10464: chomp($configline); 10465: my ($short,$plain)=split(/:/,$configline); 10466: my ($pack,$name)=split(/\&/,$short); 10467: if ($plain ne '') { 10468: $packagetab{$pack.'&'.$name.'&name'}=$name; 10469: $packagetab{$short}=$plain; 10470: } 10471: } 10472: close($config); 10473: } 10474: 10475: # ---------------------------------------------------------- Read loncaparev table 10476: { 10477: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") { 10478: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) { 10479: while (my $configline=<$config>) { 10480: chomp($configline); 10481: my ($hostid,$loncaparev)=split(/:/,$configline); 10482: $loncaparevs{$hostid}=$loncaparev; 10483: } 10484: close($config); 10485: } 10486: } 10487: } 10488: 10489: # ---------------------------------------------------------- Read serverhostID table 10490: { 10491: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") { 10492: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) { 10493: while (my $configline=<$config>) { 10494: chomp($configline); 10495: my ($name,$id)=split(/:/,$configline); 10496: $serverhomeIDs{$name}=$id; 10497: } 10498: close($config); 10499: } 10500: } 10501: } 10502: 10503: { 10504: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml'; 10505: if (-e $file) { 10506: my $parser = HTML::LCParser->new($file); 10507: while (my $token = $parser->get_token()) { 10508: if ($token->[0] eq 'S') { 10509: my $item = $token->[1]; 10510: my $name = $token->[2]{'name'}; 10511: my $value = $token->[2]{'value'}; 10512: if ($item ne '' && $name ne '' && $value ne '') { 10513: my $release = $parser->get_text(); 10514: $release =~ s/(^\s*|\s*$ )//gx; 10515: $needsrelease{$item.':'.$name.':'.$value} = $release; 10516: } 10517: } 10518: } 10519: } 10520: } 10521: 10522: # ------------- set up temporary directory 10523: { 10524: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/'; 10525: 10526: } 10527: 10528: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'], 10529: 'compress_threshold'=> 20_000, 10530: }); 10531: 10532: $processmarker='_'.time.'_'.$perlvar{'lonHostID'}; 10533: $dumpcount=0; 10534: $locknum=0; 10535: 10536: &logtouch(); 10537: &logthis('<font color="yellow">INFO: Read configuration</font>'); 10538: $readit=1; 10539: { 10540: use integer; 10541: my $test=(2**32)+1; 10542: if ($test != 0) { $_64bit=1; } else { $_64bit=0; } 10543: &logthis(" Detected 64bit platform ($_64bit)"); 10544: } 10545: } 10546: } 10547: 10548: 1; 10549: __END__ 10550: 10551: =pod 10552: 10553: =head1 NAME 10554: 10555: Apache::lonnet - Subroutines to ask questions about things in the network. 10556: 10557: =head1 SYNOPSIS 10558: 10559: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network. 10560: 10561: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS); 10562: 10563: Common parameters: 10564: 10565: =over 4 10566: 10567: =item * 10568: 10569: $uname : an internal username (if $cname expecting a course Id specifically) 10570: 10571: =item * 10572: 10573: $udom : a domain (if $cdom expecting a course's domain specifically) 10574: 10575: =item * 10576: 10577: $symb : a resource instance identifier 10578: 10579: =item * 10580: 10581: $namespace : the name of a .db file that contains the data needed or 10582: being set. 10583: 10584: =back 10585: 10586: =head1 OVERVIEW 10587: 10588: lonnet provides subroutines which interact with the 10589: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask 10590: about classes, users, and resources. 10591: 10592: For many of these objects you can also use this to store data about 10593: them or modify them in various ways. 10594: 10595: =head2 Symbs 10596: 10597: To identify a specific instance of a resource, LON-CAPA uses symbols 10598: or "symbs"X<symb>. These identifiers are built from the URL of the 10599: map, the resource number of the resource in the map, and the URL of 10600: the resource itself. The latter is somewhat redundant, but might help 10601: if maps change. 10602: 10603: An example is 10604: 10605: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem 10606: 10607: The respective map entry is 10608: 10609: <resource id="19" src="/res/msu/korte/tests/part12.problem" 10610: title="Problem 2"> 10611: </resource> 10612: 10613: Symbs are used by the random number generator, as well as to store and 10614: restore data specific to a certain instance of for example a problem. 10615: 10616: =head2 Storing And Retrieving Data 10617: 10618: X<store()>X<cstore()>X<restore()>Three of the most important functions 10619: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>, 10620: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which 10621: is is the non-critical message twin of cstore. These functions are for 10622: handlers to store a perl hash to a user's permanent data space in an 10623: easy manner, and to retrieve it again on another call. It is expected 10624: that a handler would use this once at the beginning to retrieve data, 10625: and then again once at the end to send only the new data back. 10626: 10627: The data is stored in the user's data directory on the user's 10628: homeserver under the ID of the course. 10629: 10630: The hash that is returned by restore will have all of the previous 10631: value for all of the elements of the hash. 10632: 10633: Example: 10634: 10635: #creating a hash 10636: my %hash; 10637: $hash{'foo'}='bar'; 10638: 10639: #storing it 10640: &Apache::lonnet::cstore(\%hash); 10641: 10642: #changing a value 10643: $hash{'foo'}='notbar'; 10644: 10645: #adding a new value 10646: $hash{'bar'}='foo'; 10647: &Apache::lonnet::cstore(\%hash); 10648: 10649: #retrieving the hash 10650: my %history=&Apache::lonnet::restore(); 10651: 10652: #print the hash 10653: foreach my $key (sort(keys(%history))) { 10654: print("\%history{$key} = $history{$key}"); 10655: } 10656: 10657: Will print out: 10658: 10659: %history{1:foo} = bar 10660: %history{1:keys} = foo:timestamp 10661: %history{1:timestamp} = 990455579 10662: %history{2:bar} = foo 10663: %history{2:foo} = notbar 10664: %history{2:keys} = foo:bar:timestamp 10665: %history{2:timestamp} = 990455580 10666: %history{bar} = foo 10667: %history{foo} = notbar 10668: %history{timestamp} = 990455580 10669: %history{version} = 2 10670: 10671: Note that the special hash entries C<keys>, C<version> and 10672: C<timestamp> were added to the hash. C<version> will be equal to the 10673: total number of versions of the data that have been stored. The 10674: C<timestamp> attribute will be the UNIX time the hash was 10675: stored. C<keys> is available in every historical section to list which 10676: keys were added or changed at a specific historical revision of a 10677: hash. 10678: 10679: B<Warning>: do not store the hash that restore returns directly. This 10680: will cause a mess since it will restore the historical keys as if the 10681: were new keys. I.E. 1:foo will become 1:1:foo etc. 10682: 10683: Calling convention: 10684: 10685: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home); 10686: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home); 10687: 10688: For more detailed information, see lonnet specific documentation. 10689: 10690: =head1 RETURN MESSAGES 10691: 10692: =over 4 10693: 10694: =item * B<con_lost>: unable to contact remote host 10695: 10696: =item * B<con_delayed>: unable to contact remote host, message will be delivered 10697: when the connection is brought back up 10698: 10699: =item * B<con_failed>: unable to contact remote host and unable to save message 10700: for later delivery 10701: 10702: =item * B<error:>: an error a occurred, a description of the error follows the : 10703: 10704: =item * B<no_such_host>: unable to fund a host associated with the user/domain 10705: that was requested 10706: 10707: =back 10708: 10709: =head1 PUBLIC SUBROUTINES 10710: 10711: =head2 Session Environment Functions 10712: 10713: =over 4 10714: 10715: =item * 10716: X<appenv()> 10717: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to 10718: the user envirnoment file, and will be restored for each access this 10719: user makes during this session, also modifies the %env for the current 10720: process. Optional rolesarrayref - if defined contains a reference to an array 10721: of roles which are exempt from the restriction on modifying user.role entries 10722: in the user's environment.db and in %env. 10723: 10724: =item * 10725: X<delenv()> 10726: B<delenv($delthis,$regexp)>: removes all items from the session 10727: environment file that begin with $delthis. If the 10728: optional second arg - $regexp - is true, $delthis is treated as a 10729: regular expression, otherwise \Q$delthis\E is used. 10730: The values are also deleted from the current processes %env. 10731: 10732: =item * get_env_multiple($name) 10733: 10734: gets $name from the %env hash, it seemlessly handles the cases where multiple 10735: values may be defined and end up as an array ref. 10736: 10737: returns an array of values 10738: 10739: =back 10740: 10741: =head2 User Information 10742: 10743: =over 4 10744: 10745: =item * 10746: X<queryauthenticate()> 10747: B<queryauthenticate($uname,$udom)>: try to determine user's current 10748: authentication scheme 10749: 10750: =item * 10751: X<authenticate()> 10752: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to 10753: authenticate user from domain's lib servers (first use the current 10754: one). C<$upass> should be the users password. 10755: $checkdefauth is optional (value is 1 if a check should be made to 10756: authenticate user using default authentication method, and allow 10757: account creation if username does not have account in the domain). 10758: $clientcancheckhost is optional (value is 1 if checking whether the 10759: server can host will occur on the client side in lonauth.pm). 10760: 10761: =item * 10762: X<homeserver()> 10763: B<homeserver($uname,$udom)>: find the server which has 10764: the user's directory and files (there must be only one), this caches 10765: the answer, and also caches if there is a borken connection. 10766: 10767: =item * 10768: X<idget()> 10769: B<idget($udom,@ids)>: find the usernames behind a list of IDs 10770: (IDs are a unique resource in a domain, there must be only 1 ID per 10771: username, and only 1 username per ID in a specific domain) (returns 10772: hash: id=>name,id=>name) 10773: 10774: =item * 10775: X<idrget()> 10776: B<idrget($udom,@unames)>: find the IDs behind a list of 10777: usernames (returns hash: name=>id,name=>id) 10778: 10779: =item * 10780: X<idput()> 10781: B<idput($udom,%ids)>: store away a list of names and associated IDs 10782: 10783: =item * 10784: X<rolesinit()> 10785: B<rolesinit($udom,$username,$authhost)>: get user privileges 10786: 10787: =item * 10788: X<getsection()> 10789: B<getsection($udom,$uname,$cname)>: finds the section of student in the 10790: course $cname, return section name/number or '' for "not in course" 10791: and '-1' for "no section" 10792: 10793: =item * 10794: X<userenvironment()> 10795: B<userenvironment($udom,$uname,@what)>: gets the values of the keys 10796: passed in @what from the requested user's environment, returns a hash 10797: 10798: =item * 10799: X<userlog_query()> 10800: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's 10801: activity.log file. %filters defines filters applied when parsing the 10802: log file. These can be start or end timestamps, or the type of action 10803: - log to look for Login or Logout events, check for Checkin or 10804: Checkout, role for role selection. The response is in the form 10805: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are 10806: escaped strings of the action recorded in the activity.log file. 10807: 10808: =back 10809: 10810: =head2 User Roles 10811: 10812: =over 4 10813: 10814: =item * 10815: 10816: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions 10817: F: full access 10818: U,I,K: authentication modes (cxx only) 10819: '': forbidden 10820: 1: user needs to choose course 10821: 2: browse allowed 10822: A: passphrase authentication needed 10823: 10824: =item * 10825: 10826: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom 10827: role rolename set privileges in format of lonTabs/roles.tab for system, domain, 10828: and course level 10829: 10830: =item * 10831: 10832: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 10833: (rolesplain.tab); plain text explanation of a user role term. 10834: $type is Course (default) or Community. 10835: If $forcedefault evaluates to true, text returned will be default 10836: text for $type. Otherwise, if this is a course, the text returned 10837: will be a custom name for the role (if defined in the course's 10838: environment). If no custom name is defined the default is returned. 10839: 10840: =item * 10841: 10842: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) : 10843: All arguments are optional. Returns a hash of a roles, either for 10844: co-author/assistant author roles for a user's Construction Space 10845: (default), or if $context is 'userroles', roles for the user himself, 10846: In the hash, keys are set to colon-separated $uname,$udom,$role, and 10847: (optionally) if $withsec is true, a fourth colon-separated item - $section. 10848: For each key, value is set to colon-separated start and end times for 10849: the role. If no username and domain are specified, will default to 10850: current user/domain. Types, roles, and roledoms are references to arrays 10851: of role statuses (active, future or previous), roles 10852: (e.g., cc,in, st etc.) and domains of the roles which can be used 10853: to restrict the list of roles reported. If no array ref is 10854: provided for types, will default to return only active roles. 10855: 10856: =back 10857: 10858: =head2 User Modification 10859: 10860: =over 4 10861: 10862: =item * 10863: 10864: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a 10865: user for the level given by URL. Optional start and end dates (leave empty 10866: string or zero for "no date") 10867: 10868: =item * 10869: 10870: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to 10871: change a users, password, possible return values are: ok, 10872: pwchange_failure, non_authorized, auth_mode_error, unknown_user, 10873: refused 10874: 10875: =item * 10876: 10877: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication 10878: 10879: =item * 10880: 10881: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene, 10882: $forceid,$desiredhome,$email,$inststatus,$candelete) : 10883: 10884: will update user information (firstname,middlename,lastname,generation, 10885: permanentemail), and if forceid is true, student/employee ID also. 10886: A user's institutional affiliation(s) can also be updated. 10887: User information fields will not be overwritten with empty entries 10888: unless the field is included in the $candelete array reference. 10889: This array is included when a single user is modified via "Manage Users", 10890: or when Autoupdate.pl is run by cron in a domain. 10891: 10892: =item * 10893: 10894: modifystudent 10895: 10896: modify a student's enrollment and identification information. 10897: The course id is resolved based on the current users environment. 10898: This means the envoking user must be a course coordinator or otherwise 10899: associated with a course. 10900: 10901: This call is essentially a wrapper for lonnet::modifyuser and 10902: lonnet::modify_student_enrollment 10903: 10904: Inputs: 10905: 10906: =over 4 10907: 10908: =item B<$udom> Student's loncapa domain 10909: 10910: =item B<$uname> Student's loncapa login name 10911: 10912: =item B<$uid> Student/Employee ID 10913: 10914: =item B<$umode> Student's authentication mode 10915: 10916: =item B<$upass> Student's password 10917: 10918: =item B<$first> Student's first name 10919: 10920: =item B<$middle> Student's middle name 10921: 10922: =item B<$last> Student's last name 10923: 10924: =item B<$gene> Student's generation 10925: 10926: =item B<$usec> Student's section in course 10927: 10928: =item B<$end> Unix time of the roles expiration 10929: 10930: =item B<$start> Unix time of the roles start date 10931: 10932: =item B<$forceid> If defined, allow $uid to be changed 10933: 10934: =item B<$desiredhome> server to use as home server for student 10935: 10936: =item B<$email> Student's permanent e-mail address 10937: 10938: =item B<$type> Type of enrollment (auto or manual) 10939: 10940: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto 10941: 10942: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC 10943: 10944: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment 10945: 10946: =item B<$context> role change context (shown in User Management Logs display in a course) 10947: 10948: =item B<$inststatus> institutional status of user - : separated string of escaped status types 10949: 10950: =back 10951: 10952: =item * 10953: 10954: modify_student_enrollment 10955: 10956: Change a students enrollment status in a class. The environment variable 10957: 'role.request.course' must be defined for this function to proceed. 10958: 10959: Inputs: 10960: 10961: =over 4 10962: 10963: =item $udom, students domain 10964: 10965: =item $uname, students name 10966: 10967: =item $uid, students user id 10968: 10969: =item $first, students first name 10970: 10971: =item $middle 10972: 10973: =item $last 10974: 10975: =item $gene 10976: 10977: =item $usec 10978: 10979: =item $end 10980: 10981: =item $start 10982: 10983: =item $type 10984: 10985: =item $locktype 10986: 10987: =item $cid 10988: 10989: =item $selfenroll 10990: 10991: =item $context 10992: 10993: =back 10994: 10995: 10996: =item * 10997: 10998: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign 10999: custom role; give a custom role to a user for the level given by URL. Specify 11000: name and domain of role author, and role name 11001: 11002: =item * 11003: 11004: revokerole($udom,$uname,$url,$role) : revoke a role for url 11005: 11006: =item * 11007: 11008: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role 11009: 11010: =back 11011: 11012: =head2 Course Infomation 11013: 11014: =over 4 11015: 11016: =item * 11017: 11018: coursedescription($courseid) : returns a hash of information about the 11019: specified course id, including all environment settings for the 11020: course, the description of the course will be in the hash under the 11021: key 'description' 11022: 11023: =item * 11024: 11025: resdata($name,$domain,$type,@which) : request for current parameter 11026: setting for a specific $type, where $type is either 'course' or 'user', 11027: @what should be a list of parameters to ask about. This routine caches 11028: answers for 5 minutes. 11029: 11030: =item * 11031: 11032: get_courseresdata($courseid, $domain) : dump the entire course resource 11033: data base, returning a hash that is keyed by the resource name and has 11034: values that are the resource value. I believe that the timestamps and 11035: versions are also returned. 11036: 11037: 11038: =back 11039: 11040: =head2 Course Modification 11041: 11042: =over 4 11043: 11044: =item * 11045: 11046: writecoursepref($courseid,%prefs) : write preferences (environment 11047: database) for a course 11048: 11049: =item * 11050: 11051: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course 11052: 11053: =item * 11054: 11055: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community). 11056: 11057: =back 11058: 11059: =head2 Resource Subroutines 11060: 11061: =over 4 11062: 11063: =item * 11064: 11065: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead) 11066: 11067: =item * 11068: 11069: repcopy($filename) : subscribes to the requested file, and attempts to 11070: replicate from the owning library server, Might return 11071: 'unavailable', 'not_found', 'forbidden', 'ok', or 11072: 'bad_request', also attempts to grab the metadata for the 11073: resource. Expects the local filesystem pathname 11074: (/home/httpd/html/res/....) 11075: 11076: =back 11077: 11078: =head2 Resource Information 11079: 11080: =over 4 11081: 11082: =item * 11083: 11084: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of 11085: a vairety of different possible values, $varname should be a request 11086: string, and the other parameters can be used to specify who and what 11087: one is asking about. 11088: 11089: Possible values for $varname are environment.lastname (or other item 11090: from the envirnment hash), user.name (or someother aspect about the 11091: user), resource.0.maxtries (or some other part and parameter of a 11092: resource) 11093: 11094: =item * 11095: 11096: directcondval($number) : get current value of a condition; reads from a state 11097: string 11098: 11099: =item * 11100: 11101: condval($condidx) : value of condition index based on state 11102: 11103: =item * 11104: 11105: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a 11106: resource's metadata, $what should be either a specific key, or either 11107: 'keys' (to get a list of possible keys) or 'packages' to get a list of 11108: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata. 11109: 11110: this function automatically caches all requests 11111: 11112: =item * 11113: 11114: metadata_query($query,$custom,$customshow) : make a metadata query against the 11115: network of library servers; returns file handle of where SQL and regex results 11116: will be stored for query 11117: 11118: =item * 11119: 11120: symbread($filename) : return symbolic list entry (filename argument optional); 11121: returns the data handle 11122: 11123: =item * 11124: 11125: symbverify($symb,$thisfn) : verifies that $symb actually exists and is 11126: a possible symb for the URL in $thisfn, and if is an encryypted 11127: resource that the user accessed using /enc/ returns a 1 on success, 0 11128: on failure, user must be in a course, as it assumes the existance of 11129: the course initial hash, and uses $env('request.course.id'} 11130: 11131: 11132: =item * 11133: 11134: symbclean($symb) : removes versions numbers from a symb, returns the 11135: cleaned symb 11136: 11137: =item * 11138: 11139: is_on_map($uri) : checks if the $uri is somewhere on the current 11140: course map, user must be in a course for it to work. 11141: 11142: =item * 11143: 11144: numval($salt) : return random seed value (addend for rndseed) 11145: 11146: =item * 11147: 11148: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns 11149: a random seed, all arguments are optional, if they aren't sent it uses the 11150: environment to derive them. Note: if symb isn't sent and it can't get one 11151: from &symbread it will use the current time as its return value 11152: 11153: =item * 11154: 11155: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique, 11156: unfakeable, receipt 11157: 11158: =item * 11159: 11160: receipt() : API to ireceipt working off of env values; given out to users 11161: 11162: =item * 11163: 11164: countacc($url) : count the number of accesses to a given URL 11165: 11166: =item * 11167: 11168: 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 11169: 11170: =item * 11171: 11172: 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) 11173: 11174: =item * 11175: 11176: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet 11177: 11178: =item * 11179: 11180: devalidate($symb) : devalidate temporary spreadsheet calculations, 11181: forcing spreadsheet to reevaluate the resource scores next time. 11182: 11183: =back 11184: 11185: =head2 Storing/Retreiving Data 11186: 11187: =over 4 11188: 11189: =item * 11190: 11191: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently 11192: for this url; hashref needs to be given and should be a \%hashname; the 11193: remaining args aren't required and if they aren't passed or are '' they will 11194: be derived from the env 11195: 11196: =item * 11197: 11198: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but 11199: uses critical subroutine 11200: 11201: =item * 11202: 11203: restore($symb,$namespace,$udom,$uname) : returns hash for this symb; 11204: all args are optional 11205: 11206: =item * 11207: 11208: dumpstore($namespace,$udom,$uname,$regexp,$range) : 11209: dumps the complete (or key matching regexp) namespace into a hash 11210: ($udom, $uname, $regexp, $range are optional) for a namespace that is 11211: normally &store()ed into 11212: 11213: $range should be either an integer '100' (give me the first 100 11214: matching records) 11215: or be two integers sperated by a - with no spaces 11216: '30-50' (give me the 30th through the 50th matching 11217: records) 11218: 11219: 11220: =item * 11221: 11222: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) : 11223: replaces a &store() version of data with a replacement set of data 11224: for a particular resource in a namespace passed in the $storehash hash 11225: reference 11226: 11227: =item * 11228: 11229: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that 11230: works very similar to store/cstore, but all data is stored in a 11231: temporary location and can be reset using tmpreset, $storehash should 11232: be a hash reference, returns nothing on success 11233: 11234: =item * 11235: 11236: tmprestore($symb,$namespace,$udom,$uname) : storage that works very 11237: similar to restore, but all data is stored in a temporary location and 11238: can be reset using tmpreset. Returns a hash of values on success, 11239: error string otherwise. 11240: 11241: =item * 11242: 11243: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset, 11244: deltes all keys for $symb form the temporary storage hash. 11245: 11246: =item * 11247: 11248: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array 11249: reference filled in from namesp ($udom and $uname are optional) 11250: 11251: =item * 11252: 11253: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from 11254: namesp ($udom and $uname are optional) 11255: 11256: =item * 11257: 11258: dump($namespace,$udom,$uname,$regexp,$range) : 11259: dumps the complete (or key matching regexp) namespace into a hash 11260: ($udom, $uname, $regexp, $range are optional) 11261: 11262: $range should be either an integer '100' (give me the first 100 11263: matching records) 11264: or be two integers sperated by a - with no spaces 11265: '30-50' (give me the 30th through the 50th matching 11266: records) 11267: =item * 11268: 11269: inc($namespace,$store,$udom,$uname) : increments $store in $namespace. 11270: $store can be a scalar, an array reference, or if the amount to be 11271: incremented is > 1, a hash reference. 11272: 11273: ($udom and $uname are optional) 11274: 11275: =item * 11276: 11277: put($namespace,$storehash,$udom,$uname) : stores hash in namesp 11278: ($udom and $uname are optional) 11279: 11280: =item * 11281: 11282: cput($namespace,$storehash,$udom,$uname) : critical put 11283: ($udom and $uname are optional) 11284: 11285: =item * 11286: 11287: newput($namespace,$storehash,$udom,$uname) : 11288: 11289: Attempts to store the items in the $storehash, but only if they don't 11290: currently exist, if this succeeds you can be certain that you have 11291: successfully created a new key value pair in the $namespace db. 11292: 11293: 11294: Args: 11295: $namespace: name of database to store values to 11296: $storehash: hashref to store to the db 11297: $udom: (optional) domain of user containing the db 11298: $uname: (optional) name of user caontaining the db 11299: 11300: Returns: 11301: 'ok' -> succeeded in storing all keys of $storehash 11302: 'key_exists: <key>' -> failed to anything out of $storehash, as at 11303: least <key> already existed in the db (other 11304: requested keys may also already exist) 11305: 'error: <msg>' -> unable to tie the DB or other error occurred 11306: 'con_lost' -> unable to contact request server 11307: 'refused' -> action was not allowed by remote machine 11308: 11309: 11310: =item * 11311: 11312: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array 11313: reference filled in from namesp (encrypts the return communication) 11314: ($udom and $uname are optional) 11315: 11316: =item * 11317: 11318: log($udom,$name,$home,$message) : write to permanent log for user; use 11319: critical subroutine 11320: 11321: =item * 11322: 11323: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from 11324: array reference filled in from namespace found in domain level on either 11325: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional). 11326: 11327: =item * 11328: 11329: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at 11330: domain level either on specified domain server ($uhome) or primary domain 11331: server ($udom and $uhome are optional) 11332: 11333: =item * 11334: 11335: get_domain_defaults($target_domain) : returns hash with defaults for 11336: authentication and language in the domain. Keys are: auth_def, auth_arg_def, 11337: lang_def; corresponsing values are authentication type (internal, krb4, krb5, 11338: or localauth), initial password or a kerberos realm, language (e.g., en-us). 11339: Values are retrieved from cache (if current), or from domain's configuration.db 11340: (if available), or lastly from values in lonTabs/dns_domain,tab, 11341: or lonTabs/domain.tab. 11342: 11343: %domdefaults = &get_auth_defaults($target_domain); 11344: 11345: =back 11346: 11347: =head2 Network Status Functions 11348: 11349: =over 4 11350: 11351: =item * 11352: 11353: dirlist($uri) : return directory list based on URI 11354: 11355: =item * 11356: 11357: spareserver() : find server with least workload from spare.tab 11358: 11359: 11360: =item * 11361: 11362: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef 11363: if there is no corresponding loncapa host. 11364: 11365: =back 11366: 11367: 11368: =head2 Apache Request 11369: 11370: =over 4 11371: 11372: =item * 11373: 11374: ssi($url,%hash) : server side include, does a complete request cycle on url to 11375: localhost, posts hash 11376: 11377: =back 11378: 11379: =head2 Data to String to Data 11380: 11381: =over 4 11382: 11383: =item * 11384: 11385: hash2str(%hash) : convert a hash into a string complete with escaping and '=' 11386: and '&' separators, supports elements that are arrayrefs and hashrefs 11387: 11388: =item * 11389: 11390: hashref2str($hashref) : convert a hashref into a string complete with 11391: escaping and '=' and '&' separators, supports elements that are 11392: arrayrefs and hashrefs 11393: 11394: =item * 11395: 11396: arrayref2str($arrayref) : convert an arrayref into a string complete 11397: with escaping and '&' separators, supports elements that are arrayrefs 11398: and hashrefs 11399: 11400: =item * 11401: 11402: str2hash($string) : convert string to hash using unescaping and 11403: splitting on '=' and '&', supports elements that are arrayrefs and 11404: hashrefs 11405: 11406: =item * 11407: 11408: str2array($string) : convert string to hash using unescaping and 11409: splitting on '&', supports elements that are arrayrefs and hashrefs 11410: 11411: =back 11412: 11413: =head2 Logging Routines 11414: 11415: =over 4 11416: 11417: These routines allow one to make log messages in the lonnet.log and 11418: lonnet.perm logfiles. 11419: 11420: =item * 11421: 11422: logtouch() : make sure the logfile, lonnet.log, exists 11423: 11424: =item * 11425: 11426: logthis() : append message to the normal lonnet.log file, it gets 11427: preiodically rolled over and deleted. 11428: 11429: =item * 11430: 11431: logperm() : append a permanent message to lonnet.perm.log, this log 11432: file never gets deleted by any automated portion of the system, only 11433: messages of critical importance should go in here. 11434: 11435: =back 11436: 11437: =head2 General File Helper Routines 11438: 11439: =over 4 11440: 11441: =item * 11442: 11443: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded. 11444: (a) files in /uploaded 11445: (i) If a local copy of the file exists - 11446: compares modification date of local copy with last-modified date for 11447: definitive version stored on home server for course. If local copy is 11448: stale, requests a new version from the home server and stores it. 11449: If the original has been removed from the home server, then local copy 11450: is unlinked. 11451: (ii) If local copy does not exist - 11452: requests the file from the home server and stores it. 11453: 11454: If $caller is 'uploadrep': 11455: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase) 11456: for request for files originally uploaded via DOCS. 11457: - returns 'ok' if fresh local copy now available, -1 otherwise. 11458: 11459: Otherwise: 11460: This indicates a call from the content generation phase of the request. 11461: - returns the entire contents of the file or -1. 11462: 11463: (b) files in /res 11464: - returns the entire contents of a file or -1; 11465: it properly subscribes to and replicates the file if neccessary. 11466: 11467: 11468: =item * 11469: 11470: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file 11471: reference 11472: 11473: returns either a stat() list of data about the file or an empty list 11474: if the file doesn't exist or couldn't find out about it (connection 11475: problems or user unknown) 11476: 11477: =item * 11478: 11479: filelocation($dir,$file) : returns file system location of a file 11480: based on URI; meant to be "fairly clean" absolute reference, $dir is a 11481: directory that relative $file lookups are to looked in ($dir of /a/dir 11482: and a file of ../bob will become /a/bob) 11483: 11484: =item * 11485: 11486: hreflocation($dir,$file) : returns file system location or a URL; same as 11487: filelocation except for hrefs 11488: 11489: =item * 11490: 11491: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc) 11492: 11493: =back 11494: 11495: =head2 Usererfile file routines (/uploaded*) 11496: 11497: =over 4 11498: 11499: =item * 11500: 11501: userfileupload(): main rotine for putting a file in a user or course's 11502: filespace, arguments are, 11503: 11504: formname - required - this is the name of the element in $env where the 11505: filename, and the contents of the file to create/modifed exist 11506: the filename is in $env{'form.'.$formname.'.filename'} and the 11507: contents of the file is located in $env{'form.'.$formname} 11508: context - if coursedoc, store the file in the course of the active role 11509: of the current user; 11510: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp 11511: if 'canceloverwrite': delete file in tmp/overwrites directory 11512: subdir - required - subdirectory to put the file in under ../userfiles/ 11513: if undefined, it will be placed in "unknown" 11514: 11515: (This routine calls clean_filename() to remove any dangerous 11516: characters from the filename, and then calls finuserfileupload() to 11517: complete the transaction) 11518: 11519: returns either the url of the uploaded file (/uploaded/....) if successful 11520: and /adm/notfound.html if unsuccessful 11521: 11522: =item * 11523: 11524: clean_filename(): routine for cleaing a filename up for storage in 11525: userfile space, argument is: 11526: 11527: filename - proposed filename 11528: 11529: returns: the new clean filename 11530: 11531: =item * 11532: 11533: finishuserfileupload(): routine that creates and sends the file to 11534: userspace, probably shouldn't be called directly 11535: 11536: docuname: username or courseid of destination for the file 11537: docudom: domain of user/course of destination for the file 11538: formname: same as for userfileupload() 11539: fname: filename (including subdirectories) for the file 11540: parser: if 'parse', will parse (html) file to extract references to objects, links etc. 11541: allfiles: reference to hash used to store objects found by parser 11542: codebase: reference to hash used for codebases of java objects found by parser 11543: thumbwidth: width (pixels) of thumbnail to be created for uploaded image 11544: thumbheight: height (pixels) of thumbnail to be created for uploaded image 11545: resizewidth: width to be used to resize image using resizeImage from ImageMagick 11546: resizeheight: height to be used to resize image using resizeImage from ImageMagick 11547: context: if 'overwrite', will move the uploaded file from its temporary location to 11548: userfiles to facilitate overwriting a previously uploaded file with same name. 11549: mimetype: reference to scalar to accommodate mime type determined 11550: from File::MMagic if $parser = parse. 11551: 11552: returns either the url of the uploaded file (/uploaded/....) if successful 11553: and /adm/notfound.html if unsuccessful (or an error message if context 11554: was 'overwrite'). 11555: 11556: 11557: =item * 11558: 11559: renameuserfile(): renames an existing userfile to a new name 11560: 11561: Args: 11562: docuname: username or courseid of destination for the file 11563: docudom: domain of user/course of destination for the file 11564: old: current file name (including any subdirs under userfiles) 11565: new: desired file name (including any subdirs under userfiles) 11566: 11567: =item * 11568: 11569: mkdiruserfile(): creates a directory is a userfiles dir 11570: 11571: Args: 11572: docuname: username or courseid of destination for the file 11573: docudom: domain of user/course of destination for the file 11574: dir: dir to create (including any subdirs under userfiles) 11575: 11576: =item * 11577: 11578: removeuserfile(): removes a file that exists in userfiles 11579: 11580: Args: 11581: docuname: username or courseid of destination for the file 11582: docudom: domain of user/course of destination for the file 11583: fname: filname to delete (including any subdirs under userfiles) 11584: 11585: =item * 11586: 11587: removeuploadedurl(): convience function for removeuserfile() 11588: 11589: Args: 11590: url: a full /uploaded/... url to delete 11591: 11592: =item * 11593: 11594: get_portfile_permissions(): 11595: Args: 11596: domain: domain of user or course contain the portfolio files 11597: user: name of user or num of course contain the portfolio files 11598: Returns: 11599: hashref of a dump of the proper file_permissions.db 11600: 11601: 11602: =item * 11603: 11604: get_access_controls(): 11605: 11606: Args: 11607: current_permissions: the hash ref returned from get_portfile_permissions() 11608: group: (optional) the group you want the files associated with 11609: file: (optional) the file you want access info on 11610: 11611: Returns: 11612: a hash (keys are file names) of hashes containing 11613: keys are: path to file/file_name\0uniqueID:scope_end_start (see below) 11614: values are XML containing access control settings (see below) 11615: 11616: Internal notes: 11617: 11618: access controls are stored in file_permissions.db as key=value pairs. 11619: key -> path to file/file_name\0uniqueID:scope_end_start 11620: where scope -> public,guest,course,group,domains or users. 11621: end -> UNIX time for end of access (0 -> no end date) 11622: start -> UNIX time for start of access 11623: 11624: value -> XML description of access control 11625: <scope type=""> (type =1 of: public,guest,course,group,domains,users"> 11626: <start></start> 11627: <end></end> 11628: 11629: <password></password> for scope type = guest 11630: 11631: <domain></domain> for scope type = course or group 11632: <number></number> 11633: <roles id=""> 11634: <role></role> 11635: <access></access> 11636: <section></section> 11637: <group></group> 11638: </roles> 11639: 11640: <dom></dom> for scope type = domains 11641: 11642: <users> for scope type = users 11643: <user> 11644: <uname></uname> 11645: <udom></udom> 11646: </user> 11647: </users> 11648: </scope> 11649: 11650: Access data is also aggregated for each file in an additional key=value pair: 11651: key -> path to file/file_name\0accesscontrol 11652: value -> reference to hash 11653: hash contains key = value pairs 11654: where key = uniqueID:scope_end_start 11655: value = UNIX time record was last updated 11656: 11657: Used to improve speed of look-ups of access controls for each file. 11658: 11659: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays. 11660: 11661: modify_access_controls(): 11662: 11663: Modifies access controls for a portfolio file 11664: Args 11665: 1. file name 11666: 2. reference to hash of required changes, 11667: 3. domain 11668: 4. username 11669: where domain,username are the domain of the portfolio owner 11670: (either a user or a course) 11671: 11672: Returns: 11673: 1. result of additions or updates ('ok' or 'error', with error message). 11674: 2. result of deletions ('ok' or 'error', with error message). 11675: 3. reference to hash of any new or updated access controls. 11676: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control. 11677: key = integer (inbound ID) 11678: value = uniqueID 11679: 11680: =back 11681: 11682: =head2 HTTP Helper Routines 11683: 11684: =over 4 11685: 11686: =item * 11687: 11688: escape() : unpack non-word characters into CGI-compatible hex codes 11689: 11690: =item * 11691: 11692: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character 11693: 11694: =back 11695: 11696: =head1 PRIVATE SUBROUTINES 11697: 11698: =head2 Underlying communication routines (Shouldn't call) 11699: 11700: =over 4 11701: 11702: =item * 11703: 11704: subreply() : tries to pass a message to lonc, returns con_lost if incapable 11705: 11706: =item * 11707: 11708: reply() : uses subreply to send a message to remote machine, logs all failures 11709: 11710: =item * 11711: 11712: critical() : passes a critical message to another server; if cannot 11713: get through then place message in connection buffer directory and 11714: returns con_delayed, if incapable of saving message, returns 11715: con_failed 11716: 11717: =item * 11718: 11719: reconlonc() : tries to reconnect lonc client processes. 11720: 11721: =back 11722: 11723: =head2 Resource Access Logging 11724: 11725: =over 4 11726: 11727: =item * 11728: 11729: flushcourselogs() : flush (save) buffer logs and access logs 11730: 11731: =item * 11732: 11733: courselog($what) : save message for course in hash 11734: 11735: =item * 11736: 11737: courseacclog($what) : save message for course using &courselog(). Perform 11738: special processing for specific resource types (problems, exams, quizzes, etc). 11739: 11740: =item * 11741: 11742: goodbye() : flush course logs and log shutting down; it is called in srm.conf 11743: as a PerlChildExitHandler 11744: 11745: =back 11746: 11747: =head2 Other 11748: 11749: =over 4 11750: 11751: =item * 11752: 11753: symblist($mapname,%newhash) : update symbolic storage links 11754: 11755: =back 11756: 11757: =cut 11758: