1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.930 2007/12/05 20:08:52 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonnet;
31:
32: use strict;
33: use LWP::UserAgent();
34: use HTTP::Date;
35: # use Date::Parse;
36: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
37: $_64bit %env);
38:
39: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
40: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
41: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
42: %courseownerbuf, %coursetypebuf);
43:
44: use IO::Socket;
45: use GDBM_File;
46: use HTML::LCParser;
47: use Fcntl qw(:flock);
48: use Storable qw(thaw nfreeze);
49: use Time::HiRes qw( gettimeofday tv_interval );
50: use Cache::Memcached;
51: use Digest::MD5;
52: use Math::Random;
53: use LONCAPA qw(:DEFAULT :match);
54: use LONCAPA::Configuration;
55:
56: my $readit;
57: my $max_connection_retries = 10; # Or some such value.
58:
59: require Exporter;
60:
61: our @ISA = qw (Exporter);
62: our @EXPORT = qw(%env);
63:
64: =pod
65:
66: =head1 Package Variables
67:
68: These are largely undocumented, so if you decipher one please note it here.
69:
70: =over 4
71:
72: =item $processmarker
73:
74: Contains the time this process was started and this servers host id.
75:
76: =item $dumpcount
77:
78: Counts the number of times a message log flush has been attempted (regardless
79: of success) by this process. Used as part of the filename when messages are
80: delayed.
81:
82: =back
83:
84: =cut
85:
86:
87: # --------------------------------------------------------------------- Logging
88: {
89: my $logid;
90: sub instructor_log {
91: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
92: $logid++;
93: my $id=time().'00000'.$$.'00000'.$logid;
94: return &Apache::lonnet::put('nohist_'.$hash_name,
95: { $id => {
96: 'exe_uname' => $env{'user.name'},
97: 'exe_udom' => $env{'user.domain'},
98: 'exe_time' => time(),
99: 'exe_ip' => $ENV{'REMOTE_ADDR'},
100: 'delflag' => $delflag,
101: 'logentry' => $storehash,
102: 'uname' => $uname,
103: 'udom' => $udom,
104: }
105: },
106: $env{'course.'.$env{'request.course.id'}.'.domain'},
107: $env{'course.'.$env{'request.course.id'}.'.num'}
108: );
109: }
110: }
111:
112: sub logtouch {
113: my $execdir=$perlvar{'lonDaemons'};
114: unless (-e "$execdir/logs/lonnet.log") {
115: open(my $fh,">>$execdir/logs/lonnet.log");
116: close $fh;
117: }
118: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
119: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
120: }
121:
122: sub logthis {
123: my $message=shift;
124: my $execdir=$perlvar{'lonDaemons'};
125: my $now=time;
126: my $local=localtime($now);
127: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
128: print $fh "$local ($$): $message\n";
129: close($fh);
130: }
131: return 1;
132: }
133:
134: sub logperm {
135: my $message=shift;
136: my $execdir=$perlvar{'lonDaemons'};
137: my $now=time;
138: my $local=localtime($now);
139: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
140: print $fh "$now:$message:$local\n";
141: close($fh);
142: }
143: return 1;
144: }
145:
146: sub create_connection {
147: my ($hostname,$lonid) = @_;
148: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
149: Type => SOCK_STREAM,
150: Timeout => 10);
151: return 0 if (!$client);
152: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
153: my $result = <$client>;
154: chomp($result);
155: return 1 if ($result eq 'done');
156: return 0;
157: }
158:
159:
160: # -------------------------------------------------- Non-critical communication
161: sub subreply {
162: my ($cmd,$server)=@_;
163: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
164: #
165: # With loncnew process trimming, there's a timing hole between lonc server
166: # process exit and the master server picking up the listen on the AF_UNIX
167: # socket. In that time interval, a lock file will exist:
168:
169: my $lockfile=$peerfile.".lock";
170: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
171: sleep(1);
172: }
173: # At this point, either a loncnew parent is listening or an old lonc
174: # or loncnew child is listening so we can connect or everything's dead.
175: #
176: # We'll give the connection a few tries before abandoning it. If
177: # connection is not possible, we'll con_lost back to the client.
178: #
179: my $client;
180: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
181: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
182: Type => SOCK_STREAM,
183: Timeout => 10);
184: if ($client) {
185: last; # Connected!
186: } else {
187: &create_connection(&hostname($server),$server);
188: }
189: sleep(1); # Try again later if failed connection.
190: }
191: my $answer;
192: if ($client) {
193: print $client "sethost:$server:$cmd\n";
194: $answer=<$client>;
195: if (!$answer) { $answer="con_lost"; }
196: chomp($answer);
197: } else {
198: $answer = 'con_lost'; # Failed connection.
199: }
200: return $answer;
201: }
202:
203: sub reply {
204: my ($cmd,$server)=@_;
205: unless (defined(&hostname($server))) { return 'no_such_host'; }
206: my $answer=subreply($cmd,$server);
207: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
208: &logthis("<font color=\"blue\">WARNING:".
209: " $cmd to $server returned $answer</font>");
210: }
211: return $answer;
212: }
213:
214: # ----------------------------------------------------------- Send USR1 to lonc
215:
216: sub reconlonc {
217: my ($lonid) = @_;
218: my $hostname = &hostname($lonid);
219: if ($lonid) {
220: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
221: if ($hostname && -e $peerfile) {
222: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
223: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
224: Type => SOCK_STREAM,
225: Timeout => 10);
226: if ($client) {
227: print $client ("reset_retries\n");
228: my $answer=<$client>;
229: #reset just this one.
230: }
231: }
232: return;
233: }
234:
235: &logthis("Trying to reconnect lonc");
236: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
237: if (open(my $fh,"<$loncfile")) {
238: my $loncpid=<$fh>;
239: chomp($loncpid);
240: if (kill 0 => $loncpid) {
241: &logthis("lonc at pid $loncpid responding, sending USR1");
242: kill USR1 => $loncpid;
243: sleep 1;
244: } else {
245: &logthis(
246: "<font color=\"blue\">WARNING:".
247: " lonc at pid $loncpid not responding, giving up</font>");
248: }
249: } else {
250: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
251: }
252: }
253:
254: # ------------------------------------------------------ Critical communication
255:
256: sub critical {
257: my ($cmd,$server)=@_;
258: unless (&hostname($server)) {
259: &logthis("<font color=\"blue\">WARNING:".
260: " Critical message to unknown server ($server)</font>");
261: return 'no_such_host';
262: }
263: my $answer=reply($cmd,$server);
264: if ($answer eq 'con_lost') {
265: &reconlonc("$perlvar{'lonSockDir'}/$server");
266: my $answer=reply($cmd,$server);
267: if ($answer eq 'con_lost') {
268: my $now=time;
269: my $middlename=$cmd;
270: $middlename=substr($middlename,0,16);
271: $middlename=~s/\W//g;
272: my $dfilename=
273: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
274: $dumpcount++;
275: {
276: my $dfh;
277: if (open($dfh,">$dfilename")) {
278: print $dfh "$cmd\n";
279: close($dfh);
280: }
281: }
282: sleep 2;
283: my $wcmd='';
284: {
285: my $dfh;
286: if (open($dfh,"<$dfilename")) {
287: $wcmd=<$dfh>;
288: close($dfh);
289: }
290: }
291: chomp($wcmd);
292: if ($wcmd eq $cmd) {
293: &logthis("<font color=\"blue\">WARNING: ".
294: "Connection buffer $dfilename: $cmd</font>");
295: &logperm("D:$server:$cmd");
296: return 'con_delayed';
297: } else {
298: &logthis("<font color=\"red\">CRITICAL:"
299: ." Critical connection failed: $server $cmd</font>");
300: &logperm("F:$server:$cmd");
301: return 'con_failed';
302: }
303: }
304: }
305: return $answer;
306: }
307:
308: # ------------------------------------------- check if return value is an error
309:
310: sub error {
311: my ($result) = @_;
312: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
313: if ($2 == 2) { return undef; }
314: return $1;
315: }
316: return undef;
317: }
318:
319: sub convert_and_load_session_env {
320: my ($lonidsdir,$handle)=@_;
321: my @profile;
322: {
323: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
324: if (!$opened) {
325: return 0;
326: }
327: flock($idf,LOCK_SH);
328: @profile=<$idf>;
329: close($idf);
330: }
331: my %temp_env;
332: foreach my $line (@profile) {
333: if ($line !~ m/=/) {
334: return 0;
335: }
336: chomp($line);
337: my ($envname,$envvalue)=split(/=/,$line,2);
338: $temp_env{&unescape($envname)} = &unescape($envvalue);
339: }
340: unlink("$lonidsdir/$handle.id");
341: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
342: 0640)) {
343: %disk_env = %temp_env;
344: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
345: untie(%disk_env);
346: }
347: return 1;
348: }
349:
350: # ------------------------------------------- Transfer profile into environment
351: my $env_loaded;
352: sub transfer_profile_to_env {
353: my ($lonidsdir,$handle,$force_transfer) = @_;
354: if (!$force_transfer && $env_loaded) { return; }
355:
356: if (!defined($lonidsdir)) {
357: $lonidsdir = $perlvar{'lonIDsDir'};
358: }
359: if (!defined($handle)) {
360: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
361: }
362:
363: my $convert;
364: {
365: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
366: if (!$opened) {
367: return;
368: }
369: flock($idf,LOCK_SH);
370: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
371: &GDBM_READER(),0640)) {
372: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
373: untie(%disk_env);
374: } else {
375: $convert = 1;
376: }
377: }
378: if ($convert) {
379: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
380: &logthis("Failed to load session, or convert session.");
381: }
382: }
383:
384: my %remove;
385: while ( my $envname = each(%env) ) {
386: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
387: if ($time < time-300) {
388: $remove{$key}++;
389: }
390: }
391: }
392:
393: $env{'user.environment'} = "$lonidsdir/$handle.id";
394: $env_loaded=1;
395: foreach my $expired_key (keys(%remove)) {
396: &delenv($expired_key);
397: }
398: }
399:
400: # ---------------------------------------------------- Check for valid session
401: sub check_for_valid_session {
402: my ($r) = @_;
403: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
404: my $lonid=$cookies{'lonID'};
405: return undef if (!$lonid);
406:
407: my $handle=&LONCAPA::clean_handle($lonid->value);
408: my $lonidsdir=$r->dir_config('lonIDsDir');
409: return undef if (!-e "$lonidsdir/$handle.id");
410:
411: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
412: return undef if (!$opened);
413:
414: flock($idf,LOCK_SH);
415: my %disk_env;
416: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
417: &GDBM_READER(),0640)) {
418: return undef;
419: }
420:
421: if (!defined($disk_env{'user.name'})
422: || !defined($disk_env{'user.domain'})) {
423: return undef;
424: }
425: return $handle;
426: }
427:
428: sub timed_flock {
429: my ($file,$lock_type) = @_;
430: my $failed=0;
431: eval {
432: local $SIG{__DIE__}='DEFAULT';
433: local $SIG{ALRM}=sub {
434: $failed=1;
435: die("failed lock");
436: };
437: alarm(13);
438: flock($file,$lock_type);
439: alarm(0);
440: };
441: if ($failed) {
442: return undef;
443: } else {
444: return 1;
445: }
446: }
447:
448: # ---------------------------------------------------------- Append Environment
449:
450: sub appenv {
451: my %newenv=@_;
452: foreach my $key (keys(%newenv)) {
453: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
454: &logthis("<font color=\"blue\">WARNING: ".
455: "Attempt to modify environment ".$key." to ".$newenv{$key}
456: .'</font>');
457: delete($newenv{$key});
458: } else {
459: $env{$key}=$newenv{$key};
460: }
461: }
462: my $opened = open(my $env_file,'+<',$env{'user.environment'});
463: if ($opened
464: && &timed_flock($env_file,LOCK_EX)
465: &&
466: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
467: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
468: while (my ($key,$value) = each(%newenv)) {
469: $disk_env{$key} = $value;
470: }
471: untie(%disk_env);
472: }
473: return 'ok';
474: }
475: # ----------------------------------------------------- Delete from Environment
476:
477: sub delenv {
478: my $delthis=shift;
479: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
480: &logthis("<font color=\"blue\">WARNING: ".
481: "Attempt to delete from environment ".$delthis);
482: return 'error';
483: }
484: my $opened = open(my $env_file,'+<',$env{'user.environment'});
485: if ($opened
486: && &timed_flock($env_file,LOCK_EX)
487: &&
488: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
489: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
490: foreach my $key (keys(%disk_env)) {
491: if ($key=~/^$delthis/) {
492: delete($env{$key});
493: delete($disk_env{$key});
494: }
495: }
496: untie(%disk_env);
497: }
498: return 'ok';
499: }
500:
501: sub get_env_multiple {
502: my ($name) = @_;
503: my @values;
504: if (defined($env{$name})) {
505: # exists is it an array
506: if (ref($env{$name})) {
507: @values=@{ $env{$name} };
508: } else {
509: $values[0]=$env{$name};
510: }
511: }
512: return(@values);
513: }
514:
515: # ------------------------------------------ Find out current server userload
516: sub userload {
517: my $numusers=0;
518: {
519: opendir(LONIDS,$perlvar{'lonIDsDir'});
520: my $filename;
521: my $curtime=time;
522: while ($filename=readdir(LONIDS)) {
523: next if ($filename eq '.' || $filename eq '..');
524: next if ($filename =~ /publicuser_\d+\.id/);
525: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
526: if ($curtime-$mtime < 1800) { $numusers++; }
527: }
528: closedir(LONIDS);
529: }
530: my $userloadpercent=0;
531: my $maxuserload=$perlvar{'lonUserLoadLim'};
532: if ($maxuserload) {
533: $userloadpercent=100*$numusers/$maxuserload;
534: }
535: $userloadpercent=sprintf("%.2f",$userloadpercent);
536: return $userloadpercent;
537: }
538:
539: # ------------------------------------------ Fight off request when overloaded
540:
541: sub overloaderror {
542: my ($r,$checkserver)=@_;
543: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
544: my $loadavg;
545: if ($checkserver eq $perlvar{'lonHostID'}) {
546: open(my $loadfile,'/proc/loadavg');
547: $loadavg=<$loadfile>;
548: $loadavg =~ s/\s.*//g;
549: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
550: close($loadfile);
551: } else {
552: $loadavg=&reply('load',$checkserver);
553: }
554: my $overload=$loadavg-100;
555: if ($overload>0) {
556: $r->err_headers_out->{'Retry-After'}=$overload;
557: $r->log_error('Overload of '.$overload.' on '.$checkserver);
558: return 413;
559: }
560: return '';
561: }
562:
563: # ------------------------------ Find server with least workload from spare.tab
564:
565: sub spareserver {
566: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
567: my $spare_server;
568: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
569: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
570: : $userloadpercent;
571:
572: foreach my $try_server (@{ $spareid{'primary'} }) {
573: ($spare_server, $lowest_load) =
574: &compare_server_load($try_server, $spare_server, $lowest_load);
575: }
576:
577: my $found_server = ($spare_server ne '' && $lowest_load < 100);
578:
579: if (!$found_server) {
580: foreach my $try_server (@{ $spareid{'default'} }) {
581: ($spare_server, $lowest_load) =
582: &compare_server_load($try_server, $spare_server, $lowest_load);
583: }
584: }
585:
586: if (!$want_server_name) {
587: $spare_server="http://".&hostname($spare_server);
588: }
589: return $spare_server;
590: }
591:
592: sub compare_server_load {
593: my ($try_server, $spare_server, $lowest_load) = @_;
594:
595: my $loadans = &reply('load', $try_server);
596: my $userloadans = &reply('userload',$try_server);
597:
598: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
599: next; #didn't get a number from the server
600: }
601:
602: my $load;
603: if ($loadans =~ /\d/) {
604: if ($userloadans =~ /\d/) {
605: #both are numbers, pick the bigger one
606: $load = ($loadans > $userloadans) ? $loadans
607: : $userloadans;
608: } else {
609: $load = $loadans;
610: }
611: } else {
612: $load = $userloadans;
613: }
614:
615: if (($load =~ /\d/) && ($load < $lowest_load)) {
616: $spare_server = $try_server;
617: $lowest_load = $load;
618: }
619: return ($spare_server,$lowest_load);
620: }
621:
622: # --------------------------- ask offload servers if user already has a session
623: sub find_existing_session {
624: my ($udom,$uname) = @_;
625: foreach my $try_server (@{ $spareid{'primary'} },
626: @{ $spareid{'default'} }) {
627: return $try_server if (&has_user_session($try_server, $udom, $uname));
628: }
629: return;
630: }
631:
632: # -------------------------------- ask if server already has a session for user
633: sub has_user_session {
634: my ($lonid,$udom,$uname) = @_;
635: my $result = &reply(join(':','userhassession',
636: map {&escape($_)} ($udom,$uname)),$lonid);
637: return 1 if ($result eq 'ok');
638:
639: return 0;
640: }
641:
642: # --------------------------------------------- Try to change a user's password
643:
644: sub changepass {
645: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
646: $currentpass = &escape($currentpass);
647: $newpass = &escape($newpass);
648: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
649: $server);
650: if (! $answer) {
651: &logthis("No reply on password change request to $server ".
652: "by $uname in domain $udom.");
653: } elsif ($answer =~ "^ok") {
654: &logthis("$uname in $udom successfully changed their password ".
655: "on $server.");
656: } elsif ($answer =~ "^pwchange_failure") {
657: &logthis("$uname in $udom was unable to change their password ".
658: "on $server. The action was blocked by either lcpasswd ".
659: "or pwchange");
660: } elsif ($answer =~ "^non_authorized") {
661: &logthis("$uname in $udom did not get their password correct when ".
662: "attempting to change it on $server.");
663: } elsif ($answer =~ "^auth_mode_error") {
664: &logthis("$uname in $udom attempted to change their password despite ".
665: "not being locally or internally authenticated on $server.");
666: } elsif ($answer =~ "^unknown_user") {
667: &logthis("$uname in $udom attempted to change their password ".
668: "on $server but were unable to because $server is not ".
669: "their home server.");
670: } elsif ($answer =~ "^refused") {
671: &logthis("$server refused to change $uname in $udom password because ".
672: "it was sent an unencrypted request to change the password.");
673: }
674: return $answer;
675: }
676:
677: # ----------------------- Try to determine user's current authentication scheme
678:
679: sub queryauthenticate {
680: my ($uname,$udom)=@_;
681: my $uhome=&homeserver($uname,$udom);
682: if (!$uhome) {
683: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
684: return 'no_host';
685: }
686: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
687: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
688: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
689: }
690: return $answer;
691: }
692:
693: # --------- Try to authenticate user from domain's lib servers (first this one)
694:
695: sub authenticate {
696: my ($uname,$upass,$udom)=@_;
697: $upass=&escape($upass);
698: $uname= &LONCAPA::clean_username($uname);
699: my $uhome=&homeserver($uname,$udom,1);
700: if ((!$uhome) || ($uhome eq 'no_host')) {
701: # Maybe the machine was offline and only re-appeared again recently?
702: &reconlonc();
703: # One more
704: my $uhome=&homeserver($uname,$udom,1);
705: if ((!$uhome) || ($uhome eq 'no_host')) {
706: &logthis("User $uname at $udom is unknown in authenticate");
707: }
708: return 'no_host';
709: }
710: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
711: if ($answer eq 'authorized') {
712: &logthis("User $uname at $udom authorized by $uhome");
713: return $uhome;
714: }
715: if ($answer eq 'non_authorized') {
716: &logthis("User $uname at $udom rejected by $uhome");
717: return 'no_host';
718: }
719: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
720: return 'no_host';
721: }
722:
723: # ---------------------- Find the homebase for a user from domain's lib servers
724:
725: my %homecache;
726: sub homeserver {
727: my ($uname,$udom,$ignoreBadCache)=@_;
728: my $index="$uname:$udom";
729:
730: if (exists($homecache{$index})) { return $homecache{$index}; }
731:
732: my %servers = &get_servers($udom,'library');
733: foreach my $tryserver (keys(%servers)) {
734: next if ($ignoreBadCache ne 'true' &&
735: exists($badServerCache{$tryserver}));
736:
737: my $answer=reply("home:$udom:$uname",$tryserver);
738: if ($answer eq 'found') {
739: delete($badServerCache{$tryserver});
740: return $homecache{$index}=$tryserver;
741: } elsif ($answer eq 'no_host') {
742: $badServerCache{$tryserver}=1;
743: }
744: }
745: return 'no_host';
746: }
747:
748: # ------------------------------------- Find the usernames behind a list of IDs
749:
750: sub idget {
751: my ($udom,@ids)=@_;
752: my %returnhash=();
753:
754: my %servers = &get_servers($udom,'library');
755: foreach my $tryserver (keys(%servers)) {
756: my $idlist=join('&',@ids);
757: $idlist=~tr/A-Z/a-z/;
758: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
759: my @answer=();
760: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
761: @answer=split(/\&/,$reply);
762: } ;
763: my $i;
764: for ($i=0;$i<=$#ids;$i++) {
765: if ($answer[$i]) {
766: $returnhash{$ids[$i]}=$answer[$i];
767: }
768: }
769: }
770: return %returnhash;
771: }
772:
773: # ------------------------------------- Find the IDs behind a list of usernames
774:
775: sub idrget {
776: my ($udom,@unames)=@_;
777: my %returnhash=();
778: foreach my $uname (@unames) {
779: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
780: }
781: return %returnhash;
782: }
783:
784: # ------------------------------- Store away a list of names and associated IDs
785:
786: sub idput {
787: my ($udom,%ids)=@_;
788: my %servers=();
789: foreach my $uname (keys(%ids)) {
790: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
791: my $uhom=&homeserver($uname,$udom);
792: if ($uhom ne 'no_host') {
793: my $id=&escape($ids{$uname});
794: $id=~tr/A-Z/a-z/;
795: my $esc_unam=&escape($uname);
796: if ($servers{$uhom}) {
797: $servers{$uhom}.='&'.$id.'='.$esc_unam;
798: } else {
799: $servers{$uhom}=$id.'='.$esc_unam;
800: }
801: }
802: }
803: foreach my $server (keys(%servers)) {
804: &critical('idput:'.$udom.':'.$servers{$server},$server);
805: }
806: }
807:
808: # ------------------------------------------- get items from domain db files
809:
810: sub get_dom {
811: my ($namespace,$storearr,$udom,$uhome)=@_;
812: my $items='';
813: foreach my $item (@$storearr) {
814: $items.=&escape($item).'&';
815: }
816: $items=~s/\&$//;
817: if (!$udom) {
818: $udom=$env{'user.domain'};
819: if (defined(&domain($udom,'primary'))) {
820: $uhome=&domain($udom,'primary');
821: } else {
822: undef($uhome);
823: }
824: } else {
825: if (!$uhome) {
826: if (defined(&domain($udom,'primary'))) {
827: $uhome=&domain($udom,'primary');
828: }
829: }
830: }
831: if ($udom && $uhome && ($uhome ne 'no_host')) {
832: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
833: my %returnhash;
834: if ($rep eq '' || $rep =~ /^error: 2 /) {
835: return %returnhash;
836: }
837: my @pairs=split(/\&/,$rep);
838: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
839: return @pairs;
840: }
841: my $i=0;
842: foreach my $item (@$storearr) {
843: $returnhash{$item}=&thaw_unescape($pairs[$i]);
844: $i++;
845: }
846: return %returnhash;
847: } else {
848: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
849: }
850: }
851:
852: # -------------------------------------------- put items in domain db files
853:
854: sub put_dom {
855: my ($namespace,$storehash,$udom,$uhome)=@_;
856: if (!$udom) {
857: $udom=$env{'user.domain'};
858: if (defined(&domain($udom,'primary'))) {
859: $uhome=&domain($udom,'primary');
860: } else {
861: undef($uhome);
862: }
863: } else {
864: if (!$uhome) {
865: if (defined(&domain($udom,'primary'))) {
866: $uhome=&domain($udom,'primary');
867: }
868: }
869: }
870: if ($udom && $uhome && ($uhome ne 'no_host')) {
871: my $items='';
872: foreach my $item (keys(%$storehash)) {
873: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
874: }
875: $items=~s/\&$//;
876: return &reply("putdom:$udom:$namespace:$items",$uhome);
877: } else {
878: &logthis("put_dom failed - no homeserver and/or domain");
879: }
880: }
881:
882: sub retrieve_inst_usertypes {
883: my ($udom) = @_;
884: my (%returnhash,@order);
885: if (defined(&domain($udom,'primary'))) {
886: my $uhome=&domain($udom,'primary');
887: my $rep=&reply("inst_usertypes:$udom",$uhome);
888: my ($hashitems,$orderitems) = split(/:/,$rep);
889: my @pairs=split(/\&/,$hashitems);
890: foreach my $item (@pairs) {
891: my ($key,$value)=split(/=/,$item,2);
892: $key = &unescape($key);
893: next if ($key =~ /^error: 2 /);
894: $returnhash{$key}=&thaw_unescape($value);
895: }
896: my @esc_order = split(/\&/,$orderitems);
897: foreach my $item (@esc_order) {
898: push(@order,&unescape($item));
899: }
900: } else {
901: &logthis("get_dom failed - no primary domain server for $udom");
902: }
903: return (\%returnhash,\@order);
904: }
905:
906: sub is_domainimage {
907: my ($url) = @_;
908: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
909: if (&domain($1) ne '') {
910: return '1';
911: }
912: }
913: return;
914: }
915:
916: sub inst_directory_query {
917: my ($srch) = @_;
918: my $udom = $srch->{'srchdomain'};
919: my %results;
920: my $homeserver = &domain($udom,'primary');
921: my $outcome;
922: if ($homeserver ne '') {
923: my $queryid=&reply("querysend:instdirsearch:".
924: &escape($srch->{'srchby'}).':'.
925: &escape($srch->{'srchterm'}).':'.
926: &escape($srch->{'srchtype'}),$homeserver);
927: my $host=&hostname($homeserver);
928: if ($queryid !~/^\Q$host\E\_/) {
929: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
930: return;
931: }
932: my $response = &get_query_reply($queryid);
933: my $maxtries = 5;
934: my $tries = 1;
935: while (($response=~/^timeout/) && ($tries < $maxtries)) {
936: $response = &get_query_reply($queryid);
937: $tries ++;
938: }
939:
940: if (!&error($response) && $response ne 'refused') {
941: if ($response eq 'unavailable') {
942: $outcome = $response;
943: } else {
944: $outcome = 'ok';
945: my @matches = split(/\n/,$response);
946: foreach my $match (@matches) {
947: my ($key,$value) = split(/=/,$match);
948: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
949: }
950: }
951: }
952: }
953: return ($outcome,%results);
954: }
955:
956: sub usersearch {
957: my ($srch) = @_;
958: my $dom = $srch->{'srchdomain'};
959: my %results;
960: my %libserv = &all_library();
961: my $query = 'usersearch';
962: foreach my $tryserver (keys(%libserv)) {
963: if (&host_domain($tryserver) eq $dom) {
964: my $host=&hostname($tryserver);
965: my $queryid=
966: &reply("querysend:".&escape($query).':'.
967: &escape($srch->{'srchby'}).':'.
968: &escape($srch->{'srchtype'}).':'.
969: &escape($srch->{'srchterm'}),$tryserver);
970: if ($queryid !~/^\Q$host\E\_/) {
971: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
972: next;
973: }
974: my $reply = &get_query_reply($queryid);
975: my $maxtries = 1;
976: my $tries = 1;
977: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
978: $reply = &get_query_reply($queryid);
979: $tries ++;
980: }
981: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
982: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
983: } else {
984: my @matches;
985: if ($reply =~ /\n/) {
986: @matches = split(/\n/,$reply);
987: } else {
988: @matches = split(/\&/,$reply);
989: }
990: foreach my $match (@matches) {
991: my ($uname,$udom,%userhash);
992: foreach my $entry (split(/:/,$match)) {
993: my ($key,$value) =
994: map {&unescape($_);} split(/=/,$entry);
995: $userhash{$key} = $value;
996: if ($key eq 'username') {
997: $uname = $value;
998: } elsif ($key eq 'domain') {
999: $udom = $value;
1000: }
1001: }
1002: $results{$uname.':'.$udom} = \%userhash;
1003: }
1004: }
1005: }
1006: }
1007: return %results;
1008: }
1009:
1010: sub get_instuser {
1011: my ($udom,$uname,$id) = @_;
1012: my $homeserver = &domain($udom,'primary');
1013: my ($outcome,%results);
1014: if ($homeserver ne '') {
1015: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1016: &escape($id).':'.&escape($udom),$homeserver);
1017: my $host=&hostname($homeserver);
1018: if ($queryid !~/^\Q$host\E\_/) {
1019: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1020: return;
1021: }
1022: my $response = &get_query_reply($queryid);
1023: my $maxtries = 5;
1024: my $tries = 1;
1025: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1026: $response = &get_query_reply($queryid);
1027: $tries ++;
1028: }
1029: if (!&error($response) && $response ne 'refused') {
1030: if ($response eq 'unavailable') {
1031: $outcome = $response;
1032: } else {
1033: $outcome = 'ok';
1034: my @matches = split(/\n/,$response);
1035: foreach my $match (@matches) {
1036: my ($key,$value) = split(/=/,$match);
1037: $results{&unescape($key)} = &thaw_unescape($value);
1038: }
1039: }
1040: }
1041: }
1042: my %userinfo;
1043: if (ref($results{$uname}) eq 'HASH') {
1044: %userinfo = %{$results{$uname}};
1045: }
1046: return ($outcome,%userinfo);
1047: }
1048:
1049: sub inst_rulecheck {
1050: my ($udom,$uname,$id,$item,$rules) = @_;
1051: my %returnhash;
1052: if ($udom ne '') {
1053: if (ref($rules) eq 'ARRAY') {
1054: @{$rules} = map {&escape($_);} (@{$rules});
1055: my $rulestr = join(':',@{$rules});
1056: my $homeserver=&domain($udom,'primary');
1057: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1058: my $response;
1059: if ($item eq 'username') {
1060: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1061: ':'.&escape($uname).':'.$rulestr,
1062: $homeserver));
1063: } elsif ($item eq 'id') {
1064: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1065: ':'.&escape($id).':'.$rulestr,
1066: $homeserver));
1067: }
1068: if ($response ne 'refused') {
1069: my @pairs=split(/\&/,$response);
1070: foreach my $item (@pairs) {
1071: my ($key,$value)=split(/=/,$item,2);
1072: $key = &unescape($key);
1073: next if ($key =~ /^error: 2 /);
1074: $returnhash{$key}=&thaw_unescape($value);
1075: }
1076: }
1077: }
1078: }
1079: }
1080: return %returnhash;
1081: }
1082:
1083: sub inst_userrules {
1084: my ($udom,$check) = @_;
1085: my (%ruleshash,@ruleorder);
1086: if ($udom ne '') {
1087: my $homeserver=&domain($udom,'primary');
1088: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1089: my $response;
1090: if ($check eq 'id') {
1091: $response=&reply('instidrules:'.&escape($udom),
1092: $homeserver);
1093: } else {
1094: $response=&reply('instuserrules:'.&escape($udom),
1095: $homeserver);
1096: }
1097: if (($response ne 'refused') && ($response ne 'error') &&
1098: ($response ne 'unknown_cmd') &&
1099: ($response ne 'no_such_host')) {
1100: my ($hashitems,$orderitems) = split(/:/,$response);
1101: my @pairs=split(/\&/,$hashitems);
1102: foreach my $item (@pairs) {
1103: my ($key,$value)=split(/=/,$item,2);
1104: $key = &unescape($key);
1105: next if ($key =~ /^error: 2 /);
1106: $ruleshash{$key}=&thaw_unescape($value);
1107: }
1108: my @esc_order = split(/\&/,$orderitems);
1109: foreach my $item (@esc_order) {
1110: push(@ruleorder,&unescape($item));
1111: }
1112: }
1113: }
1114: }
1115: return (\%ruleshash,\@ruleorder);
1116: }
1117:
1118: # --------------------------------------------------- Assign a key to a student
1119:
1120: sub assign_access_key {
1121: #
1122: # a valid key looks like uname:udom#comments
1123: # comments are being appended
1124: #
1125: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1126: $kdom=
1127: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1128: $knum=
1129: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1130: $cdom=
1131: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1132: $cnum=
1133: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1134: $udom=$env{'user.name'} unless (defined($udom));
1135: $uname=$env{'user.domain'} unless (defined($uname));
1136: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1137: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1138: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1139: # assigned to this person
1140: # - this should not happen,
1141: # unless something went wrong
1142: # the first time around
1143: # ready to assign
1144: $logentry=$1.'; '.$logentry;
1145: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1146: $kdom,$knum) eq 'ok') {
1147: # key now belongs to user
1148: my $envkey='key.'.$cdom.'_'.$cnum;
1149: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1150: &appenv('environment.'.$envkey => $ckey);
1151: return 'ok';
1152: } else {
1153: return
1154: 'error: Count not permanently assign key, will need to be re-entered later.';
1155: }
1156: } else {
1157: return 'error: Could not assign key, try again later.';
1158: }
1159: } elsif (!$existing{$ckey}) {
1160: # the key does not exist
1161: return 'error: The key does not exist';
1162: } else {
1163: # the key is somebody else's
1164: return 'error: The key is already in use';
1165: }
1166: }
1167:
1168: # ------------------------------------------ put an additional comment on a key
1169:
1170: sub comment_access_key {
1171: #
1172: # a valid key looks like uname:udom#comments
1173: # comments are being appended
1174: #
1175: my ($ckey,$cdom,$cnum,$logentry)=@_;
1176: $cdom=
1177: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1178: $cnum=
1179: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1180: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1181: if ($existing{$ckey}) {
1182: $existing{$ckey}.='; '.$logentry;
1183: # ready to assign
1184: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1185: $cdom,$cnum) eq 'ok') {
1186: return 'ok';
1187: } else {
1188: return 'error: Count not store comment.';
1189: }
1190: } else {
1191: # the key does not exist
1192: return 'error: The key does not exist';
1193: }
1194: }
1195:
1196: # ------------------------------------------------------ Generate a set of keys
1197:
1198: sub generate_access_keys {
1199: my ($number,$cdom,$cnum,$logentry)=@_;
1200: $cdom=
1201: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1202: $cnum=
1203: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1204: unless (&allowed('mky',$cdom)) { return 0; }
1205: unless (($cdom) && ($cnum)) { return 0; }
1206: if ($number>10000) { return 0; }
1207: sleep(2); # make sure don't get same seed twice
1208: srand(time()^($$+($$<<15))); # from "Programming Perl"
1209: my $total=0;
1210: for (my $i=1;$i<=$number;$i++) {
1211: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1212: sprintf("%lx",int(100000*rand)).'-'.
1213: sprintf("%lx",int(100000*rand));
1214: $newkey=~s/1/g/g; # folks mix up 1 and l
1215: $newkey=~s/0/h/g; # and also 0 and O
1216: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1217: if ($existing{$newkey}) {
1218: $i--;
1219: } else {
1220: if (&put('accesskeys',
1221: { $newkey => '# generated '.localtime().
1222: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1223: '; '.$logentry },
1224: $cdom,$cnum) eq 'ok') {
1225: $total++;
1226: }
1227: }
1228: }
1229: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1230: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1231: return $total;
1232: }
1233:
1234: # ------------------------------------------------------- Validate an accesskey
1235:
1236: sub validate_access_key {
1237: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1238: $cdom=
1239: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1240: $cnum=
1241: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1242: $udom=$env{'user.domain'} unless (defined($udom));
1243: $uname=$env{'user.name'} unless (defined($uname));
1244: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1245: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1246: }
1247:
1248: # ------------------------------------- Find the section of student in a course
1249: sub devalidate_getsection_cache {
1250: my ($udom,$unam,$courseid)=@_;
1251: my $hashid="$udom:$unam:$courseid";
1252: &devalidate_cache_new('getsection',$hashid);
1253: }
1254:
1255: sub courseid_to_courseurl {
1256: my ($courseid) = @_;
1257: #already url style courseid
1258: return $courseid if ($courseid =~ m{^/});
1259:
1260: if (exists($env{'course.'.$courseid.'.num'})) {
1261: my $cnum = $env{'course.'.$courseid.'.num'};
1262: my $cdom = $env{'course.'.$courseid.'.domain'};
1263: return "/$cdom/$cnum";
1264: }
1265:
1266: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1267: if (exists($courseinfo{'num'})) {
1268: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1269: }
1270:
1271: return undef;
1272: }
1273:
1274: sub getsection {
1275: my ($udom,$unam,$courseid)=@_;
1276: my $cachetime=1800;
1277:
1278: my $hashid="$udom:$unam:$courseid";
1279: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1280: if (defined($cached)) { return $result; }
1281:
1282: my %Pending;
1283: my %Expired;
1284: #
1285: # Each role can either have not started yet (pending), be active,
1286: # or have expired.
1287: #
1288: # If there is an active role, we are done.
1289: #
1290: # If there is more than one role which has not started yet,
1291: # choose the one which will start sooner
1292: # If there is one role which has not started yet, return it.
1293: #
1294: # If there is more than one expired role, choose the one which ended last.
1295: # If there is a role which has expired, return it.
1296: #
1297: $courseid = &courseid_to_courseurl($courseid);
1298: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1299: foreach my $key (keys(%roleshash)) {
1300: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1301: my $section=$1;
1302: if ($key eq $courseid.'_st') { $section=''; }
1303: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1304: my $now=time;
1305: if (defined($end) && $end && ($now > $end)) {
1306: $Expired{$end}=$section;
1307: next;
1308: }
1309: if (defined($start) && $start && ($now < $start)) {
1310: $Pending{$start}=$section;
1311: next;
1312: }
1313: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1314: }
1315: #
1316: # Presumedly there will be few matching roles from the above
1317: # loop and the sorting time will be negligible.
1318: if (scalar(keys(%Pending))) {
1319: my ($time) = sort {$a <=> $b} keys(%Pending);
1320: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1321: }
1322: if (scalar(keys(%Expired))) {
1323: my @sorted = sort {$a <=> $b} keys(%Expired);
1324: my $time = pop(@sorted);
1325: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1326: }
1327: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1328: }
1329:
1330: sub save_cache {
1331: &purge_remembered();
1332: #&Apache::loncommon::validate_page();
1333: undef(%env);
1334: undef($env_loaded);
1335: }
1336:
1337: my $to_remember=-1;
1338: my %remembered;
1339: my %accessed;
1340: my $kicks=0;
1341: my $hits=0;
1342: sub make_key {
1343: my ($name,$id) = @_;
1344: if (length($id) > 65
1345: && length(&escape($id)) > 200) {
1346: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1347: }
1348: return &escape($name.':'.$id);
1349: }
1350:
1351: sub devalidate_cache_new {
1352: my ($name,$id,$debug) = @_;
1353: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1354: $id=&make_key($name,$id);
1355: $memcache->delete($id);
1356: delete($remembered{$id});
1357: delete($accessed{$id});
1358: }
1359:
1360: sub is_cached_new {
1361: my ($name,$id,$debug) = @_;
1362: $id=&make_key($name,$id);
1363: if (exists($remembered{$id})) {
1364: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1365: $accessed{$id}=[&gettimeofday()];
1366: $hits++;
1367: return ($remembered{$id},1);
1368: }
1369: my $value = $memcache->get($id);
1370: if (!(defined($value))) {
1371: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1372: return (undef,undef);
1373: }
1374: if ($value eq '__undef__') {
1375: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1376: $value=undef;
1377: }
1378: &make_room($id,$value,$debug);
1379: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1380: return ($value,1);
1381: }
1382:
1383: sub do_cache_new {
1384: my ($name,$id,$value,$time,$debug) = @_;
1385: $id=&make_key($name,$id);
1386: my $setvalue=$value;
1387: if (!defined($setvalue)) {
1388: $setvalue='__undef__';
1389: }
1390: if (!defined($time) ) {
1391: $time=600;
1392: }
1393: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1394: my $result = $memcache->set($id,$setvalue,$time);
1395: if (! $result) {
1396: &logthis("caching of id -> $id failed");
1397: $memcache->disconnect_all();
1398: }
1399: # need to make a copy of $value
1400: &make_room($id,$value,$debug);
1401: return $value;
1402: }
1403:
1404: sub make_room {
1405: my ($id,$value,$debug)=@_;
1406:
1407: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1408: : $value;
1409: if ($to_remember<0) { return; }
1410: $accessed{$id}=[&gettimeofday()];
1411: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1412: my $to_kick;
1413: my $max_time=0;
1414: foreach my $other (keys(%accessed)) {
1415: if (&tv_interval($accessed{$other}) > $max_time) {
1416: $to_kick=$other;
1417: $max_time=&tv_interval($accessed{$other});
1418: }
1419: }
1420: delete($remembered{$to_kick});
1421: delete($accessed{$to_kick});
1422: $kicks++;
1423: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1424: return;
1425: }
1426:
1427: sub purge_remembered {
1428: #&logthis("Tossing ".scalar(keys(%remembered)));
1429: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1430: undef(%remembered);
1431: undef(%accessed);
1432: }
1433: # ------------------------------------- Read an entry from a user's environment
1434:
1435: sub userenvironment {
1436: my ($udom,$unam,@what)=@_;
1437: my %returnhash=();
1438: my @answer=split(/\&/,
1439: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1440: &homeserver($unam,$udom)));
1441: my $i;
1442: for ($i=0;$i<=$#what;$i++) {
1443: $returnhash{$what[$i]}=&unescape($answer[$i]);
1444: }
1445: return %returnhash;
1446: }
1447:
1448: # ---------------------------------------------------------- Get a studentphoto
1449: sub studentphoto {
1450: my ($udom,$unam,$ext) = @_;
1451: my $home=&Apache::lonnet::homeserver($unam,$udom);
1452: if (defined($env{'request.course.id'})) {
1453: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1454: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1455: return(&retrievestudentphoto($udom,$unam,$ext));
1456: } else {
1457: my ($result,$perm_reqd)=
1458: &Apache::lonnet::auto_photo_permission($unam,$udom);
1459: if ($result eq 'ok') {
1460: if (!($perm_reqd eq 'yes')) {
1461: return(&retrievestudentphoto($udom,$unam,$ext));
1462: }
1463: }
1464: }
1465: }
1466: } else {
1467: my ($result,$perm_reqd) =
1468: &Apache::lonnet::auto_photo_permission($unam,$udom);
1469: if ($result eq 'ok') {
1470: if (!($perm_reqd eq 'yes')) {
1471: return(&retrievestudentphoto($udom,$unam,$ext));
1472: }
1473: }
1474: }
1475: return '/adm/lonKaputt/lonlogo_broken.gif';
1476: }
1477:
1478: sub retrievestudentphoto {
1479: my ($udom,$unam,$ext,$type) = @_;
1480: my $home=&Apache::lonnet::homeserver($unam,$udom);
1481: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1482: if ($ret eq 'ok') {
1483: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1484: if ($type eq 'thumbnail') {
1485: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1486: }
1487: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1488: return $tokenurl;
1489: } else {
1490: if ($type eq 'thumbnail') {
1491: return '/adm/lonKaputt/genericstudent_tn.gif';
1492: } else {
1493: return '/adm/lonKaputt/lonlogo_broken.gif';
1494: }
1495: }
1496: }
1497:
1498: # -------------------------------------------------------------------- New chat
1499:
1500: sub chatsend {
1501: my ($newentry,$anon,$group)=@_;
1502: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1503: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1504: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1505: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1506: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1507: &escape($newentry)).':'.$group,$chome);
1508: }
1509:
1510: # ------------------------------------------ Find current version of a resource
1511:
1512: sub getversion {
1513: my $fname=&clutter(shift);
1514: unless ($fname=~/^\/res\//) { return -1; }
1515: return ¤tversion(&filelocation('',$fname));
1516: }
1517:
1518: sub currentversion {
1519: my $fname=shift;
1520: my ($result,$cached)=&is_cached_new('resversion',$fname);
1521: if (defined($cached)) { return $result; }
1522: my $author=$fname;
1523: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1524: my ($udom,$uname)=split(/\//,$author);
1525: my $home=homeserver($uname,$udom);
1526: if ($home eq 'no_host') {
1527: return -1;
1528: }
1529: my $answer=reply("currentversion:$fname",$home);
1530: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1531: return -1;
1532: }
1533: return &do_cache_new('resversion',$fname,$answer,600);
1534: }
1535:
1536: # ----------------------------- Subscribe to a resource, return URL if possible
1537:
1538: sub subscribe {
1539: my $fname=shift;
1540: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1541: $fname=~s/[\n\r]//g;
1542: my $author=$fname;
1543: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1544: my ($udom,$uname)=split(/\//,$author);
1545: my $home=homeserver($uname,$udom);
1546: if ($home eq 'no_host') {
1547: return 'not_found';
1548: }
1549: my $answer=reply("sub:$fname",$home);
1550: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1551: $answer.=' by '.$home;
1552: }
1553: return $answer;
1554: }
1555:
1556: # -------------------------------------------------------------- Replicate file
1557:
1558: sub repcopy {
1559: my $filename=shift;
1560: $filename=~s/\/+/\//g;
1561: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1562: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1563: if ($filename=~m|^/home/httpd/html/userfiles/| or
1564: $filename=~m -^/*(uploaded|editupload)/-) {
1565: return &repcopy_userfile($filename);
1566: }
1567: $filename=~s/[\n\r]//g;
1568: my $transname="$filename.in.transfer";
1569: # FIXME: this should flock
1570: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1571: my $remoteurl=subscribe($filename);
1572: if ($remoteurl =~ /^con_lost by/) {
1573: &logthis("Subscribe returned $remoteurl: $filename");
1574: return 'unavailable';
1575: } elsif ($remoteurl eq 'not_found') {
1576: #&logthis("Subscribe returned not_found: $filename");
1577: return 'not_found';
1578: } elsif ($remoteurl =~ /^rejected by/) {
1579: &logthis("Subscribe returned $remoteurl: $filename");
1580: return 'forbidden';
1581: } elsif ($remoteurl eq 'directory') {
1582: return 'ok';
1583: } else {
1584: my $author=$filename;
1585: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1586: my ($udom,$uname)=split(/\//,$author);
1587: my $home=homeserver($uname,$udom);
1588: unless ($home eq $perlvar{'lonHostID'}) {
1589: my @parts=split(/\//,$filename);
1590: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1591: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1592: &logthis("Malconfiguration for replication: $filename");
1593: return 'bad_request';
1594: }
1595: my $count;
1596: for ($count=5;$count<$#parts;$count++) {
1597: $path.="/$parts[$count]";
1598: if ((-e $path)!=1) {
1599: mkdir($path,0777);
1600: }
1601: }
1602: my $ua=new LWP::UserAgent;
1603: my $request=new HTTP::Request('GET',"$remoteurl");
1604: my $response=$ua->request($request,$transname);
1605: if ($response->is_error()) {
1606: unlink($transname);
1607: my $message=$response->status_line;
1608: &logthis("<font color=\"blue\">WARNING:"
1609: ." LWP get: $message: $filename</font>");
1610: return 'unavailable';
1611: } else {
1612: if ($remoteurl!~/\.meta$/) {
1613: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1614: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1615: if ($mresponse->is_error()) {
1616: unlink($filename.'.meta');
1617: &logthis(
1618: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1619: }
1620: }
1621: rename($transname,$filename);
1622: return 'ok';
1623: }
1624: }
1625: }
1626: }
1627:
1628: # ------------------------------------------------ Get server side include body
1629: sub ssi_body {
1630: my ($filelink,%form)=@_;
1631: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1632: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1633: }
1634: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1635: &ssi($filelink,%form));
1636: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1637: $output=~s/^.*?\<body[^\>]*\>//si;
1638: $output=~s/\<\/body\s*\>.*?$//si;
1639: return $output;
1640: }
1641:
1642: # --------------------------------------------------------- Server Side Include
1643:
1644: sub absolute_url {
1645: my ($host_name) = @_;
1646: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1647: if ($host_name eq '') {
1648: $host_name = $ENV{'SERVER_NAME'};
1649: }
1650: return $protocol.$host_name;
1651: }
1652:
1653: sub ssi {
1654:
1655: my ($fn,%form)=@_;
1656:
1657: my $ua=new LWP::UserAgent;
1658:
1659: my $request;
1660:
1661: $form{'no_update_last_known'}=1;
1662: &Apache::lonenc::check_encrypt(\$fn);
1663: if (%form) {
1664: $request=new HTTP::Request('POST',&absolute_url().$fn);
1665: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1666: } else {
1667: $request=new HTTP::Request('GET',&absolute_url().$fn);
1668: }
1669:
1670: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1671: my $response=$ua->request($request);
1672:
1673: return $response->content;
1674: }
1675:
1676: sub externalssi {
1677: my ($url)=@_;
1678: my $ua=new LWP::UserAgent;
1679: my $request=new HTTP::Request('GET',$url);
1680: my $response=$ua->request($request);
1681: return $response->content;
1682: }
1683:
1684: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1685:
1686: sub allowuploaded {
1687: my ($srcurl,$url)=@_;
1688: $url=&clutter(&declutter($url));
1689: my $dir=$url;
1690: $dir=~s/\/[^\/]+$//;
1691: my %httpref=();
1692: my $httpurl=&hreflocation('',$url);
1693: $httpref{'httpref.'.$httpurl}=$srcurl;
1694: &Apache::lonnet::appenv(%httpref);
1695: }
1696:
1697: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1698: # input: action, courseID, current domain, intended
1699: # path to file, source of file, instruction to parse file for objects,
1700: # ref to hash for embedded objects,
1701: # ref to hash for codebase of java objects.
1702: #
1703: # output: url to file (if action was uploaddoc),
1704: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1705: #
1706: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1707: # course.
1708: #
1709: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1710: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1711: # course's home server.
1712: #
1713: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1714: # be copied from $source (current location) to
1715: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1716: # and will then be copied to
1717: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1718: # course's home server.
1719: #
1720: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1721: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1722: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1723: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1724: # in course's home server.
1725: #
1726:
1727: sub process_coursefile {
1728: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1729: my $fetchresult;
1730: my $home=&homeserver($docuname,$docudom);
1731: if ($action eq 'propagate') {
1732: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1733: $home);
1734: } else {
1735: my $fpath = '';
1736: my $fname = $file;
1737: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1738: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1739: my $filepath = &build_filepath($fpath);
1740: if ($action eq 'copy') {
1741: if ($source eq '') {
1742: $fetchresult = 'no source file';
1743: return $fetchresult;
1744: } else {
1745: my $destination = $filepath.'/'.$fname;
1746: rename($source,$destination);
1747: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1748: $home);
1749: }
1750: } elsif ($action eq 'uploaddoc') {
1751: open(my $fh,'>'.$filepath.'/'.$fname);
1752: print $fh $env{'form.'.$source};
1753: close($fh);
1754: if ($parser eq 'parse') {
1755: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1756: unless ($parse_result eq 'ok') {
1757: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1758: }
1759: }
1760: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1761: $home);
1762: if ($fetchresult eq 'ok') {
1763: return '/uploaded/'.$fpath.'/'.$fname;
1764: } else {
1765: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1766: ' to host '.$home.': '.$fetchresult);
1767: return '/adm/notfound.html';
1768: }
1769: }
1770: }
1771: unless ( $fetchresult eq 'ok') {
1772: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1773: ' to host '.$home.': '.$fetchresult);
1774: }
1775: return $fetchresult;
1776: }
1777:
1778: sub build_filepath {
1779: my ($fpath) = @_;
1780: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1781: unless ($fpath eq '') {
1782: my @parts=split('/',$fpath);
1783: foreach my $part (@parts) {
1784: $filepath.= '/'.$part;
1785: if ((-e $filepath)!=1) {
1786: mkdir($filepath,0777);
1787: }
1788: }
1789: }
1790: return $filepath;
1791: }
1792:
1793: sub store_edited_file {
1794: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1795: my $file = $primary_url;
1796: $file =~ s#^/uploaded/$docudom/$docuname/##;
1797: my $fpath = '';
1798: my $fname = $file;
1799: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1800: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1801: my $filepath = &build_filepath($fpath);
1802: open(my $fh,'>'.$filepath.'/'.$fname);
1803: print $fh $content;
1804: close($fh);
1805: my $home=&homeserver($docuname,$docudom);
1806: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1807: $home);
1808: if ($$fetchresult eq 'ok') {
1809: return '/uploaded/'.$fpath.'/'.$fname;
1810: } else {
1811: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1812: ' to host '.$home.': '.$$fetchresult);
1813: return '/adm/notfound.html';
1814: }
1815: }
1816:
1817: sub clean_filename {
1818: my ($fname,$args)=@_;
1819: # Replace Windows backslashes by forward slashes
1820: $fname=~s/\\/\//g;
1821: if (!$args->{'keep_path'}) {
1822: # Get rid of everything but the actual filename
1823: $fname=~s/^.*\/([^\/]+)$/$1/;
1824: }
1825: # Replace spaces by underscores
1826: $fname=~s/\s+/\_/g;
1827: # Replace all other weird characters by nothing
1828: $fname=~s{[^/\w\.\-]}{}g;
1829: # Replace all .\d. sequences with _\d. so they no longer look like version
1830: # numbers
1831: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1832: return $fname;
1833: }
1834:
1835: # --------------- Take an uploaded file and put it into the userfiles directory
1836: # input: $formname - the contents of the file are in $env{"form.$formname"}
1837: # the desired filenam is in $env{"form.$formname.filename"}
1838: # $coursedoc - if true up to the current course
1839: # if false
1840: # $subdir - directory in userfile to store the file into
1841: # $parser - instruction to parse file for objects ($parser = parse)
1842: # $allfiles - reference to hash for embedded objects
1843: # $codebase - reference to hash for codebase of java objects
1844: # $desuname - username for permanent storage of uploaded file
1845: # $dsetudom - domain for permanaent storage of uploaded file
1846: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
1847: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1848: #
1849: # output: url of file in userspace, or error: <message>
1850: # or /adm/notfound.html if failure to upload occurse
1851:
1852:
1853: sub userfileupload {
1854: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1855: $destudom,$thumbwidth,$thumbheight)=@_;
1856: if (!defined($subdir)) { $subdir='unknown'; }
1857: my $fname=$env{'form.'.$formname.'.filename'};
1858: $fname=&clean_filename($fname);
1859: # See if there is anything left
1860: unless ($fname) { return 'error: no uploaded file'; }
1861: chop($env{'form.'.$formname});
1862: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1863: my $now = time;
1864: my $filepath = 'tmp/helprequests/'.$now;
1865: my @parts=split(/\//,$filepath);
1866: my $fullpath = $perlvar{'lonDaemons'};
1867: for (my $i=0;$i<@parts;$i++) {
1868: $fullpath .= '/'.$parts[$i];
1869: if ((-e $fullpath)!=1) {
1870: mkdir($fullpath,0777);
1871: }
1872: }
1873: open(my $fh,'>'.$fullpath.'/'.$fname);
1874: print $fh $env{'form.'.$formname};
1875: close($fh);
1876: return $fullpath.'/'.$fname;
1877: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1878: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1879: '_'.$env{'user.domain'}.'/pending';
1880: my @parts=split(/\//,$filepath);
1881: my $fullpath = $perlvar{'lonDaemons'};
1882: for (my $i=0;$i<@parts;$i++) {
1883: $fullpath .= '/'.$parts[$i];
1884: if ((-e $fullpath)!=1) {
1885: mkdir($fullpath,0777);
1886: }
1887: }
1888: open(my $fh,'>'.$fullpath.'/'.$fname);
1889: print $fh $env{'form.'.$formname};
1890: close($fh);
1891: return $fullpath.'/'.$fname;
1892: }
1893:
1894: # Create the directory if not present
1895: $fname="$subdir/$fname";
1896: if ($coursedoc) {
1897: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1898: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1899: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1900: return &finishuserfileupload($docuname,$docudom,
1901: $formname,$fname,$parser,$allfiles,
1902: $codebase,$thumbwidth,$thumbheight);
1903: } else {
1904: $fname=$env{'form.folder'}.'/'.$fname;
1905: return &process_coursefile('uploaddoc',$docuname,$docudom,
1906: $fname,$formname,$parser,
1907: $allfiles,$codebase);
1908: }
1909: } elsif (defined($destuname)) {
1910: my $docuname=$destuname;
1911: my $docudom=$destudom;
1912: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1913: $parser,$allfiles,$codebase,
1914: $thumbwidth,$thumbheight);
1915:
1916: } else {
1917: my $docuname=$env{'user.name'};
1918: my $docudom=$env{'user.domain'};
1919: if (exists($env{'form.group'})) {
1920: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1921: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1922: }
1923: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
1924: $parser,$allfiles,$codebase,
1925: $thumbwidth,$thumbheight);
1926: }
1927: }
1928:
1929: sub finishuserfileupload {
1930: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1931: $thumbwidth,$thumbheight) = @_;
1932: my $path=$docudom.'/'.$docuname.'/';
1933: my $filepath=$perlvar{'lonDocRoot'};
1934: my ($fnamepath,$file,$fetchthumb);
1935: $file=$fname;
1936: if ($fname=~m|/|) {
1937: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1938: $path.=$fnamepath.'/';
1939: }
1940: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1941: my $count;
1942: for ($count=4;$count<=$#parts;$count++) {
1943: $filepath.="/$parts[$count]";
1944: if ((-e $filepath)!=1) {
1945: mkdir($filepath,0777);
1946: }
1947: }
1948: # Save the file
1949: {
1950: if (!open(FH,'>'.$filepath.'/'.$file)) {
1951: &logthis('Failed to create '.$filepath.'/'.$file);
1952: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1953: return '/adm/notfound.html';
1954: }
1955: if (!print FH ($env{'form.'.$formname})) {
1956: &logthis('Failed to write to '.$filepath.'/'.$file);
1957: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1958: return '/adm/notfound.html';
1959: }
1960: close(FH);
1961: }
1962: if ($parser eq 'parse') {
1963: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1964: $codebase);
1965: unless ($parse_result eq 'ok') {
1966: &logthis('Failed to parse '.$filepath.$file.
1967: ' for embedded media: '.$parse_result);
1968: }
1969: }
1970: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
1971: my $input = $filepath.'/'.$file;
1972: my $output = $filepath.'/'.'tn-'.$file;
1973: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1974: system("convert -sample $thumbsize $input $output");
1975: if (-e $filepath.'/'.'tn-'.$file) {
1976: $fetchthumb = 1;
1977: }
1978: }
1979:
1980: # Notify homeserver to grep it
1981: #
1982: my $docuhome=&homeserver($docuname,$docudom);
1983: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1984: if ($fetchresult eq 'ok') {
1985: if ($fetchthumb) {
1986: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
1987: if ($thumbresult ne 'ok') {
1988: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
1989: $docuhome.': '.$thumbresult);
1990: }
1991: }
1992: #
1993: # Return the URL to it
1994: return '/uploaded/'.$path.$file;
1995: } else {
1996: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1997: ': '.$fetchresult);
1998: return '/adm/notfound.html';
1999: }
2000: }
2001:
2002: sub extract_embedded_items {
2003: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
2004: my @state = ();
2005: my %javafiles = (
2006: codebase => '',
2007: code => '',
2008: archive => ''
2009: );
2010: my %mediafiles = (
2011: src => '',
2012: movie => '',
2013: );
2014: my $p;
2015: if ($content) {
2016: $p = HTML::LCParser->new($content);
2017: } else {
2018: $p = HTML::LCParser->new($filepath.'/'.$file);
2019: }
2020: while (my $t=$p->get_token()) {
2021: if ($t->[0] eq 'S') {
2022: my ($tagname, $attr) = ($t->[1],$t->[2]);
2023: push(@state, $tagname);
2024: if (lc($tagname) eq 'allow') {
2025: &add_filetype($allfiles,$attr->{'src'},'src');
2026: }
2027: if (lc($tagname) eq 'img') {
2028: &add_filetype($allfiles,$attr->{'src'},'src');
2029: }
2030: if (lc($tagname) eq 'a') {
2031: &add_filetype($allfiles,$attr->{'href'},'href');
2032: }
2033: if (lc($tagname) eq 'script') {
2034: if ($attr->{'archive'} =~ /\.jar$/i) {
2035: &add_filetype($allfiles,$attr->{'archive'},'archive');
2036: } else {
2037: &add_filetype($allfiles,$attr->{'src'},'src');
2038: }
2039: }
2040: if (lc($tagname) eq 'link') {
2041: if (lc($attr->{'rel'}) eq 'stylesheet') {
2042: &add_filetype($allfiles,$attr->{'href'},'href');
2043: }
2044: }
2045: if (lc($tagname) eq 'object' ||
2046: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2047: foreach my $item (keys(%javafiles)) {
2048: $javafiles{$item} = '';
2049: }
2050: }
2051: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2052: my $name = lc($attr->{'name'});
2053: foreach my $item (keys(%javafiles)) {
2054: if ($name eq $item) {
2055: $javafiles{$item} = $attr->{'value'};
2056: last;
2057: }
2058: }
2059: foreach my $item (keys(%mediafiles)) {
2060: if ($name eq $item) {
2061: &add_filetype($allfiles, $attr->{'value'}, 'value');
2062: last;
2063: }
2064: }
2065: }
2066: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2067: foreach my $item (keys(%javafiles)) {
2068: if ($attr->{$item}) {
2069: $javafiles{$item} = $attr->{$item};
2070: last;
2071: }
2072: }
2073: foreach my $item (keys(%mediafiles)) {
2074: if ($attr->{$item}) {
2075: &add_filetype($allfiles,$attr->{$item},$item);
2076: last;
2077: }
2078: }
2079: }
2080: } elsif ($t->[0] eq 'E') {
2081: my ($tagname) = ($t->[1]);
2082: if ($javafiles{'codebase'} ne '') {
2083: $javafiles{'codebase'} .= '/';
2084: }
2085: if (lc($tagname) eq 'applet' ||
2086: lc($tagname) eq 'object' ||
2087: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2088: ) {
2089: foreach my $item (keys(%javafiles)) {
2090: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2091: my $file=$javafiles{'codebase'}.$javafiles{$item};
2092: &add_filetype($allfiles,$file,$item);
2093: }
2094: }
2095: }
2096: pop @state;
2097: }
2098: }
2099: return 'ok';
2100: }
2101:
2102: sub add_filetype {
2103: my ($allfiles,$file,$type)=@_;
2104: if (exists($allfiles->{$file})) {
2105: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2106: push(@{$allfiles->{$file}}, &escape($type));
2107: }
2108: } else {
2109: @{$allfiles->{$file}} = (&escape($type));
2110: }
2111: }
2112:
2113: sub removeuploadedurl {
2114: my ($url)=@_;
2115: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2116: return &removeuserfile($uname,$udom,$fname);
2117: }
2118:
2119: sub removeuserfile {
2120: my ($docuname,$docudom,$fname)=@_;
2121: my $home=&homeserver($docuname,$docudom);
2122: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2123: if ($result eq 'ok') {
2124: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2125: my $metafile = $fname.'.meta';
2126: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2127: my $url = "/uploaded/$docudom/$docuname/$fname";
2128: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2129: my $sqlresult =
2130: &update_portfolio_table($docuname,$docudom,$file,
2131: 'portfolio_metadata',$group,
2132: 'delete');
2133: }
2134: }
2135: return $result;
2136: }
2137:
2138: sub mkdiruserfile {
2139: my ($docuname,$docudom,$dir)=@_;
2140: my $home=&homeserver($docuname,$docudom);
2141: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2142: }
2143:
2144: sub renameuserfile {
2145: my ($docuname,$docudom,$old,$new)=@_;
2146: my $home=&homeserver($docuname,$docudom);
2147: my $result = &reply("renameuserfile:$docudom:$docuname:".
2148: &escape("$old").':'.&escape("$new"),$home);
2149: if ($result eq 'ok') {
2150: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2151: my $oldmeta = $old.'.meta';
2152: my $newmeta = $new.'.meta';
2153: my $metaresult =
2154: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2155: my $url = "/uploaded/$docudom/$docuname/$old";
2156: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2157: my $sqlresult =
2158: &update_portfolio_table($docuname,$docudom,$file,
2159: 'portfolio_metadata',$group,
2160: 'delete');
2161: }
2162: }
2163: return $result;
2164: }
2165:
2166: # ------------------------------------------------------------------------- Log
2167:
2168: sub log {
2169: my ($dom,$nam,$hom,$what)=@_;
2170: return critical("log:$dom:$nam:$what",$hom);
2171: }
2172:
2173: # ------------------------------------------------------------------ Course Log
2174: #
2175: # This routine flushes several buffers of non-mission-critical nature
2176: #
2177:
2178: sub flushcourselogs {
2179: &logthis('Flushing log buffers');
2180: #
2181: # course logs
2182: # This is a log of all transactions in a course, which can be used
2183: # for data mining purposes
2184: #
2185: # It also collects the courseid database, which lists last transaction
2186: # times and course titles for all courseids
2187: #
2188: my %courseidbuffer=();
2189: foreach my $crsid (keys(%courselogs)) {
2190: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2191: &escape($courselogs{$crsid}),
2192: $coursehombuf{$crsid}) eq 'ok') {
2193: delete $courselogs{$crsid};
2194: } else {
2195: &logthis('Failed to flush log buffer for '.$crsid);
2196: if (length($courselogs{$crsid})>40000) {
2197: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2198: " exceeded maximum size, deleting.</font>");
2199: delete $courselogs{$crsid};
2200: }
2201: }
2202: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2203: 'description' => &escape($coursedescrbuf{$crsid}),
2204: 'inst_code' => &escape($courseinstcodebuf{$crsid}),
2205: 'type' => &escape($coursetypebuf{$crsid}),
2206: 'owner' => &escape($courseownerbuf{$crsid}),
2207: };
2208: }
2209: #
2210: # Write course id database (reverse lookup) to homeserver of courses
2211: # Is used in pickcourse
2212: #
2213: foreach my $crs_home (keys(%courseidbuffer)) {
2214: my $response = &courseidput(&host_domain($crs_home),
2215: $courseidbuffer{$crs_home},
2216: $crs_home,'timeonly');
2217: }
2218: #
2219: # File accesses
2220: # Writes to the dynamic metadata of resources to get hit counts, etc.
2221: #
2222: foreach my $entry (keys(%accesshash)) {
2223: if ($entry =~ /___count$/) {
2224: my ($dom,$name);
2225: ($dom,$name,undef)=
2226: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2227: if (! defined($dom) || $dom eq '' ||
2228: ! defined($name) || $name eq '') {
2229: my $cid = $env{'request.course.id'};
2230: $dom = $env{'request.'.$cid.'.domain'};
2231: $name = $env{'request.'.$cid.'.num'};
2232: }
2233: my $value = $accesshash{$entry};
2234: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2235: my %temphash=($url => $value);
2236: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2237: if ($result eq 'ok') {
2238: delete $accesshash{$entry};
2239: } elsif ($result eq 'unknown_cmd') {
2240: # Target server has old code running on it.
2241: my %temphash=($entry => $value);
2242: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2243: delete $accesshash{$entry};
2244: }
2245: }
2246: } else {
2247: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2248: my %temphash=($entry => $accesshash{$entry});
2249: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2250: delete $accesshash{$entry};
2251: }
2252: }
2253: }
2254: #
2255: # Roles
2256: # Reverse lookup of user roles for course faculty/staff and co-authorship
2257: #
2258: foreach my $entry (keys(%userrolehash)) {
2259: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2260: split(/\:/,$entry);
2261: if (&Apache::lonnet::put('nohist_userroles',
2262: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2263: $rudom,$runame) eq 'ok') {
2264: delete $userrolehash{$entry};
2265: }
2266: }
2267: #
2268: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2269: #
2270: my %domrolebuffer = ();
2271: foreach my $entry (keys %domainrolehash) {
2272: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2273: if ($domrolebuffer{$rudom}) {
2274: $domrolebuffer{$rudom}.='&'.&escape($entry).
2275: '='.&escape($domainrolehash{$entry});
2276: } else {
2277: $domrolebuffer{$rudom}.=&escape($entry).
2278: '='.&escape($domainrolehash{$entry});
2279: }
2280: delete $domainrolehash{$entry};
2281: }
2282: foreach my $dom (keys(%domrolebuffer)) {
2283: my %servers = &get_servers($dom,'library');
2284: foreach my $tryserver (keys(%servers)) {
2285: unless (&reply('domroleput:'.$dom.':'.
2286: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2287: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2288: }
2289: }
2290: }
2291: $dumpcount++;
2292: }
2293:
2294: sub courselog {
2295: my $what=shift;
2296: $what=time.':'.$what;
2297: unless ($env{'request.course.id'}) { return ''; }
2298: $coursedombuf{$env{'request.course.id'}}=
2299: $env{'course.'.$env{'request.course.id'}.'.domain'};
2300: $coursenumbuf{$env{'request.course.id'}}=
2301: $env{'course.'.$env{'request.course.id'}.'.num'};
2302: $coursehombuf{$env{'request.course.id'}}=
2303: $env{'course.'.$env{'request.course.id'}.'.home'};
2304: $coursedescrbuf{$env{'request.course.id'}}=
2305: $env{'course.'.$env{'request.course.id'}.'.description'};
2306: $courseinstcodebuf{$env{'request.course.id'}}=
2307: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2308: $courseownerbuf{$env{'request.course.id'}}=
2309: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2310: $coursetypebuf{$env{'request.course.id'}}=
2311: $env{'course.'.$env{'request.course.id'}.'.type'};
2312: if (defined $courselogs{$env{'request.course.id'}}) {
2313: $courselogs{$env{'request.course.id'}}.='&'.$what;
2314: } else {
2315: $courselogs{$env{'request.course.id'}}.=$what;
2316: }
2317: if (length($courselogs{$env{'request.course.id'}})>4048) {
2318: &flushcourselogs();
2319: }
2320: }
2321:
2322: sub courseacclog {
2323: my $fnsymb=shift;
2324: unless ($env{'request.course.id'}) { return ''; }
2325: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2326: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2327: $what.=':POST';
2328: # FIXME: Probably ought to escape things....
2329: foreach my $key (keys(%env)) {
2330: if ($key=~/^form\.(.*)/) {
2331: $what.=':'.$1.'='.$env{$key};
2332: }
2333: }
2334: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2335: # FIXME: We should not be depending on a form parameter that someone
2336: # editing lonsearchcat.pm might change in the future.
2337: if ($env{'form.phase'} eq 'course_search') {
2338: $what.= ':POST';
2339: # FIXME: Probably ought to escape things....
2340: foreach my $element ('courseexp','crsfulltext','crsrelated',
2341: 'crsdiscuss') {
2342: $what.=':'.$element.'='.$env{'form.'.$element};
2343: }
2344: }
2345: }
2346: &courselog($what);
2347: }
2348:
2349: sub countacc {
2350: my $url=&declutter(shift);
2351: return if (! defined($url) || $url eq '');
2352: unless ($env{'request.course.id'}) { return ''; }
2353: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2354: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2355: $accesshash{$key}++;
2356: }
2357:
2358: sub linklog {
2359: my ($from,$to)=@_;
2360: $from=&declutter($from);
2361: $to=&declutter($to);
2362: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2363: $accesshash{$to.'___'.$from.'___goto'}=1;
2364: }
2365:
2366: sub userrolelog {
2367: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2368: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2369: ($trole=~/^in/) || ($trole=~/^cc/) ||
2370: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2371: ($trole=~/^ta/)) {
2372: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2373: $userrolehash
2374: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2375: =$tend.':'.$tstart;
2376: }
2377: if (($env{'request.role'} =~ /dc\./) &&
2378: (($trole=~/^au/) || ($trole=~/^in/) ||
2379: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2380: ($trole=~/^cr/) || ($trole=~/^ta/))) {
2381: $userrolehash
2382: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2383: =$tend.':'.$tstart;
2384: }
2385: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2386: ($trole=~/^li/) || ($trole=~/^li/) ||
2387: ($trole=~/^au/) || ($trole=~/^dg/) ||
2388: ($trole=~/^sc/)) {
2389: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2390: $domainrolehash
2391: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2392: = $tend.':'.$tstart;
2393: }
2394: }
2395:
2396: sub get_course_adv_roles {
2397: my $cid=shift;
2398: $cid=$env{'request.course.id'} unless (defined($cid));
2399: my %coursehash=&coursedescription($cid);
2400: my %nothide=();
2401: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2402: $nothide{join(':',split(/[\@\:]/,$user))}=1;
2403: }
2404: my %returnhash=();
2405: my %dumphash=
2406: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2407: my $now=time;
2408: foreach my $entry (keys %dumphash) {
2409: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2410: if (($tstart) && ($tstart<0)) { next; }
2411: if (($tend) && ($tend<$now)) { next; }
2412: if (($tstart) && ($now<$tstart)) { next; }
2413: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2414: if ($username eq '' || $domain eq '') { next; }
2415: if ((&privileged($username,$domain)) &&
2416: (!$nothide{$username.':'.$domain})) { next; }
2417: if ($role eq 'cr') { next; }
2418: my $key=&plaintext($role);
2419: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
2420: if ($returnhash{$key}) {
2421: $returnhash{$key}.=','.$username.':'.$domain;
2422: } else {
2423: $returnhash{$key}=$username.':'.$domain;
2424: }
2425: }
2426: return %returnhash;
2427: }
2428:
2429: sub get_my_roles {
2430: my ($uname,$udom,$context,$types,$roles,$roledoms)=@_;
2431: unless (defined($uname)) { $uname=$env{'user.name'}; }
2432: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2433: my %dumphash;
2434: if ($context eq 'userroles') {
2435: %dumphash = &dump('roles',$udom,$uname);
2436: } else {
2437: %dumphash=
2438: &dump('nohist_userroles',$udom,$uname);
2439: }
2440: my %returnhash=();
2441: my $now=time;
2442: foreach my $entry (keys(%dumphash)) {
2443: my ($role,$tend,$tstart);
2444: if ($context eq 'userroles') {
2445: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2446: } else {
2447: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2448: }
2449: if (($tstart) && ($tstart<0)) { next; }
2450: my $status = 'active';
2451: if (($tend) && ($tend<$now)) {
2452: $status = 'previous';
2453: }
2454: if (($tstart) && ($now<$tstart)) {
2455: $status = 'future';
2456: }
2457: if (ref($types) eq 'ARRAY') {
2458: if (!grep(/^\Q$status\E$/,@{$types})) {
2459: next;
2460: }
2461: } else {
2462: if ($status ne 'active') {
2463: next;
2464: }
2465: }
2466: my ($rolecode,$username,$domain,$section,$area);
2467: if ($context eq 'userroles') {
2468: ($area,$rolecode) = split(/_/,$entry);
2469: (undef,$domain,$username,$section) = split(/\//,$area);
2470: } else {
2471: ($role,$username,$domain,$section) = split(/\:/,$entry);
2472: }
2473: if (ref($roledoms) eq 'ARRAY') {
2474: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2475: next;
2476: }
2477: }
2478: if (ref($roles) eq 'ARRAY') {
2479: if (!grep(/^\Q$role\E$/,@{$roles})) {
2480: if ($role =~ /^cr\//) {
2481: if (!grep(/^cr$/,@{$roles})) {
2482: next;
2483: }
2484: } else {
2485: next;
2486: }
2487: }
2488: }
2489: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2490: }
2491: return %returnhash;
2492: }
2493:
2494: # ----------------------------------------------------- Frontpage Announcements
2495: #
2496: #
2497:
2498: sub postannounce {
2499: my ($server,$text)=@_;
2500: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2501: unless ($text=~/\w/) { $text=''; }
2502: return &reply('setannounce:'.&escape($text),$server);
2503: }
2504:
2505: sub getannounce {
2506:
2507: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2508: my $announcement='';
2509: while (my $line = <$fh>) { $announcement .= $line; }
2510: close($fh);
2511: if ($announcement=~/\w/) {
2512: return
2513: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2514: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2515: } else {
2516: return '';
2517: }
2518: } else {
2519: return '';
2520: }
2521: }
2522:
2523: # ---------------------------------------------------------- Course ID routines
2524: # Deal with domain's nohist_courseid.db files
2525: #
2526:
2527: sub courseidput {
2528: my ($domain,$storehash,$coursehome,$caller) = @_;
2529: my $outcome;
2530: if ($caller eq 'timeonly') {
2531: my $cids = '';
2532: foreach my $item (keys(%$storehash)) {
2533: $cids.=&escape($item).'&';
2534: }
2535: $cids=~s/\&$//;
2536: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
2537: $coursehome);
2538: } else {
2539: my $items = '';
2540: foreach my $item (keys(%$storehash)) {
2541: $items.= &escape($item).'='.
2542: &freeze_escape($$storehash{$item}).'&';
2543: }
2544: $items=~s/\&$//;
2545: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
2546: $coursehome);
2547: }
2548: if ($outcome eq 'unknown_cmd') {
2549: my $what;
2550: foreach my $cid (keys(%$storehash)) {
2551: $what .= &escape($cid).'=';
2552: foreach my $item ('description','inst_code','owner','type') {
2553: $what .= &escape($storehash->{$item}).':';
2554: }
2555: $what =~ s/\:$/&/;
2556: }
2557: $what =~ s/\&$//;
2558: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2559: } else {
2560: return $outcome;
2561: }
2562: }
2563:
2564: sub courseiddump {
2565: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
2566: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2567: my $as_hash = 1;
2568: my %returnhash;
2569: if (!$domfilter) { $domfilter=''; }
2570: my %libserv = &all_library();
2571: foreach my $tryserver (keys(%libserv)) {
2572: if ( ( $hostidflag == 1
2573: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
2574: || (!defined($hostidflag)) ) {
2575:
2576: if (($domfilter eq '') ||
2577: (&host_domain($tryserver) eq $domfilter)) {
2578: my $rep =
2579: &reply('courseiddump:'.&host_domain($tryserver).':'.
2580: $sincefilter.':'.&escape($descfilter).':'.
2581: &escape($instcodefilter).':'.&escape($ownerfilter).
2582: ':'.&escape($coursefilter).':'.&escape($typefilter).
2583: ':'.&escape($regexp_ok).':'.$as_hash,$tryserver);
2584: my @pairs=split(/\&/,$rep);
2585: foreach my $item (@pairs) {
2586: my ($key,$value)=split(/\=/,$item,2);
2587: $key = &unescape($key);
2588: next if ($key =~ /^error: 2 /);
2589: my $result = &thaw_unescape($value);
2590: if (ref($result) eq 'HASH') {
2591: $returnhash{$key}=$result;
2592: } else {
2593: my @responses = split(/:/,$value);
2594: my @items = ('description','inst_code','owner','type');
2595: for (my $i=0; $i<@responses; $i++) {
2596: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
2597: }
2598: }
2599: }
2600: }
2601: }
2602: }
2603: return %returnhash;
2604: }
2605:
2606: # ---------------------------------------------------------- DC e-mail
2607:
2608: sub dcmailput {
2609: my ($domain,$msgid,$message,$server)=@_;
2610: my $status = &Apache::lonnet::critical(
2611: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2612: &escape($message),$server);
2613: return $status;
2614: }
2615:
2616: sub dcmaildump {
2617: my ($dom,$startdate,$enddate,$senders) = @_;
2618: my %returnhash=();
2619:
2620: if (defined(&domain($dom,'primary'))) {
2621: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2622: &escape($enddate).':';
2623: my @esc_senders=map { &escape($_)} @$senders;
2624: $cmd.=&escape(join('&',@esc_senders));
2625: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
2626: my ($key,$value) = split(/\=/,$line,2);
2627: if (($key) && ($value)) {
2628: $returnhash{&unescape($key)} = &unescape($value);
2629: }
2630: }
2631: }
2632: return %returnhash;
2633: }
2634: # ---------------------------------------------------------- Domain roles
2635:
2636: sub get_domain_roles {
2637: my ($dom,$roles,$startdate,$enddate)=@_;
2638: if (undef($startdate) || $startdate eq '') {
2639: $startdate = '.';
2640: }
2641: if (undef($enddate) || $enddate eq '') {
2642: $enddate = '.';
2643: }
2644: my $rolelist;
2645: if (ref($roles) eq 'ARRAY') {
2646: $rolelist = join(':',@{$roles});
2647: }
2648: my %personnel = ();
2649:
2650: my %servers = &get_servers($dom,'library');
2651: foreach my $tryserver (keys(%servers)) {
2652: %{$personnel{$tryserver}}=();
2653: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
2654: &escape($startdate).':'.
2655: &escape($enddate).':'.
2656: &escape($rolelist), $tryserver))) {
2657: my ($key,$value) = split(/\=/,$line,2);
2658: if (($key) && ($value)) {
2659: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2660: }
2661: }
2662: }
2663: return %personnel;
2664: }
2665:
2666: # ----------------------------------------------------------- Check out an item
2667:
2668: sub get_first_access {
2669: my ($type,$argsymb)=@_;
2670: my ($symb,$courseid,$udom,$uname)=&whichuser();
2671: if ($argsymb) { $symb=$argsymb; }
2672: my ($map,$id,$res)=&decode_symb($symb);
2673: if ($type eq 'course') {
2674: $res='course';
2675: } elsif ($type eq 'map') {
2676: $res=&symbread($map);
2677: } else {
2678: $res=$symb;
2679: }
2680: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2681: return $times{"$courseid\0$res"};
2682: }
2683:
2684: sub set_first_access {
2685: my ($type)=@_;
2686: my ($symb,$courseid,$udom,$uname)=&whichuser();
2687: my ($map,$id,$res)=&decode_symb($symb);
2688: if ($type eq 'course') {
2689: $res='course';
2690: } elsif ($type eq 'map') {
2691: $res=&symbread($map);
2692: } else {
2693: $res=$symb;
2694: }
2695: my $firstaccess=&get_first_access($type,$symb);
2696: if (!$firstaccess) {
2697: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2698: }
2699: return 'already_set';
2700: }
2701:
2702: sub checkout {
2703: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2704: my $now=time;
2705: my $lonhost=$perlvar{'lonHostID'};
2706: my $infostr=&escape(
2707: 'CHECKOUTTOKEN&'.
2708: $tuname.'&'.
2709: $tudom.'&'.
2710: $tcrsid.'&'.
2711: $symb.'&'.
2712: $now.'&'.$ENV{'REMOTE_ADDR'});
2713: my $token=&reply('tmpput:'.$infostr,$lonhost);
2714: if ($token=~/^error\:/) {
2715: &logthis("<font color=\"blue\">WARNING: ".
2716: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2717: "</font>");
2718: return '';
2719: }
2720:
2721: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2722: $token=~tr/a-z/A-Z/;
2723:
2724: my %infohash=('resource.0.outtoken' => $token,
2725: 'resource.0.checkouttime' => $now,
2726: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2727:
2728: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2729: return '';
2730: } else {
2731: &logthis("<font color=\"blue\">WARNING: ".
2732: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2733: "</font>");
2734: }
2735:
2736: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2737: &escape('Checkout '.$infostr.' - '.
2738: $token)) ne 'ok') {
2739: return '';
2740: } else {
2741: &logthis("<font color=\"blue\">WARNING: ".
2742: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2743: "</font>");
2744: }
2745: return $token;
2746: }
2747:
2748: # ------------------------------------------------------------ Check in an item
2749:
2750: sub checkin {
2751: my $token=shift;
2752: my $now=time;
2753: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2754: $lonhost=~tr/A-Z/a-z/;
2755: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
2756: $dtoken=~s/\W/\_/g;
2757: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2758: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2759:
2760: unless (($tuname) && ($tudom)) {
2761: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2762: return '';
2763: }
2764:
2765: unless (&allowed('mgr',$tcrsid)) {
2766: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2767: $env{'user.name'}.' - '.$env{'user.domain'});
2768: return '';
2769: }
2770:
2771: my %infohash=('resource.0.intoken' => $token,
2772: 'resource.0.checkintime' => $now,
2773: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2774:
2775: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2776: return '';
2777: }
2778:
2779: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2780: &escape('Checkin - '.$token)) ne 'ok') {
2781: return '';
2782: }
2783:
2784: return ($symb,$tuname,$tudom,$tcrsid);
2785: }
2786:
2787: # --------------------------------------------- Set Expire Date for Spreadsheet
2788:
2789: sub expirespread {
2790: my ($uname,$udom,$stype,$usymb)=@_;
2791: my $cid=$env{'request.course.id'};
2792: if ($cid) {
2793: my $now=time;
2794: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2795: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2796: $env{'course.'.$cid.'.num'}.
2797: ':nohist_expirationdates:'.
2798: &escape($key).'='.$now,
2799: $env{'course.'.$cid.'.home'})
2800: }
2801: return 'ok';
2802: }
2803:
2804: # ----------------------------------------------------- Devalidate Spreadsheets
2805:
2806: sub devalidate {
2807: my ($symb,$uname,$udom)=@_;
2808: my $cid=$env{'request.course.id'};
2809: if ($cid) {
2810: # delete the stored spreadsheets for
2811: # - the student level sheet of this user in course's homespace
2812: # - the assessment level sheet for this resource
2813: # for this user in user's homespace
2814: # - current conditional state info
2815: my $key=$uname.':'.$udom.':';
2816: my $status=
2817: &del('nohist_calculatedsheets',
2818: [$key.'studentcalc:'],
2819: $env{'course.'.$cid.'.domain'},
2820: $env{'course.'.$cid.'.num'})
2821: .' '.
2822: &del('nohist_calculatedsheets_'.$cid,
2823: [$key.'assesscalc:'.$symb],$udom,$uname);
2824: unless ($status eq 'ok ok') {
2825: &logthis('Could not devalidate spreadsheet '.
2826: $uname.' at '.$udom.' for '.
2827: $symb.': '.$status);
2828: }
2829: &delenv('user.state.'.$cid);
2830: }
2831: }
2832:
2833: sub get_scalar {
2834: my ($string,$end) = @_;
2835: my $value;
2836: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2837: $value = $1;
2838: } elsif ($$string =~ s/^([^&]*?)&//) {
2839: $value = $1;
2840: }
2841: return &unescape($value);
2842: }
2843:
2844: sub array2str {
2845: my (@array) = @_;
2846: my $result=&arrayref2str(\@array);
2847: $result=~s/^__ARRAY_REF__//;
2848: $result=~s/__END_ARRAY_REF__$//;
2849: return $result;
2850: }
2851:
2852: sub arrayref2str {
2853: my ($arrayref) = @_;
2854: my $result='__ARRAY_REF__';
2855: foreach my $elem (@$arrayref) {
2856: if(ref($elem) eq 'ARRAY') {
2857: $result.=&arrayref2str($elem).'&';
2858: } elsif(ref($elem) eq 'HASH') {
2859: $result.=&hashref2str($elem).'&';
2860: } elsif(ref($elem)) {
2861: #print("Got a ref of ".(ref($elem))." skipping.");
2862: } else {
2863: $result.=&escape($elem).'&';
2864: }
2865: }
2866: $result=~s/\&$//;
2867: $result .= '__END_ARRAY_REF__';
2868: return $result;
2869: }
2870:
2871: sub hash2str {
2872: my (%hash) = @_;
2873: my $result=&hashref2str(\%hash);
2874: $result=~s/^__HASH_REF__//;
2875: $result=~s/__END_HASH_REF__$//;
2876: return $result;
2877: }
2878:
2879: sub hashref2str {
2880: my ($hashref)=@_;
2881: my $result='__HASH_REF__';
2882: foreach my $key (sort(keys(%$hashref))) {
2883: if (ref($key) eq 'ARRAY') {
2884: $result.=&arrayref2str($key).'=';
2885: } elsif (ref($key) eq 'HASH') {
2886: $result.=&hashref2str($key).'=';
2887: } elsif (ref($key)) {
2888: $result.='=';
2889: #print("Got a ref of ".(ref($key))." skipping.");
2890: } else {
2891: if ($key) {$result.=&escape($key).'=';} else { last; }
2892: }
2893:
2894: if(ref($hashref->{$key}) eq 'ARRAY') {
2895: $result.=&arrayref2str($hashref->{$key}).'&';
2896: } elsif(ref($hashref->{$key}) eq 'HASH') {
2897: $result.=&hashref2str($hashref->{$key}).'&';
2898: } elsif(ref($hashref->{$key})) {
2899: $result.='&';
2900: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2901: } else {
2902: $result.=&escape($hashref->{$key}).'&';
2903: }
2904: }
2905: $result=~s/\&$//;
2906: $result .= '__END_HASH_REF__';
2907: return $result;
2908: }
2909:
2910: sub str2hash {
2911: my ($string)=@_;
2912: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2913: return %$hash;
2914: }
2915:
2916: sub str2hashref {
2917: my ($string) = @_;
2918:
2919: my %hash;
2920:
2921: if($string !~ /^__HASH_REF__/) {
2922: if (! ($string eq '' || !defined($string))) {
2923: $hash{'error'}='Not hash reference';
2924: }
2925: return (\%hash, $string);
2926: }
2927:
2928: $string =~ s/^__HASH_REF__//;
2929:
2930: while($string !~ /^__END_HASH_REF__/) {
2931: #key
2932: my $key='';
2933: if($string =~ /^__HASH_REF__/) {
2934: ($key, $string)=&str2hashref($string);
2935: if(defined($key->{'error'})) {
2936: $hash{'error'}='Bad data';
2937: return (\%hash, $string);
2938: }
2939: } elsif($string =~ /^__ARRAY_REF__/) {
2940: ($key, $string)=&str2arrayref($string);
2941: if($key->[0] eq 'Array reference error') {
2942: $hash{'error'}='Bad data';
2943: return (\%hash, $string);
2944: }
2945: } else {
2946: $string =~ s/^(.*?)=//;
2947: $key=&unescape($1);
2948: }
2949: $string =~ s/^=//;
2950:
2951: #value
2952: my $value='';
2953: if($string =~ /^__HASH_REF__/) {
2954: ($value, $string)=&str2hashref($string);
2955: if(defined($value->{'error'})) {
2956: $hash{'error'}='Bad data';
2957: return (\%hash, $string);
2958: }
2959: } elsif($string =~ /^__ARRAY_REF__/) {
2960: ($value, $string)=&str2arrayref($string);
2961: if($value->[0] eq 'Array reference error') {
2962: $hash{'error'}='Bad data';
2963: return (\%hash, $string);
2964: }
2965: } else {
2966: $value=&get_scalar(\$string,'__END_HASH_REF__');
2967: }
2968: $string =~ s/^&//;
2969:
2970: $hash{$key}=$value;
2971: }
2972:
2973: $string =~ s/^__END_HASH_REF__//;
2974:
2975: return (\%hash, $string);
2976: }
2977:
2978: sub str2array {
2979: my ($string)=@_;
2980: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2981: return @$array;
2982: }
2983:
2984: sub str2arrayref {
2985: my ($string) = @_;
2986: my @array;
2987:
2988: if($string !~ /^__ARRAY_REF__/) {
2989: if (! ($string eq '' || !defined($string))) {
2990: $array[0]='Array reference error';
2991: }
2992: return (\@array, $string);
2993: }
2994:
2995: $string =~ s/^__ARRAY_REF__//;
2996:
2997: while($string !~ /^__END_ARRAY_REF__/) {
2998: my $value='';
2999: if($string =~ /^__HASH_REF__/) {
3000: ($value, $string)=&str2hashref($string);
3001: if(defined($value->{'error'})) {
3002: $array[0] ='Array reference error';
3003: return (\@array, $string);
3004: }
3005: } elsif($string =~ /^__ARRAY_REF__/) {
3006: ($value, $string)=&str2arrayref($string);
3007: if($value->[0] eq 'Array reference error') {
3008: $array[0] ='Array reference error';
3009: return (\@array, $string);
3010: }
3011: } else {
3012: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3013: }
3014: $string =~ s/^&//;
3015:
3016: push(@array, $value);
3017: }
3018:
3019: $string =~ s/^__END_ARRAY_REF__//;
3020:
3021: return (\@array, $string);
3022: }
3023:
3024: # -------------------------------------------------------------------Temp Store
3025:
3026: sub tmpreset {
3027: my ($symb,$namespace,$domain,$stuname) = @_;
3028: if (!$symb) {
3029: $symb=&symbread();
3030: if (!$symb) { $symb= $env{'request.url'}; }
3031: }
3032: $symb=escape($symb);
3033:
3034: if (!$namespace) { $namespace=$env{'request.state'}; }
3035: $namespace=~s/\//\_/g;
3036: $namespace=~s/\W//g;
3037:
3038: if (!$domain) { $domain=$env{'user.domain'}; }
3039: if (!$stuname) { $stuname=$env{'user.name'}; }
3040: if ($domain eq 'public' && $stuname eq 'public') {
3041: $stuname=$ENV{'REMOTE_ADDR'};
3042: }
3043: my $path=$perlvar{'lonDaemons'}.'/tmp';
3044: my %hash;
3045: if (tie(%hash,'GDBM_File',
3046: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3047: &GDBM_WRCREAT(),0640)) {
3048: foreach my $key (keys %hash) {
3049: if ($key=~ /:$symb/) {
3050: delete($hash{$key});
3051: }
3052: }
3053: }
3054: }
3055:
3056: sub tmpstore {
3057: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3058:
3059: if (!$symb) {
3060: $symb=&symbread();
3061: if (!$symb) { $symb= $env{'request.url'}; }
3062: }
3063: $symb=escape($symb);
3064:
3065: if (!$namespace) {
3066: # I don't think we would ever want to store this for a course.
3067: # it seems this will only be used if we don't have a course.
3068: #$namespace=$env{'request.course.id'};
3069: #if (!$namespace) {
3070: $namespace=$env{'request.state'};
3071: #}
3072: }
3073: $namespace=~s/\//\_/g;
3074: $namespace=~s/\W//g;
3075: if (!$domain) { $domain=$env{'user.domain'}; }
3076: if (!$stuname) { $stuname=$env{'user.name'}; }
3077: if ($domain eq 'public' && $stuname eq 'public') {
3078: $stuname=$ENV{'REMOTE_ADDR'};
3079: }
3080: my $now=time;
3081: my %hash;
3082: my $path=$perlvar{'lonDaemons'}.'/tmp';
3083: if (tie(%hash,'GDBM_File',
3084: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3085: &GDBM_WRCREAT(),0640)) {
3086: $hash{"version:$symb"}++;
3087: my $version=$hash{"version:$symb"};
3088: my $allkeys='';
3089: foreach my $key (keys(%$storehash)) {
3090: $allkeys.=$key.':';
3091: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3092: }
3093: $hash{"$version:$symb:timestamp"}=$now;
3094: $allkeys.='timestamp';
3095: $hash{"$version:keys:$symb"}=$allkeys;
3096: if (untie(%hash)) {
3097: return 'ok';
3098: } else {
3099: return "error:$!";
3100: }
3101: } else {
3102: return "error:$!";
3103: }
3104: }
3105:
3106: # -----------------------------------------------------------------Temp Restore
3107:
3108: sub tmprestore {
3109: my ($symb,$namespace,$domain,$stuname) = @_;
3110:
3111: if (!$symb) {
3112: $symb=&symbread();
3113: if (!$symb) { $symb= $env{'request.url'}; }
3114: }
3115: $symb=escape($symb);
3116:
3117: if (!$namespace) { $namespace=$env{'request.state'}; }
3118:
3119: if (!$domain) { $domain=$env{'user.domain'}; }
3120: if (!$stuname) { $stuname=$env{'user.name'}; }
3121: if ($domain eq 'public' && $stuname eq 'public') {
3122: $stuname=$ENV{'REMOTE_ADDR'};
3123: }
3124: my %returnhash;
3125: $namespace=~s/\//\_/g;
3126: $namespace=~s/\W//g;
3127: my %hash;
3128: my $path=$perlvar{'lonDaemons'}.'/tmp';
3129: if (tie(%hash,'GDBM_File',
3130: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3131: &GDBM_READER(),0640)) {
3132: my $version=$hash{"version:$symb"};
3133: $returnhash{'version'}=$version;
3134: my $scope;
3135: for ($scope=1;$scope<=$version;$scope++) {
3136: my $vkeys=$hash{"$scope:keys:$symb"};
3137: my @keys=split(/:/,$vkeys);
3138: my $key;
3139: $returnhash{"$scope:keys"}=$vkeys;
3140: foreach $key (@keys) {
3141: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3142: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3143: }
3144: }
3145: if (!(untie(%hash))) {
3146: return "error:$!";
3147: }
3148: } else {
3149: return "error:$!";
3150: }
3151: return %returnhash;
3152: }
3153:
3154: # ----------------------------------------------------------------------- Store
3155:
3156: sub store {
3157: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3158: my $home='';
3159:
3160: if ($stuname) { $home=&homeserver($stuname,$domain); }
3161:
3162: $symb=&symbclean($symb);
3163: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3164:
3165: if (!$domain) { $domain=$env{'user.domain'}; }
3166: if (!$stuname) { $stuname=$env{'user.name'}; }
3167:
3168: &devalidate($symb,$stuname,$domain);
3169:
3170: $symb=escape($symb);
3171: if (!$namespace) {
3172: unless ($namespace=$env{'request.course.id'}) {
3173: return '';
3174: }
3175: }
3176: if (!$home) { $home=$env{'user.home'}; }
3177:
3178: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3179: $$storehash{'host'}=$perlvar{'lonHostID'};
3180:
3181: my $namevalue='';
3182: foreach my $key (keys(%$storehash)) {
3183: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3184: }
3185: $namevalue=~s/\&$//;
3186: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3187: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3188: }
3189:
3190: # -------------------------------------------------------------- Critical Store
3191:
3192: sub cstore {
3193: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3194: my $home='';
3195:
3196: if ($stuname) { $home=&homeserver($stuname,$domain); }
3197:
3198: $symb=&symbclean($symb);
3199: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3200:
3201: if (!$domain) { $domain=$env{'user.domain'}; }
3202: if (!$stuname) { $stuname=$env{'user.name'}; }
3203:
3204: &devalidate($symb,$stuname,$domain);
3205:
3206: $symb=escape($symb);
3207: if (!$namespace) {
3208: unless ($namespace=$env{'request.course.id'}) {
3209: return '';
3210: }
3211: }
3212: if (!$home) { $home=$env{'user.home'}; }
3213:
3214: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3215: $$storehash{'host'}=$perlvar{'lonHostID'};
3216:
3217: my $namevalue='';
3218: foreach my $key (keys(%$storehash)) {
3219: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3220: }
3221: $namevalue=~s/\&$//;
3222: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3223: return critical
3224: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3225: }
3226:
3227: # --------------------------------------------------------------------- Restore
3228:
3229: sub restore {
3230: my ($symb,$namespace,$domain,$stuname) = @_;
3231: my $home='';
3232:
3233: if ($stuname) { $home=&homeserver($stuname,$domain); }
3234:
3235: if (!$symb) {
3236: unless ($symb=escape(&symbread())) { return ''; }
3237: } else {
3238: $symb=&escape(&symbclean($symb));
3239: }
3240: if (!$namespace) {
3241: unless ($namespace=$env{'request.course.id'}) {
3242: return '';
3243: }
3244: }
3245: if (!$domain) { $domain=$env{'user.domain'}; }
3246: if (!$stuname) { $stuname=$env{'user.name'}; }
3247: if (!$home) { $home=$env{'user.home'}; }
3248: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3249:
3250: my %returnhash=();
3251: foreach my $line (split(/\&/,$answer)) {
3252: my ($name,$value)=split(/\=/,$line);
3253: $returnhash{&unescape($name)}=&thaw_unescape($value);
3254: }
3255: my $version;
3256: for ($version=1;$version<=$returnhash{'version'};$version++) {
3257: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3258: $returnhash{$item}=$returnhash{$version.':'.$item};
3259: }
3260: }
3261: return %returnhash;
3262: }
3263:
3264: # ---------------------------------------------------------- Course Description
3265:
3266: sub coursedescription {
3267: my ($courseid,$args)=@_;
3268: $courseid=~s/^\///;
3269: $courseid=~s/\_/\//g;
3270: my ($cdomain,$cnum)=split(/\//,$courseid);
3271: my $chome=&homeserver($cnum,$cdomain);
3272: my $normalid=$cdomain.'_'.$cnum;
3273: # need to always cache even if we get errors otherwise we keep
3274: # trying and trying and trying to get the course description.
3275: my %envhash=();
3276: my %returnhash=();
3277:
3278: my $expiretime=600;
3279: if ($env{'request.course.id'} eq $normalid) {
3280: $expiretime=120;
3281: }
3282:
3283: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3284: if (!$args->{'freshen_cache'}
3285: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3286: foreach my $key (keys(%env)) {
3287: next if ($key !~ /^\Q$prefix\E(.*)/);
3288: my ($setting) = $1;
3289: $returnhash{$setting} = $env{$key};
3290: }
3291: return %returnhash;
3292: }
3293:
3294: # get the data agin
3295: if (!$args->{'one_time'}) {
3296: $envhash{'course.'.$normalid.'.last_cache'}=time;
3297: }
3298:
3299: if ($chome ne 'no_host') {
3300: %returnhash=&dump('environment',$cdomain,$cnum);
3301: if (!exists($returnhash{'con_lost'})) {
3302: $returnhash{'home'}= $chome;
3303: $returnhash{'domain'} = $cdomain;
3304: $returnhash{'num'} = $cnum;
3305: if (!defined($returnhash{'type'})) {
3306: $returnhash{'type'} = 'Course';
3307: }
3308: while (my ($name,$value) = each %returnhash) {
3309: $envhash{'course.'.$normalid.'.'.$name}=$value;
3310: }
3311: $returnhash{'url'}=&clutter($returnhash{'url'});
3312: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3313: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3314: $envhash{'course.'.$normalid.'.home'}=$chome;
3315: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3316: $envhash{'course.'.$normalid.'.num'}=$cnum;
3317: }
3318: }
3319: if (!$args->{'one_time'}) {
3320: &appenv(%envhash);
3321: }
3322: return %returnhash;
3323: }
3324:
3325: # -------------------------------------------------See if a user is privileged
3326:
3327: sub privileged {
3328: my ($username,$domain)=@_;
3329: my $rolesdump=&reply("dump:$domain:$username:roles",
3330: &homeserver($username,$domain));
3331: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
3332: my $now=time;
3333: if ($rolesdump ne '') {
3334: foreach my $entry (split(/&/,$rolesdump)) {
3335: if ($entry!~/^rolesdef_/) {
3336: my ($area,$role)=split(/=/,$entry);
3337: $area=~s/\_\w\w$//;
3338: my ($trole,$tend,$tstart)=split(/_/,$role);
3339: if (($trole eq 'dc') || ($trole eq 'su')) {
3340: my $active=1;
3341: if ($tend) {
3342: if ($tend<$now) { $active=0; }
3343: }
3344: if ($tstart) {
3345: if ($tstart>$now) { $active=0; }
3346: }
3347: if ($active) { return 1; }
3348: }
3349: }
3350: }
3351: }
3352: return 0;
3353: }
3354:
3355: # -------------------------------------------------------- Get user privileges
3356:
3357: sub rolesinit {
3358: my ($domain,$username,$authhost)=@_;
3359: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3360: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
3361: my %allroles=();
3362: my %allgroups=();
3363: my $now=time;
3364: my %userroles = ('user.login.time' => $now);
3365: my $group_privs;
3366:
3367: if ($rolesdump ne '') {
3368: foreach my $entry (split(/&/,$rolesdump)) {
3369: if ($entry!~/^rolesdef_/) {
3370: my ($area,$role)=split(/=/,$entry);
3371: $area=~s/\_\w\w$//;
3372: my ($trole,$tend,$tstart,$group_privs);
3373: if ($role=~/^cr/) {
3374: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3375: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3376: ($tend,$tstart)=split('_',$trest);
3377: } else {
3378: $trole=$role;
3379: }
3380: } elsif ($role =~ m|^gr/|) {
3381: ($trole,$tend,$tstart) = split(/_/,$role);
3382: ($trole,$group_privs) = split(/\//,$trole);
3383: $group_privs = &unescape($group_privs);
3384: } else {
3385: ($trole,$tend,$tstart)=split(/_/,$role);
3386: }
3387: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3388: $username);
3389: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3390: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3391: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3392: if (($area ne '') && ($trole ne '')) {
3393: my $spec=$trole.'.'.$area;
3394: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3395: if ($trole =~ /^cr\//) {
3396: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3397: } elsif ($trole eq 'gr') {
3398: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3399: } else {
3400: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3401: }
3402: }
3403: }
3404: }
3405: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3406: $userroles{'user.adv'} = $adv;
3407: $userroles{'user.author'} = $author;
3408: $env{'user.adv'}=$adv;
3409: }
3410: return \%userroles;
3411: }
3412:
3413: sub set_arearole {
3414: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3415: # log the associated role with the area
3416: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3417: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3418: }
3419:
3420: sub custom_roleprivs {
3421: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3422: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3423: my $homsvr=homeserver($rauthor,$rdomain);
3424: if (&hostname($homsvr) ne '') {
3425: my ($rdummy,$roledef)=
3426: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3427: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3428: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3429: if (defined($syspriv)) {
3430: $$allroles{'cm./'}.=':'.$syspriv;
3431: $$allroles{$spec.'./'}.=':'.$syspriv;
3432: }
3433: if ($tdomain ne '') {
3434: if (defined($dompriv)) {
3435: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3436: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3437: }
3438: if (($trest ne '') && (defined($coursepriv))) {
3439: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3440: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3441: }
3442: }
3443: }
3444: }
3445: }
3446:
3447: sub group_roleprivs {
3448: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3449: my $access = 1;
3450: my $now = time;
3451: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3452: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3453: if ($access) {
3454: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3455: $$allgroups{$course}{$group} .=':'.$group_privs;
3456: }
3457: }
3458:
3459: sub standard_roleprivs {
3460: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3461: if (defined($pr{$trole.':s'})) {
3462: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3463: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3464: }
3465: if ($tdomain ne '') {
3466: if (defined($pr{$trole.':d'})) {
3467: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3468: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3469: }
3470: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3471: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3472: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3473: }
3474: }
3475: }
3476:
3477: sub set_userprivs {
3478: my ($userroles,$allroles,$allgroups) = @_;
3479: my $author=0;
3480: my $adv=0;
3481: my %grouproles = ();
3482: if (keys(%{$allgroups}) > 0) {
3483: foreach my $role (keys %{$allroles}) {
3484: my ($trole,$area,$sec,$extendedarea);
3485: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3486: $trole = $1;
3487: $area = $2;
3488: $sec = $3;
3489: $extendedarea = $area.$sec;
3490: if (exists($$allgroups{$area})) {
3491: foreach my $group (keys(%{$$allgroups{$area}})) {
3492: my $spec = $trole.'.'.$extendedarea;
3493: $grouproles{$spec.'.'.$area.'/'.$group} =
3494: $$allgroups{$area}{$group};
3495: }
3496: }
3497: }
3498: }
3499: }
3500: foreach my $group (keys(%grouproles)) {
3501: $$allroles{$group} = $grouproles{$group};
3502: }
3503: foreach my $role (keys(%{$allroles})) {
3504: my %thesepriv;
3505: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
3506: foreach my $item (split(/:/,$$allroles{$role})) {
3507: if ($item ne '') {
3508: my ($privilege,$restrictions)=split(/&/,$item);
3509: if ($restrictions eq '') {
3510: $thesepriv{$privilege}='F';
3511: } elsif ($thesepriv{$privilege} ne 'F') {
3512: $thesepriv{$privilege}.=$restrictions;
3513: }
3514: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3515: }
3516: }
3517: my $thesestr='';
3518: foreach my $priv (keys(%thesepriv)) {
3519: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3520: }
3521: $userroles->{'user.priv.'.$role} = $thesestr;
3522: }
3523: return ($author,$adv);
3524: }
3525:
3526: # --------------------------------------------------------------- get interface
3527:
3528: sub get {
3529: my ($namespace,$storearr,$udomain,$uname)=@_;
3530: my $items='';
3531: foreach my $item (@$storearr) {
3532: $items.=&escape($item).'&';
3533: }
3534: $items=~s/\&$//;
3535: if (!$udomain) { $udomain=$env{'user.domain'}; }
3536: if (!$uname) { $uname=$env{'user.name'}; }
3537: my $uhome=&homeserver($uname,$udomain);
3538:
3539: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
3540: my @pairs=split(/\&/,$rep);
3541: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
3542: return @pairs;
3543: }
3544: my %returnhash=();
3545: my $i=0;
3546: foreach my $item (@$storearr) {
3547: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3548: $i++;
3549: }
3550: return %returnhash;
3551: }
3552:
3553: # --------------------------------------------------------------- del interface
3554:
3555: sub del {
3556: my ($namespace,$storearr,$udomain,$uname)=@_;
3557: my $items='';
3558: foreach my $item (@$storearr) {
3559: $items.=&escape($item).'&';
3560: }
3561: $items=~s/\&$//;
3562: if (!$udomain) { $udomain=$env{'user.domain'}; }
3563: if (!$uname) { $uname=$env{'user.name'}; }
3564: my $uhome=&homeserver($uname,$udomain);
3565:
3566: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3567: }
3568:
3569: # -------------------------------------------------------------- dump interface
3570:
3571: sub dump {
3572: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3573: if (!$udomain) { $udomain=$env{'user.domain'}; }
3574: if (!$uname) { $uname=$env{'user.name'}; }
3575: my $uhome=&homeserver($uname,$udomain);
3576: if ($regexp) {
3577: $regexp=&escape($regexp);
3578: } else {
3579: $regexp='.';
3580: }
3581: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3582: my @pairs=split(/\&/,$rep);
3583: my %returnhash=();
3584: foreach my $item (@pairs) {
3585: my ($key,$value)=split(/=/,$item,2);
3586: $key = &unescape($key);
3587: next if ($key =~ /^error: 2 /);
3588: $returnhash{$key}=&thaw_unescape($value);
3589: }
3590: return %returnhash;
3591: }
3592:
3593: # --------------------------------------------------------- dumpstore interface
3594:
3595: sub dumpstore {
3596: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3597: if (!$udomain) { $udomain=$env{'user.domain'}; }
3598: if (!$uname) { $uname=$env{'user.name'}; }
3599: my $uhome=&homeserver($uname,$udomain);
3600: if ($regexp) {
3601: $regexp=&escape($regexp);
3602: } else {
3603: $regexp='.';
3604: }
3605: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3606: my @pairs=split(/\&/,$rep);
3607: my %returnhash=();
3608: foreach my $item (@pairs) {
3609: my ($key,$value)=split(/=/,$item,2);
3610: next if ($key =~ /^error: 2 /);
3611: $returnhash{$key}=&thaw_unescape($value);
3612: }
3613: return %returnhash;
3614: }
3615:
3616: # -------------------------------------------------------------- keys interface
3617:
3618: sub getkeys {
3619: my ($namespace,$udomain,$uname)=@_;
3620: if (!$udomain) { $udomain=$env{'user.domain'}; }
3621: if (!$uname) { $uname=$env{'user.name'}; }
3622: my $uhome=&homeserver($uname,$udomain);
3623: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3624: my @keyarray=();
3625: foreach my $key (split(/\&/,$rep)) {
3626: next if ($key =~ /^error: 2 /);
3627: push(@keyarray,&unescape($key));
3628: }
3629: return @keyarray;
3630: }
3631:
3632: # --------------------------------------------------------------- currentdump
3633: sub currentdump {
3634: my ($courseid,$sdom,$sname)=@_;
3635: $courseid = $env{'request.course.id'} if (! defined($courseid));
3636: $sdom = $env{'user.domain'} if (! defined($sdom));
3637: $sname = $env{'user.name'} if (! defined($sname));
3638: my $uhome = &homeserver($sname,$sdom);
3639: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3640: return if ($rep =~ /^(error:|no_such_host)/);
3641: #
3642: my %returnhash=();
3643: #
3644: if ($rep eq "unknown_cmd") {
3645: # an old lond will not know currentdump
3646: # Do a dump and make it look like a currentdump
3647: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
3648: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3649: my %hash = @tmp;
3650: @tmp=();
3651: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3652: } else {
3653: my @pairs=split(/\&/,$rep);
3654: foreach my $pair (@pairs) {
3655: my ($key,$value)=split(/=/,$pair,2);
3656: my ($symb,$param) = split(/:/,$key);
3657: $returnhash{&unescape($symb)}->{&unescape($param)} =
3658: &thaw_unescape($value);
3659: }
3660: }
3661: return %returnhash;
3662: }
3663:
3664: sub convert_dump_to_currentdump{
3665: my %hash = %{shift()};
3666: my %returnhash;
3667: # Code ripped from lond, essentially. The only difference
3668: # here is the unescaping done by lonnet::dump(). Conceivably
3669: # we might run in to problems with parameter names =~ /^v\./
3670: while (my ($key,$value) = each(%hash)) {
3671: my ($v,$symb,$param) = split(/:/,$key);
3672: $symb = &unescape($symb);
3673: $param = &unescape($param);
3674: next if ($v eq 'version' || $symb eq 'keys');
3675: next if (exists($returnhash{$symb}) &&
3676: exists($returnhash{$symb}->{$param}) &&
3677: $returnhash{$symb}->{'v.'.$param} > $v);
3678: $returnhash{$symb}->{$param}=$value;
3679: $returnhash{$symb}->{'v.'.$param}=$v;
3680: }
3681: #
3682: # Remove all of the keys in the hashes which keep track of
3683: # the version of the parameter.
3684: while (my ($symb,$param_hash) = each(%returnhash)) {
3685: # use a foreach because we are going to delete from the hash.
3686: foreach my $key (keys(%$param_hash)) {
3687: delete($param_hash->{$key}) if ($key =~ /^v\./);
3688: }
3689: }
3690: return \%returnhash;
3691: }
3692:
3693: # ------------------------------------------------------ critical inc interface
3694:
3695: sub cinc {
3696: return &inc(@_,'critical');
3697: }
3698:
3699: # --------------------------------------------------------------- inc interface
3700:
3701: sub inc {
3702: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3703: if (!$udomain) { $udomain=$env{'user.domain'}; }
3704: if (!$uname) { $uname=$env{'user.name'}; }
3705: my $uhome=&homeserver($uname,$udomain);
3706: my $items='';
3707: if (! ref($store)) {
3708: # got a single value, so use that instead
3709: $items = &escape($store).'=&';
3710: } elsif (ref($store) eq 'SCALAR') {
3711: $items = &escape($$store).'=&';
3712: } elsif (ref($store) eq 'ARRAY') {
3713: $items = join('=&',map {&escape($_);} @{$store});
3714: } elsif (ref($store) eq 'HASH') {
3715: while (my($key,$value) = each(%{$store})) {
3716: $items.= &escape($key).'='.&escape($value).'&';
3717: }
3718: }
3719: $items=~s/\&$//;
3720: if ($critical) {
3721: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3722: } else {
3723: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3724: }
3725: }
3726:
3727: # --------------------------------------------------------------- put interface
3728:
3729: sub put {
3730: my ($namespace,$storehash,$udomain,$uname)=@_;
3731: if (!$udomain) { $udomain=$env{'user.domain'}; }
3732: if (!$uname) { $uname=$env{'user.name'}; }
3733: my $uhome=&homeserver($uname,$udomain);
3734: my $items='';
3735: foreach my $item (keys(%$storehash)) {
3736: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3737: }
3738: $items=~s/\&$//;
3739: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3740: }
3741:
3742: # ------------------------------------------------------------ newput interface
3743:
3744: sub newput {
3745: my ($namespace,$storehash,$udomain,$uname)=@_;
3746: if (!$udomain) { $udomain=$env{'user.domain'}; }
3747: if (!$uname) { $uname=$env{'user.name'}; }
3748: my $uhome=&homeserver($uname,$udomain);
3749: my $items='';
3750: foreach my $key (keys(%$storehash)) {
3751: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3752: }
3753: $items=~s/\&$//;
3754: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3755: }
3756:
3757: # --------------------------------------------------------- putstore interface
3758:
3759: sub putstore {
3760: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3761: if (!$udomain) { $udomain=$env{'user.domain'}; }
3762: if (!$uname) { $uname=$env{'user.name'}; }
3763: my $uhome=&homeserver($uname,$udomain);
3764: my $items='';
3765: foreach my $key (keys(%$storehash)) {
3766: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3767: }
3768: $items=~s/\&$//;
3769: my $esc_symb=&escape($symb);
3770: my $esc_v=&escape($version);
3771: my $reply =
3772: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3773: $uhome);
3774: if ($reply eq 'unknown_cmd') {
3775: # gfall back to way things use to be done
3776: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3777: $uname);
3778: }
3779: return $reply;
3780: }
3781:
3782: sub old_putstore {
3783: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3784: if (!$udomain) { $udomain=$env{'user.domain'}; }
3785: if (!$uname) { $uname=$env{'user.name'}; }
3786: my $uhome=&homeserver($uname,$udomain);
3787: my %newstorehash;
3788: foreach my $item (keys(%$storehash)) {
3789: my $key = $version.':'.&escape($symb).':'.$item;
3790: $newstorehash{$key} = $storehash->{$item};
3791: }
3792: my $items='';
3793: my %allitems = ();
3794: foreach my $item (keys(%newstorehash)) {
3795: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3796: my $key = $1.':keys:'.$2;
3797: $allitems{$key} .= $3.':';
3798: }
3799: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3800: }
3801: foreach my $item (keys(%allitems)) {
3802: $allitems{$item} =~ s/\:$//;
3803: $items.= $item.'='.$allitems{$item}.'&';
3804: }
3805: $items=~s/\&$//;
3806: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3807: }
3808:
3809: # ------------------------------------------------------ critical put interface
3810:
3811: sub cput {
3812: my ($namespace,$storehash,$udomain,$uname)=@_;
3813: if (!$udomain) { $udomain=$env{'user.domain'}; }
3814: if (!$uname) { $uname=$env{'user.name'}; }
3815: my $uhome=&homeserver($uname,$udomain);
3816: my $items='';
3817: foreach my $item (keys(%$storehash)) {
3818: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3819: }
3820: $items=~s/\&$//;
3821: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3822: }
3823:
3824: # -------------------------------------------------------------- eget interface
3825:
3826: sub eget {
3827: my ($namespace,$storearr,$udomain,$uname)=@_;
3828: my $items='';
3829: foreach my $item (@$storearr) {
3830: $items.=&escape($item).'&';
3831: }
3832: $items=~s/\&$//;
3833: if (!$udomain) { $udomain=$env{'user.domain'}; }
3834: if (!$uname) { $uname=$env{'user.name'}; }
3835: my $uhome=&homeserver($uname,$udomain);
3836: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3837: my @pairs=split(/\&/,$rep);
3838: my %returnhash=();
3839: my $i=0;
3840: foreach my $item (@$storearr) {
3841: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3842: $i++;
3843: }
3844: return %returnhash;
3845: }
3846:
3847: # ------------------------------------------------------------ tmpput interface
3848: sub tmpput {
3849: my ($storehash,$server,$context)=@_;
3850: my $items='';
3851: foreach my $item (keys(%$storehash)) {
3852: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3853: }
3854: $items=~s/\&$//;
3855: if (defined($context)) {
3856: $items .= ':'.&escape($context);
3857: }
3858: return &reply("tmpput:$items",$server);
3859: }
3860:
3861: # ------------------------------------------------------------ tmpget interface
3862: sub tmpget {
3863: my ($token,$server)=@_;
3864: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3865: my $rep=&reply("tmpget:$token",$server);
3866: my %returnhash;
3867: foreach my $item (split(/\&/,$rep)) {
3868: my ($key,$value)=split(/=/,$item);
3869: $returnhash{&unescape($key)}=&thaw_unescape($value);
3870: }
3871: return %returnhash;
3872: }
3873:
3874: # ------------------------------------------------------------ tmpget interface
3875: sub tmpdel {
3876: my ($token,$server)=@_;
3877: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3878: return &reply("tmpdel:$token",$server);
3879: }
3880:
3881: # -------------------------------------------------- portfolio access checking
3882:
3883: sub portfolio_access {
3884: my ($requrl) = @_;
3885: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3886: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3887: if ($result) {
3888: my %setters;
3889: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3890: my ($startblock,$endblock) =
3891: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
3892: if ($startblock && $endblock) {
3893: return 'B';
3894: }
3895: } else {
3896: my ($startblock,$endblock) =
3897: &Apache::loncommon::blockcheck(\%setters,'port');
3898: if ($startblock && $endblock) {
3899: return 'B';
3900: }
3901: }
3902: }
3903: if ($result eq 'ok') {
3904: return 'F';
3905: } elsif ($result =~ /^[^:]+:guest_/) {
3906: return 'A';
3907: }
3908: return '';
3909: }
3910:
3911: sub get_portfolio_access {
3912: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3913:
3914: if (!ref($access_hash)) {
3915: my $current_perms = &get_portfile_permissions($udom,$unum);
3916: my %access_controls = &get_access_controls($current_perms,$group,
3917: $file_name);
3918: $access_hash = $access_controls{$file_name};
3919: }
3920:
3921: my ($public,$guest,@domains,@users,@courses,@groups);
3922: my $now = time;
3923: if (ref($access_hash) eq 'HASH') {
3924: foreach my $key (keys(%{$access_hash})) {
3925: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3926: if ($start > $now) {
3927: next;
3928: }
3929: if ($end && $end<$now) {
3930: next;
3931: }
3932: if ($scope eq 'public') {
3933: $public = $key;
3934: last;
3935: } elsif ($scope eq 'guest') {
3936: $guest = $key;
3937: } elsif ($scope eq 'domains') {
3938: push(@domains,$key);
3939: } elsif ($scope eq 'users') {
3940: push(@users,$key);
3941: } elsif ($scope eq 'course') {
3942: push(@courses,$key);
3943: } elsif ($scope eq 'group') {
3944: push(@groups,$key);
3945: }
3946: }
3947: if ($public) {
3948: return 'ok';
3949: }
3950: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3951: if ($guest) {
3952: return $guest;
3953: }
3954: } else {
3955: if (@domains > 0) {
3956: foreach my $domkey (@domains) {
3957: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3958: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3959: return 'ok';
3960: }
3961: }
3962: }
3963: }
3964: if (@users > 0) {
3965: foreach my $userkey (@users) {
3966: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
3967: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
3968: if (ref($item) eq 'HASH') {
3969: if (($item->{'uname'} eq $env{'user.name'}) &&
3970: ($item->{'udom'} eq $env{'user.domain'})) {
3971: return 'ok';
3972: }
3973: }
3974: }
3975: }
3976: }
3977: }
3978: my %roleshash;
3979: my @courses_and_groups = @courses;
3980: push(@courses_and_groups,@groups);
3981: if (@courses_and_groups > 0) {
3982: my (%allgroups,%allroles);
3983: my ($start,$end,$role,$sec,$group);
3984: foreach my $envkey (%env) {
3985: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
3986: my $cid = $2.'_'.$3;
3987: if ($1 eq 'gr') {
3988: $group = $4;
3989: $allgroups{$cid}{$group} = $env{$envkey};
3990: } else {
3991: if ($4 eq '') {
3992: $sec = 'none';
3993: } else {
3994: $sec = $4;
3995: }
3996: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3997: }
3998: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
3999: my $cid = $2.'_'.$3;
4000: if ($4 eq '') {
4001: $sec = 'none';
4002: } else {
4003: $sec = $4;
4004: }
4005: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4006: }
4007: }
4008: if (keys(%allroles) == 0) {
4009: return;
4010: }
4011: foreach my $key (@courses_and_groups) {
4012: my %content = %{$$access_hash{$key}};
4013: my $cnum = $content{'number'};
4014: my $cdom = $content{'domain'};
4015: my $cid = $cdom.'_'.$cnum;
4016: if (!exists($allroles{$cid})) {
4017: next;
4018: }
4019: foreach my $role_id (keys(%{$content{'roles'}})) {
4020: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4021: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4022: my @status = @{$content{'roles'}{$role_id}{'access'}};
4023: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4024: foreach my $role (keys(%{$allroles{$cid}})) {
4025: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4026: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4027: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4028: if (grep/^all$/,@sections) {
4029: return 'ok';
4030: } else {
4031: if (grep/^$sec$/,@sections) {
4032: return 'ok';
4033: }
4034: }
4035: }
4036: }
4037: if (keys(%{$allgroups{$cid}}) == 0) {
4038: if (grep/^none$/,@groups) {
4039: return 'ok';
4040: }
4041: } else {
4042: if (grep/^all$/,@groups) {
4043: return 'ok';
4044: }
4045: foreach my $group (keys(%{$allgroups{$cid}})) {
4046: if (grep/^$group$/,@groups) {
4047: return 'ok';
4048: }
4049: }
4050: }
4051: }
4052: }
4053: }
4054: }
4055: }
4056: if ($guest) {
4057: return $guest;
4058: }
4059: }
4060: }
4061: return;
4062: }
4063:
4064: sub course_group_datechecker {
4065: my ($dates,$now,$status) = @_;
4066: my ($start,$end) = split(/\./,$dates);
4067: if (!$start && !$end) {
4068: return 'ok';
4069: }
4070: if (grep/^active$/,@{$status}) {
4071: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4072: return 'ok';
4073: }
4074: }
4075: if (grep/^previous$/,@{$status}) {
4076: if ($end > $now ) {
4077: return 'ok';
4078: }
4079: }
4080: if (grep/^future$/,@{$status}) {
4081: if ($start > $now) {
4082: return 'ok';
4083: }
4084: }
4085: return;
4086: }
4087:
4088: sub parse_portfolio_url {
4089: my ($url) = @_;
4090:
4091: my ($type,$udom,$unum,$group,$file_name);
4092:
4093: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4094: $type = 1;
4095: $udom = $1;
4096: $unum = $2;
4097: $file_name = $3;
4098: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4099: $type = 2;
4100: $udom = $1;
4101: $unum = $2;
4102: $group = $3;
4103: $file_name = $3.'/'.$4;
4104: }
4105: if (wantarray) {
4106: return ($type,$udom,$unum,$file_name,$group);
4107: }
4108: return $type;
4109: }
4110:
4111: sub is_portfolio_url {
4112: my ($url) = @_;
4113: return scalar(&parse_portfolio_url($url));
4114: }
4115:
4116: sub is_portfolio_file {
4117: my ($file) = @_;
4118: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4119: return 1;
4120: }
4121: return;
4122: }
4123:
4124:
4125: # ---------------------------------------------- Custom access rule evaluation
4126:
4127: sub customaccess {
4128: my ($priv,$uri)=@_;
4129: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4130: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4131: $udom = &LONCAPA::clean_domain($udom);
4132: $ucrs = &LONCAPA::clean_username($ucrs);
4133: my $access=0;
4134: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4135: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4136: if ($type eq 'user') {
4137: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4138: my ($tdom,$tuname)=split(m{/},$scope);
4139: if ($tdom) {
4140: if ($tdom ne $env{'user.domain'}) { next; }
4141: }
4142: if ($tuname) {
4143: if ($tuname ne $env{'user.name'}) { next; }
4144: }
4145: $access=($effect eq 'allow');
4146: last;
4147: }
4148: } else {
4149: if ($role) {
4150: if ($role ne $urole) { next; }
4151: }
4152: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4153: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4154: if ($tdom) {
4155: if ($tdom ne $udom) { next; }
4156: }
4157: if ($tcrs) {
4158: if ($tcrs ne $ucrs) { next; }
4159: }
4160: if ($tsec) {
4161: if ($tsec ne $usec) { next; }
4162: }
4163: $access=($effect eq 'allow');
4164: last;
4165: }
4166: if ($realm eq '' && $role eq '') {
4167: $access=($effect eq 'allow');
4168: }
4169: }
4170: }
4171: return $access;
4172: }
4173:
4174: # ------------------------------------------------- Check for a user privilege
4175:
4176: sub allowed {
4177: my ($priv,$uri,$symb,$role)=@_;
4178: my $ver_orguri=$uri;
4179: $uri=&deversion($uri);
4180: my $orguri=$uri;
4181: $uri=&declutter($uri);
4182:
4183: if ($priv eq 'evb') {
4184: # Evade communication block restrictions for specified role in a course
4185: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4186: return $1;
4187: } else {
4188: return;
4189: }
4190: }
4191:
4192: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4193: # Free bre access to adm and meta resources
4194: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4195: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4196: && ($priv eq 'bre')) {
4197: return 'F';
4198: }
4199:
4200: # Free bre access to user's own portfolio contents
4201: my ($space,$domain,$name,@dir)=split('/',$uri);
4202: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4203: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4204: my %setters;
4205: my ($startblock,$endblock) =
4206: &Apache::loncommon::blockcheck(\%setters,'port');
4207: if ($startblock && $endblock) {
4208: return 'B';
4209: } else {
4210: return 'F';
4211: }
4212: }
4213:
4214: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4215: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4216: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4217: if (exists($env{'request.course.id'})) {
4218: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4219: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4220: if (($domain eq $cdom) && ($name eq $cnum)) {
4221: my $courseprivid=$env{'request.course.id'};
4222: $courseprivid=~s/\_/\//;
4223: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4224: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4225: return $1;
4226: } else {
4227: if ($env{'request.course.sec'}) {
4228: $courseprivid.='/'.$env{'request.course.sec'};
4229: }
4230: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4231: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
4232: return $2;
4233: }
4234: }
4235: }
4236: }
4237: }
4238:
4239: # Free bre to public access
4240:
4241: if ($priv eq 'bre') {
4242: my $copyright=&metadata($uri,'copyright');
4243: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
4244: return 'F';
4245: }
4246: if ($copyright eq 'priv') {
4247: $uri=~/([^\/]+)\/([^\/]+)\//;
4248: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
4249: return '';
4250: }
4251: }
4252: if ($copyright eq 'domain') {
4253: $uri=~/([^\/]+)\/([^\/]+)\//;
4254: unless (($env{'user.domain'} eq $1) ||
4255: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
4256: return '';
4257: }
4258: }
4259: if ($env{'request.role'}=~ /li\.\//) {
4260: # Library role, so allow browsing of resources in this domain.
4261: return 'F';
4262: }
4263: if ($copyright eq 'custom') {
4264: unless (&customaccess($priv,$uri)) { return ''; }
4265: }
4266: }
4267: # Domain coordinator is trying to create a course
4268: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
4269: # uri is the requested domain in this case.
4270: # comparison to 'request.role.domain' shows if the user has selected
4271: # a role of dc for the domain in question.
4272: return 'F' if ($uri eq $env{'request.role.domain'});
4273: }
4274:
4275: my $thisallowed='';
4276: my $statecond=0;
4277: my $courseprivid='';
4278:
4279: # Course
4280:
4281: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
4282: $thisallowed.=$1;
4283: }
4284:
4285: # Domain
4286:
4287: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
4288: =~/\Q$priv\E\&([^\:]*)/) {
4289: $thisallowed.=$1;
4290: }
4291:
4292: # Course: uri itself is a course
4293: my $courseuri=$uri;
4294: $courseuri=~s/\_(\d)/\/$1/;
4295: $courseuri=~s/^([^\/])/\/$1/;
4296:
4297: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
4298: =~/\Q$priv\E\&([^\:]*)/) {
4299: $thisallowed.=$1;
4300: }
4301:
4302: # URI is an uploaded document for this course, default permissions don't matter
4303: # not allowing 'edit' access (editupload) to uploaded course docs
4304: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
4305: $thisallowed='';
4306: my ($match)=&is_on_map($uri);
4307: if ($match) {
4308: if ($env{'user.priv.'.$env{'request.role'}.'./'}
4309: =~/\Q$priv\E\&([^\:]*)/) {
4310: $thisallowed.=$1;
4311: }
4312: } else {
4313: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
4314: if ($refuri) {
4315: if ($refuri =~ m|^/adm/|) {
4316: $thisallowed='F';
4317: } else {
4318: $refuri=&declutter($refuri);
4319: my ($match) = &is_on_map($refuri);
4320: if ($match) {
4321: $thisallowed='F';
4322: }
4323: }
4324: }
4325: }
4326: }
4327:
4328: if ($priv eq 'bre'
4329: && $thisallowed ne 'F'
4330: && $thisallowed ne '2'
4331: && &is_portfolio_url($uri)) {
4332: $thisallowed = &portfolio_access($uri);
4333: }
4334:
4335: # Full access at system, domain or course-wide level? Exit.
4336:
4337: if ($thisallowed=~/F/) {
4338: return 'F';
4339: }
4340:
4341: # If this is generating or modifying users, exit with special codes
4342:
4343: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
4344: if (($priv eq 'cca') || ($priv eq 'caa')) {
4345: my ($audom,$auname)=split('/',$uri);
4346: # no author name given, so this just checks on the general right to make a co-author in this domain
4347: unless ($auname) { return $thisallowed; }
4348: # an author name is given, so we are about to actually make a co-author for a certain account
4349: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
4350: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
4351: ($audom ne $env{'request.role.domain'}))) { return ''; }
4352: }
4353: return $thisallowed;
4354: }
4355: #
4356: # Gathered so far: system, domain and course wide privileges
4357: #
4358: # Course: See if uri or referer is an individual resource that is part of
4359: # the course
4360:
4361: if ($env{'request.course.id'}) {
4362:
4363: $courseprivid=$env{'request.course.id'};
4364: if ($env{'request.course.sec'}) {
4365: $courseprivid.='/'.$env{'request.course.sec'};
4366: }
4367: $courseprivid=~s/\_/\//;
4368: my $checkreferer=1;
4369: my ($match,$cond)=&is_on_map($uri);
4370: if ($match) {
4371: $statecond=$cond;
4372: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4373: =~/\Q$priv\E\&([^\:]*)/) {
4374: $thisallowed.=$1;
4375: $checkreferer=0;
4376: }
4377: }
4378:
4379: if ($checkreferer) {
4380: my $refuri=$env{'httpref.'.$orguri};
4381: unless ($refuri) {
4382: foreach my $key (keys(%env)) {
4383: if ($key=~/^httpref\..*\*/) {
4384: my $pattern=$key;
4385: $pattern=~s/^httpref\.\/res\///;
4386: $pattern=~s/\*/\[\^\/\]\+/g;
4387: $pattern=~s/\//\\\//g;
4388: if ($orguri=~/$pattern/) {
4389: $refuri=$env{$key};
4390: }
4391: }
4392: }
4393: }
4394:
4395: if ($refuri) {
4396: $refuri=&declutter($refuri);
4397: my ($match,$cond)=&is_on_map($refuri);
4398: if ($match) {
4399: my $refstatecond=$cond;
4400: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
4401: =~/\Q$priv\E\&([^\:]*)/) {
4402: $thisallowed.=$1;
4403: $uri=$refuri;
4404: $statecond=$refstatecond;
4405: }
4406: }
4407: }
4408: }
4409: }
4410:
4411: #
4412: # Gathered now: all privileges that could apply, and condition number
4413: #
4414: #
4415: # Full or no access?
4416: #
4417:
4418: if ($thisallowed=~/F/) {
4419: return 'F';
4420: }
4421:
4422: unless ($thisallowed) {
4423: return '';
4424: }
4425:
4426: # Restrictions exist, deal with them
4427: #
4428: # C:according to course preferences
4429: # R:according to resource settings
4430: # L:unless locked
4431: # X:according to user session state
4432: #
4433:
4434: # Possibly locked functionality, check all courses
4435: # Locks might take effect only after 10 minutes cache expiration for other
4436: # courses, and 2 minutes for current course
4437:
4438: my $envkey;
4439: if ($thisallowed=~/L/) {
4440: foreach $envkey (keys %env) {
4441: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
4442: my $courseid=$2;
4443: my $roleid=$1.'.'.$2;
4444: $courseid=~s/^\///;
4445: my $expiretime=600;
4446: if ($env{'request.role'} eq $roleid) {
4447: $expiretime=120;
4448: }
4449: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
4450: my $prefix='course.'.$cdom.'_'.$cnum.'.';
4451: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
4452: &coursedescription($courseid,{'freshen_cache' => 1});
4453: }
4454: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
4455: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
4456: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
4457: &log($env{'user.domain'},$env{'user.name'},
4458: $env{'user.home'},
4459: 'Locked by res: '.$priv.' for '.$uri.' due to '.
4460: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4461: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4462: return '';
4463: }
4464: }
4465: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
4466: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
4467: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
4468: &log($env{'user.domain'},$env{'user.name'},
4469: $env{'user.home'},
4470: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
4471: $cdom.'/'.$cnum.'/'.$csec.' expire '.
4472: $env{$prefix.'priv.'.$priv.'.lock.expire'});
4473: return '';
4474: }
4475: }
4476: }
4477: }
4478: }
4479:
4480: #
4481: # Rest of the restrictions depend on selected course
4482: #
4483:
4484: unless ($env{'request.course.id'}) {
4485: if ($thisallowed eq 'A') {
4486: return 'A';
4487: } elsif ($thisallowed eq 'B') {
4488: return 'B';
4489: } else {
4490: return '1';
4491: }
4492: }
4493:
4494: #
4495: # Now user is definitely in a course
4496: #
4497:
4498:
4499: # Course preferences
4500:
4501: if ($thisallowed=~/C/) {
4502: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4503: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
4504: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
4505: =~/\Q$rolecode\E/) {
4506: if ($priv ne 'pch') {
4507: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4508: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
4509: $env{'request.course.id'});
4510: }
4511: return '';
4512: }
4513:
4514: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
4515: =~/\Q$unamedom\E/) {
4516: if ($priv ne 'pch') {
4517: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
4518: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
4519: $env{'request.course.id'});
4520: }
4521: return '';
4522: }
4523: }
4524:
4525: # Resource preferences
4526:
4527: if ($thisallowed=~/R/) {
4528: my $rolecode=(split(/\./,$env{'request.role'}))[0];
4529: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
4530: if ($priv ne 'pch') {
4531: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
4532: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
4533: }
4534: return '';
4535: }
4536: }
4537:
4538: # Restricted by state or randomout?
4539:
4540: if ($thisallowed=~/X/) {
4541: if ($env{'acc.randomout'}) {
4542: if (!$symb) { $symb=&symbread($uri,1); }
4543: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
4544: return '';
4545: }
4546: }
4547: if (&condval($statecond)) {
4548: return '2';
4549: } else {
4550: return '';
4551: }
4552: }
4553:
4554: if ($thisallowed eq 'A') {
4555: return 'A';
4556: } elsif ($thisallowed eq 'B') {
4557: return 'B';
4558: }
4559: return 'F';
4560: }
4561:
4562: sub split_uri_for_cond {
4563: my $uri=&deversion(&declutter(shift));
4564: my @uriparts=split(/\//,$uri);
4565: my $filename=pop(@uriparts);
4566: my $pathname=join('/',@uriparts);
4567: return ($pathname,$filename);
4568: }
4569: # --------------------------------------------------- Is a resource on the map?
4570:
4571: sub is_on_map {
4572: my ($pathname,$filename) = &split_uri_for_cond(shift);
4573: #Trying to find the conditional for the file
4574: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4575: /\&\Q$filename\E\:([\d\|]+)\&/);
4576: if ($match) {
4577: return (1,$1);
4578: } else {
4579: return (0,0);
4580: }
4581: }
4582:
4583: # --------------------------------------------------------- Get symb from alias
4584:
4585: sub get_symb_from_alias {
4586: my $symb=shift;
4587: my ($map,$resid,$url)=&decode_symb($symb);
4588: # Already is a symb
4589: if ($url) { return $symb; }
4590: # Must be an alias
4591: my $aliassymb='';
4592: my %bighash;
4593: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4594: &GDBM_READER(),0640)) {
4595: my $rid=$bighash{'mapalias_'.$symb};
4596: if ($rid) {
4597: my ($mapid,$resid)=split(/\./,$rid);
4598: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
4599: $resid,$bighash{'src_'.$rid});
4600: }
4601: untie %bighash;
4602: }
4603: return $aliassymb;
4604: }
4605:
4606: # ----------------------------------------------------------------- Define Role
4607:
4608: sub definerole {
4609: if (allowed('mcr','/')) {
4610: my ($rolename,$sysrole,$domrole,$courole)=@_;
4611: foreach my $role (split(':',$sysrole)) {
4612: my ($crole,$cqual)=split(/\&/,$role);
4613: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
4614: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
4615: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4616: return "refused:s:$crole&$cqual";
4617: }
4618: }
4619: }
4620: foreach my $role (split(':',$domrole)) {
4621: my ($crole,$cqual)=split(/\&/,$role);
4622: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
4623: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
4624: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
4625: return "refused:d:$crole&$cqual";
4626: }
4627: }
4628: }
4629: foreach my $role (split(':',$courole)) {
4630: my ($crole,$cqual)=split(/\&/,$role);
4631: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
4632: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
4633: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
4634: return "refused:c:$crole&$cqual";
4635: }
4636: }
4637: }
4638: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4639: "$env{'user.domain'}:$env{'user.name'}:".
4640: "rolesdef_$rolename=".
4641: escape($sysrole.'_'.$domrole.'_'.$courole);
4642: return reply($command,$env{'user.home'});
4643: } else {
4644: return 'refused';
4645: }
4646: }
4647:
4648: # ---------------- Make a metadata query against the network of library servers
4649:
4650: sub metadata_query {
4651: my ($query,$custom,$customshow,$server_array)=@_;
4652: my %rhash;
4653: my %libserv = &all_library();
4654: my @server_list = (defined($server_array) ? @$server_array
4655: : keys(%libserv) );
4656: for my $server (@server_list) {
4657: unless ($custom or $customshow) {
4658: my $reply=&reply("querysend:".&escape($query),$server);
4659: $rhash{$server}=$reply;
4660: }
4661: else {
4662: my $reply=&reply("querysend:".&escape($query).':'.
4663: &escape($custom).':'.&escape($customshow),
4664: $server);
4665: $rhash{$server}=$reply;
4666: }
4667: }
4668: return \%rhash;
4669: }
4670:
4671: # ----------------------------------------- Send log queries and wait for reply
4672:
4673: sub log_query {
4674: my ($uname,$udom,$query,%filters)=@_;
4675: my $uhome=&homeserver($uname,$udom);
4676: if ($uhome eq 'no_host') { return 'error: no_host'; }
4677: my $uhost=&hostname($uhome);
4678: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4679: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4680: $uhome);
4681: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4682: return get_query_reply($queryid);
4683: }
4684:
4685: # -------------------------- Update MySQL table for portfolio file
4686:
4687: sub update_portfolio_table {
4688: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
4689: my $homeserver = &homeserver($uname,$udom);
4690: my $queryid=
4691: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
4692: ':'.&escape($file_name).':'.$action,$homeserver);
4693: my $reply = &get_query_reply($queryid);
4694: return $reply;
4695: }
4696:
4697: # -------------------------- Update MySQL allusers table
4698:
4699: sub update_allusers_table {
4700: my ($uname,$udom,$names) = @_;
4701: my $homeserver = &homeserver($uname,$udom);
4702: my $queryid=
4703: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
4704: 'lastname='.&escape($names->{'lastname'}).'%%'.
4705: 'firstname='.&escape($names->{'firstname'}).'%%'.
4706: 'middlename='.&escape($names->{'middlename'}).'%%'.
4707: 'generation='.&escape($names->{'generation'}).'%%'.
4708: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
4709: 'id='.&escape($names->{'id'}),$homeserver);
4710: my $reply = &get_query_reply($queryid);
4711: return $reply;
4712: }
4713:
4714: # ------- Request retrieval of institutional classlists for course(s)
4715:
4716: sub fetch_enrollment_query {
4717: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4718: my $homeserver;
4719: my $maxtries = 1;
4720: if ($context eq 'automated') {
4721: $homeserver = $perlvar{'lonHostID'};
4722: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4723: } else {
4724: $homeserver = &homeserver($cnum,$dom);
4725: }
4726: my $host=&hostname($homeserver);
4727: my $cmd = '';
4728: foreach my $affiliate (keys %{$affiliatesref}) {
4729: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4730: }
4731: $cmd =~ s/%%$//;
4732: $cmd = &escape($cmd);
4733: my $query = 'fetchenrollment';
4734: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4735: unless ($queryid=~/^\Q$host\E\_/) {
4736: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4737: return 'error: '.$queryid;
4738: }
4739: my $reply = &get_query_reply($queryid);
4740: my $tries = 1;
4741: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4742: $reply = &get_query_reply($queryid);
4743: $tries ++;
4744: }
4745: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4746: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4747: } else {
4748: my @responses = split(/:/,$reply);
4749: if ($homeserver eq $perlvar{'lonHostID'}) {
4750: foreach my $line (@responses) {
4751: my ($key,$value) = split(/=/,$line,2);
4752: $$replyref{$key} = $value;
4753: }
4754: } else {
4755: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4756: foreach my $line (@responses) {
4757: my ($key,$value) = split(/=/,$line);
4758: $$replyref{$key} = $value;
4759: if ($value > 0) {
4760: foreach my $item (@{$$affiliatesref{$key}}) {
4761: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4762: my $destname = $pathname.'/'.$filename;
4763: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4764: if ($xml_classlist =~ /^error/) {
4765: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4766: } else {
4767: if ( open(FILE,">$destname") ) {
4768: print FILE &unescape($xml_classlist);
4769: close(FILE);
4770: } else {
4771: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4772: }
4773: }
4774: }
4775: }
4776: }
4777: }
4778: return 'ok';
4779: }
4780: return 'error';
4781: }
4782:
4783: sub get_query_reply {
4784: my $queryid=shift;
4785: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4786: my $reply='';
4787: for (1..100) {
4788: sleep 2;
4789: if (-e $replyfile.'.end') {
4790: if (open(my $fh,$replyfile)) {
4791: $reply = join('',<$fh>);
4792: close($fh);
4793: } else { return 'error: reply_file_error'; }
4794: return &unescape($reply);
4795: }
4796: }
4797: return 'timeout:'.$queryid;
4798: }
4799:
4800: sub courselog_query {
4801: #
4802: # possible filters:
4803: # url: url or symb
4804: # username
4805: # domain
4806: # action: view, submit, grade
4807: # start: timestamp
4808: # end: timestamp
4809: #
4810: my (%filters)=@_;
4811: unless ($env{'request.course.id'}) { return 'no_course'; }
4812: if ($filters{'url'}) {
4813: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4814: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4815: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4816: }
4817: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4818: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4819: return &log_query($cname,$cdom,'courselog',%filters);
4820: }
4821:
4822: sub userlog_query {
4823: #
4824: # possible filters:
4825: # action: log check role
4826: # start: timestamp
4827: # end: timestamp
4828: #
4829: my ($uname,$udom,%filters)=@_;
4830: return &log_query($uname,$udom,'userlog',%filters);
4831: }
4832:
4833: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4834:
4835: sub auto_run {
4836: my ($cnum,$cdom) = @_;
4837: my $response = 0;
4838: my $settings;
4839: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
4840: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
4841: $settings = $domconfig{'autoenroll'};
4842: if ($settings->{'run'} eq '1') {
4843: $response = 1;
4844: }
4845: } else {
4846: my $homeserver = &homeserver($cnum,$cdom);
4847: $response = &reply('autorun:'.$cdom,$homeserver);
4848: }
4849: return $response;
4850: }
4851:
4852: sub auto_get_sections {
4853: my ($cnum,$cdom,$inst_coursecode) = @_;
4854: my $homeserver = &homeserver($cnum,$cdom);
4855: my @secs = ();
4856: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4857: unless ($response eq 'refused') {
4858: @secs = split(/:/,$response);
4859: }
4860: return @secs;
4861: }
4862:
4863: sub auto_new_course {
4864: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4865: my $homeserver = &homeserver($cnum,$cdom);
4866: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4867: return $response;
4868: }
4869:
4870: sub auto_validate_courseID {
4871: my ($cnum,$cdom,$inst_course_id) = @_;
4872: my $homeserver = &homeserver($cnum,$cdom);
4873: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4874: return $response;
4875: }
4876:
4877: sub auto_create_password {
4878: my ($cnum,$cdom,$authparam,$udom) = @_;
4879: my ($homeserver,$response);
4880: my $create_passwd = 0;
4881: my $authchk = '';
4882: if ($udom =~ /^$match_domain$/) {
4883: $homeserver = &domain($udom,'primary');
4884: }
4885: if ($homeserver eq '') {
4886: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
4887: $homeserver = &homeserver($cnum,$cdom);
4888: }
4889: }
4890: if ($homeserver eq '') {
4891: $authchk = 'nodomain';
4892: } else {
4893: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4894: if ($response eq 'refused') {
4895: $authchk = 'refused';
4896: } else {
4897: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
4898: }
4899: }
4900: return ($authparam,$create_passwd,$authchk);
4901: }
4902:
4903: sub auto_photo_permission {
4904: my ($cnum,$cdom,$students) = @_;
4905: my $homeserver = &homeserver($cnum,$cdom);
4906: my ($outcome,$perm_reqd,$conditions) =
4907: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4908: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4909: return (undef,undef);
4910: }
4911: return ($outcome,$perm_reqd,$conditions);
4912: }
4913:
4914: sub auto_checkphotos {
4915: my ($uname,$udom,$pid) = @_;
4916: my $homeserver = &homeserver($uname,$udom);
4917: my ($result,$resulttype);
4918: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4919: &escape($uname).':'.&escape($pid),
4920: $homeserver));
4921: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4922: return (undef,undef);
4923: }
4924: if ($outcome) {
4925: ($result,$resulttype) = split(/:/,$outcome);
4926: }
4927: return ($result,$resulttype);
4928: }
4929:
4930: sub auto_photochoice {
4931: my ($cnum,$cdom) = @_;
4932: my $homeserver = &homeserver($cnum,$cdom);
4933: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4934: &escape($cdom),
4935: $homeserver)));
4936: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4937: return (undef,undef);
4938: }
4939: return ($update,$comment);
4940: }
4941:
4942: sub auto_photoupdate {
4943: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4944: my $homeserver = &homeserver($cnum,$dom);
4945: my $host=&hostname($homeserver);
4946: my $cmd = '';
4947: my $maxtries = 1;
4948: foreach my $affiliate (keys(%{$affiliatesref})) {
4949: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4950: }
4951: $cmd =~ s/%%$//;
4952: $cmd = &escape($cmd);
4953: my $query = 'institutionalphotos';
4954: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4955: unless ($queryid=~/^\Q$host\E\_/) {
4956: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4957: return 'error: '.$queryid;
4958: }
4959: my $reply = &get_query_reply($queryid);
4960: my $tries = 1;
4961: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4962: $reply = &get_query_reply($queryid);
4963: $tries ++;
4964: }
4965: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4966: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4967: } else {
4968: my @responses = split(/:/,$reply);
4969: my $outcome = shift(@responses);
4970: foreach my $item (@responses) {
4971: my ($key,$value) = split(/=/,$item);
4972: $$photo{$key} = $value;
4973: }
4974: return $outcome;
4975: }
4976: return 'error';
4977: }
4978:
4979: sub auto_instcode_format {
4980: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4981: $cat_order) = @_;
4982: my $courses = '';
4983: my @homeservers;
4984: if ($caller eq 'global') {
4985: my %servers = &get_servers($codedom,'library');
4986: foreach my $tryserver (keys(%servers)) {
4987: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4988: push(@homeservers,$tryserver);
4989: }
4990: }
4991: } else {
4992: push(@homeservers,&homeserver($caller,$codedom));
4993: }
4994: foreach my $code (keys(%{$instcodes})) {
4995: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4996: }
4997: chop($courses);
4998: my $ok_response = 0;
4999: my $response;
5000: while (@homeservers > 0 && $ok_response == 0) {
5001: my $server = shift(@homeservers);
5002: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5003: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5004: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5005: split(/:/,$response);
5006: %{$codes} = (%{$codes},&str2hash($codes_str));
5007: push(@{$codetitles},&str2array($codetitles_str));
5008: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5009: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5010: $ok_response = 1;
5011: }
5012: }
5013: if ($ok_response) {
5014: return 'ok';
5015: } else {
5016: return $response;
5017: }
5018: }
5019:
5020: sub auto_instcode_defaults {
5021: my ($domain,$returnhash,$code_order) = @_;
5022: my @homeservers;
5023:
5024: my %servers = &get_servers($domain,'library');
5025: foreach my $tryserver (keys(%servers)) {
5026: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5027: push(@homeservers,$tryserver);
5028: }
5029: }
5030:
5031: my $response;
5032: foreach my $server (@homeservers) {
5033: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5034: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5035:
5036: foreach my $pair (split(/\&/,$response)) {
5037: my ($name,$value)=split(/\=/,$pair);
5038: if ($name eq 'code_order') {
5039: @{$code_order} = split(/\&/,&unescape($value));
5040: } else {
5041: $returnhash->{&unescape($name)}=&unescape($value);
5042: }
5043: }
5044: return 'ok';
5045: }
5046:
5047: return $response;
5048: }
5049:
5050: sub auto_validate_class_sec {
5051: my ($cdom,$cnum,$owners,$inst_class) = @_;
5052: my $homeserver = &homeserver($cnum,$cdom);
5053: my $ownerlist;
5054: if (ref($owners) eq 'ARRAY') {
5055: $ownerlist = join(',',@{$owners});
5056: } else {
5057: $ownerlist = $owners;
5058: }
5059: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
5060: &escape($ownerlist).':'.$cdom,$homeserver);
5061: return $response;
5062: }
5063:
5064: # ------------------------------------------------------- Course Group routines
5065:
5066: sub get_coursegroups {
5067: my ($cdom,$cnum,$group,$namespace) = @_;
5068: return(&dump($namespace,$cdom,$cnum,$group));
5069: }
5070:
5071: sub modify_coursegroup {
5072: my ($cdom,$cnum,$groupsettings) = @_;
5073: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
5074: }
5075:
5076: sub toggle_coursegroup_status {
5077: my ($cdom,$cnum,$group,$action) = @_;
5078: my ($from_namespace,$to_namespace);
5079: if ($action eq 'delete') {
5080: $from_namespace = 'coursegroups';
5081: $to_namespace = 'deleted_groups';
5082: } else {
5083: $from_namespace = 'deleted_groups';
5084: $to_namespace = 'coursegroups';
5085: }
5086: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
5087: if (my $tmp = &error(%curr_group)) {
5088: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
5089: return ('read error',$tmp);
5090: } else {
5091: my %savedsettings = %curr_group;
5092: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
5093: my $deloutcome;
5094: if ($result eq 'ok') {
5095: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
5096: } else {
5097: return ('write error',$result);
5098: }
5099: if ($deloutcome eq 'ok') {
5100: return 'ok';
5101: } else {
5102: return ('delete error',$deloutcome);
5103: }
5104: }
5105: }
5106:
5107: sub modify_group_roles {
5108: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
5109: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
5110: my $role = 'gr/'.&escape($userprivs);
5111: my ($uname,$udom) = split(/:/,$user);
5112: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
5113: if ($result eq 'ok') {
5114: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
5115: }
5116: return $result;
5117: }
5118:
5119: sub modify_coursegroup_membership {
5120: my ($cdom,$cnum,$membership) = @_;
5121: my $result = &put('groupmembership',$membership,$cdom,$cnum);
5122: return $result;
5123: }
5124:
5125: sub get_active_groups {
5126: my ($udom,$uname,$cdom,$cnum) = @_;
5127: my $now = time;
5128: my %groups = ();
5129: foreach my $key (keys(%env)) {
5130: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
5131: my ($start,$end) = split(/\./,$env{$key});
5132: if (($end!=0) && ($end<$now)) { next; }
5133: if (($start!=0) && ($start>$now)) { next; }
5134: if ($1 eq $cdom && $2 eq $cnum) {
5135: $groups{$3} = $env{$key} ;
5136: }
5137: }
5138: }
5139: return %groups;
5140: }
5141:
5142: sub get_group_membership {
5143: my ($cdom,$cnum,$group) = @_;
5144: return(&dump('groupmembership',$cdom,$cnum,$group));
5145: }
5146:
5147: sub get_users_groups {
5148: my ($udom,$uname,$courseid) = @_;
5149: my @usersgroups;
5150: my $cachetime=1800;
5151:
5152: my $hashid="$udom:$uname:$courseid";
5153: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
5154: if (defined($cached)) {
5155: @usersgroups = split(/:/,$grouplist);
5156: } else {
5157: $grouplist = '';
5158: my $courseurl = &courseid_to_courseurl($courseid);
5159: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
5160: my $access_end = $env{'course.'.$courseid.
5161: '.default_enrollment_end_date'};
5162: my $now = time;
5163: foreach my $key (keys(%roleshash)) {
5164: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
5165: my $group = $1;
5166: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
5167: my $start = $2;
5168: my $end = $1;
5169: if ($start == -1) { next; } # deleted from group
5170: if (($start!=0) && ($start>$now)) { next; }
5171: if (($end!=0) && ($end<$now)) {
5172: if ($access_end && $access_end < $now) {
5173: if ($access_end - $end < 86400) {
5174: push(@usersgroups,$group);
5175: }
5176: }
5177: next;
5178: }
5179: push(@usersgroups,$group);
5180: }
5181: }
5182: }
5183: @usersgroups = &sort_course_groups($courseid,@usersgroups);
5184: $grouplist = join(':',@usersgroups);
5185: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
5186: }
5187: return @usersgroups;
5188: }
5189:
5190: sub devalidate_getgroups_cache {
5191: my ($udom,$uname,$cdom,$cnum)=@_;
5192: my $courseid = $cdom.'_'.$cnum;
5193:
5194: my $hashid="$udom:$uname:$courseid";
5195: &devalidate_cache_new('getgroups',$hashid);
5196: }
5197:
5198: # ------------------------------------------------------------------ Plain Text
5199:
5200: sub plaintext {
5201: my ($short,$type,$cid) = @_;
5202: if ($short =~ /^cr/) {
5203: return (split('/',$short))[-1];
5204: }
5205: if (!defined($cid)) {
5206: $cid = $env{'request.course.id'};
5207: }
5208: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
5209: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
5210: '.plaintext'});
5211: }
5212: my %rolenames = (
5213: Course => 'std',
5214: Group => 'alt1',
5215: );
5216: if (defined($type) &&
5217: defined($rolenames{$type}) &&
5218: defined($prp{$short}{$rolenames{$type}})) {
5219: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
5220: } else {
5221: return &Apache::lonlocal::mt($prp{$short}{'std'});
5222: }
5223: }
5224:
5225: # ----------------------------------------------------------------- Assign Role
5226:
5227: sub assignrole {
5228: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
5229: my $mrole;
5230: if ($role =~ /^cr\//) {
5231: my $cwosec=$url;
5232: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5233: unless (&allowed('ccr',$cwosec)) {
5234: &logthis('Refused custom assignrole: '.
5235: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5236: $env{'user.name'}.' at '.$env{'user.domain'});
5237: return 'refused';
5238: }
5239: $mrole='cr';
5240: } elsif ($role =~ /^gr\//) {
5241: my $cwogrp=$url;
5242: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
5243: unless (&allowed('mdg',$cwogrp)) {
5244: &logthis('Refused group assignrole: '.
5245: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5246: $env{'user.name'}.' at '.$env{'user.domain'});
5247: return 'refused';
5248: }
5249: $mrole='gr';
5250: } else {
5251: my $cwosec=$url;
5252: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
5253: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
5254: &logthis('Refused assignrole: '.
5255: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
5256: $env{'user.name'}.' at '.$env{'user.domain'});
5257: return 'refused';
5258: }
5259: $mrole=$role;
5260: }
5261: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5262: "$udom:$uname:$url".'_'."$mrole=$role";
5263: if ($end) { $command.='_'.$end; }
5264: if ($start) {
5265: if ($end) {
5266: $command.='_'.$start;
5267: } else {
5268: $command.='_0_'.$start;
5269: }
5270: }
5271: my $origstart = $start;
5272: my $origend = $end;
5273: # actually delete
5274: if ($deleteflag) {
5275: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
5276: # modify command to delete the role
5277: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
5278: "$udom:$uname:$url".'_'."$mrole";
5279: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
5280: # set start and finish to negative values for userrolelog
5281: $start=-1;
5282: $end=-1;
5283: }
5284: }
5285: # send command
5286: my $answer=&reply($command,&homeserver($uname,$udom));
5287: # log new user role if status is ok
5288: if ($answer eq 'ok') {
5289: &userrolelog($role,$uname,$udom,$url,$start,$end);
5290: # for course roles, perform group memberships changes triggered by role change.
5291: unless ($role =~ /^gr/) {
5292: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
5293: $origstart);
5294: }
5295: }
5296: return $answer;
5297: }
5298:
5299: # -------------------------------------------------- Modify user authentication
5300: # Overrides without validation
5301:
5302: sub modifyuserauth {
5303: my ($udom,$uname,$umode,$upass)=@_;
5304: my $uhome=&homeserver($uname,$udom);
5305: unless (&allowed('mau',$udom)) { return 'refused'; }
5306: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
5307: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5308: ' in domain '.$env{'request.role.domain'});
5309: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
5310: &escape($upass),$uhome);
5311: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
5312: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
5313: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5314: &log($udom,,$uname,$uhome,
5315: 'Authentication changed by '.$env{'user.domain'}.', '.
5316: $env{'user.name'}.', '.$umode.
5317: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
5318: unless ($reply eq 'ok') {
5319: &logthis('Authentication mode error: '.$reply);
5320: return 'error: '.$reply;
5321: }
5322: return 'ok';
5323: }
5324:
5325: # --------------------------------------------------------------- Modify a user
5326:
5327: sub modifyuser {
5328: my ($udom, $uname, $uid,
5329: $umode, $upass, $first,
5330: $middle, $last, $gene,
5331: $forceid, $desiredhome, $email)=@_;
5332: $udom= &LONCAPA::clean_domain($udom);
5333: $uname=&LONCAPA::clean_username($uname);
5334: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
5335: $umode.', '.$first.', '.$middle.', '.
5336: $last.', '.$gene.'(forceid: '.$forceid.')'.
5337: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
5338: ' desiredhome not specified').
5339: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
5340: ' in domain '.$env{'request.role.domain'});
5341: my $uhome=&homeserver($uname,$udom,'true');
5342: # ----------------------------------------------------------------- Create User
5343: if (($uhome eq 'no_host') &&
5344: (($umode && $upass) || ($umode eq 'localauth'))) {
5345: my $unhome='';
5346: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
5347: $unhome = $desiredhome;
5348: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
5349: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
5350: } else { # load balancing routine for determining $unhome
5351: my $loadm=10000000;
5352: my %servers = &get_servers($udom,'library');
5353: foreach my $tryserver (keys(%servers)) {
5354: my $answer=reply('load',$tryserver);
5355: if (($answer=~/\d+/) && ($answer<$loadm)) {
5356: $loadm=$answer;
5357: $unhome=$tryserver;
5358: }
5359: }
5360: }
5361: if (($unhome eq '') || ($unhome eq 'no_host')) {
5362: return 'error: unable to find a home server for '.$uname.
5363: ' in domain '.$udom;
5364: }
5365: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
5366: &escape($upass),$unhome);
5367: unless ($reply eq 'ok') {
5368: return 'error: '.$reply;
5369: }
5370: $uhome=&homeserver($uname,$udom,'true');
5371: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
5372: return 'error: unable verify users home machine.';
5373: }
5374: } # End of creation of new user
5375: # ---------------------------------------------------------------------- Add ID
5376: if ($uid) {
5377: $uid=~tr/A-Z/a-z/;
5378: my %uidhash=&idrget($udom,$uname);
5379: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
5380: && (!$forceid)) {
5381: unless ($uid eq $uidhash{$uname}) {
5382: return 'error: user id "'.$uid.'" does not match '.
5383: 'current user id "'.$uidhash{$uname}.'".';
5384: }
5385: } else {
5386: &idput($udom,($uname => $uid));
5387: }
5388: }
5389: # -------------------------------------------------------------- Add names, etc
5390: my @tmp=&get('environment',
5391: ['firstname','middlename','lastname','generation','id',
5392: 'permanentemail'],
5393: $udom,$uname);
5394: my %names;
5395: if ($tmp[0] =~ m/^error:.*/) {
5396: %names=();
5397: } else {
5398: %names = @tmp;
5399: }
5400: #
5401: # Make sure to not trash student environment if instructor does not bother
5402: # to supply name and email information
5403: #
5404: if ($first) { $names{'firstname'} = $first; }
5405: if (defined($middle)) { $names{'middlename'} = $middle; }
5406: if ($last) { $names{'lastname'} = $last; }
5407: if (defined($gene)) { $names{'generation'} = $gene; }
5408: if ($email) {
5409: $email=~s/[^\w\@\.\-\,]//gs;
5410: if ($email=~/\@/) { $names{'notification'} = $email;
5411: $names{'critnotification'} = $email;
5412: $names{'permanentemail'} = $email; }
5413: }
5414: if ($uid) { $names{'id'} = $uid; }
5415: my $reply = &put('environment', \%names, $udom,$uname);
5416: if ($reply ne 'ok') { return 'error: '.$reply; }
5417: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
5418: &devalidate_cache_new('namescache',$uname.':'.$udom);
5419: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
5420: $umode.', '.$first.', '.$middle.', '.
5421: $last.', '.$gene.' by '.
5422: $env{'user.name'}.' at '.$env{'user.domain'});
5423: return 'ok';
5424: }
5425:
5426: # -------------------------------------------------------------- Modify student
5427:
5428: sub modifystudent {
5429: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
5430: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
5431: if (!$cid) {
5432: unless ($cid=$env{'request.course.id'}) {
5433: return 'not_in_class';
5434: }
5435: }
5436: # --------------------------------------------------------------- Make the user
5437: my $reply=&modifyuser
5438: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
5439: $desiredhome,$email);
5440: unless ($reply eq 'ok') { return $reply; }
5441: # This will cause &modify_student_enrollment to get the uid from the
5442: # students environment
5443: $uid = undef if (!$forceid);
5444: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
5445: $gene,$usec,$end,$start,$type,$locktype,$cid);
5446: return $reply;
5447: }
5448:
5449: sub modify_student_enrollment {
5450: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
5451: my ($cdom,$cnum,$chome);
5452: if (!$cid) {
5453: unless ($cid=$env{'request.course.id'}) {
5454: return 'not_in_class';
5455: }
5456: $cdom=$env{'course.'.$cid.'.domain'};
5457: $cnum=$env{'course.'.$cid.'.num'};
5458: } else {
5459: ($cdom,$cnum)=split(/_/,$cid);
5460: }
5461: $chome=$env{'course.'.$cid.'.home'};
5462: if (!$chome) {
5463: $chome=&homeserver($cnum,$cdom);
5464: }
5465: if (!$chome) { return 'unknown_course'; }
5466: # Make sure the user exists
5467: my $uhome=&homeserver($uname,$udom);
5468: if (($uhome eq '') || ($uhome eq 'no_host')) {
5469: return 'error: no such user';
5470: }
5471: # Get student data if we were not given enough information
5472: if (!defined($first) || $first eq '' ||
5473: !defined($last) || $last eq '' ||
5474: !defined($uid) || $uid eq '' ||
5475: !defined($middle) || $middle eq '' ||
5476: !defined($gene) || $gene eq '') {
5477: # They did not supply us with enough data to enroll the student, so
5478: # we need to pick up more information.
5479: my %tmp = &get('environment',
5480: ['firstname','middlename','lastname', 'generation','id']
5481: ,$udom,$uname);
5482:
5483: #foreach my $key (keys(%tmp)) {
5484: # &logthis("key $key = ".$tmp{$key});
5485: #}
5486: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
5487: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
5488: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
5489: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
5490: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
5491: }
5492: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
5493: my $reply=cput('classlist',
5494: {"$uname:$udom" =>
5495: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
5496: $cdom,$cnum);
5497: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
5498: return 'error: '.$reply;
5499: } else {
5500: &devalidate_getsection_cache($udom,$uname,$cid);
5501: }
5502: # Add student role to user
5503: my $uurl='/'.$cid;
5504: $uurl=~s/\_/\//g;
5505: if ($usec) {
5506: $uurl.='/'.$usec;
5507: }
5508: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
5509: }
5510:
5511: sub format_name {
5512: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
5513: my $name;
5514: if ($first ne 'lastname') {
5515: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
5516: } else {
5517: if ($lastname=~/\S/) {
5518: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
5519: $name=~s/\s+,/,/;
5520: } else {
5521: $name.= $firstname.' '.$middlename.' '.$generation;
5522: }
5523: }
5524: $name=~s/^\s+//;
5525: $name=~s/\s+$//;
5526: $name=~s/\s+/ /g;
5527: return $name;
5528: }
5529:
5530: # ------------------------------------------------- Write to course preferences
5531:
5532: sub writecoursepref {
5533: my ($courseid,%prefs)=@_;
5534: $courseid=~s/^\///;
5535: $courseid=~s/\_/\//g;
5536: my ($cdomain,$cnum)=split(/\//,$courseid);
5537: my $chome=homeserver($cnum,$cdomain);
5538: if (($chome eq '') || ($chome eq 'no_host')) {
5539: return 'error: no such course';
5540: }
5541: my $cstring='';
5542: foreach my $pref (keys(%prefs)) {
5543: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
5544: }
5545: $cstring=~s/\&$//;
5546: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
5547: }
5548:
5549: # ---------------------------------------------------------- Make/modify course
5550:
5551: sub createcourse {
5552: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
5553: $course_owner,$crstype)=@_;
5554: $url=&declutter($url);
5555: my $cid='';
5556: unless (&allowed('ccc',$udom)) {
5557: return 'refused';
5558: }
5559: # ------------------------------------------------------------------- Create ID
5560: my $uname=int(1+rand(9)).
5561: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
5562: substr($$.time,0,5).unpack("H8",pack("I32",time)).
5563: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5564: # ----------------------------------------------- Make sure that does not exist
5565: my $uhome=&homeserver($uname,$udom,'true');
5566: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5567: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
5568: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
5569: $uhome=&homeserver($uname,$udom,'true');
5570: unless (($uhome eq '') || ($uhome eq 'no_host')) {
5571: return 'error: unable to generate unique course-ID';
5572: }
5573: }
5574: # ------------------------------------------------ Check supplied server name
5575: $course_server = $env{'user.homeserver'} if (! defined($course_server));
5576: if (! &is_library($course_server)) {
5577: return 'error:bad server name '.$course_server;
5578: }
5579: # ------------------------------------------------------------- Make the course
5580: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
5581: $course_server);
5582: unless ($reply eq 'ok') { return 'error: '.$reply; }
5583: $uhome=&homeserver($uname,$udom,'true');
5584: if (($uhome eq '') || ($uhome eq 'no_host')) {
5585: return 'error: no such course';
5586: }
5587: # ----------------------------------------------------------------- Course made
5588: # log existence
5589: my $newcourse = {
5590: $udom.'_'.$uname => {
5591: description => $description,
5592: inst_code => $inst_code,
5593: owner => $course_owner,
5594: type => $crstype,
5595: },
5596: };
5597: &courseidput($udom,$newcourse,$uhome,'notime');
5598: # set toplevel url
5599: my $topurl=$url;
5600: unless ($nonstandard) {
5601: # ------------------------------------------ For standard courses, make top url
5602: my $mapurl=&clutter($url);
5603: if ($mapurl eq '/res/') { $mapurl=''; }
5604: $env{'form.initmap'}=(<<ENDINITMAP);
5605: <map>
5606: <resource id="1" type="start"></resource>
5607: <resource id="2" src="$mapurl"></resource>
5608: <resource id="3" type="finish"></resource>
5609: <link index="1" from="1" to="2"></link>
5610: <link index="2" from="2" to="3"></link>
5611: </map>
5612: ENDINITMAP
5613: $topurl=&declutter(
5614: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
5615: );
5616: }
5617: # ----------------------------------------------------------- Write preferences
5618: &writecoursepref($udom.'_'.$uname,
5619: ('description' => $description,
5620: 'url' => $topurl));
5621: return '/'.$udom.'/'.$uname;
5622: }
5623:
5624: sub is_course {
5625: my ($cdom,$cnum) = @_;
5626: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
5627: undef,'.',undef,1);
5628: if (exists($courses{$cdom.'_'.$cnum})) {
5629: return 1;
5630: }
5631: return 0;
5632: }
5633:
5634: # ---------------------------------------------------------- Assign Custom Role
5635:
5636: sub assigncustomrole {
5637: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
5638: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
5639: $end,$start,$deleteflag);
5640: }
5641:
5642: # ----------------------------------------------------------------- Revoke Role
5643:
5644: sub revokerole {
5645: my ($udom,$uname,$url,$role,$deleteflag)=@_;
5646: my $now=time;
5647: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
5648: }
5649:
5650: # ---------------------------------------------------------- Revoke Custom Role
5651:
5652: sub revokecustomrole {
5653: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
5654: my $now=time;
5655: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
5656: $deleteflag);
5657: }
5658:
5659: # ------------------------------------------------------------ Disk usage
5660: sub diskusage {
5661: my ($udom,$uname,$directoryRoot)=@_;
5662: $directoryRoot =~ s/\/$//;
5663: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
5664: return $listing;
5665: }
5666:
5667: sub is_locked {
5668: my ($file_name, $domain, $user) = @_;
5669: my @check;
5670: my $is_locked;
5671: push @check, $file_name;
5672: my %locked = &get('file_permissions',\@check,
5673: $env{'user.domain'},$env{'user.name'});
5674: my ($tmp)=keys(%locked);
5675: if ($tmp=~/^error:/) { undef(%locked); }
5676:
5677: if (ref($locked{$file_name}) eq 'ARRAY') {
5678: $is_locked = 'false';
5679: foreach my $entry (@{$locked{$file_name}}) {
5680: if (ref($entry) eq 'ARRAY') {
5681: $is_locked = 'true';
5682: last;
5683: }
5684: }
5685: } else {
5686: $is_locked = 'false';
5687: }
5688: }
5689:
5690: sub declutter_portfile {
5691: my ($file) = @_;
5692: $file =~ s{^(/portfolio/|portfolio/)}{/};
5693: return $file;
5694: }
5695:
5696: # ------------------------------------------------------------- Mark as Read Only
5697:
5698: sub mark_as_readonly {
5699: my ($domain,$user,$files,$what) = @_;
5700: my %current_permissions = &dump('file_permissions',$domain,$user);
5701: my ($tmp)=keys(%current_permissions);
5702: if ($tmp=~/^error:/) { undef(%current_permissions); }
5703: foreach my $file (@{$files}) {
5704: $file = &declutter_portfile($file);
5705: push(@{$current_permissions{$file}},$what);
5706: }
5707: &put('file_permissions',\%current_permissions,$domain,$user);
5708: return;
5709: }
5710:
5711: # ------------------------------------------------------------Save Selected Files
5712:
5713: sub save_selected_files {
5714: my ($user, $path, @files) = @_;
5715: my $filename = $user."savedfiles";
5716: my @other_files = &files_not_in_path($user, $path);
5717: open (OUT, '>'.$tmpdir.$filename);
5718: foreach my $file (@files) {
5719: print (OUT $env{'form.currentpath'}.$file."\n");
5720: }
5721: foreach my $file (@other_files) {
5722: print (OUT $file."\n");
5723: }
5724: close (OUT);
5725: return 'ok';
5726: }
5727:
5728: sub clear_selected_files {
5729: my ($user) = @_;
5730: my $filename = $user."savedfiles";
5731: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5732: print (OUT undef);
5733: close (OUT);
5734: return ("ok");
5735: }
5736:
5737: sub files_in_path {
5738: my ($user, $path) = @_;
5739: my $filename = $user."savedfiles";
5740: my %return_files;
5741: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5742: while (my $line_in = <IN>) {
5743: chomp ($line_in);
5744: my @paths_and_file = split (m!/!, $line_in);
5745: my $file_part = pop (@paths_and_file);
5746: my $path_part = join ('/', @paths_and_file);
5747: $path_part.='/';
5748: my $path_and_file = $path_part.$file_part;
5749: if ($path_part eq $path) {
5750: $return_files{$file_part}= 'selected';
5751: }
5752: }
5753: close (IN);
5754: return (\%return_files);
5755: }
5756:
5757: # called in portfolio select mode, to show files selected NOT in current directory
5758: sub files_not_in_path {
5759: my ($user, $path) = @_;
5760: my $filename = $user."savedfiles";
5761: my @return_files;
5762: my $path_part;
5763: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5764: while (my $line = <IN>) {
5765: #ok, I know it's clunky, but I want it to work
5766: my @paths_and_file = split(m|/|, $line);
5767: my $file_part = pop(@paths_and_file);
5768: chomp($file_part);
5769: my $path_part = join('/', @paths_and_file);
5770: $path_part .= '/';
5771: my $path_and_file = $path_part.$file_part;
5772: if ($path_part ne $path) {
5773: push(@return_files, ($path_and_file));
5774: }
5775: }
5776: close(OUT);
5777: return (@return_files);
5778: }
5779:
5780: #----------------------------------------------Get portfolio file permissions
5781:
5782: sub get_portfile_permissions {
5783: my ($domain,$user) = @_;
5784: my %current_permissions = &dump('file_permissions',$domain,$user);
5785: my ($tmp)=keys(%current_permissions);
5786: if ($tmp=~/^error:/) { undef(%current_permissions); }
5787: return \%current_permissions;
5788: }
5789:
5790: #---------------------------------------------Get portfolio file access controls
5791:
5792: sub get_access_controls {
5793: my ($current_permissions,$group,$file) = @_;
5794: my %access;
5795: my $real_file = $file;
5796: $file =~ s/\.meta$//;
5797: if (defined($file)) {
5798: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5799: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5800: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5801: }
5802: }
5803: } else {
5804: foreach my $key (keys(%{$current_permissions})) {
5805: if ($key =~ /\0accesscontrol$/) {
5806: if (defined($group)) {
5807: if ($key !~ m-^\Q$group\E/-) {
5808: next;
5809: }
5810: }
5811: my ($fullpath) = split(/\0/,$key);
5812: if (ref($$current_permissions{$key}) eq 'HASH') {
5813: foreach my $control (keys(%{$$current_permissions{$key}})) {
5814: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5815: }
5816: }
5817: }
5818: }
5819: }
5820: return %access;
5821: }
5822:
5823: sub modify_access_controls {
5824: my ($file_name,$changes,$domain,$user)=@_;
5825: my ($outcome,$deloutcome);
5826: my %store_permissions;
5827: my %new_values;
5828: my %new_control;
5829: my %translation;
5830: my @deletions = ();
5831: my $now = time;
5832: if (exists($$changes{'activate'})) {
5833: if (ref($$changes{'activate'}) eq 'HASH') {
5834: my @newitems = sort(keys(%{$$changes{'activate'}}));
5835: my $numnew = scalar(@newitems);
5836: for (my $i=0; $i<$numnew; $i++) {
5837: my $newkey = $newitems[$i];
5838: my $newid = &Apache::loncommon::get_cgi_id();
5839: if ($newkey =~ /^\d+:/) {
5840: $newkey =~ s/^(\d+)/$newid/;
5841: $translation{$1} = $newid;
5842: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5843: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5844: $translation{$1} = $newid;
5845: }
5846: $new_values{$file_name."\0".$newkey} =
5847: $$changes{'activate'}{$newitems[$i]};
5848: $new_control{$newkey} = $now;
5849: }
5850: }
5851: }
5852: my %todelete;
5853: my %changed_items;
5854: foreach my $action ('delete','update') {
5855: if (exists($$changes{$action})) {
5856: if (ref($$changes{$action}) eq 'HASH') {
5857: foreach my $key (keys(%{$$changes{$action}})) {
5858: my ($itemnum) = ($key =~ /^([^:]+):/);
5859: if ($action eq 'delete') {
5860: $todelete{$itemnum} = 1;
5861: } else {
5862: $changed_items{$itemnum} = $key;
5863: }
5864: }
5865: }
5866: }
5867: }
5868: # get lock on access controls for file.
5869: my $lockhash = {
5870: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5871: ':'.$env{'user.domain'},
5872: };
5873: my $tries = 0;
5874: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5875:
5876: while (($gotlock ne 'ok') && $tries <3) {
5877: $tries ++;
5878: sleep 1;
5879: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5880: }
5881: if ($gotlock eq 'ok') {
5882: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5883: my ($tmp)=keys(%curr_permissions);
5884: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5885: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5886: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5887: if (ref($curr_controls) eq 'HASH') {
5888: foreach my $control_item (keys(%{$curr_controls})) {
5889: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5890: if (defined($todelete{$itemnum})) {
5891: push(@deletions,$file_name."\0".$control_item);
5892: } else {
5893: if (defined($changed_items{$itemnum})) {
5894: $new_control{$changed_items{$itemnum}} = $now;
5895: push(@deletions,$file_name."\0".$control_item);
5896: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5897: } else {
5898: $new_control{$control_item} = $$curr_controls{$control_item};
5899: }
5900: }
5901: }
5902: }
5903: }
5904: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5905: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5906: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5907: # remove lock
5908: my @del_lock = ($file_name."\0".'locked_access_records');
5909: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5910: my ($file,$group);
5911: if (&is_course($domain,$user)) {
5912: ($group,$file) = split(/\//,$file_name,2);
5913: } else {
5914: $file = $file_name;
5915: }
5916: my $sqlresult =
5917: &update_portfolio_table($user,$domain,$file,'portfolio_access',
5918: $group);
5919: } else {
5920: $outcome = "error: could not obtain lockfile\n";
5921: }
5922: return ($outcome,$deloutcome,\%new_values,\%translation);
5923: }
5924:
5925: sub make_public_indefinitely {
5926: my ($requrl) = @_;
5927: my $now = time;
5928: my $action = 'activate';
5929: my $aclnum = 0;
5930: if (&is_portfolio_url($requrl)) {
5931: my (undef,$udom,$unum,$file_name,$group) =
5932: &parse_portfolio_url($requrl);
5933: my $current_perms = &get_portfile_permissions($udom,$unum);
5934: my %access_controls = &get_access_controls($current_perms,
5935: $group,$file_name);
5936: foreach my $key (keys(%{$access_controls{$file_name}})) {
5937: my ($num,$scope,$end,$start) =
5938: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5939: if ($scope eq 'public') {
5940: if ($start <= $now && $end == 0) {
5941: $action = 'none';
5942: } else {
5943: $action = 'update';
5944: $aclnum = $num;
5945: }
5946: last;
5947: }
5948: }
5949: if ($action eq 'none') {
5950: return 'ok';
5951: } else {
5952: my %changes;
5953: my $newend = 0;
5954: my $newstart = $now;
5955: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
5956: $changes{$action}{$newkey} = {
5957: type => 'public',
5958: time => {
5959: start => $newstart,
5960: end => $newend,
5961: },
5962: };
5963: my ($outcome,$deloutcome,$new_values,$translation) =
5964: &modify_access_controls($file_name,\%changes,$udom,$unum);
5965: return $outcome;
5966: }
5967: } else {
5968: return 'invalid';
5969: }
5970: }
5971:
5972: #------------------------------------------------------Get Marked as Read Only
5973:
5974: sub get_marked_as_readonly {
5975: my ($domain,$user,$what,$group) = @_;
5976: my $current_permissions = &get_portfile_permissions($domain,$user);
5977: my @readonly_files;
5978: my $cmp1=$what;
5979: if (ref($what)) { $cmp1=join('',@{$what}) };
5980: while (my ($file_name,$value) = each(%{$current_permissions})) {
5981: if (defined($group)) {
5982: if ($file_name !~ m-^\Q$group\E/-) {
5983: next;
5984: }
5985: }
5986: if (ref($value) eq "ARRAY"){
5987: foreach my $stored_what (@{$value}) {
5988: my $cmp2=$stored_what;
5989: if (ref($stored_what) eq 'ARRAY') {
5990: $cmp2=join('',@{$stored_what});
5991: }
5992: if ($cmp1 eq $cmp2) {
5993: push(@readonly_files, $file_name);
5994: last;
5995: } elsif (!defined($what)) {
5996: push(@readonly_files, $file_name);
5997: last;
5998: }
5999: }
6000: }
6001: }
6002: return @readonly_files;
6003: }
6004: #-----------------------------------------------------------Get Marked as Read Only Hash
6005:
6006: sub get_marked_as_readonly_hash {
6007: my ($current_permissions,$group,$what) = @_;
6008: my %readonly_files;
6009: while (my ($file_name,$value) = each(%{$current_permissions})) {
6010: if (defined($group)) {
6011: if ($file_name !~ m-^\Q$group\E/-) {
6012: next;
6013: }
6014: }
6015: if (ref($value) eq "ARRAY"){
6016: foreach my $stored_what (@{$value}) {
6017: if (ref($stored_what) eq 'ARRAY') {
6018: foreach my $lock_descriptor(@{$stored_what}) {
6019: if ($lock_descriptor eq 'graded') {
6020: $readonly_files{$file_name} = 'graded';
6021: } elsif ($lock_descriptor eq 'handback') {
6022: $readonly_files{$file_name} = 'handback';
6023: } else {
6024: if (!exists($readonly_files{$file_name})) {
6025: $readonly_files{$file_name} = 'locked';
6026: }
6027: }
6028: }
6029: }
6030: }
6031: }
6032: }
6033: return %readonly_files;
6034: }
6035: # ------------------------------------------------------------ Unmark as Read Only
6036:
6037: sub unmark_as_readonly {
6038: # unmarks $file_name (if $file_name is defined), or all files locked by $what
6039: # for portfolio submissions, $what contains [$symb,$crsid]
6040: my ($domain,$user,$what,$file_name,$group) = @_;
6041: $file_name = &declutter_portfile($file_name);
6042: my $symb_crs = $what;
6043: if (ref($what)) { $symb_crs=join('',@$what); }
6044: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
6045: my ($tmp)=keys(%current_permissions);
6046: if ($tmp=~/^error:/) { undef(%current_permissions); }
6047: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
6048: foreach my $file (@readonly_files) {
6049: my $clean_file = &declutter_portfile($file);
6050: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
6051: my $current_locks = $current_permissions{$file};
6052: my @new_locks;
6053: my @del_keys;
6054: if (ref($current_locks) eq "ARRAY"){
6055: foreach my $locker (@{$current_locks}) {
6056: my $compare=$locker;
6057: if (ref($locker) eq 'ARRAY') {
6058: $compare=join('',@{$locker});
6059: if ($compare ne $symb_crs) {
6060: push(@new_locks, $locker);
6061: }
6062: }
6063: }
6064: if (scalar(@new_locks) > 0) {
6065: $current_permissions{$file} = \@new_locks;
6066: } else {
6067: push(@del_keys, $file);
6068: &del('file_permissions',\@del_keys, $domain, $user);
6069: delete($current_permissions{$file});
6070: }
6071: }
6072: }
6073: &put('file_permissions',\%current_permissions,$domain,$user);
6074: return;
6075: }
6076:
6077: # ------------------------------------------------------------ Directory lister
6078:
6079: sub dirlist {
6080: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
6081:
6082: $uri=~s/^\///;
6083: $uri=~s/\/$//;
6084: my ($udom, $uname);
6085: (undef,$udom,$uname)=split(/\//,$uri);
6086: if(defined($userdomain)) {
6087: $udom = $userdomain;
6088: }
6089: if(defined($username)) {
6090: $uname = $username;
6091: }
6092:
6093: my $dirRoot = $perlvar{'lonDocRoot'};
6094: if(defined($alternateDirectoryRoot)) {
6095: $dirRoot = $alternateDirectoryRoot;
6096: $dirRoot =~ s/\/$//;
6097: }
6098:
6099: if($udom) {
6100: if($uname) {
6101: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
6102: &homeserver($uname,$udom));
6103: my @listing_results;
6104: if ($listing eq 'unknown_cmd') {
6105: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
6106: &homeserver($uname,$udom));
6107: @listing_results = split(/:/,$listing);
6108: } else {
6109: @listing_results = map { &unescape($_); } split(/:/,$listing);
6110: }
6111: return @listing_results;
6112: } elsif(!defined($alternateDirectoryRoot)) {
6113: my %allusers;
6114: my %servers = &get_servers($udom,'library');
6115: foreach my $tryserver (keys(%servers)) {
6116: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
6117: $udom, $tryserver);
6118: my @listing_results;
6119: if ($listing eq 'unknown_cmd') {
6120: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
6121: $udom, $tryserver);
6122: @listing_results = split(/:/,$listing);
6123: } else {
6124: @listing_results =
6125: map { &unescape($_); } split(/:/,$listing);
6126: }
6127: if ($listing_results[0] ne 'no_such_dir' &&
6128: $listing_results[0] ne 'empty' &&
6129: $listing_results[0] ne 'con_lost') {
6130: foreach my $line (@listing_results) {
6131: my ($entry) = split(/&/,$line,2);
6132: $allusers{$entry} = 1;
6133: }
6134: }
6135: }
6136: my $alluserstr='';
6137: foreach my $user (sort(keys(%allusers))) {
6138: $alluserstr.=$user.'&user:';
6139: }
6140: $alluserstr=~s/:$//;
6141: return split(/:/,$alluserstr);
6142: } else {
6143: return ('missing user name');
6144: }
6145: } elsif(!defined($alternateDirectoryRoot)) {
6146: my @all_domains = sort(&all_domains());
6147: foreach my $domain (@all_domains) {
6148: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
6149: }
6150: return @all_domains;
6151: } else {
6152: return ('missing domain');
6153: }
6154: }
6155:
6156: # --------------------------------------------- GetFileTimestamp
6157: # This function utilizes dirlist and returns the date stamp for
6158: # when it was last modified. It will also return an error of -1
6159: # if an error occurs
6160:
6161: ##
6162: ## FIXME: This subroutine assumes its caller knows something about the
6163: ## directory structure of the home server for the student ($root).
6164: ## Not a good assumption to make. Since this is for looking up files
6165: ## in user directories, the full path should be constructed by lond, not
6166: ## whatever machine we request data from.
6167: ##
6168: sub GetFileTimestamp {
6169: my ($studentDomain,$studentName,$filename,$root)=@_;
6170: $studentDomain = &LONCAPA::clean_domain($studentDomain);
6171: $studentName = &LONCAPA::clean_username($studentName);
6172: my $subdir=$studentName.'__';
6173: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
6174: my $proname="$studentDomain/$subdir/$studentName";
6175: $proname .= '/'.$filename;
6176: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
6177: $studentName, $root);
6178: my @stats = split('&', $fileStat);
6179: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6180: # @stats contains first the filename, then the stat output
6181: return $stats[10]; # so this is 10 instead of 9.
6182: } else {
6183: return -1;
6184: }
6185: }
6186:
6187: sub stat_file {
6188: my ($uri) = @_;
6189: $uri = &clutter_with_no_wrapper($uri);
6190:
6191: my ($udom,$uname,$file,$dir);
6192: if ($uri =~ m-^/(uploaded|editupload)/-) {
6193: ($udom,$uname,$file) =
6194: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
6195: $file = 'userfiles/'.$file;
6196: $dir = &propath($udom,$uname);
6197: }
6198: if ($uri =~ m-^/res/-) {
6199: ($udom,$uname) =
6200: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
6201: $file = $uri;
6202: }
6203:
6204: if (!$udom || !$uname || !$file) {
6205: # unable to handle the uri
6206: return ();
6207: }
6208:
6209: my ($result) = &dirlist($file,$udom,$uname,$dir);
6210: my @stats = split('&', $result);
6211:
6212: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
6213: shift(@stats); #filename is first
6214: return @stats;
6215: }
6216: return ();
6217: }
6218:
6219: # -------------------------------------------------------- Value of a Condition
6220:
6221: # gets the value of a specific preevaluated condition
6222: # stored in the string $env{user.state.<cid>}
6223: # or looks up a condition reference in the bighash and if if hasn't
6224: # already been evaluated recurses into docondval to get the value of
6225: # the condition, then memoizing it to
6226: # $env{user.state.<cid>.<condition>}
6227: sub directcondval {
6228: my $number=shift;
6229: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
6230: &Apache::lonuserstate::evalstate();
6231: }
6232: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
6233: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
6234: } elsif ($number =~ /^_/) {
6235: my $sub_condition;
6236: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6237: &GDBM_READER(),0640)) {
6238: $sub_condition=$bighash{'conditions'.$number};
6239: untie(%bighash);
6240: }
6241: my $value = &docondval($sub_condition);
6242: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
6243: return $value;
6244: }
6245: if ($env{'user.state.'.$env{'request.course.id'}}) {
6246: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
6247: } else {
6248: return 2;
6249: }
6250: }
6251:
6252: # get the collection of conditions for this resource
6253: sub condval {
6254: my $condidx=shift;
6255: my $allpathcond='';
6256: foreach my $cond (split(/\|/,$condidx)) {
6257: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
6258: $allpathcond.=
6259: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
6260: }
6261: }
6262: $allpathcond=~s/\|$//;
6263: return &docondval($allpathcond);
6264: }
6265:
6266: #evaluates an expression of conditions
6267: sub docondval {
6268: my ($allpathcond) = @_;
6269: my $result=0;
6270: if ($env{'request.course.id'}
6271: && defined($allpathcond)) {
6272: my $operand='|';
6273: my @stack;
6274: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
6275: if ($chunk eq '(') {
6276: push @stack,($operand,$result);
6277: } elsif ($chunk eq ')') {
6278: my $before=pop @stack;
6279: if (pop @stack eq '&') {
6280: $result=$result>$before?$before:$result;
6281: } else {
6282: $result=$result>$before?$result:$before;
6283: }
6284: } elsif (($chunk eq '&') || ($chunk eq '|')) {
6285: $operand=$chunk;
6286: } else {
6287: my $new=directcondval($chunk);
6288: if ($operand eq '&') {
6289: $result=$result>$new?$new:$result;
6290: } else {
6291: $result=$result>$new?$result:$new;
6292: }
6293: }
6294: }
6295: }
6296: return $result;
6297: }
6298:
6299: # ---------------------------------------------------- Devalidate courseresdata
6300:
6301: sub devalidatecourseresdata {
6302: my ($coursenum,$coursedomain)=@_;
6303: my $hashid=$coursenum.':'.$coursedomain;
6304: &devalidate_cache_new('courseres',$hashid);
6305: }
6306:
6307:
6308: # --------------------------------------------------- Course Resourcedata Query
6309: #
6310: # Parameters:
6311: # $coursenum - Number of the course.
6312: # $coursedomain - Domain at which the course was created.
6313: # Returns:
6314: # A hash of the course parameters along (I think) with timestamps
6315: # and version info.
6316:
6317: sub get_courseresdata {
6318: my ($coursenum,$coursedomain)=@_;
6319: my $coursehom=&homeserver($coursenum,$coursedomain);
6320: my $hashid=$coursenum.':'.$coursedomain;
6321: my ($result,$cached)=&is_cached_new('courseres',$hashid);
6322: my %dumpreply;
6323: unless (defined($cached)) {
6324: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
6325: $result=\%dumpreply;
6326: my ($tmp) = keys(%dumpreply);
6327: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6328: &do_cache_new('courseres',$hashid,$result,600);
6329: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
6330: return $tmp;
6331: } elsif ($tmp =~ /^(error)/) {
6332: $result=undef;
6333: &do_cache_new('courseres',$hashid,$result,600);
6334: }
6335: }
6336: return $result;
6337: }
6338:
6339: sub devalidateuserresdata {
6340: my ($uname,$udom)=@_;
6341: my $hashid="$udom:$uname";
6342: &devalidate_cache_new('userres',$hashid);
6343: }
6344:
6345: sub get_userresdata {
6346: my ($uname,$udom)=@_;
6347: #most student don\'t have any data set, check if there is some data
6348: if (&EXT_cache_status($udom,$uname)) { return undef; }
6349:
6350: my $hashid="$udom:$uname";
6351: my ($result,$cached)=&is_cached_new('userres',$hashid);
6352: if (!defined($cached)) {
6353: my %resourcedata=&dump('resourcedata',$udom,$uname);
6354: $result=\%resourcedata;
6355: &do_cache_new('userres',$hashid,$result,600);
6356: }
6357: my ($tmp)=keys(%$result);
6358: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
6359: return $result;
6360: }
6361: #error 2 occurs when the .db doesn't exist
6362: if ($tmp!~/error: 2 /) {
6363: &logthis("<font color=\"blue\">WARNING:".
6364: " Trying to get resource data for ".
6365: $uname." at ".$udom.": ".
6366: $tmp."</font>");
6367: } elsif ($tmp=~/error: 2 /) {
6368: #&EXT_cache_set($udom,$uname);
6369: &do_cache_new('userres',$hashid,undef,600);
6370: undef($tmp); # not really an error so don't send it back
6371: }
6372: return $tmp;
6373: }
6374: #----------------------------------------------- resdata - return resource data
6375: # Purpose:
6376: # Return resource data for either users or for a course.
6377: # Parameters:
6378: # $name - Course/user name.
6379: # $domain - Name of the domain the user/course is registered on.
6380: # $type - Type of thing $name is (must be 'course' or 'user'
6381: # @which - Array of names of resources desired.
6382: # Returns:
6383: # The value of the first reasource in @which that is found in the
6384: # resource hash.
6385: # Exceptional Conditions:
6386: # If the $type passed in is not valid (not the string 'course' or
6387: # 'user', an undefined reference is returned.
6388: # If none of the resources are found, an undef is returned
6389: sub resdata {
6390: my ($name,$domain,$type,@which)=@_;
6391: my $result;
6392: if ($type eq 'course') {
6393: $result=&get_courseresdata($name,$domain);
6394: } elsif ($type eq 'user') {
6395: $result=&get_userresdata($name,$domain);
6396: }
6397: if (!ref($result)) { return $result; }
6398: foreach my $item (@which) {
6399: if (defined($result->{$item->[0]})) {
6400: return [$result->{$item->[0]},$item->[1]];
6401: }
6402: }
6403: return undef;
6404: }
6405:
6406: #
6407: # EXT resource caching routines
6408: #
6409:
6410: sub clear_EXT_cache_status {
6411: &delenv('cache.EXT.');
6412: }
6413:
6414: sub EXT_cache_status {
6415: my ($target_domain,$target_user) = @_;
6416: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6417: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
6418: # We know already the user has no data
6419: return 1;
6420: } else {
6421: return 0;
6422: }
6423: }
6424:
6425: sub EXT_cache_set {
6426: my ($target_domain,$target_user) = @_;
6427: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
6428: #&appenv($cachename => time);
6429: }
6430:
6431: # --------------------------------------------------------- Value of a Variable
6432: sub EXT {
6433:
6434: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
6435: unless ($varname) { return ''; }
6436: #get real user name/domain, courseid and symb
6437: my $courseid;
6438: my $publicuser;
6439: if ($symbparm) {
6440: $symbparm=&get_symb_from_alias($symbparm);
6441: }
6442: if (!($uname && $udom)) {
6443: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
6444: if (!$symbparm) { $symbparm=$cursymb; }
6445: } else {
6446: $courseid=$env{'request.course.id'};
6447: }
6448: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
6449: my $rest;
6450: if (defined($therest[0])) {
6451: $rest=join('.',@therest);
6452: } else {
6453: $rest='';
6454: }
6455:
6456: my $qualifierrest=$qualifier;
6457: if ($rest) { $qualifierrest.='.'.$rest; }
6458: my $spacequalifierrest=$space;
6459: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
6460: if ($realm eq 'user') {
6461: # --------------------------------------------------------------- user.resource
6462: if ($space eq 'resource') {
6463: if ( (defined($Apache::lonhomework::parsing_a_problem)
6464: || defined($Apache::lonhomework::parsing_a_task))
6465: &&
6466: ($symbparm eq &symbread()) ) {
6467: # if we are in the middle of processing the resource the
6468: # get the value we are planning on committing
6469: if (defined($Apache::lonhomework::results{$qualifierrest})) {
6470: return $Apache::lonhomework::results{$qualifierrest};
6471: } else {
6472: return $Apache::lonhomework::history{$qualifierrest};
6473: }
6474: } else {
6475: my %restored;
6476: if ($publicuser || $env{'request.state'} eq 'construct') {
6477: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
6478: } else {
6479: %restored=&restore($symbparm,$courseid,$udom,$uname);
6480: }
6481: return $restored{$qualifierrest};
6482: }
6483: # ----------------------------------------------------------------- user.access
6484: } elsif ($space eq 'access') {
6485: # FIXME - not supporting calls for a specific user
6486: return &allowed($qualifier,$rest);
6487: # ------------------------------------------ user.preferences, user.environment
6488: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
6489: if (($uname eq $env{'user.name'}) &&
6490: ($udom eq $env{'user.domain'})) {
6491: return $env{join('.',('environment',$qualifierrest))};
6492: } else {
6493: my %returnhash;
6494: if (!$publicuser) {
6495: %returnhash=&userenvironment($udom,$uname,
6496: $qualifierrest);
6497: }
6498: return $returnhash{$qualifierrest};
6499: }
6500: # ----------------------------------------------------------------- user.course
6501: } elsif ($space eq 'course') {
6502: # FIXME - not supporting calls for a specific user
6503: return $env{join('.',('request.course',$qualifier))};
6504: # ------------------------------------------------------------------- user.role
6505: } elsif ($space eq 'role') {
6506: # FIXME - not supporting calls for a specific user
6507: my ($role,$where)=split(/\./,$env{'request.role'});
6508: if ($qualifier eq 'value') {
6509: return $role;
6510: } elsif ($qualifier eq 'extent') {
6511: return $where;
6512: }
6513: # ----------------------------------------------------------------- user.domain
6514: } elsif ($space eq 'domain') {
6515: return $udom;
6516: # ------------------------------------------------------------------- user.name
6517: } elsif ($space eq 'name') {
6518: return $uname;
6519: # ---------------------------------------------------- Any other user namespace
6520: } else {
6521: my %reply;
6522: if (!$publicuser) {
6523: %reply=&get($space,[$qualifierrest],$udom,$uname);
6524: }
6525: return $reply{$qualifierrest};
6526: }
6527: } elsif ($realm eq 'query') {
6528: # ---------------------------------------------- pull stuff out of query string
6529: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
6530: [$spacequalifierrest]);
6531: return $env{'form.'.$spacequalifierrest};
6532: } elsif ($realm eq 'request') {
6533: # ------------------------------------------------------------- request.browser
6534: if ($space eq 'browser') {
6535: if ($qualifier eq 'textremote') {
6536: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
6537: return 1;
6538: } else {
6539: return 0;
6540: }
6541: } else {
6542: return $env{'browser.'.$qualifier};
6543: }
6544: # ------------------------------------------------------------ request.filename
6545: } else {
6546: return $env{'request.'.$spacequalifierrest};
6547: }
6548: } elsif ($realm eq 'course') {
6549: # ---------------------------------------------------------- course.description
6550: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
6551: } elsif ($realm eq 'resource') {
6552:
6553: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
6554: if (!$symbparm) { $symbparm=&symbread(); }
6555: }
6556:
6557: if ($space eq 'title') {
6558: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
6559: return &gettitle($symbparm);
6560: }
6561:
6562: if ($space eq 'map') {
6563: my ($map) = &decode_symb($symbparm);
6564: return &symbread($map);
6565: }
6566: if ($space eq 'filename') {
6567: if ($symbparm) {
6568: return &clutter((&decode_symb($symbparm))[2]);
6569: }
6570: return &hreflocation('',$env{'request.filename'});
6571: }
6572:
6573: my ($section, $group, @groups);
6574: my ($courselevelm,$courselevel);
6575: if ($symbparm && defined($courseid) &&
6576: $courseid eq $env{'request.course.id'}) {
6577:
6578: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
6579:
6580: # ----------------------------------------------------- Cascading lookup scheme
6581: my $symbp=$symbparm;
6582: my $mapp=&deversion((&decode_symb($symbp))[0]);
6583:
6584: my $symbparm=$symbp.'.'.$spacequalifierrest;
6585: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
6586:
6587: if (($env{'user.name'} eq $uname) &&
6588: ($env{'user.domain'} eq $udom)) {
6589: $section=$env{'request.course.sec'};
6590: @groups = split(/:/,$env{'request.course.groups'});
6591: @groups=&sort_course_groups($courseid,@groups);
6592: } else {
6593: if (! defined($usection)) {
6594: $section=&getsection($udom,$uname,$courseid);
6595: } else {
6596: $section = $usection;
6597: }
6598: @groups = &get_users_groups($udom,$uname,$courseid);
6599: }
6600:
6601: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
6602: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
6603: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
6604:
6605: $courselevel=$courseid.'.'.$spacequalifierrest;
6606: my $courselevelr=$courseid.'.'.$symbparm;
6607: $courselevelm=$courseid.'.'.$mapparm;
6608:
6609: # ----------------------------------------------------------- first, check user
6610:
6611: my $userreply=&resdata($uname,$udom,'user',
6612: ([$courselevelr,'resource'],
6613: [$courselevelm,'map' ],
6614: [$courselevel, 'course' ]));
6615: if (defined($userreply)) { return $userreply; }
6616:
6617: # ------------------------------------------------ second, check some of course
6618: my $coursereply;
6619: if (@groups > 0) {
6620: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
6621: $mapparm,$spacequalifierrest);
6622: if (defined($coursereply)) { return &get_reply($coursereply); }
6623: }
6624:
6625: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6626: $env{'course.'.$courseid.'.domain'},
6627: 'course',
6628: ([$seclevelr, 'resource'],
6629: [$seclevelm, 'map' ],
6630: [$seclevel, 'course' ],
6631: [$courselevelr,'resource']));
6632: if (defined($coursereply)) { return &get_reply($coursereply); }
6633:
6634: # ------------------------------------------------------ third, check map parms
6635: my %parmhash=();
6636: my $thisparm='';
6637: if (tie(%parmhash,'GDBM_File',
6638: $env{'request.course.fn'}.'_parms.db',
6639: &GDBM_READER(),0640)) {
6640: $thisparm=$parmhash{$symbparm};
6641: untie(%parmhash);
6642: }
6643: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
6644: }
6645: # ------------------------------------------ fourth, look in resource metadata
6646:
6647: $spacequalifierrest=~s/\./\_/;
6648: my $filename;
6649: if (!$symbparm) { $symbparm=&symbread(); }
6650: if ($symbparm) {
6651: $filename=(&decode_symb($symbparm))[2];
6652: } else {
6653: $filename=$env{'request.filename'};
6654: }
6655: my $metadata=&metadata($filename,$spacequalifierrest);
6656: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
6657: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
6658: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
6659:
6660: # ---------------------------------------------- fourth, look in rest of course
6661: if ($symbparm && defined($courseid) &&
6662: $courseid eq $env{'request.course.id'}) {
6663: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
6664: $env{'course.'.$courseid.'.domain'},
6665: 'course',
6666: ([$courselevelm,'map' ],
6667: [$courselevel, 'course']));
6668: if (defined($coursereply)) { return &get_reply($coursereply); }
6669: }
6670: # ------------------------------------------------------------------ Cascade up
6671: unless ($space eq '0') {
6672: my @parts=split(/_/,$space);
6673: my $id=pop(@parts);
6674: my $part=join('_',@parts);
6675: if ($part eq '') { $part='0'; }
6676: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
6677: $symbparm,$udom,$uname,$section,1);
6678: if (@partgeneral) { return &get_reply(\@partgeneral); }
6679: }
6680: if ($recurse) { return undef; }
6681: my $pack_def=&packages_tab_default($filename,$varname);
6682: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
6683: # ---------------------------------------------------- Any other user namespace
6684: } elsif ($realm eq 'environment') {
6685: # ----------------------------------------------------------------- environment
6686: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
6687: return $env{'environment.'.$spacequalifierrest};
6688: } else {
6689: if ($uname eq 'anonymous' && $udom eq '') {
6690: return '';
6691: }
6692: my %returnhash=&userenvironment($udom,$uname,
6693: $spacequalifierrest);
6694: return $returnhash{$spacequalifierrest};
6695: }
6696: } elsif ($realm eq 'system') {
6697: # ----------------------------------------------------------------- system.time
6698: if ($space eq 'time') {
6699: return time;
6700: }
6701: } elsif ($realm eq 'server') {
6702: # ----------------------------------------------------------------- system.time
6703: if ($space eq 'name') {
6704: return $ENV{'SERVER_NAME'};
6705: }
6706: }
6707: return '';
6708: }
6709:
6710: sub get_reply {
6711: my ($reply_value) = @_;
6712: if (wantarray) {
6713: return @$reply_value;
6714: }
6715: return $reply_value->[0];
6716: }
6717:
6718: sub check_group_parms {
6719: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
6720: my @groupitems = ();
6721: my $resultitem;
6722: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
6723: foreach my $group (@{$groups}) {
6724: foreach my $level (@levels) {
6725: my $item = $courseid.'.['.$group.'].'.$level->[0];
6726: push(@groupitems,[$item,$level->[1]]);
6727: }
6728: }
6729: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
6730: $env{'course.'.$courseid.'.domain'},
6731: 'course',@groupitems);
6732: return $coursereply;
6733: }
6734:
6735: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
6736: my ($courseid,@groups) = @_;
6737: @groups = sort(@groups);
6738: return @groups;
6739: }
6740:
6741: sub packages_tab_default {
6742: my ($uri,$varname)=@_;
6743: my (undef,$part,$name)=split(/\./,$varname);
6744:
6745: my (@extension,@specifics,$do_default);
6746: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
6747: my ($pack_type,$pack_part)=split(/_/,$package,2);
6748: if ($pack_type eq 'default') {
6749: $do_default=1;
6750: } elsif ($pack_type eq 'extension') {
6751: push(@extension,[$package,$pack_type,$pack_part]);
6752: } elsif ($pack_part eq $part || $pack_type eq 'part') {
6753: # only look at packages defaults for packages that this id is
6754: push(@specifics,[$package,$pack_type,$pack_part]);
6755: }
6756: }
6757: # first look for a package that matches the requested part id
6758: foreach my $package (@specifics) {
6759: my (undef,$pack_type,$pack_part)=@{$package};
6760: next if ($pack_part ne $part);
6761: if (defined($packagetab{"$pack_type&$name&default"})) {
6762: return $packagetab{"$pack_type&$name&default"};
6763: }
6764: }
6765: # look for any possible matching non extension_ package
6766: foreach my $package (@specifics) {
6767: my (undef,$pack_type,$pack_part)=@{$package};
6768: if (defined($packagetab{"$pack_type&$name&default"})) {
6769: return $packagetab{"$pack_type&$name&default"};
6770: }
6771: if ($pack_type eq 'part') { $pack_part='0'; }
6772: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
6773: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
6774: }
6775: }
6776: # look for any posible extension_ match
6777: foreach my $package (@extension) {
6778: my ($package,$pack_type)=@{$package};
6779: if (defined($packagetab{"$pack_type&$name&default"})) {
6780: return $packagetab{"$pack_type&$name&default"};
6781: }
6782: if (defined($packagetab{$package."&$name&default"})) {
6783: return $packagetab{$package."&$name&default"};
6784: }
6785: }
6786: # look for a global default setting
6787: if ($do_default && defined($packagetab{"default&$name&default"})) {
6788: return $packagetab{"default&$name&default"};
6789: }
6790: return undef;
6791: }
6792:
6793: sub add_prefix_and_part {
6794: my ($prefix,$part)=@_;
6795: my $keyroot;
6796: if (defined($prefix) && $prefix !~ /^__/) {
6797: # prefix that has a part already
6798: $keyroot=$prefix;
6799: } elsif (defined($prefix)) {
6800: # prefix that is missing a part
6801: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6802: } else {
6803: # no prefix at all
6804: if (defined($part)) { $keyroot='_'.$part; }
6805: }
6806: return $keyroot;
6807: }
6808:
6809: # ---------------------------------------------------------------- Get metadata
6810:
6811: my %metaentry;
6812: sub metadata {
6813: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6814: $uri=&declutter($uri);
6815: # if it is a non metadata possible uri return quickly
6816: if (($uri eq '') ||
6817: (($uri =~ m|^/*adm/|) &&
6818: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6819: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
6820: return undef;
6821: }
6822: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
6823: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
6824: return undef;
6825: }
6826: my $filename=$uri;
6827: $uri=~s/\.meta$//;
6828: #
6829: # Is the metadata already cached?
6830: # Look at timestamp of caching
6831: # Everything is cached by the main uri, libraries are never directly cached
6832: #
6833: if (!defined($liburi)) {
6834: my ($result,$cached)=&is_cached_new('meta',$uri);
6835: if (defined($cached)) { return $result->{':'.$what}; }
6836: }
6837: {
6838: #
6839: # Is this a recursive call for a library?
6840: #
6841: # if (! exists($metacache{$uri})) {
6842: # $metacache{$uri}={};
6843: # }
6844: my $cachetime = 60*60;
6845: if ($liburi) {
6846: $liburi=&declutter($liburi);
6847: $filename=$liburi;
6848: } else {
6849: &devalidate_cache_new('meta',$uri);
6850: undef(%metaentry);
6851: }
6852: my %metathesekeys=();
6853: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6854: my $metastring;
6855: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
6856: my $which = &hreflocation('','/'.($liburi || $uri));
6857: $metastring =
6858: &Apache::lonnet::ssi_body($which,
6859: ('grade_target' => 'meta'));
6860: $cachetime = 1; # only want this cached in the child not long term
6861: } elsif ($uri !~ m -^(editupload)/-) {
6862: my $file=&filelocation('',&clutter($filename));
6863: #push(@{$metaentry{$uri.'.file'}},$file);
6864: $metastring=&getfile($file);
6865: }
6866: my $parser=HTML::LCParser->new(\$metastring);
6867: my $token;
6868: undef %metathesekeys;
6869: while ($token=$parser->get_token) {
6870: if ($token->[0] eq 'S') {
6871: if (defined($token->[2]->{'package'})) {
6872: #
6873: # This is a package - get package info
6874: #
6875: my $package=$token->[2]->{'package'};
6876: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6877: if (defined($token->[2]->{'id'})) {
6878: $keyroot.='_'.$token->[2]->{'id'};
6879: }
6880: if ($metaentry{':packages'}) {
6881: $metaentry{':packages'}.=','.$package.$keyroot;
6882: } else {
6883: $metaentry{':packages'}=$package.$keyroot;
6884: }
6885: foreach my $pack_entry (keys(%packagetab)) {
6886: my $part=$keyroot;
6887: $part=~s/^\_//;
6888: if ($pack_entry=~/^\Q$package\E\&/ ||
6889: $pack_entry=~/^\Q$package\E_0\&/) {
6890: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6891: # ignore package.tab specified default values
6892: # here &package_tab_default() will fetch those
6893: if ($subp eq 'default') { next; }
6894: my $value=$packagetab{$pack_entry};
6895: my $unikey;
6896: if ($pack =~ /_0$/) {
6897: $unikey='parameter_0_'.$name;
6898: $part=0;
6899: } else {
6900: $unikey='parameter'.$keyroot.'_'.$name;
6901: }
6902: if ($subp eq 'display') {
6903: $value.=' [Part: '.$part.']';
6904: }
6905: $metaentry{':'.$unikey.'.part'}=$part;
6906: $metathesekeys{$unikey}=1;
6907: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6908: $metaentry{':'.$unikey.'.'.$subp}=$value;
6909: }
6910: if (defined($metaentry{':'.$unikey.'.default'})) {
6911: $metaentry{':'.$unikey}=
6912: $metaentry{':'.$unikey.'.default'};
6913: }
6914: }
6915: }
6916: } else {
6917: #
6918: # This is not a package - some other kind of start tag
6919: #
6920: my $entry=$token->[1];
6921: my $unikey;
6922: if ($entry eq 'import') {
6923: $unikey='';
6924: } else {
6925: $unikey=$entry;
6926: }
6927: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6928:
6929: if (defined($token->[2]->{'id'})) {
6930: $unikey.='_'.$token->[2]->{'id'};
6931: }
6932:
6933: if ($entry eq 'import') {
6934: #
6935: # Importing a library here
6936: #
6937: if ($depthcount<20) {
6938: my $location=$parser->get_text('/import');
6939: my $dir=$filename;
6940: $dir=~s|[^/]*$||;
6941: $location=&filelocation($dir,$location);
6942: my $metadata =
6943: &metadata($uri,'keys', $location,$unikey,
6944: $depthcount+1);
6945: foreach my $meta (split(',',$metadata)) {
6946: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6947: $metathesekeys{$meta}=1;
6948: }
6949: }
6950: } else {
6951:
6952: if (defined($token->[2]->{'name'})) {
6953: $unikey.='_'.$token->[2]->{'name'};
6954: }
6955: $metathesekeys{$unikey}=1;
6956: foreach my $param (@{$token->[3]}) {
6957: $metaentry{':'.$unikey.'.'.$param} =
6958: $token->[2]->{$param};
6959: }
6960: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6961: my $default=$metaentry{':'.$unikey.'.default'};
6962: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6963: # only ws inside the tag, and not in default, so use default
6964: # as value
6965: $metaentry{':'.$unikey}=$default;
6966: } elsif ( $internaltext =~ /\S/ ) {
6967: # something interesting inside the tag
6968: $metaentry{':'.$unikey}=$internaltext;
6969: } else {
6970: # no interesting values, don't set a default
6971: }
6972: # end of not-a-package not-a-library import
6973: }
6974: # end of not-a-package start tag
6975: }
6976: # the next is the end of "start tag"
6977: }
6978: }
6979: my ($extension) = ($uri =~ /\.(\w+)$/);
6980: $extension = lc($extension);
6981: if ($extension eq 'htm') { $extension='html'; }
6982:
6983: foreach my $key (keys(%packagetab)) {
6984: #no specific packages #how's our extension
6985: if ($key!~/^extension_\Q$extension\E&/) { next; }
6986: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6987: \%metathesekeys);
6988: }
6989:
6990: if (!exists($metaentry{':packages'})
6991: || $packagetab{"import_defaults&extension_$extension"}) {
6992: foreach my $key (keys(%packagetab)) {
6993: #no specific packages well let's get default then
6994: if ($key!~/^default&/) { next; }
6995: &metadata_create_package_def($uri,$key,'default',
6996: \%metathesekeys);
6997: }
6998: }
6999: # are there custom rights to evaluate
7000: if ($metaentry{':copyright'} eq 'custom') {
7001:
7002: #
7003: # Importing a rights file here
7004: #
7005: unless ($depthcount) {
7006: my $location=$metaentry{':customdistributionfile'};
7007: my $dir=$filename;
7008: $dir=~s|[^/]*$||;
7009: $location=&filelocation($dir,$location);
7010: my $rights_metadata =
7011: &metadata($uri,'keys',$location,'_rights',
7012: $depthcount+1);
7013: foreach my $rights (split(',',$rights_metadata)) {
7014: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
7015: $metathesekeys{$rights}=1;
7016: }
7017: }
7018: }
7019: # uniqifiy package listing
7020: my %seen;
7021: my @uniq_packages =
7022: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
7023: $metaentry{':packages'} = join(',',@uniq_packages);
7024:
7025: $metaentry{':keys'} = join(',',keys(%metathesekeys));
7026: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
7027: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
7028: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
7029: # this is the end of "was not already recently cached
7030: }
7031: return $metaentry{':'.$what};
7032: }
7033:
7034: sub metadata_create_package_def {
7035: my ($uri,$key,$package,$metathesekeys)=@_;
7036: my ($pack,$name,$subp)=split(/\&/,$key);
7037: if ($subp eq 'default') { next; }
7038:
7039: if (defined($metaentry{':packages'})) {
7040: $metaentry{':packages'}.=','.$package;
7041: } else {
7042: $metaentry{':packages'}=$package;
7043: }
7044: my $value=$packagetab{$key};
7045: my $unikey;
7046: $unikey='parameter_0_'.$name;
7047: $metaentry{':'.$unikey.'.part'}=0;
7048: $$metathesekeys{$unikey}=1;
7049: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
7050: $metaentry{':'.$unikey.'.'.$subp}=$value;
7051: }
7052: if (defined($metaentry{':'.$unikey.'.default'})) {
7053: $metaentry{':'.$unikey}=
7054: $metaentry{':'.$unikey.'.default'};
7055: }
7056: }
7057:
7058: sub metadata_generate_part0 {
7059: my ($metadata,$metacache,$uri) = @_;
7060: my %allnames;
7061: foreach my $metakey (keys(%$metadata)) {
7062: if ($metakey=~/^parameter\_(.*)/) {
7063: my $part=$$metacache{':'.$metakey.'.part'};
7064: my $name=$$metacache{':'.$metakey.'.name'};
7065: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
7066: $allnames{$name}=$part;
7067: }
7068: }
7069: }
7070: foreach my $name (keys(%allnames)) {
7071: $$metadata{"parameter_0_$name"}=1;
7072: my $key=":parameter_0_$name";
7073: $$metacache{"$key.part"}='0';
7074: $$metacache{"$key.name"}=$name;
7075: $$metacache{"$key.type"}=$$metacache{':parameter_'.
7076: $allnames{$name}.'_'.$name.
7077: '.type'};
7078: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
7079: '.display'};
7080: my $expr='[Part: '.$allnames{$name}.']';
7081: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
7082: $$metacache{"$key.display"}=$olddis;
7083: }
7084: }
7085:
7086: # ------------------------------------------------------ Devalidate title cache
7087:
7088: sub devalidate_title_cache {
7089: my ($url)=@_;
7090: if (!$env{'request.course.id'}) { return; }
7091: my $symb=&symbread($url);
7092: if (!$symb) { return; }
7093: my $key=$env{'request.course.id'}."\0".$symb;
7094: &devalidate_cache_new('title',$key);
7095: }
7096:
7097: # ------------------------------------------------- Get the title of a resource
7098:
7099: sub gettitle {
7100: my $urlsymb=shift;
7101: my $symb=&symbread($urlsymb);
7102: if ($symb) {
7103: my $key=$env{'request.course.id'}."\0".$symb;
7104: my ($result,$cached)=&is_cached_new('title',$key);
7105: if (defined($cached)) {
7106: return $result;
7107: }
7108: my ($map,$resid,$url)=&decode_symb($symb);
7109: my $title='';
7110: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
7111: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
7112: } else {
7113: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7114: &GDBM_READER(),0640)) {
7115: my $mapid=$bighash{'map_pc_'.&clutter($map)};
7116: $title=$bighash{'title_'.$mapid.'.'.$resid};
7117: untie(%bighash);
7118: }
7119: }
7120: $title=~s/\&colon\;/\:/gs;
7121: if ($title) {
7122: return &do_cache_new('title',$key,$title,600);
7123: }
7124: $urlsymb=$url;
7125: }
7126: my $title=&metadata($urlsymb,'title');
7127: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
7128: return $title;
7129: }
7130:
7131: sub get_slot {
7132: my ($which,$cnum,$cdom)=@_;
7133: if (!$cnum || !$cdom) {
7134: (undef,my $courseid)=&whichuser();
7135: $cdom=$env{'course.'.$courseid.'.domain'};
7136: $cnum=$env{'course.'.$courseid.'.num'};
7137: }
7138: my $key=join("\0",'slots',$cdom,$cnum,$which);
7139: my %slotinfo;
7140: if (exists($remembered{$key})) {
7141: $slotinfo{$which} = $remembered{$key};
7142: } else {
7143: %slotinfo=&get('slots',[$which],$cdom,$cnum);
7144: &Apache::lonhomework::showhash(%slotinfo);
7145: my ($tmp)=keys(%slotinfo);
7146: if ($tmp=~/^error:/) { return (); }
7147: $remembered{$key} = $slotinfo{$which};
7148: }
7149: if (ref($slotinfo{$which}) eq 'HASH') {
7150: return %{$slotinfo{$which}};
7151: }
7152: return $slotinfo{$which};
7153: }
7154: # ------------------------------------------------- Update symbolic store links
7155:
7156: sub symblist {
7157: my ($mapname,%newhash)=@_;
7158: $mapname=&deversion(&declutter($mapname));
7159: my %hash;
7160: if (($env{'request.course.fn'}) && (%newhash)) {
7161: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7162: &GDBM_WRCREAT(),0640)) {
7163: foreach my $url (keys %newhash) {
7164: next if ($url eq 'last_known'
7165: && $env{'form.no_update_last_known'});
7166: $hash{declutter($url)}=&encode_symb($mapname,
7167: $newhash{$url}->[1],
7168: $newhash{$url}->[0]);
7169: }
7170: if (untie(%hash)) {
7171: return 'ok';
7172: }
7173: }
7174: }
7175: return 'error';
7176: }
7177:
7178: # --------------------------------------------------------------- Verify a symb
7179:
7180: sub symbverify {
7181: my ($symb,$thisurl)=@_;
7182: my $thisfn=$thisurl;
7183: $thisfn=&declutter($thisfn);
7184: # direct jump to resource in page or to a sequence - will construct own symbs
7185: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
7186: # check URL part
7187: my ($map,$resid,$url)=&decode_symb($symb);
7188:
7189: unless ($url eq $thisfn) { return 0; }
7190:
7191: $symb=&symbclean($symb);
7192: $thisurl=&deversion($thisurl);
7193: $thisfn=&deversion($thisfn);
7194:
7195: my %bighash;
7196: my $okay=0;
7197:
7198: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7199: &GDBM_READER(),0640)) {
7200: my $ids=$bighash{'ids_'.&clutter($thisurl)};
7201: unless ($ids) {
7202: $ids=$bighash{'ids_/'.$thisurl};
7203: }
7204: if ($ids) {
7205: # ------------------------------------------------------------------- Has ID(s)
7206: foreach my $id (split(/\,/,$ids)) {
7207: my ($mapid,$resid)=split(/\./,$id);
7208: if (
7209: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
7210: eq $symb) {
7211: if (($env{'request.role.adv'}) ||
7212: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
7213: $okay=1;
7214: }
7215: }
7216: }
7217: }
7218: untie(%bighash);
7219: }
7220: return $okay;
7221: }
7222:
7223: # --------------------------------------------------------------- Clean-up symb
7224:
7225: sub symbclean {
7226: my $symb=shift;
7227: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7228: # remove version from map
7229: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
7230:
7231: # remove version from URL
7232: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
7233:
7234: # remove wrapper
7235:
7236: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
7237: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
7238: return $symb;
7239: }
7240:
7241: # ---------------------------------------------- Split symb to find map and url
7242:
7243: sub encode_symb {
7244: my ($map,$resid,$url)=@_;
7245: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
7246: }
7247:
7248: sub decode_symb {
7249: my $symb=shift;
7250: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
7251: my ($map,$resid,$url)=split(/___/,$symb);
7252: return (&fixversion($map),$resid,&fixversion($url));
7253: }
7254:
7255: sub fixversion {
7256: my $fn=shift;
7257: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
7258: my %bighash;
7259: my $uri=&clutter($fn);
7260: my $key=$env{'request.course.id'}.'_'.$uri;
7261: # is this cached?
7262: my ($result,$cached)=&is_cached_new('courseresversion',$key);
7263: if (defined($cached)) { return $result; }
7264: # unfortunately not cached, or expired
7265: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7266: &GDBM_READER(),0640)) {
7267: if ($bighash{'version_'.$uri}) {
7268: my $version=$bighash{'version_'.$uri};
7269: unless (($version eq 'mostrecent') ||
7270: ($version==&getversion($uri))) {
7271: $uri=~s/\.(\w+)$/\.$version\.$1/;
7272: }
7273: }
7274: untie %bighash;
7275: }
7276: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
7277: }
7278:
7279: sub deversion {
7280: my $url=shift;
7281: $url=~s/\.\d+\.(\w+)$/\.$1/;
7282: return $url;
7283: }
7284:
7285: # ------------------------------------------------------ Return symb list entry
7286:
7287: sub symbread {
7288: my ($thisfn,$donotrecurse)=@_;
7289: my $cache_str='request.symbread.cached.'.$thisfn;
7290: if (defined($env{$cache_str})) { return $env{$cache_str}; }
7291: # no filename provided? try from environment
7292: unless ($thisfn) {
7293: if ($env{'request.symb'}) {
7294: return $env{$cache_str}=&symbclean($env{'request.symb'});
7295: }
7296: $thisfn=$env{'request.filename'};
7297: }
7298: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7299: # is that filename actually a symb? Verify, clean, and return
7300: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
7301: if (&symbverify($thisfn,$1)) {
7302: return $env{$cache_str}=&symbclean($thisfn);
7303: }
7304: }
7305: $thisfn=declutter($thisfn);
7306: my %hash;
7307: my %bighash;
7308: my $syval='';
7309: if (($env{'request.course.fn'}) && ($thisfn)) {
7310: my $targetfn = $thisfn;
7311: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
7312: $targetfn = 'adm/wrapper/'.$thisfn;
7313: }
7314: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
7315: $targetfn=$1;
7316: }
7317: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
7318: &GDBM_READER(),0640)) {
7319: $syval=$hash{$targetfn};
7320: untie(%hash);
7321: }
7322: # ---------------------------------------------------------- There was an entry
7323: if ($syval) {
7324: #unless ($syval=~/\_\d+$/) {
7325: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
7326: #&appenv('request.ambiguous' => $thisfn);
7327: #return $env{$cache_str}='';
7328: #}
7329: #$syval.=$1;
7330: #}
7331: } else {
7332: # ------------------------------------------------------- Was not in symb table
7333: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7334: &GDBM_READER(),0640)) {
7335: # ---------------------------------------------- Get ID(s) for current resource
7336: my $ids=$bighash{'ids_'.&clutter($thisfn)};
7337: unless ($ids) {
7338: $ids=$bighash{'ids_/'.$thisfn};
7339: }
7340: unless ($ids) {
7341: # alias?
7342: $ids=$bighash{'mapalias_'.$thisfn};
7343: }
7344: if ($ids) {
7345: # ------------------------------------------------------------------- Has ID(s)
7346: my @possibilities=split(/\,/,$ids);
7347: if ($#possibilities==0) {
7348: # ----------------------------------------------- There is only one possibility
7349: my ($mapid,$resid)=split(/\./,$ids);
7350: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7351: $resid,$thisfn);
7352: } elsif (!$donotrecurse) {
7353: # ------------------------------------------ There is more than one possibility
7354: my $realpossible=0;
7355: foreach my $id (@possibilities) {
7356: my $file=$bighash{'src_'.$id};
7357: if (&allowed('bre',$file)) {
7358: my ($mapid,$resid)=split(/\./,$id);
7359: if ($bighash{'map_type_'.$mapid} ne 'page') {
7360: $realpossible++;
7361: $syval=&encode_symb($bighash{'map_id_'.$mapid},
7362: $resid,$thisfn);
7363: }
7364: }
7365: }
7366: if ($realpossible!=1) { $syval=''; }
7367: } else {
7368: $syval='';
7369: }
7370: }
7371: untie(%bighash)
7372: }
7373: }
7374: if ($syval) {
7375: return $env{$cache_str}=$syval;
7376: }
7377: }
7378: &appenv('request.ambiguous' => $thisfn);
7379: return $env{$cache_str}='';
7380: }
7381:
7382: # ---------------------------------------------------------- Return random seed
7383:
7384: sub numval {
7385: my $txt=shift;
7386: $txt=~tr/A-J/0-9/;
7387: $txt=~tr/a-j/0-9/;
7388: $txt=~tr/K-T/0-9/;
7389: $txt=~tr/k-t/0-9/;
7390: $txt=~tr/U-Z/0-5/;
7391: $txt=~tr/u-z/0-5/;
7392: $txt=~s/\D//g;
7393: if ($_64bit) { if ($txt > 2**32) { return -1; } }
7394: return int($txt);
7395: }
7396:
7397: sub numval2 {
7398: my $txt=shift;
7399: $txt=~tr/A-J/0-9/;
7400: $txt=~tr/a-j/0-9/;
7401: $txt=~tr/K-T/0-9/;
7402: $txt=~tr/k-t/0-9/;
7403: $txt=~tr/U-Z/0-5/;
7404: $txt=~tr/u-z/0-5/;
7405: $txt=~s/\D//g;
7406: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7407: my $total;
7408: foreach my $val (@txts) { $total+=$val; }
7409: if ($_64bit) { if ($total > 2**32) { return -1; } }
7410: return int($total);
7411: }
7412:
7413: sub numval3 {
7414: use integer;
7415: my $txt=shift;
7416: $txt=~tr/A-J/0-9/;
7417: $txt=~tr/a-j/0-9/;
7418: $txt=~tr/K-T/0-9/;
7419: $txt=~tr/k-t/0-9/;
7420: $txt=~tr/U-Z/0-5/;
7421: $txt=~tr/u-z/0-5/;
7422: $txt=~s/\D//g;
7423: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
7424: my $total;
7425: foreach my $val (@txts) { $total+=$val; }
7426: if ($_64bit) { $total=(($total<<32)>>32); }
7427: return $total;
7428: }
7429:
7430: sub digest {
7431: my ($data)=@_;
7432: my $digest=&Digest::MD5::md5($data);
7433: my ($a,$b,$c,$d)=unpack("iiii",$digest);
7434: my ($e,$f);
7435: {
7436: use integer;
7437: $e=($a+$b);
7438: $f=($c+$d);
7439: if ($_64bit) {
7440: $e=(($e<<32)>>32);
7441: $f=(($f<<32)>>32);
7442: }
7443: }
7444: if (wantarray) {
7445: return ($e,$f);
7446: } else {
7447: my $g;
7448: {
7449: use integer;
7450: $g=($e+$f);
7451: if ($_64bit) {
7452: $g=(($g<<32)>>32);
7453: }
7454: }
7455: return $g;
7456: }
7457: }
7458:
7459: sub latest_rnd_algorithm_id {
7460: return '64bit5';
7461: }
7462:
7463: sub get_rand_alg {
7464: my ($courseid)=@_;
7465: if (!$courseid) { $courseid=(&whichuser())[1]; }
7466: if ($courseid) {
7467: return $env{"course.$courseid.rndseed"};
7468: }
7469: return &latest_rnd_algorithm_id();
7470: }
7471:
7472: sub validCODE {
7473: my ($CODE)=@_;
7474: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
7475: return 0;
7476: }
7477:
7478: sub getCODE {
7479: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
7480: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
7481: defined($Apache::lonhomework::parsing_a_task) ) &&
7482: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
7483: return $Apache::lonhomework::history{'resource.CODE'};
7484: }
7485: return undef;
7486: }
7487:
7488: sub rndseed {
7489: my ($symb,$courseid,$domain,$username)=@_;
7490: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
7491: if (!defined($symb)) {
7492: unless ($symb=$wsymb) { return time; }
7493: }
7494: if (!$courseid) { $courseid=$wcourseid; }
7495: if (!$domain) { $domain=$wdomain; }
7496: if (!$username) { $username=$wusername }
7497: my $which=&get_rand_alg();
7498:
7499: if (defined(&getCODE())) {
7500: if ($which eq '64bit5') {
7501: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
7502: } elsif ($which eq '64bit4') {
7503: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
7504: } else {
7505: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
7506: }
7507: } elsif ($which eq '64bit5') {
7508: return &rndseed_64bit5($symb,$courseid,$domain,$username);
7509: } elsif ($which eq '64bit4') {
7510: return &rndseed_64bit4($symb,$courseid,$domain,$username);
7511: } elsif ($which eq '64bit3') {
7512: return &rndseed_64bit3($symb,$courseid,$domain,$username);
7513: } elsif ($which eq '64bit2') {
7514: return &rndseed_64bit2($symb,$courseid,$domain,$username);
7515: } elsif ($which eq '64bit') {
7516: return &rndseed_64bit($symb,$courseid,$domain,$username);
7517: }
7518: return &rndseed_32bit($symb,$courseid,$domain,$username);
7519: }
7520:
7521: sub rndseed_32bit {
7522: my ($symb,$courseid,$domain,$username)=@_;
7523: {
7524: use integer;
7525: my $symbchck=unpack("%32C*",$symb) << 27;
7526: my $symbseed=numval($symb) << 22;
7527: my $namechck=unpack("%32C*",$username) << 17;
7528: my $nameseed=numval($username) << 12;
7529: my $domainseed=unpack("%32C*",$domain) << 7;
7530: my $courseseed=unpack("%32C*",$courseid);
7531: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
7532: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7533: #&logthis("rndseed :$num:$symb");
7534: if ($_64bit) { $num=(($num<<32)>>32); }
7535: return $num;
7536: }
7537: }
7538:
7539: sub rndseed_64bit {
7540: my ($symb,$courseid,$domain,$username)=@_;
7541: {
7542: use integer;
7543: my $symbchck=unpack("%32S*",$symb) << 21;
7544: my $symbseed=numval($symb) << 10;
7545: my $namechck=unpack("%32S*",$username);
7546:
7547: my $nameseed=numval($username) << 21;
7548: my $domainseed=unpack("%32S*",$domain) << 10;
7549: my $courseseed=unpack("%32S*",$courseid);
7550:
7551: my $num1=$symbchck+$symbseed+$namechck;
7552: my $num2=$nameseed+$domainseed+$courseseed;
7553: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7554: #&logthis("rndseed :$num:$symb");
7555: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7556: return "$num1,$num2";
7557: }
7558: }
7559:
7560: sub rndseed_64bit2 {
7561: my ($symb,$courseid,$domain,$username)=@_;
7562: {
7563: use integer;
7564: # strings need to be an even # of cahracters long, it it is odd the
7565: # last characters gets thrown away
7566: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7567: my $symbseed=numval($symb) << 10;
7568: my $namechck=unpack("%32S*",$username.' ');
7569:
7570: my $nameseed=numval($username) << 21;
7571: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7572: my $courseseed=unpack("%32S*",$courseid.' ');
7573:
7574: my $num1=$symbchck+$symbseed+$namechck;
7575: my $num2=$nameseed+$domainseed+$courseseed;
7576: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7577: #&logthis("rndseed :$num:$symb");
7578: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7579: return "$num1,$num2";
7580: }
7581: }
7582:
7583: sub rndseed_64bit3 {
7584: my ($symb,$courseid,$domain,$username)=@_;
7585: {
7586: use integer;
7587: # strings need to be an even # of cahracters long, it it is odd the
7588: # last characters gets thrown away
7589: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7590: my $symbseed=numval2($symb) << 10;
7591: my $namechck=unpack("%32S*",$username.' ');
7592:
7593: my $nameseed=numval2($username) << 21;
7594: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7595: my $courseseed=unpack("%32S*",$courseid.' ');
7596:
7597: my $num1=$symbchck+$symbseed+$namechck;
7598: my $num2=$nameseed+$domainseed+$courseseed;
7599: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7600: #&logthis("rndseed :$num1:$num2:$_64bit");
7601: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7602:
7603: return "$num1:$num2";
7604: }
7605: }
7606:
7607: sub rndseed_64bit4 {
7608: my ($symb,$courseid,$domain,$username)=@_;
7609: {
7610: use integer;
7611: # strings need to be an even # of cahracters long, it it is odd the
7612: # last characters gets thrown away
7613: my $symbchck=unpack("%32S*",$symb.' ') << 21;
7614: my $symbseed=numval3($symb) << 10;
7615: my $namechck=unpack("%32S*",$username.' ');
7616:
7617: my $nameseed=numval3($username) << 21;
7618: my $domainseed=unpack("%32S*",$domain.' ') << 10;
7619: my $courseseed=unpack("%32S*",$courseid.' ');
7620:
7621: my $num1=$symbchck+$symbseed+$namechck;
7622: my $num2=$nameseed+$domainseed+$courseseed;
7623: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
7624: #&logthis("rndseed :$num1:$num2:$_64bit");
7625: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
7626:
7627: return "$num1:$num2";
7628: }
7629: }
7630:
7631: sub rndseed_64bit5 {
7632: my ($symb,$courseid,$domain,$username)=@_;
7633: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
7634: return "$num1:$num2";
7635: }
7636:
7637: sub rndseed_CODE_64bit {
7638: my ($symb,$courseid,$domain,$username)=@_;
7639: {
7640: use integer;
7641: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7642: my $symbseed=numval2($symb);
7643: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7644: my $CODEseed=numval(&getCODE());
7645: my $courseseed=unpack("%32S*",$courseid.' ');
7646: my $num1=$symbseed+$CODEchck;
7647: my $num2=$CODEseed+$courseseed+$symbchck;
7648: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7649: #&logthis("rndseed :$num1:$num2:$symb");
7650: if ($_64bit) { $num1=(($num1<<32)>>32); }
7651: if ($_64bit) { $num2=(($num2<<32)>>32); }
7652: return "$num1:$num2";
7653: }
7654: }
7655:
7656: sub rndseed_CODE_64bit4 {
7657: my ($symb,$courseid,$domain,$username)=@_;
7658: {
7659: use integer;
7660: my $symbchck=unpack("%32S*",$symb.' ') << 16;
7661: my $symbseed=numval3($symb);
7662: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
7663: my $CODEseed=numval3(&getCODE());
7664: my $courseseed=unpack("%32S*",$courseid.' ');
7665: my $num1=$symbseed+$CODEchck;
7666: my $num2=$CODEseed+$courseseed+$symbchck;
7667: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
7668: #&logthis("rndseed :$num1:$num2:$symb");
7669: if ($_64bit) { $num1=(($num1<<32)>>32); }
7670: if ($_64bit) { $num2=(($num2<<32)>>32); }
7671: return "$num1:$num2";
7672: }
7673: }
7674:
7675: sub rndseed_CODE_64bit5 {
7676: my ($symb,$courseid,$domain,$username)=@_;
7677: my $code = &getCODE();
7678: my ($num1,$num2)=&digest("$symb,$courseid,$code");
7679: return "$num1:$num2";
7680: }
7681:
7682: sub setup_random_from_rndseed {
7683: my ($rndseed)=@_;
7684: if ($rndseed =~/([,:])/) {
7685: my ($num1,$num2)=split(/[,:]/,$rndseed);
7686: &Math::Random::random_set_seed(abs($num1),abs($num2));
7687: } else {
7688: &Math::Random::random_set_seed_from_phrase($rndseed);
7689: }
7690: }
7691:
7692: sub latest_receipt_algorithm_id {
7693: return 'receipt3';
7694: }
7695:
7696: sub recunique {
7697: my $fucourseid=shift;
7698: my $unique;
7699: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
7700: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7701: $unique=$env{"course.$fucourseid.internal.encseed"};
7702: } else {
7703: $unique=$perlvar{'lonReceipt'};
7704: }
7705: return unpack("%32C*",$unique);
7706: }
7707:
7708: sub recprefix {
7709: my $fucourseid=shift;
7710: my $prefix;
7711: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
7712: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
7713: $prefix=$env{"course.$fucourseid.internal.encpref"};
7714: } else {
7715: $prefix=$perlvar{'lonHostID'};
7716: }
7717: return unpack("%32C*",$prefix);
7718: }
7719:
7720: sub ireceipt {
7721: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
7722:
7723: my $return =&recprefix($fucourseid).'-';
7724:
7725: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
7726: $env{'request.state'} eq 'construct') {
7727: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
7728: return $return;
7729: }
7730:
7731: my $cuname=unpack("%32C*",$funame);
7732: my $cudom=unpack("%32C*",$fudom);
7733: my $cucourseid=unpack("%32C*",$fucourseid);
7734: my $cusymb=unpack("%32C*",$fusymb);
7735: my $cunique=&recunique($fucourseid);
7736: my $cpart=unpack("%32S*",$part);
7737: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
7738:
7739: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
7740:
7741: $return.= ($cunique%$cuname+
7742: $cunique%$cudom+
7743: $cusymb%$cuname+
7744: $cusymb%$cudom+
7745: $cucourseid%$cuname+
7746: $cucourseid%$cudom+
7747: $cpart%$cuname+
7748: $cpart%$cudom);
7749: } else {
7750: $return.= ($cunique%$cuname+
7751: $cunique%$cudom+
7752: $cusymb%$cuname+
7753: $cusymb%$cudom+
7754: $cucourseid%$cuname+
7755: $cucourseid%$cudom);
7756: }
7757: return $return;
7758: }
7759:
7760: sub receipt {
7761: my ($part)=@_;
7762: my ($symb,$courseid,$domain,$name) = &whichuser();
7763: return &ireceipt($name,$domain,$courseid,$symb,$part);
7764: }
7765:
7766: sub whichuser {
7767: my ($passedsymb)=@_;
7768: my ($symb,$courseid,$domain,$name,$publicuser);
7769: if (defined($env{'form.grade_symb'})) {
7770: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
7771: my $allowed=&allowed('vgr',$tmp_courseid);
7772: if (!$allowed &&
7773: exists($env{'request.course.sec'}) &&
7774: $env{'request.course.sec'} !~ /^\s*$/) {
7775: $allowed=&allowed('vgr',$tmp_courseid.
7776: '/'.$env{'request.course.sec'});
7777: }
7778: if ($allowed) {
7779: ($symb)=&get_env_multiple('form.grade_symb');
7780: $courseid=$tmp_courseid;
7781: ($domain)=&get_env_multiple('form.grade_domain');
7782: ($name)=&get_env_multiple('form.grade_username');
7783: return ($symb,$courseid,$domain,$name,$publicuser);
7784: }
7785: }
7786: if (!$passedsymb) {
7787: $symb=&symbread();
7788: } else {
7789: $symb=$passedsymb;
7790: }
7791: $courseid=$env{'request.course.id'};
7792: $domain=$env{'user.domain'};
7793: $name=$env{'user.name'};
7794: if ($name eq 'public' && $domain eq 'public') {
7795: if (!defined($env{'form.username'})) {
7796: $env{'form.username'}.=time.rand(10000000);
7797: }
7798: $name.=$env{'form.username'};
7799: }
7800: return ($symb,$courseid,$domain,$name,$publicuser);
7801:
7802: }
7803:
7804: # ------------------------------------------------------------ Serves up a file
7805: # returns either the contents of the file or
7806: # -1 if the file doesn't exist
7807: #
7808: # if the target is a file that was uploaded via DOCS,
7809: # a check will be made to see if a current copy exists on the local server,
7810: # if it does this will be served, otherwise a copy will be retrieved from
7811: # the home server for the course and stored in /home/httpd/html/userfiles on
7812: # the local server.
7813:
7814: sub getfile {
7815: my ($file) = @_;
7816: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7817: &repcopy($file);
7818: return &readfile($file);
7819: }
7820:
7821: sub repcopy_userfile {
7822: my ($file)=@_;
7823: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7824: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7825: my ($cdom,$cnum,$filename) =
7826: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
7827: my $uri="/uploaded/$cdom/$cnum/$filename";
7828: if (-e "$file") {
7829: # we already have a local copy, check it out
7830: my @fileinfo = stat($file);
7831: my $rtncode;
7832: my $info;
7833: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7834: if ($lwpresp ne 'ok') {
7835: # there is no such file anymore, even though we had a local copy
7836: if ($rtncode eq '404') {
7837: unlink($file);
7838: }
7839: return -1;
7840: }
7841: if ($info < $fileinfo[9]) {
7842: # nice, the file we have is up-to-date, just say okay
7843: return 'ok';
7844: } else {
7845: # the file is outdated, get rid of it
7846: unlink($file);
7847: }
7848: }
7849: # one way or the other, at this point, we don't have the file
7850: # construct the correct path for the file
7851: my @parts = ($cdom,$cnum);
7852: if ($filename =~ m|^(.+)/[^/]+$|) {
7853: push @parts, split(/\//,$1);
7854: }
7855: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7856: foreach my $part (@parts) {
7857: $path .= '/'.$part;
7858: if (!-e $path) {
7859: mkdir($path,0770);
7860: }
7861: }
7862: # now the path exists for sure
7863: # get a user agent
7864: my $ua=new LWP::UserAgent;
7865: my $transferfile=$file.'.in.transfer';
7866: # FIXME: this should flock
7867: if (-e $transferfile) { return 'ok'; }
7868: my $request;
7869: $uri=~s/^\///;
7870: $request=new HTTP::Request('GET','http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri);
7871: my $response=$ua->request($request,$transferfile);
7872: # did it work?
7873: if ($response->is_error()) {
7874: unlink($transferfile);
7875: &logthis("Userfile repcopy failed for $uri");
7876: return -1;
7877: }
7878: # worked, rename the transfer file
7879: rename($transferfile,$file);
7880: return 'ok';
7881: }
7882:
7883: sub tokenwrapper {
7884: my $uri=shift;
7885: $uri=~s|^http\://([^/]+)||;
7886: $uri=~s|^/||;
7887: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7888: my $token=$1;
7889: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7890: if ($udom && $uname && $file) {
7891: $file=~s|(\?\.*)*$||;
7892: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7893: return 'http://'.&hostname(&homeserver($uname,$udom)).'/'.$uri.
7894: (($uri=~/\?/)?'&':'?').'token='.$token.
7895: '&tokenissued='.$perlvar{'lonHostID'};
7896: } else {
7897: return '/adm/notfound.html';
7898: }
7899: }
7900:
7901: # call with reqtype HEAD: get last modification time
7902: # call with reqtype GET: get the file contents
7903: # Do not call this with reqtype GET for large files! It loads everything into memory
7904: #
7905: sub getuploaded {
7906: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7907: $uri=~s/^\///;
7908: $uri = 'http://'.&hostname(&homeserver($cnum,$cdom)).'/raw/'.$uri;
7909: my $ua=new LWP::UserAgent;
7910: my $request=new HTTP::Request($reqtype,$uri);
7911: my $response=$ua->request($request);
7912: $$rtncode = $response->code;
7913: if (! $response->is_success()) {
7914: return 'failed';
7915: }
7916: if ($reqtype eq 'HEAD') {
7917: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7918: } elsif ($reqtype eq 'GET') {
7919: $$info = $response->content;
7920: }
7921: return 'ok';
7922: }
7923:
7924: sub readfile {
7925: my $file = shift;
7926: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7927: my $fh;
7928: open($fh,"<$file");
7929: my $a='';
7930: while (my $line = <$fh>) { $a .= $line; }
7931: return $a;
7932: }
7933:
7934: sub filelocation {
7935: my ($dir,$file) = @_;
7936: my $location;
7937: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7938:
7939: if ($file =~ m-^/adm/-) {
7940: $file=~s-^/adm/wrapper/-/-;
7941: $file=~s-^/adm/coursedocs/showdoc/-/-;
7942: }
7943:
7944: if ($file=~m:^/~:) { # is a contruction space reference
7945: $location = $file;
7946: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7947: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7948: # is a correct contruction space reference
7949: $location = $file;
7950: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7951: my ($udom,$uname,$filename)=
7952: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
7953: my $home=&homeserver($uname,$udom);
7954: my $is_me=0;
7955: my @ids=¤t_machine_ids();
7956: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7957: if ($is_me) {
7958: $location=&propath($udom,$uname).
7959: '/userfiles/'.$filename;
7960: } else {
7961: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7962: $udom.'/'.$uname.'/'.$filename;
7963: }
7964: } elsif ($file =~ m-^/adm/-) {
7965: $location = $perlvar{'lonDocRoot'}.'/'.$file;
7966: } else {
7967: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7968: $file=~s:^/res/:/:;
7969: if ( !( $file =~ m:^/:) ) {
7970: $location = $dir. '/'.$file;
7971: } else {
7972: $location = '/home/httpd/html/res'.$file;
7973: }
7974: }
7975: $location=~s://+:/:g; # remove duplicate /
7976: while ($location=~m{/\.\./}) {
7977: if ($location =~ m{/[^/]+/\.\./}) {
7978: $location=~ s{/[^/]+/\.\./}{/}g;
7979: } else {
7980: $location=~ s{/\.\./}{/}g;
7981: }
7982: } #remove dir/..
7983: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7984: return $location;
7985: }
7986:
7987: sub hreflocation {
7988: my ($dir,$file)=@_;
7989: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7990: $file=filelocation($dir,$file);
7991: } elsif ($file=~m-^/adm/-) {
7992: $file=~s-^/adm/wrapper/-/-;
7993: $file=~s-^/adm/coursedocs/showdoc/-/-;
7994: }
7995: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7996: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7997: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7998: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7999: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
8000: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
8001: -/uploaded/$1/$2/-x;
8002: }
8003: if ($file=~ m{^/userfiles/}) {
8004: $file =~ s{^/userfiles/}{/uploaded/};
8005: }
8006: return $file;
8007: }
8008:
8009: sub current_machine_domains {
8010: return &machine_domains(&hostname($perlvar{'lonHostID'}));
8011: }
8012:
8013: sub machine_domains {
8014: my ($hostname) = @_;
8015: my @domains;
8016: my %hostname = &all_hostnames();
8017: while( my($id, $name) = each(%hostname)) {
8018: # &logthis("-$id-$name-$hostname-");
8019: if ($hostname eq $name) {
8020: push(@domains,&host_domain($id));
8021: }
8022: }
8023: return @domains;
8024: }
8025:
8026: sub current_machine_ids {
8027: return &machine_ids(&hostname($perlvar{'lonHostID'}));
8028: }
8029:
8030: sub machine_ids {
8031: my ($hostname) = @_;
8032: $hostname ||= &hostname($perlvar{'lonHostID'});
8033: my @ids;
8034: my %name_to_host = &all_names();
8035: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
8036: return @{ $name_to_host{$hostname} };
8037: }
8038: return;
8039: }
8040:
8041: sub additional_machine_domains {
8042: my @domains;
8043: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
8044: while( my $line = <$fh>) {
8045: $line =~ s/\s//g;
8046: push(@domains,$line);
8047: }
8048: return @domains;
8049: }
8050:
8051: sub default_login_domain {
8052: my $domain = $perlvar{'lonDefDomain'};
8053: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
8054: foreach my $posdom (¤t_machine_domains(),
8055: &additional_machine_domains()) {
8056: if (lc($posdom) eq lc($testdomain)) {
8057: $domain=$posdom;
8058: last;
8059: }
8060: }
8061: return $domain;
8062: }
8063:
8064: # ------------------------------------------------------------- Declutters URLs
8065:
8066: sub declutter {
8067: my $thisfn=shift;
8068: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8069: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
8070: $thisfn=~s/^\///;
8071: $thisfn=~s|^adm/wrapper/||;
8072: $thisfn=~s|^adm/coursedocs/showdoc/||;
8073: $thisfn=~s/^res\///;
8074: $thisfn=~s/\?.+$//;
8075: return $thisfn;
8076: }
8077:
8078: # ------------------------------------------------------------- Clutter up URLs
8079:
8080: sub clutter {
8081: my $thisfn='/'.&declutter(shift);
8082: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
8083: || $thisfn =~ m{^/adm/(includes|pages)} ) {
8084: $thisfn='/res'.$thisfn;
8085: }
8086: if ($thisfn !~m|/adm|) {
8087: if ($thisfn =~ m|/ext/|) {
8088: $thisfn='/adm/wrapper'.$thisfn;
8089: } else {
8090: my ($ext) = ($thisfn =~ /\.(\w+)$/);
8091: my $embstyle=&Apache::loncommon::fileembstyle($ext);
8092: if ($embstyle eq 'ssi'
8093: || ($embstyle eq 'hdn')
8094: || ($embstyle eq 'rat')
8095: || ($embstyle eq 'prv')
8096: || ($embstyle eq 'ign')) {
8097: #do nothing with these
8098: } elsif (($embstyle eq 'img')
8099: || ($embstyle eq 'emb')
8100: || ($embstyle eq 'wrp')) {
8101: $thisfn='/adm/wrapper'.$thisfn;
8102: } elsif ($embstyle eq 'unk'
8103: && $thisfn!~/\.(sequence|page)$/) {
8104: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
8105: } else {
8106: # &logthis("Got a blank emb style");
8107: }
8108: }
8109: }
8110: return $thisfn;
8111: }
8112:
8113: sub clutter_with_no_wrapper {
8114: my $uri = &clutter(shift);
8115: if ($uri =~ m-^/adm/-) {
8116: $uri =~ s-^/adm/wrapper/-/-;
8117: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
8118: }
8119: return $uri;
8120: }
8121:
8122: sub freeze_escape {
8123: my ($value)=@_;
8124: if (ref($value)) {
8125: $value=&nfreeze($value);
8126: return '__FROZEN__'.&escape($value);
8127: }
8128: return &escape($value);
8129: }
8130:
8131:
8132: sub thaw_unescape {
8133: my ($value)=@_;
8134: if ($value =~ /^__FROZEN__/) {
8135: substr($value,0,10,undef);
8136: $value=&unescape($value);
8137: return &thaw($value);
8138: }
8139: return &unescape($value);
8140: }
8141:
8142: sub correct_line_ends {
8143: my ($result)=@_;
8144: $$result =~s/\r\n/\n/mg;
8145: $$result =~s/\r/\n/mg;
8146: }
8147: # ================================================================ Main Program
8148:
8149: sub goodbye {
8150: &logthis("Starting Shut down");
8151: #not converted to using infrastruture and probably shouldn't be
8152: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
8153: #converted
8154: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
8155: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
8156: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
8157: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
8158: #1.1 only
8159: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
8160: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
8161: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
8162: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
8163: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
8164: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
8165: &logthis(sprintf("%-20s is %s",'hits',$hits));
8166: &flushcourselogs();
8167: &logthis("Shutting down");
8168: }
8169:
8170: sub get_dns {
8171: my ($url,$func,$ignore_cache) = @_;
8172: if (!$ignore_cache) {
8173: my ($content,$cached)=
8174: &Apache::lonnet::is_cached_new('dns',$url);
8175: if ($cached) {
8176: &$func($content);
8177: return;
8178: }
8179: }
8180:
8181: my %alldns;
8182: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8183: foreach my $dns (<$config>) {
8184: next if ($dns !~ /^\^(\S*)/x);
8185: $alldns{$1} = 1;
8186: }
8187: while (%alldns) {
8188: my ($dns) = keys(%alldns);
8189: delete($alldns{$dns});
8190: my $ua=new LWP::UserAgent;
8191: my $request=new HTTP::Request('GET',"http://$dns$url");
8192: my $response=$ua->request($request);
8193: next if ($response->is_error());
8194: my @content = split("\n",$response->content);
8195: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
8196: &$func(\@content);
8197: return;
8198: }
8199: close($config);
8200: my $which = (split('/',$url))[3];
8201: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
8202: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
8203: my @content = <$config>;
8204: &$func(\@content);
8205: return;
8206: }
8207: # ------------------------------------------------------------ Read domain file
8208: {
8209: my $loaded;
8210: my %domain;
8211:
8212: sub parse_domain_tab {
8213: my ($lines) = @_;
8214: foreach my $line (@$lines) {
8215: next if ($line =~ /^(\#|\s*$ )/x);
8216:
8217: chomp($line);
8218: my ($name,@elements) = split(/:/,$line,9);
8219: my %this_domain;
8220: foreach my $field ('description', 'auth_def', 'auth_arg_def',
8221: 'lang_def', 'city', 'longi', 'lati',
8222: 'primary') {
8223: $this_domain{$field} = shift(@elements);
8224: }
8225: $domain{$name} = \%this_domain;
8226: }
8227: }
8228:
8229: sub reset_domain_info {
8230: undef($loaded);
8231: undef(%domain);
8232: }
8233:
8234: sub load_domain_tab {
8235: my ($ignore_cache) = @_;
8236: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
8237: my $fh;
8238: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
8239: my @lines = <$fh>;
8240: &parse_domain_tab(\@lines);
8241: }
8242: close($fh);
8243: $loaded = 1;
8244: }
8245:
8246: sub domain {
8247: &load_domain_tab() if (!$loaded);
8248:
8249: my ($name,$what) = @_;
8250: return if ( !exists($domain{$name}) );
8251:
8252: if (!$what) {
8253: return $domain{$name}{'description'};
8254: }
8255: return $domain{$name}{$what};
8256: }
8257: }
8258:
8259:
8260: # ------------------------------------------------------------- Read hosts file
8261: {
8262: my %hostname;
8263: my %hostdom;
8264: my %libserv;
8265: my $loaded;
8266: my %name_to_host;
8267:
8268: sub parse_hosts_tab {
8269: my ($file) = @_;
8270: foreach my $configline (@$file) {
8271: next if ($configline =~ /^(\#|\s*$ )/x);
8272: next if ($configline =~ /^\^/);
8273: chomp($configline);
8274: my ($id,$domain,$role,$name)=split(/:/,$configline);
8275: $name=~s/\s//g;
8276: if ($id && $domain && $role && $name) {
8277: $hostname{$id}=$name;
8278: push(@{$name_to_host{$name}}, $id);
8279: $hostdom{$id}=$domain;
8280: if ($role eq 'library') { $libserv{$id}=$name; }
8281: }
8282: }
8283: }
8284:
8285: sub reset_hosts_info {
8286: &purge_remembered();
8287: &reset_domain_info();
8288: &reset_hosts_ip_info();
8289: undef(%name_to_host);
8290: undef(%hostname);
8291: undef(%hostdom);
8292: undef(%libserv);
8293: undef($loaded);
8294: }
8295:
8296: sub load_hosts_tab {
8297: my ($ignore_cache) = @_;
8298: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
8299: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
8300: my @config = <$config>;
8301: &parse_hosts_tab(\@config);
8302: close($config);
8303: $loaded=1;
8304: }
8305:
8306: sub hostname {
8307: &load_hosts_tab() if (!$loaded);
8308:
8309: my ($lonid) = @_;
8310: return $hostname{$lonid};
8311: }
8312:
8313: sub all_hostnames {
8314: &load_hosts_tab() if (!$loaded);
8315:
8316: return %hostname;
8317: }
8318:
8319: sub all_names {
8320: &load_hosts_tab() if (!$loaded);
8321:
8322: return %name_to_host;
8323: }
8324:
8325: sub is_library {
8326: &load_hosts_tab() if (!$loaded);
8327:
8328: return exists($libserv{$_[0]});
8329: }
8330:
8331: sub all_library {
8332: &load_hosts_tab() if (!$loaded);
8333:
8334: return %libserv;
8335: }
8336:
8337: sub get_servers {
8338: &load_hosts_tab() if (!$loaded);
8339:
8340: my ($domain,$type) = @_;
8341: my %possible_hosts = ($type eq 'library') ? %libserv
8342: : %hostname;
8343: my %result;
8344: if (ref($domain) eq 'ARRAY') {
8345: while ( my ($host,$hostname) = each(%possible_hosts)) {
8346: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
8347: $result{$host} = $hostname;
8348: }
8349: }
8350: } else {
8351: while ( my ($host,$hostname) = each(%possible_hosts)) {
8352: if ($hostdom{$host} eq $domain) {
8353: $result{$host} = $hostname;
8354: }
8355: }
8356: }
8357: return %result;
8358: }
8359:
8360: sub host_domain {
8361: &load_hosts_tab() if (!$loaded);
8362:
8363: my ($lonid) = @_;
8364: return $hostdom{$lonid};
8365: }
8366:
8367: sub all_domains {
8368: &load_hosts_tab() if (!$loaded);
8369:
8370: my %seen;
8371: my @uniq = grep(!$seen{$_}++, values(%hostdom));
8372: return @uniq;
8373: }
8374: }
8375:
8376: {
8377: my %iphost;
8378: my %name_to_ip;
8379: my %lonid_to_ip;
8380:
8381: sub get_hosts_from_ip {
8382: my ($ip) = @_;
8383: my %iphosts = &get_iphost();
8384: if (ref($iphosts{$ip})) {
8385: return @{$iphosts{$ip}};
8386: }
8387: return;
8388: }
8389:
8390: sub reset_hosts_ip_info {
8391: undef(%iphost);
8392: undef(%name_to_ip);
8393: undef(%lonid_to_ip);
8394: }
8395:
8396: sub get_host_ip {
8397: my ($lonid) = @_;
8398: if (exists($lonid_to_ip{$lonid})) {
8399: return $lonid_to_ip{$lonid};
8400: }
8401: my $name=&hostname($lonid);
8402: my $ip = gethostbyname($name);
8403: return if (!$ip || length($ip) ne 4);
8404: $ip=inet_ntoa($ip);
8405: $name_to_ip{$name} = $ip;
8406: $lonid_to_ip{$lonid} = $ip;
8407: return $ip;
8408: }
8409:
8410: sub get_iphost {
8411: my ($ignore_cache) = @_;
8412:
8413: if (!$ignore_cache) {
8414: if (%iphost) {
8415: return %iphost;
8416: }
8417: my ($ip_info,$cached)=
8418: &Apache::lonnet::is_cached_new('iphost','iphost');
8419: if ($cached) {
8420: %iphost = %{$ip_info->[0]};
8421: %name_to_ip = %{$ip_info->[1]};
8422: %lonid_to_ip = %{$ip_info->[2]};
8423: return %iphost;
8424: }
8425: }
8426:
8427: # get yesterday's info for fallback
8428: my %old_name_to_ip;
8429: my ($ip_info,$cached)=
8430: &Apache::lonnet::is_cached_new('iphost','iphost');
8431: if ($cached) {
8432: %old_name_to_ip = %{$ip_info->[1]};
8433: }
8434:
8435: my %name_to_host = &all_names();
8436: foreach my $name (keys(%name_to_host)) {
8437: my $ip;
8438: if (!exists($name_to_ip{$name})) {
8439: $ip = gethostbyname($name);
8440: if (!$ip || length($ip) ne 4) {
8441: if (defined($old_name_to_ip{$name})) {
8442: $ip = $old_name_to_ip{$name};
8443: &logthis("Can't find $name defaulting to old $ip");
8444: } else {
8445: &logthis("Name $name no IP found");
8446: next;
8447: }
8448: } else {
8449: $ip=inet_ntoa($ip);
8450: }
8451: $name_to_ip{$name} = $ip;
8452: } else {
8453: $ip = $name_to_ip{$name};
8454: }
8455: foreach my $id (@{ $name_to_host{$name} }) {
8456: $lonid_to_ip{$id} = $ip;
8457: }
8458: push(@{$iphost{$ip}},@{$name_to_host{$name}});
8459: }
8460: &Apache::lonnet::do_cache_new('iphost','iphost',
8461: [\%iphost,\%name_to_ip,\%lonid_to_ip],
8462: 48*60*60);
8463:
8464: return %iphost;
8465: }
8466: }
8467:
8468: BEGIN {
8469:
8470: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
8471: unless ($readit) {
8472: {
8473: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
8474: %perlvar = (%perlvar,%{$configvars});
8475: }
8476:
8477:
8478: # ------------------------------------------------------ Read spare server file
8479: {
8480: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
8481:
8482: while (my $configline=<$config>) {
8483: chomp($configline);
8484: if ($configline) {
8485: my ($host,$type) = split(':',$configline,2);
8486: if (!defined($type) || $type eq '') { $type = 'default' };
8487: push(@{ $spareid{$type} }, $host);
8488: }
8489: }
8490: close($config);
8491: }
8492: # ------------------------------------------------------------ Read permissions
8493: {
8494: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
8495:
8496: while (my $configline=<$config>) {
8497: chomp($configline);
8498: if ($configline) {
8499: my ($role,$perm)=split(/ /,$configline);
8500: if ($perm ne '') { $pr{$role}=$perm; }
8501: }
8502: }
8503: close($config);
8504: }
8505:
8506: # -------------------------------------------- Read plain texts for permissions
8507: {
8508: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
8509:
8510: while (my $configline=<$config>) {
8511: chomp($configline);
8512: if ($configline) {
8513: my ($short,@plain)=split(/:/,$configline);
8514: %{$prp{$short}} = ();
8515: if (@plain > 0) {
8516: $prp{$short}{'std'} = $plain[0];
8517: for (my $i=1; $i<@plain; $i++) {
8518: $prp{$short}{'alt'.$i} = $plain[$i];
8519: }
8520: }
8521: }
8522: }
8523: close($config);
8524: }
8525:
8526: # ---------------------------------------------------------- Read package table
8527: {
8528: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
8529:
8530: while (my $configline=<$config>) {
8531: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
8532: chomp($configline);
8533: my ($short,$plain)=split(/:/,$configline);
8534: my ($pack,$name)=split(/\&/,$short);
8535: if ($plain ne '') {
8536: $packagetab{$pack.'&'.$name.'&name'}=$name;
8537: $packagetab{$short}=$plain;
8538: }
8539: }
8540: close($config);
8541: }
8542:
8543: # ------------- set up temporary directory
8544: {
8545: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
8546:
8547: }
8548:
8549: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
8550: 'compress_threshold'=> 20_000,
8551: });
8552:
8553: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
8554: $dumpcount=0;
8555:
8556: &logtouch();
8557: &logthis('<font color="yellow">INFO: Read configuration</font>');
8558: $readit=1;
8559: {
8560: use integer;
8561: my $test=(2**32)+1;
8562: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
8563: &logthis(" Detected 64bit platform ($_64bit)");
8564: }
8565: }
8566: }
8567:
8568: 1;
8569: __END__
8570:
8571: =pod
8572:
8573: =head1 NAME
8574:
8575: Apache::lonnet - Subroutines to ask questions about things in the network.
8576:
8577: =head1 SYNOPSIS
8578:
8579: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
8580:
8581: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
8582:
8583: Common parameters:
8584:
8585: =over 4
8586:
8587: =item *
8588:
8589: $uname : an internal username (if $cname expecting a course Id specifically)
8590:
8591: =item *
8592:
8593: $udom : a domain (if $cdom expecting a course's domain specifically)
8594:
8595: =item *
8596:
8597: $symb : a resource instance identifier
8598:
8599: =item *
8600:
8601: $namespace : the name of a .db file that contains the data needed or
8602: being set.
8603:
8604: =back
8605:
8606: =head1 OVERVIEW
8607:
8608: lonnet provides subroutines which interact with the
8609: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
8610: about classes, users, and resources.
8611:
8612: For many of these objects you can also use this to store data about
8613: them or modify them in various ways.
8614:
8615: =head2 Symbs
8616:
8617: To identify a specific instance of a resource, LON-CAPA uses symbols
8618: or "symbs"X<symb>. These identifiers are built from the URL of the
8619: map, the resource number of the resource in the map, and the URL of
8620: the resource itself. The latter is somewhat redundant, but might help
8621: if maps change.
8622:
8623: An example is
8624:
8625: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
8626:
8627: The respective map entry is
8628:
8629: <resource id="19" src="/res/msu/korte/tests/part12.problem"
8630: title="Problem 2">
8631: </resource>
8632:
8633: Symbs are used by the random number generator, as well as to store and
8634: restore data specific to a certain instance of for example a problem.
8635:
8636: =head2 Storing And Retrieving Data
8637:
8638: X<store()>X<cstore()>X<restore()>Three of the most important functions
8639: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
8640: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
8641: is is the non-critical message twin of cstore. These functions are for
8642: handlers to store a perl hash to a user's permanent data space in an
8643: easy manner, and to retrieve it again on another call. It is expected
8644: that a handler would use this once at the beginning to retrieve data,
8645: and then again once at the end to send only the new data back.
8646:
8647: The data is stored in the user's data directory on the user's
8648: homeserver under the ID of the course.
8649:
8650: The hash that is returned by restore will have all of the previous
8651: value for all of the elements of the hash.
8652:
8653: Example:
8654:
8655: #creating a hash
8656: my %hash;
8657: $hash{'foo'}='bar';
8658:
8659: #storing it
8660: &Apache::lonnet::cstore(\%hash);
8661:
8662: #changing a value
8663: $hash{'foo'}='notbar';
8664:
8665: #adding a new value
8666: $hash{'bar'}='foo';
8667: &Apache::lonnet::cstore(\%hash);
8668:
8669: #retrieving the hash
8670: my %history=&Apache::lonnet::restore();
8671:
8672: #print the hash
8673: foreach my $key (sort(keys(%history))) {
8674: print("\%history{$key} = $history{$key}");
8675: }
8676:
8677: Will print out:
8678:
8679: %history{1:foo} = bar
8680: %history{1:keys} = foo:timestamp
8681: %history{1:timestamp} = 990455579
8682: %history{2:bar} = foo
8683: %history{2:foo} = notbar
8684: %history{2:keys} = foo:bar:timestamp
8685: %history{2:timestamp} = 990455580
8686: %history{bar} = foo
8687: %history{foo} = notbar
8688: %history{timestamp} = 990455580
8689: %history{version} = 2
8690:
8691: Note that the special hash entries C<keys>, C<version> and
8692: C<timestamp> were added to the hash. C<version> will be equal to the
8693: total number of versions of the data that have been stored. The
8694: C<timestamp> attribute will be the UNIX time the hash was
8695: stored. C<keys> is available in every historical section to list which
8696: keys were added or changed at a specific historical revision of a
8697: hash.
8698:
8699: B<Warning>: do not store the hash that restore returns directly. This
8700: will cause a mess since it will restore the historical keys as if the
8701: were new keys. I.E. 1:foo will become 1:1:foo etc.
8702:
8703: Calling convention:
8704:
8705: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
8706: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
8707:
8708: For more detailed information, see lonnet specific documentation.
8709:
8710: =head1 RETURN MESSAGES
8711:
8712: =over 4
8713:
8714: =item * B<con_lost>: unable to contact remote host
8715:
8716: =item * B<con_delayed>: unable to contact remote host, message will be delivered
8717: when the connection is brought back up
8718:
8719: =item * B<con_failed>: unable to contact remote host and unable to save message
8720: for later delivery
8721:
8722: =item * B<error:>: an error a occured, a description of the error follows the :
8723:
8724: =item * B<no_such_host>: unable to fund a host associated with the user/domain
8725: that was requested
8726:
8727: =back
8728:
8729: =head1 PUBLIC SUBROUTINES
8730:
8731: =head2 Session Environment Functions
8732:
8733: =over 4
8734:
8735: =item *
8736: X<appenv()>
8737: B<appenv(%hash)>: the value of %hash is written to
8738: the user envirnoment file, and will be restored for each access this
8739: user makes during this session, also modifies the %env for the current
8740: process
8741:
8742: =item *
8743: X<delenv()>
8744: B<delenv($regexp)>: removes all items from the session
8745: environment file that matches the regular expression in $regexp. The
8746: values are also delted from the current processes %env.
8747:
8748: =item * get_env_multiple($name)
8749:
8750: gets $name from the %env hash, it seemlessly handles the cases where multiple
8751: values may be defined and end up as an array ref.
8752:
8753: returns an array of values
8754:
8755: =back
8756:
8757: =head2 User Information
8758:
8759: =over 4
8760:
8761: =item *
8762: X<queryauthenticate()>
8763: B<queryauthenticate($uname,$udom)>: try to determine user's current
8764: authentication scheme
8765:
8766: =item *
8767: X<authenticate()>
8768: B<authenticate($uname,$upass,$udom)>: try to
8769: authenticate user from domain's lib servers (first use the current
8770: one). C<$upass> should be the users password.
8771:
8772: =item *
8773: X<homeserver()>
8774: B<homeserver($uname,$udom)>: find the server which has
8775: the user's directory and files (there must be only one), this caches
8776: the answer, and also caches if there is a borken connection.
8777:
8778: =item *
8779: X<idget()>
8780: B<idget($udom,@ids)>: find the usernames behind a list of IDs
8781: (IDs are a unique resource in a domain, there must be only 1 ID per
8782: username, and only 1 username per ID in a specific domain) (returns
8783: hash: id=>name,id=>name)
8784:
8785: =item *
8786: X<idrget()>
8787: B<idrget($udom,@unames)>: find the IDs behind a list of
8788: usernames (returns hash: name=>id,name=>id)
8789:
8790: =item *
8791: X<idput()>
8792: B<idput($udom,%ids)>: store away a list of names and associated IDs
8793:
8794: =item *
8795: X<rolesinit()>
8796: B<rolesinit($udom,$username,$authhost)>: get user privileges
8797:
8798: =item *
8799: X<getsection()>
8800: B<getsection($udom,$uname,$cname)>: finds the section of student in the
8801: course $cname, return section name/number or '' for "not in course"
8802: and '-1' for "no section"
8803:
8804: =item *
8805: X<userenvironment()>
8806: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
8807: passed in @what from the requested user's environment, returns a hash
8808:
8809: =item *
8810: X<userlog_query()>
8811: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
8812: activity.log file. %filters defines filters applied when parsing the
8813: log file. These can be start or end timestamps, or the type of action
8814: - log to look for Login or Logout events, check for Checkin or
8815: Checkout, role for role selection. The response is in the form
8816: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
8817: escaped strings of the action recorded in the activity.log file.
8818:
8819: =back
8820:
8821: =head2 User Roles
8822:
8823: =over 4
8824:
8825: =item *
8826:
8827: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
8828: F: full access
8829: U,I,K: authentication modes (cxx only)
8830: '': forbidden
8831: 1: user needs to choose course
8832: 2: browse allowed
8833: A: passphrase authentication needed
8834:
8835: =item *
8836:
8837: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
8838: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
8839: and course level
8840:
8841: =item *
8842:
8843: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
8844: explanation of a user role term
8845:
8846: =item *
8847:
8848: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms) :
8849: All arguments are optional. Returns a hash of a roles, either for
8850: co-author/assistant author roles for a user's Construction Space
8851: (default), or if $context is 'userroles', roles for the user himself,
8852: In the hash, keys are set to colon-sparated $uname,$udom,and $role,
8853: and value is set to colon-separated start and end times for the role.
8854: If no username and domain are specified, will default to current
8855: user/domain. Types, roles, and roledoms are references to arrays,
8856: of role statuses (active, future or previous), roles
8857: (e.g., cc,in, st etc.) and domains of the roles which can be used
8858: to restrict the list of roles reported. If no array ref is
8859: provided for types, will default to return only active roles.
8860:
8861: =back
8862:
8863: =head2 User Modification
8864:
8865: =over 4
8866:
8867: =item *
8868:
8869: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
8870: user for the level given by URL. Optional start and end dates (leave empty
8871: string or zero for "no date")
8872:
8873: =item *
8874:
8875: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
8876: change a users, password, possible return values are: ok,
8877: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
8878: refused
8879:
8880: =item *
8881:
8882: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
8883:
8884: =item *
8885:
8886: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
8887: modify user
8888:
8889: =item *
8890:
8891: modifystudent
8892:
8893: modify a students enrollment and identification information.
8894: The course id is resolved based on the current users environment.
8895: This means the envoking user must be a course coordinator or otherwise
8896: associated with a course.
8897:
8898: This call is essentially a wrapper for lonnet::modifyuser and
8899: lonnet::modify_student_enrollment
8900:
8901: Inputs:
8902:
8903: =over 4
8904:
8905: =item B<$udom> Students loncapa domain
8906:
8907: =item B<$uname> Students loncapa login name
8908:
8909: =item B<$uid> Students id/student number
8910:
8911: =item B<$umode> Students authentication mode
8912:
8913: =item B<$upass> Students password
8914:
8915: =item B<$first> Students first name
8916:
8917: =item B<$middle> Students middle name
8918:
8919: =item B<$last> Students last name
8920:
8921: =item B<$gene> Students generation
8922:
8923: =item B<$usec> Students section in course
8924:
8925: =item B<$end> Unix time of the roles expiration
8926:
8927: =item B<$start> Unix time of the roles start date
8928:
8929: =item B<$forceid> If defined, allow $uid to be changed
8930:
8931: =item B<$desiredhome> server to use as home server for student
8932:
8933: =back
8934:
8935: =item *
8936:
8937: modify_student_enrollment
8938:
8939: Change a students enrollment status in a class. The environment variable
8940: 'role.request.course' must be defined for this function to proceed.
8941:
8942: Inputs:
8943:
8944: =over 4
8945:
8946: =item $udom, students domain
8947:
8948: =item $uname, students name
8949:
8950: =item $uid, students user id
8951:
8952: =item $first, students first name
8953:
8954: =item $middle
8955:
8956: =item $last
8957:
8958: =item $gene
8959:
8960: =item $usec
8961:
8962: =item $end
8963:
8964: =item $start
8965:
8966: =back
8967:
8968:
8969: =item *
8970:
8971: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
8972: custom role; give a custom role to a user for the level given by URL. Specify
8973: name and domain of role author, and role name
8974:
8975: =item *
8976:
8977: revokerole($udom,$uname,$url,$role) : revoke a role for url
8978:
8979: =item *
8980:
8981: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
8982:
8983: =back
8984:
8985: =head2 Course Infomation
8986:
8987: =over 4
8988:
8989: =item *
8990:
8991: coursedescription($courseid) : returns a hash of information about the
8992: specified course id, including all environment settings for the
8993: course, the description of the course will be in the hash under the
8994: key 'description'
8995:
8996: =item *
8997:
8998: resdata($name,$domain,$type,@which) : request for current parameter
8999: setting for a specific $type, where $type is either 'course' or 'user',
9000: @what should be a list of parameters to ask about. This routine caches
9001: answers for 5 minutes.
9002:
9003: =item *
9004:
9005: get_courseresdata($courseid, $domain) : dump the entire course resource
9006: data base, returning a hash that is keyed by the resource name and has
9007: values that are the resource value. I believe that the timestamps and
9008: versions are also returned.
9009:
9010:
9011: =back
9012:
9013: =head2 Course Modification
9014:
9015: =over 4
9016:
9017: =item *
9018:
9019: writecoursepref($courseid,%prefs) : write preferences (environment
9020: database) for a course
9021:
9022: =item *
9023:
9024: createcourse($udom,$description,$url) : make/modify course
9025:
9026: =back
9027:
9028: =head2 Resource Subroutines
9029:
9030: =over 4
9031:
9032: =item *
9033:
9034: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
9035:
9036: =item *
9037:
9038: repcopy($filename) : subscribes to the requested file, and attempts to
9039: replicate from the owning library server, Might return
9040: 'unavailable', 'not_found', 'forbidden', 'ok', or
9041: 'bad_request', also attempts to grab the metadata for the
9042: resource. Expects the local filesystem pathname
9043: (/home/httpd/html/res/....)
9044:
9045: =back
9046:
9047: =head2 Resource Information
9048:
9049: =over 4
9050:
9051: =item *
9052:
9053: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
9054: a vairety of different possible values, $varname should be a request
9055: string, and the other parameters can be used to specify who and what
9056: one is asking about.
9057:
9058: Possible values for $varname are environment.lastname (or other item
9059: from the envirnment hash), user.name (or someother aspect about the
9060: user), resource.0.maxtries (or some other part and parameter of a
9061: resource)
9062:
9063: =item *
9064:
9065: directcondval($number) : get current value of a condition; reads from a state
9066: string
9067:
9068: =item *
9069:
9070: condval($condidx) : value of condition index based on state
9071:
9072: =item *
9073:
9074: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
9075: resource's metadata, $what should be either a specific key, or either
9076: 'keys' (to get a list of possible keys) or 'packages' to get a list of
9077: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
9078:
9079: this function automatically caches all requests
9080:
9081: =item *
9082:
9083: metadata_query($query,$custom,$customshow) : make a metadata query against the
9084: network of library servers; returns file handle of where SQL and regex results
9085: will be stored for query
9086:
9087: =item *
9088:
9089: symbread($filename) : return symbolic list entry (filename argument optional);
9090: returns the data handle
9091:
9092: =item *
9093:
9094: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
9095: a possible symb for the URL in $thisfn, and if is an encryypted
9096: resource that the user accessed using /enc/ returns a 1 on success, 0
9097: on failure, user must be in a course, as it assumes the existance of
9098: the course initial hash, and uses $env('request.course.id'}
9099:
9100:
9101: =item *
9102:
9103: symbclean($symb) : removes versions numbers from a symb, returns the
9104: cleaned symb
9105:
9106: =item *
9107:
9108: is_on_map($uri) : checks if the $uri is somewhere on the current
9109: course map, user must be in a course for it to work.
9110:
9111: =item *
9112:
9113: numval($salt) : return random seed value (addend for rndseed)
9114:
9115: =item *
9116:
9117: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
9118: a random seed, all arguments are optional, if they aren't sent it uses the
9119: environment to derive them. Note: if symb isn't sent and it can't get one
9120: from &symbread it will use the current time as its return value
9121:
9122: =item *
9123:
9124: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
9125: unfakeable, receipt
9126:
9127: =item *
9128:
9129: receipt() : API to ireceipt working off of env values; given out to users
9130:
9131: =item *
9132:
9133: countacc($url) : count the number of accesses to a given URL
9134:
9135: =item *
9136:
9137: 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
9138:
9139: =item *
9140:
9141: 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)
9142:
9143: =item *
9144:
9145: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
9146:
9147: =item *
9148:
9149: devalidate($symb) : devalidate temporary spreadsheet calculations,
9150: forcing spreadsheet to reevaluate the resource scores next time.
9151:
9152: =back
9153:
9154: =head2 Storing/Retreiving Data
9155:
9156: =over 4
9157:
9158: =item *
9159:
9160: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
9161: for this url; hashref needs to be given and should be a \%hashname; the
9162: remaining args aren't required and if they aren't passed or are '' they will
9163: be derived from the env
9164:
9165: =item *
9166:
9167: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
9168: uses critical subroutine
9169:
9170: =item *
9171:
9172: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
9173: all args are optional
9174:
9175: =item *
9176:
9177: dumpstore($namespace,$udom,$uname,$regexp,$range) :
9178: dumps the complete (or key matching regexp) namespace into a hash
9179: ($udom, $uname, $regexp, $range are optional) for a namespace that is
9180: normally &store()ed into
9181:
9182: $range should be either an integer '100' (give me the first 100
9183: matching records)
9184: or be two integers sperated by a - with no spaces
9185: '30-50' (give me the 30th through the 50th matching
9186: records)
9187:
9188:
9189: =item *
9190:
9191: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
9192: replaces a &store() version of data with a replacement set of data
9193: for a particular resource in a namespace passed in the $storehash hash
9194: reference
9195:
9196: =item *
9197:
9198: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
9199: works very similar to store/cstore, but all data is stored in a
9200: temporary location and can be reset using tmpreset, $storehash should
9201: be a hash reference, returns nothing on success
9202:
9203: =item *
9204:
9205: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
9206: similar to restore, but all data is stored in a temporary location and
9207: can be reset using tmpreset. Returns a hash of values on success,
9208: error string otherwise.
9209:
9210: =item *
9211:
9212: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
9213: deltes all keys for $symb form the temporary storage hash.
9214:
9215: =item *
9216:
9217: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9218: reference filled in from namesp ($udom and $uname are optional)
9219:
9220: =item *
9221:
9222: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
9223: namesp ($udom and $uname are optional)
9224:
9225: =item *
9226:
9227: dump($namespace,$udom,$uname,$regexp,$range) :
9228: dumps the complete (or key matching regexp) namespace into a hash
9229: ($udom, $uname, $regexp, $range are optional)
9230:
9231: $range should be either an integer '100' (give me the first 100
9232: matching records)
9233: or be two integers sperated by a - with no spaces
9234: '30-50' (give me the 30th through the 50th matching
9235: records)
9236: =item *
9237:
9238: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
9239: $store can be a scalar, an array reference, or if the amount to be
9240: incremented is > 1, a hash reference.
9241:
9242: ($udom and $uname are optional)
9243:
9244: =item *
9245:
9246: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
9247: ($udom and $uname are optional)
9248:
9249: =item *
9250:
9251: cput($namespace,$storehash,$udom,$uname) : critical put
9252: ($udom and $uname are optional)
9253:
9254: =item *
9255:
9256: newput($namespace,$storehash,$udom,$uname) :
9257:
9258: Attempts to store the items in the $storehash, but only if they don't
9259: currently exist, if this succeeds you can be certain that you have
9260: successfully created a new key value pair in the $namespace db.
9261:
9262:
9263: Args:
9264: $namespace: name of database to store values to
9265: $storehash: hashref to store to the db
9266: $udom: (optional) domain of user containing the db
9267: $uname: (optional) name of user caontaining the db
9268:
9269: Returns:
9270: 'ok' -> succeeded in storing all keys of $storehash
9271: 'key_exists: <key>' -> failed to anything out of $storehash, as at
9272: least <key> already existed in the db (other
9273: requested keys may also already exist)
9274: 'error: <msg>' -> unable to tie the DB or other erorr occured
9275: 'con_lost' -> unable to contact request server
9276: 'refused' -> action was not allowed by remote machine
9277:
9278:
9279: =item *
9280:
9281: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
9282: reference filled in from namesp (encrypts the return communication)
9283: ($udom and $uname are optional)
9284:
9285: =item *
9286:
9287: log($udom,$name,$home,$message) : write to permanent log for user; use
9288: critical subroutine
9289:
9290: =item *
9291:
9292: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
9293: array reference filled in from namespace found in domain level on either
9294: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
9295:
9296: =item *
9297:
9298: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
9299: domain level either on specified domain server ($uhome) or primary domain
9300: server ($udom and $uhome are optional)
9301:
9302: =back
9303:
9304: =head2 Network Status Functions
9305:
9306: =over 4
9307:
9308: =item *
9309:
9310: dirlist($uri) : return directory list based on URI
9311:
9312: =item *
9313:
9314: spareserver() : find server with least workload from spare.tab
9315:
9316: =back
9317:
9318: =head2 Apache Request
9319:
9320: =over 4
9321:
9322: =item *
9323:
9324: ssi($url,%hash) : server side include, does a complete request cycle on url to
9325: localhost, posts hash
9326:
9327: =back
9328:
9329: =head2 Data to String to Data
9330:
9331: =over 4
9332:
9333: =item *
9334:
9335: hash2str(%hash) : convert a hash into a string complete with escaping and '='
9336: and '&' separators, supports elements that are arrayrefs and hashrefs
9337:
9338: =item *
9339:
9340: hashref2str($hashref) : convert a hashref into a string complete with
9341: escaping and '=' and '&' separators, supports elements that are
9342: arrayrefs and hashrefs
9343:
9344: =item *
9345:
9346: arrayref2str($arrayref) : convert an arrayref into a string complete
9347: with escaping and '&' separators, supports elements that are arrayrefs
9348: and hashrefs
9349:
9350: =item *
9351:
9352: str2hash($string) : convert string to hash using unescaping and
9353: splitting on '=' and '&', supports elements that are arrayrefs and
9354: hashrefs
9355:
9356: =item *
9357:
9358: str2array($string) : convert string to hash using unescaping and
9359: splitting on '&', supports elements that are arrayrefs and hashrefs
9360:
9361: =back
9362:
9363: =head2 Logging Routines
9364:
9365: =over 4
9366:
9367: These routines allow one to make log messages in the lonnet.log and
9368: lonnet.perm logfiles.
9369:
9370: =item *
9371:
9372: logtouch() : make sure the logfile, lonnet.log, exists
9373:
9374: =item *
9375:
9376: logthis() : append message to the normal lonnet.log file, it gets
9377: preiodically rolled over and deleted.
9378:
9379: =item *
9380:
9381: logperm() : append a permanent message to lonnet.perm.log, this log
9382: file never gets deleted by any automated portion of the system, only
9383: messages of critical importance should go in here.
9384:
9385: =back
9386:
9387: =head2 General File Helper Routines
9388:
9389: =over 4
9390:
9391: =item *
9392:
9393: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
9394: (a) files in /uploaded
9395: (i) If a local copy of the file exists -
9396: compares modification date of local copy with last-modified date for
9397: definitive version stored on home server for course. If local copy is
9398: stale, requests a new version from the home server and stores it.
9399: If the original has been removed from the home server, then local copy
9400: is unlinked.
9401: (ii) If local copy does not exist -
9402: requests the file from the home server and stores it.
9403:
9404: If $caller is 'uploadrep':
9405: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
9406: for request for files originally uploaded via DOCS.
9407: - returns 'ok' if fresh local copy now available, -1 otherwise.
9408:
9409: Otherwise:
9410: This indicates a call from the content generation phase of the request.
9411: - returns the entire contents of the file or -1.
9412:
9413: (b) files in /res
9414: - returns the entire contents of a file or -1;
9415: it properly subscribes to and replicates the file if neccessary.
9416:
9417:
9418: =item *
9419:
9420: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
9421: reference
9422:
9423: returns either a stat() list of data about the file or an empty list
9424: if the file doesn't exist or couldn't find out about it (connection
9425: problems or user unknown)
9426:
9427: =item *
9428:
9429: filelocation($dir,$file) : returns file system location of a file
9430: based on URI; meant to be "fairly clean" absolute reference, $dir is a
9431: directory that relative $file lookups are to looked in ($dir of /a/dir
9432: and a file of ../bob will become /a/bob)
9433:
9434: =item *
9435:
9436: hreflocation($dir,$file) : returns file system location or a URL; same as
9437: filelocation except for hrefs
9438:
9439: =item *
9440:
9441: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
9442:
9443: =back
9444:
9445: =head2 Usererfile file routines (/uploaded*)
9446:
9447: =over 4
9448:
9449: =item *
9450:
9451: userfileupload(): main rotine for putting a file in a user or course's
9452: filespace, arguments are,
9453:
9454: formname - required - this is the name of the element in $env where the
9455: filename, and the contents of the file to create/modifed exist
9456: the filename is in $env{'form.'.$formname.'.filename'} and the
9457: contents of the file is located in $env{'form.'.$formname}
9458: coursedoc - if true, store the file in the course of the active role
9459: of the current user
9460: subdir - required - subdirectory to put the file in under ../userfiles/
9461: if undefined, it will be placed in "unknown"
9462:
9463: (This routine calls clean_filename() to remove any dangerous
9464: characters from the filename, and then calls finuserfileupload() to
9465: complete the transaction)
9466:
9467: returns either the url of the uploaded file (/uploaded/....) if successful
9468: and /adm/notfound.html if unsuccessful
9469:
9470: =item *
9471:
9472: clean_filename(): routine for cleaing a filename up for storage in
9473: userfile space, argument is:
9474:
9475: filename - proposed filename
9476:
9477: returns: the new clean filename
9478:
9479: =item *
9480:
9481: finishuserfileupload(): routine that creaes and sends the file to
9482: userspace, probably shouldn't be called directly
9483:
9484: docuname: username or courseid of destination for the file
9485: docudom: domain of user/course of destination for the file
9486: formname: same as for userfileupload()
9487: fname: filename (inculding subdirectories) for the file
9488:
9489: returns either the url of the uploaded file (/uploaded/....) if successful
9490: and /adm/notfound.html if unsuccessful
9491:
9492: =item *
9493:
9494: renameuserfile(): renames an existing userfile to a new name
9495:
9496: Args:
9497: docuname: username or courseid of destination for the file
9498: docudom: domain of user/course of destination for the file
9499: old: current file name (including any subdirs under userfiles)
9500: new: desired file name (including any subdirs under userfiles)
9501:
9502: =item *
9503:
9504: mkdiruserfile(): creates a directory is a userfiles dir
9505:
9506: Args:
9507: docuname: username or courseid of destination for the file
9508: docudom: domain of user/course of destination for the file
9509: dir: dir to create (including any subdirs under userfiles)
9510:
9511: =item *
9512:
9513: removeuserfile(): removes a file that exists in userfiles
9514:
9515: Args:
9516: docuname: username or courseid of destination for the file
9517: docudom: domain of user/course of destination for the file
9518: fname: filname to delete (including any subdirs under userfiles)
9519:
9520: =item *
9521:
9522: removeuploadedurl(): convience function for removeuserfile()
9523:
9524: Args:
9525: url: a full /uploaded/... url to delete
9526:
9527: =item *
9528:
9529: get_portfile_permissions():
9530: Args:
9531: domain: domain of user or course contain the portfolio files
9532: user: name of user or num of course contain the portfolio files
9533: Returns:
9534: hashref of a dump of the proper file_permissions.db
9535:
9536:
9537: =item *
9538:
9539: get_access_controls():
9540:
9541: Args:
9542: current_permissions: the hash ref returned from get_portfile_permissions()
9543: group: (optional) the group you want the files associated with
9544: file: (optional) the file you want access info on
9545:
9546: Returns:
9547: a hash (keys are file names) of hashes containing
9548: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
9549: values are XML containing access control settings (see below)
9550:
9551: Internal notes:
9552:
9553: access controls are stored in file_permissions.db as key=value pairs.
9554: key -> path to file/file_name\0uniqueID:scope_end_start
9555: where scope -> public,guest,course,group,domains or users.
9556: end -> UNIX time for end of access (0 -> no end date)
9557: start -> UNIX time for start of access
9558:
9559: value -> XML description of access control
9560: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
9561: <start></start>
9562: <end></end>
9563:
9564: <password></password> for scope type = guest
9565:
9566: <domain></domain> for scope type = course or group
9567: <number></number>
9568: <roles id="">
9569: <role></role>
9570: <access></access>
9571: <section></section>
9572: <group></group>
9573: </roles>
9574:
9575: <dom></dom> for scope type = domains
9576:
9577: <users> for scope type = users
9578: <user>
9579: <uname></uname>
9580: <udom></udom>
9581: </user>
9582: </users>
9583: </scope>
9584:
9585: Access data is also aggregated for each file in an additional key=value pair:
9586: key -> path to file/file_name\0accesscontrol
9587: value -> reference to hash
9588: hash contains key = value pairs
9589: where key = uniqueID:scope_end_start
9590: value = UNIX time record was last updated
9591:
9592: Used to improve speed of look-ups of access controls for each file.
9593:
9594: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
9595:
9596: modify_access_controls():
9597:
9598: Modifies access controls for a portfolio file
9599: Args
9600: 1. file name
9601: 2. reference to hash of required changes,
9602: 3. domain
9603: 4. username
9604: where domain,username are the domain of the portfolio owner
9605: (either a user or a course)
9606:
9607: Returns:
9608: 1. result of additions or updates ('ok' or 'error', with error message).
9609: 2. result of deletions ('ok' or 'error', with error message).
9610: 3. reference to hash of any new or updated access controls.
9611: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
9612: key = integer (inbound ID)
9613: value = uniqueID
9614:
9615: =back
9616:
9617: =head2 HTTP Helper Routines
9618:
9619: =over 4
9620:
9621: =item *
9622:
9623: escape() : unpack non-word characters into CGI-compatible hex codes
9624:
9625: =item *
9626:
9627: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
9628:
9629: =back
9630:
9631: =head1 PRIVATE SUBROUTINES
9632:
9633: =head2 Underlying communication routines (Shouldn't call)
9634:
9635: =over 4
9636:
9637: =item *
9638:
9639: subreply() : tries to pass a message to lonc, returns con_lost if incapable
9640:
9641: =item *
9642:
9643: reply() : uses subreply to send a message to remote machine, logs all failures
9644:
9645: =item *
9646:
9647: critical() : passes a critical message to another server; if cannot
9648: get through then place message in connection buffer directory and
9649: returns con_delayed, if incapable of saving message, returns
9650: con_failed
9651:
9652: =item *
9653:
9654: reconlonc() : tries to reconnect lonc client processes.
9655:
9656: =back
9657:
9658: =head2 Resource Access Logging
9659:
9660: =over 4
9661:
9662: =item *
9663:
9664: flushcourselogs() : flush (save) buffer logs and access logs
9665:
9666: =item *
9667:
9668: courselog($what) : save message for course in hash
9669:
9670: =item *
9671:
9672: courseacclog($what) : save message for course using &courselog(). Perform
9673: special processing for specific resource types (problems, exams, quizzes, etc).
9674:
9675: =item *
9676:
9677: goodbye() : flush course logs and log shutting down; it is called in srm.conf
9678: as a PerlChildExitHandler
9679:
9680: =back
9681:
9682: =head2 Other
9683:
9684: =over 4
9685:
9686: =item *
9687:
9688: symblist($mapname,%newhash) : update symbolic storage links
9689:
9690: =back
9691:
9692: =cut
9693:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnet.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / lonnet / perl