loncom/lonnet/perl/lonnet.pm - view

File: [LON-CAPA] / loncom / lonnet / perl / lonnet.pm
Revision 1.1096: download - view: text, annotated - select for diffs
Thu Dec 30 19:35:37 2010 UTC (13 years, 6 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Portfolio files can be overwritten in course context, if locked file is
  locked for an assignment with access controlled by a slot which is
  currently open for user (i.e., slot status: RESERVED_LOCATION or RESERVED).

1: # The LearningOnline Network 2: # TCP networking package 3: # 4: # $Id: lonnet.pm,v 1.1096 2010/12/30 19:35:37 raeburn Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: ### 29: 30: =pod 31: 32: =head1 NAME 33: 34: Apache::lonnet.pm 35: 36: =head1 SYNOPSIS 37: 38: This file is an interface to the lonc processes of 39: the LON-CAPA network as well as set of elaborated functions for handling information 40: necessary for navigating through a given cluster of LON-CAPA machines within a 41: domain. There are over 40 specialized functions in this module which handle the 42: reading and transmission of metadata, user information (ids, names, environments, roles, 43: logs), file information (storage, reading, directories, extensions, replication, embedded 44: styles and descriptors), educational resources (course descriptions, section names and 45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to 46: and from more descriptive phrases or explanations. 47: 48: This is part of the LearningOnline Network with CAPA project 49: described at http://www.lon-capa.org. 50: 51: =head1 Package Variables 52: 53: These are largely undocumented, so if you decipher one please note it here. 54: 55: =over 4 56: 57: =item $processmarker 58: 59: Contains the time this process was started and this servers host id. 60: 61: =item $dumpcount 62: 63: Counts the number of times a message log flush has been attempted (regardless 64: of success) by this process. Used as part of the filename when messages are 65: delayed. 66: 67: =back 68: 69: =cut 70: 71: package Apache::lonnet; 72: 73: use strict; 74: use LWP::UserAgent(); 75: use HTTP::Date; 76: use Image::Magick; 77: 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir 79: $_64bit %env %protocol %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_loncaparev { 200: my ($dom,$lonhost,$ignore_cache,$caller) = @_; 201: if (defined($lonhost)) { 202: if (!defined(&hostname($lonhost))) { 203: undef($lonhost); 204: } 205: } 206: if (!defined($lonhost)) { 207: if (defined(&domain($dom,'primary'))) { 208: $lonhost=&domain($dom,'primary'); 209: if ($lonhost eq 'no_host') { 210: undef($lonhost); 211: } 212: } 213: } 214: if (defined($lonhost)) { 215: my $cachetime = 12*3600; 216: if (!$ignore_cache) { 217: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost); 218: if (defined($cached)) { 219: return $loncaparev; 220: } 221: } 222: my ($answer,$loncaparev); 223: my @ids=&current_machine_ids(); 224: if (grep(/^\Q$lonhost\E$/,@ids)) { 225: $answer = $perlvar{'lonVersion'}; 226: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) { 227: $loncaparev = $1; 228: } 229: } else { 230: $answer = &reply('serverloncaparev',$lonhost); 231: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) { 232: if ($caller eq 'loncron') { 233: my $ua=new LWP::UserAgent; 234: $ua->timeout(4); 235: my $protocol = $protocol{$lonhost}; 236: $protocol = 'http' if ($protocol ne 'https'); 237: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html'; 238: my $request=new HTTP::Request('GET',$url); 239: my $response=$ua->request($request); 240: unless ($response->is_error()) { 241: my $content = $response->content; 242: if ($content =~ /VERSION\:\s*([\w.\-]+)<\/p>/) { 243: $loncaparev = $1; 244: } 245: } 246: } else { 247: $loncaparev = $loncaparevs{$lonhost}; 248: } 249: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) { 250: $loncaparev = $1; 251: } 252: } 253: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime); 254: } 255: } 256: 257: sub get_server_homeID { 258: my ($hostname,$ignore_cache,$caller) = @_; 259: unless ($ignore_cache) { 260: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname); 261: if (defined($cached)) { 262: return $serverhomeID; 263: } 264: } 265: my $cachetime = 12*3600; 266: my $serverhomeID; 267: if ($caller eq 'loncron') { 268: my @machine_ids = &machine_ids($hostname); 269: foreach my $id (@machine_ids) { 270: my $response = &reply('serverhomeID',$id); 271: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) { 272: $serverhomeID = $response; 273: last; 274: } 275: } 276: if ($serverhomeID eq '') { 277: $serverhomeID = $machine_ids[-1]; 278: } 279: } else { 280: $serverhomeID = $serverhomeIDs{$hostname}; 281: } 282: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime); 283: } 284: 285: # -------------------------------------------------- Non-critical communication 286: sub subreply { 287: my ($cmd,$server)=@_; 288: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server); 289: # 290: # With loncnew process trimming, there's a timing hole between lonc server 291: # process exit and the master server picking up the listen on the AF_UNIX 292: # socket. In that time interval, a lock file will exist: 293: 294: my $lockfile=$peerfile.".lock"; 295: while (-e $lockfile) { # Need to wait for the lockfile to disappear. 296: sleep(1); 297: } 298: # At this point, either a loncnew parent is listening or an old lonc 299: # or loncnew child is listening so we can connect or everything's dead. 300: # 301: # We'll give the connection a few tries before abandoning it. If 302: # connection is not possible, we'll con_lost back to the client. 303: # 304: my $client; 305: for (my $retries = 0; $retries < $max_connection_retries; $retries++) { 306: $client=IO::Socket::UNIX->new(Peer =>"$peerfile", 307: Type => SOCK_STREAM, 308: Timeout => 10); 309: if ($client) { 310: last; # Connected! 311: } else { 312: &create_connection(&hostname($server),$server); 313: } 314: sleep(1); # Try again later if failed connection. 315: } 316: my $answer; 317: if ($client) { 318: print $client "sethost:$server:$cmd\n"; 319: $answer=<$client>; 320: if (!$answer) { $answer="con_lost"; } 321: chomp($answer); 322: } else { 323: $answer = 'con_lost'; # Failed connection. 324: } 325: return $answer; 326: } 327: 328: sub reply { 329: my ($cmd,$server)=@_; 330: unless (defined(&hostname($server))) { return 'no_such_host'; } 331: my $answer=subreply($cmd,$server); 332: if (($answer=~/^refused/) || ($answer=~/^rejected/)) { 333: &logthis("WARNING:". 334: " $cmd to $server returned $answer"); 335: } 336: return $answer; 337: } 338: 339: # ----------------------------------------------------------- Send USR1 to lonc 340: 341: sub reconlonc { 342: my ($lonid) = @_; 343: my $hostname = &hostname($lonid); 344: if ($lonid) { 345: my $peerfile="$perlvar{'lonSockDir'}/$hostname"; 346: if ($hostname && -e $peerfile) { 347: &logthis("Trying to reconnect lonc for $lonid ($hostname)"); 348: my $client=IO::Socket::UNIX->new(Peer => $peerfile, 349: Type => SOCK_STREAM, 350: Timeout => 10); 351: if ($client) { 352: print $client ("reset_retries\n"); 353: my $answer=<$client>; 354: #reset just this one. 355: } 356: } 357: return; 358: } 359: 360: &logthis("Trying to reconnect lonc"); 361: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid"; 362: if (open(my $fh,"<$loncfile")) { 363: my $loncpid=<$fh>; 364: chomp($loncpid); 365: if (kill 0 => $loncpid) { 366: &logthis("lonc at pid $loncpid responding, sending USR1"); 367: kill USR1 => $loncpid; 368: sleep 1; 369: } else { 370: &logthis( 371: "WARNING:". 372: " lonc at pid $loncpid not responding, giving up"); 373: } 374: } else { 375: &logthis('WARNING: lonc not running, giving up'); 376: } 377: } 378: 379: # ------------------------------------------------------ Critical communication 380: 381: sub critical { 382: my ($cmd,$server)=@_; 383: unless (&hostname($server)) { 384: &logthis("WARNING:". 385: " Critical message to unknown server ($server)"); 386: return 'no_such_host'; 387: } 388: my $answer=reply($cmd,$server); 389: if ($answer eq 'con_lost') { 390: &reconlonc("$perlvar{'lonSockDir'}/$server"); 391: my $answer=reply($cmd,$server); 392: if ($answer eq 'con_lost') { 393: my $now=time; 394: my $middlename=$cmd; 395: $middlename=substr($middlename,0,16); 396: $middlename=~s/\W//g; 397: my $dfilename= 398: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server"; 399: $dumpcount++; 400: { 401: my $dfh; 402: if (open($dfh,">$dfilename")) { 403: print $dfh "$cmd\n"; 404: close($dfh); 405: } 406: } 407: sleep 2; 408: my $wcmd=''; 409: { 410: my $dfh; 411: if (open($dfh,"<$dfilename")) { 412: $wcmd=<$dfh>; 413: close($dfh); 414: } 415: } 416: chomp($wcmd); 417: if ($wcmd eq $cmd) { 418: &logthis("WARNING: ". 419: "Connection buffer $dfilename: $cmd"); 420: &logperm("D:$server:$cmd"); 421: return 'con_delayed'; 422: } else { 423: &logthis("CRITICAL:" 424: ." Critical connection failed: $server $cmd"); 425: &logperm("F:$server:$cmd"); 426: return 'con_failed'; 427: } 428: } 429: } 430: return $answer; 431: } 432: 433: # ------------------------------------------- check if return value is an error 434: 435: sub error { 436: my ($result) = @_; 437: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) { 438: if ($2 == 2) { return undef; } 439: return $1; 440: } 441: return undef; 442: } 443: 444: sub convert_and_load_session_env { 445: my ($lonidsdir,$handle)=@_; 446: my @profile; 447: { 448: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 449: if (!$opened) { 450: return 0; 451: } 452: flock($idf,LOCK_SH); 453: @profile=<$idf>; 454: close($idf); 455: } 456: my %temp_env; 457: foreach my $line (@profile) { 458: if ($line !~ m/=/) { 459: return 0; 460: } 461: chomp($line); 462: my ($envname,$envvalue)=split(/=/,$line,2); 463: $temp_env{&unescape($envname)} = &unescape($envvalue); 464: } 465: unlink("$lonidsdir/$handle.id"); 466: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(), 467: 0640)) { 468: %disk_env = %temp_env; 469: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)}; 470: untie(%disk_env); 471: } 472: return 1; 473: } 474: 475: # ------------------------------------------- Transfer profile into environment 476: my $env_loaded; 477: sub transfer_profile_to_env { 478: my ($lonidsdir,$handle,$force_transfer) = @_; 479: if (!$force_transfer && $env_loaded) { return; } 480: 481: if (!defined($lonidsdir)) { 482: $lonidsdir = $perlvar{'lonIDsDir'}; 483: } 484: if (!defined($handle)) { 485: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| ); 486: } 487: 488: my $convert; 489: { 490: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 491: if (!$opened) { 492: return; 493: } 494: flock($idf,LOCK_SH); 495: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id", 496: &GDBM_READER(),0640)) { 497: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)}; 498: untie(%disk_env); 499: } else { 500: $convert = 1; 501: } 502: } 503: if ($convert) { 504: if (!&convert_and_load_session_env($lonidsdir,$handle)) { 505: &logthis("Failed to load session, or convert session."); 506: } 507: } 508: 509: my %remove; 510: while ( my $envname = each(%env) ) { 511: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) { 512: if ($time < time-300) { 513: $remove{$key}++; 514: } 515: } 516: } 517: 518: $env{'user.environment'} = "$lonidsdir/$handle.id"; 519: $env_loaded=1; 520: foreach my $expired_key (keys(%remove)) { 521: &delenv($expired_key); 522: } 523: } 524: 525: # ---------------------------------------------------- Check for valid session 526: sub check_for_valid_session { 527: my ($r) = @_; 528: my %cookies=CGI::Cookie->parse($r->header_in('Cookie')); 529: my $lonid=$cookies{'lonID'}; 530: return undef if (!$lonid); 531: 532: my $handle=&LONCAPA::clean_handle($lonid->value); 533: my $lonidsdir=$r->dir_config('lonIDsDir'); 534: return undef if (!-e "$lonidsdir/$handle.id"); 535: 536: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id"); 537: return undef if (!$opened); 538: 539: flock($idf,LOCK_SH); 540: my %disk_env; 541: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id", 542: &GDBM_READER(),0640)) { 543: return undef; 544: } 545: 546: if (!defined($disk_env{'user.name'}) 547: || !defined($disk_env{'user.domain'})) { 548: return undef; 549: } 550: return $handle; 551: } 552: 553: sub timed_flock { 554: my ($file,$lock_type) = @_; 555: my $failed=0; 556: eval { 557: local $SIG{__DIE__}='DEFAULT'; 558: local $SIG{ALRM}=sub { 559: $failed=1; 560: die("failed lock"); 561: }; 562: alarm(13); 563: flock($file,$lock_type); 564: alarm(0); 565: }; 566: if ($failed) { 567: return undef; 568: } else { 569: return 1; 570: } 571: } 572: 573: # ---------------------------------------------------------- Append Environment 574: 575: sub appenv { 576: my ($newenv,$roles) = @_; 577: if (ref($newenv) eq 'HASH') { 578: foreach my $key (keys(%{$newenv})) { 579: my $refused = 0; 580: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) { 581: $refused = 1; 582: if (ref($roles) eq 'ARRAY') { 583: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./); 584: if (grep(/^\Q$role\E$/,@{$roles})) { 585: $refused = 0; 586: } 587: } 588: } 589: if ($refused) { 590: &logthis("WARNING: ". 591: "Attempt to modify environment ".$key." to ".$newenv->{$key} 592: .''); 593: delete($newenv->{$key}); 594: } else { 595: $env{$key}=$newenv->{$key}; 596: } 597: } 598: my $opened = open(my $env_file,'+<',$env{'user.environment'}); 599: if ($opened 600: && &timed_flock($env_file,LOCK_EX) 601: && 602: tie(my %disk_env,'GDBM_File',$env{'user.environment'}, 603: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) { 604: while (my ($key,$value) = each(%{$newenv})) { 605: $disk_env{$key} = $value; 606: } 607: untie(%disk_env); 608: } 609: } 610: return 'ok'; 611: } 612: # ----------------------------------------------------- Delete from Environment 613: 614: sub delenv { 615: my ($delthis,$regexp) = @_; 616: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) { 617: &logthis("WARNING: ". 618: "Attempt to delete from environment ".$delthis); 619: return 'error'; 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: foreach my $key (keys(%disk_env)) { 628: if ($regexp) { 629: if ($key=~/^$delthis/) { 630: delete($env{$key}); 631: delete($disk_env{$key}); 632: } 633: } else { 634: if ($key=~/^\Q$delthis\E/) { 635: delete($env{$key}); 636: delete($disk_env{$key}); 637: } 638: } 639: } 640: untie(%disk_env); 641: } 642: return 'ok'; 643: } 644: 645: sub get_env_multiple { 646: my ($name) = @_; 647: my @values; 648: if (defined($env{$name})) { 649: # exists is it an array 650: if (ref($env{$name})) { 651: @values=@{ $env{$name} }; 652: } else { 653: $values[0]=$env{$name}; 654: } 655: } 656: return(@values); 657: } 658: 659: # ------------------------------------------------------------------- Locking 660: 661: sub set_lock { 662: my ($text)=@_; 663: $locknum++; 664: my $id=$$.'-'.$locknum; 665: &appenv({'session.locks' => $env{'session.locks'}.','.$id, 666: 'session.lock.'.$id => $text}); 667: return $id; 668: } 669: 670: sub get_locks { 671: my $num=0; 672: my %texts=(); 673: foreach my $lock (split(/\,/,$env{'session.locks'})) { 674: if ($lock=~/\w/) { 675: $num++; 676: $texts{$lock}=$env{'session.lock.'.$lock}; 677: } 678: } 679: return ($num,%texts); 680: } 681: 682: sub remove_lock { 683: my ($id)=@_; 684: my $newlocks=''; 685: foreach my $lock (split(/\,/,$env{'session.locks'})) { 686: if (($lock=~/\w/) && ($lock ne $id)) { 687: $newlocks.=','.$lock; 688: } 689: } 690: &appenv({'session.locks' => $newlocks}); 691: &delenv('session.lock.'.$id); 692: } 693: 694: sub remove_all_locks { 695: my $activelocks=$env{'session.locks'}; 696: foreach my $lock (split(/\,/,$env{'session.locks'})) { 697: if ($lock=~/\w/) { 698: &remove_lock($lock); 699: } 700: } 701: } 702: 703: 704: # ------------------------------------------ Find out current server userload 705: sub userload { 706: my $numusers=0; 707: { 708: opendir(LONIDS,$perlvar{'lonIDsDir'}); 709: my $filename; 710: my $curtime=time; 711: while ($filename=readdir(LONIDS)) { 712: next if ($filename eq '.' || $filename eq '..'); 713: next if ($filename =~ /publicuser_\d+\.id/); 714: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9]; 715: if ($curtime-$mtime < 1800) { $numusers++; } 716: } 717: closedir(LONIDS); 718: } 719: my $userloadpercent=0; 720: my $maxuserload=$perlvar{'lonUserLoadLim'}; 721: if ($maxuserload) { 722: $userloadpercent=100*$numusers/$maxuserload; 723: } 724: $userloadpercent=sprintf("%.2f",$userloadpercent); 725: return $userloadpercent; 726: } 727: 728: # ------------------------------ Find server with least workload from spare.tab 729: 730: sub spareserver { 731: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_; 732: my $spare_server; 733: if ($userloadpercent !~ /\d/) { $userloadpercent=0; } 734: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent 735: : $userloadpercent; 736: my ($uint_dom,$remotesessions); 737: if (($udom ne '') && (&domain($udom) ne '')) { 738: my $uprimary_id = &Apache::lonnet::domain($udom,'primary'); 739: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id); 740: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom); 741: $remotesessions = $udomdefaults{'remotesessions'}; 742: } 743: foreach my $try_server (@{ $spareid{'primary'} }) { 744: if ($uint_dom) { 745: next unless (&spare_can_host($udom,$uint_dom,$remotesessions, 746: $try_server)); 747: } 748: ($spare_server, $lowest_load) = 749: &compare_server_load($try_server, $spare_server, $lowest_load); 750: } 751: 752: my $found_server = ($spare_server ne '' && $lowest_load < 100); 753: 754: if (!$found_server) { 755: foreach my $try_server (@{ $spareid{'default'} }) { 756: if ($uint_dom) { 757: next unless (&spare_can_host($udom,$uint_dom,$remotesessions, 758: $try_server)); 759: } 760: ($spare_server, $lowest_load) = 761: &compare_server_load($try_server, $spare_server, $lowest_load); 762: } 763: } 764: 765: if (!$want_server_name) { 766: my $protocol = 'http'; 767: if ($protocol{$spare_server} eq 'https') { 768: $protocol = $protocol{$spare_server}; 769: } 770: if (defined($spare_server)) { 771: my $hostname = &hostname($spare_server); 772: if (defined($hostname)) { 773: $spare_server = $protocol.'://'.$hostname; 774: } 775: } 776: } 777: return $spare_server; 778: } 779: 780: sub compare_server_load { 781: my ($try_server, $spare_server, $lowest_load) = @_; 782: 783: my $loadans = &reply('load', $try_server); 784: my $userloadans = &reply('userload',$try_server); 785: 786: if ($loadans !~ /\d/ && $userloadans !~ /\d/) { 787: return; #didn't get a number from the server 788: } 789: 790: my $load; 791: if ($loadans =~ /\d/) { 792: if ($userloadans =~ /\d/) { 793: #both are numbers, pick the bigger one 794: $load = ($loadans > $userloadans) ? $loadans 795: : $userloadans; 796: } else { 797: $load = $loadans; 798: } 799: } else { 800: $load = $userloadans; 801: } 802: 803: if (($load =~ /\d/) && ($load < $lowest_load)) { 804: $spare_server = $try_server; 805: $lowest_load = $load; 806: } 807: return ($spare_server,$lowest_load); 808: } 809: 810: # --------------------------- ask offload servers if user already has a session 811: sub find_existing_session { 812: my ($udom,$uname) = @_; 813: foreach my $try_server (@{ $spareid{'primary'} }, 814: @{ $spareid{'default'} }) { 815: return $try_server if (&has_user_session($try_server, $udom, $uname)); 816: } 817: return; 818: } 819: 820: # -------------------------------- ask if server already has a session for user 821: sub has_user_session { 822: my ($lonid,$udom,$uname) = @_; 823: my $result = &reply(join(':','userhassession', 824: map {&escape($_)} ($udom,$uname)),$lonid); 825: return 1 if ($result eq 'ok'); 826: 827: return 0; 828: } 829: 830: # --------- determine least loaded server in a user's domain which allows login 831: 832: sub choose_server { 833: my ($udom) = @_; 834: my %domconfhash = &Apache::loncommon::get_domainconf($udom); 835: my %servers = &get_servers($udom); 836: my $lowest_load = 30000; 837: my ($login_host,$hostname); 838: foreach my $lonhost (keys(%servers)) { 839: my $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost}; 840: if ($loginvia eq '') { 841: ($login_host, $lowest_load) = 842: &compare_server_load($lonhost, $login_host, $lowest_load); 843: } 844: } 845: if ($login_host ne '') { 846: $hostname = $servers{$login_host}; 847: } 848: return ($login_host,$hostname); 849: } 850: 851: # --------------------------------------------- Try to change a user's password 852: 853: sub changepass { 854: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_; 855: $currentpass = &escape($currentpass); 856: $newpass = &escape($newpass); 857: my $lonhost = $perlvar{'lonHostID'}; 858: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost", 859: $server); 860: if (! $answer) { 861: &logthis("No reply on password change request to $server ". 862: "by $uname in domain $udom."); 863: } elsif ($answer =~ "^ok") { 864: &logthis("$uname in $udom successfully changed their password ". 865: "on $server."); 866: } elsif ($answer =~ "^pwchange_failure") { 867: &logthis("$uname in $udom was unable to change their password ". 868: "on $server. The action was blocked by either lcpasswd ". 869: "or pwchange"); 870: } elsif ($answer =~ "^non_authorized") { 871: &logthis("$uname in $udom did not get their password correct when ". 872: "attempting to change it on $server."); 873: } elsif ($answer =~ "^auth_mode_error") { 874: &logthis("$uname in $udom attempted to change their password despite ". 875: "not being locally or internally authenticated on $server."); 876: } elsif ($answer =~ "^unknown_user") { 877: &logthis("$uname in $udom attempted to change their password ". 878: "on $server but were unable to because $server is not ". 879: "their home server."); 880: } elsif ($answer =~ "^refused") { 881: &logthis("$server refused to change $uname in $udom password because ". 882: "it was sent an unencrypted request to change the password."); 883: } elsif ($answer =~ "invalid_client") { 884: &logthis("$server refused to change $uname in $udom password because ". 885: "it was a reset by e-mail originating from an invalid server."); 886: } 887: return $answer; 888: } 889: 890: # ----------------------- Try to determine user's current authentication scheme 891: 892: sub queryauthenticate { 893: my ($uname,$udom)=@_; 894: my $uhome=&homeserver($uname,$udom); 895: if (!$uhome) { 896: &logthis("User $uname at $udom is unknown when looking for authentication mechanism"); 897: return 'no_host'; 898: } 899: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome); 900: if ($answer =~ /^(unknown_user|refused|con_lost)/) { 901: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 902: } 903: return $answer; 904: } 905: 906: # --------- Try to authenticate user from domain's lib servers (first this one) 907: 908: sub authenticate { 909: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_; 910: $upass=&escape($upass); 911: $uname= &LONCAPA::clean_username($uname); 912: my $uhome=&homeserver($uname,$udom,1); 913: my $newhome; 914: if ((!$uhome) || ($uhome eq 'no_host')) { 915: # Maybe the machine was offline and only re-appeared again recently? 916: &reconlonc(); 917: # One more 918: $uhome=&homeserver($uname,$udom,1); 919: if (($uhome eq 'no_host') && $checkdefauth) { 920: if (defined(&domain($udom,'primary'))) { 921: $newhome=&domain($udom,'primary'); 922: } 923: if ($newhome ne '') { 924: $uhome = $newhome; 925: } 926: } 927: if ((!$uhome) || ($uhome eq 'no_host')) { 928: &logthis("User $uname at $udom is unknown in authenticate"); 929: return 'no_host'; 930: } 931: } 932: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome); 933: if ($answer eq 'authorized') { 934: if ($newhome) { 935: &logthis("User $uname at $udom authorized by $uhome, but needs account"); 936: return 'no_account_on_host'; 937: } else { 938: &logthis("User $uname at $udom authorized by $uhome"); 939: return $uhome; 940: } 941: } 942: if ($answer eq 'non_authorized') { 943: &logthis("User $uname at $udom rejected by $uhome"); 944: return 'no_host'; 945: } 946: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism"); 947: return 'no_host'; 948: } 949: 950: sub can_host_session { 951: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_; 952: my $canhost = 1; 953: my $host_idn = &Apache::lonnet::internet_dom($lonhost); 954: if (ref($remotesessions) eq 'HASH') { 955: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') { 956: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) { 957: $canhost = 0; 958: } else { 959: $canhost = 1; 960: } 961: } 962: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') { 963: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) { 964: $canhost = 1; 965: } else { 966: $canhost = 0; 967: } 968: } 969: if ($canhost) { 970: if ($remotesessions->{'version'} ne '') { 971: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/); 972: if ($reqmajor ne '' && $reqminor ne '') { 973: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) { 974: my $major = $1; 975: my $minor = $2; 976: if (($major < $reqmajor ) || 977: (($major == $reqmajor) && ($minor < $reqminor))) { 978: $canhost = 0; 979: } 980: } else { 981: $canhost = 0; 982: } 983: } 984: } 985: } 986: } 987: if ($canhost) { 988: if (ref($hostedsessions) eq 'HASH') { 989: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') { 990: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'excludedomain'}})) { 991: $canhost = 0; 992: } else { 993: $canhost = 1; 994: } 995: } 996: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') { 997: if (grep(/^\Q$udom\E$/,@{$hostedsessions->{'includedomain'}})) { 998: $canhost = 1; 999: } else { 1000: $canhost = 0; 1001: } 1002: } 1003: } 1004: } 1005: return $canhost; 1006: } 1007: 1008: sub spare_can_host { 1009: my ($udom,$uint_dom,$remotesessions,$try_server)=@_; 1010: my $canhost=1; 1011: my @intdoms; 1012: my $internet_names = &Apache::lonnet::get_internet_names($try_server); 1013: if (ref($internet_names) eq 'ARRAY') { 1014: @intdoms = @{$internet_names}; 1015: } 1016: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) { 1017: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server); 1018: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID); 1019: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom); 1020: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server); 1021: $canhost = &can_host_session($udom,$try_server,$remoterev, 1022: $remotesessions, 1023: $defdomdefaults{'hostedsessions'}); 1024: } 1025: return $canhost; 1026: } 1027: 1028: # ---------------------- Find the homebase for a user from domain's lib servers 1029: 1030: my %homecache; 1031: sub homeserver { 1032: my ($uname,$udom,$ignoreBadCache)=@_; 1033: my $index="$uname:$udom"; 1034: 1035: if (exists($homecache{$index})) { return $homecache{$index}; } 1036: 1037: my %servers = &get_servers($udom,'library'); 1038: foreach my $tryserver (keys(%servers)) { 1039: next if ($ignoreBadCache ne 'true' && 1040: exists($badServerCache{$tryserver})); 1041: 1042: my $answer=reply("home:$udom:$uname",$tryserver); 1043: if ($answer eq 'found') { 1044: delete($badServerCache{$tryserver}); 1045: return $homecache{$index}=$tryserver; 1046: } elsif ($answer eq 'no_host') { 1047: $badServerCache{$tryserver}=1; 1048: } 1049: } 1050: return 'no_host'; 1051: } 1052: 1053: # ------------------------------------- Find the usernames behind a list of IDs 1054: 1055: sub idget { 1056: my ($udom,@ids)=@_; 1057: my %returnhash=(); 1058: 1059: my %servers = &get_servers($udom,'library'); 1060: foreach my $tryserver (keys(%servers)) { 1061: my $idlist=join('&',@ids); 1062: $idlist=~tr/A-Z/a-z/; 1063: my $reply=&reply("idget:$udom:".$idlist,$tryserver); 1064: my @answer=(); 1065: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) { 1066: @answer=split(/\&/,$reply); 1067: } ; 1068: my $i; 1069: for ($i=0;$i<=$#ids;$i++) { 1070: if ($answer[$i]) { 1071: $returnhash{$ids[$i]}=$answer[$i]; 1072: } 1073: } 1074: } 1075: return %returnhash; 1076: } 1077: 1078: # ------------------------------------- Find the IDs behind a list of usernames 1079: 1080: sub idrget { 1081: my ($udom,@unames)=@_; 1082: my %returnhash=(); 1083: foreach my $uname (@unames) { 1084: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1]; 1085: } 1086: return %returnhash; 1087: } 1088: 1089: # ------------------------------- Store away a list of names and associated IDs 1090: 1091: sub idput { 1092: my ($udom,%ids)=@_; 1093: my %servers=(); 1094: foreach my $uname (keys(%ids)) { 1095: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname); 1096: my $uhom=&homeserver($uname,$udom); 1097: if ($uhom ne 'no_host') { 1098: my $id=&escape($ids{$uname}); 1099: $id=~tr/A-Z/a-z/; 1100: my $esc_unam=&escape($uname); 1101: if ($servers{$uhom}) { 1102: $servers{$uhom}.='&'.$id.'='.$esc_unam; 1103: } else { 1104: $servers{$uhom}=$id.'='.$esc_unam; 1105: } 1106: } 1107: } 1108: foreach my $server (keys(%servers)) { 1109: &critical('idput:'.$udom.':'.$servers{$server},$server); 1110: } 1111: } 1112: 1113: # ------------------------------dump from db file owned by domainconfig user 1114: sub dump_dom { 1115: my ($namespace,$udom,$regexp,$range)=@_; 1116: if (!$udom) { 1117: $udom=$env{'user.domain'}; 1118: } 1119: my %returnhash; 1120: if ($udom) { 1121: my $uname = &get_domainconfiguser($udom); 1122: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range); 1123: } 1124: return %returnhash; 1125: } 1126: 1127: # ------------------------------------------ get items from domain db files 1128: 1129: sub get_dom { 1130: my ($namespace,$storearr,$udom,$uhome)=@_; 1131: my $items=''; 1132: foreach my $item (@$storearr) { 1133: $items.=&escape($item).'&'; 1134: } 1135: $items=~s/\&$//; 1136: if (!$udom) { 1137: $udom=$env{'user.domain'}; 1138: if (defined(&domain($udom,'primary'))) { 1139: $uhome=&domain($udom,'primary'); 1140: } else { 1141: undef($uhome); 1142: } 1143: } else { 1144: if (!$uhome) { 1145: if (defined(&domain($udom,'primary'))) { 1146: $uhome=&domain($udom,'primary'); 1147: } 1148: } 1149: } 1150: if ($udom && $uhome && ($uhome ne 'no_host')) { 1151: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome); 1152: my %returnhash; 1153: if ($rep eq '' || $rep =~ /^error: 2 /) { 1154: return %returnhash; 1155: } 1156: my @pairs=split(/\&/,$rep); 1157: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 1158: return @pairs; 1159: } 1160: my $i=0; 1161: foreach my $item (@$storearr) { 1162: $returnhash{$item}=&thaw_unescape($pairs[$i]); 1163: $i++; 1164: } 1165: return %returnhash; 1166: } else { 1167: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)"); 1168: } 1169: } 1170: 1171: # -------------------------------------------- put items in domain db files 1172: 1173: sub put_dom { 1174: my ($namespace,$storehash,$udom,$uhome)=@_; 1175: if (!$udom) { 1176: $udom=$env{'user.domain'}; 1177: if (defined(&domain($udom,'primary'))) { 1178: $uhome=&domain($udom,'primary'); 1179: } else { 1180: undef($uhome); 1181: } 1182: } else { 1183: if (!$uhome) { 1184: if (defined(&domain($udom,'primary'))) { 1185: $uhome=&domain($udom,'primary'); 1186: } 1187: } 1188: } 1189: if ($udom && $uhome && ($uhome ne 'no_host')) { 1190: my $items=''; 1191: foreach my $item (keys(%$storehash)) { 1192: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 1193: } 1194: $items=~s/\&$//; 1195: return &reply("putdom:$udom:$namespace:$items",$uhome); 1196: } else { 1197: &logthis("put_dom failed - no homeserver and/or domain"); 1198: } 1199: } 1200: 1201: # --------------------- newput for items in db file owned by domainconfig user 1202: sub newput_dom { 1203: my ($namespace,$storehash,$udom) = @_; 1204: my $result; 1205: if (!$udom) { 1206: $udom=$env{'user.domain'}; 1207: } 1208: if ($udom) { 1209: my $uname = &get_domainconfiguser($udom); 1210: $result = &newput($namespace,$storehash,$udom,$uname); 1211: } 1212: return $result; 1213: } 1214: 1215: # --------------------- delete for items in db file owned by domainconfig user 1216: sub del_dom { 1217: my ($namespace,$storearr,$udom)=@_; 1218: if (ref($storearr) eq 'ARRAY') { 1219: if (!$udom) { 1220: $udom=$env{'user.domain'}; 1221: } 1222: if ($udom) { 1223: my $uname = &get_domainconfiguser($udom); 1224: return &del($namespace,$storearr,$udom,$uname); 1225: } 1226: } 1227: } 1228: 1229: # ----------------------------------construct domainconfig user for a domain 1230: sub get_domainconfiguser { 1231: my ($udom) = @_; 1232: return $udom.'-domainconfig'; 1233: } 1234: 1235: sub retrieve_inst_usertypes { 1236: my ($udom) = @_; 1237: my (%returnhash,@order); 1238: my %domdefs = &Apache::lonnet::get_domain_defaults($udom); 1239: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') && 1240: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) { 1241: %returnhash = %{$domdefs{'inststatustypes'}}; 1242: @order = @{$domdefs{'inststatusorder'}}; 1243: } else { 1244: if (defined(&domain($udom,'primary'))) { 1245: my $uhome=&domain($udom,'primary'); 1246: my $rep=&reply("inst_usertypes:$udom",$uhome); 1247: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) { 1248: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom"); 1249: return (\%returnhash,\@order); 1250: } 1251: my ($hashitems,$orderitems) = split(/:/,$rep); 1252: my @pairs=split(/\&/,$hashitems); 1253: foreach my $item (@pairs) { 1254: my ($key,$value)=split(/=/,$item,2); 1255: $key = &unescape($key); 1256: next if ($key =~ /^error: 2 /); 1257: $returnhash{$key}=&thaw_unescape($value); 1258: } 1259: my @esc_order = split(/\&/,$orderitems); 1260: foreach my $item (@esc_order) { 1261: push(@order,&unescape($item)); 1262: } 1263: } else { 1264: &logthis("get_dom failed - no primary domain server for $udom"); 1265: } 1266: } 1267: return (\%returnhash,\@order); 1268: } 1269: 1270: sub is_domainimage { 1271: my ($url) = @_; 1272: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) { 1273: if (&domain($1) ne '') { 1274: return '1'; 1275: } 1276: } 1277: return; 1278: } 1279: 1280: sub inst_directory_query { 1281: my ($srch) = @_; 1282: my $udom = $srch->{'srchdomain'}; 1283: my %results; 1284: my $homeserver = &domain($udom,'primary'); 1285: my $outcome; 1286: if ($homeserver ne '') { 1287: my $queryid=&reply("querysend:instdirsearch:". 1288: &escape($srch->{'srchby'}).':'. 1289: &escape($srch->{'srchterm'}).':'. 1290: &escape($srch->{'srchtype'}),$homeserver); 1291: my $host=&hostname($homeserver); 1292: if ($queryid !~/^\Q$host\E\_/) { 1293: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1294: return; 1295: } 1296: my $response = &get_query_reply($queryid); 1297: my $maxtries = 5; 1298: my $tries = 1; 1299: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1300: $response = &get_query_reply($queryid); 1301: $tries ++; 1302: } 1303: 1304: if (!&error($response) && $response ne 'refused') { 1305: if ($response eq 'unavailable') { 1306: $outcome = $response; 1307: } else { 1308: $outcome = 'ok'; 1309: my @matches = split(/\n/,$response); 1310: foreach my $match (@matches) { 1311: my ($key,$value) = split(/=/,$match); 1312: $results{&unescape($key).':'.$udom} = &thaw_unescape($value); 1313: } 1314: } 1315: } 1316: } 1317: return ($outcome,%results); 1318: } 1319: 1320: sub usersearch { 1321: my ($srch) = @_; 1322: my $dom = $srch->{'srchdomain'}; 1323: my %results; 1324: my %libserv = &all_library(); 1325: my $query = 'usersearch'; 1326: foreach my $tryserver (keys(%libserv)) { 1327: if (&host_domain($tryserver) eq $dom) { 1328: my $host=&hostname($tryserver); 1329: my $queryid= 1330: &reply("querysend:".&escape($query).':'. 1331: &escape($srch->{'srchby'}).':'. 1332: &escape($srch->{'srchtype'}).':'. 1333: &escape($srch->{'srchterm'}),$tryserver); 1334: if ($queryid !~/^\Q$host\E\_/) { 1335: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver); 1336: next; 1337: } 1338: my $reply = &get_query_reply($queryid); 1339: my $maxtries = 1; 1340: my $tries = 1; 1341: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 1342: $reply = &get_query_reply($queryid); 1343: $tries ++; 1344: } 1345: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 1346: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries); 1347: } else { 1348: my @matches; 1349: if ($reply =~ /\n/) { 1350: @matches = split(/\n/,$reply); 1351: } else { 1352: @matches = split(/\&/,$reply); 1353: } 1354: foreach my $match (@matches) { 1355: my ($uname,$udom,%userhash); 1356: foreach my $entry (split(/:/,$match)) { 1357: my ($key,$value) = 1358: map {&unescape($_);} split(/=/,$entry); 1359: $userhash{$key} = $value; 1360: if ($key eq 'username') { 1361: $uname = $value; 1362: } elsif ($key eq 'domain') { 1363: $udom = $value; 1364: } 1365: } 1366: $results{$uname.':'.$udom} = \%userhash; 1367: } 1368: } 1369: } 1370: } 1371: return %results; 1372: } 1373: 1374: sub get_instuser { 1375: my ($udom,$uname,$id) = @_; 1376: my $homeserver = &domain($udom,'primary'); 1377: my ($outcome,%results); 1378: if ($homeserver ne '') { 1379: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'. 1380: &escape($id).':'.&escape($udom),$homeserver); 1381: my $host=&hostname($homeserver); 1382: if ($queryid !~/^\Q$host\E\_/) { 1383: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom); 1384: return; 1385: } 1386: my $response = &get_query_reply($queryid); 1387: my $maxtries = 5; 1388: my $tries = 1; 1389: while (($response=~/^timeout/) && ($tries < $maxtries)) { 1390: $response = &get_query_reply($queryid); 1391: $tries ++; 1392: } 1393: if (!&error($response) && $response ne 'refused') { 1394: if ($response eq 'unavailable') { 1395: $outcome = $response; 1396: } else { 1397: $outcome = 'ok'; 1398: my @matches = split(/\n/,$response); 1399: foreach my $match (@matches) { 1400: my ($key,$value) = split(/=/,$match); 1401: $results{&unescape($key)} = &thaw_unescape($value); 1402: } 1403: } 1404: } 1405: } 1406: my %userinfo; 1407: if (ref($results{$uname}) eq 'HASH') { 1408: %userinfo = %{$results{$uname}}; 1409: } 1410: return ($outcome,%userinfo); 1411: } 1412: 1413: sub inst_rulecheck { 1414: my ($udom,$uname,$id,$item,$rules) = @_; 1415: my %returnhash; 1416: if ($udom ne '') { 1417: if (ref($rules) eq 'ARRAY') { 1418: @{$rules} = map {&escape($_);} (@{$rules}); 1419: my $rulestr = join(':',@{$rules}); 1420: my $homeserver=&domain($udom,'primary'); 1421: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1422: my $response; 1423: if ($item eq 'username') { 1424: $response=&unescape(&reply('instrulecheck:'.&escape($udom). 1425: ':'.&escape($uname).':'.$rulestr, 1426: $homeserver)); 1427: } elsif ($item eq 'id') { 1428: $response=&unescape(&reply('instidrulecheck:'.&escape($udom). 1429: ':'.&escape($id).':'.$rulestr, 1430: $homeserver)); 1431: } elsif ($item eq 'selfcreate') { 1432: $response=&unescape(&reply('instselfcreatecheck:'. 1433: &escape($udom).':'.&escape($uname). 1434: ':'.$rulestr,$homeserver)); 1435: } 1436: if ($response ne 'refused') { 1437: my @pairs=split(/\&/,$response); 1438: foreach my $item (@pairs) { 1439: my ($key,$value)=split(/=/,$item,2); 1440: $key = &unescape($key); 1441: next if ($key =~ /^error: 2 /); 1442: $returnhash{$key}=&thaw_unescape($value); 1443: } 1444: } 1445: } 1446: } 1447: } 1448: return %returnhash; 1449: } 1450: 1451: sub inst_userrules { 1452: my ($udom,$check) = @_; 1453: my (%ruleshash,@ruleorder); 1454: if ($udom ne '') { 1455: my $homeserver=&domain($udom,'primary'); 1456: if (($homeserver ne '') && ($homeserver ne 'no_host')) { 1457: my $response; 1458: if ($check eq 'id') { 1459: $response=&reply('instidrules:'.&escape($udom), 1460: $homeserver); 1461: } elsif ($check eq 'email') { 1462: $response=&reply('instemailrules:'.&escape($udom), 1463: $homeserver); 1464: } else { 1465: $response=&reply('instuserrules:'.&escape($udom), 1466: $homeserver); 1467: } 1468: if (($response ne 'refused') && ($response ne 'error') && 1469: ($response ne 'unknown_cmd') && 1470: ($response ne 'no_such_host')) { 1471: my ($hashitems,$orderitems) = split(/:/,$response); 1472: my @pairs=split(/\&/,$hashitems); 1473: foreach my $item (@pairs) { 1474: my ($key,$value)=split(/=/,$item,2); 1475: $key = &unescape($key); 1476: next if ($key =~ /^error: 2 /); 1477: $ruleshash{$key}=&thaw_unescape($value); 1478: } 1479: my @esc_order = split(/\&/,$orderitems); 1480: foreach my $item (@esc_order) { 1481: push(@ruleorder,&unescape($item)); 1482: } 1483: } 1484: } 1485: } 1486: return (\%ruleshash,\@ruleorder); 1487: } 1488: 1489: # ------------- Get Authentication, Language and User Tools Defaults for Domain 1490: 1491: sub get_domain_defaults { 1492: my ($domain) = @_; 1493: my $cachetime = 60*60*24; 1494: my ($result,$cached)=&is_cached_new('domdefaults',$domain); 1495: if (defined($cached)) { 1496: if (ref($result) eq 'HASH') { 1497: return %{$result}; 1498: } 1499: } 1500: my %domdefaults; 1501: my %domconfig = 1502: &Apache::lonnet::get_dom('configuration',['defaults','quotas', 1503: 'requestcourses','inststatus', 1504: 'coursedefaults','usersessions'],$domain); 1505: if (ref($domconfig{'defaults'}) eq 'HASH') { 1506: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'}; 1507: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'}; 1508: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'}; 1509: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'}; 1510: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'}; 1511: } else { 1512: $domdefaults{'lang_def'} = &domain($domain,'lang_def'); 1513: $domdefaults{'auth_def'} = &domain($domain,'auth_def'); 1514: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def'); 1515: } 1516: if (ref($domconfig{'quotas'}) eq 'HASH') { 1517: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') { 1518: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'}; 1519: } else { 1520: $domdefaults{'defaultquota'} = $domconfig{'quotas'}; 1521: } 1522: my @usertools = ('aboutme','blog','portfolio'); 1523: foreach my $item (@usertools) { 1524: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') { 1525: $domdefaults{$item} = $domconfig{'quotas'}{$item}; 1526: } 1527: } 1528: } 1529: if (ref($domconfig{'requestcourses'}) eq 'HASH') { 1530: foreach my $item ('official','unofficial','community') { 1531: $domdefaults{$item} = $domconfig{'requestcourses'}{$item}; 1532: } 1533: } 1534: if (ref($domconfig{'inststatus'}) eq 'HASH') { 1535: foreach my $item ('inststatustypes','inststatusorder') { 1536: $domdefaults{$item} = $domconfig{'inststatus'}{$item}; 1537: } 1538: } 1539: if (ref($domconfig{'coursedefaults'}) eq 'HASH') { 1540: foreach my $item ('canuse_pdfforms') { 1541: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item}; 1542: } 1543: } 1544: if (ref($domconfig{'usersessions'}) eq 'HASH') { 1545: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') { 1546: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'}; 1547: } 1548: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') { 1549: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'}; 1550: } 1551: } 1552: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults, 1553: $cachetime); 1554: return %domdefaults; 1555: } 1556: 1557: # --------------------------------------------------- Assign a key to a student 1558: 1559: sub assign_access_key { 1560: # 1561: # a valid key looks like uname:udom#comments 1562: # comments are being appended 1563: # 1564: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_; 1565: $kdom= 1566: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom)); 1567: $knum= 1568: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum)); 1569: $cdom= 1570: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1571: $cnum= 1572: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1573: $udom=$env{'user.name'} unless (defined($udom)); 1574: $uname=$env{'user.domain'} unless (defined($uname)); 1575: my %existing=&get('accesskeys',[$ckey],$kdom,$knum); 1576: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key 1577: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) { 1578: # assigned to this person 1579: # - this should not happen, 1580: # unless something went wrong 1581: # the first time around 1582: # ready to assign 1583: $logentry=$1.'; '.$logentry; 1584: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry}, 1585: $kdom,$knum) eq 'ok') { 1586: # key now belongs to user 1587: my $envkey='key.'.$cdom.'_'.$cnum; 1588: if (&put('environment',{$envkey => $ckey}) eq 'ok') { 1589: &appenv({'environment.'.$envkey => $ckey}); 1590: return 'ok'; 1591: } else { 1592: return 1593: 'error: Count not permanently assign key, will need to be re-entered later.'; 1594: } 1595: } else { 1596: return 'error: Could not assign key, try again later.'; 1597: } 1598: } elsif (!$existing{$ckey}) { 1599: # the key does not exist 1600: return 'error: The key does not exist'; 1601: } else { 1602: # the key is somebody else's 1603: return 'error: The key is already in use'; 1604: } 1605: } 1606: 1607: # ------------------------------------------ put an additional comment on a key 1608: 1609: sub comment_access_key { 1610: # 1611: # a valid key looks like uname:udom#comments 1612: # comments are being appended 1613: # 1614: my ($ckey,$cdom,$cnum,$logentry)=@_; 1615: $cdom= 1616: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1617: $cnum= 1618: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1619: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1620: if ($existing{$ckey}) { 1621: $existing{$ckey}.='; '.$logentry; 1622: # ready to assign 1623: if (&put('accesskeys',{$ckey=>$existing{$ckey}}, 1624: $cdom,$cnum) eq 'ok') { 1625: return 'ok'; 1626: } else { 1627: return 'error: Count not store comment.'; 1628: } 1629: } else { 1630: # the key does not exist 1631: return 'error: The key does not exist'; 1632: } 1633: } 1634: 1635: # ------------------------------------------------------ Generate a set of keys 1636: 1637: sub generate_access_keys { 1638: my ($number,$cdom,$cnum,$logentry)=@_; 1639: $cdom= 1640: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1641: $cnum= 1642: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1643: unless (&allowed('mky',$cdom)) { return 0; } 1644: unless (($cdom) && ($cnum)) { return 0; } 1645: if ($number>10000) { return 0; } 1646: sleep(2); # make sure don't get same seed twice 1647: srand(time()^($$+($$<<15))); # from "Programming Perl" 1648: my $total=0; 1649: for (my $i=1;$i<=$number;$i++) { 1650: my $newkey=sprintf("%lx",int(100000*rand)).'-'. 1651: sprintf("%lx",int(100000*rand)).'-'. 1652: sprintf("%lx",int(100000*rand)); 1653: $newkey=~s/1/g/g; # folks mix up 1 and l 1654: $newkey=~s/0/h/g; # and also 0 and O 1655: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum); 1656: if ($existing{$newkey}) { 1657: $i--; 1658: } else { 1659: if (&put('accesskeys', 1660: { $newkey => '# generated '.localtime(). 1661: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}. 1662: '; '.$logentry }, 1663: $cdom,$cnum) eq 'ok') { 1664: $total++; 1665: } 1666: } 1667: } 1668: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 1669: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom); 1670: return $total; 1671: } 1672: 1673: # ------------------------------------------------------- Validate an accesskey 1674: 1675: sub validate_access_key { 1676: my ($ckey,$cdom,$cnum,$udom,$uname)=@_; 1677: $cdom= 1678: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom)); 1679: $cnum= 1680: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum)); 1681: $udom=$env{'user.domain'} unless (defined($udom)); 1682: $uname=$env{'user.name'} unless (defined($uname)); 1683: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum); 1684: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/); 1685: } 1686: 1687: # ------------------------------------- Find the section of student in a course 1688: sub devalidate_getsection_cache { 1689: my ($udom,$unam,$courseid)=@_; 1690: my $hashid="$udom:$unam:$courseid"; 1691: &devalidate_cache_new('getsection',$hashid); 1692: } 1693: 1694: sub courseid_to_courseurl { 1695: my ($courseid) = @_; 1696: #already url style courseid 1697: return $courseid if ($courseid =~ m{^/}); 1698: 1699: if (exists($env{'course.'.$courseid.'.num'})) { 1700: my $cnum = $env{'course.'.$courseid.'.num'}; 1701: my $cdom = $env{'course.'.$courseid.'.domain'}; 1702: return "/$cdom/$cnum"; 1703: } 1704: 1705: my %courseinfo=&Apache::lonnet::coursedescription($courseid); 1706: if (exists($courseinfo{'num'})) { 1707: return "/$courseinfo{'domain'}/$courseinfo{'num'}"; 1708: } 1709: 1710: return undef; 1711: } 1712: 1713: sub getsection { 1714: my ($udom,$unam,$courseid)=@_; 1715: my $cachetime=1800; 1716: 1717: my $hashid="$udom:$unam:$courseid"; 1718: my ($result,$cached)=&is_cached_new('getsection',$hashid); 1719: if (defined($cached)) { return $result; } 1720: 1721: my %Pending; 1722: my %Expired; 1723: # 1724: # Each role can either have not started yet (pending), be active, 1725: # or have expired. 1726: # 1727: # If there is an active role, we are done. 1728: # 1729: # If there is more than one role which has not started yet, 1730: # choose the one which will start sooner 1731: # If there is one role which has not started yet, return it. 1732: # 1733: # If there is more than one expired role, choose the one which ended last. 1734: # If there is a role which has expired, return it. 1735: # 1736: $courseid = &courseid_to_courseurl($courseid); 1737: my $extra = &freeze_escape({'skipcheck' => 1}); 1738: my %roleshash = &dump('roles',$udom,$unam,$courseid,undef,$extra); 1739: foreach my $key (keys(%roleshash)) { 1740: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/); 1741: my $section=$1; 1742: if ($key eq $courseid.'_st') { $section=''; } 1743: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key})); 1744: my $now=time; 1745: if (defined($end) && $end && ($now > $end)) { 1746: $Expired{$end}=$section; 1747: next; 1748: } 1749: if (defined($start) && $start && ($now < $start)) { 1750: $Pending{$start}=$section; 1751: next; 1752: } 1753: return &do_cache_new('getsection',$hashid,$section,$cachetime); 1754: } 1755: # 1756: # Presumedly there will be few matching roles from the above 1757: # loop and the sorting time will be negligible. 1758: if (scalar(keys(%Pending))) { 1759: my ($time) = sort {$a <=> $b} keys(%Pending); 1760: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime); 1761: } 1762: if (scalar(keys(%Expired))) { 1763: my @sorted = sort {$a <=> $b} keys(%Expired); 1764: my $time = pop(@sorted); 1765: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime); 1766: } 1767: return &do_cache_new('getsection',$hashid,'-1',$cachetime); 1768: } 1769: 1770: sub save_cache { 1771: &purge_remembered(); 1772: #&Apache::loncommon::validate_page(); 1773: undef(%env); 1774: undef($env_loaded); 1775: } 1776: 1777: my $to_remember=-1; 1778: my %remembered; 1779: my %accessed; 1780: my $kicks=0; 1781: my $hits=0; 1782: sub make_key { 1783: my ($name,$id) = @_; 1784: if (length($id) > 65 1785: && length(&escape($id)) > 200) { 1786: $id=length($id).':'.&Digest::MD5::md5_hex($id); 1787: } 1788: return &escape($name.':'.$id); 1789: } 1790: 1791: sub devalidate_cache_new { 1792: my ($name,$id,$debug) = @_; 1793: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); } 1794: $id=&make_key($name,$id); 1795: $memcache->delete($id); 1796: delete($remembered{$id}); 1797: delete($accessed{$id}); 1798: } 1799: 1800: sub is_cached_new { 1801: my ($name,$id,$debug) = @_; 1802: $id=&make_key($name,$id); 1803: if (exists($remembered{$id})) { 1804: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); } 1805: $accessed{$id}=[&gettimeofday()]; 1806: $hits++; 1807: return ($remembered{$id},1); 1808: } 1809: my $value = $memcache->get($id); 1810: if (!(defined($value))) { 1811: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); } 1812: return (undef,undef); 1813: } 1814: if ($value eq '__undef__') { 1815: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); } 1816: $value=undef; 1817: } 1818: &make_room($id,$value,$debug); 1819: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); } 1820: return ($value,1); 1821: } 1822: 1823: sub do_cache_new { 1824: my ($name,$id,$value,$time,$debug) = @_; 1825: $id=&make_key($name,$id); 1826: my $setvalue=$value; 1827: if (!defined($setvalue)) { 1828: $setvalue='__undef__'; 1829: } 1830: if (!defined($time) ) { 1831: $time=600; 1832: } 1833: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); } 1834: my $result = $memcache->set($id,$setvalue,$time); 1835: if (! $result) { 1836: &logthis("caching of id -> $id failed"); 1837: $memcache->disconnect_all(); 1838: } 1839: # need to make a copy of $value 1840: &make_room($id,$value,$debug); 1841: return $value; 1842: } 1843: 1844: sub make_room { 1845: my ($id,$value,$debug)=@_; 1846: 1847: $remembered{$id}= (ref($value)) ? &Storable::dclone($value) 1848: : $value; 1849: if ($to_remember<0) { return; } 1850: $accessed{$id}=[&gettimeofday()]; 1851: if (scalar(keys(%remembered)) <= $to_remember) { return; } 1852: my $to_kick; 1853: my $max_time=0; 1854: foreach my $other (keys(%accessed)) { 1855: if (&tv_interval($accessed{$other}) > $max_time) { 1856: $to_kick=$other; 1857: $max_time=&tv_interval($accessed{$other}); 1858: } 1859: } 1860: delete($remembered{$to_kick}); 1861: delete($accessed{$to_kick}); 1862: $kicks++; 1863: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); } 1864: return; 1865: } 1866: 1867: sub purge_remembered { 1868: #&logthis("Tossing ".scalar(keys(%remembered))); 1869: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered)))); 1870: undef(%remembered); 1871: undef(%accessed); 1872: } 1873: # ------------------------------------- Read an entry from a user's environment 1874: 1875: sub userenvironment { 1876: my ($udom,$unam,@what)=@_; 1877: my $items; 1878: foreach my $item (@what) { 1879: $items.=&escape($item).'&'; 1880: } 1881: $items=~s/\&$//; 1882: my %returnhash=(); 1883: my $uhome = &homeserver($unam,$udom); 1884: unless ($uhome eq 'no_host') { 1885: my @answer=split(/\&/, 1886: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome)); 1887: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) { 1888: return %returnhash; 1889: } 1890: my $i; 1891: for ($i=0;$i<=$#what;$i++) { 1892: $returnhash{$what[$i]}=&unescape($answer[$i]); 1893: } 1894: } 1895: return %returnhash; 1896: } 1897: 1898: # ---------------------------------------------------------- Get a studentphoto 1899: sub studentphoto { 1900: my ($udom,$unam,$ext) = @_; 1901: my $home=&Apache::lonnet::homeserver($unam,$udom); 1902: if (defined($env{'request.course.id'})) { 1903: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) { 1904: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) { 1905: return(&retrievestudentphoto($udom,$unam,$ext)); 1906: } else { 1907: my ($result,$perm_reqd)= 1908: &Apache::lonnet::auto_photo_permission($unam,$udom); 1909: if ($result eq 'ok') { 1910: if (!($perm_reqd eq 'yes')) { 1911: return(&retrievestudentphoto($udom,$unam,$ext)); 1912: } 1913: } 1914: } 1915: } 1916: } else { 1917: my ($result,$perm_reqd) = 1918: &Apache::lonnet::auto_photo_permission($unam,$udom); 1919: if ($result eq 'ok') { 1920: if (!($perm_reqd eq 'yes')) { 1921: return(&retrievestudentphoto($udom,$unam,$ext)); 1922: } 1923: } 1924: } 1925: return '/adm/lonKaputt/lonlogo_broken.gif'; 1926: } 1927: 1928: sub retrievestudentphoto { 1929: my ($udom,$unam,$ext,$type) = @_; 1930: my $home=&Apache::lonnet::homeserver($unam,$udom); 1931: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home); 1932: if ($ret eq 'ok') { 1933: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext"; 1934: if ($type eq 'thumbnail') { 1935: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext"; 1936: } 1937: my $tokenurl=&Apache::lonnet::tokenwrapper($url); 1938: return $tokenurl; 1939: } else { 1940: if ($type eq 'thumbnail') { 1941: return '/adm/lonKaputt/genericstudent_tn.gif'; 1942: } else { 1943: return '/adm/lonKaputt/lonlogo_broken.gif'; 1944: } 1945: } 1946: } 1947: 1948: # -------------------------------------------------------------------- New chat 1949: 1950: sub chatsend { 1951: my ($newentry,$anon,$group)=@_; 1952: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'}; 1953: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 1954: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'}; 1955: &reply('chatsend:'.$cdom.':'.$cnum.':'. 1956: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'. 1957: &escape($newentry)).':'.$group,$chome); 1958: } 1959: 1960: # ------------------------------------------ Find current version of a resource 1961: 1962: sub getversion { 1963: my $fname=&clutter(shift); 1964: unless ($fname=~/^\/res\//) { return -1; } 1965: return &currentversion(&filelocation('',$fname)); 1966: } 1967: 1968: sub currentversion { 1969: my $fname=shift; 1970: my ($result,$cached)=&is_cached_new('resversion',$fname); 1971: if (defined($cached)) { return $result; } 1972: my $author=$fname; 1973: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1974: my ($udom,$uname)=split(/\//,$author); 1975: my $home=homeserver($uname,$udom); 1976: if ($home eq 'no_host') { 1977: return -1; 1978: } 1979: my $answer=reply("currentversion:$fname",$home); 1980: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 1981: return -1; 1982: } 1983: return &do_cache_new('resversion',$fname,$answer,600); 1984: } 1985: 1986: # ----------------------------- Subscribe to a resource, return URL if possible 1987: 1988: sub subscribe { 1989: my $fname=shift; 1990: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; } 1991: $fname=~s/[\n\r]//g; 1992: my $author=$fname; 1993: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 1994: my ($udom,$uname)=split(/\//,$author); 1995: my $home=homeserver($uname,$udom); 1996: if ($home eq 'no_host') { 1997: return 'not_found'; 1998: } 1999: my $answer=reply("sub:$fname",$home); 2000: if (($answer eq 'con_lost') || ($answer eq 'rejected')) { 2001: $answer.=' by '.$home; 2002: } 2003: return $answer; 2004: } 2005: 2006: # -------------------------------------------------------------- Replicate file 2007: 2008: sub repcopy { 2009: my $filename=shift; 2010: $filename=~s/\/+/\//g; 2011: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; } 2012: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 2013: if ($filename=~m|^/home/httpd/html/userfiles/| or 2014: $filename=~m -^/*(uploaded|editupload)/-) { 2015: return &repcopy_userfile($filename); 2016: } 2017: $filename=~s/[\n\r]//g; 2018: my $transname="$filename.in.transfer"; 2019: # FIXME: this should flock 2020: if ((-e $filename) || (-e $transname)) { return 'ok'; } 2021: my $remoteurl=subscribe($filename); 2022: if ($remoteurl =~ /^con_lost by/) { 2023: &logthis("Subscribe returned $remoteurl: $filename"); 2024: return 'unavailable'; 2025: } elsif ($remoteurl eq 'not_found') { 2026: #&logthis("Subscribe returned not_found: $filename"); 2027: return 'not_found'; 2028: } elsif ($remoteurl =~ /^rejected by/) { 2029: &logthis("Subscribe returned $remoteurl: $filename"); 2030: return 'forbidden'; 2031: } elsif ($remoteurl eq 'directory') { 2032: return 'ok'; 2033: } else { 2034: my $author=$filename; 2035: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/; 2036: my ($udom,$uname)=split(/\//,$author); 2037: my $home=homeserver($uname,$udom); 2038: unless ($home eq $perlvar{'lonHostID'}) { 2039: my @parts=split(/\//,$filename); 2040: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]"; 2041: if ($path ne "$perlvar{'lonDocRoot'}/res") { 2042: &logthis("Malconfiguration for replication: $filename"); 2043: return 'bad_request'; 2044: } 2045: my $count; 2046: for ($count=5;$count<$#parts;$count++) { 2047: $path.="/$parts[$count]"; 2048: if ((-e $path)!=1) { 2049: mkdir($path,0777); 2050: } 2051: } 2052: my $ua=new LWP::UserAgent; 2053: my $request=new HTTP::Request('GET',"$remoteurl"); 2054: my $response=$ua->request($request,$transname); 2055: if ($response->is_error()) { 2056: unlink($transname); 2057: my $message=$response->status_line; 2058: &logthis("WARNING:" 2059: ." LWP get: $message: $filename"); 2060: return 'unavailable'; 2061: } else { 2062: if ($remoteurl!~/\.meta$/) { 2063: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta'); 2064: my $mresponse=$ua->request($mrequest,$filename.'.meta'); 2065: if ($mresponse->is_error()) { 2066: unlink($filename.'.meta'); 2067: &logthis( 2068: "INFO: No metadata: $filename"); 2069: } 2070: } 2071: rename($transname,$filename); 2072: return 'ok'; 2073: } 2074: } 2075: } 2076: } 2077: 2078: # ------------------------------------------------ Get server side include body 2079: sub ssi_body { 2080: my ($filelink,%form)=@_; 2081: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) { 2082: $form{'LONCAPA_INTERNAL_no_discussion'}='true'; 2083: } 2084: my $output=''; 2085: my $response; 2086: if ($filelink=~/^https?\:/) { 2087: ($output,$response)=&externalssi($filelink); 2088: } else { 2089: $filelink .= $filelink=~/\?/ ? '&' : '?'; 2090: $filelink .= 'inhibitmenu=yes'; 2091: ($output,$response)=&ssi($filelink,%form); 2092: } 2093: $output=~s|//(\s*)?\s||gs; 2094: $output=~s/^.*?\<body[^\>]*\>//si; 2095: $output=~s/\<\/body\s*\>.*?$//si; 2096: if (wantarray) { 2097: return ($output, $response); 2098: } else { 2099: return $output; 2100: } 2101: } 2102: 2103: # --------------------------------------------------------- Server Side Include 2104: 2105: sub absolute_url { 2106: my ($host_name) = @_; 2107: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://'); 2108: if ($host_name eq '') { 2109: $host_name = $ENV{'SERVER_NAME'}; 2110: } 2111: return $protocol.$host_name; 2112: } 2113: 2114: # 2115: # Server side include. 2116: # Parameters: 2117: # fn Possibly encrypted resource name/id. 2118: # form Hash that describes how the rendering should be done 2119: # and other things. 2120: # Returns: 2121: # Scalar context: The content of the response. 2122: # Array context: 2 element list of the content and the full response object. 2123: # 2124: sub ssi { 2125: 2126: my ($fn,%form)=@_; 2127: my $ua=new LWP::UserAgent; 2128: my $request; 2129: 2130: $form{'no_update_last_known'}=1; 2131: &Apache::lonenc::check_encrypt(\$fn); 2132: if (%form) { 2133: $request=new HTTP::Request('POST',&absolute_url().$fn); 2134: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form))); 2135: } else { 2136: $request=new HTTP::Request('GET',&absolute_url().$fn); 2137: } 2138: 2139: $request->header(Cookie => $ENV{'HTTP_COOKIE'}); 2140: my $response=$ua->request($request); 2141: 2142: if (wantarray) { 2143: return ($response->content, $response); 2144: } else { 2145: return $response->content; 2146: } 2147: } 2148: 2149: sub externalssi { 2150: my ($url)=@_; 2151: my $ua=new LWP::UserAgent; 2152: my $request=new HTTP::Request('GET',$url); 2153: my $response=$ua->request($request); 2154: if (wantarray) { 2155: return ($response->content, $response); 2156: } else { 2157: return $response->content; 2158: } 2159: } 2160: 2161: # -------------------------------- Allow a /uploaded/ URI to be vouched for 2162: 2163: sub allowuploaded { 2164: my ($srcurl,$url)=@_; 2165: $url=&clutter(&declutter($url)); 2166: my $dir=$url; 2167: $dir=~s/\/[^\/]+$//; 2168: my %httpref=(); 2169: my $httpurl=&hreflocation('',$url); 2170: $httpref{'httpref.'.$httpurl}=$srcurl; 2171: &Apache::lonnet::appenv(\%httpref); 2172: } 2173: 2174: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course 2175: # input: action, courseID, current domain, intended 2176: # path to file, source of file, instruction to parse file for objects, 2177: # ref to hash for embedded objects, 2178: # ref to hash for codebase of java objects. 2179: # reference to scalar to accommodate mime type determined 2180: # from File::MMagic if $parser = parse. 2181: # 2182: # output: url to file (if action was uploaddoc), 2183: # ok if successful, or diagnostic message otherwise (if action was propagate or copy) 2184: # 2185: # Allows directory structure to be used within lonUsers/../userfiles/ for a 2186: # course. 2187: # 2188: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2189: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in 2190: # course's home server. 2191: # 2192: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will 2193: # be copied from $source (current location) to 2194: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2195: # and will then be copied to 2196: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in 2197: # course's home server. 2198: # 2199: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2200: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to 2201: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file 2202: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file 2203: # in course's home server. 2204: # 2205: 2206: sub process_coursefile { 2207: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase, 2208: $mimetype)=@_; 2209: my $fetchresult; 2210: my $home=&homeserver($docuname,$docudom); 2211: if ($action eq 'propagate') { 2212: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2213: $home); 2214: } else { 2215: my $fpath = ''; 2216: my $fname = $file; 2217: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2218: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2219: my $filepath = &build_filepath($fpath); 2220: if ($action eq 'copy') { 2221: if ($source eq '') { 2222: $fetchresult = 'no source file'; 2223: return $fetchresult; 2224: } else { 2225: my $destination = $filepath.'/'.$fname; 2226: rename($source,$destination); 2227: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2228: $home); 2229: } 2230: } elsif ($action eq 'uploaddoc') { 2231: open(my $fh,'>'.$filepath.'/'.$fname); 2232: print $fh $env{'form.'.$source}; 2233: close($fh); 2234: if ($parser eq 'parse') { 2235: my $mm = new File::MMagic; 2236: my $type = $mm->checktype_filename($filepath.'/'.$fname); 2237: if ($type eq 'text/html') { 2238: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase); 2239: unless ($parse_result eq 'ok') { 2240: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result); 2241: } 2242: } 2243: if (ref($mimetype)) { 2244: $$mimetype = $type; 2245: } 2246: } 2247: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2248: $home); 2249: if ($fetchresult eq 'ok') { 2250: return '/uploaded/'.$fpath.'/'.$fname; 2251: } else { 2252: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2253: ' to host '.$home.': '.$fetchresult); 2254: return '/adm/notfound.html'; 2255: } 2256: } 2257: } 2258: unless ( $fetchresult eq 'ok') { 2259: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2260: ' to host '.$home.': '.$fetchresult); 2261: } 2262: return $fetchresult; 2263: } 2264: 2265: sub build_filepath { 2266: my ($fpath) = @_; 2267: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles'; 2268: unless ($fpath eq '') { 2269: my @parts=split('/',$fpath); 2270: foreach my $part (@parts) { 2271: $filepath.= '/'.$part; 2272: if ((-e $filepath)!=1) { 2273: mkdir($filepath,0777); 2274: } 2275: } 2276: } 2277: return $filepath; 2278: } 2279: 2280: sub store_edited_file { 2281: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_; 2282: my $file = $primary_url; 2283: $file =~ s#^/uploaded/$docudom/$docuname/##; 2284: my $fpath = ''; 2285: my $fname = $file; 2286: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|); 2287: $fpath=$docudom.'/'.$docuname.'/'.$fpath; 2288: my $filepath = &build_filepath($fpath); 2289: open(my $fh,'>'.$filepath.'/'.$fname); 2290: print $fh $content; 2291: close($fh); 2292: my $home=&homeserver($docuname,$docudom); 2293: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file, 2294: $home); 2295: if ($$fetchresult eq 'ok') { 2296: return '/uploaded/'.$fpath.'/'.$fname; 2297: } else { 2298: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file. 2299: ' to host '.$home.': '.$$fetchresult); 2300: return '/adm/notfound.html'; 2301: } 2302: } 2303: 2304: sub clean_filename { 2305: my ($fname,$args)=@_; 2306: # Replace Windows backslashes by forward slashes 2307: $fname=~s/\\/\//g; 2308: if (!$args->{'keep_path'}) { 2309: # Get rid of everything but the actual filename 2310: $fname=~s/^.*\/([^\/]+)$/$1/; 2311: } 2312: # Replace spaces by underscores 2313: $fname=~s/\s+/\_/g; 2314: # Replace all other weird characters by nothing 2315: $fname=~s{[^/\w\.\-]}{}g; 2316: # Replace all .\d. sequences with _\d. so they no longer look like version 2317: # numbers 2318: $fname=~s/\.(\d+)(?=\.)/_$1/g; 2319: return $fname; 2320: } 2321: # This Function checks if an Image's dimensions exceed either $resizewidth (width) 2322: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an 2323: # image with the same aspect ratio as the original, but with dimensions which do 2324: # not exceed $resizewidth and $resizeheight. 2325: 2326: sub resizeImage { 2327: my ($img_path,$resizewidth,$resizeheight) = @_; 2328: my $ima = Image::Magick->new; 2329: my $resized; 2330: if (-e $img_path) { 2331: $ima->Read($img_path); 2332: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) { 2333: my $width = $ima->Get('width'); 2334: my $height = $ima->Get('height'); 2335: if ($width > $resizewidth) { 2336: my $factor = $width/$resizewidth; 2337: my $newheight = $height/$factor; 2338: $ima->Scale(width=>$resizewidth,height=>$newheight); 2339: $resized = 1; 2340: } 2341: } 2342: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) { 2343: my $width = $ima->Get('width'); 2344: my $height = $ima->Get('height'); 2345: if ($height > $resizeheight) { 2346: my $factor = $height/$resizeheight; 2347: my $newwidth = $width/$factor; 2348: $ima->Scale(width=>$newwidth,height=>$resizeheight); 2349: $resized = 1; 2350: } 2351: } 2352: if ($resized) { 2353: $ima->Write($img_path); 2354: } 2355: } 2356: return; 2357: } 2358: 2359: # --------------- Take an uploaded file and put it into the userfiles directory 2360: # input: $formname - the contents of the file are in $env{"form.$formname"} 2361: # the desired filename is in $env{"form.$formname.filename"} 2362: # $context - possible values: coursedoc, existingfile, overwrite, 2363: # canceloverwrite, or ''. 2364: # if 'coursedoc': upload to the current course 2365: # if 'existingfile': write file to tmp/overwrites directory 2366: # if 'canceloverwrite': delete file written to tmp/overwrites directory 2367: # $context is passed as argument to &finishuserfileupload 2368: # $subdir - directory in userfile to store the file into 2369: # $parser - instruction to parse file for objects ($parser = parse) 2370: # $allfiles - reference to hash for embedded objects 2371: # $codebase - reference to hash for codebase of java objects 2372: # $desuname - username for permanent storage of uploaded file 2373: # $dsetudom - domain for permanaent storage of uploaded file 2374: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image 2375: # $thumbheight - height (pixels) of thumbnail to make for uploaded image 2376: # $resizewidth - width (pixels) to which to resize uploaded image 2377: # $resizeheight - height (pixels) to which to resize uploaded image 2378: # $mimetype - reference to scalar to accommodate mime type determined 2379: # from File::MMagic if $parser = parse. 2380: # 2381: # output: url of file in userspace, or error: <message> 2382: # or /adm/notfound.html if failure to upload occurse 2383: 2384: sub userfileupload { 2385: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname, 2386: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_; 2387: if (!defined($subdir)) { $subdir='unknown'; } 2388: my $fname=$env{'form.'.$formname.'.filename'}; 2389: $fname=&clean_filename($fname); 2390: # See if there is anything left 2391: unless ($fname) { return 'error: no uploaded file'; } 2392: # Files uploaded to help request form, or uploaded to "create course" page are handled differently 2393: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) || 2394: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) || 2395: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) { 2396: my $now = time; 2397: my $filepath; 2398: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { 2399: $filepath = 'tmp/helprequests/'.$now; 2400: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { 2401: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}. 2402: '_'.$env{'user.domain'}.'/pending'; 2403: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) { 2404: my ($docuname,$docudom); 2405: if ($destudom) { 2406: $docudom = $destudom; 2407: } else { 2408: $docudom = $env{'user.domain'}; 2409: } 2410: if ($destuname) { 2411: $docuname = $destuname; 2412: } else { 2413: $docuname = $env{'user.name'}; 2414: } 2415: if (exists($env{'form.group'})) { 2416: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2417: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2418: } 2419: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir; 2420: if ($context eq 'canceloverwrite') { 2421: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname; 2422: if (-e $tempfile) { 2423: my @info = stat($tempfile); 2424: if ($info[9] eq $env{'form.timestamp'}) { 2425: unlink($tempfile); 2426: } 2427: } 2428: return; 2429: } 2430: } 2431: # Create the directory if not present 2432: my @parts=split(/\//,$filepath); 2433: my $fullpath = $perlvar{'lonDaemons'}; 2434: for (my $i=0;$i<@parts;$i++) { 2435: $fullpath .= '/'.$parts[$i]; 2436: if ((-e $fullpath)!=1) { 2437: mkdir($fullpath,0777); 2438: } 2439: } 2440: open(my $fh,'>'.$fullpath.'/'.$fname); 2441: print $fh $env{'form.'.$formname}; 2442: close($fh); 2443: if ($context eq 'existingfile') { 2444: my @info = stat($fullpath.'/'.$fname); 2445: return ($fullpath.'/'.$fname,$info[9]); 2446: } else { 2447: return $fullpath.'/'.$fname; 2448: } 2449: } 2450: if ($subdir eq 'scantron') { 2451: $fname = 'scantron_orig_'.$fname; 2452: } else { 2453: $fname="$subdir/$fname"; 2454: } 2455: if ($context eq 'coursedoc') { 2456: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2457: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2458: if ($env{'form.folder'} =~ m/^(default|supplemental)/) { 2459: return &finishuserfileupload($docuname,$docudom, 2460: $formname,$fname,$parser,$allfiles, 2461: $codebase,$thumbwidth,$thumbheight, 2462: $resizewidth,$resizeheight,$context,$mimetype); 2463: } else { 2464: $fname=$env{'form.folder'}.'/'.$fname; 2465: return &process_coursefile('uploaddoc',$docuname,$docudom, 2466: $fname,$formname,$parser, 2467: $allfiles,$codebase,$mimetype); 2468: } 2469: } elsif (defined($destuname)) { 2470: my $docuname=$destuname; 2471: my $docudom=$destudom; 2472: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2473: $parser,$allfiles,$codebase, 2474: $thumbwidth,$thumbheight, 2475: $resizewidth,$resizeheight,$context,$mimetype); 2476: } else { 2477: my $docuname=$env{'user.name'}; 2478: my $docudom=$env{'user.domain'}; 2479: if (exists($env{'form.group'})) { 2480: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'}; 2481: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 2482: } 2483: return &finishuserfileupload($docuname,$docudom,$formname,$fname, 2484: $parser,$allfiles,$codebase, 2485: $thumbwidth,$thumbheight, 2486: $resizewidth,$resizeheight,$context,$mimetype); 2487: } 2488: } 2489: 2490: sub finishuserfileupload { 2491: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase, 2492: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_; 2493: my $path=$docudom.'/'.$docuname.'/'; 2494: my $filepath=$perlvar{'lonDocRoot'}; 2495: 2496: my ($fnamepath,$file,$fetchthumb); 2497: $file=$fname; 2498: if ($fname=~m|/|) { 2499: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|); 2500: $path.=$fnamepath.'/'; 2501: } 2502: my @parts=split(/\//,$filepath.'/userfiles/'.$path); 2503: my $count; 2504: for ($count=4;$count<=$#parts;$count++) { 2505: $filepath.="/$parts[$count]"; 2506: if ((-e $filepath)!=1) { 2507: mkdir($filepath,0777); 2508: } 2509: } 2510: 2511: # Save the file 2512: { 2513: if (!open(FH,'>'.$filepath.'/'.$file)) { 2514: &logthis('Failed to create '.$filepath.'/'.$file); 2515: print STDERR ('Failed to create '.$filepath.'/'.$file."\n"); 2516: return '/adm/notfound.html'; 2517: } 2518: if ($context eq 'overwrite') { 2519: my $source = $perlvar{'lonDaemons'}.'/tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$fname; 2520: my $target = $filepath.'/'.$file; 2521: if (-e $source) { 2522: my @info = stat($source); 2523: if ($info[9] eq $env{'form.timestamp'}) { 2524: unless (&File::Copy::move($source,$target)) { 2525: &logthis('Failed to overwrite '.$filepath.'/'.$file); 2526: return "Moving from $source failed"; 2527: } 2528: } else { 2529: return "Temporary file: $source had unexpected date/time for last modification"; 2530: } 2531: } else { 2532: return "Temporary file: $source missing"; 2533: } 2534: } elsif (!print FH ($env{'form.'.$formname})) { 2535: &logthis('Failed to write to '.$filepath.'/'.$file); 2536: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n"); 2537: return '/adm/notfound.html'; 2538: } 2539: close(FH); 2540: if ($resizewidth && $resizeheight) { 2541: my $mm = new File::MMagic; 2542: my $mime_type = $mm->checktype_filename($filepath.'/'.$file); 2543: if ($mime_type =~ m{^image/}) { 2544: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight); 2545: } 2546: } 2547: } 2548: if ($parser eq 'parse') { 2549: my $mm = new File::MMagic; 2550: my $type = $mm->checktype_filename($filepath.'/'.$file); 2551: if ($type eq 'text/html') { 2552: my $parse_result = &extract_embedded_items($filepath.'/'.$file, 2553: $allfiles,$codebase); 2554: unless ($parse_result eq 'ok') { 2555: &logthis('Failed to parse '.$filepath.$file. 2556: ' for embedded media: '.$parse_result); 2557: } 2558: } 2559: if (ref($mimetype)) { 2560: $$mimetype = $type; 2561: } 2562: } 2563: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) { 2564: my $input = $filepath.'/'.$file; 2565: my $output = $filepath.'/'.'tn-'.$file; 2566: my $thumbsize = $thumbwidth.'x'.$thumbheight; 2567: system("convert -sample $thumbsize $input $output"); 2568: if (-e $filepath.'/'.'tn-'.$file) { 2569: $fetchthumb = 1; 2570: } 2571: } 2572: 2573: # Notify homeserver to grep it 2574: # 2575: my $docuhome=&homeserver($docuname,$docudom); 2576: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome); 2577: if ($fetchresult eq 'ok') { 2578: if ($fetchthumb) { 2579: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome); 2580: if ($thumbresult ne 'ok') { 2581: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '. 2582: $docuhome.': '.$thumbresult); 2583: } 2584: } 2585: # 2586: # Return the URL to it 2587: return '/uploaded/'.$path.$file; 2588: } else { 2589: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome. 2590: ': '.$fetchresult); 2591: return '/adm/notfound.html'; 2592: } 2593: } 2594: 2595: sub extract_embedded_items { 2596: my ($fullpath,$allfiles,$codebase,$content) = @_; 2597: my @state = (); 2598: my %javafiles = ( 2599: codebase => '', 2600: code => '', 2601: archive => '' 2602: ); 2603: my %mediafiles = ( 2604: src => '', 2605: movie => '', 2606: ); 2607: my $p; 2608: if ($content) { 2609: $p = HTML::LCParser->new($content); 2610: } else { 2611: $p = HTML::LCParser->new($fullpath); 2612: } 2613: while (my $t=$p->get_token()) { 2614: if ($t->[0] eq 'S') { 2615: my ($tagname, $attr) = ($t->[1],$t->[2]); 2616: push(@state, $tagname); 2617: if (lc($tagname) eq 'allow') { 2618: &add_filetype($allfiles,$attr->{'src'},'src'); 2619: } 2620: if (lc($tagname) eq 'img') { 2621: &add_filetype($allfiles,$attr->{'src'},'src'); 2622: } 2623: if (lc($tagname) eq 'a') { 2624: &add_filetype($allfiles,$attr->{'href'},'href'); 2625: } 2626: if (lc($tagname) eq 'script') { 2627: if ($attr->{'archive'} =~ /\.jar$/i) { 2628: &add_filetype($allfiles,$attr->{'archive'},'archive'); 2629: } else { 2630: &add_filetype($allfiles,$attr->{'src'},'src'); 2631: } 2632: } 2633: if (lc($tagname) eq 'link') { 2634: if (lc($attr->{'rel'}) eq 'stylesheet') { 2635: &add_filetype($allfiles,$attr->{'href'},'href'); 2636: } 2637: } 2638: if (lc($tagname) eq 'object' || 2639: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) { 2640: foreach my $item (keys(%javafiles)) { 2641: $javafiles{$item} = ''; 2642: } 2643: } 2644: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') { 2645: my $name = lc($attr->{'name'}); 2646: foreach my $item (keys(%javafiles)) { 2647: if ($name eq $item) { 2648: $javafiles{$item} = $attr->{'value'}; 2649: last; 2650: } 2651: } 2652: foreach my $item (keys(%mediafiles)) { 2653: if ($name eq $item) { 2654: &add_filetype($allfiles, $attr->{'value'}, 'value'); 2655: last; 2656: } 2657: } 2658: } 2659: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') { 2660: foreach my $item (keys(%javafiles)) { 2661: if ($attr->{$item}) { 2662: $javafiles{$item} = $attr->{$item}; 2663: last; 2664: } 2665: } 2666: foreach my $item (keys(%mediafiles)) { 2667: if ($attr->{$item}) { 2668: &add_filetype($allfiles,$attr->{$item},$item); 2669: last; 2670: } 2671: } 2672: } 2673: } elsif ($t->[0] eq 'E') { 2674: my ($tagname) = ($t->[1]); 2675: if ($javafiles{'codebase'} ne '') { 2676: $javafiles{'codebase'} .= '/'; 2677: } 2678: if (lc($tagname) eq 'applet' || 2679: lc($tagname) eq 'object' || 2680: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object') 2681: ) { 2682: foreach my $item (keys(%javafiles)) { 2683: if ($item ne 'codebase' && $javafiles{$item} ne '') { 2684: my $file=$javafiles{'codebase'}.$javafiles{$item}; 2685: &add_filetype($allfiles,$file,$item); 2686: } 2687: } 2688: } 2689: pop @state; 2690: } 2691: } 2692: return 'ok'; 2693: } 2694: 2695: sub add_filetype { 2696: my ($allfiles,$file,$type)=@_; 2697: if (exists($allfiles->{$file})) { 2698: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) { 2699: push(@{$allfiles->{$file}}, &escape($type)); 2700: } 2701: } else { 2702: @{$allfiles->{$file}} = (&escape($type)); 2703: } 2704: } 2705: 2706: sub removeuploadedurl { 2707: my ($url)=@_; 2708: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5); 2709: return &removeuserfile($uname,$udom,$fname); 2710: } 2711: 2712: sub removeuserfile { 2713: my ($docuname,$docudom,$fname)=@_; 2714: my $home=&homeserver($docuname,$docudom); 2715: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home); 2716: if ($result eq 'ok') { 2717: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) { 2718: my $metafile = $fname.'.meta'; 2719: my $metaresult = &removeuserfile($docuname,$docudom,$metafile); 2720: my $url = "/uploaded/$docudom/$docuname/$fname"; 2721: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2722: my $sqlresult = 2723: &update_portfolio_table($docuname,$docudom,$file, 2724: 'portfolio_metadata',$group, 2725: 'delete'); 2726: } 2727: } 2728: return $result; 2729: } 2730: 2731: sub mkdiruserfile { 2732: my ($docuname,$docudom,$dir)=@_; 2733: my $home=&homeserver($docuname,$docudom); 2734: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home); 2735: } 2736: 2737: sub renameuserfile { 2738: my ($docuname,$docudom,$old,$new)=@_; 2739: my $home=&homeserver($docuname,$docudom); 2740: my $result = &reply("renameuserfile:$docudom:$docuname:". 2741: &escape("$old").':'.&escape("$new"),$home); 2742: if ($result eq 'ok') { 2743: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) { 2744: my $oldmeta = $old.'.meta'; 2745: my $newmeta = $new.'.meta'; 2746: my $metaresult = 2747: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta); 2748: my $url = "/uploaded/$docudom/$docuname/$old"; 2749: my ($file,$group) = (&parse_portfolio_url($url))[3,4]; 2750: my $sqlresult = 2751: &update_portfolio_table($docuname,$docudom,$file, 2752: 'portfolio_metadata',$group, 2753: 'delete'); 2754: } 2755: } 2756: return $result; 2757: } 2758: 2759: # ------------------------------------------------------------------------- Log 2760: 2761: sub log { 2762: my ($dom,$nam,$hom,$what)=@_; 2763: return critical("log:$dom:$nam:$what",$hom); 2764: } 2765: 2766: # ------------------------------------------------------------------ Course Log 2767: # 2768: # This routine flushes several buffers of non-mission-critical nature 2769: # 2770: 2771: sub flushcourselogs { 2772: &logthis('Flushing log buffers'); 2773: # 2774: # course logs 2775: # This is a log of all transactions in a course, which can be used 2776: # for data mining purposes 2777: # 2778: # It also collects the courseid database, which lists last transaction 2779: # times and course titles for all courseids 2780: # 2781: my %courseidbuffer=(); 2782: foreach my $crsid (keys(%courselogs)) { 2783: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'. 2784: &escape($courselogs{$crsid}), 2785: $coursehombuf{$crsid}) eq 'ok') { 2786: delete $courselogs{$crsid}; 2787: } else { 2788: &logthis('Failed to flush log buffer for '.$crsid); 2789: if (length($courselogs{$crsid})>40000) { 2790: &logthis("WARNING: Buffer for ".$crsid. 2791: " exceeded maximum size, deleting."); 2792: delete $courselogs{$crsid}; 2793: } 2794: } 2795: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = { 2796: 'description' => $coursedescrbuf{$crsid}, 2797: 'inst_code' => $courseinstcodebuf{$crsid}, 2798: 'type' => $coursetypebuf{$crsid}, 2799: 'owner' => $courseownerbuf{$crsid}, 2800: }; 2801: } 2802: # 2803: # Write course id database (reverse lookup) to homeserver of courses 2804: # Is used in pickcourse 2805: # 2806: foreach my $crs_home (keys(%courseidbuffer)) { 2807: my $response = &courseidput(&host_domain($crs_home), 2808: $courseidbuffer{$crs_home}, 2809: $crs_home,'timeonly'); 2810: } 2811: # 2812: # File accesses 2813: # Writes to the dynamic metadata of resources to get hit counts, etc. 2814: # 2815: foreach my $entry (keys(%accesshash)) { 2816: if ($entry =~ /___count$/) { 2817: my ($dom,$name); 2818: ($dom,$name,undef)= 2819: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$}); 2820: if (! defined($dom) || $dom eq '' || 2821: ! defined($name) || $name eq '') { 2822: my $cid = $env{'request.course.id'}; 2823: $dom = $env{'request.'.$cid.'.domain'}; 2824: $name = $env{'request.'.$cid.'.num'}; 2825: } 2826: my $value = $accesshash{$entry}; 2827: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/); 2828: my %temphash=($url => $value); 2829: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name); 2830: if ($result eq 'ok') { 2831: delete $accesshash{$entry}; 2832: } elsif ($result eq 'unknown_cmd') { 2833: # Target server has old code running on it. 2834: my %temphash=($entry => $value); 2835: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2836: delete $accesshash{$entry}; 2837: } 2838: } 2839: } else { 2840: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$}); 2841: my %temphash=($entry => $accesshash{$entry}); 2842: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') { 2843: delete $accesshash{$entry}; 2844: } 2845: } 2846: } 2847: # 2848: # Roles 2849: # Reverse lookup of user roles for course faculty/staff and co-authorship 2850: # 2851: foreach my $entry (keys(%userrolehash)) { 2852: my ($role,$uname,$udom,$runame,$rudom,$rsec)= 2853: split(/\:/,$entry); 2854: if (&Apache::lonnet::put('nohist_userroles', 2855: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} }, 2856: $rudom,$runame) eq 'ok') { 2857: delete $userrolehash{$entry}; 2858: } 2859: } 2860: # 2861: # Reverse lookup of domain roles (dc, ad, li, sc, au) 2862: # 2863: my %domrolebuffer = (); 2864: foreach my $entry (keys(%domainrolehash)) { 2865: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry); 2866: if ($domrolebuffer{$rudom}) { 2867: $domrolebuffer{$rudom}.='&'.&escape($entry). 2868: '='.&escape($domainrolehash{$entry}); 2869: } else { 2870: $domrolebuffer{$rudom}.=&escape($entry). 2871: '='.&escape($domainrolehash{$entry}); 2872: } 2873: delete $domainrolehash{$entry}; 2874: } 2875: foreach my $dom (keys(%domrolebuffer)) { 2876: my %servers = &get_servers($dom,'library'); 2877: foreach my $tryserver (keys(%servers)) { 2878: unless (&reply('domroleput:'.$dom.':'. 2879: $domrolebuffer{$dom},$tryserver) eq 'ok') { 2880: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver); 2881: } 2882: } 2883: } 2884: $dumpcount++; 2885: } 2886: 2887: sub courselog { 2888: my $what=shift; 2889: $what=time.':'.$what; 2890: unless ($env{'request.course.id'}) { return ''; } 2891: $coursedombuf{$env{'request.course.id'}}= 2892: $env{'course.'.$env{'request.course.id'}.'.domain'}; 2893: $coursenumbuf{$env{'request.course.id'}}= 2894: $env{'course.'.$env{'request.course.id'}.'.num'}; 2895: $coursehombuf{$env{'request.course.id'}}= 2896: $env{'course.'.$env{'request.course.id'}.'.home'}; 2897: $coursedescrbuf{$env{'request.course.id'}}= 2898: $env{'course.'.$env{'request.course.id'}.'.description'}; 2899: $courseinstcodebuf{$env{'request.course.id'}}= 2900: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}; 2901: $courseownerbuf{$env{'request.course.id'}}= 2902: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'}; 2903: $coursetypebuf{$env{'request.course.id'}}= 2904: $env{'course.'.$env{'request.course.id'}.'.type'}; 2905: if (defined $courselogs{$env{'request.course.id'}}) { 2906: $courselogs{$env{'request.course.id'}}.='&'.$what; 2907: } else { 2908: $courselogs{$env{'request.course.id'}}.=$what; 2909: } 2910: if (length($courselogs{$env{'request.course.id'}})>4048) { 2911: &flushcourselogs(); 2912: } 2913: } 2914: 2915: sub courseacclog { 2916: my $fnsymb=shift; 2917: unless ($env{'request.course.id'}) { return ''; } 2918: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'}; 2919: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) { 2920: $what.=':POST'; 2921: # FIXME: Probably ought to escape things.... 2922: foreach my $key (keys(%env)) { 2923: if ($key=~/^form\.(.*)/) { 2924: my $formitem = $1; 2925: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) { 2926: $what.=':'.$formitem.'='.$env{$key}; 2927: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) { 2928: $what.=':'.$formitem.'='.$env{$key}; 2929: } 2930: } 2931: } 2932: } elsif ($fnsymb =~ m:^/adm/searchcat:) { 2933: # FIXME: We should not be depending on a form parameter that someone 2934: # editing lonsearchcat.pm might change in the future. 2935: if ($env{'form.phase'} eq 'course_search') { 2936: $what.= ':POST'; 2937: # FIXME: Probably ought to escape things.... 2938: foreach my $element ('courseexp','crsfulltext','crsrelated', 2939: 'crsdiscuss') { 2940: $what.=':'.$element.'='.$env{'form.'.$element}; 2941: } 2942: } 2943: } 2944: &courselog($what); 2945: } 2946: 2947: sub countacc { 2948: my $url=&declutter(shift); 2949: return if (! defined($url) || $url eq ''); 2950: unless ($env{'request.course.id'}) { return ''; } 2951: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1; 2952: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count'; 2953: $accesshash{$key}++; 2954: } 2955: 2956: sub linklog { 2957: my ($from,$to)=@_; 2958: $from=&declutter($from); 2959: $to=&declutter($to); 2960: $accesshash{$from.'___'.$to.'___comefrom'}=1; 2961: $accesshash{$to.'___'.$from.'___goto'}=1; 2962: } 2963: 2964: sub userrolelog { 2965: my ($trole,$username,$domain,$area,$tstart,$tend)=@_; 2966: if (($trole=~/^ca/) || ($trole=~/^aa/) || 2967: ($trole=~/^in/) || ($trole=~/^cc/) || 2968: ($trole=~/^ep/) || ($trole=~/^cr/) || 2969: ($trole=~/^ta/) || ($trole=~/^co/)) { 2970: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 2971: $userrolehash 2972: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 2973: =$tend.':'.$tstart; 2974: } 2975: if (($env{'request.role'} =~ /dc\./) && 2976: (($trole=~/^au/) || ($trole=~/^in/) || 2977: ($trole=~/^cc/) || ($trole=~/^ep/) || 2978: ($trole=~/^cr/) || ($trole=~/^ta/) || 2979: ($trole=~/^co/))) { 2980: $userrolehash 2981: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'} 2982: =$tend.':'.$tstart; 2983: } 2984: if (($trole=~/^dc/) || ($trole=~/^ad/) || 2985: ($trole=~/^li/) || ($trole=~/^li/) || 2986: ($trole=~/^au/) || ($trole=~/^dg/) || 2987: ($trole=~/^sc/)) { 2988: my (undef,$rudom,$runame,$rsec)=split(/\//,$area); 2989: $domainrolehash 2990: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec} 2991: = $tend.':'.$tstart; 2992: } 2993: } 2994: 2995: sub courserolelog { 2996: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_; 2997: if (($trole eq 'cc') || ($trole eq 'in') || 2998: ($trole eq 'ep') || ($trole eq 'ad') || 2999: ($trole eq 'ta') || ($trole eq 'st') || 3000: ($trole=~/^cr/) || ($trole eq 'gr') || 3001: ($trole eq 'co')) { 3002: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) { 3003: my $cdom = $1; 3004: my $cnum = $2; 3005: my $sec = $3; 3006: my $namespace = 'rolelog'; 3007: my %storehash = ( 3008: role => $trole, 3009: start => $tstart, 3010: end => $tend, 3011: selfenroll => $selfenroll, 3012: context => $context, 3013: ); 3014: if ($trole eq 'gr') { 3015: $namespace = 'groupslog'; 3016: $storehash{'group'} = $sec; 3017: } else { 3018: $storehash{'section'} = $sec; 3019: } 3020: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom); 3021: if (($trole ne 'st') || ($sec ne '')) { 3022: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum); 3023: } 3024: } 3025: } 3026: return; 3027: } 3028: 3029: sub get_course_adv_roles { 3030: my ($cid,$codes) = @_; 3031: $cid=$env{'request.course.id'} unless (defined($cid)); 3032: my %coursehash=&coursedescription($cid); 3033: my $crstype = &Apache::loncommon::course_type($cid); 3034: my %nothide=(); 3035: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 3036: if ($user !~ /:/) { 3037: $nothide{join(':',split(/[\@]/,$user))}=1; 3038: } else { 3039: $nothide{$user}=1; 3040: } 3041: } 3042: my %returnhash=(); 3043: my %dumphash= 3044: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'}); 3045: my $now=time; 3046: my %privileged; 3047: foreach my $entry (keys(%dumphash)) { 3048: my ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 3049: if (($tstart) && ($tstart<0)) { next; } 3050: if (($tend) && ($tend<$now)) { next; } 3051: if (($tstart) && ($now<$tstart)) { next; } 3052: my ($role,$username,$domain,$section)=split(/\:/,$entry); 3053: if ($username eq '' || $domain eq '') { next; } 3054: unless (ref($privileged{$domain}) eq 'HASH') { 3055: my %dompersonnel = 3056: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 3057: $privileged{$domain} = {}; 3058: foreach my $server (keys(%dompersonnel)) { 3059: if (ref($dompersonnel{$server}) eq 'HASH') { 3060: foreach my $user (keys(%{$dompersonnel{$server}})) { 3061: my ($trole,$uname,$udom) = split(/:/,$user); 3062: $privileged{$udom}{$uname} = 1; 3063: } 3064: } 3065: } 3066: } 3067: if ((exists($privileged{$domain}{$username})) && 3068: (!$nothide{$username.':'.$domain})) { next; } 3069: if ($role eq 'cr') { next; } 3070: if ($codes) { 3071: if ($section) { $role .= ':'.$section; } 3072: if ($returnhash{$role}) { 3073: $returnhash{$role}.=','.$username.':'.$domain; 3074: } else { 3075: $returnhash{$role}=$username.':'.$domain; 3076: } 3077: } else { 3078: my $key=&plaintext($role,$crstype); 3079: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; } 3080: if ($returnhash{$key}) { 3081: $returnhash{$key}.=','.$username.':'.$domain; 3082: } else { 3083: $returnhash{$key}=$username.':'.$domain; 3084: } 3085: } 3086: } 3087: return %returnhash; 3088: } 3089: 3090: sub get_my_roles { 3091: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_; 3092: unless (defined($uname)) { $uname=$env{'user.name'}; } 3093: unless (defined($udom)) { $udom=$env{'user.domain'}; } 3094: my (%dumphash,%nothide); 3095: if ($context eq 'userroles') { 3096: my $extra = &freeze_escape({'skipcheck' => 1}); 3097: %dumphash = &dump('roles',$udom,$uname,'.',undef,$extra); 3098: } else { 3099: %dumphash= 3100: &dump('nohist_userroles',$udom,$uname); 3101: if ($hidepriv) { 3102: my %coursehash=&coursedescription($udom.'_'.$uname); 3103: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 3104: if ($user !~ /:/) { 3105: $nothide{join(':',split(/[\@]/,$user))} = 1; 3106: } else { 3107: $nothide{$user} = 1; 3108: } 3109: } 3110: } 3111: } 3112: my %returnhash=(); 3113: my $now=time; 3114: my %privileged; 3115: foreach my $entry (keys(%dumphash)) { 3116: my ($role,$tend,$tstart); 3117: if ($context eq 'userroles') { 3118: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry}); 3119: } else { 3120: ($tend,$tstart)=split(/\:/,$dumphash{$entry}); 3121: } 3122: if (($tstart) && ($tstart<0)) { next; } 3123: my $status = 'active'; 3124: if (($tend) && ($tend<=$now)) { 3125: $status = 'previous'; 3126: } 3127: if (($tstart) && ($now<$tstart)) { 3128: $status = 'future'; 3129: } 3130: if (ref($types) eq 'ARRAY') { 3131: if (!grep(/^\Q$status\E$/,@{$types})) { 3132: next; 3133: } 3134: } else { 3135: if ($status ne 'active') { 3136: next; 3137: } 3138: } 3139: my ($rolecode,$username,$domain,$section,$area); 3140: if ($context eq 'userroles') { 3141: ($area,$rolecode) = split(/_/,$entry); 3142: (undef,$domain,$username,$section) = split(/\//,$area); 3143: } else { 3144: ($role,$username,$domain,$section) = split(/\:/,$entry); 3145: } 3146: if (ref($roledoms) eq 'ARRAY') { 3147: if (!grep(/^\Q$domain\E$/,@{$roledoms})) { 3148: next; 3149: } 3150: } 3151: if (ref($roles) eq 'ARRAY') { 3152: if (!grep(/^\Q$role\E$/,@{$roles})) { 3153: if ($role =~ /^cr\//) { 3154: if (!grep(/^cr$/,@{$roles})) { 3155: next; 3156: } 3157: } else { 3158: next; 3159: } 3160: } 3161: } 3162: if ($hidepriv) { 3163: if ($context eq 'userroles') { 3164: if ((&privileged($username,$domain)) && 3165: (!$nothide{$username.':'.$domain})) { 3166: next; 3167: } 3168: } else { 3169: unless (ref($privileged{$domain}) eq 'HASH') { 3170: my %dompersonnel = 3171: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now); 3172: $privileged{$domain} = {}; 3173: if (keys(%dompersonnel)) { 3174: foreach my $server (keys(%dompersonnel)) { 3175: if (ref($dompersonnel{$server}) eq 'HASH') { 3176: foreach my $user (keys(%{$dompersonnel{$server}})) { 3177: my ($trole,$uname,$udom) = split(/:/,$user); 3178: $privileged{$udom}{$uname} = $trole; 3179: } 3180: } 3181: } 3182: } 3183: } 3184: if (exists($privileged{$domain}{$username})) { 3185: if (!$nothide{$username.':'.$domain}) { 3186: next; 3187: } 3188: } 3189: } 3190: } 3191: if ($withsec) { 3192: $returnhash{$username.':'.$domain.':'.$role.':'.$section} = 3193: $tstart.':'.$tend; 3194: } else { 3195: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend; 3196: } 3197: } 3198: return %returnhash; 3199: } 3200: 3201: # ----------------------------------------------------- Frontpage Announcements 3202: # 3203: # 3204: 3205: sub postannounce { 3206: my ($server,$text)=@_; 3207: unless (&allowed('psa',&host_domain($server))) { return 'refused'; } 3208: unless ($text=~/\w/) { $text=''; } 3209: return &reply('setannounce:'.&escape($text),$server); 3210: } 3211: 3212: sub getannounce { 3213: 3214: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) { 3215: my $announcement=''; 3216: while (my $line = <$fh>) { $announcement .= $line; } 3217: close($fh); 3218: if ($announcement=~/\w/) { 3219: return 3220: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'. 3221: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>'; 3222: } else { 3223: return ''; 3224: } 3225: } else { 3226: return ''; 3227: } 3228: } 3229: 3230: # ---------------------------------------------------------- Course ID routines 3231: # Deal with domain's nohist_courseid.db files 3232: # 3233: 3234: sub courseidput { 3235: my ($domain,$storehash,$coursehome,$caller) = @_; 3236: return unless (ref($storehash) eq 'HASH'); 3237: my $outcome; 3238: if ($caller eq 'timeonly') { 3239: my $cids = ''; 3240: foreach my $item (keys(%$storehash)) { 3241: $cids.=&escape($item).'&'; 3242: } 3243: $cids=~s/\&$//; 3244: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids, 3245: $coursehome); 3246: } else { 3247: my $items = ''; 3248: foreach my $item (keys(%$storehash)) { 3249: $items.= &escape($item).'='. 3250: &freeze_escape($$storehash{$item}).'&'; 3251: } 3252: $items=~s/\&$//; 3253: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items, 3254: $coursehome); 3255: } 3256: if ($outcome eq 'unknown_cmd') { 3257: my $what; 3258: foreach my $cid (keys(%$storehash)) { 3259: $what .= &escape($cid).'='; 3260: foreach my $item ('description','inst_code','owner','type') { 3261: $what .= &escape($storehash->{$cid}{$item}).':'; 3262: } 3263: $what =~ s/\:$/&/; 3264: } 3265: $what =~ s/\&$//; 3266: return &reply('courseidput:'.$domain.':'.$what,$coursehome); 3267: } else { 3268: return $outcome; 3269: } 3270: } 3271: 3272: sub courseiddump { 3273: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter, 3274: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok, 3275: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone, 3276: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_; 3277: my $as_hash = 1; 3278: my %returnhash; 3279: if (!$domfilter) { $domfilter=''; } 3280: my %libserv = &all_library(); 3281: foreach my $tryserver (keys(%libserv)) { 3282: if ( ( $hostidflag == 1 3283: && grep(/^\Q$tryserver\E$/,@{$hostidref}) ) 3284: || (!defined($hostidflag)) ) { 3285: 3286: if (($domfilter eq '') || 3287: (&host_domain($tryserver) eq $domfilter)) { 3288: my $rep = 3289: &reply('courseiddump:'.&host_domain($tryserver).':'. 3290: $sincefilter.':'.&escape($descfilter).':'. 3291: &escape($instcodefilter).':'.&escape($ownerfilter). 3292: ':'.&escape($coursefilter).':'.&escape($typefilter). 3293: ':'.&escape($regexp_ok).':'.$as_hash.':'. 3294: &escape($selfenrollonly).':'.&escape($catfilter).':'. 3295: $showhidden.':'.$caller.':'.&escape($cloner).':'. 3296: &escape($cc_clone).':'.$cloneonly.':'. 3297: &escape($createdbefore).':'.&escape($createdafter).':'. 3298: &escape($creationcontext).':'.$domcloner, 3299: $tryserver); 3300: my @pairs=split(/\&/,$rep); 3301: foreach my $item (@pairs) { 3302: my ($key,$value)=split(/\=/,$item,2); 3303: $key = &unescape($key); 3304: next if ($key =~ /^error: 2 /); 3305: my $result = &thaw_unescape($value); 3306: if (ref($result) eq 'HASH') { 3307: $returnhash{$key}=$result; 3308: } else { 3309: my @responses = split(/:/,$value); 3310: my @items = ('description','inst_code','owner','type'); 3311: for (my $i=0; $i<@responses; $i++) { 3312: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]); 3313: } 3314: } 3315: } 3316: } 3317: } 3318: } 3319: return %returnhash; 3320: } 3321: 3322: sub courselastaccess { 3323: my ($cdom,$cnum,$hostidref) = @_; 3324: my %returnhash; 3325: if ($cdom && $cnum) { 3326: my $chome = &homeserver($cnum,$cdom); 3327: if ($chome ne 'no_host') { 3328: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome); 3329: &extract_lastaccess(\%returnhash,$rep); 3330: } 3331: } else { 3332: if (!$cdom) { $cdom=''; } 3333: my %libserv = &all_library(); 3334: foreach my $tryserver (keys(%libserv)) { 3335: if (ref($hostidref) eq 'ARRAY') { 3336: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref})); 3337: } 3338: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) { 3339: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver); 3340: &extract_lastaccess(\%returnhash,$rep); 3341: } 3342: } 3343: } 3344: return %returnhash; 3345: } 3346: 3347: sub extract_lastaccess { 3348: my ($returnhash,$rep) = @_; 3349: if (ref($returnhash) eq 'HASH') { 3350: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' || 3351: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' || 3352: $rep eq '') { 3353: my @pairs=split(/\&/,$rep); 3354: foreach my $item (@pairs) { 3355: my ($key,$value)=split(/\=/,$item,2); 3356: $key = &unescape($key); 3357: next if ($key =~ /^error: 2 /); 3358: $returnhash->{$key} = &thaw_unescape($value); 3359: } 3360: } 3361: } 3362: return; 3363: } 3364: 3365: # ---------------------------------------------------------- DC e-mail 3366: 3367: sub dcmailput { 3368: my ($domain,$msgid,$message,$server)=@_; 3369: my $status = &Apache::lonnet::critical( 3370: 'dcmailput:'.$domain.':'.&escape($msgid).'='. 3371: &escape($message),$server); 3372: return $status; 3373: } 3374: 3375: sub dcmaildump { 3376: my ($dom,$startdate,$enddate,$senders) = @_; 3377: my %returnhash=(); 3378: 3379: if (defined(&domain($dom,'primary'))) { 3380: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'. 3381: &escape($enddate).':'; 3382: my @esc_senders=map { &escape($_)} @$senders; 3383: $cmd.=&escape(join('&',@esc_senders)); 3384: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) { 3385: my ($key,$value) = split(/\=/,$line,2); 3386: if (($key) && ($value)) { 3387: $returnhash{&unescape($key)} = &unescape($value); 3388: } 3389: } 3390: } 3391: return %returnhash; 3392: } 3393: # ---------------------------------------------------------- Domain roles 3394: 3395: sub get_domain_roles { 3396: my ($dom,$roles,$startdate,$enddate)=@_; 3397: if ((!defined($startdate)) || ($startdate eq '')) { 3398: $startdate = '.'; 3399: } 3400: if ((!defined($enddate)) || ($enddate eq '')) { 3401: $enddate = '.'; 3402: } 3403: my $rolelist; 3404: if (ref($roles) eq 'ARRAY') { 3405: $rolelist = join(':',@{$roles}); 3406: } 3407: my %personnel = (); 3408: 3409: my %servers = &get_servers($dom,'library'); 3410: foreach my $tryserver (keys(%servers)) { 3411: %{$personnel{$tryserver}}=(); 3412: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'. 3413: &escape($startdate).':'. 3414: &escape($enddate).':'. 3415: &escape($rolelist), $tryserver))) { 3416: my ($key,$value) = split(/\=/,$line,2); 3417: if (($key) && ($value)) { 3418: $personnel{$tryserver}{&unescape($key)} = &unescape($value); 3419: } 3420: } 3421: } 3422: return %personnel; 3423: } 3424: 3425: # ----------------------------------------------------------- Interval timing 3426: 3427: sub get_first_access { 3428: my ($type,$argsymb)=@_; 3429: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3430: if ($argsymb) { $symb=$argsymb; } 3431: my ($map,$id,$res)=&decode_symb($symb); 3432: if ($type eq 'course') { 3433: $res='course'; 3434: } elsif ($type eq 'map') { 3435: $res=&symbread($map); 3436: } else { 3437: $res=$symb; 3438: } 3439: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname); 3440: return $times{"$courseid\0$res"}; 3441: } 3442: 3443: sub set_first_access { 3444: my ($type)=@_; 3445: my ($symb,$courseid,$udom,$uname)=&whichuser(); 3446: my ($map,$id,$res)=&decode_symb($symb); 3447: if ($type eq 'course') { 3448: $res='course'; 3449: } elsif ($type eq 'map') { 3450: $res=&symbread($map); 3451: } else { 3452: $res=$symb; 3453: } 3454: my $firstaccess=&get_first_access($type,$symb); 3455: if (!$firstaccess) { 3456: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname); 3457: } 3458: return 'already_set'; 3459: } 3460: 3461: # --------------------------------------------- Set Expire Date for Spreadsheet 3462: 3463: sub expirespread { 3464: my ($uname,$udom,$stype,$usymb)=@_; 3465: my $cid=$env{'request.course.id'}; 3466: if ($cid) { 3467: my $now=time; 3468: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb; 3469: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'. 3470: $env{'course.'.$cid.'.num'}. 3471: ':nohist_expirationdates:'. 3472: &escape($key).'='.$now, 3473: $env{'course.'.$cid.'.home'}) 3474: } 3475: return 'ok'; 3476: } 3477: 3478: # ----------------------------------------------------- Devalidate Spreadsheets 3479: 3480: sub devalidate { 3481: my ($symb,$uname,$udom)=@_; 3482: my $cid=$env{'request.course.id'}; 3483: if ($cid) { 3484: # delete the stored spreadsheets for 3485: # - the student level sheet of this user in course's homespace 3486: # - the assessment level sheet for this resource 3487: # for this user in user's homespace 3488: # - current conditional state info 3489: my $key=$uname.':'.$udom.':'; 3490: my $status= 3491: &del('nohist_calculatedsheets', 3492: [$key.'studentcalc:'], 3493: $env{'course.'.$cid.'.domain'}, 3494: $env{'course.'.$cid.'.num'}) 3495: .' '. 3496: &del('nohist_calculatedsheets_'.$cid, 3497: [$key.'assesscalc:'.$symb],$udom,$uname); 3498: unless ($status eq 'ok ok') { 3499: &logthis('Could not devalidate spreadsheet '. 3500: $uname.' at '.$udom.' for '. 3501: $symb.': '.$status); 3502: } 3503: &delenv('user.state.'.$cid); 3504: } 3505: } 3506: 3507: sub get_scalar { 3508: my ($string,$end) = @_; 3509: my $value; 3510: if ($$string =~ s/^([^&]*?)($end)/$2/) { 3511: $value = $1; 3512: } elsif ($$string =~ s/^([^&]*?)&//) { 3513: $value = $1; 3514: } 3515: return &unescape($value); 3516: } 3517: 3518: sub array2str { 3519: my (@array) = @_; 3520: my $result=&arrayref2str(\@array); 3521: $result=~s/^__ARRAY_REF__//; 3522: $result=~s/__END_ARRAY_REF__$//; 3523: return $result; 3524: } 3525: 3526: sub arrayref2str { 3527: my ($arrayref) = @_; 3528: my $result='__ARRAY_REF__'; 3529: foreach my $elem (@$arrayref) { 3530: if(ref($elem) eq 'ARRAY') { 3531: $result.=&arrayref2str($elem).'&'; 3532: } elsif(ref($elem) eq 'HASH') { 3533: $result.=&hashref2str($elem).'&'; 3534: } elsif(ref($elem)) { 3535: #print("Got a ref of ".(ref($elem))." skipping."); 3536: } else { 3537: $result.=&escape($elem).'&'; 3538: } 3539: } 3540: $result=~s/\&$//; 3541: $result .= '__END_ARRAY_REF__'; 3542: return $result; 3543: } 3544: 3545: sub hash2str { 3546: my (%hash) = @_; 3547: my $result=&hashref2str(\%hash); 3548: $result=~s/^__HASH_REF__//; 3549: $result=~s/__END_HASH_REF__$//; 3550: return $result; 3551: } 3552: 3553: sub hashref2str { 3554: my ($hashref)=@_; 3555: my $result='__HASH_REF__'; 3556: foreach my $key (sort(keys(%$hashref))) { 3557: if (ref($key) eq 'ARRAY') { 3558: $result.=&arrayref2str($key).'='; 3559: } elsif (ref($key) eq 'HASH') { 3560: $result.=&hashref2str($key).'='; 3561: } elsif (ref($key)) { 3562: $result.='='; 3563: #print("Got a ref of ".(ref($key))." skipping."); 3564: } else { 3565: if ($key) {$result.=&escape($key).'=';} else { last; } 3566: } 3567: 3568: if(ref($hashref->{$key}) eq 'ARRAY') { 3569: $result.=&arrayref2str($hashref->{$key}).'&'; 3570: } elsif(ref($hashref->{$key}) eq 'HASH') { 3571: $result.=&hashref2str($hashref->{$key}).'&'; 3572: } elsif(ref($hashref->{$key})) { 3573: $result.='&'; 3574: #print("Got a ref of ".(ref($hashref->{$key}))." skipping."); 3575: } else { 3576: $result.=&escape($hashref->{$key}).'&'; 3577: } 3578: } 3579: $result=~s/\&$//; 3580: $result .= '__END_HASH_REF__'; 3581: return $result; 3582: } 3583: 3584: sub str2hash { 3585: my ($string)=@_; 3586: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__'); 3587: return %$hash; 3588: } 3589: 3590: sub str2hashref { 3591: my ($string) = @_; 3592: 3593: my %hash; 3594: 3595: if($string !~ /^__HASH_REF__/) { 3596: if (! ($string eq '' || !defined($string))) { 3597: $hash{'error'}='Not hash reference'; 3598: } 3599: return (\%hash, $string); 3600: } 3601: 3602: $string =~ s/^__HASH_REF__//; 3603: 3604: while($string !~ /^__END_HASH_REF__/) { 3605: #key 3606: my $key=''; 3607: if($string =~ /^__HASH_REF__/) { 3608: ($key, $string)=&str2hashref($string); 3609: if(defined($key->{'error'})) { 3610: $hash{'error'}='Bad data'; 3611: return (\%hash, $string); 3612: } 3613: } elsif($string =~ /^__ARRAY_REF__/) { 3614: ($key, $string)=&str2arrayref($string); 3615: if($key->[0] eq 'Array reference error') { 3616: $hash{'error'}='Bad data'; 3617: return (\%hash, $string); 3618: } 3619: } else { 3620: $string =~ s/^(.*?)=//; 3621: $key=&unescape($1); 3622: } 3623: $string =~ s/^=//; 3624: 3625: #value 3626: my $value=''; 3627: if($string =~ /^__HASH_REF__/) { 3628: ($value, $string)=&str2hashref($string); 3629: if(defined($value->{'error'})) { 3630: $hash{'error'}='Bad data'; 3631: return (\%hash, $string); 3632: } 3633: } elsif($string =~ /^__ARRAY_REF__/) { 3634: ($value, $string)=&str2arrayref($string); 3635: if($value->[0] eq 'Array reference error') { 3636: $hash{'error'}='Bad data'; 3637: return (\%hash, $string); 3638: } 3639: } else { 3640: $value=&get_scalar(\$string,'__END_HASH_REF__'); 3641: } 3642: $string =~ s/^&//; 3643: 3644: $hash{$key}=$value; 3645: } 3646: 3647: $string =~ s/^__END_HASH_REF__//; 3648: 3649: return (\%hash, $string); 3650: } 3651: 3652: sub str2array { 3653: my ($string)=@_; 3654: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__'); 3655: return @$array; 3656: } 3657: 3658: sub str2arrayref { 3659: my ($string) = @_; 3660: my @array; 3661: 3662: if($string !~ /^__ARRAY_REF__/) { 3663: if (! ($string eq '' || !defined($string))) { 3664: $array[0]='Array reference error'; 3665: } 3666: return (\@array, $string); 3667: } 3668: 3669: $string =~ s/^__ARRAY_REF__//; 3670: 3671: while($string !~ /^__END_ARRAY_REF__/) { 3672: my $value=''; 3673: if($string =~ /^__HASH_REF__/) { 3674: ($value, $string)=&str2hashref($string); 3675: if(defined($value->{'error'})) { 3676: $array[0] ='Array reference error'; 3677: return (\@array, $string); 3678: } 3679: } elsif($string =~ /^__ARRAY_REF__/) { 3680: ($value, $string)=&str2arrayref($string); 3681: if($value->[0] eq 'Array reference error') { 3682: $array[0] ='Array reference error'; 3683: return (\@array, $string); 3684: } 3685: } else { 3686: $value=&get_scalar(\$string,'__END_ARRAY_REF__'); 3687: } 3688: $string =~ s/^&//; 3689: 3690: push(@array, $value); 3691: } 3692: 3693: $string =~ s/^__END_ARRAY_REF__//; 3694: 3695: return (\@array, $string); 3696: } 3697: 3698: # -------------------------------------------------------------------Temp Store 3699: 3700: sub tmpreset { 3701: my ($symb,$namespace,$domain,$stuname) = @_; 3702: if (!$symb) { 3703: $symb=&symbread(); 3704: if (!$symb) { $symb= $env{'request.url'}; } 3705: } 3706: $symb=escape($symb); 3707: 3708: if (!$namespace) { $namespace=$env{'request.state'}; } 3709: $namespace=~s/\//\_/g; 3710: $namespace=~s/\W//g; 3711: 3712: if (!$domain) { $domain=$env{'user.domain'}; } 3713: if (!$stuname) { $stuname=$env{'user.name'}; } 3714: if ($domain eq 'public' && $stuname eq 'public') { 3715: $stuname=$ENV{'REMOTE_ADDR'}; 3716: } 3717: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3718: my %hash; 3719: if (tie(%hash,'GDBM_File', 3720: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3721: &GDBM_WRCREAT(),0640)) { 3722: foreach my $key (keys(%hash)) { 3723: if ($key=~ /:$symb/) { 3724: delete($hash{$key}); 3725: } 3726: } 3727: } 3728: } 3729: 3730: sub tmpstore { 3731: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3732: 3733: if (!$symb) { 3734: $symb=&symbread(); 3735: if (!$symb) { $symb= $env{'request.url'}; } 3736: } 3737: $symb=escape($symb); 3738: 3739: if (!$namespace) { 3740: # I don't think we would ever want to store this for a course. 3741: # it seems this will only be used if we don't have a course. 3742: #$namespace=$env{'request.course.id'}; 3743: #if (!$namespace) { 3744: $namespace=$env{'request.state'}; 3745: #} 3746: } 3747: $namespace=~s/\//\_/g; 3748: $namespace=~s/\W//g; 3749: if (!$domain) { $domain=$env{'user.domain'}; } 3750: if (!$stuname) { $stuname=$env{'user.name'}; } 3751: if ($domain eq 'public' && $stuname eq 'public') { 3752: $stuname=$ENV{'REMOTE_ADDR'}; 3753: } 3754: my $now=time; 3755: my %hash; 3756: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3757: if (tie(%hash,'GDBM_File', 3758: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3759: &GDBM_WRCREAT(),0640)) { 3760: $hash{"version:$symb"}++; 3761: my $version=$hash{"version:$symb"}; 3762: my $allkeys=''; 3763: foreach my $key (keys(%$storehash)) { 3764: $allkeys.=$key.':'; 3765: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key}); 3766: } 3767: $hash{"$version:$symb:timestamp"}=$now; 3768: $allkeys.='timestamp'; 3769: $hash{"$version:keys:$symb"}=$allkeys; 3770: if (untie(%hash)) { 3771: return 'ok'; 3772: } else { 3773: return "error:$!"; 3774: } 3775: } else { 3776: return "error:$!"; 3777: } 3778: } 3779: 3780: # -----------------------------------------------------------------Temp Restore 3781: 3782: sub tmprestore { 3783: my ($symb,$namespace,$domain,$stuname) = @_; 3784: 3785: if (!$symb) { 3786: $symb=&symbread(); 3787: if (!$symb) { $symb= $env{'request.url'}; } 3788: } 3789: $symb=escape($symb); 3790: 3791: if (!$namespace) { $namespace=$env{'request.state'}; } 3792: 3793: if (!$domain) { $domain=$env{'user.domain'}; } 3794: if (!$stuname) { $stuname=$env{'user.name'}; } 3795: if ($domain eq 'public' && $stuname eq 'public') { 3796: $stuname=$ENV{'REMOTE_ADDR'}; 3797: } 3798: my %returnhash; 3799: $namespace=~s/\//\_/g; 3800: $namespace=~s/\W//g; 3801: my %hash; 3802: my $path=$perlvar{'lonDaemons'}.'/tmp'; 3803: if (tie(%hash,'GDBM_File', 3804: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db', 3805: &GDBM_READER(),0640)) { 3806: my $version=$hash{"version:$symb"}; 3807: $returnhash{'version'}=$version; 3808: my $scope; 3809: for ($scope=1;$scope<=$version;$scope++) { 3810: my $vkeys=$hash{"$scope:keys:$symb"}; 3811: my @keys=split(/:/,$vkeys); 3812: my $key; 3813: $returnhash{"$scope:keys"}=$vkeys; 3814: foreach $key (@keys) { 3815: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3816: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"}); 3817: } 3818: } 3819: if (!(untie(%hash))) { 3820: return "error:$!"; 3821: } 3822: } else { 3823: return "error:$!"; 3824: } 3825: return %returnhash; 3826: } 3827: 3828: # ----------------------------------------------------------------------- Store 3829: 3830: sub store { 3831: my ($storehash,$symb,$namespace,$domain,$stuname) = @_; 3832: my $home=''; 3833: 3834: if ($stuname) { $home=&homeserver($stuname,$domain); } 3835: 3836: $symb=&symbclean($symb); 3837: if (!$symb) { unless ($symb=&symbread()) { return ''; } } 3838: 3839: if (!$domain) { $domain=$env{'user.domain'}; } 3840: if (!$stuname) { $stuname=$env{'user.name'}; } 3841: 3842: &devalidate($symb,$stuname,$domain); 3843: 3844: $symb=escape($symb); 3845: if (!$namespace) { 3846: unless ($namespace=$env{'request.course.id'}) { 3847: return ''; 3848: } 3849: } 3850: if (!$home) { $home=$env{'user.home'}; } 3851: 3852: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'}; 3853: $$storehash{'host'}=$perlvar{'lonHostID'}; 3854: 3855: my $namevalue=''; 3856: foreach my $key (keys(%$storehash)) { 3857: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 3858: } 3859: $namevalue=~s/\&$//; 3860: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue); 3861: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3862: } 3863: 3864: # -------------------------------------------------------------- Critical Store 3865: 3866: sub cstore { 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.':CSTORE:'.$namevalue); 3897: return critical 3898: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home"); 3899: } 3900: 3901: # --------------------------------------------------------------------- Restore 3902: 3903: sub restore { 3904: my ($symb,$namespace,$domain,$stuname) = @_; 3905: my $home=''; 3906: 3907: if ($stuname) { $home=&homeserver($stuname,$domain); } 3908: 3909: if (!$symb) { 3910: unless ($symb=escape(&symbread())) { return ''; } 3911: } else { 3912: $symb=&escape(&symbclean($symb)); 3913: } 3914: if (!$namespace) { 3915: unless ($namespace=$env{'request.course.id'}) { 3916: return ''; 3917: } 3918: } 3919: if (!$domain) { $domain=$env{'user.domain'}; } 3920: if (!$stuname) { $stuname=$env{'user.name'}; } 3921: if (!$home) { $home=$env{'user.home'}; } 3922: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home"); 3923: 3924: my %returnhash=(); 3925: foreach my $line (split(/\&/,$answer)) { 3926: my ($name,$value)=split(/\=/,$line); 3927: $returnhash{&unescape($name)}=&thaw_unescape($value); 3928: } 3929: my $version; 3930: for ($version=1;$version<=$returnhash{'version'};$version++) { 3931: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) { 3932: $returnhash{$item}=$returnhash{$version.':'.$item}; 3933: } 3934: } 3935: return %returnhash; 3936: } 3937: 3938: # ---------------------------------------------------------- Course Description 3939: 3940: sub coursedescription { 3941: my ($courseid,$args)=@_; 3942: $courseid=~s/^\///; 3943: $courseid=~s/\_/\//g; 3944: my ($cdomain,$cnum)=split(/\//,$courseid); 3945: my $chome=&homeserver($cnum,$cdomain); 3946: my $normalid=$cdomain.'_'.$cnum; 3947: # need to always cache even if we get errors otherwise we keep 3948: # trying and trying and trying to get the course description. 3949: my %envhash=(); 3950: my %returnhash=(); 3951: 3952: my $expiretime=600; 3953: if ($env{'request.course.id'} eq $normalid) { 3954: $expiretime=120; 3955: } 3956: 3957: my $prefix='course.'.$cdomain.'_'.$cnum.'.'; 3958: if (!$args->{'freshen_cache'} 3959: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) { 3960: foreach my $key (keys(%env)) { 3961: next if ($key !~ /^\Q$prefix\E(.*)/); 3962: my ($setting) = $1; 3963: $returnhash{$setting} = $env{$key}; 3964: } 3965: return %returnhash; 3966: } 3967: 3968: # get the data agin 3969: if (!$args->{'one_time'}) { 3970: $envhash{'course.'.$normalid.'.last_cache'}=time; 3971: } 3972: 3973: if ($chome ne 'no_host') { 3974: %returnhash=&dump('environment',$cdomain,$cnum); 3975: if (!exists($returnhash{'con_lost'})) { 3976: $returnhash{'home'}= $chome; 3977: $returnhash{'domain'} = $cdomain; 3978: $returnhash{'num'} = $cnum; 3979: if (!defined($returnhash{'type'})) { 3980: $returnhash{'type'} = 'Course'; 3981: } 3982: while (my ($name,$value) = each %returnhash) { 3983: $envhash{'course.'.$normalid.'.'.$name}=$value; 3984: } 3985: $returnhash{'url'}=&clutter($returnhash{'url'}); 3986: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'. 3987: $env{'user.name'}.'_'.$cdomain.'_'.$cnum; 3988: $envhash{'course.'.$normalid.'.home'}=$chome; 3989: $envhash{'course.'.$normalid.'.domain'}=$cdomain; 3990: $envhash{'course.'.$normalid.'.num'}=$cnum; 3991: } 3992: } 3993: if (!$args->{'one_time'}) { 3994: &appenv(\%envhash); 3995: } 3996: return %returnhash; 3997: } 3998: 3999: sub update_released_required { 4000: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_; 4001: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') { 4002: $cid = $env{'request.course.id'}; 4003: $cdom = $env{'course.'.$cid.'.domain'}; 4004: $cnum = $env{'course.'.$cid.'.num'}; 4005: $chome = $env{'course.'.$cid.'.home'}; 4006: } 4007: if ($needsrelease) { 4008: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired'); 4009: my $needsupdate; 4010: if ($curr_reqd_hash{'internal.releaserequired'} eq '') { 4011: $needsupdate = 1; 4012: } else { 4013: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'}); 4014: my ($needsmajor,$needsminor) = split(/\./,$needsrelease); 4015: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) { 4016: $needsupdate = 1; 4017: } 4018: } 4019: if ($needsupdate) { 4020: my %needshash = ( 4021: 'internal.releaserequired' => $needsrelease, 4022: ); 4023: my $putresult = &put('environment',\%needshash,$cdom,$cnum); 4024: if ($putresult eq 'ok') { 4025: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease}); 4026: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.'); 4027: if (ref($crsinfo{$cid}) eq 'HASH') { 4028: $crsinfo{$cid}{'releaserequired'} = $needsrelease; 4029: &courseidput($cdom,\%crsinfo,$chome,'notime'); 4030: } 4031: } 4032: } 4033: } 4034: return; 4035: } 4036: 4037: # -------------------------------------------------See if a user is privileged 4038: 4039: sub privileged { 4040: my ($username,$domain)=@_; 4041: my $rolesdump=&reply("dump:$domain:$username:roles", 4042: &homeserver($username,$domain)); 4043: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 4044: ($rolesdump =~ /^error:/)) { 4045: return 0; 4046: } 4047: my $now=time; 4048: if ($rolesdump ne '') { 4049: foreach my $entry (split(/&/,$rolesdump)) { 4050: if ($entry!~/^rolesdef_/) { 4051: my ($area,$role)=split(/=/,$entry); 4052: $area=~s/\_\w\w$//; 4053: my ($trole,$tend,$tstart)=split(/_/,$role); 4054: if (($trole eq 'dc') || ($trole eq 'su')) { 4055: my $active=1; 4056: if ($tend) { 4057: if ($tend<$now) { $active=0; } 4058: } 4059: if ($tstart) { 4060: if ($tstart>$now) { $active=0; } 4061: } 4062: if ($active) { return 1; } 4063: } 4064: } 4065: } 4066: } 4067: return 0; 4068: } 4069: 4070: # -------------------------------------------------------- Get user privileges 4071: 4072: sub rolesinit { 4073: my ($domain,$username,$authhost)=@_; 4074: my $now=time; 4075: my %userroles = ('user.login.time' => $now); 4076: my $extra = &freeze_escape({'skipcheck' => 1}); 4077: my $rolesdump=reply("dump:$domain:$username:roles:.::$extra",$authhost); 4078: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') || 4079: ($rolesdump =~ /^error:/)) { 4080: return \%userroles; 4081: } 4082: my %allroles=(); 4083: my %allgroups=(); 4084: my $group_privs; 4085: 4086: if ($rolesdump ne '') { 4087: foreach my $entry (split(/&/,$rolesdump)) { 4088: if ($entry!~/^rolesdef_/) { 4089: my ($area,$role)=split(/=/,$entry); 4090: $area=~s/\_\w\w$//; 4091: my ($trole,$tend,$tstart,$group_privs); 4092: if ($role=~/^cr/) { 4093: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) { 4094: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|); 4095: ($tend,$tstart)=split('_',$trest); 4096: } else { 4097: $trole=$role; 4098: } 4099: } elsif ($role =~ m|^gr/|) { 4100: ($trole,$tend,$tstart) = split(/_/,$role); 4101: ($trole,$group_privs) = split(/\//,$trole); 4102: $group_privs = &unescape($group_privs); 4103: } else { 4104: ($trole,$tend,$tstart)=split(/_/,$role); 4105: } 4106: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain, 4107: $username); 4108: @userroles{keys(%new_role)} = @new_role{keys(%new_role)}; 4109: if (($tend!=0) && ($tend<$now)) { $trole=''; } 4110: if (($tstart!=0) && ($tstart>$now)) { $trole=''; } 4111: if (($area ne '') && ($trole ne '')) { 4112: my $spec=$trole.'.'.$area; 4113: my ($tdummy,$tdomain,$trest)=split(/\//,$area); 4114: if ($trole =~ /^cr\//) { 4115: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 4116: } elsif ($trole eq 'gr') { 4117: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart); 4118: } else { 4119: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 4120: } 4121: } 4122: } 4123: } 4124: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups); 4125: $userroles{'user.adv'} = $adv; 4126: $userroles{'user.author'} = $author; 4127: $env{'user.adv'}=$adv; 4128: } 4129: return \%userroles; 4130: } 4131: 4132: sub set_arearole { 4133: my ($trole,$area,$tstart,$tend,$domain,$username) = @_; 4134: # log the associated role with the area 4135: &userrolelog($trole,$username,$domain,$area,$tstart,$tend); 4136: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend); 4137: } 4138: 4139: sub custom_roleprivs { 4140: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_; 4141: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole); 4142: my $homsvr=homeserver($rauthor,$rdomain); 4143: if (&hostname($homsvr) ne '') { 4144: my ($rdummy,$roledef)= 4145: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor); 4146: if (($rdummy ne 'con_lost') && ($roledef ne '')) { 4147: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef); 4148: if (defined($syspriv)) { 4149: if ($trest =~ /^$match_community$/) { 4150: $syspriv =~ s/bre\&S//; 4151: } 4152: $$allroles{'cm./'}.=':'.$syspriv; 4153: $$allroles{$spec.'./'}.=':'.$syspriv; 4154: } 4155: if ($tdomain ne '') { 4156: if (defined($dompriv)) { 4157: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv; 4158: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv; 4159: } 4160: if (($trest ne '') && (defined($coursepriv))) { 4161: $$allroles{'cm.'.$area}.=':'.$coursepriv; 4162: $$allroles{$spec.'.'.$area}.=':'.$coursepriv; 4163: } 4164: } 4165: } 4166: } 4167: } 4168: 4169: sub group_roleprivs { 4170: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_; 4171: my $access = 1; 4172: my $now = time; 4173: if (($tend!=0) && ($tend<$now)) { $access = 0; } 4174: if (($tstart!=0) && ($tstart>$now)) { $access=0; } 4175: if ($access) { 4176: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|); 4177: $$allgroups{$course}{$group} .=':'.$group_privs; 4178: } 4179: } 4180: 4181: sub standard_roleprivs { 4182: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_; 4183: if (defined($pr{$trole.':s'})) { 4184: $$allroles{'cm./'}.=':'.$pr{$trole.':s'}; 4185: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'}; 4186: } 4187: if ($tdomain ne '') { 4188: if (defined($pr{$trole.':d'})) { 4189: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 4190: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'}; 4191: } 4192: if (($trest ne '') && (defined($pr{$trole.':c'}))) { 4193: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'}; 4194: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'}; 4195: } 4196: } 4197: } 4198: 4199: sub set_userprivs { 4200: my ($userroles,$allroles,$allgroups,$groups_roles) = @_; 4201: my $author=0; 4202: my $adv=0; 4203: my %grouproles = (); 4204: if (keys(%{$allgroups}) > 0) { 4205: my @groupkeys; 4206: foreach my $role (keys(%{$allroles})) { 4207: push(@groupkeys,$role); 4208: } 4209: if (ref($groups_roles) eq 'HASH') { 4210: foreach my $key (keys(%{$groups_roles})) { 4211: unless (grep(/^\Q$key\E$/,@groupkeys)) { 4212: push(@groupkeys,$key); 4213: } 4214: } 4215: } 4216: if (@groupkeys > 0) { 4217: foreach my $role (@groupkeys) { 4218: my ($trole,$area,$sec,$extendedarea); 4219: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) { 4220: $trole = $1; 4221: $area = $2; 4222: $sec = $3; 4223: $extendedarea = $area.$sec; 4224: if (exists($$allgroups{$area})) { 4225: foreach my $group (keys(%{$$allgroups{$area}})) { 4226: my $spec = $trole.'.'.$extendedarea; 4227: $grouproles{$spec.'.'.$area.'/'.$group} = 4228: $$allgroups{$area}{$group}; 4229: } 4230: } 4231: } 4232: } 4233: } 4234: } 4235: foreach my $group (keys(%grouproles)) { 4236: $$allroles{$group} = $grouproles{$group}; 4237: } 4238: foreach my $role (keys(%{$allroles})) { 4239: my %thesepriv; 4240: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; } 4241: foreach my $item (split(/:/,$$allroles{$role})) { 4242: if ($item ne '') { 4243: my ($privilege,$restrictions)=split(/&/,$item); 4244: if ($restrictions eq '') { 4245: $thesepriv{$privilege}='F'; 4246: } elsif ($thesepriv{$privilege} ne 'F') { 4247: $thesepriv{$privilege}.=$restrictions; 4248: } 4249: if ($thesepriv{'adv'} eq 'F') { $adv=1; } 4250: } 4251: } 4252: my $thesestr=''; 4253: foreach my $priv (keys(%thesepriv)) { 4254: $thesestr.=':'.$priv.'&'.$thesepriv{$priv}; 4255: } 4256: $userroles->{'user.priv.'.$role} = $thesestr; 4257: } 4258: return ($author,$adv); 4259: } 4260: 4261: sub role_status { 4262: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_; 4263: my @pwhere = (); 4264: if (exists($env{$rolekey}) && $env{$rolekey} ne '') { 4265: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey); 4266: unless (!defined($$role) || $$role eq '') { 4267: $$where=join('.',@pwhere); 4268: $$trolecode=$$role.'.'.$$where; 4269: ($$tstart,$$tend)=split(/\./,$env{$rolekey}); 4270: $$tstatus='is'; 4271: if ($$tstart && $$tstart>$then) { 4272: $$tstatus='future'; 4273: if ($$tstart<$now) { 4274: if ($$tstart && $$tstart>$refresh) { 4275: if (($$where ne '') && ($$role ne '')) { 4276: my (%allroles,%allgroups,$group_privs, 4277: %groups_roles,@rolecodes); 4278: my %userroles = ( 4279: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend 4280: ); 4281: @rolecodes = ('cm'); 4282: my $spec=$$role.'.'.$$where; 4283: my ($tdummy,$tdomain,$trest)=split(/\//,$$where); 4284: if ($$role =~ /^cr\//) { 4285: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where); 4286: push(@rolecodes,'cr'); 4287: } elsif ($$role eq 'gr') { 4288: push(@rolecodes,$$role); 4289: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'}, 4290: $env{'user.name'}); 4291: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2); 4292: (undef,my $group_privs) = split(/\//,$trole); 4293: $group_privs = &unescape($group_privs); 4294: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart); 4295: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1); 4296: if (keys(%course_roles) > 0) { 4297: my ($tnum) = ($trest =~ /^($match_courseid)/); 4298: if ($tdomain ne '' && $tnum ne '') { 4299: foreach my $key (keys(%course_roles)) { 4300: if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) { 4301: my $crsrole = $1; 4302: my $crssec = $2; 4303: if ($crsrole =~ /^cr/) { 4304: unless (grep(/^cr$/,@rolecodes)) { 4305: push(@rolecodes,'cr'); 4306: } 4307: } else { 4308: unless(grep(/^\Q$crsrole\E$/,@rolecodes)) { 4309: push(@rolecodes,$crsrole); 4310: } 4311: } 4312: my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum; 4313: if ($crssec ne '') { 4314: $rolekey .= '/'.$crssec; 4315: } 4316: $rolekey .= './'; 4317: $groups_roles{$rolekey} = \@rolecodes; 4318: } 4319: } 4320: } 4321: } 4322: } else { 4323: push(@rolecodes,$$role); 4324: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where); 4325: } 4326: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles); 4327: &appenv(\%userroles,\@rolecodes); 4328: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4329: } 4330: } 4331: $$tstatus = 'is'; 4332: } 4333: } 4334: if ($$tend) { 4335: if ($$tend<$then) { 4336: $$tstatus='expired'; 4337: } elsif ($$tend<$now) { 4338: $$tstatus='will_not'; 4339: } 4340: } 4341: } 4342: } 4343: } 4344: 4345: sub check_adhoc_privs { 4346: my ($cdom,$cnum,$then,$refresh,$now,$checkrole,$caller) = @_; 4347: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum; 4348: if ($env{$cckey}) { 4349: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend); 4350: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend); 4351: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) { 4352: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller); 4353: } 4354: } else { 4355: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller); 4356: } 4357: } 4358: 4359: sub set_adhoc_privileges { 4360: # role can be cc or ca 4361: my ($dcdom,$pickedcourse,$role,$caller) = @_; 4362: my $area = '/'.$dcdom.'/'.$pickedcourse; 4363: my $spec = $role.'.'.$area; 4364: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'}, 4365: $env{'user.name'}); 4366: my %ccrole = (); 4367: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area); 4368: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole); 4369: &appenv(\%userroles,[$role,'cm']); 4370: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role); 4371: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) { 4372: &appenv( {'request.role' => $spec, 4373: 'request.role.domain' => $dcdom, 4374: 'request.course.sec' => '' 4375: } 4376: ); 4377: my $tadv=0; 4378: if (&allowed('adv') eq 'F') { $tadv=1; } 4379: &appenv({'request.role.adv' => $tadv}); 4380: } 4381: } 4382: 4383: # --------------------------------------------------------------- get interface 4384: 4385: sub get { 4386: my ($namespace,$storearr,$udomain,$uname)=@_; 4387: my $items=''; 4388: foreach my $item (@$storearr) { 4389: $items.=&escape($item).'&'; 4390: } 4391: $items=~s/\&$//; 4392: if (!$udomain) { $udomain=$env{'user.domain'}; } 4393: if (!$uname) { $uname=$env{'user.name'}; } 4394: my $uhome=&homeserver($uname,$udomain); 4395: 4396: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome); 4397: my @pairs=split(/\&/,$rep); 4398: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) { 4399: return @pairs; 4400: } 4401: my %returnhash=(); 4402: my $i=0; 4403: foreach my $item (@$storearr) { 4404: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4405: $i++; 4406: } 4407: return %returnhash; 4408: } 4409: 4410: # --------------------------------------------------------------- del interface 4411: 4412: sub del { 4413: my ($namespace,$storearr,$udomain,$uname)=@_; 4414: my $items=''; 4415: foreach my $item (@$storearr) { 4416: $items.=&escape($item).'&'; 4417: } 4418: 4419: $items=~s/\&$//; 4420: if (!$udomain) { $udomain=$env{'user.domain'}; } 4421: if (!$uname) { $uname=$env{'user.name'}; } 4422: my $uhome=&homeserver($uname,$udomain); 4423: return &reply("del:$udomain:$uname:$namespace:$items",$uhome); 4424: } 4425: 4426: # -------------------------------------------------------------- dump interface 4427: 4428: sub dump { 4429: my ($namespace,$udomain,$uname,$regexp,$range,$extra)=@_; 4430: if (!$udomain) { $udomain=$env{'user.domain'}; } 4431: if (!$uname) { $uname=$env{'user.name'}; } 4432: my $uhome=&homeserver($uname,$udomain); 4433: if ($regexp) { 4434: $regexp=&escape($regexp); 4435: } else { 4436: $regexp='.'; 4437: } 4438: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range:$extra",$uhome); 4439: my @pairs=split(/\&/,$rep); 4440: my %returnhash=(); 4441: foreach my $item (@pairs) { 4442: my ($key,$value)=split(/=/,$item,2); 4443: $key = &unescape($key); 4444: next if ($key =~ /^error: 2 /); 4445: $returnhash{$key}=&thaw_unescape($value); 4446: } 4447: return %returnhash; 4448: } 4449: 4450: # --------------------------------------------------------- dumpstore interface 4451: 4452: sub dumpstore { 4453: my ($namespace,$udomain,$uname,$regexp,$range)=@_; 4454: if (!$udomain) { $udomain=$env{'user.domain'}; } 4455: if (!$uname) { $uname=$env{'user.name'}; } 4456: my $uhome=&homeserver($uname,$udomain); 4457: if ($regexp) { 4458: $regexp=&escape($regexp); 4459: } else { 4460: $regexp='.'; 4461: } 4462: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome); 4463: my @pairs=split(/\&/,$rep); 4464: my %returnhash=(); 4465: foreach my $item (@pairs) { 4466: my ($key,$value)=split(/=/,$item,2); 4467: next if ($key =~ /^error: 2 /); 4468: $returnhash{$key}=&thaw_unescape($value); 4469: } 4470: return %returnhash; 4471: } 4472: 4473: # -------------------------------------------------------------- keys interface 4474: 4475: sub getkeys { 4476: my ($namespace,$udomain,$uname)=@_; 4477: if (!$udomain) { $udomain=$env{'user.domain'}; } 4478: if (!$uname) { $uname=$env{'user.name'}; } 4479: my $uhome=&homeserver($uname,$udomain); 4480: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome); 4481: my @keyarray=(); 4482: foreach my $key (split(/\&/,$rep)) { 4483: next if ($key =~ /^error: 2 /); 4484: push(@keyarray,&unescape($key)); 4485: } 4486: return @keyarray; 4487: } 4488: 4489: # --------------------------------------------------------------- currentdump 4490: sub currentdump { 4491: my ($courseid,$sdom,$sname)=@_; 4492: $courseid = $env{'request.course.id'} if (! defined($courseid)); 4493: $sdom = $env{'user.domain'} if (! defined($sdom)); 4494: $sname = $env{'user.name'} if (! defined($sname)); 4495: my $uhome = &homeserver($sname,$sdom); 4496: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome); 4497: return if ($rep =~ /^(error:|no_such_host)/); 4498: # 4499: my %returnhash=(); 4500: # 4501: if ($rep eq "unknown_cmd") { 4502: # an old lond will not know currentdump 4503: # Do a dump and make it look like a currentdump 4504: my @tmp = &dumpstore($courseid,$sdom,$sname,'.'); 4505: return if ($tmp[0] =~ /^(error:|no_such_host)/); 4506: my %hash = @tmp; 4507: @tmp=(); 4508: %returnhash = %{&convert_dump_to_currentdump(\%hash)}; 4509: } else { 4510: my @pairs=split(/\&/,$rep); 4511: foreach my $pair (@pairs) { 4512: my ($key,$value)=split(/=/,$pair,2); 4513: my ($symb,$param) = split(/:/,$key); 4514: $returnhash{&unescape($symb)}->{&unescape($param)} = 4515: &thaw_unescape($value); 4516: } 4517: } 4518: return %returnhash; 4519: } 4520: 4521: sub convert_dump_to_currentdump{ 4522: my %hash = %{shift()}; 4523: my %returnhash; 4524: # Code ripped from lond, essentially. The only difference 4525: # here is the unescaping done by lonnet::dump(). Conceivably 4526: # we might run in to problems with parameter names =~ /^v\./ 4527: while (my ($key,$value) = each(%hash)) { 4528: my ($v,$symb,$param) = split(/:/,$key); 4529: $symb = &unescape($symb); 4530: $param = &unescape($param); 4531: next if ($v eq 'version' || $symb eq 'keys'); 4532: next if (exists($returnhash{$symb}) && 4533: exists($returnhash{$symb}->{$param}) && 4534: $returnhash{$symb}->{'v.'.$param} > $v); 4535: $returnhash{$symb}->{$param}=$value; 4536: $returnhash{$symb}->{'v.'.$param}=$v; 4537: } 4538: # 4539: # Remove all of the keys in the hashes which keep track of 4540: # the version of the parameter. 4541: while (my ($symb,$param_hash) = each(%returnhash)) { 4542: # use a foreach because we are going to delete from the hash. 4543: foreach my $key (keys(%$param_hash)) { 4544: delete($param_hash->{$key}) if ($key =~ /^v\./); 4545: } 4546: } 4547: return \%returnhash; 4548: } 4549: 4550: # ------------------------------------------------------ critical inc interface 4551: 4552: sub cinc { 4553: return &inc(@_,'critical'); 4554: } 4555: 4556: # --------------------------------------------------------------- inc interface 4557: 4558: sub inc { 4559: my ($namespace,$store,$udomain,$uname,$critical) = @_; 4560: if (!$udomain) { $udomain=$env{'user.domain'}; } 4561: if (!$uname) { $uname=$env{'user.name'}; } 4562: my $uhome=&homeserver($uname,$udomain); 4563: my $items=''; 4564: if (! ref($store)) { 4565: # got a single value, so use that instead 4566: $items = &escape($store).'=&'; 4567: } elsif (ref($store) eq 'SCALAR') { 4568: $items = &escape($$store).'=&'; 4569: } elsif (ref($store) eq 'ARRAY') { 4570: $items = join('=&',map {&escape($_);} @{$store}); 4571: } elsif (ref($store) eq 'HASH') { 4572: while (my($key,$value) = each(%{$store})) { 4573: $items.= &escape($key).'='.&escape($value).'&'; 4574: } 4575: } 4576: $items=~s/\&$//; 4577: if ($critical) { 4578: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome); 4579: } else { 4580: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome); 4581: } 4582: } 4583: 4584: # --------------------------------------------------------------- put interface 4585: 4586: sub put { 4587: my ($namespace,$storehash,$udomain,$uname)=@_; 4588: if (!$udomain) { $udomain=$env{'user.domain'}; } 4589: if (!$uname) { $uname=$env{'user.name'}; } 4590: my $uhome=&homeserver($uname,$udomain); 4591: my $items=''; 4592: foreach my $item (keys(%$storehash)) { 4593: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4594: } 4595: $items=~s/\&$//; 4596: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4597: } 4598: 4599: # ------------------------------------------------------------ newput interface 4600: 4601: sub newput { 4602: my ($namespace,$storehash,$udomain,$uname)=@_; 4603: if (!$udomain) { $udomain=$env{'user.domain'}; } 4604: if (!$uname) { $uname=$env{'user.name'}; } 4605: my $uhome=&homeserver($uname,$udomain); 4606: my $items=''; 4607: foreach my $key (keys(%$storehash)) { 4608: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 4609: } 4610: $items=~s/\&$//; 4611: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome); 4612: } 4613: 4614: # --------------------------------------------------------- putstore interface 4615: 4616: sub putstore { 4617: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4618: if (!$udomain) { $udomain=$env{'user.domain'}; } 4619: if (!$uname) { $uname=$env{'user.name'}; } 4620: my $uhome=&homeserver($uname,$udomain); 4621: my $items=''; 4622: foreach my $key (keys(%$storehash)) { 4623: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&'; 4624: } 4625: $items=~s/\&$//; 4626: my $esc_symb=&escape($symb); 4627: my $esc_v=&escape($version); 4628: my $reply = 4629: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items", 4630: $uhome); 4631: if ($reply eq 'unknown_cmd') { 4632: # gfall back to way things use to be done 4633: return &old_putstore($namespace,$symb,$version,$storehash,$udomain, 4634: $uname); 4635: } 4636: return $reply; 4637: } 4638: 4639: sub old_putstore { 4640: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_; 4641: if (!$udomain) { $udomain=$env{'user.domain'}; } 4642: if (!$uname) { $uname=$env{'user.name'}; } 4643: my $uhome=&homeserver($uname,$udomain); 4644: my %newstorehash; 4645: foreach my $item (keys(%$storehash)) { 4646: my $key = $version.':'.&escape($symb).':'.$item; 4647: $newstorehash{$key} = $storehash->{$item}; 4648: } 4649: my $items=''; 4650: my %allitems = (); 4651: foreach my $item (keys(%newstorehash)) { 4652: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) { 4653: my $key = $1.':keys:'.$2; 4654: $allitems{$key} .= $3.':'; 4655: } 4656: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&'; 4657: } 4658: foreach my $item (keys(%allitems)) { 4659: $allitems{$item} =~ s/\:$//; 4660: $items.= $item.'='.$allitems{$item}.'&'; 4661: } 4662: $items=~s/\&$//; 4663: return &reply("put:$udomain:$uname:$namespace:$items",$uhome); 4664: } 4665: 4666: # ------------------------------------------------------ critical put interface 4667: 4668: sub cput { 4669: my ($namespace,$storehash,$udomain,$uname)=@_; 4670: if (!$udomain) { $udomain=$env{'user.domain'}; } 4671: if (!$uname) { $uname=$env{'user.name'}; } 4672: my $uhome=&homeserver($uname,$udomain); 4673: my $items=''; 4674: foreach my $item (keys(%$storehash)) { 4675: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4676: } 4677: $items=~s/\&$//; 4678: return &critical("put:$udomain:$uname:$namespace:$items",$uhome); 4679: } 4680: 4681: # -------------------------------------------------------------- eget interface 4682: 4683: sub eget { 4684: my ($namespace,$storearr,$udomain,$uname)=@_; 4685: my $items=''; 4686: foreach my $item (@$storearr) { 4687: $items.=&escape($item).'&'; 4688: } 4689: $items=~s/\&$//; 4690: if (!$udomain) { $udomain=$env{'user.domain'}; } 4691: if (!$uname) { $uname=$env{'user.name'}; } 4692: my $uhome=&homeserver($uname,$udomain); 4693: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome); 4694: my @pairs=split(/\&/,$rep); 4695: my %returnhash=(); 4696: my $i=0; 4697: foreach my $item (@$storearr) { 4698: $returnhash{$item}=&thaw_unescape($pairs[$i]); 4699: $i++; 4700: } 4701: return %returnhash; 4702: } 4703: 4704: # ------------------------------------------------------------ tmpput interface 4705: sub tmpput { 4706: my ($storehash,$server,$context)=@_; 4707: my $items=''; 4708: foreach my $item (keys(%$storehash)) { 4709: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&'; 4710: } 4711: $items=~s/\&$//; 4712: if (defined($context)) { 4713: $items .= ':'.&escape($context); 4714: } 4715: return &reply("tmpput:$items",$server); 4716: } 4717: 4718: # ------------------------------------------------------------ tmpget interface 4719: sub tmpget { 4720: my ($token,$server)=@_; 4721: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4722: my $rep=&reply("tmpget:$token",$server); 4723: my %returnhash; 4724: foreach my $item (split(/\&/,$rep)) { 4725: my ($key,$value)=split(/=/,$item); 4726: next if ($key =~ /^error: 2 /); 4727: $returnhash{&unescape($key)}=&thaw_unescape($value); 4728: } 4729: return %returnhash; 4730: } 4731: 4732: # ------------------------------------------------------------ tmpget interface 4733: sub tmpdel { 4734: my ($token,$server)=@_; 4735: if (!defined($server)) { $server = $perlvar{'lonHostID'}; } 4736: return &reply("tmpdel:$token",$server); 4737: } 4738: 4739: # -------------------------------------------------- portfolio access checking 4740: 4741: sub portfolio_access { 4742: my ($requrl) = @_; 4743: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl); 4744: my $result = &get_portfolio_access($udom,$unum,$file_name,$group); 4745: if ($result) { 4746: my %setters; 4747: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4748: my ($startblock,$endblock) = 4749: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom); 4750: if ($startblock && $endblock) { 4751: return 'B'; 4752: } 4753: } else { 4754: my ($startblock,$endblock) = 4755: &Apache::loncommon::blockcheck(\%setters,'port'); 4756: if ($startblock && $endblock) { 4757: return 'B'; 4758: } 4759: } 4760: } 4761: if ($result eq 'ok') { 4762: return 'F'; 4763: } elsif ($result =~ /^[^:]+:guest_/) { 4764: return 'A'; 4765: } 4766: return ''; 4767: } 4768: 4769: sub get_portfolio_access { 4770: my ($udom,$unum,$file_name,$group,$access_hash) = @_; 4771: 4772: if (!ref($access_hash)) { 4773: my $current_perms = &get_portfile_permissions($udom,$unum); 4774: my %access_controls = &get_access_controls($current_perms,$group, 4775: $file_name); 4776: $access_hash = $access_controls{$file_name}; 4777: } 4778: 4779: my ($public,$guest,@domains,@users,@courses,@groups); 4780: my $now = time; 4781: if (ref($access_hash) eq 'HASH') { 4782: foreach my $key (keys(%{$access_hash})) { 4783: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 4784: if ($start > $now) { 4785: next; 4786: } 4787: if ($end && $end<$now) { 4788: next; 4789: } 4790: if ($scope eq 'public') { 4791: $public = $key; 4792: last; 4793: } elsif ($scope eq 'guest') { 4794: $guest = $key; 4795: } elsif ($scope eq 'domains') { 4796: push(@domains,$key); 4797: } elsif ($scope eq 'users') { 4798: push(@users,$key); 4799: } elsif ($scope eq 'course') { 4800: push(@courses,$key); 4801: } elsif ($scope eq 'group') { 4802: push(@groups,$key); 4803: } 4804: } 4805: if ($public) { 4806: return 'ok'; 4807: } 4808: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') { 4809: if ($guest) { 4810: return $guest; 4811: } 4812: } else { 4813: if (@domains > 0) { 4814: foreach my $domkey (@domains) { 4815: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') { 4816: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) { 4817: return 'ok'; 4818: } 4819: } 4820: } 4821: } 4822: if (@users > 0) { 4823: foreach my $userkey (@users) { 4824: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') { 4825: foreach my $item (@{$access_hash->{$userkey}{'users'}}) { 4826: if (ref($item) eq 'HASH') { 4827: if (($item->{'uname'} eq $env{'user.name'}) && 4828: ($item->{'udom'} eq $env{'user.domain'})) { 4829: return 'ok'; 4830: } 4831: } 4832: } 4833: } 4834: } 4835: } 4836: my %roleshash; 4837: my @courses_and_groups = @courses; 4838: push(@courses_and_groups,@groups); 4839: if (@courses_and_groups > 0) { 4840: my (%allgroups,%allroles); 4841: my ($start,$end,$role,$sec,$group); 4842: foreach my $envkey (%env) { 4843: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) { 4844: my $cid = $2.'_'.$3; 4845: if ($1 eq 'gr') { 4846: $group = $4; 4847: $allgroups{$cid}{$group} = $env{$envkey}; 4848: } else { 4849: if ($4 eq '') { 4850: $sec = 'none'; 4851: } else { 4852: $sec = $4; 4853: } 4854: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4855: } 4856: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) { 4857: my $cid = $2.'_'.$3; 4858: if ($4 eq '') { 4859: $sec = 'none'; 4860: } else { 4861: $sec = $4; 4862: } 4863: $allroles{$cid}{$1}{$sec} = $env{$envkey}; 4864: } 4865: } 4866: if (keys(%allroles) == 0) { 4867: return; 4868: } 4869: foreach my $key (@courses_and_groups) { 4870: my %content = %{$$access_hash{$key}}; 4871: my $cnum = $content{'number'}; 4872: my $cdom = $content{'domain'}; 4873: my $cid = $cdom.'_'.$cnum; 4874: if (!exists($allroles{$cid})) { 4875: next; 4876: } 4877: foreach my $role_id (keys(%{$content{'roles'}})) { 4878: my @sections = @{$content{'roles'}{$role_id}{'section'}}; 4879: my @groups = @{$content{'roles'}{$role_id}{'group'}}; 4880: my @status = @{$content{'roles'}{$role_id}{'access'}}; 4881: my @roles = @{$content{'roles'}{$role_id}{'role'}}; 4882: foreach my $role (keys(%{$allroles{$cid}})) { 4883: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) { 4884: foreach my $sec (keys(%{$allroles{$cid}{$role}})) { 4885: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') { 4886: if (grep/^all$/,@sections) { 4887: return 'ok'; 4888: } else { 4889: if (grep/^$sec$/,@sections) { 4890: return 'ok'; 4891: } 4892: } 4893: } 4894: } 4895: if (keys(%{$allgroups{$cid}}) == 0) { 4896: if (grep/^none$/,@groups) { 4897: return 'ok'; 4898: } 4899: } else { 4900: if (grep/^all$/,@groups) { 4901: return 'ok'; 4902: } 4903: foreach my $group (keys(%{$allgroups{$cid}})) { 4904: if (grep/^$group$/,@groups) { 4905: return 'ok'; 4906: } 4907: } 4908: } 4909: } 4910: } 4911: } 4912: } 4913: } 4914: if ($guest) { 4915: return $guest; 4916: } 4917: } 4918: } 4919: return; 4920: } 4921: 4922: sub course_group_datechecker { 4923: my ($dates,$now,$status) = @_; 4924: my ($start,$end) = split(/\./,$dates); 4925: if (!$start && !$end) { 4926: return 'ok'; 4927: } 4928: if (grep/^active$/,@{$status}) { 4929: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) { 4930: return 'ok'; 4931: } 4932: } 4933: if (grep/^previous$/,@{$status}) { 4934: if ($end > $now ) { 4935: return 'ok'; 4936: } 4937: } 4938: if (grep/^future$/,@{$status}) { 4939: if ($start > $now) { 4940: return 'ok'; 4941: } 4942: } 4943: return; 4944: } 4945: 4946: sub parse_portfolio_url { 4947: my ($url) = @_; 4948: 4949: my ($type,$udom,$unum,$group,$file_name); 4950: 4951: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) { 4952: $type = 1; 4953: $udom = $1; 4954: $unum = $2; 4955: $file_name = $3; 4956: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) { 4957: $type = 2; 4958: $udom = $1; 4959: $unum = $2; 4960: $group = $3; 4961: $file_name = $3.'/'.$4; 4962: } 4963: if (wantarray) { 4964: return ($type,$udom,$unum,$file_name,$group); 4965: } 4966: return $type; 4967: } 4968: 4969: sub is_portfolio_url { 4970: my ($url) = @_; 4971: return scalar(&parse_portfolio_url($url)); 4972: } 4973: 4974: sub is_portfolio_file { 4975: my ($file) = @_; 4976: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) { 4977: return 1; 4978: } 4979: return; 4980: } 4981: 4982: sub usertools_access { 4983: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_; 4984: my ($access,%tools); 4985: if ($context eq '') { 4986: $context = 'tools'; 4987: } 4988: if ($context eq 'requestcourses') { 4989: %tools = ( 4990: official => 1, 4991: unofficial => 1, 4992: community => 1, 4993: ); 4994: } else { 4995: %tools = ( 4996: aboutme => 1, 4997: blog => 1, 4998: portfolio => 1, 4999: ); 5000: } 5001: return if (!defined($tools{$tool})); 5002: 5003: if ((!defined($udom)) || (!defined($uname))) { 5004: $udom = $env{'user.domain'}; 5005: $uname = $env{'user.name'}; 5006: } 5007: 5008: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 5009: if ($action ne 'reload') { 5010: if ($context eq 'requestcourses') { 5011: return $env{'environment.canrequest.'.$tool}; 5012: } else { 5013: return $env{'environment.availabletools.'.$tool}; 5014: } 5015: } 5016: } 5017: 5018: my ($toolstatus,$inststatus); 5019: 5020: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) && 5021: ($action ne 'reload')) { 5022: $toolstatus = $env{'environment.'.$context.'.'.$tool}; 5023: $inststatus = $env{'environment.inststatus'}; 5024: } else { 5025: if (ref($userenvref) eq 'HASH') { 5026: $toolstatus = $userenvref->{$context.'.'.$tool}; 5027: $inststatus = $userenvref->{'inststatus'}; 5028: } else { 5029: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus'); 5030: $toolstatus = $userenv{$context.'.'.$tool}; 5031: $inststatus = $userenv{'inststatus'}; 5032: } 5033: } 5034: 5035: if ($toolstatus ne '') { 5036: if ($toolstatus) { 5037: $access = 1; 5038: } else { 5039: $access = 0; 5040: } 5041: return $access; 5042: } 5043: 5044: my ($is_adv,%domdef); 5045: if (ref($is_advref) eq 'HASH') { 5046: $is_adv = $is_advref->{'is_adv'}; 5047: } else { 5048: $is_adv = &is_advanced_user($udom,$uname); 5049: } 5050: if (ref($domdefref) eq 'HASH') { 5051: %domdef = %{$domdefref}; 5052: } else { 5053: %domdef = &get_domain_defaults($udom); 5054: } 5055: if (ref($domdef{$tool}) eq 'HASH') { 5056: if ($is_adv) { 5057: if ($domdef{$tool}{'_LC_adv'} ne '') { 5058: if ($domdef{$tool}{'_LC_adv'}) { 5059: $access = 1; 5060: } else { 5061: $access = 0; 5062: } 5063: return $access; 5064: } 5065: } 5066: if ($inststatus ne '') { 5067: my ($hasaccess,$hasnoaccess); 5068: foreach my $affiliation (split(/:/,$inststatus)) { 5069: if ($domdef{$tool}{$affiliation} ne '') { 5070: if ($domdef{$tool}{$affiliation}) { 5071: $hasaccess = 1; 5072: } else { 5073: $hasnoaccess = 1; 5074: } 5075: } 5076: } 5077: if ($hasaccess || $hasnoaccess) { 5078: if ($hasaccess) { 5079: $access = 1; 5080: } elsif ($hasnoaccess) { 5081: $access = 0; 5082: } 5083: return $access; 5084: } 5085: } else { 5086: if ($domdef{$tool}{'default'} ne '') { 5087: if ($domdef{$tool}{'default'}) { 5088: $access = 1; 5089: } elsif ($domdef{$tool}{'default'} == 0) { 5090: $access = 0; 5091: } 5092: return $access; 5093: } 5094: } 5095: } else { 5096: if ($context eq 'tools') { 5097: $access = 1; 5098: } else { 5099: $access = 0; 5100: } 5101: return $access; 5102: } 5103: } 5104: 5105: sub is_course_owner { 5106: my ($cdom,$cnum,$udom,$uname) = @_; 5107: if (($udom eq '') || ($uname eq '')) { 5108: $udom = $env{'user.domain'}; 5109: $uname = $env{'user.name'}; 5110: } 5111: unless (($udom eq '') || ($uname eq '')) { 5112: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) { 5113: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) { 5114: return 1; 5115: } else { 5116: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum); 5117: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) { 5118: return 1; 5119: } 5120: } 5121: } 5122: } 5123: return; 5124: } 5125: 5126: sub is_advanced_user { 5127: my ($udom,$uname) = @_; 5128: if ($udom ne '' && $uname ne '') { 5129: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 5130: return $env{'user.adv'}; 5131: } 5132: } 5133: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1); 5134: my %allroles; 5135: my $is_adv; 5136: foreach my $role (keys(%roleshash)) { 5137: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role); 5138: my $area = '/'.$tdomain.'/'.$trest; 5139: if ($sec ne '') { 5140: $area .= '/'.$sec; 5141: } 5142: if (($area ne '') && ($trole ne '')) { 5143: my $spec=$trole.'.'.$area; 5144: if ($trole =~ /^cr\//) { 5145: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area); 5146: } elsif ($trole ne 'gr') { 5147: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area); 5148: } 5149: } 5150: } 5151: foreach my $role (keys(%allroles)) { 5152: last if ($is_adv); 5153: foreach my $item (split(/:/,$allroles{$role})) { 5154: if ($item ne '') { 5155: my ($privilege,$restrictions)=split(/&/,$item); 5156: if ($privilege eq 'adv') { 5157: $is_adv = 1; 5158: last; 5159: } 5160: } 5161: } 5162: } 5163: return $is_adv; 5164: } 5165: 5166: sub check_can_request { 5167: my ($dom,$can_request,$request_domains) = @_; 5168: my $canreq = 0; 5169: my ($types,$typename) = &Apache::loncommon::course_types(); 5170: my @options = ('approval','validate','autolimit'); 5171: my $optregex = join('|',@options); 5172: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) { 5173: foreach my $type (@{$types}) { 5174: if (&usertools_access($env{'user.name'}, 5175: $env{'user.domain'}, 5176: $type,undef,'requestcourses')) { 5177: $canreq ++; 5178: if (ref($request_domains) eq 'HASH') { 5179: push(@{$request_domains->{$type}},$env{'user.domain'}); 5180: } 5181: if ($dom eq $env{'user.domain'}) { 5182: $can_request->{$type} = 1; 5183: } 5184: } 5185: if ($env{'environment.reqcrsotherdom.'.$type} ne '') { 5186: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type}); 5187: if (@curr > 0) { 5188: foreach my $item (@curr) { 5189: if (ref($request_domains) eq 'HASH') { 5190: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/); 5191: if ($otherdom ne '') { 5192: if (ref($request_domains->{$type}) eq 'ARRAY') { 5193: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) { 5194: push(@{$request_domains->{$type}},$otherdom); 5195: } 5196: } else { 5197: push(@{$request_domains->{$type}},$otherdom); 5198: } 5199: } 5200: } 5201: } 5202: unless($dom eq $env{'user.domain'}) { 5203: $canreq ++; 5204: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) { 5205: $can_request->{$type} = 1; 5206: } 5207: } 5208: } 5209: } 5210: } 5211: } 5212: return $canreq; 5213: } 5214: 5215: # ---------------------------------------------- Custom access rule evaluation 5216: 5217: sub customaccess { 5218: my ($priv,$uri)=@_; 5219: my ($urole,$urealm)=split(/\./,$env{'request.role'},2); 5220: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm); 5221: $udom = &LONCAPA::clean_domain($udom); 5222: $ucrs = &LONCAPA::clean_username($ucrs); 5223: my $access=0; 5224: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) { 5225: my ($effect,$realm,$role,$type)=split(/\:/,$right); 5226: if ($type eq 'user') { 5227: foreach my $scope (split(/\s*\,\s*/,$realm)) { 5228: my ($tdom,$tuname)=split(m{/},$scope); 5229: if ($tdom) { 5230: if ($tdom ne $env{'user.domain'}) { next; } 5231: } 5232: if ($tuname) { 5233: if ($tuname ne $env{'user.name'}) { next; } 5234: } 5235: $access=($effect eq 'allow'); 5236: last; 5237: } 5238: } else { 5239: if ($role) { 5240: if ($role ne $urole) { next; } 5241: } 5242: foreach my $scope (split(/\s*\,\s*/,$realm)) { 5243: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope); 5244: if ($tdom) { 5245: if ($tdom ne $udom) { next; } 5246: } 5247: if ($tcrs) { 5248: if ($tcrs ne $ucrs) { next; } 5249: } 5250: if ($tsec) { 5251: if ($tsec ne $usec) { next; } 5252: } 5253: $access=($effect eq 'allow'); 5254: last; 5255: } 5256: if ($realm eq '' && $role eq '') { 5257: $access=($effect eq 'allow'); 5258: } 5259: } 5260: } 5261: return $access; 5262: } 5263: 5264: # ------------------------------------------------- Check for a user privilege 5265: 5266: sub allowed { 5267: my ($priv,$uri,$symb,$role)=@_; 5268: my $ver_orguri=$uri; 5269: $uri=&deversion($uri); 5270: my $orguri=$uri; 5271: $uri=&declutter($uri); 5272: 5273: if ($priv eq 'evb') { 5274: # Evade communication block restrictions for specified role in a course 5275: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) { 5276: return $1; 5277: } else { 5278: return; 5279: } 5280: } 5281: 5282: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; } 5283: # Free bre access to adm and meta resources 5284: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$})) 5285: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) )) 5286: && ($priv eq 'bre')) { 5287: return 'F'; 5288: } 5289: 5290: # Free bre access to user's own portfolio contents 5291: my ($space,$domain,$name,@dir)=split('/',$uri); 5292: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) && 5293: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) { 5294: my %setters; 5295: my ($startblock,$endblock) = 5296: &Apache::loncommon::blockcheck(\%setters,'port'); 5297: if ($startblock && $endblock) { 5298: return 'B'; 5299: } else { 5300: return 'F'; 5301: } 5302: } 5303: 5304: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course. 5305: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups') 5306: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) { 5307: if (exists($env{'request.course.id'})) { 5308: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 5309: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; 5310: if (($domain eq $cdom) && ($name eq $cnum)) { 5311: my $courseprivid=$env{'request.course.id'}; 5312: $courseprivid=~s/\_/\//; 5313: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid 5314: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) { 5315: return $1; 5316: } else { 5317: if ($env{'request.course.sec'}) { 5318: $courseprivid.='/'.$env{'request.course.sec'}; 5319: } 5320: if ($env{'user.priv.'.$env{'request.role'}.'./'. 5321: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) { 5322: return $2; 5323: } 5324: } 5325: } 5326: } 5327: } 5328: 5329: # Free bre to public access 5330: 5331: if ($priv eq 'bre') { 5332: my $copyright=&metadata($uri,'copyright'); 5333: if (($copyright eq 'public') && (!$env{'request.course.id'})) { 5334: return 'F'; 5335: } 5336: if ($copyright eq 'priv') { 5337: $uri=~/([^\/]+)\/([^\/]+)\//; 5338: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) { 5339: return ''; 5340: } 5341: } 5342: if ($copyright eq 'domain') { 5343: $uri=~/([^\/]+)\/([^\/]+)\//; 5344: unless (($env{'user.domain'} eq $1) || 5345: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) { 5346: return ''; 5347: } 5348: } 5349: if ($env{'request.role'}=~ /li\.\//) { 5350: # Library role, so allow browsing of resources in this domain. 5351: return 'F'; 5352: } 5353: if ($copyright eq 'custom') { 5354: unless (&customaccess($priv,$uri)) { return ''; } 5355: } 5356: } 5357: # Domain coordinator is trying to create a course 5358: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) { 5359: # uri is the requested domain in this case. 5360: # comparison to 'request.role.domain' shows if the user has selected 5361: # a role of dc for the domain in question. 5362: return 'F' if ($uri eq $env{'request.role.domain'}); 5363: } 5364: 5365: my $thisallowed=''; 5366: my $statecond=0; 5367: my $courseprivid=''; 5368: 5369: my $ownaccess; 5370: # Community Coordinator or Assistant Co-author browsing resource space. 5371: if (($priv eq 'bro') && ($env{'user.author'})) { 5372: if ($uri eq '') { 5373: $ownaccess = 1; 5374: } else { 5375: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) { 5376: my $udom = $env{'user.domain'}; 5377: my $uname = $env{'user.name'}; 5378: if ($uri =~ m{^\Q$udom\E/?$}) { 5379: $ownaccess = 1; 5380: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) { 5381: unless ($uri =~ m{\.\./}) { 5382: $ownaccess = 1; 5383: } 5384: } elsif (($udom ne 'public') && ($uname ne 'public')) { 5385: my $now = time; 5386: if ($uri =~ m{^([^/]+)/?$}) { 5387: my $adom = $1; 5388: foreach my $key (keys(%env)) { 5389: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) { 5390: my ($start,$end) = split('.',$env{$key}); 5391: if (($now >= $start) && (!$end || $end < $now)) { 5392: $ownaccess = 1; 5393: last; 5394: } 5395: } 5396: } 5397: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) { 5398: my $adom = $1; 5399: my $aname = $2; 5400: foreach my $role ('ca','aa') { 5401: if ($env{"user.role.$role./$adom/$aname"}) { 5402: my ($start,$end) = 5403: split('.',$env{"user.role.$role./$adom/$aname"}); 5404: if (($now >= $start) && (!$end || $end < $now)) { 5405: $ownaccess = 1; 5406: last; 5407: } 5408: } 5409: } 5410: } 5411: } 5412: } 5413: } 5414: } 5415: 5416: # Course 5417: 5418: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) { 5419: unless (($priv eq 'bro') && (!$ownaccess)) { 5420: $thisallowed.=$1; 5421: } 5422: } 5423: 5424: # Domain 5425: 5426: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'} 5427: =~/\Q$priv\E\&([^\:]*)/) { 5428: unless (($priv eq 'bro') && (!$ownaccess)) { 5429: $thisallowed.=$1; 5430: } 5431: } 5432: 5433: # Course: uri itself is a course 5434: my $courseuri=$uri; 5435: $courseuri=~s/\_(\d)/\/$1/; 5436: $courseuri=~s/^([^\/])/\/$1/; 5437: 5438: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri} 5439: =~/\Q$priv\E\&([^\:]*)/) { 5440: unless (($priv eq 'bro') && (!$ownaccess)) { 5441: $thisallowed.=$1; 5442: } 5443: } 5444: 5445: # URI is an uploaded document for this course, default permissions don't matter 5446: # not allowing 'edit' access (editupload) to uploaded course docs 5447: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) { 5448: $thisallowed=''; 5449: my ($match)=&is_on_map($uri); 5450: if ($match) { 5451: if ($env{'user.priv.'.$env{'request.role'}.'./'} 5452: =~/\Q$priv\E\&([^\:]*)/) { 5453: $thisallowed.=$1; 5454: } 5455: } else { 5456: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri}; 5457: if ($refuri) { 5458: if ($refuri =~ m|^/adm/|) { 5459: $thisallowed='F'; 5460: } else { 5461: $refuri=&declutter($refuri); 5462: my ($match) = &is_on_map($refuri); 5463: if ($match) { 5464: $thisallowed='F'; 5465: } 5466: } 5467: } 5468: } 5469: } 5470: 5471: if ($priv eq 'bre' 5472: && $thisallowed ne 'F' 5473: && $thisallowed ne '2' 5474: && &is_portfolio_url($uri)) { 5475: $thisallowed = &portfolio_access($uri); 5476: } 5477: 5478: # Full access at system, domain or course-wide level? Exit. 5479: if ($thisallowed=~/F/) { 5480: return 'F'; 5481: } 5482: 5483: # If this is generating or modifying users, exit with special codes 5484: 5485: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) { 5486: if (($priv eq 'cca') || ($priv eq 'caa')) { 5487: my ($audom,$auname)=split('/',$uri); 5488: # no author name given, so this just checks on the general right to make a co-author in this domain 5489: unless ($auname) { return $thisallowed; } 5490: # an author name is given, so we are about to actually make a co-author for a certain account 5491: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) || 5492: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) && 5493: ($audom ne $env{'request.role.domain'}))) { return ''; } 5494: } 5495: return $thisallowed; 5496: } 5497: # 5498: # Gathered so far: system, domain and course wide privileges 5499: # 5500: # Course: See if uri or referer is an individual resource that is part of 5501: # the course 5502: 5503: if ($env{'request.course.id'}) { 5504: 5505: $courseprivid=$env{'request.course.id'}; 5506: if ($env{'request.course.sec'}) { 5507: $courseprivid.='/'.$env{'request.course.sec'}; 5508: } 5509: $courseprivid=~s/\_/\//; 5510: my $checkreferer=1; 5511: my ($match,$cond)=&is_on_map($uri); 5512: if ($match) { 5513: $statecond=$cond; 5514: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5515: =~/\Q$priv\E\&([^\:]*)/) { 5516: $thisallowed.=$1; 5517: $checkreferer=0; 5518: } 5519: } 5520: 5521: if ($checkreferer) { 5522: my $refuri=$env{'httpref.'.$orguri}; 5523: unless ($refuri) { 5524: foreach my $key (keys(%env)) { 5525: if ($key=~/^httpref\..*\*/) { 5526: my $pattern=$key; 5527: $pattern=~s/^httpref\.\/res\///; 5528: $pattern=~s/\*/\[\^\/\]\+/g; 5529: $pattern=~s/\//\\\//g; 5530: if ($orguri=~/$pattern/) { 5531: $refuri=$env{$key}; 5532: } 5533: } 5534: } 5535: } 5536: 5537: if ($refuri) { 5538: $refuri=&declutter($refuri); 5539: my ($match,$cond)=&is_on_map($refuri); 5540: if ($match) { 5541: my $refstatecond=$cond; 5542: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid} 5543: =~/\Q$priv\E\&([^\:]*)/) { 5544: $thisallowed.=$1; 5545: $uri=$refuri; 5546: $statecond=$refstatecond; 5547: } 5548: } 5549: } 5550: } 5551: } 5552: 5553: # 5554: # Gathered now: all privileges that could apply, and condition number 5555: # 5556: # 5557: # Full or no access? 5558: # 5559: 5560: if ($thisallowed=~/F/) { 5561: return 'F'; 5562: } 5563: 5564: unless ($thisallowed) { 5565: return ''; 5566: } 5567: 5568: # Restrictions exist, deal with them 5569: # 5570: # C:according to course preferences 5571: # R:according to resource settings 5572: # L:unless locked 5573: # X:according to user session state 5574: # 5575: 5576: # Possibly locked functionality, check all courses 5577: # Locks might take effect only after 10 minutes cache expiration for other 5578: # courses, and 2 minutes for current course 5579: 5580: my $envkey; 5581: if ($thisallowed=~/L/) { 5582: foreach $envkey (keys(%env)) { 5583: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) { 5584: my $courseid=$2; 5585: my $roleid=$1.'.'.$2; 5586: $courseid=~s/^\///; 5587: my $expiretime=600; 5588: if ($env{'request.role'} eq $roleid) { 5589: $expiretime=120; 5590: } 5591: my ($cdom,$cnum,$csec)=split(/\//,$courseid); 5592: my $prefix='course.'.$cdom.'_'.$cnum.'.'; 5593: if ((time-$env{$prefix.'last_cache'})>$expiretime) { 5594: &coursedescription($courseid,{'freshen_cache' => 1}); 5595: } 5596: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/) 5597: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) { 5598: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) { 5599: &log($env{'user.domain'},$env{'user.name'}, 5600: $env{'user.home'}, 5601: 'Locked by res: '.$priv.' for '.$uri.' due to '. 5602: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5603: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5604: return ''; 5605: } 5606: } 5607: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/) 5608: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) { 5609: if ($env{'priv.'.$priv.'.lock.expire'}>time) { 5610: &log($env{'user.domain'},$env{'user.name'}, 5611: $env{'user.home'}, 5612: 'Locked by priv: '.$priv.' for '.$uri.' due to '. 5613: $cdom.'/'.$cnum.'/'.$csec.' expire '. 5614: $env{$prefix.'priv.'.$priv.'.lock.expire'}); 5615: return ''; 5616: } 5617: } 5618: } 5619: } 5620: } 5621: 5622: # 5623: # Rest of the restrictions depend on selected course 5624: # 5625: 5626: unless ($env{'request.course.id'}) { 5627: if ($thisallowed eq 'A') { 5628: return 'A'; 5629: } elsif ($thisallowed eq 'B') { 5630: return 'B'; 5631: } else { 5632: return '1'; 5633: } 5634: } 5635: 5636: # 5637: # Now user is definitely in a course 5638: # 5639: 5640: 5641: # Course preferences 5642: 5643: if ($thisallowed=~/C/) { 5644: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5645: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'}; 5646: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'} 5647: =~/\Q$rolecode\E/) { 5648: if ($priv ne 'pch') { 5649: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5650: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '. 5651: $env{'request.course.id'}); 5652: } 5653: return ''; 5654: } 5655: 5656: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'} 5657: =~/\Q$unamedom\E/) { 5658: if ($priv ne 'pch') { 5659: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}. 5660: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '. 5661: $env{'request.course.id'}); 5662: } 5663: return ''; 5664: } 5665: } 5666: 5667: # Resource preferences 5668: 5669: if ($thisallowed=~/R/) { 5670: my $rolecode=(split(/\./,$env{'request.role'}))[0]; 5671: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) { 5672: if ($priv ne 'pch') { 5673: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'. 5674: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode); 5675: } 5676: return ''; 5677: } 5678: } 5679: 5680: # Restricted by state or randomout? 5681: 5682: if ($thisallowed=~/X/) { 5683: if ($env{'acc.randomout'}) { 5684: if (!$symb) { $symb=&symbread($uri,1); } 5685: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) { 5686: return ''; 5687: } 5688: } 5689: if (&condval($statecond)) { 5690: return '2'; 5691: } else { 5692: return ''; 5693: } 5694: } 5695: 5696: if ($thisallowed eq 'A') { 5697: return 'A'; 5698: } elsif ($thisallowed eq 'B') { 5699: return 'B'; 5700: } 5701: return 'F'; 5702: } 5703: 5704: sub split_uri_for_cond { 5705: my $uri=&deversion(&declutter(shift)); 5706: my @uriparts=split(/\//,$uri); 5707: my $filename=pop(@uriparts); 5708: my $pathname=join('/',@uriparts); 5709: return ($pathname,$filename); 5710: } 5711: # --------------------------------------------------- Is a resource on the map? 5712: 5713: sub is_on_map { 5714: my ($pathname,$filename) = &split_uri_for_cond(shift); 5715: #Trying to find the conditional for the file 5716: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~ 5717: /\&\Q$filename\E\:([\d\|]+)\&/); 5718: if ($match) { 5719: return (1,$1); 5720: } else { 5721: return (0,0); 5722: } 5723: } 5724: 5725: # --------------------------------------------------------- Get symb from alias 5726: 5727: sub get_symb_from_alias { 5728: my $symb=shift; 5729: my ($map,$resid,$url)=&decode_symb($symb); 5730: # Already is a symb 5731: if ($url) { return $symb; } 5732: # Must be an alias 5733: my $aliassymb=''; 5734: my %bighash; 5735: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 5736: &GDBM_READER(),0640)) { 5737: my $rid=$bighash{'mapalias_'.$symb}; 5738: if ($rid) { 5739: my ($mapid,$resid)=split(/\./,$rid); 5740: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid}, 5741: $resid,$bighash{'src_'.$rid}); 5742: } 5743: untie %bighash; 5744: } 5745: return $aliassymb; 5746: } 5747: 5748: # ----------------------------------------------------------------- Define Role 5749: 5750: sub definerole { 5751: if (allowed('mcr','/')) { 5752: my ($rolename,$sysrole,$domrole,$courole)=@_; 5753: foreach my $role (split(':',$sysrole)) { 5754: my ($crole,$cqual)=split(/\&/,$role); 5755: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; } 5756: if ($pr{'cr:s'}=~/\Q$crole\E\&/) { 5757: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5758: return "refused:s:$crole&$cqual"; 5759: } 5760: } 5761: } 5762: foreach my $role (split(':',$domrole)) { 5763: my ($crole,$cqual)=split(/\&/,$role); 5764: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; } 5765: if ($pr{'cr:d'}=~/\Q$crole\E\&/) { 5766: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) { 5767: return "refused:d:$crole&$cqual"; 5768: } 5769: } 5770: } 5771: foreach my $role (split(':',$courole)) { 5772: my ($crole,$cqual)=split(/\&/,$role); 5773: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; } 5774: if ($pr{'cr:c'}=~/\Q$crole\E\&/) { 5775: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) { 5776: return "refused:c:$crole&$cqual"; 5777: } 5778: } 5779: } 5780: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 5781: "$env{'user.domain'}:$env{'user.name'}:". 5782: "rolesdef_$rolename=". 5783: escape($sysrole.'_'.$domrole.'_'.$courole); 5784: return reply($command,$env{'user.home'}); 5785: } else { 5786: return 'refused'; 5787: } 5788: } 5789: 5790: # ---------------- Make a metadata query against the network of library servers 5791: 5792: sub metadata_query { 5793: my ($query,$custom,$customshow,$server_array)=@_; 5794: my %rhash; 5795: my %libserv = &all_library(); 5796: my @server_list = (defined($server_array) ? @$server_array 5797: : keys(%libserv) ); 5798: for my $server (@server_list) { 5799: unless ($custom or $customshow) { 5800: my $reply=&reply("querysend:".&escape($query),$server); 5801: $rhash{$server}=$reply; 5802: } 5803: else { 5804: my $reply=&reply("querysend:".&escape($query).':'. 5805: &escape($custom).':'.&escape($customshow), 5806: $server); 5807: $rhash{$server}=$reply; 5808: } 5809: } 5810: return \%rhash; 5811: } 5812: 5813: # ----------------------------------------- Send log queries and wait for reply 5814: 5815: sub log_query { 5816: my ($uname,$udom,$query,%filters)=@_; 5817: my $uhome=&homeserver($uname,$udom); 5818: if ($uhome eq 'no_host') { return 'error: no_host'; } 5819: my $uhost=&hostname($uhome); 5820: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters))); 5821: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command, 5822: $uhome); 5823: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; } 5824: return get_query_reply($queryid); 5825: } 5826: 5827: # -------------------------- Update MySQL table for portfolio file 5828: 5829: sub update_portfolio_table { 5830: my ($uname,$udom,$file_name,$query,$group,$action) = @_; 5831: if ($group ne '') { 5832: $file_name =~s /^\Q$group\E//; 5833: } 5834: my $homeserver = &homeserver($uname,$udom); 5835: my $queryid= 5836: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group). 5837: ':'.&escape($file_name).':'.$action,$homeserver); 5838: my $reply = &get_query_reply($queryid); 5839: return $reply; 5840: } 5841: 5842: # -------------------------- Update MySQL allusers table 5843: 5844: sub update_allusers_table { 5845: my ($uname,$udom,$names) = @_; 5846: my $homeserver = &homeserver($uname,$udom); 5847: my $queryid= 5848: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'. 5849: 'lastname='.&escape($names->{'lastname'}).'%%'. 5850: 'firstname='.&escape($names->{'firstname'}).'%%'. 5851: 'middlename='.&escape($names->{'middlename'}).'%%'. 5852: 'generation='.&escape($names->{'generation'}).'%%'. 5853: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'. 5854: 'id='.&escape($names->{'id'}),$homeserver); 5855: return; 5856: } 5857: 5858: # ------- Request retrieval of institutional classlists for course(s) 5859: 5860: sub fetch_enrollment_query { 5861: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_; 5862: my $homeserver; 5863: my $maxtries = 1; 5864: if ($context eq 'automated') { 5865: $homeserver = $perlvar{'lonHostID'}; 5866: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout 5867: } else { 5868: $homeserver = &homeserver($cnum,$dom); 5869: } 5870: my $host=&hostname($homeserver); 5871: my $cmd = ''; 5872: foreach my $affiliate (keys(%{$affiliatesref})) { 5873: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 5874: } 5875: $cmd =~ s/%%$//; 5876: $cmd = &escape($cmd); 5877: my $query = 'fetchenrollment'; 5878: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver); 5879: unless ($queryid=~/^\Q$host\E\_/) { 5880: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum); 5881: return 'error: '.$queryid; 5882: } 5883: my $reply = &get_query_reply($queryid); 5884: my $tries = 1; 5885: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 5886: $reply = &get_query_reply($queryid); 5887: $tries ++; 5888: } 5889: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 5890: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 5891: } else { 5892: my @responses = split(/:/,$reply); 5893: if ($homeserver eq $perlvar{'lonHostID'}) { 5894: foreach my $line (@responses) { 5895: my ($key,$value) = split(/=/,$line,2); 5896: $$replyref{$key} = $value; 5897: } 5898: } else { 5899: my $pathname = $perlvar{'lonDaemons'}.'/tmp'; 5900: foreach my $line (@responses) { 5901: my ($key,$value) = split(/=/,$line); 5902: $$replyref{$key} = $value; 5903: if ($value > 0) { 5904: foreach my $item (@{$$affiliatesref{$key}}) { 5905: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml'; 5906: my $destname = $pathname.'/'.$filename; 5907: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver); 5908: if ($xml_classlist =~ /^error/) { 5909: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum); 5910: } else { 5911: if ( open(FILE,">$destname") ) { 5912: print FILE &unescape($xml_classlist); 5913: close(FILE); 5914: } else { 5915: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum); 5916: } 5917: } 5918: } 5919: } 5920: } 5921: } 5922: return 'ok'; 5923: } 5924: return 'error'; 5925: } 5926: 5927: sub get_query_reply { 5928: my $queryid=shift; 5929: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid; 5930: my $reply=''; 5931: for (1..100) { 5932: sleep 2; 5933: if (-e $replyfile.'.end') { 5934: if (open(my $fh,$replyfile)) { 5935: $reply = join('',<$fh>); 5936: close($fh); 5937: } else { return 'error: reply_file_error'; } 5938: return &unescape($reply); 5939: } 5940: } 5941: return 'timeout:'.$queryid; 5942: } 5943: 5944: sub courselog_query { 5945: # 5946: # possible filters: 5947: # url: url or symb 5948: # username 5949: # domain 5950: # action: view, submit, grade 5951: # start: timestamp 5952: # end: timestamp 5953: # 5954: my (%filters)=@_; 5955: unless ($env{'request.course.id'}) { return 'no_course'; } 5956: if ($filters{'url'}) { 5957: $filters{'url'}=&symbclean(&declutter($filters{'url'})); 5958: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/; 5959: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/; 5960: } 5961: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'}; 5962: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'}; 5963: return &log_query($cname,$cdom,'courselog',%filters); 5964: } 5965: 5966: sub userlog_query { 5967: # 5968: # possible filters: 5969: # action: log check role 5970: # start: timestamp 5971: # end: timestamp 5972: # 5973: my ($uname,$udom,%filters)=@_; 5974: return &log_query($uname,$udom,'userlog',%filters); 5975: } 5976: 5977: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course 5978: 5979: sub auto_run { 5980: my ($cnum,$cdom) = @_; 5981: my $response = 0; 5982: my $settings; 5983: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom); 5984: if (ref($domconfig{'autoenroll'}) eq 'HASH') { 5985: $settings = $domconfig{'autoenroll'}; 5986: if ($settings->{'run'} eq '1') { 5987: $response = 1; 5988: } 5989: } else { 5990: my $homeserver; 5991: if (&is_course($cdom,$cnum)) { 5992: $homeserver = &homeserver($cnum,$cdom); 5993: } else { 5994: $homeserver = &domain($cdom,'primary'); 5995: } 5996: if ($homeserver ne 'no_host') { 5997: $response = &reply('autorun:'.$cdom,$homeserver); 5998: } 5999: } 6000: return $response; 6001: } 6002: 6003: sub auto_get_sections { 6004: my ($cnum,$cdom,$inst_coursecode) = @_; 6005: my $homeserver; 6006: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6007: $homeserver = &homeserver($cnum,$cdom); 6008: } 6009: if (!defined($homeserver)) { 6010: if ($cdom =~ /^$match_domain$/) { 6011: $homeserver = &domain($cdom,'primary'); 6012: } 6013: } 6014: my @secs; 6015: if (defined($homeserver)) { 6016: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver)); 6017: unless ($response eq 'refused') { 6018: @secs = split(/:/,$response); 6019: } 6020: } 6021: return @secs; 6022: } 6023: 6024: sub auto_new_course { 6025: my ($cnum,$cdom,$inst_course_id,$owner) = @_; 6026: my $homeserver = &homeserver($cnum,$cdom); 6027: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver)); 6028: return $response; 6029: } 6030: 6031: sub auto_validate_courseID { 6032: my ($cnum,$cdom,$inst_course_id) = @_; 6033: my $homeserver = &homeserver($cnum,$cdom); 6034: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver)); 6035: return $response; 6036: } 6037: 6038: sub auto_validate_instcode { 6039: my ($cnum,$cdom,$instcode,$owner) = @_; 6040: my ($homeserver,$response); 6041: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6042: $homeserver = &homeserver($cnum,$cdom); 6043: } 6044: if (!defined($homeserver)) { 6045: if ($cdom =~ /^$match_domain$/) { 6046: $homeserver = &domain($cdom,'primary'); 6047: } 6048: } 6049: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'. 6050: &escape($instcode).':'.&escape($owner),$homeserver)); 6051: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2); 6052: return ($outcome,$description); 6053: } 6054: 6055: sub auto_create_password { 6056: my ($cnum,$cdom,$authparam,$udom) = @_; 6057: my ($homeserver,$response); 6058: my $create_passwd = 0; 6059: my $authchk = ''; 6060: if ($udom =~ /^$match_domain$/) { 6061: $homeserver = &domain($udom,'primary'); 6062: } 6063: if ($homeserver eq '') { 6064: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) { 6065: $homeserver = &homeserver($cnum,$cdom); 6066: } 6067: } 6068: if ($homeserver eq '') { 6069: $authchk = 'nodomain'; 6070: } else { 6071: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver)); 6072: if ($response eq 'refused') { 6073: $authchk = 'refused'; 6074: } else { 6075: ($authparam,$create_passwd,$authchk) = split(/:/,$response); 6076: } 6077: } 6078: return ($authparam,$create_passwd,$authchk); 6079: } 6080: 6081: sub auto_photo_permission { 6082: my ($cnum,$cdom,$students) = @_; 6083: my $homeserver = &homeserver($cnum,$cdom); 6084: my ($outcome,$perm_reqd,$conditions) = 6085: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3); 6086: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6087: return (undef,undef); 6088: } 6089: return ($outcome,$perm_reqd,$conditions); 6090: } 6091: 6092: sub auto_checkphotos { 6093: my ($uname,$udom,$pid) = @_; 6094: my $homeserver = &homeserver($uname,$udom); 6095: my ($result,$resulttype); 6096: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'. 6097: &escape($uname).':'.&escape($pid), 6098: $homeserver)); 6099: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6100: return (undef,undef); 6101: } 6102: if ($outcome) { 6103: ($result,$resulttype) = split(/:/,$outcome); 6104: } 6105: return ($result,$resulttype); 6106: } 6107: 6108: sub auto_photochoice { 6109: my ($cnum,$cdom) = @_; 6110: my $homeserver = &homeserver($cnum,$cdom); 6111: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'. 6112: &escape($cdom), 6113: $homeserver))); 6114: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) { 6115: return (undef,undef); 6116: } 6117: return ($update,$comment); 6118: } 6119: 6120: sub auto_photoupdate { 6121: my ($affiliatesref,$dom,$cnum,$photo) = @_; 6122: my $homeserver = &homeserver($cnum,$dom); 6123: my $host=&hostname($homeserver); 6124: my $cmd = ''; 6125: my $maxtries = 1; 6126: foreach my $affiliate (keys(%{$affiliatesref})) { 6127: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%'; 6128: } 6129: $cmd =~ s/%%$//; 6130: $cmd = &escape($cmd); 6131: my $query = 'institutionalphotos'; 6132: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver); 6133: unless ($queryid=~/^\Q$host\E\_/) { 6134: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum); 6135: return 'error: '.$queryid; 6136: } 6137: my $reply = &get_query_reply($queryid); 6138: my $tries = 1; 6139: while (($reply=~/^timeout/) && ($tries < $maxtries)) { 6140: $reply = &get_query_reply($queryid); 6141: $tries ++; 6142: } 6143: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) { 6144: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries); 6145: } else { 6146: my @responses = split(/:/,$reply); 6147: my $outcome = shift(@responses); 6148: foreach my $item (@responses) { 6149: my ($key,$value) = split(/=/,$item); 6150: $$photo{$key} = $value; 6151: } 6152: return $outcome; 6153: } 6154: return 'error'; 6155: } 6156: 6157: sub auto_instcode_format { 6158: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles, 6159: $cat_order) = @_; 6160: my $courses = ''; 6161: my @homeservers; 6162: if ($caller eq 'global') { 6163: my %servers = &get_servers($codedom,'library'); 6164: foreach my $tryserver (keys(%servers)) { 6165: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6166: push(@homeservers,$tryserver); 6167: } 6168: } 6169: } elsif ($caller eq 'requests') { 6170: if ($codedom =~ /^$match_domain$/) { 6171: my $chome = &domain($codedom,'primary'); 6172: unless ($chome eq 'no_host') { 6173: push(@homeservers,$chome); 6174: } 6175: } 6176: } else { 6177: push(@homeservers,&homeserver($caller,$codedom)); 6178: } 6179: foreach my $code (keys(%{$instcodes})) { 6180: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&'; 6181: } 6182: chop($courses); 6183: my $ok_response = 0; 6184: my $response; 6185: while (@homeservers > 0 && $ok_response == 0) { 6186: my $server = shift(@homeservers); 6187: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server); 6188: if ($response !~ /(con_lost|error|no_such_host|refused)/) { 6189: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = 6190: split(/:/,$response); 6191: %{$codes} = (%{$codes},&str2hash($codes_str)); 6192: push(@{$codetitles},&str2array($codetitles_str)); 6193: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str)); 6194: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str)); 6195: $ok_response = 1; 6196: } 6197: } 6198: if ($ok_response) { 6199: return 'ok'; 6200: } else { 6201: return $response; 6202: } 6203: } 6204: 6205: sub auto_instcode_defaults { 6206: my ($domain,$returnhash,$code_order) = @_; 6207: my @homeservers; 6208: 6209: my %servers = &get_servers($domain,'library'); 6210: foreach my $tryserver (keys(%servers)) { 6211: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6212: push(@homeservers,$tryserver); 6213: } 6214: } 6215: 6216: my $response; 6217: foreach my $server (@homeservers) { 6218: $response=&reply('autoinstcodedefaults:'.$domain,$server); 6219: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 6220: 6221: foreach my $pair (split(/\&/,$response)) { 6222: my ($name,$value)=split(/\=/,$pair); 6223: if ($name eq 'code_order') { 6224: @{$code_order} = split(/\&/,&unescape($value)); 6225: } else { 6226: $returnhash->{&unescape($name)}=&unescape($value); 6227: } 6228: } 6229: return 'ok'; 6230: } 6231: 6232: return $response; 6233: } 6234: 6235: sub auto_possible_instcodes { 6236: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_; 6237: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') && 6238: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) { 6239: return; 6240: } 6241: my (@homeservers,$uhome); 6242: if (defined(&domain($domain,'primary'))) { 6243: $uhome=&domain($domain,'primary'); 6244: push(@homeservers,&domain($domain,'primary')); 6245: } else { 6246: my %servers = &get_servers($domain,'library'); 6247: foreach my $tryserver (keys(%servers)) { 6248: if (!grep(/^\Q$tryserver\E$/,@homeservers)) { 6249: push(@homeservers,$tryserver); 6250: } 6251: } 6252: } 6253: my $response; 6254: foreach my $server (@homeservers) { 6255: $response=&reply('autopossibleinstcodes:'.$domain,$server); 6256: next if ($response =~ /(con_lost|error|no_such_host|refused)/); 6257: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) = 6258: split(':',$response); 6259: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr)); 6260: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr)); 6261: foreach my $item (split('&',$cat_title)) { 6262: my ($name,$value)=split('=',$item); 6263: $cat_titles->{&unescape($name)}=&thaw_unescape($value); 6264: } 6265: foreach my $item (split('&',$cat_order)) { 6266: my ($name,$value)=split('=',$item); 6267: $cat_orders->{&unescape($name)}=&thaw_unescape($value); 6268: } 6269: return 'ok'; 6270: } 6271: return $response; 6272: } 6273: 6274: sub auto_courserequest_checks { 6275: my ($dom) = @_; 6276: my ($homeserver,%validations); 6277: if ($dom =~ /^$match_domain$/) { 6278: $homeserver = &domain($dom,'primary'); 6279: } 6280: unless ($homeserver eq 'no_host') { 6281: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver); 6282: unless ($response =~ /(con_lost|error|no_such_host|refused)/) { 6283: my @items = split(/&/,$response); 6284: foreach my $item (@items) { 6285: my ($key,$value) = split('=',$item); 6286: $validations{&unescape($key)} = &thaw_unescape($value); 6287: } 6288: } 6289: } 6290: return %validations; 6291: } 6292: 6293: sub auto_courserequest_validation { 6294: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_; 6295: my ($homeserver,$response); 6296: if ($dom =~ /^$match_domain$/) { 6297: $homeserver = &domain($dom,'primary'); 6298: } 6299: unless ($homeserver eq 'no_host') { 6300: 6301: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner). 6302: ':'.&escape($crstype).':'.&escape($inststatuslist). 6303: ':'.&escape($instcode).':'.&escape($instseclist), 6304: $homeserver)); 6305: } 6306: return $response; 6307: } 6308: 6309: sub auto_validate_class_sec { 6310: my ($cdom,$cnum,$owners,$inst_class) = @_; 6311: my $homeserver = &homeserver($cnum,$cdom); 6312: my $ownerlist; 6313: if (ref($owners) eq 'ARRAY') { 6314: $ownerlist = join(',',@{$owners}); 6315: } else { 6316: $ownerlist = $owners; 6317: } 6318: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'. 6319: &escape($ownerlist).':'.$cdom,$homeserver); 6320: return $response; 6321: } 6322: 6323: # ------------------------------------------------------- Course Group routines 6324: 6325: sub get_coursegroups { 6326: my ($cdom,$cnum,$group,$namespace) = @_; 6327: return(&dump($namespace,$cdom,$cnum,$group)); 6328: } 6329: 6330: sub modify_coursegroup { 6331: my ($cdom,$cnum,$groupsettings) = @_; 6332: return(&put('coursegroups',$groupsettings,$cdom,$cnum)); 6333: } 6334: 6335: sub toggle_coursegroup_status { 6336: my ($cdom,$cnum,$group,$action) = @_; 6337: my ($from_namespace,$to_namespace); 6338: if ($action eq 'delete') { 6339: $from_namespace = 'coursegroups'; 6340: $to_namespace = 'deleted_groups'; 6341: } else { 6342: $from_namespace = 'deleted_groups'; 6343: $to_namespace = 'coursegroups'; 6344: } 6345: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace); 6346: if (my $tmp = &error(%curr_group)) { 6347: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom); 6348: return ('read error',$tmp); 6349: } else { 6350: my %savedsettings = %curr_group; 6351: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum); 6352: my $deloutcome; 6353: if ($result eq 'ok') { 6354: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum); 6355: } else { 6356: return ('write error',$result); 6357: } 6358: if ($deloutcome eq 'ok') { 6359: return 'ok'; 6360: } else { 6361: return ('delete error',$deloutcome); 6362: } 6363: } 6364: } 6365: 6366: sub modify_group_roles { 6367: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_; 6368: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id; 6369: my $role = 'gr/'.&escape($userprivs); 6370: my ($uname,$udom) = split(/:/,$user); 6371: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context); 6372: if ($result eq 'ok') { 6373: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum); 6374: } 6375: return $result; 6376: } 6377: 6378: sub modify_coursegroup_membership { 6379: my ($cdom,$cnum,$membership) = @_; 6380: my $result = &put('groupmembership',$membership,$cdom,$cnum); 6381: return $result; 6382: } 6383: 6384: sub get_active_groups { 6385: my ($udom,$uname,$cdom,$cnum) = @_; 6386: my $now = time; 6387: my %groups = (); 6388: foreach my $key (keys(%env)) { 6389: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) { 6390: my ($start,$end) = split(/\./,$env{$key}); 6391: if (($end!=0) && ($end<$now)) { next; } 6392: if (($start!=0) && ($start>$now)) { next; } 6393: if ($1 eq $cdom && $2 eq $cnum) { 6394: $groups{$3} = $env{$key} ; 6395: } 6396: } 6397: } 6398: return %groups; 6399: } 6400: 6401: sub get_group_membership { 6402: my ($cdom,$cnum,$group) = @_; 6403: return(&dump('groupmembership',$cdom,$cnum,$group)); 6404: } 6405: 6406: sub get_users_groups { 6407: my ($udom,$uname,$courseid) = @_; 6408: my @usersgroups; 6409: my $cachetime=1800; 6410: 6411: my $hashid="$udom:$uname:$courseid"; 6412: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid); 6413: if (defined($cached)) { 6414: @usersgroups = split(/:/,$grouplist); 6415: } else { 6416: $grouplist = ''; 6417: my $courseurl = &courseid_to_courseurl($courseid); 6418: my $extra = &freeze_escape({'skipcheck' => 1}); 6419: my %roleshash = &dump('roles',$udom,$uname,$courseurl,undef,$extra); 6420: my $access_end = $env{'course.'.$courseid. 6421: '.default_enrollment_end_date'}; 6422: my $now = time; 6423: foreach my $key (keys(%roleshash)) { 6424: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) { 6425: my $group = $1; 6426: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) { 6427: my $start = $2; 6428: my $end = $1; 6429: if ($start == -1) { next; } # deleted from group 6430: if (($start!=0) && ($start>$now)) { next; } 6431: if (($end!=0) && ($end<$now)) { 6432: if ($access_end && $access_end < $now) { 6433: if ($access_end - $end < 86400) { 6434: push(@usersgroups,$group); 6435: } 6436: } 6437: next; 6438: } 6439: push(@usersgroups,$group); 6440: } 6441: } 6442: } 6443: @usersgroups = &sort_course_groups($courseid,@usersgroups); 6444: $grouplist = join(':',@usersgroups); 6445: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime); 6446: } 6447: return @usersgroups; 6448: } 6449: 6450: sub devalidate_getgroups_cache { 6451: my ($udom,$uname,$cdom,$cnum)=@_; 6452: my $courseid = $cdom.'_'.$cnum; 6453: 6454: my $hashid="$udom:$uname:$courseid"; 6455: &devalidate_cache_new('getgroups',$hashid); 6456: } 6457: 6458: # ------------------------------------------------------------------ Plain Text 6459: 6460: sub plaintext { 6461: my ($short,$type,$cid,$forcedefault) = @_; 6462: if ($short =~ m{^cr/}) { 6463: return (split('/',$short))[-1]; 6464: } 6465: if (!defined($cid)) { 6466: $cid = $env{'request.course.id'}; 6467: } 6468: my %rolenames = ( 6469: Course => 'std', 6470: Community => 'alt1', 6471: ); 6472: if ($cid ne '') { 6473: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') { 6474: unless ($forcedefault) { 6475: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'}; 6476: &Apache::lonlocal::mt_escape(\$roletext); 6477: return &Apache::lonlocal::mt($roletext); 6478: } 6479: } 6480: } 6481: if ((defined($type)) && (defined($rolenames{$type})) && 6482: (defined($rolenames{$type})) && 6483: (defined($prp{$short}{$rolenames{$type}}))) { 6484: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}}); 6485: } elsif ($cid ne '') { 6486: my $crstype = $env{'course.'.$cid.'.type'}; 6487: if (($crstype ne '') && (defined($rolenames{$crstype})) && 6488: (defined($prp{$short}{$rolenames{$crstype}}))) { 6489: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}}); 6490: } 6491: } 6492: return &Apache::lonlocal::mt($prp{$short}{'std'}); 6493: } 6494: 6495: # ----------------------------------------------------------------- Assign Role 6496: 6497: sub assignrole { 6498: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll, 6499: $context)=@_; 6500: my $mrole; 6501: if ($role =~ /^cr\//) { 6502: my $cwosec=$url; 6503: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6504: unless (&allowed('ccr',$cwosec)) { 6505: my $refused = 1; 6506: if ($context eq 'requestcourses') { 6507: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) { 6508: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) { 6509: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) { 6510: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6511: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6512: if ($crsenv{'internal.courseowner'} eq 6513: $env{'user.name'}.':'.$env{'user.domain'}) { 6514: $refused = ''; 6515: } 6516: } 6517: } 6518: } 6519: } 6520: if ($refused) { 6521: &logthis('Refused custom assignrole: '. 6522: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start. 6523: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}); 6524: return 'refused'; 6525: } 6526: } 6527: $mrole='cr'; 6528: } elsif ($role =~ /^gr\//) { 6529: my $cwogrp=$url; 6530: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2}; 6531: unless (&allowed('mdg',$cwogrp)) { 6532: &logthis('Refused group assignrole: '. 6533: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '. 6534: $env{'user.name'}.' at '.$env{'user.domain'}); 6535: return 'refused'; 6536: } 6537: $mrole='gr'; 6538: } else { 6539: my $cwosec=$url; 6540: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/; 6541: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) { 6542: my $refused; 6543: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) { 6544: if (!(&allowed('c'.$role,$url))) { 6545: $refused = 1; 6546: } 6547: } else { 6548: $refused = 1; 6549: } 6550: if ($refused) { 6551: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$}); 6552: if (!$selfenroll && $context eq 'course') { 6553: my %crsenv; 6554: if ($role eq 'cc' || $role eq 'co') { 6555: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6556: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) { 6557: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) { 6558: if ($crsenv{'internal.courseowner'} eq 6559: $env{'user.name'}.':'.$env{'user.domain'}) { 6560: $refused = ''; 6561: } 6562: } 6563: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) { 6564: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) { 6565: if ($crsenv{'internal.courseowner'} eq 6566: $env{'user.name'}.':'.$env{'user.domain'}) { 6567: $refused = ''; 6568: } 6569: } 6570: } 6571: } 6572: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) { 6573: $refused = ''; 6574: } elsif ($context eq 'requestcourses') { 6575: my @possroles = ('st','ta','ep','in','cc','co'); 6576: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) { 6577: my $wrongcc; 6578: if ($cnum =~ /^$match_community$/) { 6579: $wrongcc = 1 if ($role eq 'cc'); 6580: } else { 6581: $wrongcc = 1 if ($role eq 'co'); 6582: } 6583: unless ($wrongcc) { 6584: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner')); 6585: if ($crsenv{'internal.courseowner'} eq 6586: $env{'user.name'}.':'.$env{'user.domain'}) { 6587: $refused = ''; 6588: } 6589: } 6590: } 6591: } 6592: if ($refused) { 6593: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url. 6594: ' '.$role.' '.$end.' '.$start.' by '. 6595: $env{'user.name'}.' at '.$env{'user.domain'}); 6596: return 'refused'; 6597: } 6598: } 6599: } 6600: $mrole=$role; 6601: } 6602: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:". 6603: "$udom:$uname:$url".'_'."$mrole=$role"; 6604: if ($end) { $command.='_'.$end; } 6605: if ($start) { 6606: if ($end) { 6607: $command.='_'.$start; 6608: } else { 6609: $command.='_0_'.$start; 6610: } 6611: } 6612: my $origstart = $start; 6613: my $origend = $end; 6614: my $delflag; 6615: # actually delete 6616: if ($deleteflag) { 6617: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) { 6618: # modify command to delete the role 6619: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:". 6620: "$udom:$uname:$url".'_'."$mrole"; 6621: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom"); 6622: # set start and finish to negative values for userrolelog 6623: $start=-1; 6624: $end=-1; 6625: $delflag = 1; 6626: } 6627: } 6628: # send command 6629: my $answer=&reply($command,&homeserver($uname,$udom)); 6630: # log new user role if status is ok 6631: if ($answer eq 'ok') { 6632: &userrolelog($role,$uname,$udom,$url,$start,$end); 6633: # for course roles, perform group memberships changes triggered by role change. 6634: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context); 6635: unless ($role =~ /^gr/) { 6636: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend, 6637: $origstart,$selfenroll,$context); 6638: } 6639: if ($role eq 'cc') { 6640: &autoupdate_coowners($url,$end,$start,$uname,$udom); 6641: } 6642: } 6643: return $answer; 6644: } 6645: 6646: sub autoupdate_coowners { 6647: my ($url,$end,$start,$uname,$udom) = @_; 6648: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)}); 6649: if (($cdom ne '') && ($cnum ne '')) { 6650: my $now = time; 6651: my %domdesign = &Apache::loncommon::get_domainconf($cdom); 6652: if ($domdesign{$cdom.'.autoassign.co-owners'}) { 6653: my %coursehash = &coursedescription($cdom.'_'.$cnum); 6654: my $instcode = $coursehash{'internal.coursecode'}; 6655: if ($instcode ne '') { 6656: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) { 6657: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) { 6658: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners); 6659: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom); 6660: if ($result eq 'valid') { 6661: if ($coursehash{'internal.co-owners'}) { 6662: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) { 6663: push(@newcoowners,$coowner); 6664: } 6665: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) { 6666: push(@newcoowners,$uname.':'.$udom); 6667: } 6668: @newcoowners = sort(@newcoowners); 6669: } else { 6670: push(@newcoowners,$uname.':'.$udom); 6671: } 6672: } else { 6673: if ($coursehash{'internal.co-owners'}) { 6674: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) { 6675: unless ($coowner eq $uname.':'.$udom) { 6676: push(@newcoowners,$coowner); 6677: } 6678: } 6679: unless (@newcoowners > 0) { 6680: $delcoowners = 1; 6681: $coowners = ''; 6682: } 6683: } 6684: } 6685: if (@newcoowners || $delcoowners) { 6686: &store_coowners($cdom,$cnum,$coursehash{'home'}, 6687: $delcoowners,@newcoowners); 6688: } 6689: } 6690: } 6691: } 6692: } 6693: } 6694: } 6695: 6696: sub store_coowners { 6697: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_; 6698: my $cid = $cdom.'_'.$cnum; 6699: my ($coowners,$delresult,$putresult); 6700: if (@newcoowners) { 6701: $coowners = join(',',@newcoowners); 6702: my %coownershash = ( 6703: 'internal.co-owners' => $coowners, 6704: ); 6705: $putresult = &put('environment',\%coownershash,$cdom,$cnum); 6706: if ($putresult eq 'ok') { 6707: if ($env{'course.'.$cid.'.num'} eq $cnum) { 6708: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners}); 6709: } 6710: } 6711: } 6712: if ($delcoowners) { 6713: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum); 6714: if ($delresult eq 'ok') { 6715: if ($env{'course.'.$cid.'.internal.co-owners'}) { 6716: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners'); 6717: } 6718: } 6719: } 6720: if (($putresult eq 'ok') || ($delresult eq 'ok')) { 6721: my %crsinfo = 6722: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.'); 6723: if (ref($crsinfo{$cid}) eq 'HASH') { 6724: $crsinfo{$cid}{'co-owners'} = \@newcoowners; 6725: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime'); 6726: } 6727: } 6728: } 6729: 6730: # -------------------------------------------------- Modify user authentication 6731: # Overrides without validation 6732: 6733: sub modifyuserauth { 6734: my ($udom,$uname,$umode,$upass)=@_; 6735: my $uhome=&homeserver($uname,$udom); 6736: unless (&allowed('mau',$udom)) { return 'refused'; } 6737: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '. 6738: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6739: ' in domain '.$env{'request.role.domain'}); 6740: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'. 6741: &escape($upass),$uhome); 6742: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'}, 6743: 'Authentication changed for '.$udom.', '.$uname.', '.$umode. 6744: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6745: &log($udom,,$uname,$uhome, 6746: 'Authentication changed by '.$env{'user.domain'}.', '. 6747: $env{'user.name'}.', '.$umode. 6748: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply); 6749: unless ($reply eq 'ok') { 6750: &logthis('Authentication mode error: '.$reply); 6751: return 'error: '.$reply; 6752: } 6753: return 'ok'; 6754: } 6755: 6756: # --------------------------------------------------------------- Modify a user 6757: 6758: sub modifyuser { 6759: my ($udom, $uname, $uid, 6760: $umode, $upass, $first, 6761: $middle, $last, $gene, 6762: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_; 6763: $udom= &LONCAPA::clean_domain($udom); 6764: $uname=&LONCAPA::clean_username($uname); 6765: my $showcandelete = 'none'; 6766: if (ref($candelete) eq 'ARRAY') { 6767: if (@{$candelete} > 0) { 6768: $showcandelete = join(', ',@{$candelete}); 6769: } 6770: } 6771: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '. 6772: $umode.', '.$first.', '.$middle.', '. 6773: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'. 6774: (defined($desiredhome) ? ' desiredhome = '.$desiredhome : 6775: ' desiredhome not specified'). 6776: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}. 6777: ' in domain '.$env{'request.role.domain'}); 6778: my $uhome=&homeserver($uname,$udom,'true'); 6779: my $newuser; 6780: if ($uhome eq 'no_host') { 6781: $newuser = 1; 6782: } 6783: # ----------------------------------------------------------------- Create User 6784: if (($uhome eq 'no_host') && 6785: (($umode && $upass) || ($umode eq 'localauth'))) { 6786: my $unhome=''; 6787: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) { 6788: $unhome = $desiredhome; 6789: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) { 6790: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'}; 6791: } else { # load balancing routine for determining $unhome 6792: my $loadm=10000000; 6793: my %servers = &get_servers($udom,'library'); 6794: foreach my $tryserver (keys(%servers)) { 6795: my $answer=reply('load',$tryserver); 6796: if (($answer=~/\d+/) && ($answer<$loadm)) { 6797: $loadm=$answer; 6798: $unhome=$tryserver; 6799: } 6800: } 6801: } 6802: if (($unhome eq '') || ($unhome eq 'no_host')) { 6803: return 'error: unable to find a home server for '.$uname. 6804: ' in domain '.$udom; 6805: } 6806: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'. 6807: &escape($upass),$unhome); 6808: unless ($reply eq 'ok') { 6809: return 'error: '.$reply; 6810: } 6811: $uhome=&homeserver($uname,$udom,'true'); 6812: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) { 6813: return 'error: unable verify users home machine.'; 6814: } 6815: } # End of creation of new user 6816: # ---------------------------------------------------------------------- Add ID 6817: if ($uid) { 6818: $uid=~tr/A-Z/a-z/; 6819: my %uidhash=&idrget($udom,$uname); 6820: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/) 6821: && (!$forceid)) { 6822: unless ($uid eq $uidhash{$uname}) { 6823: return 'error: user id "'.$uid.'" does not match '. 6824: 'current user id "'.$uidhash{$uname}.'".'; 6825: } 6826: } else { 6827: &idput($udom,($uname => $uid)); 6828: } 6829: } 6830: # -------------------------------------------------------------- Add names, etc 6831: my @tmp=&get('environment', 6832: ['firstname','middlename','lastname','generation','id', 6833: 'permanentemail','inststatus'], 6834: $udom,$uname); 6835: my (%names,%oldnames); 6836: if ($tmp[0] =~ m/^error:.*/) { 6837: %names=(); 6838: } else { 6839: %names = @tmp; 6840: %oldnames = %names; 6841: } 6842: # 6843: # If name, email and/or uid are blank (e.g., because an uploaded file 6844: # of users did not contain them), do not overwrite existing values 6845: # unless field is in $candelete array ref. 6846: # 6847: 6848: my @fields = ('firstname','middlename','lastname','generation', 6849: 'permanentemail','id'); 6850: my %newvalues; 6851: if (ref($candelete) eq 'ARRAY') { 6852: foreach my $field (@fields) { 6853: if (grep(/^\Q$field\E$/,@{$candelete})) { 6854: if ($field eq 'firstname') { 6855: $names{$field} = $first; 6856: } elsif ($field eq 'middlename') { 6857: $names{$field} = $middle; 6858: } elsif ($field eq 'lastname') { 6859: $names{$field} = $last; 6860: } elsif ($field eq 'generation') { 6861: $names{$field} = $gene; 6862: } elsif ($field eq 'permanentemail') { 6863: $names{$field} = $email; 6864: } elsif ($field eq 'id') { 6865: $names{$field} = $uid; 6866: } 6867: } 6868: } 6869: } 6870: if ($first) { $names{'firstname'} = $first; } 6871: if (defined($middle)) { $names{'middlename'} = $middle; } 6872: if ($last) { $names{'lastname'} = $last; } 6873: if (defined($gene)) { $names{'generation'} = $gene; } 6874: if ($email) { 6875: $email=~s/[^\w\@\.\-\,]//gs; 6876: if ($email=~/\@/) { $names{'permanentemail'} = $email; } 6877: } 6878: if ($uid) { $names{'id'} = $uid; } 6879: if (defined($inststatus)) { 6880: $names{'inststatus'} = ''; 6881: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom); 6882: if (ref($usertypes) eq 'HASH') { 6883: my @okstatuses; 6884: foreach my $item (split(/:/,$inststatus)) { 6885: if (defined($usertypes->{$item})) { 6886: push(@okstatuses,$item); 6887: } 6888: } 6889: if (@okstatuses) { 6890: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses); 6891: } 6892: } 6893: } 6894: my $logmsg = $udom.', '.$uname.', '.$uid.', '. 6895: $umode.', '.$first.', '.$middle.', '. 6896: $last.', '.$gene.', '.$email.', '.$inststatus; 6897: if ($env{'user.name'} ne '' && $env{'user.domain'}) { 6898: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'}; 6899: } else { 6900: $logmsg .= ' during self creation'; 6901: } 6902: my $changed; 6903: if ($newuser) { 6904: $changed = 1; 6905: } else { 6906: foreach my $field (@fields) { 6907: if ($names{$field} ne $oldnames{$field}) { 6908: $changed = 1; 6909: last; 6910: } 6911: } 6912: } 6913: unless ($changed) { 6914: $logmsg = 'No changes in user information needed for: '.$logmsg; 6915: &logthis($logmsg); 6916: return 'ok'; 6917: } 6918: my $reply = &put('environment', \%names, $udom,$uname); 6919: if ($reply ne 'ok') { 6920: return 'error: '.$reply; 6921: } 6922: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) { 6923: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom); 6924: } 6925: my $sqlresult = &update_allusers_table($uname,$udom,\%names); 6926: &devalidate_cache_new('namescache',$uname.':'.$udom); 6927: $logmsg = 'Success modifying user '.$logmsg; 6928: &logthis($logmsg); 6929: return 'ok'; 6930: } 6931: 6932: # -------------------------------------------------------------- Modify student 6933: 6934: sub modifystudent { 6935: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec, 6936: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid, 6937: $selfenroll,$context,$inststatus)=@_; 6938: if (!$cid) { 6939: unless ($cid=$env{'request.course.id'}) { 6940: return 'not_in_class'; 6941: } 6942: } 6943: # --------------------------------------------------------------- Make the user 6944: my $reply=&modifyuser 6945: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid, 6946: $desiredhome,$email,$inststatus); 6947: unless ($reply eq 'ok') { return $reply; } 6948: # This will cause &modify_student_enrollment to get the uid from the 6949: # students environment 6950: $uid = undef if (!$forceid); 6951: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last, 6952: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context); 6953: return $reply; 6954: } 6955: 6956: sub modify_student_enrollment { 6957: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_; 6958: my ($cdom,$cnum,$chome); 6959: if (!$cid) { 6960: unless ($cid=$env{'request.course.id'}) { 6961: return 'not_in_class'; 6962: } 6963: $cdom=$env{'course.'.$cid.'.domain'}; 6964: $cnum=$env{'course.'.$cid.'.num'}; 6965: } else { 6966: ($cdom,$cnum)=split(/_/,$cid); 6967: } 6968: $chome=$env{'course.'.$cid.'.home'}; 6969: if (!$chome) { 6970: $chome=&homeserver($cnum,$cdom); 6971: } 6972: if (!$chome) { return 'unknown_course'; } 6973: # Make sure the user exists 6974: my $uhome=&homeserver($uname,$udom); 6975: if (($uhome eq '') || ($uhome eq 'no_host')) { 6976: return 'error: no such user'; 6977: } 6978: # Get student data if we were not given enough information 6979: if (!defined($first) || $first eq '' || 6980: !defined($last) || $last eq '' || 6981: !defined($uid) || $uid eq '' || 6982: !defined($middle) || $middle eq '' || 6983: !defined($gene) || $gene eq '') { 6984: # They did not supply us with enough data to enroll the student, so 6985: # we need to pick up more information. 6986: my %tmp = &get('environment', 6987: ['firstname','middlename','lastname', 'generation','id'] 6988: ,$udom,$uname); 6989: 6990: #foreach my $key (keys(%tmp)) { 6991: # &logthis("key $key = ".$tmp{$key}); 6992: #} 6993: $first = $tmp{'firstname'} if (!defined($first) || $first eq ''); 6994: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq ''); 6995: $last = $tmp{'lastname'} if (!defined($last) || $last eq ''); 6996: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq ''); 6997: $uid = $tmp{'id'} if (!defined($uid) || $uid eq ''); 6998: } 6999: my $fullname = &format_name($first,$middle,$last,$gene,'lastname'); 7000: my $reply=cput('classlist', 7001: {"$uname:$udom" => 7002: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) }, 7003: $cdom,$cnum); 7004: unless (($reply eq 'ok') || ($reply eq 'delayed')) { 7005: return 'error: '.$reply; 7006: } else { 7007: &devalidate_getsection_cache($udom,$uname,$cid); 7008: } 7009: # Add student role to user 7010: my $uurl='/'.$cid; 7011: $uurl=~s/\_/\//g; 7012: if ($usec) { 7013: $uurl.='/'.$usec; 7014: } 7015: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context); 7016: } 7017: 7018: sub format_name { 7019: my ($firstname,$middlename,$lastname,$generation,$first)=@_; 7020: my $name; 7021: if ($first ne 'lastname') { 7022: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation; 7023: } else { 7024: if ($lastname=~/\S/) { 7025: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename; 7026: $name=~s/\s+,/,/; 7027: } else { 7028: $name.= $firstname.' '.$middlename.' '.$generation; 7029: } 7030: } 7031: $name=~s/^\s+//; 7032: $name=~s/\s+$//; 7033: $name=~s/\s+/ /g; 7034: return $name; 7035: } 7036: 7037: # ------------------------------------------------- Write to course preferences 7038: 7039: sub writecoursepref { 7040: my ($courseid,%prefs)=@_; 7041: $courseid=~s/^\///; 7042: $courseid=~s/\_/\//g; 7043: my ($cdomain,$cnum)=split(/\//,$courseid); 7044: my $chome=homeserver($cnum,$cdomain); 7045: if (($chome eq '') || ($chome eq 'no_host')) { 7046: return 'error: no such course'; 7047: } 7048: my $cstring=''; 7049: foreach my $pref (keys(%prefs)) { 7050: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&'; 7051: } 7052: $cstring=~s/\&$//; 7053: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome); 7054: } 7055: 7056: # ---------------------------------------------------------- Make/modify course 7057: 7058: sub createcourse { 7059: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code, 7060: $course_owner,$crstype,$cnum,$context,$category)=@_; 7061: $url=&declutter($url); 7062: my $cid=''; 7063: if ($context eq 'requestcourses') { 7064: my $can_create = 0; 7065: my ($ownername,$ownerdom) = split(':',$course_owner); 7066: if ($udom eq $ownerdom) { 7067: if (&usertools_access($ownername,$ownerdom,$category,undef, 7068: $context)) { 7069: $can_create = 1; 7070: } 7071: } else { 7072: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'. 7073: $category); 7074: if ($userenv{'reqcrsotherdom.'.$category} ne '') { 7075: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category}); 7076: if (@curr > 0) { 7077: my @options = qw(approval validate autolimit); 7078: my $optregex = join('|',@options); 7079: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) { 7080: $can_create = 1; 7081: } 7082: } 7083: } 7084: } 7085: if ($can_create) { 7086: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) { 7087: unless (&allowed('ccc',$udom)) { 7088: return 'refused'; 7089: } 7090: } 7091: } else { 7092: return 'refused'; 7093: } 7094: } elsif (!&allowed('ccc',$udom)) { 7095: return 'refused'; 7096: } 7097: # --------------------------------------------------------------- Get Unique ID 7098: my $uname; 7099: if ($cnum =~ /^$match_courseid$/) { 7100: my $chome=&homeserver($cnum,$udom,'true'); 7101: if (($chome eq '') || ($chome eq 'no_host')) { 7102: $uname = $cnum; 7103: } else { 7104: $uname = &generate_coursenum($udom,$crstype); 7105: } 7106: } else { 7107: $uname = &generate_coursenum($udom,$crstype); 7108: } 7109: return $uname if ($uname =~ /^error/); 7110: # -------------------------------------------------- Check supplied server name 7111: if (!defined($course_server)) { 7112: if (defined(&domain($udom,'primary'))) { 7113: $course_server = &domain($udom,'primary'); 7114: } else { 7115: $course_server = $env{'user.home'}; 7116: } 7117: } 7118: my %host_servers = 7119: &Apache::lonnet::get_servers($udom,'library'); 7120: unless ($host_servers{$course_server}) { 7121: return 'error: invalid home server for course: '.$course_server; 7122: } 7123: # ------------------------------------------------------------- Make the course 7124: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::', 7125: $course_server); 7126: unless ($reply eq 'ok') { return 'error: '.$reply; } 7127: my $uhome=&homeserver($uname,$udom,'true'); 7128: if (($uhome eq '') || ($uhome eq 'no_host')) { 7129: return 'error: no such course'; 7130: } 7131: # ----------------------------------------------------------------- Course made 7132: # log existence 7133: my $now = time; 7134: my $newcourse = { 7135: $udom.'_'.$uname => { 7136: description => $description, 7137: inst_code => $inst_code, 7138: owner => $course_owner, 7139: type => $crstype, 7140: creator => $env{'user.name'}.':'. 7141: $env{'user.domain'}, 7142: created => $now, 7143: context => $context, 7144: }, 7145: }; 7146: &courseidput($udom,$newcourse,$uhome,'notime'); 7147: # set toplevel url 7148: my $topurl=$url; 7149: unless ($nonstandard) { 7150: # ------------------------------------------ For standard courses, make top url 7151: my $mapurl=&clutter($url); 7152: if ($mapurl eq '/res/') { $mapurl=''; } 7153: $env{'form.initmap'}=(<<ENDINITMAP); 7154: <map> 7155: <resource id="1" type="start"></resource> 7156: <resource id="2" src="$mapurl"></resource> 7157: <resource id="3" type="finish"></resource> 7158: <link index="1" from="1" to="2"></link> 7159: <link index="2" from="2" to="3"></link> 7160: </map> 7161: ENDINITMAP 7162: $topurl=&declutter( 7163: &finishuserfileupload($uname,$udom,'initmap','default.sequence') 7164: ); 7165: } 7166: # ----------------------------------------------------------- Write preferences 7167: &writecoursepref($udom.'_'.$uname, 7168: ('description' => $description, 7169: 'url' => $topurl, 7170: 'internal.creator' => $env{'user.name'}.':'. 7171: $env{'user.domain'}, 7172: 'internal.created' => $now, 7173: 'internal.creationcontext' => $context) 7174: ); 7175: return '/'.$udom.'/'.$uname; 7176: } 7177: 7178: # ------------------------------------------------------------------- Create ID 7179: sub generate_coursenum { 7180: my ($udom,$crstype) = @_; 7181: my $domdesc = &domain($udom); 7182: return 'error: invalid domain' if ($domdesc eq ''); 7183: my $first; 7184: if ($crstype eq 'Community') { 7185: $first = '0'; 7186: } else { 7187: $first = int(1+rand(9)); 7188: } 7189: my $uname=$first. 7190: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 7191: substr($$.time,0,5).unpack("H8",pack("I32",time)). 7192: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 7193: # ----------------------------------------------- Make sure that does not exist 7194: my $uhome=&homeserver($uname,$udom,'true'); 7195: unless (($uhome eq '') || ($uhome eq 'no_host')) { 7196: if ($crstype eq 'Community') { 7197: $first = '0'; 7198: } else { 7199: $first = int(1+rand(9)); 7200: } 7201: $uname=$first. 7202: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))]. 7203: substr($$.time,0,5).unpack("H8",pack("I32",time)). 7204: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'}; 7205: $uhome=&homeserver($uname,$udom,'true'); 7206: unless (($uhome eq '') || ($uhome eq 'no_host')) { 7207: return 'error: unable to generate unique course-ID'; 7208: } 7209: } 7210: return $uname; 7211: } 7212: 7213: sub is_course { 7214: my ($cdom,$cnum) = @_; 7215: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef, 7216: undef,'.'); 7217: if (exists($courses{$cdom.'_'.$cnum})) { 7218: return 1; 7219: } 7220: return 0; 7221: } 7222: 7223: sub store_userdata { 7224: my ($storehash,$datakey,$namespace,$udom,$uname) = @_; 7225: my $result; 7226: if ($datakey ne '') { 7227: if (ref($storehash) eq 'HASH') { 7228: if ($udom eq '' || $uname eq '') { 7229: $udom = $env{'user.domain'}; 7230: $uname = $env{'user.name'}; 7231: } 7232: my $uhome=&homeserver($uname,$udom); 7233: if (($uhome eq '') || ($uhome eq 'no_host')) { 7234: $result = 'error: no_host'; 7235: } else { 7236: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'}; 7237: $storehash->{'host'} = $perlvar{'lonHostID'}; 7238: 7239: my $namevalue=''; 7240: foreach my $key (keys(%{$storehash})) { 7241: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&'; 7242: } 7243: $namevalue=~s/\&$//; 7244: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:". 7245: "$namespace:$datakey:$namevalue",$uhome); 7246: } 7247: } else { 7248: $result = 'error: data to store was not a hash reference'; 7249: } 7250: } else { 7251: $result= 'error: invalid requestkey'; 7252: } 7253: return $result; 7254: } 7255: 7256: # ---------------------------------------------------------- Assign Custom Role 7257: 7258: sub assigncustomrole { 7259: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_; 7260: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename, 7261: $end,$start,$deleteflag,$selfenroll,$context); 7262: } 7263: 7264: # ----------------------------------------------------------------- Revoke Role 7265: 7266: sub revokerole { 7267: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_; 7268: my $now=time; 7269: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context); 7270: } 7271: 7272: # ---------------------------------------------------------- Revoke Custom Role 7273: 7274: sub revokecustomrole { 7275: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_; 7276: my $now=time; 7277: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now, 7278: $deleteflag,$selfenroll,$context); 7279: } 7280: 7281: # ------------------------------------------------------------ Disk usage 7282: sub diskusage { 7283: my ($udom,$uname,$directorypath,$getpropath)=@_; 7284: $directorypath =~ s/\/$//; 7285: my $listing=&reply('du2:'.&escape($directorypath).':' 7286: .&escape($getpropath).':'.&escape($uname).':' 7287: .&escape($udom),homeserver($uname,$udom)); 7288: if ($listing eq 'unknown_cmd') { 7289: if ($getpropath) { 7290: $directorypath = &propath($udom,$uname).'/'.$directorypath; 7291: } 7292: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom)); 7293: } 7294: return $listing; 7295: } 7296: 7297: sub is_locked { 7298: my ($file_name, $domain, $user, $which) = @_; 7299: my @check; 7300: my $is_locked; 7301: push (@check,$file_name); 7302: my %locked = &get('file_permissions',\@check, 7303: $env{'user.domain'},$env{'user.name'}); 7304: my ($tmp)=keys(%locked); 7305: if ($tmp=~/^error:/) { undef(%locked); } 7306: 7307: if (ref($locked{$file_name}) eq 'ARRAY') { 7308: $is_locked = 'false'; 7309: foreach my $entry (@{$locked{$file_name}}) { 7310: if (ref($entry) eq 'ARRAY') { 7311: $is_locked = 'true'; 7312: if (ref($which) eq 'ARRAY') { 7313: push(@{$which},$entry); 7314: } else { 7315: last; 7316: } 7317: } 7318: } 7319: } else { 7320: $is_locked = 'false'; 7321: } 7322: return $is_locked; 7323: } 7324: 7325: sub declutter_portfile { 7326: my ($file) = @_; 7327: $file =~ s{^(/portfolio/|portfolio/)}{/}; 7328: return $file; 7329: } 7330: 7331: # ------------------------------------------------------------- Mark as Read Only 7332: 7333: sub mark_as_readonly { 7334: my ($domain,$user,$files,$what) = @_; 7335: my %current_permissions = &dump('file_permissions',$domain,$user); 7336: my ($tmp)=keys(%current_permissions); 7337: if ($tmp=~/^error:/) { undef(%current_permissions); } 7338: foreach my $file (@{$files}) { 7339: $file = &declutter_portfile($file); 7340: push(@{$current_permissions{$file}},$what); 7341: } 7342: &put('file_permissions',\%current_permissions,$domain,$user); 7343: return; 7344: } 7345: 7346: # ------------------------------------------------------------Save Selected Files 7347: 7348: sub save_selected_files { 7349: my ($user, $path, @files) = @_; 7350: my $filename = $user."savedfiles"; 7351: my @other_files = &files_not_in_path($user, $path); 7352: open (OUT, '>'.$tmpdir.$filename); 7353: foreach my $file (@files) { 7354: print (OUT $env{'form.currentpath'}.$file."\n"); 7355: } 7356: foreach my $file (@other_files) { 7357: print (OUT $file."\n"); 7358: } 7359: close (OUT); 7360: return 'ok'; 7361: } 7362: 7363: sub clear_selected_files { 7364: my ($user) = @_; 7365: my $filename = $user."savedfiles"; 7366: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7367: print (OUT undef); 7368: close (OUT); 7369: return ("ok"); 7370: } 7371: 7372: sub files_in_path { 7373: my ($user, $path) = @_; 7374: my $filename = $user."savedfiles"; 7375: my %return_files; 7376: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7377: while (my $line_in = <IN>) { 7378: chomp ($line_in); 7379: my @paths_and_file = split (m!/!, $line_in); 7380: my $file_part = pop (@paths_and_file); 7381: my $path_part = join ('/', @paths_and_file); 7382: $path_part.='/'; 7383: my $path_and_file = $path_part.$file_part; 7384: if ($path_part eq $path) { 7385: $return_files{$file_part}= 'selected'; 7386: } 7387: } 7388: close (IN); 7389: return (\%return_files); 7390: } 7391: 7392: # called in portfolio select mode, to show files selected NOT in current directory 7393: sub files_not_in_path { 7394: my ($user, $path) = @_; 7395: my $filename = $user."savedfiles"; 7396: my @return_files; 7397: my $path_part; 7398: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename); 7399: while (my $line = <IN>) { 7400: #ok, I know it's clunky, but I want it to work 7401: my @paths_and_file = split(m|/|, $line); 7402: my $file_part = pop(@paths_and_file); 7403: chomp($file_part); 7404: my $path_part = join('/', @paths_and_file); 7405: $path_part .= '/'; 7406: my $path_and_file = $path_part.$file_part; 7407: if ($path_part ne $path) { 7408: push(@return_files, ($path_and_file)); 7409: } 7410: } 7411: close(OUT); 7412: return (@return_files); 7413: } 7414: 7415: #----------------------------------------------Get portfolio file permissions 7416: 7417: sub get_portfile_permissions { 7418: my ($domain,$user) = @_; 7419: my %current_permissions = &dump('file_permissions',$domain,$user); 7420: my ($tmp)=keys(%current_permissions); 7421: if ($tmp=~/^error:/) { undef(%current_permissions); } 7422: return \%current_permissions; 7423: } 7424: 7425: #---------------------------------------------Get portfolio file access controls 7426: 7427: sub get_access_controls { 7428: my ($current_permissions,$group,$file) = @_; 7429: my %access; 7430: my $real_file = $file; 7431: $file =~ s/\.meta$//; 7432: if (defined($file)) { 7433: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') { 7434: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) { 7435: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control}; 7436: } 7437: } 7438: } else { 7439: foreach my $key (keys(%{$current_permissions})) { 7440: if ($key =~ /\0accesscontrol$/) { 7441: if (defined($group)) { 7442: if ($key !~ m-^\Q$group\E/-) { 7443: next; 7444: } 7445: } 7446: my ($fullpath) = split(/\0/,$key); 7447: if (ref($$current_permissions{$key}) eq 'HASH') { 7448: foreach my $control (keys(%{$$current_permissions{$key}})) { 7449: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control}; 7450: } 7451: } 7452: } 7453: } 7454: } 7455: return %access; 7456: } 7457: 7458: sub modify_access_controls { 7459: my ($file_name,$changes,$domain,$user)=@_; 7460: my ($outcome,$deloutcome); 7461: my %store_permissions; 7462: my %new_values; 7463: my %new_control; 7464: my %translation; 7465: my @deletions = (); 7466: my $now = time; 7467: if (exists($$changes{'activate'})) { 7468: if (ref($$changes{'activate'}) eq 'HASH') { 7469: my @newitems = sort(keys(%{$$changes{'activate'}})); 7470: my $numnew = scalar(@newitems); 7471: for (my $i=0; $i<$numnew; $i++) { 7472: my $newkey = $newitems[$i]; 7473: my $newid = &Apache::loncommon::get_cgi_id(); 7474: if ($newkey =~ /^\d+:/) { 7475: $newkey =~ s/^(\d+)/$newid/; 7476: $translation{$1} = $newid; 7477: } elsif ($newkey =~ /^\d+_\d+_\d+:/) { 7478: $newkey =~ s/^(\d+_\d+_\d+)/$newid/; 7479: $translation{$1} = $newid; 7480: } 7481: $new_values{$file_name."\0".$newkey} = 7482: $$changes{'activate'}{$newitems[$i]}; 7483: $new_control{$newkey} = $now; 7484: } 7485: } 7486: } 7487: my %todelete; 7488: my %changed_items; 7489: foreach my $action ('delete','update') { 7490: if (exists($$changes{$action})) { 7491: if (ref($$changes{$action}) eq 'HASH') { 7492: foreach my $key (keys(%{$$changes{$action}})) { 7493: my ($itemnum) = ($key =~ /^([^:]+):/); 7494: if ($action eq 'delete') { 7495: $todelete{$itemnum} = 1; 7496: } else { 7497: $changed_items{$itemnum} = $key; 7498: } 7499: } 7500: } 7501: } 7502: } 7503: # get lock on access controls for file. 7504: my $lockhash = { 7505: $file_name."\0".'locked_access_records' => $env{'user.name'}. 7506: ':'.$env{'user.domain'}, 7507: }; 7508: my $tries = 0; 7509: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7510: 7511: while (($gotlock ne 'ok') && $tries <3) { 7512: $tries ++; 7513: sleep 1; 7514: $gotlock = &newput('file_permissions',$lockhash,$domain,$user); 7515: } 7516: if ($gotlock eq 'ok') { 7517: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name); 7518: my ($tmp)=keys(%curr_permissions); 7519: if ($tmp=~/^error:/) { undef(%curr_permissions); } 7520: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) { 7521: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'}; 7522: if (ref($curr_controls) eq 'HASH') { 7523: foreach my $control_item (keys(%{$curr_controls})) { 7524: my ($itemnum) = ($control_item =~ /^([^:]+):/); 7525: if (defined($todelete{$itemnum})) { 7526: push(@deletions,$file_name."\0".$control_item); 7527: } else { 7528: if (defined($changed_items{$itemnum})) { 7529: $new_control{$changed_items{$itemnum}} = $now; 7530: push(@deletions,$file_name."\0".$control_item); 7531: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}}; 7532: } else { 7533: $new_control{$control_item} = $$curr_controls{$control_item}; 7534: } 7535: } 7536: } 7537: } 7538: } 7539: my ($group); 7540: if (&is_course($domain,$user)) { 7541: ($group,my $file) = split(/\//,$file_name,2); 7542: } 7543: $deloutcome = &del('file_permissions',\@deletions,$domain,$user); 7544: $new_values{$file_name."\0".'accesscontrol'} = \%new_control; 7545: $outcome = &put('file_permissions',\%new_values,$domain,$user); 7546: # remove lock 7547: my @del_lock = ($file_name."\0".'locked_access_records'); 7548: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user); 7549: my $sqlresult = 7550: &update_portfolio_table($user,$domain,$file_name,'portfolio_access', 7551: $group); 7552: } else { 7553: $outcome = "error: could not obtain lockfile\n"; 7554: } 7555: return ($outcome,$deloutcome,\%new_values,\%translation); 7556: } 7557: 7558: sub make_public_indefinitely { 7559: my ($requrl) = @_; 7560: my $now = time; 7561: my $action = 'activate'; 7562: my $aclnum = 0; 7563: if (&is_portfolio_url($requrl)) { 7564: my (undef,$udom,$unum,$file_name,$group) = 7565: &parse_portfolio_url($requrl); 7566: my $current_perms = &get_portfile_permissions($udom,$unum); 7567: my %access_controls = &get_access_controls($current_perms, 7568: $group,$file_name); 7569: foreach my $key (keys(%{$access_controls{$file_name}})) { 7570: my ($num,$scope,$end,$start) = 7571: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/); 7572: if ($scope eq 'public') { 7573: if ($start <= $now && $end == 0) { 7574: $action = 'none'; 7575: } else { 7576: $action = 'update'; 7577: $aclnum = $num; 7578: } 7579: last; 7580: } 7581: } 7582: if ($action eq 'none') { 7583: return 'ok'; 7584: } else { 7585: my %changes; 7586: my $newend = 0; 7587: my $newstart = $now; 7588: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart; 7589: $changes{$action}{$newkey} = { 7590: type => 'public', 7591: time => { 7592: start => $newstart, 7593: end => $newend, 7594: }, 7595: }; 7596: my ($outcome,$deloutcome,$new_values,$translation) = 7597: &modify_access_controls($file_name,\%changes,$udom,$unum); 7598: return $outcome; 7599: } 7600: } else { 7601: return 'invalid'; 7602: } 7603: } 7604: 7605: #------------------------------------------------------Get Marked as Read Only 7606: 7607: sub get_marked_as_readonly { 7608: my ($domain,$user,$what,$group) = @_; 7609: my $current_permissions = &get_portfile_permissions($domain,$user); 7610: my @readonly_files; 7611: my $cmp1=$what; 7612: if (ref($what)) { $cmp1=join('',@{$what}) }; 7613: while (my ($file_name,$value) = each(%{$current_permissions})) { 7614: if (defined($group)) { 7615: if ($file_name !~ m-^\Q$group\E/-) { 7616: next; 7617: } 7618: } 7619: if (ref($value) eq "ARRAY"){ 7620: foreach my $stored_what (@{$value}) { 7621: my $cmp2=$stored_what; 7622: if (ref($stored_what) eq 'ARRAY') { 7623: $cmp2=join('',@{$stored_what}); 7624: } 7625: if ($cmp1 eq $cmp2) { 7626: push(@readonly_files, $file_name); 7627: last; 7628: } elsif (!defined($what)) { 7629: push(@readonly_files, $file_name); 7630: last; 7631: } 7632: } 7633: } 7634: } 7635: return @readonly_files; 7636: } 7637: #-----------------------------------------------------------Get Marked as Read Only Hash 7638: 7639: sub get_marked_as_readonly_hash { 7640: my ($current_permissions,$group,$what) = @_; 7641: my %readonly_files; 7642: while (my ($file_name,$value) = each(%{$current_permissions})) { 7643: if (defined($group)) { 7644: if ($file_name !~ m-^\Q$group\E/-) { 7645: next; 7646: } 7647: } 7648: if (ref($value) eq "ARRAY"){ 7649: foreach my $stored_what (@{$value}) { 7650: if (ref($stored_what) eq 'ARRAY') { 7651: foreach my $lock_descriptor(@{$stored_what}) { 7652: if ($lock_descriptor eq 'graded') { 7653: $readonly_files{$file_name} = 'graded'; 7654: } elsif ($lock_descriptor eq 'handback') { 7655: $readonly_files{$file_name} = 'handback'; 7656: } else { 7657: if (!exists($readonly_files{$file_name})) { 7658: $readonly_files{$file_name} = 'locked'; 7659: } 7660: } 7661: } 7662: } 7663: } 7664: } 7665: } 7666: return %readonly_files; 7667: } 7668: # ------------------------------------------------------------ Unmark as Read Only 7669: 7670: sub unmark_as_readonly { 7671: # unmarks $file_name (if $file_name is defined), or all files locked by $what 7672: # for portfolio submissions, $what contains [$symb,$crsid] 7673: my ($domain,$user,$what,$file_name,$group) = @_; 7674: $file_name = &declutter_portfile($file_name); 7675: my $symb_crs = $what; 7676: if (ref($what)) { $symb_crs=join('',@$what); } 7677: my %current_permissions = &dump('file_permissions',$domain,$user,$group); 7678: my ($tmp)=keys(%current_permissions); 7679: if ($tmp=~/^error:/) { undef(%current_permissions); } 7680: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group); 7681: foreach my $file (@readonly_files) { 7682: my $clean_file = &declutter_portfile($file); 7683: if (defined($file_name) && ($file_name ne $clean_file)) { next; } 7684: my $current_locks = $current_permissions{$file}; 7685: my @new_locks; 7686: my @del_keys; 7687: if (ref($current_locks) eq "ARRAY"){ 7688: foreach my $locker (@{$current_locks}) { 7689: my $compare=$locker; 7690: if (ref($locker) eq 'ARRAY') { 7691: $compare=join('',@{$locker}); 7692: if ($compare ne $symb_crs) { 7693: push(@new_locks, $locker); 7694: } 7695: } 7696: } 7697: if (scalar(@new_locks) > 0) { 7698: $current_permissions{$file} = \@new_locks; 7699: } else { 7700: push(@del_keys, $file); 7701: &del('file_permissions',\@del_keys, $domain, $user); 7702: delete($current_permissions{$file}); 7703: } 7704: } 7705: } 7706: &put('file_permissions',\%current_permissions,$domain,$user); 7707: return; 7708: } 7709: 7710: # ------------------------------------------------------------ Directory lister 7711: 7712: sub dirlist { 7713: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_; 7714: $uri=~s/^\///; 7715: $uri=~s/\/$//; 7716: my ($udom, $uname); 7717: if ($getuserdir) { 7718: $udom = $userdomain; 7719: $uname = $username; 7720: } else { 7721: (undef,$udom,$uname)=split(/\//,$uri); 7722: if(defined($userdomain)) { 7723: $udom = $userdomain; 7724: } 7725: if(defined($username)) { 7726: $uname = $username; 7727: } 7728: } 7729: my ($dirRoot,$listing,@listing_results); 7730: 7731: $dirRoot = $perlvar{'lonDocRoot'}; 7732: if (defined($getpropath)) { 7733: $dirRoot = &propath($udom,$uname); 7734: $dirRoot =~ s/\/$//; 7735: } elsif (defined($getuserdir)) { 7736: my $subdir=$uname.'__'; 7737: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/; 7738: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'} 7739: ."/$udom/$subdir/$uname"; 7740: } elsif (defined($alternateRoot)) { 7741: $dirRoot = $alternateRoot; 7742: } 7743: 7744: if($udom) { 7745: if($uname) { 7746: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':' 7747: .$getuserdir.':'.&escape($dirRoot) 7748: .':'.&escape($uname).':'.&escape($udom), 7749: &homeserver($uname,$udom)); 7750: if ($listing eq 'unknown_cmd') { 7751: $listing = &reply('ls2:'.$dirRoot.'/'.$uri, 7752: &homeserver($uname,$udom)); 7753: } else { 7754: @listing_results = map { &unescape($_); } split(/:/,$listing); 7755: } 7756: if ($listing eq 'unknown_cmd') { 7757: $listing = &reply('ls:'.$dirRoot.'/'.$uri, 7758: &homeserver($uname,$udom)); 7759: @listing_results = split(/:/,$listing); 7760: } else { 7761: @listing_results = map { &unescape($_); } split(/:/,$listing); 7762: } 7763: return @listing_results; 7764: } elsif(!$alternateRoot) { 7765: my %allusers; 7766: my %servers = &get_servers($udom,'library'); 7767: foreach my $tryserver (keys(%servers)) { 7768: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'. 7769: &escape($udom),$tryserver); 7770: if ($listing eq 'unknown_cmd') { 7771: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'. 7772: $udom, $tryserver); 7773: } else { 7774: @listing_results = map { &unescape($_); } split(/:/,$listing); 7775: } 7776: if ($listing eq 'unknown_cmd') { 7777: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'. 7778: $udom, $tryserver); 7779: @listing_results = split(/:/,$listing); 7780: } else { 7781: @listing_results = 7782: map { &unescape($_); } split(/:/,$listing); 7783: } 7784: if ($listing_results[0] ne 'no_such_dir' && 7785: $listing_results[0] ne 'empty' && 7786: $listing_results[0] ne 'con_lost') { 7787: foreach my $line (@listing_results) { 7788: my ($entry) = split(/&/,$line,2); 7789: $allusers{$entry} = 1; 7790: } 7791: } 7792: } 7793: my $alluserstr=''; 7794: foreach my $user (sort(keys(%allusers))) { 7795: $alluserstr.=$user.'&user:'; 7796: } 7797: $alluserstr=~s/:$//; 7798: return split(/:/,$alluserstr); 7799: } else { 7800: return ('missing user name'); 7801: } 7802: } elsif(!defined($getpropath)) { 7803: my @all_domains = sort(&all_domains()); 7804: foreach my $domain (@all_domains) { 7805: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain'; 7806: } 7807: return @all_domains; 7808: } else { 7809: return ('missing domain'); 7810: } 7811: } 7812: 7813: # --------------------------------------------- GetFileTimestamp 7814: # This function utilizes dirlist and returns the date stamp for 7815: # when it was last modified. It will also return an error of -1 7816: # if an error occurs 7817: 7818: sub GetFileTimestamp { 7819: my ($studentDomain,$studentName,$filename,$getuserdir)=@_; 7820: $studentDomain = &LONCAPA::clean_domain($studentDomain); 7821: $studentName = &LONCAPA::clean_username($studentName); 7822: my ($fileStat) = 7823: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName, 7824: undef,$getuserdir); 7825: my @stats = split('&', $fileStat); 7826: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7827: # @stats contains first the filename, then the stat output 7828: return $stats[10]; # so this is 10 instead of 9. 7829: } else { 7830: return -1; 7831: } 7832: } 7833: 7834: sub stat_file { 7835: my ($uri) = @_; 7836: $uri = &clutter_with_no_wrapper($uri); 7837: 7838: my ($udom,$uname,$file); 7839: if ($uri =~ m-^/(uploaded|editupload)/-) { 7840: ($udom,$uname,$file) = 7841: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-); 7842: $file = 'userfiles/'.$file; 7843: } 7844: if ($uri =~ m-^/res/-) { 7845: ($udom,$uname) = 7846: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-); 7847: $file = $uri; 7848: } 7849: 7850: if (!$udom || !$uname || !$file) { 7851: # unable to handle the uri 7852: return (); 7853: } 7854: my $getpropath; 7855: if ($file =~ /^userfiles\//) { 7856: $getpropath = 1; 7857: } 7858: my ($result) = &dirlist($file,$udom,$uname,$getpropath); 7859: my @stats = split('&', $result); 7860: 7861: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') { 7862: shift(@stats); #filename is first 7863: return @stats; 7864: } 7865: return (); 7866: } 7867: 7868: # -------------------------------------------------------- Value of a Condition 7869: 7870: # gets the value of a specific preevaluated condition 7871: # stored in the string $env{user.state.<cid>} 7872: # or looks up a condition reference in the bighash and if if hasn't 7873: # already been evaluated recurses into docondval to get the value of 7874: # the condition, then memoizing it to 7875: # $env{user.state.<cid>.<condition>} 7876: sub directcondval { 7877: my $number=shift; 7878: if (!defined($env{'user.state.'.$env{'request.course.id'}})) { 7879: &Apache::lonuserstate::evalstate(); 7880: } 7881: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) { 7882: return $env{'user.state.'.$env{'request.course.id'}.".$number"}; 7883: } elsif ($number =~ /^_/) { 7884: my $sub_condition; 7885: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 7886: &GDBM_READER(),0640)) { 7887: $sub_condition=$bighash{'conditions'.$number}; 7888: untie(%bighash); 7889: } 7890: my $value = &docondval($sub_condition); 7891: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value}); 7892: return $value; 7893: } 7894: if ($env{'user.state.'.$env{'request.course.id'}}) { 7895: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1); 7896: } else { 7897: return 2; 7898: } 7899: } 7900: 7901: # get the collection of conditions for this resource 7902: sub condval { 7903: my $condidx=shift; 7904: my $allpathcond=''; 7905: foreach my $cond (split(/\|/,$condidx)) { 7906: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) { 7907: $allpathcond.= 7908: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|'; 7909: } 7910: } 7911: $allpathcond=~s/\|$//; 7912: return &docondval($allpathcond); 7913: } 7914: 7915: #evaluates an expression of conditions 7916: sub docondval { 7917: my ($allpathcond) = @_; 7918: my $result=0; 7919: if ($env{'request.course.id'} 7920: && defined($allpathcond)) { 7921: my $operand='|'; 7922: my @stack; 7923: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|$|$|\&|\|)/g) { 7924: if ($chunk eq '(') { 7925: push @stack,($operand,$result); 7926: } elsif ($chunk eq ')') { 7927: my $before=pop @stack; 7928: if (pop @stack eq '&') { 7929: $result=$result>$before?$before:$result; 7930: } else { 7931: $result=$result>$before?$result:$before; 7932: } 7933: } elsif (($chunk eq '&') || ($chunk eq '|')) { 7934: $operand=$chunk; 7935: } else { 7936: my $new=directcondval($chunk); 7937: if ($operand eq '&') { 7938: $result=$result>$new?$new:$result; 7939: } else { 7940: $result=$result>$new?$result:$new; 7941: } 7942: } 7943: } 7944: } 7945: return $result; 7946: } 7947: 7948: # ---------------------------------------------------- Devalidate courseresdata 7949: 7950: sub devalidatecourseresdata { 7951: my ($coursenum,$coursedomain)=@_; 7952: my $hashid=$coursenum.':'.$coursedomain; 7953: &devalidate_cache_new('courseres',$hashid); 7954: } 7955: 7956: 7957: # --------------------------------------------------- Course Resourcedata Query 7958: # 7959: # Parameters: 7960: # $coursenum - Number of the course. 7961: # $coursedomain - Domain at which the course was created. 7962: # Returns: 7963: # A hash of the course parameters along (I think) with timestamps 7964: # and version info. 7965: 7966: sub get_courseresdata { 7967: my ($coursenum,$coursedomain)=@_; 7968: my $coursehom=&homeserver($coursenum,$coursedomain); 7969: my $hashid=$coursenum.':'.$coursedomain; 7970: my ($result,$cached)=&is_cached_new('courseres',$hashid); 7971: my %dumpreply; 7972: unless (defined($cached)) { 7973: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum); 7974: $result=\%dumpreply; 7975: my ($tmp) = keys(%dumpreply); 7976: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 7977: &do_cache_new('courseres',$hashid,$result,600); 7978: } elsif ($tmp =~ /^(con_lost|no_such_host)/) { 7979: return $tmp; 7980: } elsif ($tmp =~ /^(error)/) { 7981: $result=undef; 7982: &do_cache_new('courseres',$hashid,$result,600); 7983: } 7984: } 7985: return $result; 7986: } 7987: 7988: sub devalidateuserresdata { 7989: my ($uname,$udom)=@_; 7990: my $hashid="$udom:$uname"; 7991: &devalidate_cache_new('userres',$hashid); 7992: } 7993: 7994: sub get_userresdata { 7995: my ($uname,$udom)=@_; 7996: #most student don\'t have any data set, check if there is some data 7997: if (&EXT_cache_status($udom,$uname)) { return undef; } 7998: 7999: my $hashid="$udom:$uname"; 8000: my ($result,$cached)=&is_cached_new('userres',$hashid); 8001: if (!defined($cached)) { 8002: my %resourcedata=&dump('resourcedata',$udom,$uname); 8003: $result=\%resourcedata; 8004: &do_cache_new('userres',$hashid,$result,600); 8005: } 8006: my ($tmp)=keys(%$result); 8007: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) { 8008: return $result; 8009: } 8010: #error 2 occurs when the .db doesn't exist 8011: if ($tmp!~/error: 2 /) { 8012: &logthis("WARNING:". 8013: " Trying to get resource data for ". 8014: $uname." at ".$udom.": ". 8015: $tmp.""); 8016: } elsif ($tmp=~/error: 2 /) { 8017: #&EXT_cache_set($udom,$uname); 8018: &do_cache_new('userres',$hashid,undef,600); 8019: undef($tmp); # not really an error so don't send it back 8020: } 8021: return $tmp; 8022: } 8023: #----------------------------------------------- resdata - return resource data 8024: # Purpose: 8025: # Return resource data for either users or for a course. 8026: # Parameters: 8027: # $name - Course/user name. 8028: # $domain - Name of the domain the user/course is registered on. 8029: # $type - Type of thing $name is (must be 'course' or 'user' 8030: # @which - Array of names of resources desired. 8031: # Returns: 8032: # The value of the first reasource in @which that is found in the 8033: # resource hash. 8034: # Exceptional Conditions: 8035: # If the $type passed in is not valid (not the string 'course' or 8036: # 'user', an undefined reference is returned. 8037: # If none of the resources are found, an undef is returned 8038: sub resdata { 8039: my ($name,$domain,$type,@which)=@_; 8040: my $result; 8041: if ($type eq 'course') { 8042: $result=&get_courseresdata($name,$domain); 8043: } elsif ($type eq 'user') { 8044: $result=&get_userresdata($name,$domain); 8045: } 8046: if (!ref($result)) { return $result; } 8047: foreach my $item (@which) { 8048: if (defined($result->{$item->[0]})) { 8049: return [$result->{$item->[0]},$item->[1]]; 8050: } 8051: } 8052: return undef; 8053: } 8054: 8055: # 8056: # EXT resource caching routines 8057: # 8058: 8059: sub clear_EXT_cache_status { 8060: &delenv('cache.EXT.'); 8061: } 8062: 8063: sub EXT_cache_status { 8064: my ($target_domain,$target_user) = @_; 8065: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 8066: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) { 8067: # We know already the user has no data 8068: return 1; 8069: } else { 8070: return 0; 8071: } 8072: } 8073: 8074: sub EXT_cache_set { 8075: my ($target_domain,$target_user) = @_; 8076: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain; 8077: #&appenv({$cachename => time}); 8078: } 8079: 8080: # --------------------------------------------------------- Value of a Variable 8081: sub EXT { 8082: 8083: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_; 8084: unless ($varname) { return ''; } 8085: #get real user name/domain, courseid and symb 8086: my $courseid; 8087: my $publicuser; 8088: if ($symbparm) { 8089: $symbparm=&get_symb_from_alias($symbparm); 8090: } 8091: if (!($uname && $udom)) { 8092: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm); 8093: if (!$symbparm) { $symbparm=$cursymb; } 8094: } else { 8095: $courseid=$env{'request.course.id'}; 8096: } 8097: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname); 8098: my $rest; 8099: if (defined($therest[0])) { 8100: $rest=join('.',@therest); 8101: } else { 8102: $rest=''; 8103: } 8104: 8105: my $qualifierrest=$qualifier; 8106: if ($rest) { $qualifierrest.='.'.$rest; } 8107: my $spacequalifierrest=$space; 8108: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; } 8109: if ($realm eq 'user') { 8110: # --------------------------------------------------------------- user.resource 8111: if ($space eq 'resource') { 8112: if ( (defined($Apache::lonhomework::parsing_a_problem) 8113: || defined($Apache::lonhomework::parsing_a_task)) 8114: && 8115: ($symbparm eq &symbread()) ) { 8116: # if we are in the middle of processing the resource the 8117: # get the value we are planning on committing 8118: if (defined($Apache::lonhomework::results{$qualifierrest})) { 8119: return $Apache::lonhomework::results{$qualifierrest}; 8120: } else { 8121: return $Apache::lonhomework::history{$qualifierrest}; 8122: } 8123: } else { 8124: my %restored; 8125: if ($publicuser || $env{'request.state'} eq 'construct') { 8126: %restored=&tmprestore($symbparm,$courseid,$udom,$uname); 8127: } else { 8128: %restored=&restore($symbparm,$courseid,$udom,$uname); 8129: } 8130: return $restored{$qualifierrest}; 8131: } 8132: # ----------------------------------------------------------------- user.access 8133: } elsif ($space eq 'access') { 8134: # FIXME - not supporting calls for a specific user 8135: return &allowed($qualifier,$rest); 8136: # ------------------------------------------ user.preferences, user.environment 8137: } elsif (($space eq 'preferences') || ($space eq 'environment')) { 8138: if (($uname eq $env{'user.name'}) && 8139: ($udom eq $env{'user.domain'})) { 8140: return $env{join('.',('environment',$qualifierrest))}; 8141: } else { 8142: my %returnhash; 8143: if (!$publicuser) { 8144: %returnhash=&userenvironment($udom,$uname, 8145: $qualifierrest); 8146: } 8147: return $returnhash{$qualifierrest}; 8148: } 8149: # ----------------------------------------------------------------- user.course 8150: } elsif ($space eq 'course') { 8151: # FIXME - not supporting calls for a specific user 8152: return $env{join('.',('request.course',$qualifier))}; 8153: # ------------------------------------------------------------------- user.role 8154: } elsif ($space eq 'role') { 8155: # FIXME - not supporting calls for a specific user 8156: my ($role,$where)=split(/\./,$env{'request.role'}); 8157: if ($qualifier eq 'value') { 8158: return $role; 8159: } elsif ($qualifier eq 'extent') { 8160: return $where; 8161: } 8162: # ----------------------------------------------------------------- user.domain 8163: } elsif ($space eq 'domain') { 8164: return $udom; 8165: # ------------------------------------------------------------------- user.name 8166: } elsif ($space eq 'name') { 8167: return $uname; 8168: # ---------------------------------------------------- Any other user namespace 8169: } else { 8170: my %reply; 8171: if (!$publicuser) { 8172: %reply=&get($space,[$qualifierrest],$udom,$uname); 8173: } 8174: return $reply{$qualifierrest}; 8175: } 8176: } elsif ($realm eq 'query') { 8177: # ---------------------------------------------- pull stuff out of query string 8178: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, 8179: [$spacequalifierrest]); 8180: return $env{'form.'.$spacequalifierrest}; 8181: } elsif ($realm eq 'request') { 8182: # ------------------------------------------------------------- request.browser 8183: if ($space eq 'browser') { 8184: if ($qualifier eq 'textremote') { 8185: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') { 8186: return 1; 8187: } else { 8188: return 0; 8189: } 8190: } else { 8191: return $env{'browser.'.$qualifier}; 8192: } 8193: # ------------------------------------------------------------ request.filename 8194: } else { 8195: return $env{'request.'.$spacequalifierrest}; 8196: } 8197: } elsif ($realm eq 'course') { 8198: # ---------------------------------------------------------- course.description 8199: return $env{'course.'.$courseid.'.'.$spacequalifierrest}; 8200: } elsif ($realm eq 'resource') { 8201: 8202: if (defined($courseid) && $courseid eq $env{'request.course.id'}) { 8203: if (!$symbparm) { $symbparm=&symbread(); } 8204: } 8205: 8206: if ($space eq 'title') { 8207: if (!$symbparm) { $symbparm = $env{'request.filename'}; } 8208: return &gettitle($symbparm); 8209: } 8210: 8211: if ($space eq 'map') { 8212: my ($map) = &decode_symb($symbparm); 8213: return &symbread($map); 8214: } 8215: if ($space eq 'filename') { 8216: if ($symbparm) { 8217: return &clutter((&decode_symb($symbparm))[2]); 8218: } 8219: return &hreflocation('',$env{'request.filename'}); 8220: } 8221: 8222: my ($section, $group, @groups); 8223: my ($courselevelm,$courselevel); 8224: if ($symbparm && defined($courseid) && 8225: $courseid eq $env{'request.course.id'}) { 8226: 8227: #print ' '.$space.' - '.$qualifier.' - '.$spacequalifierrest; 8228: 8229: # ----------------------------------------------------- Cascading lookup scheme 8230: my $symbp=$symbparm; 8231: my $mapp=&deversion((&decode_symb($symbp))[0]); 8232: 8233: my $symbparm=$symbp.'.'.$spacequalifierrest; 8234: my $mapparm=$mapp.'___(all).'.$spacequalifierrest; 8235: 8236: if (($env{'user.name'} eq $uname) && 8237: ($env{'user.domain'} eq $udom)) { 8238: $section=$env{'request.course.sec'}; 8239: @groups = split(/:/,$env{'request.course.groups'}); 8240: @groups=&sort_course_groups($courseid,@groups); 8241: } else { 8242: if (! defined($usection)) { 8243: $section=&getsection($udom,$uname,$courseid); 8244: } else { 8245: $section = $usection; 8246: } 8247: @groups = &get_users_groups($udom,$uname,$courseid); 8248: } 8249: 8250: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest; 8251: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm; 8252: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm; 8253: 8254: $courselevel=$courseid.'.'.$spacequalifierrest; 8255: my $courselevelr=$courseid.'.'.$symbparm; 8256: $courselevelm=$courseid.'.'.$mapparm; 8257: 8258: # ----------------------------------------------------------- first, check user 8259: 8260: my $userreply=&resdata($uname,$udom,'user', 8261: ([$courselevelr,'resource'], 8262: [$courselevelm,'map' ], 8263: [$courselevel, 'course' ])); 8264: if (defined($userreply)) { return &get_reply($userreply); } 8265: 8266: # ------------------------------------------------ second, check some of course 8267: my $coursereply; 8268: if (@groups > 0) { 8269: $coursereply = &check_group_parms($courseid,\@groups,$symbparm, 8270: $mapparm,$spacequalifierrest); 8271: if (defined($coursereply)) { return &get_reply($coursereply); } 8272: } 8273: 8274: $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 8275: $env{'course.'.$courseid.'.domain'}, 8276: 'course', 8277: ([$seclevelr, 'resource'], 8278: [$seclevelm, 'map' ], 8279: [$seclevel, 'course' ], 8280: [$courselevelr,'resource'])); 8281: if (defined($coursereply)) { return &get_reply($coursereply); } 8282: 8283: # ------------------------------------------------------ third, check map parms 8284: my %parmhash=(); 8285: my $thisparm=''; 8286: if (tie(%parmhash,'GDBM_File', 8287: $env{'request.course.fn'}.'_parms.db', 8288: &GDBM_READER(),0640)) { 8289: $thisparm=$parmhash{$symbparm}; 8290: untie(%parmhash); 8291: } 8292: if ($thisparm) { return &get_reply([$thisparm,'resource']); } 8293: } 8294: # ------------------------------------------ fourth, look in resource metadata 8295: 8296: $spacequalifierrest=~s/\./\_/; 8297: my $filename; 8298: if (!$symbparm) { $symbparm=&symbread(); } 8299: if ($symbparm) { 8300: $filename=(&decode_symb($symbparm))[2]; 8301: } else { 8302: $filename=$env{'request.filename'}; 8303: } 8304: my $metadata=&metadata($filename,$spacequalifierrest); 8305: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 8306: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest); 8307: if (defined($metadata)) { return &get_reply([$metadata,'resource']); } 8308: 8309: # ---------------------------------------------- fourth, look in rest of course 8310: if ($symbparm && defined($courseid) && 8311: $courseid eq $env{'request.course.id'}) { 8312: my $coursereply=&resdata($env{'course.'.$courseid.'.num'}, 8313: $env{'course.'.$courseid.'.domain'}, 8314: 'course', 8315: ([$courselevelm,'map' ], 8316: [$courselevel, 'course'])); 8317: if (defined($coursereply)) { return &get_reply($coursereply); } 8318: } 8319: # ------------------------------------------------------------------ Cascade up 8320: unless ($space eq '0') { 8321: my @parts=split(/_/,$space); 8322: my $id=pop(@parts); 8323: my $part=join('_',@parts); 8324: if ($part eq '') { $part='0'; } 8325: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest, 8326: $symbparm,$udom,$uname,$section,1); 8327: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); } 8328: } 8329: if ($recurse) { return undef; } 8330: my $pack_def=&packages_tab_default($filename,$varname); 8331: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); } 8332: # ---------------------------------------------------- Any other user namespace 8333: } elsif ($realm eq 'environment') { 8334: # ----------------------------------------------------------------- environment 8335: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) { 8336: return $env{'environment.'.$spacequalifierrest}; 8337: } else { 8338: if ($uname eq 'anonymous' && $udom eq '') { 8339: return ''; 8340: } 8341: my %returnhash=&userenvironment($udom,$uname, 8342: $spacequalifierrest); 8343: return $returnhash{$spacequalifierrest}; 8344: } 8345: } elsif ($realm eq 'system') { 8346: # ----------------------------------------------------------------- system.time 8347: if ($space eq 'time') { 8348: return time; 8349: } 8350: } elsif ($realm eq 'server') { 8351: # ----------------------------------------------------------------- system.time 8352: if ($space eq 'name') { 8353: return $ENV{'SERVER_NAME'}; 8354: } 8355: } 8356: return ''; 8357: } 8358: 8359: sub get_reply { 8360: my ($reply_value) = @_; 8361: if (ref($reply_value) eq 'ARRAY') { 8362: if (wantarray) { 8363: return @$reply_value; 8364: } 8365: return $reply_value->[0]; 8366: } else { 8367: return $reply_value; 8368: } 8369: } 8370: 8371: sub check_group_parms { 8372: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_; 8373: my @groupitems = (); 8374: my $resultitem; 8375: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']); 8376: foreach my $group (@{$groups}) { 8377: foreach my $level (@levels) { 8378: my $item = $courseid.'.['.$group.'].'.$level->[0]; 8379: push(@groupitems,[$item,$level->[1]]); 8380: } 8381: } 8382: my $coursereply = &resdata($env{'course.'.$courseid.'.num'}, 8383: $env{'course.'.$courseid.'.domain'}, 8384: 'course',@groupitems); 8385: return $coursereply; 8386: } 8387: 8388: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort(). 8389: my ($courseid,@groups) = @_; 8390: @groups = sort(@groups); 8391: return @groups; 8392: } 8393: 8394: sub packages_tab_default { 8395: my ($uri,$varname)=@_; 8396: my (undef,$part,$name)=split(/\./,$varname); 8397: 8398: my (@extension,@specifics,$do_default); 8399: foreach my $package (split(/,/,&metadata($uri,'packages'))) { 8400: my ($pack_type,$pack_part)=split(/_/,$package,2); 8401: if ($pack_type eq 'default') { 8402: $do_default=1; 8403: } elsif ($pack_type eq 'extension') { 8404: push(@extension,[$package,$pack_type,$pack_part]); 8405: } elsif ($pack_part eq $part || $pack_type eq 'part') { 8406: # only look at packages defaults for packages that this id is 8407: push(@specifics,[$package,$pack_type,$pack_part]); 8408: } 8409: } 8410: # first look for a package that matches the requested part id 8411: foreach my $package (@specifics) { 8412: my (undef,$pack_type,$pack_part)=@{$package}; 8413: next if ($pack_part ne $part); 8414: if (defined($packagetab{"$pack_type&$name&default"})) { 8415: return $packagetab{"$pack_type&$name&default"}; 8416: } 8417: } 8418: # look for any possible matching non extension_ package 8419: foreach my $package (@specifics) { 8420: my (undef,$pack_type,$pack_part)=@{$package}; 8421: if (defined($packagetab{"$pack_type&$name&default"})) { 8422: return $packagetab{"$pack_type&$name&default"}; 8423: } 8424: if ($pack_type eq 'part') { $pack_part='0'; } 8425: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) { 8426: return $packagetab{$pack_type."_".$pack_part."&$name&default"}; 8427: } 8428: } 8429: # look for any posible extension_ match 8430: foreach my $package (@extension) { 8431: my ($package,$pack_type)=@{$package}; 8432: if (defined($packagetab{"$pack_type&$name&default"})) { 8433: return $packagetab{"$pack_type&$name&default"}; 8434: } 8435: if (defined($packagetab{$package."&$name&default"})) { 8436: return $packagetab{$package."&$name&default"}; 8437: } 8438: } 8439: # look for a global default setting 8440: if ($do_default && defined($packagetab{"default&$name&default"})) { 8441: return $packagetab{"default&$name&default"}; 8442: } 8443: return undef; 8444: } 8445: 8446: sub add_prefix_and_part { 8447: my ($prefix,$part)=@_; 8448: my $keyroot; 8449: if (defined($prefix) && $prefix !~ /^__/) { 8450: # prefix that has a part already 8451: $keyroot=$prefix; 8452: } elsif (defined($prefix)) { 8453: # prefix that is missing a part 8454: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); } 8455: } else { 8456: # no prefix at all 8457: if (defined($part)) { $keyroot='_'.$part; } 8458: } 8459: return $keyroot; 8460: } 8461: 8462: # ---------------------------------------------------------------- Get metadata 8463: 8464: my %metaentry; 8465: my %importedpartids; 8466: sub metadata { 8467: my ($uri,$what,$liburi,$prefix,$depthcount)=@_; 8468: $uri=&declutter($uri); 8469: # if it is a non metadata possible uri return quickly 8470: if (($uri eq '') || 8471: (($uri =~ m|^/*adm/|) && 8472: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) || 8473: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^\*uploaded\/.+\.sequence$/) ) { 8474: return undef; 8475: } 8476: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) 8477: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) { 8478: return undef; 8479: } 8480: my $filename=$uri; 8481: $uri=~s/\.meta$//; 8482: # 8483: # Is the metadata already cached? 8484: # Look at timestamp of caching 8485: # Everything is cached by the main uri, libraries are never directly cached 8486: # 8487: if (!defined($liburi)) { 8488: my ($result,$cached)=&is_cached_new('meta',$uri); 8489: if (defined($cached)) { return $result->{':'.$what}; } 8490: } 8491: { 8492: # Imported parts would go here 8493: my %importedids=(); 8494: my @origfileimportpartids=(); 8495: my $importedparts=0; 8496: # 8497: # Is this a recursive call for a library? 8498: # 8499: # if (! exists($metacache{$uri})) { 8500: # $metacache{$uri}={}; 8501: # } 8502: my $cachetime = 60*60; 8503: if ($liburi) { 8504: $liburi=&declutter($liburi); 8505: $filename=$liburi; 8506: } else { 8507: &devalidate_cache_new('meta',$uri); 8508: undef(%metaentry); 8509: } 8510: my %metathesekeys=(); 8511: unless ($filename=~/\.meta$/) { $filename.='.meta'; } 8512: my $metastring; 8513: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) { 8514: my $which = &hreflocation('','/'.($liburi || $uri)); 8515: $metastring = 8516: &Apache::lonnet::ssi_body($which, 8517: ('grade_target' => 'meta')); 8518: $cachetime = 1; # only want this cached in the child not long term 8519: } elsif ($uri !~ m -^(editupload)/-) { 8520: my $file=&filelocation('',&clutter($filename)); 8521: #push(@{$metaentry{$uri.'.file'}},$file); 8522: $metastring=&getfile($file); 8523: } 8524: my $parser=HTML::LCParser->new(\$metastring); 8525: my $token; 8526: undef %metathesekeys; 8527: while ($token=$parser->get_token) { 8528: if ($token->[0] eq 'S') { 8529: if (defined($token->[2]->{'package'})) { 8530: # 8531: # This is a package - get package info 8532: # 8533: my $package=$token->[2]->{'package'}; 8534: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8535: if (defined($token->[2]->{'id'})) { 8536: $keyroot.='_'.$token->[2]->{'id'}; 8537: } 8538: if ($metaentry{':packages'}) { 8539: $metaentry{':packages'}.=','.$package.$keyroot; 8540: } else { 8541: $metaentry{':packages'}=$package.$keyroot; 8542: } 8543: foreach my $pack_entry (keys(%packagetab)) { 8544: my $part=$keyroot; 8545: $part=~s/^\_//; 8546: if ($pack_entry=~/^\Q$package\E\&/ || 8547: $pack_entry=~/^\Q$package\E_0\&/) { 8548: my ($pack,$name,$subp)=split(/\&/,$pack_entry); 8549: # ignore package.tab specified default values 8550: # here &package_tab_default() will fetch those 8551: if ($subp eq 'default') { next; } 8552: my $value=$packagetab{$pack_entry}; 8553: my $unikey; 8554: if ($pack =~ /_0$/) { 8555: $unikey='parameter_0_'.$name; 8556: $part=0; 8557: } else { 8558: $unikey='parameter'.$keyroot.'_'.$name; 8559: } 8560: if ($subp eq 'display') { 8561: $value.=' [Part: '.$part.']'; 8562: } 8563: $metaentry{':'.$unikey.'.part'}=$part; 8564: $metathesekeys{$unikey}=1; 8565: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8566: $metaentry{':'.$unikey.'.'.$subp}=$value; 8567: } 8568: if (defined($metaentry{':'.$unikey.'.default'})) { 8569: $metaentry{':'.$unikey}= 8570: $metaentry{':'.$unikey.'.default'}; 8571: } 8572: } 8573: } 8574: } else { 8575: # 8576: # This is not a package - some other kind of start tag 8577: # 8578: my $entry=$token->[1]; 8579: my $unikey=''; 8580: 8581: if ($entry eq 'import') { 8582: # 8583: # Importing a library here 8584: # 8585: my $location=$parser->get_text('/import'); 8586: my $dir=$filename; 8587: $dir=~s|[^/]*$||; 8588: $location=&filelocation($dir,$location); 8589: 8590: my $importmode=$token->[2]->{'importmode'}; 8591: if ($importmode eq 'problem') { 8592: # Import as problem/response 8593: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8594: } elsif ($importmode eq 'part') { 8595: # Import as part(s) 8596: $importedparts=1; 8597: # We need to get the original file and the imported file to get the part order correct 8598: # Good news: we do not need to worry about nested libraries, since parts cannot be nested 8599: # Load and inspect original file 8600: if ($#origfileimportpartids<0) { 8601: undef(%importedpartids); 8602: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri); 8603: my $origfile=&getfile($origfilelocation); 8604: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs); 8605: } 8606: 8607: # Load and inspect imported file 8608: my $impfile=&getfile($location); 8609: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs); 8610: if ($#impfilepartids>=0) { 8611: # This problem had parts 8612: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids); 8613: } else { 8614: # Importing by turning a single problem into a problem part 8615: # It gets the import-tags ID as part-ID 8616: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'}); 8617: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'}; 8618: } 8619: } else { 8620: # Normal import 8621: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8622: if (defined($token->[2]->{'id'})) { 8623: $unikey.='_'.$token->[2]->{'id'}; 8624: } 8625: } 8626: 8627: if ($depthcount<20) { 8628: my $metadata = 8629: &metadata($uri,'keys', $location,$unikey, 8630: $depthcount+1); 8631: foreach my $meta (split(',',$metadata)) { 8632: $metaentry{':'.$meta}=$metaentry{':'.$meta}; 8633: $metathesekeys{$meta}=1; 8634: } 8635: 8636: } 8637: } else { 8638: # 8639: # Not importing, some other kind of non-package, non-library start tag 8640: # 8641: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'}); 8642: if (defined($token->[2]->{'id'})) { 8643: $unikey.='_'.$token->[2]->{'id'}; 8644: } 8645: if (defined($token->[2]->{'name'})) { 8646: $unikey.='_'.$token->[2]->{'name'}; 8647: } 8648: $metathesekeys{$unikey}=1; 8649: foreach my $param (@{$token->[3]}) { 8650: $metaentry{':'.$unikey.'.'.$param} = 8651: $token->[2]->{$param}; 8652: } 8653: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry)); 8654: my $default=$metaentry{':'.$unikey.'.default'}; 8655: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) { 8656: # only ws inside the tag, and not in default, so use default 8657: # as value 8658: $metaentry{':'.$unikey}=$default; 8659: } elsif ( $internaltext =~ /\S/ ) { 8660: # something interesting inside the tag 8661: $metaentry{':'.$unikey}=$internaltext; 8662: } else { 8663: # no interesting values, don't set a default 8664: } 8665: # end of not-a-package not-a-library import 8666: } 8667: # end of not-a-package start tag 8668: } 8669: # the next is the end of "start tag" 8670: } 8671: } 8672: my ($extension) = ($uri =~ /\.(\w+)$/); 8673: $extension = lc($extension); 8674: if ($extension eq 'htm') { $extension='html'; } 8675: 8676: foreach my $key (keys(%packagetab)) { 8677: #no specific packages #how's our extension 8678: if ($key!~/^extension_\Q$extension\E&/) { next; } 8679: &metadata_create_package_def($uri,$key,'extension_'.$extension, 8680: \%metathesekeys); 8681: } 8682: 8683: if (!exists($metaentry{':packages'}) 8684: || $packagetab{"import_defaults&extension_$extension"}) { 8685: foreach my $key (keys(%packagetab)) { 8686: #no specific packages well let's get default then 8687: if ($key!~/^default&/) { next; } 8688: &metadata_create_package_def($uri,$key,'default', 8689: \%metathesekeys); 8690: } 8691: } 8692: # are there custom rights to evaluate 8693: if ($metaentry{':copyright'} eq 'custom') { 8694: 8695: # 8696: # Importing a rights file here 8697: # 8698: unless ($depthcount) { 8699: my $location=$metaentry{':customdistributionfile'}; 8700: my $dir=$filename; 8701: $dir=~s|[^/]*$||; 8702: $location=&filelocation($dir,$location); 8703: my $rights_metadata = 8704: &metadata($uri,'keys',$location,'_rights', 8705: $depthcount+1); 8706: foreach my $rights (split(',',$rights_metadata)) { 8707: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights}; 8708: $metathesekeys{$rights}=1; 8709: } 8710: } 8711: } 8712: # uniqifiy package listing 8713: my %seen; 8714: my @uniq_packages = 8715: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'})); 8716: $metaentry{':packages'} = join(',',@uniq_packages); 8717: 8718: if ($importedparts) { 8719: # We had imported parts and need to rebuild partorder 8720: $metaentry{':partorder'}=''; 8721: $metathesekeys{'partorder'}=1; 8722: for (my $index=0;$index<$#origfileimportpartids;$index+=2) { 8723: if ($origfileimportpartids[$index] eq 'part') { 8724: # original part, part of the problem 8725: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1]; 8726: } else { 8727: # we have imported parts at this position 8728: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]}; 8729: } 8730: } 8731: $metaentry{':partorder'}=~s/^\,//; 8732: } 8733: 8734: $metaentry{':keys'} = join(',',keys(%metathesekeys)); 8735: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri); 8736: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys); 8737: &do_cache_new('meta',$uri,\%metaentry,$cachetime); 8738: # this is the end of "was not already recently cached 8739: } 8740: return $metaentry{':'.$what}; 8741: } 8742: 8743: sub metadata_create_package_def { 8744: my ($uri,$key,$package,$metathesekeys)=@_; 8745: my ($pack,$name,$subp)=split(/\&/,$key); 8746: if ($subp eq 'default') { next; } 8747: 8748: if (defined($metaentry{':packages'})) { 8749: $metaentry{':packages'}.=','.$package; 8750: } else { 8751: $metaentry{':packages'}=$package; 8752: } 8753: my $value=$packagetab{$key}; 8754: my $unikey; 8755: $unikey='parameter_0_'.$name; 8756: $metaentry{':'.$unikey.'.part'}=0; 8757: $$metathesekeys{$unikey}=1; 8758: unless (defined($metaentry{':'.$unikey.'.'.$subp})) { 8759: $metaentry{':'.$unikey.'.'.$subp}=$value; 8760: } 8761: if (defined($metaentry{':'.$unikey.'.default'})) { 8762: $metaentry{':'.$unikey}= 8763: $metaentry{':'.$unikey.'.default'}; 8764: } 8765: } 8766: 8767: sub metadata_generate_part0 { 8768: my ($metadata,$metacache,$uri) = @_; 8769: my %allnames; 8770: foreach my $metakey (keys(%$metadata)) { 8771: if ($metakey=~/^parameter\_(.*)/) { 8772: my $part=$$metacache{':'.$metakey.'.part'}; 8773: my $name=$$metacache{':'.$metakey.'.name'}; 8774: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) { 8775: $allnames{$name}=$part; 8776: } 8777: } 8778: } 8779: foreach my $name (keys(%allnames)) { 8780: $$metadata{"parameter_0_$name"}=1; 8781: my $key=":parameter_0_$name"; 8782: $$metacache{"$key.part"}='0'; 8783: $$metacache{"$key.name"}=$name; 8784: $$metacache{"$key.type"}=$$metacache{':parameter_'. 8785: $allnames{$name}.'_'.$name. 8786: '.type'}; 8787: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name. 8788: '.display'}; 8789: my $expr='[Part: '.$allnames{$name}.']'; 8790: $olddis=~s/\Q$expr\E/\[Part: 0\]/; 8791: $$metacache{"$key.display"}=$olddis; 8792: } 8793: } 8794: 8795: # ------------------------------------------------------ Devalidate title cache 8796: 8797: sub devalidate_title_cache { 8798: my ($url)=@_; 8799: if (!$env{'request.course.id'}) { return; } 8800: my $symb=&symbread($url); 8801: if (!$symb) { return; } 8802: my $key=$env{'request.course.id'}."\0".$symb; 8803: &devalidate_cache_new('title',$key); 8804: } 8805: 8806: # ------------------------------------------------- Get the title of a course 8807: 8808: sub current_course_title { 8809: return $env{ 'course.' . $env{'request.course.id'} . '.description' }; 8810: } 8811: # ------------------------------------------------- Get the title of a resource 8812: 8813: sub gettitle { 8814: my $urlsymb=shift; 8815: my $symb=&symbread($urlsymb); 8816: if ($symb) { 8817: my $key=$env{'request.course.id'}."\0".$symb; 8818: my ($result,$cached)=&is_cached_new('title',$key); 8819: if (defined($cached)) { 8820: return $result; 8821: } 8822: my ($map,$resid,$url)=&decode_symb($symb); 8823: my $title=''; 8824: if (!$map && $resid == 0 && $url =~/default\.sequence$/) { 8825: $title = $env{'course.'.$env{'request.course.id'}.'.description'}; 8826: } else { 8827: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8828: &GDBM_READER(),0640)) { 8829: my $mapid=$bighash{'map_pc_'.&clutter($map)}; 8830: $title=$bighash{'title_'.$mapid.'.'.$resid}; 8831: untie(%bighash); 8832: } 8833: } 8834: $title=~s/\&colon\;/\:/gs; 8835: if ($title) { 8836: return &do_cache_new('title',$key,$title,600); 8837: } 8838: $urlsymb=$url; 8839: } 8840: my $title=&metadata($urlsymb,'title'); 8841: if (!$title) { $title=(split('/',$urlsymb))[-1]; } 8842: return $title; 8843: } 8844: 8845: sub get_slot { 8846: my ($which,$cnum,$cdom)=@_; 8847: if (!$cnum || !$cdom) { 8848: (undef,my $courseid)=&whichuser(); 8849: $cdom=$env{'course.'.$courseid.'.domain'}; 8850: $cnum=$env{'course.'.$courseid.'.num'}; 8851: } 8852: my $key=join("\0",'slots',$cdom,$cnum,$which); 8853: my %slotinfo; 8854: if (exists($remembered{$key})) { 8855: $slotinfo{$which} = $remembered{$key}; 8856: } else { 8857: %slotinfo=&get('slots',[$which],$cdom,$cnum); 8858: &Apache::lonhomework::showhash(%slotinfo); 8859: my ($tmp)=keys(%slotinfo); 8860: if ($tmp=~/^error:/) { return (); } 8861: $remembered{$key} = $slotinfo{$which}; 8862: } 8863: if (ref($slotinfo{$which}) eq 'HASH') { 8864: return %{$slotinfo{$which}}; 8865: } 8866: return $slotinfo{$which}; 8867: } 8868: # ------------------------------------------------- Update symbolic store links 8869: 8870: sub symblist { 8871: my ($mapname,%newhash)=@_; 8872: $mapname=&deversion(&declutter($mapname)); 8873: my %hash; 8874: if (($env{'request.course.fn'}) && (%newhash)) { 8875: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 8876: &GDBM_WRCREAT(),0640)) { 8877: foreach my $url (keys(%newhash)) { 8878: next if ($url eq 'last_known' 8879: && $env{'form.no_update_last_known'}); 8880: $hash{declutter($url)}=&encode_symb($mapname, 8881: $newhash{$url}->[1], 8882: $newhash{$url}->[0]); 8883: } 8884: if (untie(%hash)) { 8885: return 'ok'; 8886: } 8887: } 8888: } 8889: return 'error'; 8890: } 8891: 8892: # --------------------------------------------------------------- Verify a symb 8893: 8894: sub symbverify { 8895: my ($symb,$thisurl)=@_; 8896: my $thisfn=$thisurl; 8897: $thisfn=&declutter($thisfn); 8898: # direct jump to resource in page or to a sequence - will construct own symbs 8899: if ($thisfn=~/\.(page|sequence)$/) { return 1; } 8900: # check URL part 8901: my ($map,$resid,$url)=&decode_symb($symb); 8902: 8903: unless ($url eq $thisfn) { return 0; } 8904: 8905: $symb=&symbclean($symb); 8906: $thisurl=&deversion($thisurl); 8907: $thisfn=&deversion($thisfn); 8908: 8909: my %bighash; 8910: my $okay=0; 8911: 8912: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8913: &GDBM_READER(),0640)) { 8914: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) { 8915: $thisurl =~ s/\?.+$//; 8916: } 8917: my $ids=$bighash{'ids_'.&clutter($thisurl)}; 8918: unless ($ids) { 8919: $ids=$bighash{'ids_/'.$thisurl}; 8920: } 8921: if ($ids) { 8922: # ------------------------------------------------------------------- Has ID(s) 8923: foreach my $id (split(/\,/,$ids)) { 8924: my ($mapid,$resid)=split(/\./,$id); 8925: if ($thisfn =~ m{^/adm/wrapper/ext/}) { 8926: $symb =~ s/\?.+$//; 8927: } 8928: if ( 8929: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn) 8930: eq $symb) { 8931: if (($env{'request.role.adv'}) || 8932: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) { 8933: $okay=1; 8934: } 8935: } 8936: } 8937: } 8938: untie(%bighash); 8939: } 8940: return $okay; 8941: } 8942: 8943: # --------------------------------------------------------------- Clean-up symb 8944: 8945: sub symbclean { 8946: my $symb=shift; 8947: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 8948: # remove version from map 8949: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/; 8950: 8951: # remove version from URL 8952: $symb=~s/\.(\d+)\.(\w+)$/\.$2/; 8953: 8954: # remove wrapper 8955: 8956: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/; 8957: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/; 8958: return $symb; 8959: } 8960: 8961: # ---------------------------------------------- Split symb to find map and url 8962: 8963: sub encode_symb { 8964: my ($map,$resid,$url)=@_; 8965: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url)); 8966: } 8967: 8968: sub decode_symb { 8969: my $symb=shift; 8970: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); } 8971: my ($map,$resid,$url)=split(/___/,$symb); 8972: return (&fixversion($map),$resid,&fixversion($url)); 8973: } 8974: 8975: sub fixversion { 8976: my $fn=shift; 8977: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; } 8978: my %bighash; 8979: my $uri=&clutter($fn); 8980: my $key=$env{'request.course.id'}.'_'.$uri; 8981: # is this cached? 8982: my ($result,$cached)=&is_cached_new('courseresversion',$key); 8983: if (defined($cached)) { return $result; } 8984: # unfortunately not cached, or expired 8985: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 8986: &GDBM_READER(),0640)) { 8987: if ($bighash{'version_'.$uri}) { 8988: my $version=$bighash{'version_'.$uri}; 8989: unless (($version eq 'mostrecent') || 8990: ($version==&getversion($uri))) { 8991: $uri=~s/\.(\w+)$/\.$version\.$1/; 8992: } 8993: } 8994: untie %bighash; 8995: } 8996: return &do_cache_new('courseresversion',$key,&declutter($uri),600); 8997: } 8998: 8999: sub deversion { 9000: my $url=shift; 9001: $url=~s/\.\d+\.(\w+)$/\.$1/; 9002: return $url; 9003: } 9004: 9005: # ------------------------------------------------------ Return symb list entry 9006: 9007: sub symbread { 9008: my ($thisfn,$donotrecurse)=@_; 9009: my $cache_str='request.symbread.cached.'.$thisfn; 9010: if (defined($env{$cache_str})) { return $env{$cache_str}; } 9011: # no filename provided? try from environment 9012: unless ($thisfn) { 9013: if ($env{'request.symb'}) { 9014: return $env{$cache_str}=&symbclean($env{'request.symb'}); 9015: } 9016: $thisfn=$env{'request.filename'}; 9017: } 9018: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 9019: # is that filename actually a symb? Verify, clean, and return 9020: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) { 9021: if (&symbverify($thisfn,$1)) { 9022: return $env{$cache_str}=&symbclean($thisfn); 9023: } 9024: } 9025: $thisfn=declutter($thisfn); 9026: my %hash; 9027: my %bighash; 9028: my $syval=''; 9029: if (($env{'request.course.fn'}) && ($thisfn)) { 9030: my $targetfn = $thisfn; 9031: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) { 9032: $targetfn = 'adm/wrapper/'.$thisfn; 9033: } 9034: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) { 9035: $targetfn=$1; 9036: } 9037: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', 9038: &GDBM_READER(),0640)) { 9039: $syval=$hash{$targetfn}; 9040: untie(%hash); 9041: } 9042: # ---------------------------------------------------------- There was an entry 9043: if ($syval) { 9044: #unless ($syval=~/\_\d+$/) { 9045: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) { 9046: #&appenv({'request.ambiguous' => $thisfn}); 9047: #return $env{$cache_str}=''; 9048: #} 9049: #$syval.=$1; 9050: #} 9051: } else { 9052: # ------------------------------------------------------- Was not in symb table 9053: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db', 9054: &GDBM_READER(),0640)) { 9055: # ---------------------------------------------- Get ID(s) for current resource 9056: my $ids=$bighash{'ids_'.&clutter($thisfn)}; 9057: unless ($ids) { 9058: $ids=$bighash{'ids_/'.$thisfn}; 9059: } 9060: unless ($ids) { 9061: # alias? 9062: $ids=$bighash{'mapalias_'.$thisfn}; 9063: } 9064: if ($ids) { 9065: # ------------------------------------------------------------------- Has ID(s) 9066: my @possibilities=split(/\,/,$ids); 9067: if ($#possibilities==0) { 9068: # ----------------------------------------------- There is only one possibility 9069: my ($mapid,$resid)=split(/\./,$ids); 9070: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 9071: $resid,$thisfn); 9072: } elsif (!$donotrecurse) { 9073: # ------------------------------------------ There is more than one possibility 9074: my $realpossible=0; 9075: foreach my $id (@possibilities) { 9076: my $file=$bighash{'src_'.$id}; 9077: if (&allowed('bre',$file)) { 9078: my ($mapid,$resid)=split(/\./,$id); 9079: if ($bighash{'map_type_'.$mapid} ne 'page') { 9080: $realpossible++; 9081: $syval=&encode_symb($bighash{'map_id_'.$mapid}, 9082: $resid,$thisfn); 9083: } 9084: } 9085: } 9086: if ($realpossible!=1) { $syval=''; } 9087: } else { 9088: $syval=''; 9089: } 9090: } 9091: untie(%bighash) 9092: } 9093: } 9094: if ($syval) { 9095: return $env{$cache_str}=$syval; 9096: } 9097: } 9098: &appenv({'request.ambiguous' => $thisfn}); 9099: return $env{$cache_str}=''; 9100: } 9101: 9102: # ---------------------------------------------------------- Return random seed 9103: 9104: sub numval { 9105: my $txt=shift; 9106: $txt=~tr/A-J/0-9/; 9107: $txt=~tr/a-j/0-9/; 9108: $txt=~tr/K-T/0-9/; 9109: $txt=~tr/k-t/0-9/; 9110: $txt=~tr/U-Z/0-5/; 9111: $txt=~tr/u-z/0-5/; 9112: $txt=~s/\D//g; 9113: if ($_64bit) { if ($txt > 2**32) { return -1; } } 9114: return int($txt); 9115: } 9116: 9117: sub numval2 { 9118: my $txt=shift; 9119: $txt=~tr/A-J/0-9/; 9120: $txt=~tr/a-j/0-9/; 9121: $txt=~tr/K-T/0-9/; 9122: $txt=~tr/k-t/0-9/; 9123: $txt=~tr/U-Z/0-5/; 9124: $txt=~tr/u-z/0-5/; 9125: $txt=~s/\D//g; 9126: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 9127: my $total; 9128: foreach my $val (@txts) { $total+=$val; } 9129: if ($_64bit) { if ($total > 2**32) { return -1; } } 9130: return int($total); 9131: } 9132: 9133: sub numval3 { 9134: use integer; 9135: my $txt=shift; 9136: $txt=~tr/A-J/0-9/; 9137: $txt=~tr/a-j/0-9/; 9138: $txt=~tr/K-T/0-9/; 9139: $txt=~tr/k-t/0-9/; 9140: $txt=~tr/U-Z/0-5/; 9141: $txt=~tr/u-z/0-5/; 9142: $txt=~s/\D//g; 9143: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt); 9144: my $total; 9145: foreach my $val (@txts) { $total+=$val; } 9146: if ($_64bit) { $total=(($total<<32)>>32); } 9147: return $total; 9148: } 9149: 9150: sub digest { 9151: my ($data)=@_; 9152: my $digest=&Digest::MD5::md5($data); 9153: my ($a,$b,$c,$d)=unpack("iiii",$digest); 9154: my ($e,$f); 9155: { 9156: use integer; 9157: $e=($a+$b); 9158: $f=($c+$d); 9159: if ($_64bit) { 9160: $e=(($e<<32)>>32); 9161: $f=(($f<<32)>>32); 9162: } 9163: } 9164: if (wantarray) { 9165: return ($e,$f); 9166: } else { 9167: my $g; 9168: { 9169: use integer; 9170: $g=($e+$f); 9171: if ($_64bit) { 9172: $g=(($g<<32)>>32); 9173: } 9174: } 9175: return $g; 9176: } 9177: } 9178: 9179: sub latest_rnd_algorithm_id { 9180: return '64bit5'; 9181: } 9182: 9183: sub get_rand_alg { 9184: my ($courseid)=@_; 9185: if (!$courseid) { $courseid=(&whichuser())[1]; } 9186: if ($courseid) { 9187: return $env{"course.$courseid.rndseed"}; 9188: } 9189: return &latest_rnd_algorithm_id(); 9190: } 9191: 9192: sub validCODE { 9193: my ($CODE)=@_; 9194: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; } 9195: return 0; 9196: } 9197: 9198: sub getCODE { 9199: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; } 9200: if ( (defined($Apache::lonhomework::parsing_a_problem) || 9201: defined($Apache::lonhomework::parsing_a_task) ) && 9202: &validCODE($Apache::lonhomework::history{'resource.CODE'})) { 9203: return $Apache::lonhomework::history{'resource.CODE'}; 9204: } 9205: return undef; 9206: } 9207: 9208: sub rndseed { 9209: my ($symb,$courseid,$domain,$username)=@_; 9210: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser(); 9211: if (!defined($symb)) { 9212: unless ($symb=$wsymb) { return time; } 9213: } 9214: if (!$courseid) { $courseid=$wcourseid; } 9215: if (!$domain) { $domain=$wdomain; } 9216: if (!$username) { $username=$wusername } 9217: my $which=&get_rand_alg(); 9218: 9219: if (defined(&getCODE())) { 9220: if ($which eq '64bit5') { 9221: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username); 9222: } elsif ($which eq '64bit4') { 9223: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username); 9224: } else { 9225: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username); 9226: } 9227: } elsif ($which eq '64bit5') { 9228: return &rndseed_64bit5($symb,$courseid,$domain,$username); 9229: } elsif ($which eq '64bit4') { 9230: return &rndseed_64bit4($symb,$courseid,$domain,$username); 9231: } elsif ($which eq '64bit3') { 9232: return &rndseed_64bit3($symb,$courseid,$domain,$username); 9233: } elsif ($which eq '64bit2') { 9234: return &rndseed_64bit2($symb,$courseid,$domain,$username); 9235: } elsif ($which eq '64bit') { 9236: return &rndseed_64bit($symb,$courseid,$domain,$username); 9237: } 9238: return &rndseed_32bit($symb,$courseid,$domain,$username); 9239: } 9240: 9241: sub rndseed_32bit { 9242: my ($symb,$courseid,$domain,$username)=@_; 9243: { 9244: use integer; 9245: my $symbchck=unpack("%32C*",$symb) << 27; 9246: my $symbseed=numval($symb) << 22; 9247: my $namechck=unpack("%32C*",$username) << 17; 9248: my $nameseed=numval($username) << 12; 9249: my $domainseed=unpack("%32C*",$domain) << 7; 9250: my $courseseed=unpack("%32C*",$courseid); 9251: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck; 9252: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9253: #&logthis("rndseed :$num:$symb"); 9254: if ($_64bit) { $num=(($num<<32)>>32); } 9255: return $num; 9256: } 9257: } 9258: 9259: sub rndseed_64bit { 9260: my ($symb,$courseid,$domain,$username)=@_; 9261: { 9262: use integer; 9263: my $symbchck=unpack("%32S*",$symb) << 21; 9264: my $symbseed=numval($symb) << 10; 9265: my $namechck=unpack("%32S*",$username); 9266: 9267: my $nameseed=numval($username) << 21; 9268: my $domainseed=unpack("%32S*",$domain) << 10; 9269: my $courseseed=unpack("%32S*",$courseid); 9270: 9271: my $num1=$symbchck+$symbseed+$namechck; 9272: my $num2=$nameseed+$domainseed+$courseseed; 9273: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9274: #&logthis("rndseed :$num:$symb"); 9275: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9276: return "$num1,$num2"; 9277: } 9278: } 9279: 9280: sub rndseed_64bit2 { 9281: my ($symb,$courseid,$domain,$username)=@_; 9282: { 9283: use integer; 9284: # strings need to be an even # of cahracters long, it it is odd the 9285: # last characters gets thrown away 9286: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9287: my $symbseed=numval($symb) << 10; 9288: my $namechck=unpack("%32S*",$username.' '); 9289: 9290: my $nameseed=numval($username) << 21; 9291: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9292: my $courseseed=unpack("%32S*",$courseid.' '); 9293: 9294: my $num1=$symbchck+$symbseed+$namechck; 9295: my $num2=$nameseed+$domainseed+$courseseed; 9296: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9297: #&logthis("rndseed :$num:$symb"); 9298: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9299: return "$num1,$num2"; 9300: } 9301: } 9302: 9303: sub rndseed_64bit3 { 9304: my ($symb,$courseid,$domain,$username)=@_; 9305: { 9306: use integer; 9307: # strings need to be an even # of cahracters long, it it is odd the 9308: # last characters gets thrown away 9309: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9310: my $symbseed=numval2($symb) << 10; 9311: my $namechck=unpack("%32S*",$username.' '); 9312: 9313: my $nameseed=numval2($username) << 21; 9314: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9315: my $courseseed=unpack("%32S*",$courseid.' '); 9316: 9317: my $num1=$symbchck+$symbseed+$namechck; 9318: my $num2=$nameseed+$domainseed+$courseseed; 9319: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9320: #&logthis("rndseed :$num1:$num2:$_64bit"); 9321: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9322: 9323: return "$num1:$num2"; 9324: } 9325: } 9326: 9327: sub rndseed_64bit4 { 9328: my ($symb,$courseid,$domain,$username)=@_; 9329: { 9330: use integer; 9331: # strings need to be an even # of cahracters long, it it is odd the 9332: # last characters gets thrown away 9333: my $symbchck=unpack("%32S*",$symb.' ') << 21; 9334: my $symbseed=numval3($symb) << 10; 9335: my $namechck=unpack("%32S*",$username.' '); 9336: 9337: my $nameseed=numval3($username) << 21; 9338: my $domainseed=unpack("%32S*",$domain.' ') << 10; 9339: my $courseseed=unpack("%32S*",$courseid.' '); 9340: 9341: my $num1=$symbchck+$symbseed+$namechck; 9342: my $num2=$nameseed+$domainseed+$courseseed; 9343: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck"); 9344: #&logthis("rndseed :$num1:$num2:$_64bit"); 9345: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); } 9346: 9347: return "$num1:$num2"; 9348: } 9349: } 9350: 9351: sub rndseed_64bit5 { 9352: my ($symb,$courseid,$domain,$username)=@_; 9353: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username"); 9354: return "$num1:$num2"; 9355: } 9356: 9357: sub rndseed_CODE_64bit { 9358: my ($symb,$courseid,$domain,$username)=@_; 9359: { 9360: use integer; 9361: my $symbchck=unpack("%32S*",$symb.' ') << 16; 9362: my $symbseed=numval2($symb); 9363: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 9364: my $CODEseed=numval(&getCODE()); 9365: my $courseseed=unpack("%32S*",$courseid.' '); 9366: my $num1=$symbseed+$CODEchck; 9367: my $num2=$CODEseed+$courseseed+$symbchck; 9368: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 9369: #&logthis("rndseed :$num1:$num2:$symb"); 9370: if ($_64bit) { $num1=(($num1<<32)>>32); } 9371: if ($_64bit) { $num2=(($num2<<32)>>32); } 9372: return "$num1:$num2"; 9373: } 9374: } 9375: 9376: sub rndseed_CODE_64bit4 { 9377: my ($symb,$courseid,$domain,$username)=@_; 9378: { 9379: use integer; 9380: my $symbchck=unpack("%32S*",$symb.' ') << 16; 9381: my $symbseed=numval3($symb); 9382: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16; 9383: my $CODEseed=numval3(&getCODE()); 9384: my $courseseed=unpack("%32S*",$courseid.' '); 9385: my $num1=$symbseed+$CODEchck; 9386: my $num2=$CODEseed+$courseseed+$symbchck; 9387: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck"); 9388: #&logthis("rndseed :$num1:$num2:$symb"); 9389: if ($_64bit) { $num1=(($num1<<32)>>32); } 9390: if ($_64bit) { $num2=(($num2<<32)>>32); } 9391: return "$num1:$num2"; 9392: } 9393: } 9394: 9395: sub rndseed_CODE_64bit5 { 9396: my ($symb,$courseid,$domain,$username)=@_; 9397: my $code = &getCODE(); 9398: my ($num1,$num2)=&digest("$symb,$courseid,$code"); 9399: return "$num1:$num2"; 9400: } 9401: 9402: sub setup_random_from_rndseed { 9403: my ($rndseed)=@_; 9404: if ($rndseed =~/([,:])/) { 9405: my ($num1,$num2)=split(/[,:]/,$rndseed); 9406: &Math::Random::random_set_seed(abs($num1),abs($num2)); 9407: } else { 9408: &Math::Random::random_set_seed_from_phrase($rndseed); 9409: } 9410: } 9411: 9412: sub latest_receipt_algorithm_id { 9413: return 'receipt3'; 9414: } 9415: 9416: sub recunique { 9417: my $fucourseid=shift; 9418: my $unique; 9419: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' || 9420: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 9421: $unique=$env{"course.$fucourseid.internal.encseed"}; 9422: } else { 9423: $unique=$perlvar{'lonReceipt'}; 9424: } 9425: return unpack("%32C*",$unique); 9426: } 9427: 9428: sub recprefix { 9429: my $fucourseid=shift; 9430: my $prefix; 9431: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'|| 9432: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) { 9433: $prefix=$env{"course.$fucourseid.internal.encpref"}; 9434: } else { 9435: $prefix=$perlvar{'lonHostID'}; 9436: } 9437: return unpack("%32C*",$prefix); 9438: } 9439: 9440: sub ireceipt { 9441: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_; 9442: 9443: my $return =&recprefix($fucourseid).'-'; 9444: 9445: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' || 9446: $env{'request.state'} eq 'construct') { 9447: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000); 9448: return $return; 9449: } 9450: 9451: my $cuname=unpack("%32C*",$funame); 9452: my $cudom=unpack("%32C*",$fudom); 9453: my $cucourseid=unpack("%32C*",$fucourseid); 9454: my $cusymb=unpack("%32C*",$fusymb); 9455: my $cunique=&recunique($fucourseid); 9456: my $cpart=unpack("%32S*",$part); 9457: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') { 9458: 9459: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom)); 9460: 9461: $return.= ($cunique%$cuname+ 9462: $cunique%$cudom+ 9463: $cusymb%$cuname+ 9464: $cusymb%$cudom+ 9465: $cucourseid%$cuname+ 9466: $cucourseid%$cudom+ 9467: $cpart%$cuname+ 9468: $cpart%$cudom); 9469: } else { 9470: $return.= ($cunique%$cuname+ 9471: $cunique%$cudom+ 9472: $cusymb%$cuname+ 9473: $cusymb%$cudom+ 9474: $cucourseid%$cuname+ 9475: $cucourseid%$cudom); 9476: } 9477: return $return; 9478: } 9479: 9480: sub receipt { 9481: my ($part)=@_; 9482: my ($symb,$courseid,$domain,$name) = &whichuser(); 9483: return &ireceipt($name,$domain,$courseid,$symb,$part); 9484: } 9485: 9486: sub whichuser { 9487: my ($passedsymb)=@_; 9488: my ($symb,$courseid,$domain,$name,$publicuser); 9489: if (defined($env{'form.grade_symb'})) { 9490: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid'); 9491: my $allowed=&allowed('vgr',$tmp_courseid); 9492: if (!$allowed && 9493: exists($env{'request.course.sec'}) && 9494: $env{'request.course.sec'} !~ /^\s*$/) { 9495: $allowed=&allowed('vgr',$tmp_courseid. 9496: '/'.$env{'request.course.sec'}); 9497: } 9498: if ($allowed) { 9499: ($symb)=&get_env_multiple('form.grade_symb'); 9500: $courseid=$tmp_courseid; 9501: ($domain)=&get_env_multiple('form.grade_domain'); 9502: ($name)=&get_env_multiple('form.grade_username'); 9503: return ($symb,$courseid,$domain,$name,$publicuser); 9504: } 9505: } 9506: if (!$passedsymb) { 9507: $symb=&symbread(); 9508: } else { 9509: $symb=$passedsymb; 9510: } 9511: $courseid=$env{'request.course.id'}; 9512: $domain=$env{'user.domain'}; 9513: $name=$env{'user.name'}; 9514: if ($name eq 'public' && $domain eq 'public') { 9515: if (!defined($env{'form.username'})) { 9516: $env{'form.username'}.=time.rand(10000000); 9517: } 9518: $name.=$env{'form.username'}; 9519: } 9520: return ($symb,$courseid,$domain,$name,$publicuser); 9521: 9522: } 9523: 9524: # ------------------------------------------------------------ Serves up a file 9525: # returns either the contents of the file or 9526: # -1 if the file doesn't exist 9527: # 9528: # if the target is a file that was uploaded via DOCS, 9529: # a check will be made to see if a current copy exists on the local server, 9530: # if it does this will be served, otherwise a copy will be retrieved from 9531: # the home server for the course and stored in /home/httpd/html/userfiles on 9532: # the local server. 9533: 9534: sub getfile { 9535: my ($file) = @_; 9536: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9537: &repcopy($file); 9538: return &readfile($file); 9539: } 9540: 9541: sub repcopy_userfile { 9542: my ($file)=@_; 9543: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); } 9544: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; } 9545: my ($cdom,$cnum,$filename) = 9546: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|); 9547: my $uri="/uploaded/$cdom/$cnum/$filename"; 9548: if (-e "$file") { 9549: # we already have a local copy, check it out 9550: my @fileinfo = stat($file); 9551: my $rtncode; 9552: my $info; 9553: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode); 9554: if ($lwpresp ne 'ok') { 9555: # there is no such file anymore, even though we had a local copy 9556: if ($rtncode eq '404') { 9557: unlink($file); 9558: } 9559: return -1; 9560: } 9561: if ($info < $fileinfo[9]) { 9562: # nice, the file we have is up-to-date, just say okay 9563: return 'ok'; 9564: } else { 9565: # the file is outdated, get rid of it 9566: unlink($file); 9567: } 9568: } 9569: # one way or the other, at this point, we don't have the file 9570: # construct the correct path for the file 9571: my @parts = ($cdom,$cnum); 9572: if ($filename =~ m|^(.+)/[^/]+$|) { 9573: push @parts, split(/\//,$1); 9574: } 9575: my $path = $perlvar{'lonDocRoot'}.'/userfiles'; 9576: foreach my $part (@parts) { 9577: $path .= '/'.$part; 9578: if (!-e $path) { 9579: mkdir($path,0770); 9580: } 9581: } 9582: # now the path exists for sure 9583: # get a user agent 9584: my $ua=new LWP::UserAgent; 9585: my $transferfile=$file.'.in.transfer'; 9586: # FIXME: this should flock 9587: if (-e $transferfile) { return 'ok'; } 9588: my $request; 9589: $uri=~s/^\///; 9590: my $homeserver = &homeserver($cnum,$cdom); 9591: my $protocol = $protocol{$homeserver}; 9592: $protocol = 'http' if ($protocol ne 'https'); 9593: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri); 9594: my $response=$ua->request($request,$transferfile); 9595: # did it work? 9596: if ($response->is_error()) { 9597: unlink($transferfile); 9598: &logthis("Userfile repcopy failed for $uri"); 9599: return -1; 9600: } 9601: # worked, rename the transfer file 9602: rename($transferfile,$file); 9603: return 'ok'; 9604: } 9605: 9606: sub tokenwrapper { 9607: my $uri=shift; 9608: $uri=~s|^https?\://([^/]+)||; 9609: $uri=~s|^/||; 9610: $env{'user.environment'}=~/\/([^\/]+)\.id/; 9611: my $token=$1; 9612: my (undef,$udom,$uname,$file)=split('/',$uri,4); 9613: if ($udom && $uname && $file) { 9614: $file=~s|(\?\.*)*$||; 9615: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}}); 9616: my $homeserver = &homeserver($uname,$udom); 9617: my $protocol = $protocol{$homeserver}; 9618: $protocol = 'http' if ($protocol ne 'https'); 9619: return $protocol.'://'.&hostname($homeserver).'/'.$uri. 9620: (($uri=~/\?/)?'&':'?').'token='.$token. 9621: '&tokenissued='.$perlvar{'lonHostID'}; 9622: } else { 9623: return '/adm/notfound.html'; 9624: } 9625: } 9626: 9627: # call with reqtype HEAD: get last modification time 9628: # call with reqtype GET: get the file contents 9629: # Do not call this with reqtype GET for large files! It loads everything into memory 9630: # 9631: sub getuploaded { 9632: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_; 9633: $uri=~s/^\///; 9634: my $homeserver = &homeserver($cnum,$cdom); 9635: my $protocol = $protocol{$homeserver}; 9636: $protocol = 'http' if ($protocol ne 'https'); 9637: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri; 9638: my $ua=new LWP::UserAgent; 9639: my $request=new HTTP::Request($reqtype,$uri); 9640: my $response=$ua->request($request); 9641: $$rtncode = $response->code; 9642: if (! $response->is_success()) { 9643: return 'failed'; 9644: } 9645: if ($reqtype eq 'HEAD') { 9646: $$info = &HTTP::Date::str2time( $response->header('Last-modified') ); 9647: } elsif ($reqtype eq 'GET') { 9648: $$info = $response->content; 9649: } 9650: return 'ok'; 9651: } 9652: 9653: sub readfile { 9654: my $file = shift; 9655: if ( (! -e $file ) || ($file eq '') ) { return -1; }; 9656: my $fh; 9657: open($fh,"<$file"); 9658: my $a=''; 9659: while (my $line = <$fh>) { $a .= $line; } 9660: return $a; 9661: } 9662: 9663: sub filelocation { 9664: my ($dir,$file) = @_; 9665: my $location; 9666: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces 9667: 9668: if ($file =~ m-^/adm/-) { 9669: $file=~s-^/adm/wrapper/-/-; 9670: $file=~s-^/adm/coursedocs/showdoc/-/-; 9671: } 9672: 9673: if ($file=~m:^/~:) { # is a contruction space reference 9674: $location = $file; 9675: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:; 9676: } elsif ($file=~m{^/home/$match_username/public_html/}) { 9677: # is a correct contruction space reference 9678: $location = $file; 9679: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) { 9680: $location = $file; 9681: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file 9682: my ($udom,$uname,$filename)= 9683: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-); 9684: my $home=&homeserver($uname,$udom); 9685: my $is_me=0; 9686: my @ids=&current_machine_ids(); 9687: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } } 9688: if ($is_me) { 9689: $location=&propath($udom,$uname).'/userfiles/'.$filename; 9690: } else { 9691: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'. 9692: $udom.'/'.$uname.'/'.$filename; 9693: } 9694: } elsif ($file =~ m-^/adm/-) { 9695: $location = $perlvar{'lonDocRoot'}.'/'.$file; 9696: } else { 9697: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9698: $file=~s:^/res/:/:; 9699: if ( !( $file =~ m:^/:) ) { 9700: $location = $dir. '/'.$file; 9701: } else { 9702: $location = '/home/httpd/html/res'.$file; 9703: } 9704: } 9705: $location=~s://+:/:g; # remove duplicate / 9706: while ($location=~m{/\.\./}) { 9707: if ($location =~ m{/[^/]+/\.\./}) { 9708: $location=~ s{/[^/]+/\.\./}{/}g; 9709: } else { 9710: $location=~ s{/\.\./}{/}g; 9711: } 9712: } #remove dir/.. 9713: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./ 9714: return $location; 9715: } 9716: 9717: sub hreflocation { 9718: my ($dir,$file)=@_; 9719: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) { 9720: $file=filelocation($dir,$file); 9721: } elsif ($file=~m-^/adm/-) { 9722: $file=~s-^/adm/wrapper/-/-; 9723: $file=~s-^/adm/coursedocs/showdoc/-/-; 9724: } 9725: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) { 9726: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--; 9727: } elsif ($file=~m-/home/($match_username)/public_html/-) { 9728: $file=~s-^/home/($match_username)/public_html/-/~$1/-; 9729: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) { 9730: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/ 9731: -/uploaded/$1/$2/-x; 9732: } 9733: if ($file=~ m{^/userfiles/}) { 9734: $file =~ s{^/userfiles/}{/uploaded/}; 9735: } 9736: return $file; 9737: } 9738: 9739: sub current_machine_domains { 9740: return &machine_domains(&hostname($perlvar{'lonHostID'})); 9741: } 9742: 9743: sub machine_domains { 9744: my ($hostname) = @_; 9745: my @domains; 9746: my %hostname = &all_hostnames(); 9747: while( my($id, $name) = each(%hostname)) { 9748: # &logthis("-$id-$name-$hostname-"); 9749: if ($hostname eq $name) { 9750: push(@domains,&host_domain($id)); 9751: } 9752: } 9753: return @domains; 9754: } 9755: 9756: sub current_machine_ids { 9757: return &machine_ids(&hostname($perlvar{'lonHostID'})); 9758: } 9759: 9760: sub machine_ids { 9761: my ($hostname) = @_; 9762: $hostname ||= &hostname($perlvar{'lonHostID'}); 9763: my @ids; 9764: my %name_to_host = &all_names(); 9765: if (ref($name_to_host{$hostname}) eq 'ARRAY') { 9766: return @{ $name_to_host{$hostname} }; 9767: } 9768: return; 9769: } 9770: 9771: sub additional_machine_domains { 9772: my @domains; 9773: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab"); 9774: while( my $line = <$fh>) { 9775: $line =~ s/\s//g; 9776: push(@domains,$line); 9777: } 9778: return @domains; 9779: } 9780: 9781: sub default_login_domain { 9782: my $domain = $perlvar{'lonDefDomain'}; 9783: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0]; 9784: foreach my $posdom (&current_machine_domains(), 9785: &additional_machine_domains()) { 9786: if (lc($posdom) eq lc($testdomain)) { 9787: $domain=$posdom; 9788: last; 9789: } 9790: } 9791: return $domain; 9792: } 9793: 9794: # ------------------------------------------------------------- Declutters URLs 9795: 9796: sub declutter { 9797: my $thisfn=shift; 9798: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); } 9799: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//; 9800: $thisfn=~s/^\///; 9801: $thisfn=~s|^adm/wrapper/||; 9802: $thisfn=~s|^adm/coursedocs/showdoc/||; 9803: $thisfn=~s/^res\///; 9804: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) { 9805: $thisfn=~s/\?.+$//; 9806: } 9807: return $thisfn; 9808: } 9809: 9810: # ------------------------------------------------------------- Clutter up URLs 9811: 9812: sub clutter { 9813: my $thisfn='/'.&declutter(shift); 9814: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/} 9815: || $thisfn =~ m{^/adm/(includes|pages)} ) { 9816: $thisfn='/res'.$thisfn; 9817: } 9818: if ($thisfn !~m|^/adm|) { 9819: if ($thisfn =~ m|^/ext/|) { 9820: $thisfn='/adm/wrapper'.$thisfn; 9821: } else { 9822: my ($ext) = ($thisfn =~ /\.(\w+)$/); 9823: my $embstyle=&Apache::loncommon::fileembstyle($ext); 9824: if ($embstyle eq 'ssi' 9825: || ($embstyle eq 'hdn') 9826: || ($embstyle eq 'rat') 9827: || ($embstyle eq 'prv') 9828: || ($embstyle eq 'ign')) { 9829: #do nothing with these 9830: } elsif (($embstyle eq 'img') 9831: || ($embstyle eq 'emb') 9832: || ($embstyle eq 'wrp')) { 9833: $thisfn='/adm/wrapper'.$thisfn; 9834: } elsif ($embstyle eq 'unk' 9835: && $thisfn!~/\.(sequence|page)$/) { 9836: $thisfn='/adm/coursedocs/showdoc'.$thisfn; 9837: } else { 9838: # &logthis("Got a blank emb style"); 9839: } 9840: } 9841: } 9842: return $thisfn; 9843: } 9844: 9845: sub clutter_with_no_wrapper { 9846: my $uri = &clutter(shift); 9847: if ($uri =~ m-^/adm/-) { 9848: $uri =~ s-^/adm/wrapper/-/-; 9849: $uri =~ s-^/adm/coursedocs/showdoc/-/-; 9850: } 9851: return $uri; 9852: } 9853: 9854: sub freeze_escape { 9855: my ($value)=@_; 9856: if (ref($value)) { 9857: $value=&nfreeze($value); 9858: return '__FROZEN__'.&escape($value); 9859: } 9860: return &escape($value); 9861: } 9862: 9863: 9864: sub thaw_unescape { 9865: my ($value)=@_; 9866: if ($value =~ /^__FROZEN__/) { 9867: substr($value,0,10,undef); 9868: $value=&unescape($value); 9869: return &thaw($value); 9870: } 9871: return &unescape($value); 9872: } 9873: 9874: sub correct_line_ends { 9875: my ($result)=@_; 9876: $$result =~s/\r\n/\n/mg; 9877: $$result =~s/\r/\n/mg; 9878: } 9879: # ================================================================ Main Program 9880: 9881: sub goodbye { 9882: &logthis("Starting Shut down"); 9883: #not converted to using infrastruture and probably shouldn't be 9884: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache)))); 9885: #converted 9886: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache))); 9887: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache)))); 9888: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache)))); 9889: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache)))); 9890: #1.1 only 9891: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache)))); 9892: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache)))); 9893: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache)))); 9894: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache)))); 9895: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered)))); 9896: &logthis(sprintf("%-20s is %s",'kicks',$kicks)); 9897: &logthis(sprintf("%-20s is %s",'hits',$hits)); 9898: &flushcourselogs(); 9899: &logthis("Shutting down"); 9900: } 9901: 9902: sub get_dns { 9903: my ($url,$func,$ignore_cache) = @_; 9904: if (!$ignore_cache) { 9905: my ($content,$cached)= 9906: &Apache::lonnet::is_cached_new('dns',$url); 9907: if ($cached) { 9908: &$func($content); 9909: return; 9910: } 9911: } 9912: 9913: my %alldns; 9914: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 9915: foreach my $dns (<$config>) { 9916: next if ($dns !~ /^\^(\S*)/x); 9917: my $line = $1; 9918: my ($host,$protocol) = split(/:/,$line); 9919: if ($protocol ne 'https') { 9920: $protocol = 'http'; 9921: } 9922: $alldns{$host} = $protocol; 9923: } 9924: while (%alldns) { 9925: my ($dns) = keys(%alldns); 9926: my $ua=new LWP::UserAgent; 9927: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url"); 9928: my $response=$ua->request($request); 9929: delete($alldns{$dns}); 9930: next if ($response->is_error()); 9931: my @content = split("\n",$response->content); 9932: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60); 9933: &$func(\@content); 9934: return; 9935: } 9936: close($config); 9937: my $which = (split('/',$url))[3]; 9938: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n"); 9939: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab"); 9940: my @content = <$config>; 9941: &$func(\@content); 9942: return; 9943: } 9944: # ------------------------------------------------------------ Read domain file 9945: { 9946: my $loaded; 9947: my %domain; 9948: 9949: sub parse_domain_tab { 9950: my ($lines) = @_; 9951: foreach my $line (@$lines) { 9952: next if ($line =~ /^(\#|\s*$ )/x); 9953: 9954: chomp($line); 9955: my ($name,@elements) = split(/:/,$line,9); 9956: my %this_domain; 9957: foreach my $field ('description', 'auth_def', 'auth_arg_def', 9958: 'lang_def', 'city', 'longi', 'lati', 9959: 'primary') { 9960: $this_domain{$field} = shift(@elements); 9961: } 9962: $domain{$name} = \%this_domain; 9963: } 9964: } 9965: 9966: sub reset_domain_info { 9967: undef($loaded); 9968: undef(%domain); 9969: } 9970: 9971: sub load_domain_tab { 9972: my ($ignore_cache) = @_; 9973: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache); 9974: my $fh; 9975: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) { 9976: my @lines = <$fh>; 9977: &parse_domain_tab(\@lines); 9978: } 9979: close($fh); 9980: $loaded = 1; 9981: } 9982: 9983: sub domain { 9984: &load_domain_tab() if (!$loaded); 9985: 9986: my ($name,$what) = @_; 9987: return if ( !exists($domain{$name}) ); 9988: 9989: if (!$what) { 9990: return $domain{$name}{'description'}; 9991: } 9992: return $domain{$name}{$what}; 9993: } 9994: 9995: sub domain_info { 9996: &load_domain_tab() if (!$loaded); 9997: return %domain; 9998: } 9999: 10000: } 10001: 10002: 10003: # ------------------------------------------------------------- Read hosts file 10004: { 10005: my %hostname; 10006: my %hostdom; 10007: my %libserv; 10008: my $loaded; 10009: my %name_to_host; 10010: my %internetdom; 10011: 10012: sub parse_hosts_tab { 10013: my ($file) = @_; 10014: foreach my $configline (@$file) { 10015: next if ($configline =~ /^(\#|\s*$ )/x); 10016: next if ($configline =~ /^\^/); 10017: chomp($configline); 10018: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline); 10019: $name=~s/\s//g; 10020: if ($id && $domain && $role && $name) { 10021: $hostname{$id}=$name; 10022: push(@{$name_to_host{$name}}, $id); 10023: $hostdom{$id}=$domain; 10024: if ($role eq 'library') { $libserv{$id}=$name; } 10025: if (defined($protocol)) { 10026: if ($protocol eq 'https') { 10027: $protocol{$id} = $protocol; 10028: } else { 10029: $protocol{$id} = 'http'; 10030: } 10031: } else { 10032: $protocol{$id} = 'http'; 10033: } 10034: if (defined($intdom)) { 10035: $internetdom{$id} = $intdom; 10036: } 10037: } 10038: } 10039: } 10040: 10041: sub reset_hosts_info { 10042: &purge_remembered(); 10043: &reset_domain_info(); 10044: &reset_hosts_ip_info(); 10045: undef(%name_to_host); 10046: undef(%hostname); 10047: undef(%hostdom); 10048: undef(%libserv); 10049: undef($loaded); 10050: } 10051: 10052: sub load_hosts_tab { 10053: my ($ignore_cache) = @_; 10054: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache); 10055: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab"); 10056: my @config = <$config>; 10057: &parse_hosts_tab(\@config); 10058: close($config); 10059: $loaded=1; 10060: } 10061: 10062: sub hostname { 10063: &load_hosts_tab() if (!$loaded); 10064: 10065: my ($lonid) = @_; 10066: return $hostname{$lonid}; 10067: } 10068: 10069: sub all_hostnames { 10070: &load_hosts_tab() if (!$loaded); 10071: 10072: return %hostname; 10073: } 10074: 10075: sub all_names { 10076: &load_hosts_tab() if (!$loaded); 10077: 10078: return %name_to_host; 10079: } 10080: 10081: sub all_host_domain { 10082: &load_hosts_tab() if (!$loaded); 10083: return %hostdom; 10084: } 10085: 10086: sub is_library { 10087: &load_hosts_tab() if (!$loaded); 10088: 10089: return exists($libserv{$_[0]}); 10090: } 10091: 10092: sub all_library { 10093: &load_hosts_tab() if (!$loaded); 10094: 10095: return %libserv; 10096: } 10097: 10098: sub unique_library { 10099: #2x reverse removes all hostnames that appear more than once 10100: my %unique = reverse &all_library(); 10101: return reverse %unique; 10102: } 10103: 10104: sub get_servers { 10105: &load_hosts_tab() if (!$loaded); 10106: 10107: my ($domain,$type) = @_; 10108: my %possible_hosts = ($type eq 'library') ? %libserv 10109: : %hostname; 10110: my %result; 10111: if (ref($domain) eq 'ARRAY') { 10112: while ( my ($host,$hostname) = each(%possible_hosts)) { 10113: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) { 10114: $result{$host} = $hostname; 10115: } 10116: } 10117: } else { 10118: while ( my ($host,$hostname) = each(%possible_hosts)) { 10119: if ($hostdom{$host} eq $domain) { 10120: $result{$host} = $hostname; 10121: } 10122: } 10123: } 10124: return %result; 10125: } 10126: 10127: sub get_unique_servers { 10128: my %unique = reverse &get_servers(@_); 10129: return reverse %unique; 10130: } 10131: 10132: sub host_domain { 10133: &load_hosts_tab() if (!$loaded); 10134: 10135: my ($lonid) = @_; 10136: return $hostdom{$lonid}; 10137: } 10138: 10139: sub all_domains { 10140: &load_hosts_tab() if (!$loaded); 10141: 10142: my %seen; 10143: my @uniq = grep(!$seen{$_}++, values(%hostdom)); 10144: return @uniq; 10145: } 10146: 10147: sub internet_dom { 10148: &load_hosts_tab() if (!$loaded); 10149: 10150: my ($lonid) = @_; 10151: return $internetdom{$lonid}; 10152: } 10153: } 10154: 10155: { 10156: my %iphost; 10157: my %name_to_ip; 10158: my %lonid_to_ip; 10159: 10160: sub get_hosts_from_ip { 10161: my ($ip) = @_; 10162: my %iphosts = &get_iphost(); 10163: if (ref($iphosts{$ip})) { 10164: return @{$iphosts{$ip}}; 10165: } 10166: return; 10167: } 10168: 10169: sub reset_hosts_ip_info { 10170: undef(%iphost); 10171: undef(%name_to_ip); 10172: undef(%lonid_to_ip); 10173: } 10174: 10175: sub get_host_ip { 10176: my ($lonid) = @_; 10177: if (exists($lonid_to_ip{$lonid})) { 10178: return $lonid_to_ip{$lonid}; 10179: } 10180: my $name=&hostname($lonid); 10181: my $ip = gethostbyname($name); 10182: return if (!$ip || length($ip) ne 4); 10183: $ip=inet_ntoa($ip); 10184: $name_to_ip{$name} = $ip; 10185: $lonid_to_ip{$lonid} = $ip; 10186: return $ip; 10187: } 10188: 10189: sub get_iphost { 10190: my ($ignore_cache) = @_; 10191: 10192: if (!$ignore_cache) { 10193: if (%iphost) { 10194: return %iphost; 10195: } 10196: my ($ip_info,$cached)= 10197: &Apache::lonnet::is_cached_new('iphost','iphost'); 10198: if ($cached) { 10199: %iphost = %{$ip_info->[0]}; 10200: %name_to_ip = %{$ip_info->[1]}; 10201: %lonid_to_ip = %{$ip_info->[2]}; 10202: return %iphost; 10203: } 10204: } 10205: 10206: # get yesterday's info for fallback 10207: my %old_name_to_ip; 10208: my ($ip_info,$cached)= 10209: &Apache::lonnet::is_cached_new('iphost','iphost'); 10210: if ($cached) { 10211: %old_name_to_ip = %{$ip_info->[1]}; 10212: } 10213: 10214: my %name_to_host = &all_names(); 10215: foreach my $name (keys(%name_to_host)) { 10216: my $ip; 10217: if (!exists($name_to_ip{$name})) { 10218: $ip = gethostbyname($name); 10219: if (!$ip || length($ip) ne 4) { 10220: if (defined($old_name_to_ip{$name})) { 10221: $ip = $old_name_to_ip{$name}; 10222: &logthis("Can't find $name defaulting to old $ip"); 10223: } else { 10224: &logthis("Name $name no IP found"); 10225: next; 10226: } 10227: } else { 10228: $ip=inet_ntoa($ip); 10229: } 10230: $name_to_ip{$name} = $ip; 10231: } else { 10232: $ip = $name_to_ip{$name}; 10233: } 10234: foreach my $id (@{ $name_to_host{$name} }) { 10235: $lonid_to_ip{$id} = $ip; 10236: } 10237: push(@{$iphost{$ip}},@{$name_to_host{$name}}); 10238: } 10239: &Apache::lonnet::do_cache_new('iphost','iphost', 10240: [\%iphost,\%name_to_ip,\%lonid_to_ip], 10241: 48*60*60); 10242: 10243: return %iphost; 10244: } 10245: 10246: # 10247: # Given a DNS returns the loncapa host name for that DNS 10248: # 10249: sub host_from_dns { 10250: my ($dns) = @_; 10251: my @hosts; 10252: my $ip; 10253: 10254: if (exists($name_to_ip{$dns})) { 10255: $ip = $name_to_ip{$dns}; 10256: } 10257: if (!$ip) { 10258: $ip = gethostbyname($dns); # Initial translation to IP is in net order. 10259: if (length($ip) == 4) { 10260: $ip = &IO::Socket::inet_ntoa($ip); 10261: } 10262: } 10263: if ($ip) { 10264: @hosts = get_hosts_from_ip($ip); 10265: return $hosts[0]; 10266: } 10267: return undef; 10268: } 10269: 10270: sub get_internet_names { 10271: my ($lonid) = @_; 10272: return if ($lonid eq ''); 10273: my ($idnref,$cached)= 10274: &Apache::lonnet::is_cached_new('internetnames',$lonid); 10275: if ($cached) { 10276: return $idnref; 10277: } 10278: my $ip = &get_host_ip($lonid); 10279: my @hosts = &get_hosts_from_ip($ip); 10280: my %iphost = &get_iphost(); 10281: my (@idns,%seen); 10282: foreach my $id (@hosts) { 10283: my $dom = &host_domain($id); 10284: my $prim_id = &domain($dom,'primary'); 10285: my $prim_ip = &get_host_ip($prim_id); 10286: next if ($seen{$prim_ip}); 10287: if (ref($iphost{$prim_ip}) eq 'ARRAY') { 10288: foreach my $id (@{$iphost{$prim_ip}}) { 10289: my $intdom = &internet_dom($id); 10290: unless (grep(/^\Q$intdom\E$/,@idns)) { 10291: push(@idns,$intdom); 10292: } 10293: } 10294: } 10295: $seen{$prim_ip} = 1; 10296: } 10297: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60); 10298: } 10299: 10300: } 10301: 10302: sub all_loncaparevs { 10303: 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); 10304: } 10305: 10306: BEGIN { 10307: 10308: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf 10309: unless ($readit) { 10310: { 10311: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf'); 10312: %perlvar = (%perlvar,%{$configvars}); 10313: } 10314: 10315: 10316: # ------------------------------------------------------ Read spare server file 10317: { 10318: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab"); 10319: 10320: while (my $configline=<$config>) { 10321: chomp($configline); 10322: if ($configline) { 10323: my ($host,$type) = split(':',$configline,2); 10324: if (!defined($type) || $type eq '') { $type = 'default' }; 10325: push(@{ $spareid{$type} }, $host); 10326: } 10327: } 10328: close($config); 10329: } 10330: # ------------------------------------------------------------ Read permissions 10331: { 10332: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab"); 10333: 10334: while (my $configline=<$config>) { 10335: chomp($configline); 10336: if ($configline) { 10337: my ($role,$perm)=split(/ /,$configline); 10338: if ($perm ne '') { $pr{$role}=$perm; } 10339: } 10340: } 10341: close($config); 10342: } 10343: 10344: # -------------------------------------------- Read plain texts for permissions 10345: { 10346: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab"); 10347: 10348: while (my $configline=<$config>) { 10349: chomp($configline); 10350: if ($configline) { 10351: my ($short,@plain)=split(/:/,$configline); 10352: %{$prp{$short}} = (); 10353: if (@plain > 0) { 10354: $prp{$short}{'std'} = $plain[0]; 10355: for (my $i=1; $i<@plain; $i++) { 10356: $prp{$short}{'alt'.$i} = $plain[$i]; 10357: } 10358: } 10359: } 10360: } 10361: close($config); 10362: } 10363: 10364: # ---------------------------------------------------------- Read package table 10365: { 10366: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab"); 10367: 10368: while (my $configline=<$config>) { 10369: if ($configline !~ /\S/ || $configline=~/^#/) { next; } 10370: chomp($configline); 10371: my ($short,$plain)=split(/:/,$configline); 10372: my ($pack,$name)=split(/\&/,$short); 10373: if ($plain ne '') { 10374: $packagetab{$pack.'&'.$name.'&name'}=$name; 10375: $packagetab{$short}=$plain; 10376: } 10377: } 10378: close($config); 10379: } 10380: 10381: # ---------------------------------------------------------- Read loncaparev table 10382: { 10383: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") { 10384: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) { 10385: while (my $configline=<$config>) { 10386: chomp($configline); 10387: my ($hostid,$loncaparev)=split(/:/,$configline); 10388: $loncaparevs{$hostid}=$loncaparev; 10389: } 10390: close($config); 10391: } 10392: } 10393: } 10394: 10395: # ---------------------------------------------------------- Read serverhostID table 10396: { 10397: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") { 10398: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) { 10399: while (my $configline=<$config>) { 10400: chomp($configline); 10401: my ($name,$id)=split(/:/,$configline); 10402: $serverhomeIDs{$name}=$id; 10403: } 10404: close($config); 10405: } 10406: } 10407: } 10408: 10409: { 10410: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml'; 10411: if (-e $file) { 10412: my $parser = HTML::LCParser->new($file); 10413: while (my $token = $parser->get_token()) { 10414: if ($token->[0] eq 'S') { 10415: my $item = $token->[1]; 10416: my $name = $token->[2]{'name'}; 10417: my $value = $token->[2]{'value'}; 10418: if ($item ne '' && $name ne '' && $value ne '') { 10419: my $release = $parser->get_text(); 10420: $release =~ s/(^\s*|\s*$ )//gx; 10421: $needsrelease{$item.':'.$name.':'.$value} = $release; 10422: } 10423: } 10424: } 10425: } 10426: } 10427: 10428: # ------------- set up temporary directory 10429: { 10430: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/'; 10431: 10432: } 10433: 10434: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'], 10435: 'compress_threshold'=> 20_000, 10436: }); 10437: 10438: $processmarker='_'.time.'_'.$perlvar{'lonHostID'}; 10439: $dumpcount=0; 10440: $locknum=0; 10441: 10442: &logtouch(); 10443: &logthis('INFO: Read configuration'); 10444: $readit=1; 10445: { 10446: use integer; 10447: my $test=(2**32)+1; 10448: if ($test != 0) { $_64bit=1; } else { $_64bit=0; } 10449: &logthis(" Detected 64bit platform ($_64bit)"); 10450: } 10451: } 10452: } 10453: 10454: 1; 10455: __END__ 10456: 10457: =pod 10458: 10459: =head1 NAME 10460: 10461: Apache::lonnet - Subroutines to ask questions about things in the network. 10462: 10463: =head1 SYNOPSIS 10464: 10465: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network. 10466: 10467: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS); 10468: 10469: Common parameters: 10470: 10471: =over 4 10472: 10473: =item * 10474: 10475: $uname : an internal username (if $cname expecting a course Id specifically) 10476: 10477: =item * 10478: 10479: $udom : a domain (if $cdom expecting a course's domain specifically) 10480: 10481: =item * 10482: 10483: $symb : a resource instance identifier 10484: 10485: =item * 10486: 10487: $namespace : the name of a .db file that contains the data needed or 10488: being set. 10489: 10490: =back 10491: 10492: =head1 OVERVIEW 10493: 10494: lonnet provides subroutines which interact with the 10495: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask 10496: about classes, users, and resources. 10497: 10498: For many of these objects you can also use this to store data about 10499: them or modify them in various ways. 10500: 10501: =head2 Symbs 10502: 10503: To identify a specific instance of a resource, LON-CAPA uses symbols 10504: or "symbs"X<symb>. These identifiers are built from the URL of the 10505: map, the resource number of the resource in the map, and the URL of 10506: the resource itself. The latter is somewhat redundant, but might help 10507: if maps change. 10508: 10509: An example is 10510: 10511: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem 10512: 10513: The respective map entry is 10514: 10515: <resource id="19" src="/res/msu/korte/tests/part12.problem" 10516: title="Problem 2"> 10517: </resource> 10518: 10519: Symbs are used by the random number generator, as well as to store and 10520: restore data specific to a certain instance of for example a problem. 10521: 10522: =head2 Storing And Retrieving Data 10523: 10524: X<store()>X<cstore()>X<restore()>Three of the most important functions 10525: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>, 10526: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which 10527: is is the non-critical message twin of cstore. These functions are for 10528: handlers to store a perl hash to a user's permanent data space in an 10529: easy manner, and to retrieve it again on another call. It is expected 10530: that a handler would use this once at the beginning to retrieve data, 10531: and then again once at the end to send only the new data back. 10532: 10533: The data is stored in the user's data directory on the user's 10534: homeserver under the ID of the course. 10535: 10536: The hash that is returned by restore will have all of the previous 10537: value for all of the elements of the hash. 10538: 10539: Example: 10540: 10541: #creating a hash 10542: my %hash; 10543: $hash{'foo'}='bar'; 10544: 10545: #storing it 10546: &Apache::lonnet::cstore(\%hash); 10547: 10548: #changing a value 10549: $hash{'foo'}='notbar'; 10550: 10551: #adding a new value 10552: $hash{'bar'}='foo'; 10553: &Apache::lonnet::cstore(\%hash); 10554: 10555: #retrieving the hash 10556: my %history=&Apache::lonnet::restore(); 10557: 10558: #print the hash 10559: foreach my $key (sort(keys(%history))) { 10560: print("\%history{$key} = $history{$key}"); 10561: } 10562: 10563: Will print out: 10564: 10565: %history{1:foo} = bar 10566: %history{1:keys} = foo:timestamp 10567: %history{1:timestamp} = 990455579 10568: %history{2:bar} = foo 10569: %history{2:foo} = notbar 10570: %history{2:keys} = foo:bar:timestamp 10571: %history{2:timestamp} = 990455580 10572: %history{bar} = foo 10573: %history{foo} = notbar 10574: %history{timestamp} = 990455580 10575: %history{version} = 2 10576: 10577: Note that the special hash entries C<keys>, C<version> and 10578: C<timestamp> were added to the hash. C<version> will be equal to the 10579: total number of versions of the data that have been stored. The 10580: C<timestamp> attribute will be the UNIX time the hash was 10581: stored. C<keys> is available in every historical section to list which 10582: keys were added or changed at a specific historical revision of a 10583: hash. 10584: 10585: B<Warning>: do not store the hash that restore returns directly. This 10586: will cause a mess since it will restore the historical keys as if the 10587: were new keys. I.E. 1:foo will become 1:1:foo etc. 10588: 10589: Calling convention: 10590: 10591: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home); 10592: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home); 10593: 10594: For more detailed information, see lonnet specific documentation. 10595: 10596: =head1 RETURN MESSAGES 10597: 10598: =over 4 10599: 10600: =item * B<con_lost>: unable to contact remote host 10601: 10602: =item * B<con_delayed>: unable to contact remote host, message will be delivered 10603: when the connection is brought back up 10604: 10605: =item * B<con_failed>: unable to contact remote host and unable to save message 10606: for later delivery 10607: 10608: =item * B<error:>: an error a occurred, a description of the error follows the : 10609: 10610: =item * B<no_such_host>: unable to fund a host associated with the user/domain 10611: that was requested 10612: 10613: =back 10614: 10615: =head1 PUBLIC SUBROUTINES 10616: 10617: =head2 Session Environment Functions 10618: 10619: =over 4 10620: 10621: =item * 10622: X<appenv()> 10623: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to 10624: the user envirnoment file, and will be restored for each access this 10625: user makes during this session, also modifies the %env for the current 10626: process. Optional rolesarrayref - if defined contains a reference to an array 10627: of roles which are exempt from the restriction on modifying user.role entries 10628: in the user's environment.db and in %env. 10629: 10630: =item * 10631: X<delenv()> 10632: B<delenv($delthis,$regexp)>: removes all items from the session 10633: environment file that begin with $delthis. If the 10634: optional second arg - $regexp - is true, $delthis is treated as a 10635: regular expression, otherwise \Q$delthis\E is used. 10636: The values are also deleted from the current processes %env. 10637: 10638: =item * get_env_multiple($name) 10639: 10640: gets $name from the %env hash, it seemlessly handles the cases where multiple 10641: values may be defined and end up as an array ref. 10642: 10643: returns an array of values 10644: 10645: =back 10646: 10647: =head2 User Information 10648: 10649: =over 4 10650: 10651: =item * 10652: X<queryauthenticate()> 10653: B<queryauthenticate($uname,$udom)>: try to determine user's current 10654: authentication scheme 10655: 10656: =item * 10657: X<authenticate()> 10658: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to 10659: authenticate user from domain's lib servers (first use the current 10660: one). C<$upass> should be the users password. 10661: $checkdefauth is optional (value is 1 if a check should be made to 10662: authenticate user using default authentication method, and allow 10663: account creation if username does not have account in the domain). 10664: $clientcancheckhost is optional (value is 1 if checking whether the 10665: server can host will occur on the client side in lonauth.pm). 10666: 10667: =item * 10668: X<homeserver()> 10669: B<homeserver($uname,$udom)>: find the server which has 10670: the user's directory and files (there must be only one), this caches 10671: the answer, and also caches if there is a borken connection. 10672: 10673: =item * 10674: X<idget()> 10675: B<idget($udom,@ids)>: find the usernames behind a list of IDs 10676: (IDs are a unique resource in a domain, there must be only 1 ID per 10677: username, and only 1 username per ID in a specific domain) (returns 10678: hash: id=>name,id=>name) 10679: 10680: =item * 10681: X<idrget()> 10682: B<idrget($udom,@unames)>: find the IDs behind a list of 10683: usernames (returns hash: name=>id,name=>id) 10684: 10685: =item * 10686: X<idput()> 10687: B<idput($udom,%ids)>: store away a list of names and associated IDs 10688: 10689: =item * 10690: X<rolesinit()> 10691: B<rolesinit($udom,$username,$authhost)>: get user privileges 10692: 10693: =item * 10694: X<getsection()> 10695: B<getsection($udom,$uname,$cname)>: finds the section of student in the 10696: course $cname, return section name/number or '' for "not in course" 10697: and '-1' for "no section" 10698: 10699: =item * 10700: X<userenvironment()> 10701: B<userenvironment($udom,$uname,@what)>: gets the values of the keys 10702: passed in @what from the requested user's environment, returns a hash 10703: 10704: =item * 10705: X<userlog_query()> 10706: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's 10707: activity.log file. %filters defines filters applied when parsing the 10708: log file. These can be start or end timestamps, or the type of action 10709: - log to look for Login or Logout events, check for Checkin or 10710: Checkout, role for role selection. The response is in the form 10711: timestamp1:hostid1:event1&timestamp2:hostid2:event2 where events are 10712: escaped strings of the action recorded in the activity.log file. 10713: 10714: =back 10715: 10716: =head2 User Roles 10717: 10718: =over 4 10719: 10720: =item * 10721: 10722: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions 10723: F: full access 10724: U,I,K: authentication modes (cxx only) 10725: '': forbidden 10726: 1: user needs to choose course 10727: 2: browse allowed 10728: A: passphrase authentication needed 10729: 10730: =item * 10731: 10732: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom 10733: role rolename set privileges in format of lonTabs/roles.tab for system, domain, 10734: and course level 10735: 10736: =item * 10737: 10738: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash 10739: (rolesplain.tab); plain text explanation of a user role term. 10740: $type is Course (default) or Community. 10741: If $forcedefault evaluates to true, text returned will be default 10742: text for $type. Otherwise, if this is a course, the text returned 10743: will be a custom name for the role (if defined in the course's 10744: environment). If no custom name is defined the default is returned. 10745: 10746: =item * 10747: 10748: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) : 10749: All arguments are optional. Returns a hash of a roles, either for 10750: co-author/assistant author roles for a user's Construction Space 10751: (default), or if $context is 'userroles', roles for the user himself, 10752: In the hash, keys are set to colon-separated $uname,$udom,$role, and 10753: (optionally) if $withsec is true, a fourth colon-separated item - $section. 10754: For each key, value is set to colon-separated start and end times for 10755: the role. If no username and domain are specified, will default to 10756: current user/domain. Types, roles, and roledoms are references to arrays 10757: of role statuses (active, future or previous), roles 10758: (e.g., cc,in, st etc.) and domains of the roles which can be used 10759: to restrict the list of roles reported. If no array ref is 10760: provided for types, will default to return only active roles. 10761: 10762: =back 10763: 10764: =head2 User Modification 10765: 10766: =over 4 10767: 10768: =item * 10769: 10770: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a 10771: user for the level given by URL. Optional start and end dates (leave empty 10772: string or zero for "no date") 10773: 10774: =item * 10775: 10776: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to 10777: change a users, password, possible return values are: ok, 10778: pwchange_failure, non_authorized, auth_mode_error, unknown_user, 10779: refused 10780: 10781: =item * 10782: 10783: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication 10784: 10785: =item * 10786: 10787: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene, 10788: $forceid,$desiredhome,$email,$inststatus,$candelete) : 10789: 10790: will update user information (firstname,middlename,lastname,generation, 10791: permanentemail), and if forceid is true, student/employee ID also. 10792: A user's institutional affiliation(s) can also be updated. 10793: User information fields will not be overwritten with empty entries 10794: unless the field is included in the $candelete array reference. 10795: This array is included when a single user is modified via "Manage Users", 10796: or when Autoupdate.pl is run by cron in a domain. 10797: 10798: =item * 10799: 10800: modifystudent 10801: 10802: modify a student's enrollment and identification information. 10803: The course id is resolved based on the current users environment. 10804: This means the envoking user must be a course coordinator or otherwise 10805: associated with a course. 10806: 10807: This call is essentially a wrapper for lonnet::modifyuser and 10808: lonnet::modify_student_enrollment 10809: 10810: Inputs: 10811: 10812: =over 4 10813: 10814: =item B<$udom> Student's loncapa domain 10815: 10816: =item B<$uname> Student's loncapa login name 10817: 10818: =item B<$uid> Student/Employee ID 10819: 10820: =item B<$umode> Student's authentication mode 10821: 10822: =item B<$upass> Student's password 10823: 10824: =item B<$first> Student's first name 10825: 10826: =item B<$middle> Student's middle name 10827: 10828: =item B<$last> Student's last name 10829: 10830: =item B<$gene> Student's generation 10831: 10832: =item B<$usec> Student's section in course 10833: 10834: =item B<$end> Unix time of the roles expiration 10835: 10836: =item B<$start> Unix time of the roles start date 10837: 10838: =item B<$forceid> If defined, allow $uid to be changed 10839: 10840: =item B<$desiredhome> server to use as home server for student 10841: 10842: =item B<$email> Student's permanent e-mail address 10843: 10844: =item B<$type> Type of enrollment (auto or manual) 10845: 10846: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto 10847: 10848: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC 10849: 10850: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment 10851: 10852: =item B<$context> role change context (shown in User Management Logs display in a course) 10853: 10854: =item B<$inststatus> institutional status of user - : separated string of escaped status types 10855: 10856: =back 10857: 10858: =item * 10859: 10860: modify_student_enrollment 10861: 10862: Change a students enrollment status in a class. The environment variable 10863: 'role.request.course' must be defined for this function to proceed. 10864: 10865: Inputs: 10866: 10867: =over 4 10868: 10869: =item $udom, students domain 10870: 10871: =item $uname, students name 10872: 10873: =item $uid, students user id 10874: 10875: =item $first, students first name 10876: 10877: =item $middle 10878: 10879: =item $last 10880: 10881: =item $gene 10882: 10883: =item $usec 10884: 10885: =item $end 10886: 10887: =item $start 10888: 10889: =item $type 10890: 10891: =item $locktype 10892: 10893: =item $cid 10894: 10895: =item $selfenroll 10896: 10897: =item $context 10898: 10899: =back 10900: 10901: 10902: =item * 10903: 10904: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign 10905: custom role; give a custom role to a user for the level given by URL. Specify 10906: name and domain of role author, and role name 10907: 10908: =item * 10909: 10910: revokerole($udom,$uname,$url,$role) : revoke a role for url 10911: 10912: =item * 10913: 10914: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role 10915: 10916: =back 10917: 10918: =head2 Course Infomation 10919: 10920: =over 4 10921: 10922: =item * 10923: 10924: coursedescription($courseid) : returns a hash of information about the 10925: specified course id, including all environment settings for the 10926: course, the description of the course will be in the hash under the 10927: key 'description' 10928: 10929: =item * 10930: 10931: resdata($name,$domain,$type,@which) : request for current parameter 10932: setting for a specific $type, where $type is either 'course' or 'user', 10933: @what should be a list of parameters to ask about. This routine caches 10934: answers for 5 minutes. 10935: 10936: =item * 10937: 10938: get_courseresdata($courseid, $domain) : dump the entire course resource 10939: data base, returning a hash that is keyed by the resource name and has 10940: values that are the resource value. I believe that the timestamps and 10941: versions are also returned. 10942: 10943: 10944: =back 10945: 10946: =head2 Course Modification 10947: 10948: =over 4 10949: 10950: =item * 10951: 10952: writecoursepref($courseid,%prefs) : write preferences (environment 10953: database) for a course 10954: 10955: =item * 10956: 10957: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course 10958: 10959: =item * 10960: 10961: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community). 10962: 10963: =back 10964: 10965: =head2 Resource Subroutines 10966: 10967: =over 4 10968: 10969: =item * 10970: 10971: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead) 10972: 10973: =item * 10974: 10975: repcopy($filename) : subscribes to the requested file, and attempts to 10976: replicate from the owning library server, Might return 10977: 'unavailable', 'not_found', 'forbidden', 'ok', or 10978: 'bad_request', also attempts to grab the metadata for the 10979: resource. Expects the local filesystem pathname 10980: (/home/httpd/html/res/....) 10981: 10982: =back 10983: 10984: =head2 Resource Information 10985: 10986: =over 4 10987: 10988: =item * 10989: 10990: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of 10991: a vairety of different possible values, $varname should be a request 10992: string, and the other parameters can be used to specify who and what 10993: one is asking about. 10994: 10995: Possible values for $varname are environment.lastname (or other item 10996: from the envirnment hash), user.name (or someother aspect about the 10997: user), resource.0.maxtries (or some other part and parameter of a 10998: resource) 10999: 11000: =item * 11001: 11002: directcondval($number) : get current value of a condition; reads from a state 11003: string 11004: 11005: =item * 11006: 11007: condval($condidx) : value of condition index based on state 11008: 11009: =item * 11010: 11011: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a 11012: resource's metadata, $what should be either a specific key, or either 11013: 'keys' (to get a list of possible keys) or 'packages' to get a list of 11014: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata. 11015: 11016: this function automatically caches all requests 11017: 11018: =item * 11019: 11020: metadata_query($query,$custom,$customshow) : make a metadata query against the 11021: network of library servers; returns file handle of where SQL and regex results 11022: will be stored for query 11023: 11024: =item * 11025: 11026: symbread($filename) : return symbolic list entry (filename argument optional); 11027: returns the data handle 11028: 11029: =item * 11030: 11031: symbverify($symb,$thisfn) : verifies that $symb actually exists and is 11032: a possible symb for the URL in $thisfn, and if is an encryypted 11033: resource that the user accessed using /enc/ returns a 1 on success, 0 11034: on failure, user must be in a course, as it assumes the existance of 11035: the course initial hash, and uses $env('request.course.id'} 11036: 11037: 11038: =item * 11039: 11040: symbclean($symb) : removes versions numbers from a symb, returns the 11041: cleaned symb 11042: 11043: =item * 11044: 11045: is_on_map($uri) : checks if the $uri is somewhere on the current 11046: course map, user must be in a course for it to work. 11047: 11048: =item * 11049: 11050: numval($salt) : return random seed value (addend for rndseed) 11051: 11052: =item * 11053: 11054: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns 11055: a random seed, all arguments are optional, if they aren't sent it uses the 11056: environment to derive them. Note: if symb isn't sent and it can't get one 11057: from &symbread it will use the current time as its return value 11058: 11059: =item * 11060: 11061: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique, 11062: unfakeable, receipt 11063: 11064: =item * 11065: 11066: receipt() : API to ireceipt working off of env values; given out to users 11067: 11068: =item * 11069: 11070: countacc($url) : count the number of accesses to a given URL 11071: 11072: =item * 11073: 11074: 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 11075: 11076: =item * 11077: 11078: 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) 11079: 11080: =item * 11081: 11082: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet 11083: 11084: =item * 11085: 11086: devalidate($symb) : devalidate temporary spreadsheet calculations, 11087: forcing spreadsheet to reevaluate the resource scores next time. 11088: 11089: =back 11090: 11091: =head2 Storing/Retreiving Data 11092: 11093: =over 4 11094: 11095: =item * 11096: 11097: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently 11098: for this url; hashref needs to be given and should be a \%hashname; the 11099: remaining args aren't required and if they aren't passed or are '' they will 11100: be derived from the env 11101: 11102: =item * 11103: 11104: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but 11105: uses critical subroutine 11106: 11107: =item * 11108: 11109: restore($symb,$namespace,$udom,$uname) : returns hash for this symb; 11110: all args are optional 11111: 11112: =item * 11113: 11114: dumpstore($namespace,$udom,$uname,$regexp,$range) : 11115: dumps the complete (or key matching regexp) namespace into a hash 11116: ($udom, $uname, $regexp, $range are optional) for a namespace that is 11117: normally &store()ed into 11118: 11119: $range should be either an integer '100' (give me the first 100 11120: matching records) 11121: or be two integers sperated by a - with no spaces 11122: '30-50' (give me the 30th through the 50th matching 11123: records) 11124: 11125: 11126: =item * 11127: 11128: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) : 11129: replaces a &store() version of data with a replacement set of data 11130: for a particular resource in a namespace passed in the $storehash hash 11131: reference 11132: 11133: =item * 11134: 11135: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that 11136: works very similar to store/cstore, but all data is stored in a 11137: temporary location and can be reset using tmpreset, $storehash should 11138: be a hash reference, returns nothing on success 11139: 11140: =item * 11141: 11142: tmprestore($symb,$namespace,$udom,$uname) : storage that works very 11143: similar to restore, but all data is stored in a temporary location and 11144: can be reset using tmpreset. Returns a hash of values on success, 11145: error string otherwise. 11146: 11147: =item * 11148: 11149: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset, 11150: deltes all keys for $symb form the temporary storage hash. 11151: 11152: =item * 11153: 11154: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array 11155: reference filled in from namesp ($udom and $uname are optional) 11156: 11157: =item * 11158: 11159: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from 11160: namesp ($udom and $uname are optional) 11161: 11162: =item * 11163: 11164: dump($namespace,$udom,$uname,$regexp,$range) : 11165: dumps the complete (or key matching regexp) namespace into a hash 11166: ($udom, $uname, $regexp, $range are optional) 11167: 11168: $range should be either an integer '100' (give me the first 100 11169: matching records) 11170: or be two integers sperated by a - with no spaces 11171: '30-50' (give me the 30th through the 50th matching 11172: records) 11173: =item * 11174: 11175: inc($namespace,$store,$udom,$uname) : increments $store in $namespace. 11176: $store can be a scalar, an array reference, or if the amount to be 11177: incremented is > 1, a hash reference. 11178: 11179: ($udom and $uname are optional) 11180: 11181: =item * 11182: 11183: put($namespace,$storehash,$udom,$uname) : stores hash in namesp 11184: ($udom and $uname are optional) 11185: 11186: =item * 11187: 11188: cput($namespace,$storehash,$udom,$uname) : critical put 11189: ($udom and $uname are optional) 11190: 11191: =item * 11192: 11193: newput($namespace,$storehash,$udom,$uname) : 11194: 11195: Attempts to store the items in the $storehash, but only if they don't 11196: currently exist, if this succeeds you can be certain that you have 11197: successfully created a new key value pair in the $namespace db. 11198: 11199: 11200: Args: 11201: $namespace: name of database to store values to 11202: $storehash: hashref to store to the db 11203: $udom: (optional) domain of user containing the db 11204: $uname: (optional) name of user caontaining the db 11205: 11206: Returns: 11207: 'ok' -> succeeded in storing all keys of $storehash 11208: 'key_exists: <key>' -> failed to anything out of $storehash, as at 11209: least <key> already existed in the db (other 11210: requested keys may also already exist) 11211: 'error: <msg>' -> unable to tie the DB or other error occurred 11212: 'con_lost' -> unable to contact request server 11213: 'refused' -> action was not allowed by remote machine 11214: 11215: 11216: =item * 11217: 11218: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array 11219: reference filled in from namesp (encrypts the return communication) 11220: ($udom and $uname are optional) 11221: 11222: =item * 11223: 11224: log($udom,$name,$home,$message) : write to permanent log for user; use 11225: critical subroutine 11226: 11227: =item * 11228: 11229: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from 11230: array reference filled in from namespace found in domain level on either 11231: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional). 11232: 11233: =item * 11234: 11235: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at 11236: domain level either on specified domain server ($uhome) or primary domain 11237: server ($udom and $uhome are optional) 11238: 11239: =item * 11240: 11241: get_domain_defaults($target_domain) : returns hash with defaults for 11242: authentication and language in the domain. Keys are: auth_def, auth_arg_def, 11243: lang_def; corresponsing values are authentication type (internal, krb4, krb5, 11244: or localauth), initial password or a kerberos realm, language (e.g., en-us). 11245: Values are retrieved from cache (if current), or from domain's configuration.db 11246: (if available), or lastly from values in lonTabs/dns_domain,tab, 11247: or lonTabs/domain.tab. 11248: 11249: %domdefaults = &get_auth_defaults($target_domain); 11250: 11251: =back 11252: 11253: =head2 Network Status Functions 11254: 11255: =over 4 11256: 11257: =item * 11258: 11259: dirlist($uri) : return directory list based on URI 11260: 11261: =item * 11262: 11263: spareserver() : find server with least workload from spare.tab 11264: 11265: 11266: =item * 11267: 11268: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef 11269: if there is no corresponding loncapa host. 11270: 11271: =back 11272: 11273: 11274: =head2 Apache Request 11275: 11276: =over 4 11277: 11278: =item * 11279: 11280: ssi($url,%hash) : server side include, does a complete request cycle on url to 11281: localhost, posts hash 11282: 11283: =back 11284: 11285: =head2 Data to String to Data 11286: 11287: =over 4 11288: 11289: =item * 11290: 11291: hash2str(%hash) : convert a hash into a string complete with escaping and '=' 11292: and '&' separators, supports elements that are arrayrefs and hashrefs 11293: 11294: =item * 11295: 11296: hashref2str($hashref) : convert a hashref into a string complete with 11297: escaping and '=' and '&' separators, supports elements that are 11298: arrayrefs and hashrefs 11299: 11300: =item * 11301: 11302: arrayref2str($arrayref) : convert an arrayref into a string complete 11303: with escaping and '&' separators, supports elements that are arrayrefs 11304: and hashrefs 11305: 11306: =item * 11307: 11308: str2hash($string) : convert string to hash using unescaping and 11309: splitting on '=' and '&', supports elements that are arrayrefs and 11310: hashrefs 11311: 11312: =item * 11313: 11314: str2array($string) : convert string to hash using unescaping and 11315: splitting on '&', supports elements that are arrayrefs and hashrefs 11316: 11317: =back 11318: 11319: =head2 Logging Routines 11320: 11321: =over 4 11322: 11323: These routines allow one to make log messages in the lonnet.log and 11324: lonnet.perm logfiles. 11325: 11326: =item * 11327: 11328: logtouch() : make sure the logfile, lonnet.log, exists 11329: 11330: =item * 11331: 11332: logthis() : append message to the normal lonnet.log file, it gets 11333: preiodically rolled over and deleted. 11334: 11335: =item * 11336: 11337: logperm() : append a permanent message to lonnet.perm.log, this log 11338: file never gets deleted by any automated portion of the system, only 11339: messages of critical importance should go in here. 11340: 11341: =back 11342: 11343: =head2 General File Helper Routines 11344: 11345: =over 4 11346: 11347: =item * 11348: 11349: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded. 11350: (a) files in /uploaded 11351: (i) If a local copy of the file exists - 11352: compares modification date of local copy with last-modified date for 11353: definitive version stored on home server for course. If local copy is 11354: stale, requests a new version from the home server and stores it. 11355: If the original has been removed from the home server, then local copy 11356: is unlinked. 11357: (ii) If local copy does not exist - 11358: requests the file from the home server and stores it. 11359: 11360: If $caller is 'uploadrep': 11361: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase) 11362: for request for files originally uploaded via DOCS. 11363: - returns 'ok' if fresh local copy now available, -1 otherwise. 11364: 11365: Otherwise: 11366: This indicates a call from the content generation phase of the request. 11367: - returns the entire contents of the file or -1. 11368: 11369: (b) files in /res 11370: - returns the entire contents of a file or -1; 11371: it properly subscribes to and replicates the file if neccessary. 11372: 11373: 11374: =item * 11375: 11376: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file 11377: reference 11378: 11379: returns either a stat() list of data about the file or an empty list 11380: if the file doesn't exist or couldn't find out about it (connection 11381: problems or user unknown) 11382: 11383: =item * 11384: 11385: filelocation($dir,$file) : returns file system location of a file 11386: based on URI; meant to be "fairly clean" absolute reference, $dir is a 11387: directory that relative $file lookups are to looked in ($dir of /a/dir 11388: and a file of ../bob will become /a/bob) 11389: 11390: =item * 11391: 11392: hreflocation($dir,$file) : returns file system location or a URL; same as 11393: filelocation except for hrefs 11394: 11395: =item * 11396: 11397: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc) 11398: 11399: =back 11400: 11401: =head2 Usererfile file routines (/uploaded*) 11402: 11403: =over 4 11404: 11405: =item * 11406: 11407: userfileupload(): main rotine for putting a file in a user or course's 11408: filespace, arguments are, 11409: 11410: formname - required - this is the name of the element in $env where the 11411: filename, and the contents of the file to create/modifed exist 11412: the filename is in $env{'form.'.$formname.'.filename'} and the 11413: contents of the file is located in $env{'form.'.$formname} 11414: context - if coursedoc, store the file in the course of the active role 11415: of the current user; 11416: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp 11417: if 'canceloverwrite': delete file in tmp/overwrites directory 11418: subdir - required - subdirectory to put the file in under ../userfiles/ 11419: if undefined, it will be placed in "unknown" 11420: 11421: (This routine calls clean_filename() to remove any dangerous 11422: characters from the filename, and then calls finuserfileupload() to 11423: complete the transaction) 11424: 11425: returns either the url of the uploaded file (/uploaded/....) if successful 11426: and /adm/notfound.html if unsuccessful 11427: 11428: =item * 11429: 11430: clean_filename(): routine for cleaing a filename up for storage in 11431: userfile space, argument is: 11432: 11433: filename - proposed filename 11434: 11435: returns: the new clean filename 11436: 11437: =item * 11438: 11439: finishuserfileupload(): routine that creates and sends the file to 11440: userspace, probably shouldn't be called directly 11441: 11442: docuname: username or courseid of destination for the file 11443: docudom: domain of user/course of destination for the file 11444: formname: same as for userfileupload() 11445: fname: filename (including subdirectories) for the file 11446: parser: if 'parse', will parse (html) file to extract references to objects, links etc. 11447: allfiles: reference to hash used to store objects found by parser 11448: codebase: reference to hash used for codebases of java objects found by parser 11449: thumbwidth: width (pixels) of thumbnail to be created for uploaded image 11450: thumbheight: height (pixels) of thumbnail to be created for uploaded image 11451: resizewidth: width to be used to resize image using resizeImage from ImageMagick 11452: resizeheight: height to be used to resize image using resizeImage from ImageMagick 11453: context: if 'overwrite', will move the uploaded file from its temporary location to 11454: userfiles to facilitate overwriting a previously uploaded file with same name. 11455: mimetype: reference to scalar to accommodate mime type determined 11456: from File::MMagic if $parser = parse. 11457: 11458: returns either the url of the uploaded file (/uploaded/....) if successful 11459: and /adm/notfound.html if unsuccessful (or an error message if context 11460: was 'overwrite'). 11461: 11462: 11463: =item * 11464: 11465: renameuserfile(): renames an existing userfile to a new name 11466: 11467: Args: 11468: docuname: username or courseid of destination for the file 11469: docudom: domain of user/course of destination for the file 11470: old: current file name (including any subdirs under userfiles) 11471: new: desired file name (including any subdirs under userfiles) 11472: 11473: =item * 11474: 11475: mkdiruserfile(): creates a directory is a userfiles dir 11476: 11477: Args: 11478: docuname: username or courseid of destination for the file 11479: docudom: domain of user/course of destination for the file 11480: dir: dir to create (including any subdirs under userfiles) 11481: 11482: =item * 11483: 11484: removeuserfile(): removes a file that exists in userfiles 11485: 11486: Args: 11487: docuname: username or courseid of destination for the file 11488: docudom: domain of user/course of destination for the file 11489: fname: filname to delete (including any subdirs under userfiles) 11490: 11491: =item * 11492: 11493: removeuploadedurl(): convience function for removeuserfile() 11494: 11495: Args: 11496: url: a full /uploaded/... url to delete 11497: 11498: =item * 11499: 11500: get_portfile_permissions(): 11501: Args: 11502: domain: domain of user or course contain the portfolio files 11503: user: name of user or num of course contain the portfolio files 11504: Returns: 11505: hashref of a dump of the proper file_permissions.db 11506: 11507: 11508: =item * 11509: 11510: get_access_controls(): 11511: 11512: Args: 11513: current_permissions: the hash ref returned from get_portfile_permissions() 11514: group: (optional) the group you want the files associated with 11515: file: (optional) the file you want access info on 11516: 11517: Returns: 11518: a hash (keys are file names) of hashes containing 11519: keys are: path to file/file_name\0uniqueID:scope_end_start (see below) 11520: values are XML containing access control settings (see below) 11521: 11522: Internal notes: 11523: 11524: access controls are stored in file_permissions.db as key=value pairs. 11525: key -> path to file/file_name\0uniqueID:scope_end_start 11526: where scope -> public,guest,course,group,domains or users. 11527: end -> UNIX time for end of access (0 -> no end date) 11528: start -> UNIX time for start of access 11529: 11530: value -> XML description of access control 11531: <scope type=""> (type =1 of: public,guest,course,group,domains,users"> 11532: <start></start> 11533: <end></end> 11534: 11535: <password></password> for scope type = guest 11536: 11537: <domain></domain> for scope type = course or group 11538: <number></number> 11539: <roles id=""> 11540: <role></role> 11541: <access></access> 11542: <section></section> 11543: <group></group> 11544: </roles> 11545: 11546: <dom></dom> for scope type = domains 11547: 11548: <users> for scope type = users 11549: <user> 11550: <uname></uname> 11551: <udom></udom> 11552: </user> 11553: </users> 11554: </scope> 11555: 11556: Access data is also aggregated for each file in an additional key=value pair: 11557: key -> path to file/file_name\0accesscontrol 11558: value -> reference to hash 11559: hash contains key = value pairs 11560: where key = uniqueID:scope_end_start 11561: value = UNIX time record was last updated 11562: 11563: Used to improve speed of look-ups of access controls for each file. 11564: 11565: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays. 11566: 11567: modify_access_controls(): 11568: 11569: Modifies access controls for a portfolio file 11570: Args 11571: 1. file name 11572: 2. reference to hash of required changes, 11573: 3. domain 11574: 4. username 11575: where domain,username are the domain of the portfolio owner 11576: (either a user or a course) 11577: 11578: Returns: 11579: 1. result of additions or updates ('ok' or 'error', with error message). 11580: 2. result of deletions ('ok' or 'error', with error message). 11581: 3. reference to hash of any new or updated access controls. 11582: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control. 11583: key = integer (inbound ID) 11584: value = uniqueID 11585: 11586: =back 11587: 11588: =head2 HTTP Helper Routines 11589: 11590: =over 4 11591: 11592: =item * 11593: 11594: escape() : unpack non-word characters into CGI-compatible hex codes 11595: 11596: =item * 11597: 11598: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character 11599: 11600: =back 11601: 11602: =head1 PRIVATE SUBROUTINES 11603: 11604: =head2 Underlying communication routines (Shouldn't call) 11605: 11606: =over 4 11607: 11608: =item * 11609: 11610: subreply() : tries to pass a message to lonc, returns con_lost if incapable 11611: 11612: =item * 11613: 11614: reply() : uses subreply to send a message to remote machine, logs all failures 11615: 11616: =item * 11617: 11618: critical() : passes a critical message to another server; if cannot 11619: get through then place message in connection buffer directory and 11620: returns con_delayed, if incapable of saving message, returns 11621: con_failed 11622: 11623: =item * 11624: 11625: reconlonc() : tries to reconnect lonc client processes. 11626: 11627: =back 11628: 11629: =head2 Resource Access Logging 11630: 11631: =over 4 11632: 11633: =item * 11634: 11635: flushcourselogs() : flush (save) buffer logs and access logs 11636: 11637: =item * 11638: 11639: courselog($what) : save message for course in hash 11640: 11641: =item * 11642: 11643: courseacclog($what) : save message for course using &courselog(). Perform 11644: special processing for specific resource types (problems, exams, quizzes, etc). 11645: 11646: =item * 11647: 11648: goodbye() : flush course logs and log shutting down; it is called in srm.conf 11649: as a PerlChildExitHandler 11650: 11651: =back 11652: 11653: =head2 Other 11654: 11655: =over 4 11656: 11657: =item * 11658: 11659: symblist($mapname,%newhash) : update symbolic storage links 11660: 11661: =back 11662: 11663: =cut 11664: