1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1049 2010/01/16 13:46:05 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: =pod
31:
32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol);
80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
84: %courseownerbuf, %coursetypebuf,$locknum);
85:
86: use IO::Socket;
87: use GDBM_File;
88: use HTML::LCParser;
89: use Fcntl qw(:flock);
90: use Storable qw(thaw nfreeze);
91: use Time::HiRes qw( gettimeofday tv_interval );
92: use Cache::Memcached;
93: use Digest::MD5;
94: use Math::Random;
95: use File::MMagic;
96: use LONCAPA qw(:DEFAULT :match);
97: use LONCAPA::Configuration;
98:
99: my $readit;
100: my $max_connection_retries = 10; # Or some such value.
101:
102: my $upload_photo_form = 0; #Variable to check when user upload a photo 0=not 1=true
103:
104: require Exporter;
105:
106: our @ISA = qw (Exporter);
107: our @EXPORT = qw(%env);
108:
109:
110: # --------------------------------------------------------------------- Logging
111: {
112: my $logid;
113: sub instructor_log {
114: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
115: if (($cnum eq '') || ($cdom eq '')) {
116: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
117: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
118: }
119: $logid++;
120: my $now = time();
121: my $id=$now.'00000'.$$.'00000'.$logid;
122: return &Apache::lonnet::put('nohist_'.$hash_name,
123: { $id => {
124: 'exe_uname' => $env{'user.name'},
125: 'exe_udom' => $env{'user.domain'},
126: 'exe_time' => $now,
127: 'exe_ip' => $ENV{'REMOTE_ADDR'},
128: 'delflag' => $delflag,
129: 'logentry' => $storehash,
130: 'uname' => $uname,
131: 'udom' => $udom,
132: }
133: },$cdom,$cnum);
134: }
135: }
136:
137: sub logtouch {
138: my $execdir=$perlvar{'lonDaemons'};
139: unless (-e "$execdir/logs/lonnet.log") {
140: open(my $fh,">>$execdir/logs/lonnet.log");
141: close $fh;
142: }
143: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
144: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
145: }
146:
147: sub logthis {
148: my $message=shift;
149: my $execdir=$perlvar{'lonDaemons'};
150: my $now=time;
151: my $local=localtime($now);
152: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
153: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
154: print $fh $logstring;
155: close($fh);
156: }
157: return 1;
158: }
159:
160: sub logperm {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
165: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
166: print $fh "$now:$message:$local\n";
167: close($fh);
168: }
169: return 1;
170: }
171:
172: sub create_connection {
173: my ($hostname,$lonid) = @_;
174: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
175: Type => SOCK_STREAM,
176: Timeout => 10);
177: return 0 if (!$client);
178: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
179: my $result = <$client>;
180: chomp($result);
181: return 1 if ($result eq 'done');
182: return 0;
183: }
184:
185: sub get_server_timezone {
186: my ($cnum,$cdom) = @_;
187: my $home=&homeserver($cnum,$cdom);
188: if ($home ne 'no_host') {
189: my $cachetime = 24*3600;
190: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
191: if (defined($cached)) {
192: return $timezone;
193: } else {
194: my $timezone = &reply('servertimezone',$home);
195: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
196: }
197: }
198: }
199:
200: sub get_server_loncaparev {
201: my ($dom,$lonhost) = @_;
202: if (defined($lonhost)) {
203: if (!defined(&hostname($lonhost))) {
204: undef($lonhost);
205: }
206: }
207: if (!defined($lonhost)) {
208: if (defined(&domain($dom,'primary'))) {
209: $lonhost=&domain($dom,'primary');
210: if ($lonhost eq 'no_host') {
211: undef($lonhost);
212: }
213: }
214: }
215: if (defined($lonhost)) {
216: my $cachetime = 24*3600;
217: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
218: if (defined($cached)) {
219: return $loncaparev;
220: } else {
221: my $loncaparev = &reply('serverloncaparev',$lonhost);
222: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
223: }
224: }
225: }
226:
227: # -------------------------------------------------- Non-critical communication
228: sub subreply {
229: my ($cmd,$server)=@_;
230: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
231: #
232: # With loncnew process trimming, there's a timing hole between lonc server
233: # process exit and the master server picking up the listen on the AF_UNIX
234: # socket. In that time interval, a lock file will exist:
235:
236: my $lockfile=$peerfile.".lock";
237: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
238: sleep(1);
239: }
240: # At this point, either a loncnew parent is listening or an old lonc
241: # or loncnew child is listening so we can connect or everything's dead.
242: #
243: # We'll give the connection a few tries before abandoning it. If
244: # connection is not possible, we'll con_lost back to the client.
245: #
246: my $client;
247: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
248: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
249: Type => SOCK_STREAM,
250: Timeout => 10);
251: if ($client) {
252: last; # Connected!
253: } else {
254: &create_connection(&hostname($server),$server);
255: }
256: sleep(1); # Try again later if failed connection.
257: }
258: my $answer;
259: if ($client) {
260: print $client "sethost:$server:$cmd\n";
261: $answer=<$client>;
262: if (!$answer) { $answer="con_lost"; }
263: chomp($answer);
264: } else {
265: $answer = 'con_lost'; # Failed connection.
266: }
267: return $answer;
268: }
269:
270: sub reply {
271: my ($cmd,$server)=@_;
272: unless (defined(&hostname($server))) { return 'no_such_host'; }
273: my $answer=subreply($cmd,$server);
274: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
275: &logthis("<font color=\"blue\">WARNING:".
276: " $cmd to $server returned $answer</font>");
277: }
278: return $answer;
279: }
280:
281: # ----------------------------------------------------------- Send USR1 to lonc
282:
283: sub reconlonc {
284: my ($lonid) = @_;
285: my $hostname = &hostname($lonid);
286: if ($lonid) {
287: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
288: if ($hostname && -e $peerfile) {
289: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
290: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
291: Type => SOCK_STREAM,
292: Timeout => 10);
293: if ($client) {
294: print $client ("reset_retries\n");
295: my $answer=<$client>;
296: #reset just this one.
297: }
298: }
299: return;
300: }
301:
302: &logthis("Trying to reconnect lonc");
303: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
304: if (open(my $fh,"<$loncfile")) {
305: my $loncpid=<$fh>;
306: chomp($loncpid);
307: if (kill 0 => $loncpid) {
308: &logthis("lonc at pid $loncpid responding, sending USR1");
309: kill USR1 => $loncpid;
310: sleep 1;
311: } else {
312: &logthis(
313: "<font color=\"blue\">WARNING:".
314: " lonc at pid $loncpid not responding, giving up</font>");
315: }
316: } else {
317: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
318: }
319: }
320:
321: # ------------------------------------------------------ Critical communication
322:
323: sub critical {
324: my ($cmd,$server)=@_;
325: unless (&hostname($server)) {
326: &logthis("<font color=\"blue\">WARNING:".
327: " Critical message to unknown server ($server)</font>");
328: return 'no_such_host';
329: }
330: my $answer=reply($cmd,$server);
331: if ($answer eq 'con_lost') {
332: &reconlonc("$perlvar{'lonSockDir'}/$server");
333: my $answer=reply($cmd,$server);
334: if ($answer eq 'con_lost') {
335: my $now=time;
336: my $middlename=$cmd;
337: $middlename=substr($middlename,0,16);
338: $middlename=~s/\W//g;
339: my $dfilename=
340: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
341: $dumpcount++;
342: {
343: my $dfh;
344: if (open($dfh,">$dfilename")) {
345: print $dfh "$cmd\n";
346: close($dfh);
347: }
348: }
349: sleep 2;
350: my $wcmd='';
351: {
352: my $dfh;
353: if (open($dfh,"<$dfilename")) {
354: $wcmd=<$dfh>;
355: close($dfh);
356: }
357: }
358: chomp($wcmd);
359: if ($wcmd eq $cmd) {
360: &logthis("<font color=\"blue\">WARNING: ".
361: "Connection buffer $dfilename: $cmd</font>");
362: &logperm("D:$server:$cmd");
363: return 'con_delayed';
364: } else {
365: &logthis("<font color=\"red\">CRITICAL:"
366: ." Critical connection failed: $server $cmd</font>");
367: &logperm("F:$server:$cmd");
368: return 'con_failed';
369: }
370: }
371: }
372: return $answer;
373: }
374:
375: # ------------------------------------------- check if return value is an error
376:
377: sub error {
378: my ($result) = @_;
379: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
380: if ($2 == 2) { return undef; }
381: return $1;
382: }
383: return undef;
384: }
385:
386: sub convert_and_load_session_env {
387: my ($lonidsdir,$handle)=@_;
388: my @profile;
389: {
390: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
391: if (!$opened) {
392: return 0;
393: }
394: flock($idf,LOCK_SH);
395: @profile=<$idf>;
396: close($idf);
397: }
398: my %temp_env;
399: foreach my $line (@profile) {
400: if ($line !~ m/=/) {
401: return 0;
402: }
403: chomp($line);
404: my ($envname,$envvalue)=split(/=/,$line,2);
405: $temp_env{&unescape($envname)} = &unescape($envvalue);
406: }
407: unlink("$lonidsdir/$handle.id");
408: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
409: 0640)) {
410: %disk_env = %temp_env;
411: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
412: untie(%disk_env);
413: }
414: return 1;
415: }
416:
417: # ------------------------------------------- Transfer profile into environment
418: my $env_loaded;
419: sub transfer_profile_to_env {
420: my ($lonidsdir,$handle,$force_transfer) = @_;
421: if (!$force_transfer && $env_loaded) { return; }
422:
423: if (!defined($lonidsdir)) {
424: $lonidsdir = $perlvar{'lonIDsDir'};
425: }
426: if (!defined($handle)) {
427: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
428: }
429:
430: my $convert;
431: {
432: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
433: if (!$opened) {
434: return;
435: }
436: flock($idf,LOCK_SH);
437: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
438: &GDBM_READER(),0640)) {
439: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
440: untie(%disk_env);
441: } else {
442: $convert = 1;
443: }
444: }
445: if ($convert) {
446: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
447: &logthis("Failed to load session, or convert session.");
448: }
449: }
450:
451: my %remove;
452: while ( my $envname = each(%env) ) {
453: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
454: if ($time < time-300) {
455: $remove{$key}++;
456: }
457: }
458: }
459:
460: $env{'user.environment'} = "$lonidsdir/$handle.id";
461: $env_loaded=1;
462: foreach my $expired_key (keys(%remove)) {
463: &delenv($expired_key);
464: }
465: }
466:
467: # ---------------------------------------------------- Check for valid session
468: sub check_for_valid_session {
469: my ($r) = @_;
470: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
471: my $lonid=$cookies{'lonID'};
472: return undef if (!$lonid);
473:
474: my $handle=&LONCAPA::clean_handle($lonid->value);
475: my $lonidsdir=$r->dir_config('lonIDsDir');
476: return undef if (!-e "$lonidsdir/$handle.id");
477:
478: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
479: return undef if (!$opened);
480:
481: flock($idf,LOCK_SH);
482: my %disk_env;
483: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
484: &GDBM_READER(),0640)) {
485: return undef;
486: }
487:
488: if (!defined($disk_env{'user.name'})
489: || !defined($disk_env{'user.domain'})) {
490: return undef;
491: }
492: return $handle;
493: }
494:
495: sub timed_flock {
496: my ($file,$lock_type) = @_;
497: my $failed=0;
498: eval {
499: local $SIG{__DIE__}='DEFAULT';
500: local $SIG{ALRM}=sub {
501: $failed=1;
502: die("failed lock");
503: };
504: alarm(13);
505: flock($file,$lock_type);
506: alarm(0);
507: };
508: if ($failed) {
509: return undef;
510: } else {
511: return 1;
512: }
513: }
514:
515: # ---------------------------------------------------------- Append Environment
516:
517: sub appenv {
518: my ($newenv,$roles) = @_;
519: if (ref($newenv) eq 'HASH') {
520: foreach my $key (keys(%{$newenv})) {
521: my $refused = 0;
522: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
523: $refused = 1;
524: if (ref($roles) eq 'ARRAY') {
525: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
526: if (grep(/^\Q$role\E$/,@{$roles})) {
527: $refused = 0;
528: }
529: }
530: }
531: if ($refused) {
532: &logthis("<font color=\"blue\">WARNING: ".
533: "Attempt to modify environment ".$key." to ".$newenv->{$key}
534: .'</font>');
535: delete($newenv->{$key});
536: } else {
537: $env{$key}=$newenv->{$key};
538: }
539: }
540: my $opened = open(my $env_file,'+<',$env{'user.environment'});
541: if ($opened
542: && &timed_flock($env_file,LOCK_EX)
543: &&
544: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
545: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
546: while (my ($key,$value) = each(%{$newenv})) {
547: $disk_env{$key} = $value;
548: }
549: untie(%disk_env);
550: }
551: }
552: return 'ok';
553: }
554: # ----------------------------------------------------- Delete from Environment
555:
556: sub delenv {
557: my ($delthis,$regexp) = @_;
558: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
559: &logthis("<font color=\"blue\">WARNING: ".
560: "Attempt to delete from environment ".$delthis);
561: return 'error';
562: }
563: my $opened = open(my $env_file,'+<',$env{'user.environment'});
564: if ($opened
565: && &timed_flock($env_file,LOCK_EX)
566: &&
567: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
568: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
569: foreach my $key (keys(%disk_env)) {
570: if ($regexp) {
571: if ($key=~/^$delthis/) {
572: delete($env{$key});
573: delete($disk_env{$key});
574: }
575: } else {
576: if ($key=~/^\Q$delthis\E/) {
577: delete($env{$key});
578: delete($disk_env{$key});
579: }
580: }
581: }
582: untie(%disk_env);
583: }
584: return 'ok';
585: }
586:
587: sub get_env_multiple {
588: my ($name) = @_;
589: my @values;
590: if (defined($env{$name})) {
591: # exists is it an array
592: if (ref($env{$name})) {
593: @values=@{ $env{$name} };
594: } else {
595: $values[0]=$env{$name};
596: }
597: }
598: return(@values);
599: }
600:
601: # ------------------------------------------------------------------- Locking
602:
603: sub set_lock {
604: my ($text)=@_;
605: $locknum++;
606: my $id=$$.'-'.$locknum;
607: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
608: 'session.lock.'.$id => $text});
609: return $id;
610: }
611:
612: sub get_locks {
613: my $num=0;
614: my %texts=();
615: foreach my $lock (split(/\,/,$env{'session.locks'})) {
616: if ($lock=~/\w/) {
617: $num++;
618: $texts{$lock}=$env{'session.lock.'.$lock};
619: }
620: }
621: return ($num,%texts);
622: }
623:
624: sub remove_lock {
625: my ($id)=@_;
626: my $newlocks='';
627: foreach my $lock (split(/\,/,$env{'session.locks'})) {
628: if (($lock=~/\w/) && ($lock ne $id)) {
629: $newlocks.=','.$lock;
630: }
631: }
632: &appenv({'session.locks' => $newlocks});
633: &delenv('session.lock.'.$id);
634: }
635:
636: sub remove_all_locks {
637: my $activelocks=$env{'session.locks'};
638: foreach my $lock (split(/\,/,$env{'session.locks'})) {
639: if ($lock=~/\w/) {
640: &remove_lock($lock);
641: }
642: }
643: }
644:
645:
646: # ------------------------------------------ Find out current server userload
647: sub userload {
648: my $numusers=0;
649: {
650: opendir(LONIDS,$perlvar{'lonIDsDir'});
651: my $filename;
652: my $curtime=time;
653: while ($filename=readdir(LONIDS)) {
654: next if ($filename eq '.' || $filename eq '..');
655: next if ($filename =~ /publicuser_\d+\.id/);
656: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
657: if ($curtime-$mtime < 1800) { $numusers++; }
658: }
659: closedir(LONIDS);
660: }
661: my $userloadpercent=0;
662: my $maxuserload=$perlvar{'lonUserLoadLim'};
663: if ($maxuserload) {
664: $userloadpercent=100*$numusers/$maxuserload;
665: }
666: $userloadpercent=sprintf("%.2f",$userloadpercent);
667: return $userloadpercent;
668: }
669:
670: # ------------------------------------------ Fight off request when overloaded
671:
672: sub overloaderror {
673: my ($r,$checkserver)=@_;
674: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
675: my $loadavg;
676: if ($checkserver eq $perlvar{'lonHostID'}) {
677: open(my $loadfile,'/proc/loadavg');
678: $loadavg=<$loadfile>;
679: $loadavg =~ s/\s.*//g;
680: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
681: close($loadfile);
682: } else {
683: $loadavg=&reply('load',$checkserver);
684: }
685: my $overload=$loadavg-100;
686: if ($overload>0) {
687: $r->err_headers_out->{'Retry-After'}=$overload;
688: $r->log_error('Overload of '.$overload.' on '.$checkserver);
689: return 413;
690: }
691: return '';
692: }
693:
694: # ------------------------------ Find server with least workload from spare.tab
695:
696: sub spareserver {
697: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
698: my $spare_server;
699: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
700: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
701: : $userloadpercent;
702:
703: foreach my $try_server (@{ $spareid{'primary'} }) {
704: ($spare_server, $lowest_load) =
705: &compare_server_load($try_server, $spare_server, $lowest_load);
706: }
707:
708: my $found_server = ($spare_server ne '' && $lowest_load < 100);
709:
710: if (!$found_server) {
711: foreach my $try_server (@{ $spareid{'default'} }) {
712: ($spare_server, $lowest_load) =
713: &compare_server_load($try_server, $spare_server, $lowest_load);
714: }
715: }
716:
717: if (!$want_server_name) {
718: my $protocol = 'http';
719: if ($protocol{$spare_server} eq 'https') {
720: $protocol = $protocol{$spare_server};
721: }
722: if (defined($spare_server)) {
723: my $hostname = &hostname($spare_server);
724: if (defined($hostname)) {
725: $spare_server = $protocol.'://'.$hostname;
726: }
727: }
728: }
729: return $spare_server;
730: }
731:
732: sub compare_server_load {
733: my ($try_server, $spare_server, $lowest_load) = @_;
734:
735: my $loadans = &reply('load', $try_server);
736: my $userloadans = &reply('userload',$try_server);
737:
738: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
739: next; #didn't get a number from the server
740: }
741:
742: my $load;
743: if ($loadans =~ /\d/) {
744: if ($userloadans =~ /\d/) {
745: #both are numbers, pick the bigger one
746: $load = ($loadans > $userloadans) ? $loadans
747: : $userloadans;
748: } else {
749: $load = $loadans;
750: }
751: } else {
752: $load = $userloadans;
753: }
754:
755: if (($load =~ /\d/) && ($load < $lowest_load)) {
756: $spare_server = $try_server;
757: $lowest_load = $load;
758: }
759: return ($spare_server,$lowest_load);
760: }
761:
762: # --------------------------- ask offload servers if user already has a session
763: sub find_existing_session {
764: my ($udom,$uname) = @_;
765: foreach my $try_server (@{ $spareid{'primary'} },
766: @{ $spareid{'default'} }) {
767: return $try_server if (&has_user_session($try_server, $udom, $uname));
768: }
769: return;
770: }
771:
772: # -------------------------------- ask if server already has a session for user
773: sub has_user_session {
774: my ($lonid,$udom,$uname) = @_;
775: my $result = &reply(join(':','userhassession',
776: map {&escape($_)} ($udom,$uname)),$lonid);
777: return 1 if ($result eq 'ok');
778:
779: return 0;
780: }
781:
782: # --------------------------------------------- Try to change a user's password
783:
784: sub changepass {
785: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
786: $currentpass = &escape($currentpass);
787: $newpass = &escape($newpass);
788: my $lonhost = $perlvar{'lonHostID'};
789: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
790: $server);
791: if (! $answer) {
792: &logthis("No reply on password change request to $server ".
793: "by $uname in domain $udom.");
794: } elsif ($answer =~ "^ok") {
795: &logthis("$uname in $udom successfully changed their password ".
796: "on $server.");
797: } elsif ($answer =~ "^pwchange_failure") {
798: &logthis("$uname in $udom was unable to change their password ".
799: "on $server. The action was blocked by either lcpasswd ".
800: "or pwchange");
801: } elsif ($answer =~ "^non_authorized") {
802: &logthis("$uname in $udom did not get their password correct when ".
803: "attempting to change it on $server.");
804: } elsif ($answer =~ "^auth_mode_error") {
805: &logthis("$uname in $udom attempted to change their password despite ".
806: "not being locally or internally authenticated on $server.");
807: } elsif ($answer =~ "^unknown_user") {
808: &logthis("$uname in $udom attempted to change their password ".
809: "on $server but were unable to because $server is not ".
810: "their home server.");
811: } elsif ($answer =~ "^refused") {
812: &logthis("$server refused to change $uname in $udom password because ".
813: "it was sent an unencrypted request to change the password.");
814: } elsif ($answer =~ "invalid_client") {
815: &logthis("$server refused to change $uname in $udom password because ".
816: "it was a reset by e-mail originating from an invalid server.");
817: }
818: return $answer;
819: }
820:
821: # ----------------------- Try to determine user's current authentication scheme
822:
823: sub queryauthenticate {
824: my ($uname,$udom)=@_;
825: my $uhome=&homeserver($uname,$udom);
826: if (!$uhome) {
827: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
828: return 'no_host';
829: }
830: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
831: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
832: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
833: }
834: return $answer;
835: }
836:
837: # --------- Try to authenticate user from domain's lib servers (first this one)
838:
839: sub authenticate {
840: my ($uname,$upass,$udom,$checkdefauth)=@_;
841: $upass=&escape($upass);
842: $uname= &LONCAPA::clean_username($uname);
843: my $uhome=&homeserver($uname,$udom,1);
844: my $newhome;
845: if ((!$uhome) || ($uhome eq 'no_host')) {
846: # Maybe the machine was offline and only re-appeared again recently?
847: &reconlonc();
848: # One more
849: $uhome=&homeserver($uname,$udom,1);
850: if (($uhome eq 'no_host') && $checkdefauth) {
851: if (defined(&domain($udom,'primary'))) {
852: $newhome=&domain($udom,'primary');
853: }
854: if ($newhome ne '') {
855: $uhome = $newhome;
856: }
857: }
858: if ((!$uhome) || ($uhome eq 'no_host')) {
859: &logthis("User $uname at $udom is unknown in authenticate");
860: return 'no_host';
861: }
862: }
863: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
864: if ($answer eq 'authorized') {
865: if ($newhome) {
866: &logthis("User $uname at $udom authorized by $uhome, but needs account");
867: return 'no_account_on_host';
868: } else {
869: &logthis("User $uname at $udom authorized by $uhome");
870: return $uhome;
871: }
872: }
873: if ($answer eq 'non_authorized') {
874: &logthis("User $uname at $udom rejected by $uhome");
875: return 'no_host';
876: }
877: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
878: return 'no_host';
879: }
880:
881: # ---------------------- Find the homebase for a user from domain's lib servers
882:
883: my %homecache;
884: sub homeserver {
885: my ($uname,$udom,$ignoreBadCache)=@_;
886: my $index="$uname:$udom";
887:
888: if (exists($homecache{$index})) { return $homecache{$index}; }
889:
890: my %servers = &get_servers($udom,'library');
891: foreach my $tryserver (keys(%servers)) {
892: next if ($ignoreBadCache ne 'true' &&
893: exists($badServerCache{$tryserver}));
894:
895: my $answer=reply("home:$udom:$uname",$tryserver);
896: if ($answer eq 'found') {
897: delete($badServerCache{$tryserver});
898: return $homecache{$index}=$tryserver;
899: } elsif ($answer eq 'no_host') {
900: $badServerCache{$tryserver}=1;
901: }
902: }
903: return 'no_host';
904: }
905:
906: # ------------------------------------- Find the usernames behind a list of IDs
907:
908: sub idget {
909: my ($udom,@ids)=@_;
910: my %returnhash=();
911:
912: my %servers = &get_servers($udom,'library');
913: foreach my $tryserver (keys(%servers)) {
914: my $idlist=join('&',@ids);
915: $idlist=~tr/A-Z/a-z/;
916: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
917: my @answer=();
918: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
919: @answer=split(/\&/,$reply);
920: } ;
921: my $i;
922: for ($i=0;$i<=$#ids;$i++) {
923: if ($answer[$i]) {
924: $returnhash{$ids[$i]}=$answer[$i];
925: }
926: }
927: }
928: return %returnhash;
929: }
930:
931: # ------------------------------------- Find the IDs behind a list of usernames
932:
933: sub idrget {
934: my ($udom,@unames)=@_;
935: my %returnhash=();
936: foreach my $uname (@unames) {
937: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
938: }
939: return %returnhash;
940: }
941:
942: # ------------------------------- Store away a list of names and associated IDs
943:
944: sub idput {
945: my ($udom,%ids)=@_;
946: my %servers=();
947: foreach my $uname (keys(%ids)) {
948: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
949: my $uhom=&homeserver($uname,$udom);
950: if ($uhom ne 'no_host') {
951: my $id=&escape($ids{$uname});
952: $id=~tr/A-Z/a-z/;
953: my $esc_unam=&escape($uname);
954: if ($servers{$uhom}) {
955: $servers{$uhom}.='&'.$id.'='.$esc_unam;
956: } else {
957: $servers{$uhom}=$id.'='.$esc_unam;
958: }
959: }
960: }
961: foreach my $server (keys(%servers)) {
962: &critical('idput:'.$udom.':'.$servers{$server},$server);
963: }
964: }
965:
966: # ------------------------------dump from db file owned by domainconfig user
967: sub dump_dom {
968: my ($namespace,$udom,$regexp,$range)=@_;
969: if (!$udom) {
970: $udom=$env{'user.domain'};
971: }
972: my %returnhash;
973: if ($udom) {
974: my $uname = &get_domainconfiguser($udom);
975: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
976: }
977: return %returnhash;
978: }
979:
980: # ------------------------------------------ get items from domain db files
981:
982: sub get_dom {
983: my ($namespace,$storearr,$udom,$uhome)=@_;
984: my $items='';
985: foreach my $item (@$storearr) {
986: $items.=&escape($item).'&';
987: }
988: $items=~s/\&$//;
989: if (!$udom) {
990: $udom=$env{'user.domain'};
991: if (defined(&domain($udom,'primary'))) {
992: $uhome=&domain($udom,'primary');
993: } else {
994: undef($uhome);
995: }
996: } else {
997: if (!$uhome) {
998: if (defined(&domain($udom,'primary'))) {
999: $uhome=&domain($udom,'primary');
1000: }
1001: }
1002: }
1003: if ($udom && $uhome && ($uhome ne 'no_host')) {
1004: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1005: my %returnhash;
1006: if ($rep eq '' || $rep =~ /^error: 2 /) {
1007: return %returnhash;
1008: }
1009: my @pairs=split(/\&/,$rep);
1010: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1011: return @pairs;
1012: }
1013: my $i=0;
1014: foreach my $item (@$storearr) {
1015: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1016: $i++;
1017: }
1018: return %returnhash;
1019: } else {
1020: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1021: }
1022: }
1023:
1024: # -------------------------------------------- put items in domain db files
1025:
1026: sub put_dom {
1027: my ($namespace,$storehash,$udom,$uhome)=@_;
1028: if (!$udom) {
1029: $udom=$env{'user.domain'};
1030: if (defined(&domain($udom,'primary'))) {
1031: $uhome=&domain($udom,'primary');
1032: } else {
1033: undef($uhome);
1034: }
1035: } else {
1036: if (!$uhome) {
1037: if (defined(&domain($udom,'primary'))) {
1038: $uhome=&domain($udom,'primary');
1039: }
1040: }
1041: }
1042: if ($udom && $uhome && ($uhome ne 'no_host')) {
1043: my $items='';
1044: foreach my $item (keys(%$storehash)) {
1045: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1046: }
1047: $items=~s/\&$//;
1048: return &reply("putdom:$udom:$namespace:$items",$uhome);
1049: } else {
1050: &logthis("put_dom failed - no homeserver and/or domain");
1051: }
1052: }
1053:
1054: # --------------------- newput for items in db file owned by domainconfig user
1055: sub newput_dom {
1056: my ($namespace,$storehash,$udom) = @_;
1057: my $result;
1058: if (!$udom) {
1059: $udom=$env{'user.domain'};
1060: }
1061: if ($udom) {
1062: my $uname = &get_domainconfiguser($udom);
1063: $result = &newput($namespace,$storehash,$udom,$uname);
1064: }
1065: return $result;
1066: }
1067:
1068: # --------------------- delete for items in db file owned by domainconfig user
1069: sub del_dom {
1070: my ($namespace,$storearr,$udom)=@_;
1071: if (ref($storearr) eq 'ARRAY') {
1072: if (!$udom) {
1073: $udom=$env{'user.domain'};
1074: }
1075: if ($udom) {
1076: my $uname = &get_domainconfiguser($udom);
1077: return &del($namespace,$storearr,$udom,$uname);
1078: }
1079: }
1080: }
1081:
1082: # ----------------------------------construct domainconfig user for a domain
1083: sub get_domainconfiguser {
1084: my ($udom) = @_;
1085: return $udom.'-domainconfig';
1086: }
1087:
1088: sub retrieve_inst_usertypes {
1089: my ($udom) = @_;
1090: my (%returnhash,@order);
1091: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1092: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1093: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1094: %returnhash = %{$domdefs{'inststatustypes'}};
1095: @order = @{$domdefs{'inststatusorder'}};
1096: } else {
1097: if (defined(&domain($udom,'primary'))) {
1098: my $uhome=&domain($udom,'primary');
1099: my $rep=&reply("inst_usertypes:$udom",$uhome);
1100: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1101: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1102: return (\%returnhash,\@order);
1103: }
1104: my ($hashitems,$orderitems) = split(/:/,$rep);
1105: my @pairs=split(/\&/,$hashitems);
1106: foreach my $item (@pairs) {
1107: my ($key,$value)=split(/=/,$item,2);
1108: $key = &unescape($key);
1109: next if ($key =~ /^error: 2 /);
1110: $returnhash{$key}=&thaw_unescape($value);
1111: }
1112: my @esc_order = split(/\&/,$orderitems);
1113: foreach my $item (@esc_order) {
1114: push(@order,&unescape($item));
1115: }
1116: } else {
1117: &logthis("get_dom failed - no primary domain server for $udom");
1118: }
1119: }
1120: return (\%returnhash,\@order);
1121: }
1122:
1123: sub is_domainimage {
1124: my ($url) = @_;
1125: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1126: if (&domain($1) ne '') {
1127: return '1';
1128: }
1129: }
1130: return;
1131: }
1132:
1133: sub inst_directory_query {
1134: my ($srch) = @_;
1135: my $udom = $srch->{'srchdomain'};
1136: my %results;
1137: my $homeserver = &domain($udom,'primary');
1138: my $outcome;
1139: if ($homeserver ne '') {
1140: my $queryid=&reply("querysend:instdirsearch:".
1141: &escape($srch->{'srchby'}).':'.
1142: &escape($srch->{'srchterm'}).':'.
1143: &escape($srch->{'srchtype'}),$homeserver);
1144: my $host=&hostname($homeserver);
1145: if ($queryid !~/^\Q$host\E\_/) {
1146: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1147: return;
1148: }
1149: my $response = &get_query_reply($queryid);
1150: my $maxtries = 5;
1151: my $tries = 1;
1152: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1153: $response = &get_query_reply($queryid);
1154: $tries ++;
1155: }
1156:
1157: if (!&error($response) && $response ne 'refused') {
1158: if ($response eq 'unavailable') {
1159: $outcome = $response;
1160: } else {
1161: $outcome = 'ok';
1162: my @matches = split(/\n/,$response);
1163: foreach my $match (@matches) {
1164: my ($key,$value) = split(/=/,$match);
1165: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1166: }
1167: }
1168: }
1169: }
1170: return ($outcome,%results);
1171: }
1172:
1173: sub usersearch {
1174: my ($srch) = @_;
1175: my $dom = $srch->{'srchdomain'};
1176: my %results;
1177: my %libserv = &all_library();
1178: my $query = 'usersearch';
1179: foreach my $tryserver (keys(%libserv)) {
1180: if (&host_domain($tryserver) eq $dom) {
1181: my $host=&hostname($tryserver);
1182: my $queryid=
1183: &reply("querysend:".&escape($query).':'.
1184: &escape($srch->{'srchby'}).':'.
1185: &escape($srch->{'srchtype'}).':'.
1186: &escape($srch->{'srchterm'}),$tryserver);
1187: if ($queryid !~/^\Q$host\E\_/) {
1188: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1189: next;
1190: }
1191: my $reply = &get_query_reply($queryid);
1192: my $maxtries = 1;
1193: my $tries = 1;
1194: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1195: $reply = &get_query_reply($queryid);
1196: $tries ++;
1197: }
1198: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1199: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1200: } else {
1201: my @matches;
1202: if ($reply =~ /\n/) {
1203: @matches = split(/\n/,$reply);
1204: } else {
1205: @matches = split(/\&/,$reply);
1206: }
1207: foreach my $match (@matches) {
1208: my ($uname,$udom,%userhash);
1209: foreach my $entry (split(/:/,$match)) {
1210: my ($key,$value) =
1211: map {&unescape($_);} split(/=/,$entry);
1212: $userhash{$key} = $value;
1213: if ($key eq 'username') {
1214: $uname = $value;
1215: } elsif ($key eq 'domain') {
1216: $udom = $value;
1217: }
1218: }
1219: $results{$uname.':'.$udom} = \%userhash;
1220: }
1221: }
1222: }
1223: }
1224: return %results;
1225: }
1226:
1227: sub get_instuser {
1228: my ($udom,$uname,$id) = @_;
1229: my $homeserver = &domain($udom,'primary');
1230: my ($outcome,%results);
1231: if ($homeserver ne '') {
1232: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1233: &escape($id).':'.&escape($udom),$homeserver);
1234: my $host=&hostname($homeserver);
1235: if ($queryid !~/^\Q$host\E\_/) {
1236: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1237: return;
1238: }
1239: my $response = &get_query_reply($queryid);
1240: my $maxtries = 5;
1241: my $tries = 1;
1242: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1243: $response = &get_query_reply($queryid);
1244: $tries ++;
1245: }
1246: if (!&error($response) && $response ne 'refused') {
1247: if ($response eq 'unavailable') {
1248: $outcome = $response;
1249: } else {
1250: $outcome = 'ok';
1251: my @matches = split(/\n/,$response);
1252: foreach my $match (@matches) {
1253: my ($key,$value) = split(/=/,$match);
1254: $results{&unescape($key)} = &thaw_unescape($value);
1255: }
1256: }
1257: }
1258: }
1259: my %userinfo;
1260: if (ref($results{$uname}) eq 'HASH') {
1261: %userinfo = %{$results{$uname}};
1262: }
1263: return ($outcome,%userinfo);
1264: }
1265:
1266: sub inst_rulecheck {
1267: my ($udom,$uname,$id,$item,$rules) = @_;
1268: my %returnhash;
1269: if ($udom ne '') {
1270: if (ref($rules) eq 'ARRAY') {
1271: @{$rules} = map {&escape($_);} (@{$rules});
1272: my $rulestr = join(':',@{$rules});
1273: my $homeserver=&domain($udom,'primary');
1274: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1275: my $response;
1276: if ($item eq 'username') {
1277: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1278: ':'.&escape($uname).':'.$rulestr,
1279: $homeserver));
1280: } elsif ($item eq 'id') {
1281: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1282: ':'.&escape($id).':'.$rulestr,
1283: $homeserver));
1284: } elsif ($item eq 'selfcreate') {
1285: $response=&unescape(&reply('instselfcreatecheck:'.
1286: &escape($udom).':'.&escape($uname).
1287: ':'.$rulestr,$homeserver));
1288: }
1289: if ($response ne 'refused') {
1290: my @pairs=split(/\&/,$response);
1291: foreach my $item (@pairs) {
1292: my ($key,$value)=split(/=/,$item,2);
1293: $key = &unescape($key);
1294: next if ($key =~ /^error: 2 /);
1295: $returnhash{$key}=&thaw_unescape($value);
1296: }
1297: }
1298: }
1299: }
1300: }
1301: return %returnhash;
1302: }
1303:
1304: sub inst_userrules {
1305: my ($udom,$check) = @_;
1306: my (%ruleshash,@ruleorder);
1307: if ($udom ne '') {
1308: my $homeserver=&domain($udom,'primary');
1309: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1310: my $response;
1311: if ($check eq 'id') {
1312: $response=&reply('instidrules:'.&escape($udom),
1313: $homeserver);
1314: } elsif ($check eq 'email') {
1315: $response=&reply('instemailrules:'.&escape($udom),
1316: $homeserver);
1317: } else {
1318: $response=&reply('instuserrules:'.&escape($udom),
1319: $homeserver);
1320: }
1321: if (($response ne 'refused') && ($response ne 'error') &&
1322: ($response ne 'unknown_cmd') &&
1323: ($response ne 'no_such_host')) {
1324: my ($hashitems,$orderitems) = split(/:/,$response);
1325: my @pairs=split(/\&/,$hashitems);
1326: foreach my $item (@pairs) {
1327: my ($key,$value)=split(/=/,$item,2);
1328: $key = &unescape($key);
1329: next if ($key =~ /^error: 2 /);
1330: $ruleshash{$key}=&thaw_unescape($value);
1331: }
1332: my @esc_order = split(/\&/,$orderitems);
1333: foreach my $item (@esc_order) {
1334: push(@ruleorder,&unescape($item));
1335: }
1336: }
1337: }
1338: }
1339: return (\%ruleshash,\@ruleorder);
1340: }
1341:
1342: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1343:
1344: sub get_domain_defaults {
1345: my ($domain) = @_;
1346: my $cachetime = 60*60*24;
1347: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1348: if (defined($cached)) {
1349: if (ref($result) eq 'HASH') {
1350: return %{$result};
1351: }
1352: }
1353: my %domdefaults;
1354: my %domconfig =
1355: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1356: 'requestcourses','inststatus',
1357: 'coursedefaults'],$domain);
1358: if (ref($domconfig{'defaults'}) eq 'HASH') {
1359: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1360: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1361: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1362: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1363: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1364: } else {
1365: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1366: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1367: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1368: }
1369: if (ref($domconfig{'quotas'}) eq 'HASH') {
1370: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1372: } else {
1373: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1374: }
1375: my @usertools = ('aboutme','blog','portfolio');
1376: foreach my $item (@usertools) {
1377: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1378: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1379: }
1380: }
1381: }
1382: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1383: foreach my $item ('official','unofficial','community') {
1384: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1385: }
1386: }
1387: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1388: foreach my $item ('inststatustypes','inststatusorder') {
1389: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1390: }
1391: }
1392: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1393: foreach my $item ('canuse_pdfforms') {
1394: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1395: }
1396: }
1397: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1398: $cachetime);
1399: return %domdefaults;
1400: }
1401:
1402: # --------------------------------------------------- Assign a key to a student
1403:
1404: sub assign_access_key {
1405: #
1406: # a valid key looks like uname:udom#comments
1407: # comments are being appended
1408: #
1409: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1410: $kdom=
1411: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1412: $knum=
1413: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1414: $cdom=
1415: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1416: $cnum=
1417: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1418: $udom=$env{'user.name'} unless (defined($udom));
1419: $uname=$env{'user.domain'} unless (defined($uname));
1420: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1421: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1422: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1423: # assigned to this person
1424: # - this should not happen,
1425: # unless something went wrong
1426: # the first time around
1427: # ready to assign
1428: $logentry=$1.'; '.$logentry;
1429: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1430: $kdom,$knum) eq 'ok') {
1431: # key now belongs to user
1432: my $envkey='key.'.$cdom.'_'.$cnum;
1433: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1434: &appenv({'environment.'.$envkey => $ckey});
1435: return 'ok';
1436: } else {
1437: return
1438: 'error: Count not permanently assign key, will need to be re-entered later.';
1439: }
1440: } else {
1441: return 'error: Could not assign key, try again later.';
1442: }
1443: } elsif (!$existing{$ckey}) {
1444: # the key does not exist
1445: return 'error: The key does not exist';
1446: } else {
1447: # the key is somebody else's
1448: return 'error: The key is already in use';
1449: }
1450: }
1451:
1452: # ------------------------------------------ put an additional comment on a key
1453:
1454: sub comment_access_key {
1455: #
1456: # a valid key looks like uname:udom#comments
1457: # comments are being appended
1458: #
1459: my ($ckey,$cdom,$cnum,$logentry)=@_;
1460: $cdom=
1461: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1462: $cnum=
1463: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1464: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1465: if ($existing{$ckey}) {
1466: $existing{$ckey}.='; '.$logentry;
1467: # ready to assign
1468: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1469: $cdom,$cnum) eq 'ok') {
1470: return 'ok';
1471: } else {
1472: return 'error: Count not store comment.';
1473: }
1474: } else {
1475: # the key does not exist
1476: return 'error: The key does not exist';
1477: }
1478: }
1479:
1480: # ------------------------------------------------------ Generate a set of keys
1481:
1482: sub generate_access_keys {
1483: my ($number,$cdom,$cnum,$logentry)=@_;
1484: $cdom=
1485: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1486: $cnum=
1487: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1488: unless (&allowed('mky',$cdom)) { return 0; }
1489: unless (($cdom) && ($cnum)) { return 0; }
1490: if ($number>10000) { return 0; }
1491: sleep(2); # make sure don't get same seed twice
1492: srand(time()^($$+($$<<15))); # from "Programming Perl"
1493: my $total=0;
1494: for (my $i=1;$i<=$number;$i++) {
1495: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1496: sprintf("%lx",int(100000*rand)).'-'.
1497: sprintf("%lx",int(100000*rand));
1498: $newkey=~s/1/g/g; # folks mix up 1 and l
1499: $newkey=~s/0/h/g; # and also 0 and O
1500: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1501: if ($existing{$newkey}) {
1502: $i--;
1503: } else {
1504: if (&put('accesskeys',
1505: { $newkey => '# generated '.localtime().
1506: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1507: '; '.$logentry },
1508: $cdom,$cnum) eq 'ok') {
1509: $total++;
1510: }
1511: }
1512: }
1513: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1514: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1515: return $total;
1516: }
1517:
1518: # ------------------------------------------------------- Validate an accesskey
1519:
1520: sub validate_access_key {
1521: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1522: $cdom=
1523: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1524: $cnum=
1525: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1526: $udom=$env{'user.domain'} unless (defined($udom));
1527: $uname=$env{'user.name'} unless (defined($uname));
1528: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1529: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1530: }
1531:
1532: # ------------------------------------- Find the section of student in a course
1533: sub devalidate_getsection_cache {
1534: my ($udom,$unam,$courseid)=@_;
1535: my $hashid="$udom:$unam:$courseid";
1536: &devalidate_cache_new('getsection',$hashid);
1537: }
1538:
1539: sub courseid_to_courseurl {
1540: my ($courseid) = @_;
1541: #already url style courseid
1542: return $courseid if ($courseid =~ m{^/});
1543:
1544: if (exists($env{'course.'.$courseid.'.num'})) {
1545: my $cnum = $env{'course.'.$courseid.'.num'};
1546: my $cdom = $env{'course.'.$courseid.'.domain'};
1547: return "/$cdom/$cnum";
1548: }
1549:
1550: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1551: if (exists($courseinfo{'num'})) {
1552: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1553: }
1554:
1555: return undef;
1556: }
1557:
1558: sub getsection {
1559: my ($udom,$unam,$courseid)=@_;
1560: my $cachetime=1800;
1561:
1562: my $hashid="$udom:$unam:$courseid";
1563: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1564: if (defined($cached)) { return $result; }
1565:
1566: my %Pending;
1567: my %Expired;
1568: #
1569: # Each role can either have not started yet (pending), be active,
1570: # or have expired.
1571: #
1572: # If there is an active role, we are done.
1573: #
1574: # If there is more than one role which has not started yet,
1575: # choose the one which will start sooner
1576: # If there is one role which has not started yet, return it.
1577: #
1578: # If there is more than one expired role, choose the one which ended last.
1579: # If there is a role which has expired, return it.
1580: #
1581: $courseid = &courseid_to_courseurl($courseid);
1582: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1583: foreach my $key (keys(%roleshash)) {
1584: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1585: my $section=$1;
1586: if ($key eq $courseid.'_st') { $section=''; }
1587: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1588: my $now=time;
1589: if (defined($end) && $end && ($now > $end)) {
1590: $Expired{$end}=$section;
1591: next;
1592: }
1593: if (defined($start) && $start && ($now < $start)) {
1594: $Pending{$start}=$section;
1595: next;
1596: }
1597: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1598: }
1599: #
1600: # Presumedly there will be few matching roles from the above
1601: # loop and the sorting time will be negligible.
1602: if (scalar(keys(%Pending))) {
1603: my ($time) = sort {$a <=> $b} keys(%Pending);
1604: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1605: }
1606: if (scalar(keys(%Expired))) {
1607: my @sorted = sort {$a <=> $b} keys(%Expired);
1608: my $time = pop(@sorted);
1609: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1610: }
1611: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1612: }
1613:
1614: sub save_cache {
1615: &purge_remembered();
1616: #&Apache::loncommon::validate_page();
1617: undef(%env);
1618: undef($env_loaded);
1619: }
1620:
1621: my $to_remember=-1;
1622: my %remembered;
1623: my %accessed;
1624: my $kicks=0;
1625: my $hits=0;
1626: sub make_key {
1627: my ($name,$id) = @_;
1628: if (length($id) > 65
1629: && length(&escape($id)) > 200) {
1630: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1631: }
1632: return &escape($name.':'.$id);
1633: }
1634:
1635: sub devalidate_cache_new {
1636: my ($name,$id,$debug) = @_;
1637: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1638: $id=&make_key($name,$id);
1639: $memcache->delete($id);
1640: delete($remembered{$id});
1641: delete($accessed{$id});
1642: }
1643:
1644: sub is_cached_new {
1645: my ($name,$id,$debug) = @_;
1646: $id=&make_key($name,$id);
1647: if (exists($remembered{$id})) {
1648: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1649: $accessed{$id}=[&gettimeofday()];
1650: $hits++;
1651: return ($remembered{$id},1);
1652: }
1653: my $value = $memcache->get($id);
1654: if (!(defined($value))) {
1655: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1656: return (undef,undef);
1657: }
1658: if ($value eq '__undef__') {
1659: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1660: $value=undef;
1661: }
1662: &make_room($id,$value,$debug);
1663: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1664: return ($value,1);
1665: }
1666:
1667: sub do_cache_new {
1668: my ($name,$id,$value,$time,$debug) = @_;
1669: $id=&make_key($name,$id);
1670: my $setvalue=$value;
1671: if (!defined($setvalue)) {
1672: $setvalue='__undef__';
1673: }
1674: if (!defined($time) ) {
1675: $time=600;
1676: }
1677: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1678: my $result = $memcache->set($id,$setvalue,$time);
1679: if (! $result) {
1680: &logthis("caching of id -> $id failed");
1681: $memcache->disconnect_all();
1682: }
1683: # need to make a copy of $value
1684: &make_room($id,$value,$debug);
1685: return $value;
1686: }
1687:
1688: sub make_room {
1689: my ($id,$value,$debug)=@_;
1690:
1691: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1692: : $value;
1693: if ($to_remember<0) { return; }
1694: $accessed{$id}=[&gettimeofday()];
1695: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1696: my $to_kick;
1697: my $max_time=0;
1698: foreach my $other (keys(%accessed)) {
1699: if (&tv_interval($accessed{$other}) > $max_time) {
1700: $to_kick=$other;
1701: $max_time=&tv_interval($accessed{$other});
1702: }
1703: }
1704: delete($remembered{$to_kick});
1705: delete($accessed{$to_kick});
1706: $kicks++;
1707: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1708: return;
1709: }
1710:
1711: sub purge_remembered {
1712: #&logthis("Tossing ".scalar(keys(%remembered)));
1713: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1714: undef(%remembered);
1715: undef(%accessed);
1716: }
1717: # ------------------------------------- Read an entry from a user's environment
1718:
1719: sub userenvironment {
1720: my ($udom,$unam,@what)=@_;
1721: my $items;
1722: foreach my $item (@what) {
1723: $items.=&escape($item).'&';
1724: }
1725: $items=~s/\&$//;
1726: my %returnhash=();
1727: my $uhome = &homeserver($unam,$udom);
1728: unless ($uhome eq 'no_host') {
1729: my @answer=split(/\&/,
1730: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1731: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1732: return %returnhash;
1733: }
1734: my $i;
1735: for ($i=0;$i<=$#what;$i++) {
1736: $returnhash{$what[$i]}=&unescape($answer[$i]);
1737: }
1738: }
1739: return %returnhash;
1740: }
1741:
1742: # ---------------------------------------------------------- Get a studentphoto
1743: sub studentphoto {
1744: my ($udom,$unam,$ext) = @_;
1745: my $home=&Apache::lonnet::homeserver($unam,$udom);
1746: if (defined($env{'request.course.id'})) {
1747: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1748: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1749: return(&retrievestudentphoto($udom,$unam,$ext));
1750: } else {
1751: my ($result,$perm_reqd)=
1752: &Apache::lonnet::auto_photo_permission($unam,$udom);
1753: if ($result eq 'ok') {
1754: if (!($perm_reqd eq 'yes')) {
1755: return(&retrievestudentphoto($udom,$unam,$ext));
1756: }
1757: }
1758: }
1759: }
1760: } else {
1761: my ($result,$perm_reqd) =
1762: &Apache::lonnet::auto_photo_permission($unam,$udom);
1763: if ($result eq 'ok') {
1764: if (!($perm_reqd eq 'yes')) {
1765: return(&retrievestudentphoto($udom,$unam,$ext));
1766: }
1767: }
1768: }
1769: return '/adm/lonKaputt/lonlogo_broken.gif';
1770: }
1771:
1772: sub retrievestudentphoto {
1773: my ($udom,$unam,$ext,$type) = @_;
1774: my $home=&Apache::lonnet::homeserver($unam,$udom);
1775: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1776: if ($ret eq 'ok') {
1777: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1778: if ($type eq 'thumbnail') {
1779: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1780: }
1781: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1782: return $tokenurl;
1783: } else {
1784: if ($type eq 'thumbnail') {
1785: return '/adm/lonKaputt/genericstudent_tn.gif';
1786: } else {
1787: return '/adm/lonKaputt/lonlogo_broken.gif';
1788: }
1789: }
1790: }
1791:
1792: # -------------------------------------------------------------------- New chat
1793:
1794: sub chatsend {
1795: my ($newentry,$anon,$group)=@_;
1796: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1797: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1798: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1799: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1800: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1801: &escape($newentry)).':'.$group,$chome);
1802: }
1803:
1804: # ------------------------------------------ Find current version of a resource
1805:
1806: sub getversion {
1807: my $fname=&clutter(shift);
1808: unless ($fname=~/^\/res\//) { return -1; }
1809: return ¤tversion(&filelocation('',$fname));
1810: }
1811:
1812: sub currentversion {
1813: my $fname=shift;
1814: my ($result,$cached)=&is_cached_new('resversion',$fname);
1815: if (defined($cached)) { return $result; }
1816: my $author=$fname;
1817: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1818: my ($udom,$uname)=split(/\//,$author);
1819: my $home=homeserver($uname,$udom);
1820: if ($home eq 'no_host') {
1821: return -1;
1822: }
1823: my $answer=reply("currentversion:$fname",$home);
1824: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1825: return -1;
1826: }
1827: return &do_cache_new('resversion',$fname,$answer,600);
1828: }
1829:
1830: # ----------------------------- Subscribe to a resource, return URL if possible
1831:
1832: sub subscribe {
1833: my $fname=shift;
1834: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1835: $fname=~s/[\n\r]//g;
1836: my $author=$fname;
1837: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1838: my ($udom,$uname)=split(/\//,$author);
1839: my $home=homeserver($uname,$udom);
1840: if ($home eq 'no_host') {
1841: return 'not_found';
1842: }
1843: my $answer=reply("sub:$fname",$home);
1844: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1845: $answer.=' by '.$home;
1846: }
1847: return $answer;
1848: }
1849:
1850: # -------------------------------------------------------------- Replicate file
1851:
1852: sub repcopy {
1853: my $filename=shift;
1854: $filename=~s/\/+/\//g;
1855: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1856: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1857: if ($filename=~m|^/home/httpd/html/userfiles/| or
1858: $filename=~m -^/*(uploaded|editupload)/-) {
1859: return &repcopy_userfile($filename);
1860: }
1861: $filename=~s/[\n\r]//g;
1862: my $transname="$filename.in.transfer";
1863: # FIXME: this should flock
1864: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1865: my $remoteurl=subscribe($filename);
1866: if ($remoteurl =~ /^con_lost by/) {
1867: &logthis("Subscribe returned $remoteurl: $filename");
1868: return 'unavailable';
1869: } elsif ($remoteurl eq 'not_found') {
1870: #&logthis("Subscribe returned not_found: $filename");
1871: return 'not_found';
1872: } elsif ($remoteurl =~ /^rejected by/) {
1873: &logthis("Subscribe returned $remoteurl: $filename");
1874: return 'forbidden';
1875: } elsif ($remoteurl eq 'directory') {
1876: return 'ok';
1877: } else {
1878: my $author=$filename;
1879: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1880: my ($udom,$uname)=split(/\//,$author);
1881: my $home=homeserver($uname,$udom);
1882: unless ($home eq $perlvar{'lonHostID'}) {
1883: my @parts=split(/\//,$filename);
1884: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1885: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1886: &logthis("Malconfiguration for replication: $filename");
1887: return 'bad_request';
1888: }
1889: my $count;
1890: for ($count=5;$count<$#parts;$count++) {
1891: $path.="/$parts[$count]";
1892: if ((-e $path)!=1) {
1893: mkdir($path,0777);
1894: }
1895: }
1896: my $ua=new LWP::UserAgent;
1897: my $request=new HTTP::Request('GET',"$remoteurl");
1898: my $response=$ua->request($request,$transname);
1899: if ($response->is_error()) {
1900: unlink($transname);
1901: my $message=$response->status_line;
1902: &logthis("<font color=\"blue\">WARNING:"
1903: ." LWP get: $message: $filename</font>");
1904: return 'unavailable';
1905: } else {
1906: if ($remoteurl!~/\.meta$/) {
1907: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1908: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1909: if ($mresponse->is_error()) {
1910: unlink($filename.'.meta');
1911: &logthis(
1912: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1913: }
1914: }
1915: rename($transname,$filename);
1916: return 'ok';
1917: }
1918: }
1919: }
1920: }
1921:
1922: # ------------------------------------------------ Get server side include body
1923: sub ssi_body {
1924: my ($filelink,%form)=@_;
1925: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1926: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1927: }
1928: my $output='';
1929: my $response;
1930: if ($filelink=~/^https?\:/) {
1931: ($output,$response)=&externalssi($filelink);
1932: } else {
1933: $filelink .= $filelink=~/\?/ ? '&' : '?';
1934: $filelink .= 'inhibitmenu=yes';
1935: ($output,$response)=&ssi($filelink,%form);
1936: }
1937: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1938: $output=~s/^.*?\<body[^\>]*\>//si;
1939: $output=~s/\<\/body\s*\>.*?$//si;
1940: if (wantarray) {
1941: return ($output, $response);
1942: } else {
1943: return $output;
1944: }
1945: }
1946:
1947: # --------------------------------------------------------- Server Side Include
1948:
1949: sub absolute_url {
1950: my ($host_name) = @_;
1951: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1952: if ($host_name eq '') {
1953: $host_name = $ENV{'SERVER_NAME'};
1954: }
1955: return $protocol.$host_name;
1956: }
1957:
1958: #
1959: # Server side include.
1960: # Parameters:
1961: # fn Possibly encrypted resource name/id.
1962: # form Hash that describes how the rendering should be done
1963: # and other things.
1964: # Returns:
1965: # Scalar context: The content of the response.
1966: # Array context: 2 element list of the content and the full response object.
1967: #
1968: sub ssi {
1969:
1970: my ($fn,%form)=@_;
1971: my $ua=new LWP::UserAgent;
1972: my $request;
1973:
1974: $form{'no_update_last_known'}=1;
1975: &Apache::lonenc::check_encrypt(\$fn);
1976: if (%form) {
1977: $request=new HTTP::Request('POST',&absolute_url().$fn);
1978: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1979: } else {
1980: $request=new HTTP::Request('GET',&absolute_url().$fn);
1981: }
1982:
1983: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1984: my $response=$ua->request($request);
1985:
1986: if (wantarray) {
1987: return ($response->content, $response);
1988: } else {
1989: return $response->content;
1990: }
1991: }
1992:
1993: sub externalssi {
1994: my ($url)=@_;
1995: my $ua=new LWP::UserAgent;
1996: my $request=new HTTP::Request('GET',$url);
1997: my $response=$ua->request($request);
1998: if (wantarray) {
1999: return ($response->content, $response);
2000: } else {
2001: return $response->content;
2002: }
2003: }
2004:
2005: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2006:
2007: sub allowuploaded {
2008: my ($srcurl,$url)=@_;
2009: $url=&clutter(&declutter($url));
2010: my $dir=$url;
2011: $dir=~s/\/[^\/]+$//;
2012: my %httpref=();
2013: my $httpurl=&hreflocation('',$url);
2014: $httpref{'httpref.'.$httpurl}=$srcurl;
2015: &Apache::lonnet::appenv(\%httpref);
2016: }
2017:
2018: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2019: # input: action, courseID, current domain, intended
2020: # path to file, source of file, instruction to parse file for objects,
2021: # ref to hash for embedded objects,
2022: # ref to hash for codebase of java objects.
2023: #
2024: # output: url to file (if action was uploaddoc),
2025: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2026: #
2027: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2028: # course.
2029: #
2030: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2031: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2032: # course's home server.
2033: #
2034: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2035: # be copied from $source (current location) to
2036: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2037: # and will then be copied to
2038: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2039: # course's home server.
2040: #
2041: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2042: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2043: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2044: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2045: # in course's home server.
2046: #
2047:
2048: sub process_coursefile {
2049: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
2050: my $fetchresult;
2051: my $home=&homeserver($docuname,$docudom);
2052: if ($action eq 'propagate') {
2053: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2054: $home);
2055: } else {
2056: my $fpath = '';
2057: my $fname = $file;
2058: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2059: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2060: my $filepath = &build_filepath($fpath);
2061: if ($action eq 'copy') {
2062: if ($source eq '') {
2063: $fetchresult = 'no source file';
2064: return $fetchresult;
2065: } else {
2066: my $destination = $filepath.'/'.$fname;
2067: rename($source,$destination);
2068: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2069: $home);
2070: }
2071: } elsif ($action eq 'uploaddoc') {
2072: open(my $fh,'>'.$filepath.'/'.$fname);
2073: print $fh $env{'form.'.$source};
2074: close($fh);
2075: if ($parser eq 'parse') {
2076: my $mm = new File::MMagic;
2077: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2078: if ($mime_type eq 'text/html') {
2079: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2080: unless ($parse_result eq 'ok') {
2081: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2082: }
2083: }
2084: }
2085: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2086: $home);
2087: if ($fetchresult eq 'ok') {
2088: return '/uploaded/'.$fpath.'/'.$fname;
2089: } else {
2090: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2091: ' to host '.$home.': '.$fetchresult);
2092: return '/adm/notfound.html';
2093: }
2094: }
2095: }
2096: unless ( $fetchresult eq 'ok') {
2097: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2098: ' to host '.$home.': '.$fetchresult);
2099: }
2100: return $fetchresult;
2101: }
2102:
2103: sub build_filepath {
2104: my ($fpath) = @_;
2105: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2106: unless ($fpath eq '') {
2107: my @parts=split('/',$fpath);
2108: foreach my $part (@parts) {
2109: $filepath.= '/'.$part;
2110: if ((-e $filepath)!=1) {
2111: mkdir($filepath,0777);
2112: }
2113: }
2114: }
2115: return $filepath;
2116: }
2117:
2118: sub store_edited_file {
2119: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2120: my $file = $primary_url;
2121: $file =~ s#^/uploaded/$docudom/$docuname/##;
2122: my $fpath = '';
2123: my $fname = $file;
2124: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2125: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2126: my $filepath = &build_filepath($fpath);
2127: open(my $fh,'>'.$filepath.'/'.$fname);
2128: print $fh $content;
2129: close($fh);
2130: my $home=&homeserver($docuname,$docudom);
2131: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2132: $home);
2133: if ($$fetchresult eq 'ok') {
2134: return '/uploaded/'.$fpath.'/'.$fname;
2135: } else {
2136: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2137: ' to host '.$home.': '.$$fetchresult);
2138: return '/adm/notfound.html';
2139: }
2140: }
2141:
2142: sub clean_filename {
2143: my ($fname,$args)=@_;
2144: # Replace Windows backslashes by forward slashes
2145: $fname=~s/\\/\//g;
2146: if (!$args->{'keep_path'}) {
2147: # Get rid of everything but the actual filename
2148: $fname=~s/^.*\/([^\/]+)$/$1/;
2149: }
2150: # Replace spaces by underscores
2151: $fname=~s/\s+/\_/g;
2152: # Replace all other weird characters by nothing
2153: $fname=~s{[^/\w\.\-]}{}g;
2154: # Replace all .\d. sequences with _\d. so they no longer look like version
2155: # numbers
2156: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2157: return $fname;
2158: }
2159: #This Function check if a Image max 400px width and height 500px. If not then scale the image down
2160: sub resizeImage {
2161: my($img_url) = @_;
2162: my $ima = Image::Magick->new;
2163: $ima->Read($img_url);
2164: if($ima->Get('width') > 400)
2165: {
2166: my $factor = $ima->Get('width')/400;
2167: $ima->Scale( width=>400, height=>$ima->Get('height')/$factor );
2168: }
2169: if($ima->Get('height') > 500)
2170: {
2171: my $factor = $ima->Get('height')/500;
2172: $ima->Scale( width=>$ima->Get('width')/$factor, height=>500);
2173: }
2174:
2175: $ima->Write($img_url);
2176: }
2177:
2178: #Wrapper function for userphotoupload
2179: sub userphotoupload
2180: {
2181: my($formname,$subdir) = @_;
2182: $upload_photo_form = 1;
2183: return &userfileupload($formname,undef,$subdir);
2184: }
2185:
2186: # --------------- Take an uploaded file and put it into the userfiles directory
2187: # input: $formname - the contents of the file are in $env{"form.$formname"}
2188: # the desired filenam is in $env{"form.$formname.filename"}
2189: # $coursedoc - if true up to the current course
2190: # if false
2191: # $subdir - directory in userfile to store the file into
2192: # $parser - instruction to parse file for objects ($parser = parse)
2193: # $allfiles - reference to hash for embedded objects
2194: # $codebase - reference to hash for codebase of java objects
2195: # $desuname - username for permanent storage of uploaded file
2196: # $dsetudom - domain for permanaent storage of uploaded file
2197: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2198: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2199: #
2200: # output: url of file in userspace, or error: <message>
2201: # or /adm/notfound.html if failure to upload occurse
2202:
2203:
2204: sub userfileupload {
2205: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2206: $destudom,$thumbwidth,$thumbheight)=@_;
2207: if (!defined($subdir)) { $subdir='unknown'; }
2208: my $fname=$env{'form.'.$formname.'.filename'};
2209: $fname=&clean_filename($fname);
2210: # See if there is anything left
2211: unless ($fname) { return 'error: no uploaded file'; }
2212: chop($env{'form.'.$formname});
2213: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2214: my $now = time;
2215: my $filepath = 'tmp/helprequests/'.$now;
2216: my @parts=split(/\//,$filepath);
2217: my $fullpath = $perlvar{'lonDaemons'};
2218: for (my $i=0;$i<@parts;$i++) {
2219: $fullpath .= '/'.$parts[$i];
2220: if ((-e $fullpath)!=1) {
2221: mkdir($fullpath,0777);
2222: }
2223: }
2224: open(my $fh,'>'.$fullpath.'/'.$fname);
2225: print $fh $env{'form.'.$formname};
2226: close($fh);
2227: return $fullpath.'/'.$fname;
2228: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2229: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2230: '_'.$env{'user.domain'}.'/pending';
2231: my @parts=split(/\//,$filepath);
2232: my $fullpath = $perlvar{'lonDaemons'};
2233: for (my $i=0;$i<@parts;$i++) {
2234: $fullpath .= '/'.$parts[$i];
2235: if ((-e $fullpath)!=1) {
2236: mkdir($fullpath,0777);
2237: }
2238: }
2239: open(my $fh,'>'.$fullpath.'/'.$fname);
2240: print $fh $env{'form.'.$formname};
2241: close($fh);
2242: return $fullpath.'/'.$fname;
2243: }
2244: if ($subdir eq 'scantron') {
2245: $fname = 'scantron_orig_'.$fname;
2246: } else {
2247: # Create the directory if not present
2248: $fname="$subdir/$fname";
2249: }
2250: if ($coursedoc) {
2251: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2252: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2253: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2254: return &finishuserfileupload($docuname,$docudom,
2255: $formname,$fname,$parser,$allfiles,
2256: $codebase,$thumbwidth,$thumbheight);
2257: } else {
2258: $fname=$env{'form.folder'}.'/'.$fname;
2259: return &process_coursefile('uploaddoc',$docuname,$docudom,
2260: $fname,$formname,$parser,
2261: $allfiles,$codebase);
2262: }
2263: } elsif (defined($destuname)) {
2264: my $docuname=$destuname;
2265: my $docudom=$destudom;
2266: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2267: $parser,$allfiles,$codebase,
2268: $thumbwidth,$thumbheight);
2269:
2270: } else {
2271: my $docuname=$env{'user.name'};
2272: my $docudom=$env{'user.domain'};
2273: if (exists($env{'form.group'})) {
2274: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2275: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2276: }
2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2278: $parser,$allfiles,$codebase,
2279: $thumbwidth,$thumbheight);
2280: }
2281: }
2282:
2283: sub finishuserfileupload {
2284: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2285: $thumbwidth,$thumbheight) = @_;
2286: my $path=$docudom.'/'.$docuname.'/';
2287: my $filepath=$perlvar{'lonDocRoot'};
2288:
2289: my ($fnamepath,$file,$fetchthumb);
2290: $file=$fname;
2291: if ($fname=~m|/|) {
2292: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2293: $path.=$fnamepath.'/';
2294: }
2295: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2296: my $count;
2297: for ($count=4;$count<=$#parts;$count++) {
2298: $filepath.="/$parts[$count]";
2299: if ((-e $filepath)!=1) {
2300: mkdir($filepath,0777);
2301: }
2302: }
2303:
2304: # Save the file
2305: {
2306: if (!open(FH,'>'.$filepath.'/'.$file)) {
2307: &logthis('Failed to create '.$filepath.'/'.$file);
2308: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2309: return '/adm/notfound.html';
2310: }
2311: if (!print FH ($env{'form.'.$formname})) {
2312: &logthis('Failed to write to '.$filepath.'/'.$file);
2313: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2314: return '/adm/notfound.html';
2315: }
2316: close(FH);
2317: if($upload_photo_form==1)
2318: {
2319: resizeImage($filepath.'/'.$file);
2320: $upload_photo_form = 0;
2321: }
2322: }
2323: if ($parser eq 'parse') {
2324: my $mm = new File::MMagic;
2325: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2326: if ($mime_type eq 'text/html') {
2327: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2328: $allfiles,$codebase);
2329: unless ($parse_result eq 'ok') {
2330: &logthis('Failed to parse '.$filepath.$file.
2331: ' for embedded media: '.$parse_result);
2332: }
2333: }
2334: }
2335: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2336: my $input = $filepath.'/'.$file;
2337: my $output = $filepath.'/'.'tn-'.$file;
2338: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2339: system("convert -sample $thumbsize $input $output");
2340: if (-e $filepath.'/'.'tn-'.$file) {
2341: $fetchthumb = 1;
2342: }
2343: }
2344:
2345: # Notify homeserver to grep it
2346: #
2347: my $docuhome=&homeserver($docuname,$docudom);
2348: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2349: if ($fetchresult eq 'ok') {
2350: if ($fetchthumb) {
2351: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2352: if ($thumbresult ne 'ok') {
2353: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2354: $docuhome.': '.$thumbresult);
2355: }
2356: }
2357: #
2358: # Return the URL to it
2359: return '/uploaded/'.$path.$file;
2360: } else {
2361: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2362: ': '.$fetchresult);
2363: return '/adm/notfound.html';
2364: }
2365: }
2366:
2367: sub extract_embedded_items {
2368: my ($fullpath,$allfiles,$codebase,$content) = @_;
2369: my @state = ();
2370: my %javafiles = (
2371: codebase => '',
2372: code => '',
2373: archive => ''
2374: );
2375: my %mediafiles = (
2376: src => '',
2377: movie => '',
2378: );
2379: my $p;
2380: if ($content) {
2381: $p = HTML::LCParser->new($content);
2382: } else {
2383: $p = HTML::LCParser->new($fullpath);
2384: }
2385: while (my $t=$p->get_token()) {
2386: if ($t->[0] eq 'S') {
2387: my ($tagname, $attr) = ($t->[1],$t->[2]);
2388: push(@state, $tagname);
2389: if (lc($tagname) eq 'allow') {
2390: &add_filetype($allfiles,$attr->{'src'},'src');
2391: }
2392: if (lc($tagname) eq 'img') {
2393: &add_filetype($allfiles,$attr->{'src'},'src');
2394: }
2395: if (lc($tagname) eq 'a') {
2396: &add_filetype($allfiles,$attr->{'href'},'href');
2397: }
2398: if (lc($tagname) eq 'script') {
2399: if ($attr->{'archive'} =~ /\.jar$/i) {
2400: &add_filetype($allfiles,$attr->{'archive'},'archive');
2401: } else {
2402: &add_filetype($allfiles,$attr->{'src'},'src');
2403: }
2404: }
2405: if (lc($tagname) eq 'link') {
2406: if (lc($attr->{'rel'}) eq 'stylesheet') {
2407: &add_filetype($allfiles,$attr->{'href'},'href');
2408: }
2409: }
2410: if (lc($tagname) eq 'object' ||
2411: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2412: foreach my $item (keys(%javafiles)) {
2413: $javafiles{$item} = '';
2414: }
2415: }
2416: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2417: my $name = lc($attr->{'name'});
2418: foreach my $item (keys(%javafiles)) {
2419: if ($name eq $item) {
2420: $javafiles{$item} = $attr->{'value'};
2421: last;
2422: }
2423: }
2424: foreach my $item (keys(%mediafiles)) {
2425: if ($name eq $item) {
2426: &add_filetype($allfiles, $attr->{'value'}, 'value');
2427: last;
2428: }
2429: }
2430: }
2431: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2432: foreach my $item (keys(%javafiles)) {
2433: if ($attr->{$item}) {
2434: $javafiles{$item} = $attr->{$item};
2435: last;
2436: }
2437: }
2438: foreach my $item (keys(%mediafiles)) {
2439: if ($attr->{$item}) {
2440: &add_filetype($allfiles,$attr->{$item},$item);
2441: last;
2442: }
2443: }
2444: }
2445: } elsif ($t->[0] eq 'E') {
2446: my ($tagname) = ($t->[1]);
2447: if ($javafiles{'codebase'} ne '') {
2448: $javafiles{'codebase'} .= '/';
2449: }
2450: if (lc($tagname) eq 'applet' ||
2451: lc($tagname) eq 'object' ||
2452: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2453: ) {
2454: foreach my $item (keys(%javafiles)) {
2455: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2456: my $file=$javafiles{'codebase'}.$javafiles{$item};
2457: &add_filetype($allfiles,$file,$item);
2458: }
2459: }
2460: }
2461: pop @state;
2462: }
2463: }
2464: return 'ok';
2465: }
2466:
2467: sub add_filetype {
2468: my ($allfiles,$file,$type)=@_;
2469: if (exists($allfiles->{$file})) {
2470: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2471: push(@{$allfiles->{$file}}, &escape($type));
2472: }
2473: } else {
2474: @{$allfiles->{$file}} = (&escape($type));
2475: }
2476: }
2477:
2478: sub removeuploadedurl {
2479: my ($url)=@_;
2480: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2481: return &removeuserfile($uname,$udom,$fname);
2482: }
2483:
2484: sub removeuserfile {
2485: my ($docuname,$docudom,$fname)=@_;
2486: my $home=&homeserver($docuname,$docudom);
2487: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2488: if ($result eq 'ok') {
2489: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2490: my $metafile = $fname.'.meta';
2491: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2492: my $url = "/uploaded/$docudom/$docuname/$fname";
2493: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2494: my $sqlresult =
2495: &update_portfolio_table($docuname,$docudom,$file,
2496: 'portfolio_metadata',$group,
2497: 'delete');
2498: }
2499: }
2500: return $result;
2501: }
2502:
2503: sub mkdiruserfile {
2504: my ($docuname,$docudom,$dir)=@_;
2505: my $home=&homeserver($docuname,$docudom);
2506: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2507: }
2508:
2509: sub renameuserfile {
2510: my ($docuname,$docudom,$old,$new)=@_;
2511: my $home=&homeserver($docuname,$docudom);
2512: my $result = &reply("renameuserfile:$docudom:$docuname:".
2513: &escape("$old").':'.&escape("$new"),$home);
2514: if ($result eq 'ok') {
2515: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2516: my $oldmeta = $old.'.meta';
2517: my $newmeta = $new.'.meta';
2518: my $metaresult =
2519: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2520: my $url = "/uploaded/$docudom/$docuname/$old";
2521: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2522: my $sqlresult =
2523: &update_portfolio_table($docuname,$docudom,$file,
2524: 'portfolio_metadata',$group,
2525: 'delete');
2526: }
2527: }
2528: return $result;
2529: }
2530:
2531: # ------------------------------------------------------------------------- Log
2532:
2533: sub log {
2534: my ($dom,$nam,$hom,$what)=@_;
2535: return critical("log:$dom:$nam:$what",$hom);
2536: }
2537:
2538: # ------------------------------------------------------------------ Course Log
2539: #
2540: # This routine flushes several buffers of non-mission-critical nature
2541: #
2542:
2543: sub flushcourselogs {
2544: &logthis('Flushing log buffers');
2545: #
2546: # course logs
2547: # This is a log of all transactions in a course, which can be used
2548: # for data mining purposes
2549: #
2550: # It also collects the courseid database, which lists last transaction
2551: # times and course titles for all courseids
2552: #
2553: my %courseidbuffer=();
2554: foreach my $crsid (keys(%courselogs)) {
2555: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2556: &escape($courselogs{$crsid}),
2557: $coursehombuf{$crsid}) eq 'ok') {
2558: delete $courselogs{$crsid};
2559: } else {
2560: &logthis('Failed to flush log buffer for '.$crsid);
2561: if (length($courselogs{$crsid})>40000) {
2562: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2563: " exceeded maximum size, deleting.</font>");
2564: delete $courselogs{$crsid};
2565: }
2566: }
2567: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2568: 'description' => $coursedescrbuf{$crsid},
2569: 'inst_code' => $courseinstcodebuf{$crsid},
2570: 'type' => $coursetypebuf{$crsid},
2571: 'owner' => $courseownerbuf{$crsid},
2572: };
2573: }
2574: #
2575: # Write course id database (reverse lookup) to homeserver of courses
2576: # Is used in pickcourse
2577: #
2578: foreach my $crs_home (keys(%courseidbuffer)) {
2579: my $response = &courseidput(&host_domain($crs_home),
2580: $courseidbuffer{$crs_home},
2581: $crs_home,'timeonly');
2582: }
2583: #
2584: # File accesses
2585: # Writes to the dynamic metadata of resources to get hit counts, etc.
2586: #
2587: foreach my $entry (keys(%accesshash)) {
2588: if ($entry =~ /___count$/) {
2589: my ($dom,$name);
2590: ($dom,$name,undef)=
2591: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2592: if (! defined($dom) || $dom eq '' ||
2593: ! defined($name) || $name eq '') {
2594: my $cid = $env{'request.course.id'};
2595: $dom = $env{'request.'.$cid.'.domain'};
2596: $name = $env{'request.'.$cid.'.num'};
2597: }
2598: my $value = $accesshash{$entry};
2599: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2600: my %temphash=($url => $value);
2601: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2602: if ($result eq 'ok') {
2603: delete $accesshash{$entry};
2604: } elsif ($result eq 'unknown_cmd') {
2605: # Target server has old code running on it.
2606: my %temphash=($entry => $value);
2607: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2608: delete $accesshash{$entry};
2609: }
2610: }
2611: } else {
2612: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2613: my %temphash=($entry => $accesshash{$entry});
2614: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2615: delete $accesshash{$entry};
2616: }
2617: }
2618: }
2619: #
2620: # Roles
2621: # Reverse lookup of user roles for course faculty/staff and co-authorship
2622: #
2623: foreach my $entry (keys(%userrolehash)) {
2624: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2625: split(/\:/,$entry);
2626: if (&Apache::lonnet::put('nohist_userroles',
2627: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2628: $rudom,$runame) eq 'ok') {
2629: delete $userrolehash{$entry};
2630: }
2631: }
2632: #
2633: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2634: #
2635: my %domrolebuffer = ();
2636: foreach my $entry (keys(%domainrolehash)) {
2637: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2638: if ($domrolebuffer{$rudom}) {
2639: $domrolebuffer{$rudom}.='&'.&escape($entry).
2640: '='.&escape($domainrolehash{$entry});
2641: } else {
2642: $domrolebuffer{$rudom}.=&escape($entry).
2643: '='.&escape($domainrolehash{$entry});
2644: }
2645: delete $domainrolehash{$entry};
2646: }
2647: foreach my $dom (keys(%domrolebuffer)) {
2648: my %servers = &get_servers($dom,'library');
2649: foreach my $tryserver (keys(%servers)) {
2650: unless (&reply('domroleput:'.$dom.':'.
2651: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2652: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2653: }
2654: }
2655: }
2656: $dumpcount++;
2657: }
2658:
2659: sub courselog {
2660: my $what=shift;
2661: $what=time.':'.$what;
2662: unless ($env{'request.course.id'}) { return ''; }
2663: $coursedombuf{$env{'request.course.id'}}=
2664: $env{'course.'.$env{'request.course.id'}.'.domain'};
2665: $coursenumbuf{$env{'request.course.id'}}=
2666: $env{'course.'.$env{'request.course.id'}.'.num'};
2667: $coursehombuf{$env{'request.course.id'}}=
2668: $env{'course.'.$env{'request.course.id'}.'.home'};
2669: $coursedescrbuf{$env{'request.course.id'}}=
2670: $env{'course.'.$env{'request.course.id'}.'.description'};
2671: $courseinstcodebuf{$env{'request.course.id'}}=
2672: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2673: $courseownerbuf{$env{'request.course.id'}}=
2674: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2675: $coursetypebuf{$env{'request.course.id'}}=
2676: $env{'course.'.$env{'request.course.id'}.'.type'};
2677: if (defined $courselogs{$env{'request.course.id'}}) {
2678: $courselogs{$env{'request.course.id'}}.='&'.$what;
2679: } else {
2680: $courselogs{$env{'request.course.id'}}.=$what;
2681: }
2682: if (length($courselogs{$env{'request.course.id'}})>4048) {
2683: &flushcourselogs();
2684: }
2685: }
2686:
2687: sub courseacclog {
2688: my $fnsymb=shift;
2689: unless ($env{'request.course.id'}) { return ''; }
2690: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2691: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2692: $what.=':POST';
2693: # FIXME: Probably ought to escape things....
2694: foreach my $key (keys(%env)) {
2695: if ($key=~/^form\.(.*)/) {
2696: my $formitem = $1;
2697: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2698: $what.=':'.$formitem.'='.$env{$key};
2699: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2700: $what.=':'.$formitem.'='.$env{$key};
2701: }
2702: }
2703: }
2704: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2705: # FIXME: We should not be depending on a form parameter that someone
2706: # editing lonsearchcat.pm might change in the future.
2707: if ($env{'form.phase'} eq 'course_search') {
2708: $what.= ':POST';
2709: # FIXME: Probably ought to escape things....
2710: foreach my $element ('courseexp','crsfulltext','crsrelated',
2711: 'crsdiscuss') {
2712: $what.=':'.$element.'='.$env{'form.'.$element};
2713: }
2714: }
2715: }
2716: &courselog($what);
2717: }
2718:
2719: sub countacc {
2720: my $url=&declutter(shift);
2721: return if (! defined($url) || $url eq '');
2722: unless ($env{'request.course.id'}) { return ''; }
2723: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2724: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2725: $accesshash{$key}++;
2726: }
2727:
2728: sub linklog {
2729: my ($from,$to)=@_;
2730: $from=&declutter($from);
2731: $to=&declutter($to);
2732: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2733: $accesshash{$to.'___'.$from.'___goto'}=1;
2734: }
2735:
2736: sub userrolelog {
2737: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2738: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2739: ($trole=~/^in/) || ($trole=~/^cc/) ||
2740: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2741: ($trole=~/^ta/) || ($trole=~/^co/)) {
2742: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2743: $userrolehash
2744: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2745: =$tend.':'.$tstart;
2746: }
2747: if (($env{'request.role'} =~ /dc\./) &&
2748: (($trole=~/^au/) || ($trole=~/^in/) ||
2749: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2750: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2751: ($trole=~/^co/))) {
2752: $userrolehash
2753: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2754: =$tend.':'.$tstart;
2755: }
2756: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2757: ($trole=~/^li/) || ($trole=~/^li/) ||
2758: ($trole=~/^au/) || ($trole=~/^dg/) ||
2759: ($trole=~/^sc/)) {
2760: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2761: $domainrolehash
2762: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2763: = $tend.':'.$tstart;
2764: }
2765: }
2766:
2767: sub courserolelog {
2768: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2769: if (($trole eq 'cc') || ($trole eq 'in') ||
2770: ($trole eq 'ep') || ($trole eq 'ad') ||
2771: ($trole eq 'ta') || ($trole eq 'st') ||
2772: ($trole=~/^cr/) || ($trole eq 'gr') ||
2773: ($trole eq 'co')) {
2774: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2775: my $cdom = $1;
2776: my $cnum = $2;
2777: my $sec = $3;
2778: my $namespace = 'rolelog';
2779: my %storehash = (
2780: role => $trole,
2781: start => $tstart,
2782: end => $tend,
2783: selfenroll => $selfenroll,
2784: context => $context,
2785: );
2786: if ($trole eq 'gr') {
2787: $namespace = 'groupslog';
2788: $storehash{'group'} = $sec;
2789: } else {
2790: $storehash{'section'} = $sec;
2791: }
2792: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2793: if (($trole ne 'st') || ($sec ne '')) {
2794: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2795: }
2796: }
2797: }
2798: return;
2799: }
2800:
2801: sub get_course_adv_roles {
2802: my ($cid,$codes) = @_;
2803: $cid=$env{'request.course.id'} unless (defined($cid));
2804: my %coursehash=&coursedescription($cid);
2805: my $crstype = &Apache::loncommon::course_type($cid);
2806: my %nothide=();
2807: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2808: if ($user !~ /:/) {
2809: $nothide{join(':',split(/[\@]/,$user))}=1;
2810: } else {
2811: $nothide{$user}=1;
2812: }
2813: }
2814: my %returnhash=();
2815: my %dumphash=
2816: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2817: my $now=time;
2818: my %privileged;
2819: foreach my $entry (keys(%dumphash)) {
2820: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2821: if (($tstart) && ($tstart<0)) { next; }
2822: if (($tend) && ($tend<$now)) { next; }
2823: if (($tstart) && ($now<$tstart)) { next; }
2824: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2825: if ($username eq '' || $domain eq '') { next; }
2826: unless (ref($privileged{$domain}) eq 'HASH') {
2827: my %dompersonnel =
2828: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2829: $privileged{$domain} = {};
2830: foreach my $server (keys(%dompersonnel)) {
2831: if (ref($dompersonnel{$server}) eq 'HASH') {
2832: foreach my $user (keys(%{$dompersonnel{$server}})) {
2833: my ($trole,$uname,$udom) = split(/:/,$user);
2834: $privileged{$udom}{$uname} = 1;
2835: }
2836: }
2837: }
2838: }
2839: if ((exists($privileged{$domain}{$username})) &&
2840: (!$nothide{$username.':'.$domain})) { next; }
2841: if ($role eq 'cr') { next; }
2842: if ($codes) {
2843: if ($section) { $role .= ':'.$section; }
2844: if ($returnhash{$role}) {
2845: $returnhash{$role}.=','.$username.':'.$domain;
2846: } else {
2847: $returnhash{$role}=$username.':'.$domain;
2848: }
2849: } else {
2850: my $key=&plaintext($role,$crstype);
2851: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2852: if ($returnhash{$key}) {
2853: $returnhash{$key}.=','.$username.':'.$domain;
2854: } else {
2855: $returnhash{$key}=$username.':'.$domain;
2856: }
2857: }
2858: }
2859: return %returnhash;
2860: }
2861:
2862: sub get_my_roles {
2863: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2864: unless (defined($uname)) { $uname=$env{'user.name'}; }
2865: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2866: my (%dumphash,%nothide);
2867: if ($context eq 'userroles') {
2868: %dumphash = &dump('roles',$udom,$uname);
2869: } else {
2870: %dumphash=
2871: &dump('nohist_userroles',$udom,$uname);
2872: if ($hidepriv) {
2873: my %coursehash=&coursedescription($udom.'_'.$uname);
2874: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2875: if ($user !~ /:/) {
2876: $nothide{join(':',split(/[\@]/,$user))} = 1;
2877: } else {
2878: $nothide{$user} = 1;
2879: }
2880: }
2881: }
2882: }
2883: my %returnhash=();
2884: my $now=time;
2885: my %privileged;
2886: foreach my $entry (keys(%dumphash)) {
2887: my ($role,$tend,$tstart);
2888: if ($context eq 'userroles') {
2889: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2890: } else {
2891: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2892: }
2893: if (($tstart) && ($tstart<0)) { next; }
2894: my $status = 'active';
2895: if (($tend) && ($tend<=$now)) {
2896: $status = 'previous';
2897: }
2898: if (($tstart) && ($now<$tstart)) {
2899: $status = 'future';
2900: }
2901: if (ref($types) eq 'ARRAY') {
2902: if (!grep(/^\Q$status\E$/,@{$types})) {
2903: next;
2904: }
2905: } else {
2906: if ($status ne 'active') {
2907: next;
2908: }
2909: }
2910: my ($rolecode,$username,$domain,$section,$area);
2911: if ($context eq 'userroles') {
2912: ($area,$rolecode) = split(/_/,$entry);
2913: (undef,$domain,$username,$section) = split(/\//,$area);
2914: } else {
2915: ($role,$username,$domain,$section) = split(/\:/,$entry);
2916: }
2917: if (ref($roledoms) eq 'ARRAY') {
2918: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2919: next;
2920: }
2921: }
2922: if (ref($roles) eq 'ARRAY') {
2923: if (!grep(/^\Q$role\E$/,@{$roles})) {
2924: if ($role =~ /^cr\//) {
2925: if (!grep(/^cr$/,@{$roles})) {
2926: next;
2927: }
2928: } else {
2929: next;
2930: }
2931: }
2932: }
2933: if ($hidepriv) {
2934: if ($context eq 'userroles') {
2935: if ((&privileged($username,$domain)) &&
2936: (!$nothide{$username.':'.$domain})) {
2937: next;
2938: }
2939: } else {
2940: unless (ref($privileged{$domain}) eq 'HASH') {
2941: my %dompersonnel =
2942: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2943: $privileged{$domain} = {};
2944: if (keys(%dompersonnel)) {
2945: foreach my $server (keys(%dompersonnel)) {
2946: if (ref($dompersonnel{$server}) eq 'HASH') {
2947: foreach my $user (keys(%{$dompersonnel{$server}})) {
2948: my ($trole,$uname,$udom) = split(/:/,$user);
2949: $privileged{$udom}{$uname} = $trole;
2950: }
2951: }
2952: }
2953: }
2954: }
2955: if (exists($privileged{$domain}{$username})) {
2956: if (!$nothide{$username.':'.$domain}) {
2957: next;
2958: }
2959: }
2960: }
2961: }
2962: if ($withsec) {
2963: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2964: $tstart.':'.$tend;
2965: } else {
2966: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2967: }
2968: }
2969: return %returnhash;
2970: }
2971:
2972: # ----------------------------------------------------- Frontpage Announcements
2973: #
2974: #
2975:
2976: sub postannounce {
2977: my ($server,$text)=@_;
2978: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2979: unless ($text=~/\w/) { $text=''; }
2980: return &reply('setannounce:'.&escape($text),$server);
2981: }
2982:
2983: sub getannounce {
2984:
2985: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2986: my $announcement='';
2987: while (my $line = <$fh>) { $announcement .= $line; }
2988: close($fh);
2989: if ($announcement=~/\w/) {
2990: return
2991: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2992: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2993: } else {
2994: return '';
2995: }
2996: } else {
2997: return '';
2998: }
2999: }
3000:
3001: # ---------------------------------------------------------- Course ID routines
3002: # Deal with domain's nohist_courseid.db files
3003: #
3004:
3005: sub courseidput {
3006: my ($domain,$storehash,$coursehome,$caller) = @_;
3007: my $outcome;
3008: if ($caller eq 'timeonly') {
3009: my $cids = '';
3010: foreach my $item (keys(%$storehash)) {
3011: $cids.=&escape($item).'&';
3012: }
3013: $cids=~s/\&$//;
3014: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3015: $coursehome);
3016: } else {
3017: my $items = '';
3018: foreach my $item (keys(%$storehash)) {
3019: $items.= &escape($item).'='.
3020: &freeze_escape($$storehash{$item}).'&';
3021: }
3022: $items=~s/\&$//;
3023: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3024: $coursehome);
3025: }
3026: if ($outcome eq 'unknown_cmd') {
3027: my $what;
3028: foreach my $cid (keys(%$storehash)) {
3029: $what .= &escape($cid).'=';
3030: foreach my $item ('description','inst_code','owner','type') {
3031: $what .= &escape($storehash->{$cid}{$item}).':';
3032: }
3033: $what =~ s/\:$/&/;
3034: }
3035: $what =~ s/\&$//;
3036: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3037: } else {
3038: return $outcome;
3039: }
3040: }
3041:
3042: sub courseiddump {
3043: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3044: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3045: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3046: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
3047: my $as_hash = 1;
3048: my %returnhash;
3049: if (!$domfilter) { $domfilter=''; }
3050: my %libserv = &all_library();
3051: foreach my $tryserver (keys(%libserv)) {
3052: if ( ( $hostidflag == 1
3053: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3054: || (!defined($hostidflag)) ) {
3055:
3056: if (($domfilter eq '') ||
3057: (&host_domain($tryserver) eq $domfilter)) {
3058: my $rep =
3059: &reply('courseiddump:'.&host_domain($tryserver).':'.
3060: $sincefilter.':'.&escape($descfilter).':'.
3061: &escape($instcodefilter).':'.&escape($ownerfilter).
3062: ':'.&escape($coursefilter).':'.&escape($typefilter).
3063: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3064: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3065: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3066: &escape($cc_clone).':'.$cloneonly.':'.
3067: &escape($createdbefore).':'.&escape($createdafter).':'.
3068: &escape($creationcontext),$tryserver);
3069: my @pairs=split(/\&/,$rep);
3070: foreach my $item (@pairs) {
3071: my ($key,$value)=split(/\=/,$item,2);
3072: $key = &unescape($key);
3073: next if ($key =~ /^error: 2 /);
3074: my $result = &thaw_unescape($value);
3075: if (ref($result) eq 'HASH') {
3076: $returnhash{$key}=$result;
3077: } else {
3078: my @responses = split(/:/,$value);
3079: my @items = ('description','inst_code','owner','type');
3080: for (my $i=0; $i<@responses; $i++) {
3081: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3082: }
3083: }
3084: }
3085: }
3086: }
3087: }
3088: return %returnhash;
3089: }
3090:
3091: # ---------------------------------------------------------- DC e-mail
3092:
3093: sub dcmailput {
3094: my ($domain,$msgid,$message,$server)=@_;
3095: my $status = &Apache::lonnet::critical(
3096: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3097: &escape($message),$server);
3098: return $status;
3099: }
3100:
3101: sub dcmaildump {
3102: my ($dom,$startdate,$enddate,$senders) = @_;
3103: my %returnhash=();
3104:
3105: if (defined(&domain($dom,'primary'))) {
3106: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3107: &escape($enddate).':';
3108: my @esc_senders=map { &escape($_)} @$senders;
3109: $cmd.=&escape(join('&',@esc_senders));
3110: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3111: my ($key,$value) = split(/\=/,$line,2);
3112: if (($key) && ($value)) {
3113: $returnhash{&unescape($key)} = &unescape($value);
3114: }
3115: }
3116: }
3117: return %returnhash;
3118: }
3119: # ---------------------------------------------------------- Domain roles
3120:
3121: sub get_domain_roles {
3122: my ($dom,$roles,$startdate,$enddate)=@_;
3123: if ((!defined($startdate)) || ($startdate eq '')) {
3124: $startdate = '.';
3125: }
3126: if ((!defined($enddate)) || ($enddate eq '')) {
3127: $enddate = '.';
3128: }
3129: my $rolelist;
3130: if (ref($roles) eq 'ARRAY') {
3131: $rolelist = join(':',@{$roles});
3132: }
3133: my %personnel = ();
3134:
3135: my %servers = &get_servers($dom,'library');
3136: foreach my $tryserver (keys(%servers)) {
3137: %{$personnel{$tryserver}}=();
3138: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3139: &escape($startdate).':'.
3140: &escape($enddate).':'.
3141: &escape($rolelist), $tryserver))) {
3142: my ($key,$value) = split(/\=/,$line,2);
3143: if (($key) && ($value)) {
3144: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3145: }
3146: }
3147: }
3148: return %personnel;
3149: }
3150:
3151: # ----------------------------------------------------------- Check out an item
3152:
3153: sub get_first_access {
3154: my ($type,$argsymb)=@_;
3155: my ($symb,$courseid,$udom,$uname)=&whichuser();
3156: if ($argsymb) { $symb=$argsymb; }
3157: my ($map,$id,$res)=&decode_symb($symb);
3158: if ($type eq 'course') {
3159: $res='course';
3160: } elsif ($type eq 'map') {
3161: $res=&symbread($map);
3162: } else {
3163: $res=$symb;
3164: }
3165: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3166: return $times{"$courseid\0$res"};
3167: }
3168:
3169: sub set_first_access {
3170: my ($type)=@_;
3171: my ($symb,$courseid,$udom,$uname)=&whichuser();
3172: my ($map,$id,$res)=&decode_symb($symb);
3173: if ($type eq 'course') {
3174: $res='course';
3175: } elsif ($type eq 'map') {
3176: $res=&symbread($map);
3177: } else {
3178: $res=$symb;
3179: }
3180: my $firstaccess=&get_first_access($type,$symb);
3181: if (!$firstaccess) {
3182: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3183: }
3184: return 'already_set';
3185: }
3186:
3187: sub checkout {
3188: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3189: my $now=time;
3190: my $lonhost=$perlvar{'lonHostID'};
3191: my $infostr=&escape(
3192: 'CHECKOUTTOKEN&'.
3193: $tuname.'&'.
3194: $tudom.'&'.
3195: $tcrsid.'&'.
3196: $symb.'&'.
3197: $now.'&'.$ENV{'REMOTE_ADDR'});
3198: my $token=&reply('tmpput:'.$infostr,$lonhost);
3199: if ($token=~/^error\:/) {
3200: &logthis("<font color=\"blue\">WARNING: ".
3201: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3202: "</font>");
3203: return '';
3204: }
3205:
3206: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3207: $token=~tr/a-z/A-Z/;
3208:
3209: my %infohash=('resource.0.outtoken' => $token,
3210: 'resource.0.checkouttime' => $now,
3211: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
3212:
3213: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3214: return '';
3215: } else {
3216: &logthis("<font color=\"blue\">WARNING: ".
3217: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3218: "</font>");
3219: }
3220:
3221: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3222: &escape('Checkout '.$infostr.' - '.
3223: $token)) ne 'ok') {
3224: return '';
3225: } else {
3226: &logthis("<font color=\"blue\">WARNING: ".
3227: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3228: "</font>");
3229: }
3230: return $token;
3231: }
3232:
3233: # ------------------------------------------------------------ Check in an item
3234:
3235: sub checkin {
3236: my $token=shift;
3237: my $now=time;
3238: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3239: $lonhost=~tr/A-Z/a-z/;
3240: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
3241: $dtoken=~s/\W/\_/g;
3242: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
3243: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3244:
3245: unless (($tuname) && ($tudom)) {
3246: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3247: return '';
3248: }
3249:
3250: unless (&allowed('mgr',$tcrsid)) {
3251: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
3252: $env{'user.name'}.' - '.$env{'user.domain'});
3253: return '';
3254: }
3255:
3256: my %infohash=('resource.0.intoken' => $token,
3257: 'resource.0.checkintime' => $now,
3258: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
3259:
3260: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3261: return '';
3262: }
3263:
3264: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3265: &escape('Checkin - '.$token)) ne 'ok') {
3266: return '';
3267: }
3268:
3269: return ($symb,$tuname,$tudom,$tcrsid);
3270: }
3271:
3272: # --------------------------------------------- Set Expire Date for Spreadsheet
3273:
3274: sub expirespread {
3275: my ($uname,$udom,$stype,$usymb)=@_;
3276: my $cid=$env{'request.course.id'};
3277: if ($cid) {
3278: my $now=time;
3279: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3280: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3281: $env{'course.'.$cid.'.num'}.
3282: ':nohist_expirationdates:'.
3283: &escape($key).'='.$now,
3284: $env{'course.'.$cid.'.home'})
3285: }
3286: return 'ok';
3287: }
3288:
3289: # ----------------------------------------------------- Devalidate Spreadsheets
3290:
3291: sub devalidate {
3292: my ($symb,$uname,$udom)=@_;
3293: my $cid=$env{'request.course.id'};
3294: if ($cid) {
3295: # delete the stored spreadsheets for
3296: # - the student level sheet of this user in course's homespace
3297: # - the assessment level sheet for this resource
3298: # for this user in user's homespace
3299: # - current conditional state info
3300: my $key=$uname.':'.$udom.':';
3301: my $status=
3302: &del('nohist_calculatedsheets',
3303: [$key.'studentcalc:'],
3304: $env{'course.'.$cid.'.domain'},
3305: $env{'course.'.$cid.'.num'})
3306: .' '.
3307: &del('nohist_calculatedsheets_'.$cid,
3308: [$key.'assesscalc:'.$symb],$udom,$uname);
3309: unless ($status eq 'ok ok') {
3310: &logthis('Could not devalidate spreadsheet '.
3311: $uname.' at '.$udom.' for '.
3312: $symb.': '.$status);
3313: }
3314: &delenv('user.state.'.$cid);
3315: }
3316: }
3317:
3318: sub get_scalar {
3319: my ($string,$end) = @_;
3320: my $value;
3321: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3322: $value = $1;
3323: } elsif ($$string =~ s/^([^&]*?)&//) {
3324: $value = $1;
3325: }
3326: return &unescape($value);
3327: }
3328:
3329: sub array2str {
3330: my (@array) = @_;
3331: my $result=&arrayref2str(\@array);
3332: $result=~s/^__ARRAY_REF__//;
3333: $result=~s/__END_ARRAY_REF__$//;
3334: return $result;
3335: }
3336:
3337: sub arrayref2str {
3338: my ($arrayref) = @_;
3339: my $result='__ARRAY_REF__';
3340: foreach my $elem (@$arrayref) {
3341: if(ref($elem) eq 'ARRAY') {
3342: $result.=&arrayref2str($elem).'&';
3343: } elsif(ref($elem) eq 'HASH') {
3344: $result.=&hashref2str($elem).'&';
3345: } elsif(ref($elem)) {
3346: #print("Got a ref of ".(ref($elem))." skipping.");
3347: } else {
3348: $result.=&escape($elem).'&';
3349: }
3350: }
3351: $result=~s/\&$//;
3352: $result .= '__END_ARRAY_REF__';
3353: return $result;
3354: }
3355:
3356: sub hash2str {
3357: my (%hash) = @_;
3358: my $result=&hashref2str(\%hash);
3359: $result=~s/^__HASH_REF__//;
3360: $result=~s/__END_HASH_REF__$//;
3361: return $result;
3362: }
3363:
3364: sub hashref2str {
3365: my ($hashref)=@_;
3366: my $result='__HASH_REF__';
3367: foreach my $key (sort(keys(%$hashref))) {
3368: if (ref($key) eq 'ARRAY') {
3369: $result.=&arrayref2str($key).'=';
3370: } elsif (ref($key) eq 'HASH') {
3371: $result.=&hashref2str($key).'=';
3372: } elsif (ref($key)) {
3373: $result.='=';
3374: #print("Got a ref of ".(ref($key))." skipping.");
3375: } else {
3376: if ($key) {$result.=&escape($key).'=';} else { last; }
3377: }
3378:
3379: if(ref($hashref->{$key}) eq 'ARRAY') {
3380: $result.=&arrayref2str($hashref->{$key}).'&';
3381: } elsif(ref($hashref->{$key}) eq 'HASH') {
3382: $result.=&hashref2str($hashref->{$key}).'&';
3383: } elsif(ref($hashref->{$key})) {
3384: $result.='&';
3385: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3386: } else {
3387: $result.=&escape($hashref->{$key}).'&';
3388: }
3389: }
3390: $result=~s/\&$//;
3391: $result .= '__END_HASH_REF__';
3392: return $result;
3393: }
3394:
3395: sub str2hash {
3396: my ($string)=@_;
3397: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3398: return %$hash;
3399: }
3400:
3401: sub str2hashref {
3402: my ($string) = @_;
3403:
3404: my %hash;
3405:
3406: if($string !~ /^__HASH_REF__/) {
3407: if (! ($string eq '' || !defined($string))) {
3408: $hash{'error'}='Not hash reference';
3409: }
3410: return (\%hash, $string);
3411: }
3412:
3413: $string =~ s/^__HASH_REF__//;
3414:
3415: while($string !~ /^__END_HASH_REF__/) {
3416: #key
3417: my $key='';
3418: if($string =~ /^__HASH_REF__/) {
3419: ($key, $string)=&str2hashref($string);
3420: if(defined($key->{'error'})) {
3421: $hash{'error'}='Bad data';
3422: return (\%hash, $string);
3423: }
3424: } elsif($string =~ /^__ARRAY_REF__/) {
3425: ($key, $string)=&str2arrayref($string);
3426: if($key->[0] eq 'Array reference error') {
3427: $hash{'error'}='Bad data';
3428: return (\%hash, $string);
3429: }
3430: } else {
3431: $string =~ s/^(.*?)=//;
3432: $key=&unescape($1);
3433: }
3434: $string =~ s/^=//;
3435:
3436: #value
3437: my $value='';
3438: if($string =~ /^__HASH_REF__/) {
3439: ($value, $string)=&str2hashref($string);
3440: if(defined($value->{'error'})) {
3441: $hash{'error'}='Bad data';
3442: return (\%hash, $string);
3443: }
3444: } elsif($string =~ /^__ARRAY_REF__/) {
3445: ($value, $string)=&str2arrayref($string);
3446: if($value->[0] eq 'Array reference error') {
3447: $hash{'error'}='Bad data';
3448: return (\%hash, $string);
3449: }
3450: } else {
3451: $value=&get_scalar(\$string,'__END_HASH_REF__');
3452: }
3453: $string =~ s/^&//;
3454:
3455: $hash{$key}=$value;
3456: }
3457:
3458: $string =~ s/^__END_HASH_REF__//;
3459:
3460: return (\%hash, $string);
3461: }
3462:
3463: sub str2array {
3464: my ($string)=@_;
3465: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3466: return @$array;
3467: }
3468:
3469: sub str2arrayref {
3470: my ($string) = @_;
3471: my @array;
3472:
3473: if($string !~ /^__ARRAY_REF__/) {
3474: if (! ($string eq '' || !defined($string))) {
3475: $array[0]='Array reference error';
3476: }
3477: return (\@array, $string);
3478: }
3479:
3480: $string =~ s/^__ARRAY_REF__//;
3481:
3482: while($string !~ /^__END_ARRAY_REF__/) {
3483: my $value='';
3484: if($string =~ /^__HASH_REF__/) {
3485: ($value, $string)=&str2hashref($string);
3486: if(defined($value->{'error'})) {
3487: $array[0] ='Array reference error';
3488: return (\@array, $string);
3489: }
3490: } elsif($string =~ /^__ARRAY_REF__/) {
3491: ($value, $string)=&str2arrayref($string);
3492: if($value->[0] eq 'Array reference error') {
3493: $array[0] ='Array reference error';
3494: return (\@array, $string);
3495: }
3496: } else {
3497: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3498: }
3499: $string =~ s/^&//;
3500:
3501: push(@array, $value);
3502: }
3503:
3504: $string =~ s/^__END_ARRAY_REF__//;
3505:
3506: return (\@array, $string);
3507: }
3508:
3509: # -------------------------------------------------------------------Temp Store
3510:
3511: sub tmpreset {
3512: my ($symb,$namespace,$domain,$stuname) = @_;
3513: if (!$symb) {
3514: $symb=&symbread();
3515: if (!$symb) { $symb= $env{'request.url'}; }
3516: }
3517: $symb=escape($symb);
3518:
3519: if (!$namespace) { $namespace=$env{'request.state'}; }
3520: $namespace=~s/\//\_/g;
3521: $namespace=~s/\W//g;
3522:
3523: if (!$domain) { $domain=$env{'user.domain'}; }
3524: if (!$stuname) { $stuname=$env{'user.name'}; }
3525: if ($domain eq 'public' && $stuname eq 'public') {
3526: $stuname=$ENV{'REMOTE_ADDR'};
3527: }
3528: my $path=$perlvar{'lonDaemons'}.'/tmp';
3529: my %hash;
3530: if (tie(%hash,'GDBM_File',
3531: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3532: &GDBM_WRCREAT(),0640)) {
3533: foreach my $key (keys(%hash)) {
3534: if ($key=~ /:$symb/) {
3535: delete($hash{$key});
3536: }
3537: }
3538: }
3539: }
3540:
3541: sub tmpstore {
3542: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3543:
3544: if (!$symb) {
3545: $symb=&symbread();
3546: if (!$symb) { $symb= $env{'request.url'}; }
3547: }
3548: $symb=escape($symb);
3549:
3550: if (!$namespace) {
3551: # I don't think we would ever want to store this for a course.
3552: # it seems this will only be used if we don't have a course.
3553: #$namespace=$env{'request.course.id'};
3554: #if (!$namespace) {
3555: $namespace=$env{'request.state'};
3556: #}
3557: }
3558: $namespace=~s/\//\_/g;
3559: $namespace=~s/\W//g;
3560: if (!$domain) { $domain=$env{'user.domain'}; }
3561: if (!$stuname) { $stuname=$env{'user.name'}; }
3562: if ($domain eq 'public' && $stuname eq 'public') {
3563: $stuname=$ENV{'REMOTE_ADDR'};
3564: }
3565: my $now=time;
3566: my %hash;
3567: my $path=$perlvar{'lonDaemons'}.'/tmp';
3568: if (tie(%hash,'GDBM_File',
3569: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3570: &GDBM_WRCREAT(),0640)) {
3571: $hash{"version:$symb"}++;
3572: my $version=$hash{"version:$symb"};
3573: my $allkeys='';
3574: foreach my $key (keys(%$storehash)) {
3575: $allkeys.=$key.':';
3576: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3577: }
3578: $hash{"$version:$symb:timestamp"}=$now;
3579: $allkeys.='timestamp';
3580: $hash{"$version:keys:$symb"}=$allkeys;
3581: if (untie(%hash)) {
3582: return 'ok';
3583: } else {
3584: return "error:$!";
3585: }
3586: } else {
3587: return "error:$!";
3588: }
3589: }
3590:
3591: # -----------------------------------------------------------------Temp Restore
3592:
3593: sub tmprestore {
3594: my ($symb,$namespace,$domain,$stuname) = @_;
3595:
3596: if (!$symb) {
3597: $symb=&symbread();
3598: if (!$symb) { $symb= $env{'request.url'}; }
3599: }
3600: $symb=escape($symb);
3601:
3602: if (!$namespace) { $namespace=$env{'request.state'}; }
3603:
3604: if (!$domain) { $domain=$env{'user.domain'}; }
3605: if (!$stuname) { $stuname=$env{'user.name'}; }
3606: if ($domain eq 'public' && $stuname eq 'public') {
3607: $stuname=$ENV{'REMOTE_ADDR'};
3608: }
3609: my %returnhash;
3610: $namespace=~s/\//\_/g;
3611: $namespace=~s/\W//g;
3612: my %hash;
3613: my $path=$perlvar{'lonDaemons'}.'/tmp';
3614: if (tie(%hash,'GDBM_File',
3615: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3616: &GDBM_READER(),0640)) {
3617: my $version=$hash{"version:$symb"};
3618: $returnhash{'version'}=$version;
3619: my $scope;
3620: for ($scope=1;$scope<=$version;$scope++) {
3621: my $vkeys=$hash{"$scope:keys:$symb"};
3622: my @keys=split(/:/,$vkeys);
3623: my $key;
3624: $returnhash{"$scope:keys"}=$vkeys;
3625: foreach $key (@keys) {
3626: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3627: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3628: }
3629: }
3630: if (!(untie(%hash))) {
3631: return "error:$!";
3632: }
3633: } else {
3634: return "error:$!";
3635: }
3636: return %returnhash;
3637: }
3638:
3639: # ----------------------------------------------------------------------- Store
3640:
3641: sub store {
3642: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3643: my $home='';
3644:
3645: if ($stuname) { $home=&homeserver($stuname,$domain); }
3646:
3647: $symb=&symbclean($symb);
3648: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3649:
3650: if (!$domain) { $domain=$env{'user.domain'}; }
3651: if (!$stuname) { $stuname=$env{'user.name'}; }
3652:
3653: &devalidate($symb,$stuname,$domain);
3654:
3655: $symb=escape($symb);
3656: if (!$namespace) {
3657: unless ($namespace=$env{'request.course.id'}) {
3658: return '';
3659: }
3660: }
3661: if (!$home) { $home=$env{'user.home'}; }
3662:
3663: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3664: $$storehash{'host'}=$perlvar{'lonHostID'};
3665:
3666: my $namevalue='';
3667: foreach my $key (keys(%$storehash)) {
3668: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3669: }
3670: $namevalue=~s/\&$//;
3671: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3672: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3673: }
3674:
3675: # -------------------------------------------------------------- Critical Store
3676:
3677: sub cstore {
3678: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3679: my $home='';
3680:
3681: if ($stuname) { $home=&homeserver($stuname,$domain); }
3682:
3683: $symb=&symbclean($symb);
3684: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3685:
3686: if (!$domain) { $domain=$env{'user.domain'}; }
3687: if (!$stuname) { $stuname=$env{'user.name'}; }
3688:
3689: &devalidate($symb,$stuname,$domain);
3690:
3691: $symb=escape($symb);
3692: if (!$namespace) {
3693: unless ($namespace=$env{'request.course.id'}) {
3694: return '';
3695: }
3696: }
3697: if (!$home) { $home=$env{'user.home'}; }
3698:
3699: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3700: $$storehash{'host'}=$perlvar{'lonHostID'};
3701:
3702: my $namevalue='';
3703: foreach my $key (keys(%$storehash)) {
3704: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3705: }
3706: $namevalue=~s/\&$//;
3707: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3708: return critical
3709: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3710: }
3711:
3712: # --------------------------------------------------------------------- Restore
3713:
3714: sub restore {
3715: my ($symb,$namespace,$domain,$stuname) = @_;
3716: my $home='';
3717:
3718: if ($stuname) { $home=&homeserver($stuname,$domain); }
3719:
3720: if (!$symb) {
3721: unless ($symb=escape(&symbread())) { return ''; }
3722: } else {
3723: $symb=&escape(&symbclean($symb));
3724: }
3725: if (!$namespace) {
3726: unless ($namespace=$env{'request.course.id'}) {
3727: return '';
3728: }
3729: }
3730: if (!$domain) { $domain=$env{'user.domain'}; }
3731: if (!$stuname) { $stuname=$env{'user.name'}; }
3732: if (!$home) { $home=$env{'user.home'}; }
3733: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3734:
3735: my %returnhash=();
3736: foreach my $line (split(/\&/,$answer)) {
3737: my ($name,$value)=split(/\=/,$line);
3738: $returnhash{&unescape($name)}=&thaw_unescape($value);
3739: }
3740: my $version;
3741: for ($version=1;$version<=$returnhash{'version'};$version++) {
3742: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3743: $returnhash{$item}=$returnhash{$version.':'.$item};
3744: }
3745: }
3746: return %returnhash;
3747: }
3748:
3749: # ---------------------------------------------------------- Course Description
3750:
3751: sub coursedescription {
3752: my ($courseid,$args)=@_;
3753: $courseid=~s/^\///;
3754: $courseid=~s/\_/\//g;
3755: my ($cdomain,$cnum)=split(/\//,$courseid);
3756: my $chome=&homeserver($cnum,$cdomain);
3757: my $normalid=$cdomain.'_'.$cnum;
3758: # need to always cache even if we get errors otherwise we keep
3759: # trying and trying and trying to get the course description.
3760: my %envhash=();
3761: my %returnhash=();
3762:
3763: my $expiretime=600;
3764: if ($env{'request.course.id'} eq $normalid) {
3765: $expiretime=120;
3766: }
3767:
3768: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3769: if (!$args->{'freshen_cache'}
3770: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3771: foreach my $key (keys(%env)) {
3772: next if ($key !~ /^\Q$prefix\E(.*)/);
3773: my ($setting) = $1;
3774: $returnhash{$setting} = $env{$key};
3775: }
3776: return %returnhash;
3777: }
3778:
3779: # get the data agin
3780: if (!$args->{'one_time'}) {
3781: $envhash{'course.'.$normalid.'.last_cache'}=time;
3782: }
3783:
3784: if ($chome ne 'no_host') {
3785: %returnhash=&dump('environment',$cdomain,$cnum);
3786: if (!exists($returnhash{'con_lost'})) {
3787: $returnhash{'home'}= $chome;
3788: $returnhash{'domain'} = $cdomain;
3789: $returnhash{'num'} = $cnum;
3790: if (!defined($returnhash{'type'})) {
3791: $returnhash{'type'} = 'Course';
3792: }
3793: while (my ($name,$value) = each %returnhash) {
3794: $envhash{'course.'.$normalid.'.'.$name}=$value;
3795: }
3796: $returnhash{'url'}=&clutter($returnhash{'url'});
3797: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3798: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3799: $envhash{'course.'.$normalid.'.home'}=$chome;
3800: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3801: $envhash{'course.'.$normalid.'.num'}=$cnum;
3802: }
3803: }
3804: if (!$args->{'one_time'}) {
3805: &appenv(\%envhash);
3806: }
3807: return %returnhash;
3808: }
3809:
3810: # -------------------------------------------------See if a user is privileged
3811:
3812: sub privileged {
3813: my ($username,$domain)=@_;
3814: my $rolesdump=&reply("dump:$domain:$username:roles",
3815: &homeserver($username,$domain));
3816: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3817: ($rolesdump =~ /^error:/)) {
3818: return 0;
3819: }
3820: my $now=time;
3821: if ($rolesdump ne '') {
3822: foreach my $entry (split(/&/,$rolesdump)) {
3823: if ($entry!~/^rolesdef_/) {
3824: my ($area,$role)=split(/=/,$entry);
3825: $area=~s/\_\w\w$//;
3826: my ($trole,$tend,$tstart)=split(/_/,$role);
3827: if (($trole eq 'dc') || ($trole eq 'su')) {
3828: my $active=1;
3829: if ($tend) {
3830: if ($tend<$now) { $active=0; }
3831: }
3832: if ($tstart) {
3833: if ($tstart>$now) { $active=0; }
3834: }
3835: if ($active) { return 1; }
3836: }
3837: }
3838: }
3839: }
3840: return 0;
3841: }
3842:
3843: # -------------------------------------------------------- Get user privileges
3844:
3845: sub rolesinit {
3846: my ($domain,$username,$authhost)=@_;
3847: my $now=time;
3848: my %userroles = ('user.login.time' => $now);
3849: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3850: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3851: ($rolesdump =~ /^error:/)) {
3852: return \%userroles;
3853: }
3854: my %allroles=();
3855: my %allgroups=();
3856: my $group_privs;
3857:
3858: if ($rolesdump ne '') {
3859: foreach my $entry (split(/&/,$rolesdump)) {
3860: if ($entry!~/^rolesdef_/) {
3861: my ($area,$role)=split(/=/,$entry);
3862: $area=~s/\_\w\w$//;
3863: my ($trole,$tend,$tstart,$group_privs);
3864: if ($role=~/^cr/) {
3865: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3866: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3867: ($tend,$tstart)=split('_',$trest);
3868: } else {
3869: $trole=$role;
3870: }
3871: } elsif ($role =~ m|^gr/|) {
3872: ($trole,$tend,$tstart) = split(/_/,$role);
3873: ($trole,$group_privs) = split(/\//,$trole);
3874: $group_privs = &unescape($group_privs);
3875: } else {
3876: ($trole,$tend,$tstart)=split(/_/,$role);
3877: }
3878: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3879: $username);
3880: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3881: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3882: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3883: if (($area ne '') && ($trole ne '')) {
3884: my $spec=$trole.'.'.$area;
3885: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3886: if ($trole =~ /^cr\//) {
3887: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3888: } elsif ($trole eq 'gr') {
3889: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3890: } else {
3891: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3892: }
3893: }
3894: }
3895: }
3896: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3897: $userroles{'user.adv'} = $adv;
3898: $userroles{'user.author'} = $author;
3899: $env{'user.adv'}=$adv;
3900: }
3901: return \%userroles;
3902: }
3903:
3904: sub set_arearole {
3905: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3906: # log the associated role with the area
3907: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3908: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3909: }
3910:
3911: sub custom_roleprivs {
3912: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3913: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3914: my $homsvr=homeserver($rauthor,$rdomain);
3915: if (&hostname($homsvr) ne '') {
3916: my ($rdummy,$roledef)=
3917: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3918: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3919: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3920: if (defined($syspriv)) {
3921: if ($trest =~ /^$match_community$/) {
3922: $syspriv =~ s/bre\&S//;
3923: }
3924: $$allroles{'cm./'}.=':'.$syspriv;
3925: $$allroles{$spec.'./'}.=':'.$syspriv;
3926: }
3927: if ($tdomain ne '') {
3928: if (defined($dompriv)) {
3929: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3930: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3931: }
3932: if (($trest ne '') && (defined($coursepriv))) {
3933: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3934: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3935: }
3936: }
3937: }
3938: }
3939: }
3940:
3941: sub group_roleprivs {
3942: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3943: my $access = 1;
3944: my $now = time;
3945: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3946: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3947: if ($access) {
3948: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3949: $$allgroups{$course}{$group} .=':'.$group_privs;
3950: }
3951: }
3952:
3953: sub standard_roleprivs {
3954: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3955: if (defined($pr{$trole.':s'})) {
3956: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3957: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3958: }
3959: if ($tdomain ne '') {
3960: if (defined($pr{$trole.':d'})) {
3961: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3962: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3963: }
3964: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3965: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3966: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3967: }
3968: }
3969: }
3970:
3971: sub set_userprivs {
3972: my ($userroles,$allroles,$allgroups) = @_;
3973: my $author=0;
3974: my $adv=0;
3975: my %grouproles = ();
3976: if (keys(%{$allgroups}) > 0) {
3977: foreach my $role (keys(%{$allroles})) {
3978: my ($trole,$area,$sec,$extendedarea);
3979: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3980: $trole = $1;
3981: $area = $2;
3982: $sec = $3;
3983: $extendedarea = $area.$sec;
3984: if (exists($$allgroups{$area})) {
3985: foreach my $group (keys(%{$$allgroups{$area}})) {
3986: my $spec = $trole.'.'.$extendedarea;
3987: $grouproles{$spec.'.'.$area.'/'.$group} =
3988: $$allgroups{$area}{$group};
3989: }
3990: }
3991: }
3992: }
3993: }
3994: foreach my $group (keys(%grouproles)) {
3995: $$allroles{$group} = $grouproles{$group};
3996: }
3997: foreach my $role (keys(%{$allroles})) {
3998: my %thesepriv;
3999: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4000: foreach my $item (split(/:/,$$allroles{$role})) {
4001: if ($item ne '') {
4002: my ($privilege,$restrictions)=split(/&/,$item);
4003: if ($restrictions eq '') {
4004: $thesepriv{$privilege}='F';
4005: } elsif ($thesepriv{$privilege} ne 'F') {
4006: $thesepriv{$privilege}.=$restrictions;
4007: }
4008: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4009: }
4010: }
4011: my $thesestr='';
4012: foreach my $priv (keys(%thesepriv)) {
4013: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4014: }
4015: $userroles->{'user.priv.'.$role} = $thesestr;
4016: }
4017: return ($author,$adv);
4018: }
4019:
4020: sub role_status {
4021: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4022: my @pwhere = ();
4023: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4024: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4025: unless (!defined($$role) || $$role eq '') {
4026: $$where=join('.',@pwhere);
4027: $$trolecode=$$role.'.'.$$where;
4028: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4029: $$tstatus='is';
4030: if ($$tstart && $$tstart>$then) {
4031: $$tstatus='future';
4032: if ($$tstart<$now) {
4033: if ($$tstart && $$tstart>$refresh) {
4034: if (($$where ne '') && ($$role ne '')) {
4035: my (%allroles,%allgroups,$group_privs);
4036: my %userroles = (
4037: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4038: );
4039: my $spec=$$role.'.'.$$where;
4040: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4041: if ($$role =~ /^cr\//) {
4042: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4043: } elsif ($$role eq 'gr') {
4044: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4045: $env{'user.name'});
4046: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4047: (undef,my $group_privs) = split(/\//,$trole);
4048: $group_privs = &unescape($group_privs);
4049: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4050: } else {
4051: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4052: }
4053: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4054: &appenv(\%userroles,[$$role,'cm']);
4055: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4056: }
4057: }
4058: $$tstatus = 'is';
4059: }
4060: }
4061: if ($$tend) {
4062: if ($$tend<$then) {
4063: $$tstatus='expired';
4064: } elsif ($$tend<$now) {
4065: $$tstatus='will_not';
4066: }
4067: }
4068: }
4069: }
4070: }
4071:
4072: sub check_adhoc_privs {
4073: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
4074: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4075: if ($env{$cckey}) {
4076: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4077: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4078: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4079: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4080: }
4081: } else {
4082: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4083: }
4084: }
4085:
4086: sub set_adhoc_privileges {
4087: # role can be cc or ca
4088: my ($dcdom,$pickedcourse,$role) = @_;
4089: my $area = '/'.$dcdom.'/'.$pickedcourse;
4090: my $spec = $role.'.'.$area;
4091: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4092: $env{'user.name'});
4093: my %ccrole = ();
4094: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4095: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4096: &appenv(\%userroles,[$role,'cm']);
4097: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4098: &appenv( {'request.role' => $spec,
4099: 'request.role.domain' => $dcdom,
4100: 'request.course.sec' => ''
4101: }
4102: );
4103: my $tadv=0;
4104: if (&allowed('adv') eq 'F') { $tadv=1; }
4105: &appenv({'request.role.adv' => $tadv});
4106: }
4107:
4108: # --------------------------------------------------------------- get interface
4109:
4110: sub get {
4111: my ($namespace,$storearr,$udomain,$uname)=@_;
4112: my $items='';
4113: foreach my $item (@$storearr) {
4114: $items.=&escape($item).'&';
4115: }
4116: $items=~s/\&$//;
4117: if (!$udomain) { $udomain=$env{'user.domain'}; }
4118: if (!$uname) { $uname=$env{'user.name'}; }
4119: my $uhome=&homeserver($uname,$udomain);
4120:
4121: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4122: my @pairs=split(/\&/,$rep);
4123: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4124: return @pairs;
4125: }
4126: my %returnhash=();
4127: my $i=0;
4128: foreach my $item (@$storearr) {
4129: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4130: $i++;
4131: }
4132: return %returnhash;
4133: }
4134:
4135: # --------------------------------------------------------------- del interface
4136:
4137: sub del {
4138: my ($namespace,$storearr,$udomain,$uname)=@_;
4139: my $items='';
4140: foreach my $item (@$storearr) {
4141: $items.=&escape($item).'&';
4142: }
4143:
4144: $items=~s/\&$//;
4145: if (!$udomain) { $udomain=$env{'user.domain'}; }
4146: if (!$uname) { $uname=$env{'user.name'}; }
4147: my $uhome=&homeserver($uname,$udomain);
4148: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4149: }
4150:
4151: # -------------------------------------------------------------- dump interface
4152:
4153: sub dump {
4154: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4155: if (!$udomain) { $udomain=$env{'user.domain'}; }
4156: if (!$uname) { $uname=$env{'user.name'}; }
4157: my $uhome=&homeserver($uname,$udomain);
4158: if ($regexp) {
4159: $regexp=&escape($regexp);
4160: } else {
4161: $regexp='.';
4162: }
4163: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4164: my @pairs=split(/\&/,$rep);
4165: my %returnhash=();
4166: foreach my $item (@pairs) {
4167: my ($key,$value)=split(/=/,$item,2);
4168: $key = &unescape($key);
4169: next if ($key =~ /^error: 2 /);
4170: $returnhash{$key}=&thaw_unescape($value);
4171: }
4172: return %returnhash;
4173: }
4174:
4175: # --------------------------------------------------------- dumpstore interface
4176:
4177: sub dumpstore {
4178: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4179: if (!$udomain) { $udomain=$env{'user.domain'}; }
4180: if (!$uname) { $uname=$env{'user.name'}; }
4181: my $uhome=&homeserver($uname,$udomain);
4182: if ($regexp) {
4183: $regexp=&escape($regexp);
4184: } else {
4185: $regexp='.';
4186: }
4187: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4188: my @pairs=split(/\&/,$rep);
4189: my %returnhash=();
4190: foreach my $item (@pairs) {
4191: my ($key,$value)=split(/=/,$item,2);
4192: next if ($key =~ /^error: 2 /);
4193: $returnhash{$key}=&thaw_unescape($value);
4194: }
4195: return %returnhash;
4196: }
4197:
4198: # -------------------------------------------------------------- keys interface
4199:
4200: sub getkeys {
4201: my ($namespace,$udomain,$uname)=@_;
4202: if (!$udomain) { $udomain=$env{'user.domain'}; }
4203: if (!$uname) { $uname=$env{'user.name'}; }
4204: my $uhome=&homeserver($uname,$udomain);
4205: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4206: my @keyarray=();
4207: foreach my $key (split(/\&/,$rep)) {
4208: next if ($key =~ /^error: 2 /);
4209: push(@keyarray,&unescape($key));
4210: }
4211: return @keyarray;
4212: }
4213:
4214: # --------------------------------------------------------------- currentdump
4215: sub currentdump {
4216: my ($courseid,$sdom,$sname)=@_;
4217: $courseid = $env{'request.course.id'} if (! defined($courseid));
4218: $sdom = $env{'user.domain'} if (! defined($sdom));
4219: $sname = $env{'user.name'} if (! defined($sname));
4220: my $uhome = &homeserver($sname,$sdom);
4221: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4222: return if ($rep =~ /^(error:|no_such_host)/);
4223: #
4224: my %returnhash=();
4225: #
4226: if ($rep eq "unknown_cmd") {
4227: # an old lond will not know currentdump
4228: # Do a dump and make it look like a currentdump
4229: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4230: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4231: my %hash = @tmp;
4232: @tmp=();
4233: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4234: } else {
4235: my @pairs=split(/\&/,$rep);
4236: foreach my $pair (@pairs) {
4237: my ($key,$value)=split(/=/,$pair,2);
4238: my ($symb,$param) = split(/:/,$key);
4239: $returnhash{&unescape($symb)}->{&unescape($param)} =
4240: &thaw_unescape($value);
4241: }
4242: }
4243: return %returnhash;
4244: }
4245:
4246: sub convert_dump_to_currentdump{
4247: my %hash = %{shift()};
4248: my %returnhash;
4249: # Code ripped from lond, essentially. The only difference
4250: # here is the unescaping done by lonnet::dump(). Conceivably
4251: # we might run in to problems with parameter names =~ /^v\./
4252: while (my ($key,$value) = each(%hash)) {
4253: my ($v,$symb,$param) = split(/:/,$key);
4254: $symb = &unescape($symb);
4255: $param = &unescape($param);
4256: next if ($v eq 'version' || $symb eq 'keys');
4257: next if (exists($returnhash{$symb}) &&
4258: exists($returnhash{$symb}->{$param}) &&
4259: $returnhash{$symb}->{'v.'.$param} > $v);
4260: $returnhash{$symb}->{$param}=$value;
4261: $returnhash{$symb}->{'v.'.$param}=$v;
4262: }
4263: #
4264: # Remove all of the keys in the hashes which keep track of
4265: # the version of the parameter.
4266: while (my ($symb,$param_hash) = each(%returnhash)) {
4267: # use a foreach because we are going to delete from the hash.
4268: foreach my $key (keys(%$param_hash)) {
4269: delete($param_hash->{$key}) if ($key =~ /^v\./);
4270: }
4271: }
4272: return \%returnhash;
4273: }
4274:
4275: # ------------------------------------------------------ critical inc interface
4276:
4277: sub cinc {
4278: return &inc(@_,'critical');
4279: }
4280:
4281: # --------------------------------------------------------------- inc interface
4282:
4283: sub inc {
4284: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4285: if (!$udomain) { $udomain=$env{'user.domain'}; }
4286: if (!$uname) { $uname=$env{'user.name'}; }
4287: my $uhome=&homeserver($uname,$udomain);
4288: my $items='';
4289: if (! ref($store)) {
4290: # got a single value, so use that instead
4291: $items = &escape($store).'=&';
4292: } elsif (ref($store) eq 'SCALAR') {
4293: $items = &escape($$store).'=&';
4294: } elsif (ref($store) eq 'ARRAY') {
4295: $items = join('=&',map {&escape($_);} @{$store});
4296: } elsif (ref($store) eq 'HASH') {
4297: while (my($key,$value) = each(%{$store})) {
4298: $items.= &escape($key).'='.&escape($value).'&';
4299: }
4300: }
4301: $items=~s/\&$//;
4302: if ($critical) {
4303: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4304: } else {
4305: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4306: }
4307: }
4308:
4309: # --------------------------------------------------------------- put interface
4310:
4311: sub put {
4312: my ($namespace,$storehash,$udomain,$uname)=@_;
4313: if (!$udomain) { $udomain=$env{'user.domain'}; }
4314: if (!$uname) { $uname=$env{'user.name'}; }
4315: my $uhome=&homeserver($uname,$udomain);
4316: my $items='';
4317: foreach my $item (keys(%$storehash)) {
4318: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4319: }
4320: $items=~s/\&$//;
4321: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4322: }
4323:
4324: # ------------------------------------------------------------ newput interface
4325:
4326: sub newput {
4327: my ($namespace,$storehash,$udomain,$uname)=@_;
4328: if (!$udomain) { $udomain=$env{'user.domain'}; }
4329: if (!$uname) { $uname=$env{'user.name'}; }
4330: my $uhome=&homeserver($uname,$udomain);
4331: my $items='';
4332: foreach my $key (keys(%$storehash)) {
4333: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4334: }
4335: $items=~s/\&$//;
4336: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4337: }
4338:
4339: # --------------------------------------------------------- putstore interface
4340:
4341: sub putstore {
4342: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4343: if (!$udomain) { $udomain=$env{'user.domain'}; }
4344: if (!$uname) { $uname=$env{'user.name'}; }
4345: my $uhome=&homeserver($uname,$udomain);
4346: my $items='';
4347: foreach my $key (keys(%$storehash)) {
4348: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4349: }
4350: $items=~s/\&$//;
4351: my $esc_symb=&escape($symb);
4352: my $esc_v=&escape($version);
4353: my $reply =
4354: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4355: $uhome);
4356: if ($reply eq 'unknown_cmd') {
4357: # gfall back to way things use to be done
4358: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4359: $uname);
4360: }
4361: return $reply;
4362: }
4363:
4364: sub old_putstore {
4365: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4366: if (!$udomain) { $udomain=$env{'user.domain'}; }
4367: if (!$uname) { $uname=$env{'user.name'}; }
4368: my $uhome=&homeserver($uname,$udomain);
4369: my %newstorehash;
4370: foreach my $item (keys(%$storehash)) {
4371: my $key = $version.':'.&escape($symb).':'.$item;
4372: $newstorehash{$key} = $storehash->{$item};
4373: }
4374: my $items='';
4375: my %allitems = ();
4376: foreach my $item (keys(%newstorehash)) {
4377: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4378: my $key = $1.':keys:'.$2;
4379: $allitems{$key} .= $3.':';
4380: }
4381: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4382: }
4383: foreach my $item (keys(%allitems)) {
4384: $allitems{$item} =~ s/\:$//;
4385: $items.= $item.'='.$allitems{$item}.'&';
4386: }
4387: $items=~s/\&$//;
4388: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4389: }
4390:
4391: # ------------------------------------------------------ critical put interface
4392:
4393: sub cput {
4394: my ($namespace,$storehash,$udomain,$uname)=@_;
4395: if (!$udomain) { $udomain=$env{'user.domain'}; }
4396: if (!$uname) { $uname=$env{'user.name'}; }
4397: my $uhome=&homeserver($uname,$udomain);
4398: my $items='';
4399: foreach my $item (keys(%$storehash)) {
4400: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4401: }
4402: $items=~s/\&$//;
4403: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4404: }
4405:
4406: # -------------------------------------------------------------- eget interface
4407:
4408: sub eget {
4409: my ($namespace,$storearr,$udomain,$uname)=@_;
4410: my $items='';
4411: foreach my $item (@$storearr) {
4412: $items.=&escape($item).'&';
4413: }
4414: $items=~s/\&$//;
4415: if (!$udomain) { $udomain=$env{'user.domain'}; }
4416: if (!$uname) { $uname=$env{'user.name'}; }
4417: my $uhome=&homeserver($uname,$udomain);
4418: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4419: my @pairs=split(/\&/,$rep);
4420: my %returnhash=();
4421: my $i=0;
4422: foreach my $item (@$storearr) {
4423: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4424: $i++;
4425: }
4426: return %returnhash;
4427: }
4428:
4429: # ------------------------------------------------------------ tmpput interface
4430: sub tmpput {
4431: my ($storehash,$server,$context)=@_;
4432: my $items='';
4433: foreach my $item (keys(%$storehash)) {
4434: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4435: }
4436: $items=~s/\&$//;
4437: if (defined($context)) {
4438: $items .= ':'.&escape($context);
4439: }
4440: return &reply("tmpput:$items",$server);
4441: }
4442:
4443: # ------------------------------------------------------------ tmpget interface
4444: sub tmpget {
4445: my ($token,$server)=@_;
4446: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4447: my $rep=&reply("tmpget:$token",$server);
4448: my %returnhash;
4449: foreach my $item (split(/\&/,$rep)) {
4450: my ($key,$value)=split(/=/,$item);
4451: next if ($key =~ /^error: 2 /);
4452: $returnhash{&unescape($key)}=&thaw_unescape($value);
4453: }
4454: return %returnhash;
4455: }
4456:
4457: # ------------------------------------------------------------ tmpget interface
4458: sub tmpdel {
4459: my ($token,$server)=@_;
4460: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4461: return &reply("tmpdel:$token",$server);
4462: }
4463:
4464: # -------------------------------------------------- portfolio access checking
4465:
4466: sub portfolio_access {
4467: my ($requrl) = @_;
4468: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4469: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4470: if ($result) {
4471: my %setters;
4472: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4473: my ($startblock,$endblock) =
4474: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4475: if ($startblock && $endblock) {
4476: return 'B';
4477: }
4478: } else {
4479: my ($startblock,$endblock) =
4480: &Apache::loncommon::blockcheck(\%setters,'port');
4481: if ($startblock && $endblock) {
4482: return 'B';
4483: }
4484: }
4485: }
4486: if ($result eq 'ok') {
4487: return 'F';
4488: } elsif ($result =~ /^[^:]+:guest_/) {
4489: return 'A';
4490: }
4491: return '';
4492: }
4493:
4494: sub get_portfolio_access {
4495: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4496:
4497: if (!ref($access_hash)) {
4498: my $current_perms = &get_portfile_permissions($udom,$unum);
4499: my %access_controls = &get_access_controls($current_perms,$group,
4500: $file_name);
4501: $access_hash = $access_controls{$file_name};
4502: }
4503:
4504: my ($public,$guest,@domains,@users,@courses,@groups);
4505: my $now = time;
4506: if (ref($access_hash) eq 'HASH') {
4507: foreach my $key (keys(%{$access_hash})) {
4508: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4509: if ($start > $now) {
4510: next;
4511: }
4512: if ($end && $end<$now) {
4513: next;
4514: }
4515: if ($scope eq 'public') {
4516: $public = $key;
4517: last;
4518: } elsif ($scope eq 'guest') {
4519: $guest = $key;
4520: } elsif ($scope eq 'domains') {
4521: push(@domains,$key);
4522: } elsif ($scope eq 'users') {
4523: push(@users,$key);
4524: } elsif ($scope eq 'course') {
4525: push(@courses,$key);
4526: } elsif ($scope eq 'group') {
4527: push(@groups,$key);
4528: }
4529: }
4530: if ($public) {
4531: return 'ok';
4532: }
4533: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4534: if ($guest) {
4535: return $guest;
4536: }
4537: } else {
4538: if (@domains > 0) {
4539: foreach my $domkey (@domains) {
4540: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4541: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4542: return 'ok';
4543: }
4544: }
4545: }
4546: }
4547: if (@users > 0) {
4548: foreach my $userkey (@users) {
4549: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4550: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4551: if (ref($item) eq 'HASH') {
4552: if (($item->{'uname'} eq $env{'user.name'}) &&
4553: ($item->{'udom'} eq $env{'user.domain'})) {
4554: return 'ok';
4555: }
4556: }
4557: }
4558: }
4559: }
4560: }
4561: my %roleshash;
4562: my @courses_and_groups = @courses;
4563: push(@courses_and_groups,@groups);
4564: if (@courses_and_groups > 0) {
4565: my (%allgroups,%allroles);
4566: my ($start,$end,$role,$sec,$group);
4567: foreach my $envkey (%env) {
4568: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4569: my $cid = $2.'_'.$3;
4570: if ($1 eq 'gr') {
4571: $group = $4;
4572: $allgroups{$cid}{$group} = $env{$envkey};
4573: } else {
4574: if ($4 eq '') {
4575: $sec = 'none';
4576: } else {
4577: $sec = $4;
4578: }
4579: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4580: }
4581: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4582: my $cid = $2.'_'.$3;
4583: if ($4 eq '') {
4584: $sec = 'none';
4585: } else {
4586: $sec = $4;
4587: }
4588: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4589: }
4590: }
4591: if (keys(%allroles) == 0) {
4592: return;
4593: }
4594: foreach my $key (@courses_and_groups) {
4595: my %content = %{$$access_hash{$key}};
4596: my $cnum = $content{'number'};
4597: my $cdom = $content{'domain'};
4598: my $cid = $cdom.'_'.$cnum;
4599: if (!exists($allroles{$cid})) {
4600: next;
4601: }
4602: foreach my $role_id (keys(%{$content{'roles'}})) {
4603: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4604: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4605: my @status = @{$content{'roles'}{$role_id}{'access'}};
4606: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4607: foreach my $role (keys(%{$allroles{$cid}})) {
4608: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4609: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4610: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4611: if (grep/^all$/,@sections) {
4612: return 'ok';
4613: } else {
4614: if (grep/^$sec$/,@sections) {
4615: return 'ok';
4616: }
4617: }
4618: }
4619: }
4620: if (keys(%{$allgroups{$cid}}) == 0) {
4621: if (grep/^none$/,@groups) {
4622: return 'ok';
4623: }
4624: } else {
4625: if (grep/^all$/,@groups) {
4626: return 'ok';
4627: }
4628: foreach my $group (keys(%{$allgroups{$cid}})) {
4629: if (grep/^$group$/,@groups) {
4630: return 'ok';
4631: }
4632: }
4633: }
4634: }
4635: }
4636: }
4637: }
4638: }
4639: if ($guest) {
4640: return $guest;
4641: }
4642: }
4643: }
4644: return;
4645: }
4646:
4647: sub course_group_datechecker {
4648: my ($dates,$now,$status) = @_;
4649: my ($start,$end) = split(/\./,$dates);
4650: if (!$start && !$end) {
4651: return 'ok';
4652: }
4653: if (grep/^active$/,@{$status}) {
4654: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4655: return 'ok';
4656: }
4657: }
4658: if (grep/^previous$/,@{$status}) {
4659: if ($end > $now ) {
4660: return 'ok';
4661: }
4662: }
4663: if (grep/^future$/,@{$status}) {
4664: if ($start > $now) {
4665: return 'ok';
4666: }
4667: }
4668: return;
4669: }
4670:
4671: sub parse_portfolio_url {
4672: my ($url) = @_;
4673:
4674: my ($type,$udom,$unum,$group,$file_name);
4675:
4676: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4677: $type = 1;
4678: $udom = $1;
4679: $unum = $2;
4680: $file_name = $3;
4681: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4682: $type = 2;
4683: $udom = $1;
4684: $unum = $2;
4685: $group = $3;
4686: $file_name = $3.'/'.$4;
4687: }
4688: if (wantarray) {
4689: return ($type,$udom,$unum,$file_name,$group);
4690: }
4691: return $type;
4692: }
4693:
4694: sub is_portfolio_url {
4695: my ($url) = @_;
4696: return scalar(&parse_portfolio_url($url));
4697: }
4698:
4699: sub is_portfolio_file {
4700: my ($file) = @_;
4701: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4702: return 1;
4703: }
4704: return;
4705: }
4706:
4707: sub usertools_access {
4708: my ($uname,$udom,$tool,$action,$context) = @_;
4709: my ($access,%tools);
4710: if ($context eq '') {
4711: $context = 'tools';
4712: }
4713: if ($context eq 'requestcourses') {
4714: %tools = (
4715: official => 1,
4716: unofficial => 1,
4717: community => 1,
4718: );
4719: } else {
4720: %tools = (
4721: aboutme => 1,
4722: blog => 1,
4723: portfolio => 1,
4724: );
4725: }
4726: return if (!defined($tools{$tool}));
4727:
4728: if ((!defined($udom)) || (!defined($uname))) {
4729: $udom = $env{'user.domain'};
4730: $uname = $env{'user.name'};
4731: }
4732:
4733: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4734: if ($action ne 'reload') {
4735: if ($context eq 'requestcourses') {
4736: return $env{'environment.canrequest.'.$tool};
4737: } else {
4738: return $env{'environment.availabletools.'.$tool};
4739: }
4740: }
4741: }
4742:
4743: my ($toolstatus,$inststatus);
4744:
4745: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4746: ($action ne 'reload')) {
4747: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4748: $inststatus = $env{'environment.inststatus'};
4749: } else {
4750: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
4751: $toolstatus = $userenv{$context.'.'.$tool};
4752: $inststatus = $userenv{'inststatus'};
4753: }
4754:
4755: if ($toolstatus ne '') {
4756: if ($toolstatus) {
4757: $access = 1;
4758: } else {
4759: $access = 0;
4760: }
4761: return $access;
4762: }
4763:
4764: my $is_adv = &is_advanced_user($udom,$uname);
4765: my %domdef = &get_domain_defaults($udom);
4766: if (ref($domdef{$tool}) eq 'HASH') {
4767: if ($is_adv) {
4768: if ($domdef{$tool}{'_LC_adv'} ne '') {
4769: if ($domdef{$tool}{'_LC_adv'}) {
4770: $access = 1;
4771: } else {
4772: $access = 0;
4773: }
4774: return $access;
4775: }
4776: }
4777: if ($inststatus ne '') {
4778: my ($hasaccess,$hasnoaccess);
4779: foreach my $affiliation (split(/:/,$inststatus)) {
4780: if ($domdef{$tool}{$affiliation} ne '') {
4781: if ($domdef{$tool}{$affiliation}) {
4782: $hasaccess = 1;
4783: } else {
4784: $hasnoaccess = 1;
4785: }
4786: }
4787: }
4788: if ($hasaccess || $hasnoaccess) {
4789: if ($hasaccess) {
4790: $access = 1;
4791: } elsif ($hasnoaccess) {
4792: $access = 0;
4793: }
4794: return $access;
4795: }
4796: } else {
4797: if ($domdef{$tool}{'default'} ne '') {
4798: if ($domdef{$tool}{'default'}) {
4799: $access = 1;
4800: } elsif ($domdef{$tool}{'default'} == 0) {
4801: $access = 0;
4802: }
4803: return $access;
4804: }
4805: }
4806: } else {
4807: if ($context eq 'tools') {
4808: $access = 1;
4809: } else {
4810: $access = 0;
4811: }
4812: return $access;
4813: }
4814: }
4815:
4816: sub is_advanced_user {
4817: my ($udom,$uname) = @_;
4818: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4819: my %allroles;
4820: my $is_adv;
4821: foreach my $role (keys(%roleshash)) {
4822: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4823: my $area = '/'.$tdomain.'/'.$trest;
4824: if ($sec ne '') {
4825: $area .= '/'.$sec;
4826: }
4827: if (($area ne '') && ($trole ne '')) {
4828: my $spec=$trole.'.'.$area;
4829: if ($trole =~ /^cr\//) {
4830: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4831: } elsif ($trole ne 'gr') {
4832: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4833: }
4834: }
4835: }
4836: foreach my $role (keys(%allroles)) {
4837: last if ($is_adv);
4838: foreach my $item (split(/:/,$allroles{$role})) {
4839: if ($item ne '') {
4840: my ($privilege,$restrictions)=split(/&/,$item);
4841: if ($privilege eq 'adv') {
4842: $is_adv = 1;
4843: last;
4844: }
4845: }
4846: }
4847: }
4848: return $is_adv;
4849: }
4850:
4851: sub check_can_request {
4852: my ($dom,$can_request,$request_domains) = @_;
4853: my $canreq = 0;
4854: my ($types,$typename) = &Apache::loncommon::course_types();
4855: my @options = ('approval','validate','autolimit');
4856: my $optregex = join('|',@options);
4857: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4858: foreach my $type (@{$types}) {
4859: if (&usertools_access($env{'user.name'},
4860: $env{'user.domain'},
4861: $type,undef,'requestcourses')) {
4862: $canreq ++;
4863: if (ref($request_domains) eq 'HASH') {
4864: push(@{$request_domains->{$type}},$env{'user.domain'});
4865: }
4866: if ($dom eq $env{'user.domain'}) {
4867: $can_request->{$type} = 1;
4868: }
4869: }
4870: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4871: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4872: if (@curr > 0) {
4873: foreach my $item (@curr) {
4874: if (ref($request_domains) eq 'HASH') {
4875: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4876: if ($otherdom ne '') {
4877: if (ref($request_domains->{$type}) eq 'ARRAY') {
4878: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4879: push(@{$request_domains->{$type}},$otherdom);
4880: }
4881: } else {
4882: push(@{$request_domains->{$type}},$otherdom);
4883: }
4884: }
4885: }
4886: }
4887: unless($dom eq $env{'user.domain'}) {
4888: $canreq ++;
4889: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4890: $can_request->{$type} = 1;
4891: }
4892: }
4893: }
4894: }
4895: }
4896: }
4897: return $canreq;
4898: }
4899:
4900: # ---------------------------------------------- Custom access rule evaluation
4901:
4902: sub customaccess {
4903: my ($priv,$uri)=@_;
4904: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4905: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4906: $udom = &LONCAPA::clean_domain($udom);
4907: $ucrs = &LONCAPA::clean_username($ucrs);
4908: my $access=0;
4909: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4910: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4911: if ($type eq 'user') {
4912: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4913: my ($tdom,$tuname)=split(m{/},$scope);
4914: if ($tdom) {
4915: if ($tdom ne $env{'user.domain'}) { next; }
4916: }
4917: if ($tuname) {
4918: if ($tuname ne $env{'user.name'}) { next; }
4919: }
4920: $access=($effect eq 'allow');
4921: last;
4922: }
4923: } else {
4924: if ($role) {
4925: if ($role ne $urole) { next; }
4926: }
4927: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4928: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4929: if ($tdom) {
4930: if ($tdom ne $udom) { next; }
4931: }
4932: if ($tcrs) {
4933: if ($tcrs ne $ucrs) { next; }
4934: }
4935: if ($tsec) {
4936: if ($tsec ne $usec) { next; }
4937: }
4938: $access=($effect eq 'allow');
4939: last;
4940: }
4941: if ($realm eq '' && $role eq '') {
4942: $access=($effect eq 'allow');
4943: }
4944: }
4945: }
4946: return $access;
4947: }
4948:
4949: # ------------------------------------------------- Check for a user privilege
4950:
4951: sub allowed {
4952: my ($priv,$uri,$symb,$role)=@_;
4953: my $ver_orguri=$uri;
4954: $uri=&deversion($uri);
4955: my $orguri=$uri;
4956: $uri=&declutter($uri);
4957:
4958: if ($priv eq 'evb') {
4959: # Evade communication block restrictions for specified role in a course
4960: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4961: return $1;
4962: } else {
4963: return;
4964: }
4965: }
4966:
4967: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4968: # Free bre access to adm and meta resources
4969: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4970: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4971: && ($priv eq 'bre')) {
4972: return 'F';
4973: }
4974:
4975: # Free bre access to user's own portfolio contents
4976: my ($space,$domain,$name,@dir)=split('/',$uri);
4977: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4978: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4979: my %setters;
4980: my ($startblock,$endblock) =
4981: &Apache::loncommon::blockcheck(\%setters,'port');
4982: if ($startblock && $endblock) {
4983: return 'B';
4984: } else {
4985: return 'F';
4986: }
4987: }
4988:
4989: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4990: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4991: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4992: if (exists($env{'request.course.id'})) {
4993: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4994: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4995: if (($domain eq $cdom) && ($name eq $cnum)) {
4996: my $courseprivid=$env{'request.course.id'};
4997: $courseprivid=~s/\_/\//;
4998: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4999: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5000: return $1;
5001: } else {
5002: if ($env{'request.course.sec'}) {
5003: $courseprivid.='/'.$env{'request.course.sec'};
5004: }
5005: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5006: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5007: return $2;
5008: }
5009: }
5010: }
5011: }
5012: }
5013:
5014: # Free bre to public access
5015:
5016: if ($priv eq 'bre') {
5017: my $copyright=&metadata($uri,'copyright');
5018: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5019: return 'F';
5020: }
5021: if ($copyright eq 'priv') {
5022: $uri=~/([^\/]+)\/([^\/]+)\//;
5023: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5024: return '';
5025: }
5026: }
5027: if ($copyright eq 'domain') {
5028: $uri=~/([^\/]+)\/([^\/]+)\//;
5029: unless (($env{'user.domain'} eq $1) ||
5030: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5031: return '';
5032: }
5033: }
5034: if ($env{'request.role'}=~ /li\.\//) {
5035: # Library role, so allow browsing of resources in this domain.
5036: return 'F';
5037: }
5038: if ($copyright eq 'custom') {
5039: unless (&customaccess($priv,$uri)) { return ''; }
5040: }
5041: }
5042: # Domain coordinator is trying to create a course
5043: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5044: # uri is the requested domain in this case.
5045: # comparison to 'request.role.domain' shows if the user has selected
5046: # a role of dc for the domain in question.
5047: return 'F' if ($uri eq $env{'request.role.domain'});
5048: }
5049:
5050: my $thisallowed='';
5051: my $statecond=0;
5052: my $courseprivid='';
5053:
5054: my $ownaccess;
5055: # Community Coordinator or Assistant Co-author browsing resource space.
5056: if (($priv eq 'bro') && ($env{'user.author'})) {
5057: if ($uri eq '') {
5058: $ownaccess = 1;
5059: } else {
5060: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5061: my $udom = $env{'user.domain'};
5062: my $uname = $env{'user.name'};
5063: if ($uri =~ m{^\Q$udom\E/?$}) {
5064: $ownaccess = 1;
5065: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5066: unless ($uri =~ m{\.\./}) {
5067: $ownaccess = 1;
5068: }
5069: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5070: my $now = time;
5071: if ($uri =~ m{^([^/]+)/?$}) {
5072: my $adom = $1;
5073: foreach my $key (keys(%env)) {
5074: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5075: my ($start,$end) = split('.',$env{$key});
5076: if (($now >= $start) && (!$end || $end < $now)) {
5077: $ownaccess = 1;
5078: last;
5079: }
5080: }
5081: }
5082: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5083: my $adom = $1;
5084: my $aname = $2;
5085: foreach my $role ('ca','aa') {
5086: if ($env{"user.role.$role./$adom/$aname"}) {
5087: my ($start,$end) =
5088: split('.',$env{"user.role.$role./$adom/$aname"});
5089: if (($now >= $start) && (!$end || $end < $now)) {
5090: $ownaccess = 1;
5091: last;
5092: }
5093: }
5094: }
5095: }
5096: }
5097: }
5098: }
5099: }
5100:
5101: # Course
5102:
5103: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5104: unless (($priv eq 'bro') && (!$ownaccess)) {
5105: $thisallowed.=$1;
5106: }
5107: }
5108:
5109: # Domain
5110:
5111: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5112: =~/\Q$priv\E\&([^\:]*)/) {
5113: unless (($priv eq 'bro') && (!$ownaccess)) {
5114: $thisallowed.=$1;
5115: }
5116: }
5117:
5118: # Course: uri itself is a course
5119: my $courseuri=$uri;
5120: $courseuri=~s/\_(\d)/\/$1/;
5121: $courseuri=~s/^([^\/])/\/$1/;
5122:
5123: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5124: =~/\Q$priv\E\&([^\:]*)/) {
5125: unless (($priv eq 'bro') && (!$ownaccess)) {
5126: $thisallowed.=$1;
5127: }
5128: }
5129:
5130: # URI is an uploaded document for this course, default permissions don't matter
5131: # not allowing 'edit' access (editupload) to uploaded course docs
5132: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5133: $thisallowed='';
5134: my ($match)=&is_on_map($uri);
5135: if ($match) {
5136: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5137: =~/\Q$priv\E\&([^\:]*)/) {
5138: $thisallowed.=$1;
5139: }
5140: } else {
5141: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5142: if ($refuri) {
5143: if ($refuri =~ m|^/adm/|) {
5144: $thisallowed='F';
5145: } else {
5146: $refuri=&declutter($refuri);
5147: my ($match) = &is_on_map($refuri);
5148: if ($match) {
5149: $thisallowed='F';
5150: }
5151: }
5152: }
5153: }
5154: }
5155:
5156: if ($priv eq 'bre'
5157: && $thisallowed ne 'F'
5158: && $thisallowed ne '2'
5159: && &is_portfolio_url($uri)) {
5160: $thisallowed = &portfolio_access($uri);
5161: }
5162:
5163: # Full access at system, domain or course-wide level? Exit.
5164: if ($thisallowed=~/F/) {
5165: return 'F';
5166: }
5167:
5168: # If this is generating or modifying users, exit with special codes
5169:
5170: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5171: if (($priv eq 'cca') || ($priv eq 'caa')) {
5172: my ($audom,$auname)=split('/',$uri);
5173: # no author name given, so this just checks on the general right to make a co-author in this domain
5174: unless ($auname) { return $thisallowed; }
5175: # an author name is given, so we are about to actually make a co-author for a certain account
5176: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5177: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5178: ($audom ne $env{'request.role.domain'}))) { return ''; }
5179: }
5180: return $thisallowed;
5181: }
5182: #
5183: # Gathered so far: system, domain and course wide privileges
5184: #
5185: # Course: See if uri or referer is an individual resource that is part of
5186: # the course
5187:
5188: if ($env{'request.course.id'}) {
5189:
5190: $courseprivid=$env{'request.course.id'};
5191: if ($env{'request.course.sec'}) {
5192: $courseprivid.='/'.$env{'request.course.sec'};
5193: }
5194: $courseprivid=~s/\_/\//;
5195: my $checkreferer=1;
5196: my ($match,$cond)=&is_on_map($uri);
5197: if ($match) {
5198: $statecond=$cond;
5199: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5200: =~/\Q$priv\E\&([^\:]*)/) {
5201: $thisallowed.=$1;
5202: $checkreferer=0;
5203: }
5204: }
5205:
5206: if ($checkreferer) {
5207: my $refuri=$env{'httpref.'.$orguri};
5208: unless ($refuri) {
5209: foreach my $key (keys(%env)) {
5210: if ($key=~/^httpref\..*\*/) {
5211: my $pattern=$key;
5212: $pattern=~s/^httpref\.\/res\///;
5213: $pattern=~s/\*/\[\^\/\]\+/g;
5214: $pattern=~s/\//\\\//g;
5215: if ($orguri=~/$pattern/) {
5216: $refuri=$env{$key};
5217: }
5218: }
5219: }
5220: }
5221:
5222: if ($refuri) {
5223: $refuri=&declutter($refuri);
5224: my ($match,$cond)=&is_on_map($refuri);
5225: if ($match) {
5226: my $refstatecond=$cond;
5227: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5228: =~/\Q$priv\E\&([^\:]*)/) {
5229: $thisallowed.=$1;
5230: $uri=$refuri;
5231: $statecond=$refstatecond;
5232: }
5233: }
5234: }
5235: }
5236: }
5237:
5238: #
5239: # Gathered now: all privileges that could apply, and condition number
5240: #
5241: #
5242: # Full or no access?
5243: #
5244:
5245: if ($thisallowed=~/F/) {
5246: return 'F';
5247: }
5248:
5249: unless ($thisallowed) {
5250: return '';
5251: }
5252:
5253: # Restrictions exist, deal with them
5254: #
5255: # C:according to course preferences
5256: # R:according to resource settings
5257: # L:unless locked
5258: # X:according to user session state
5259: #
5260:
5261: # Possibly locked functionality, check all courses
5262: # Locks might take effect only after 10 minutes cache expiration for other
5263: # courses, and 2 minutes for current course
5264:
5265: my $envkey;
5266: if ($thisallowed=~/L/) {
5267: foreach $envkey (keys(%env)) {
5268: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5269: my $courseid=$2;
5270: my $roleid=$1.'.'.$2;
5271: $courseid=~s/^\///;
5272: my $expiretime=600;
5273: if ($env{'request.role'} eq $roleid) {
5274: $expiretime=120;
5275: }
5276: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5277: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5278: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5279: &coursedescription($courseid,{'freshen_cache' => 1});
5280: }
5281: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5282: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5283: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5284: &log($env{'user.domain'},$env{'user.name'},
5285: $env{'user.home'},
5286: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5287: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5288: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5289: return '';
5290: }
5291: }
5292: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5293: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5294: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5295: &log($env{'user.domain'},$env{'user.name'},
5296: $env{'user.home'},
5297: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5298: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5299: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5300: return '';
5301: }
5302: }
5303: }
5304: }
5305: }
5306:
5307: #
5308: # Rest of the restrictions depend on selected course
5309: #
5310:
5311: unless ($env{'request.course.id'}) {
5312: if ($thisallowed eq 'A') {
5313: return 'A';
5314: } elsif ($thisallowed eq 'B') {
5315: return 'B';
5316: } else {
5317: return '1';
5318: }
5319: }
5320:
5321: #
5322: # Now user is definitely in a course
5323: #
5324:
5325:
5326: # Course preferences
5327:
5328: if ($thisallowed=~/C/) {
5329: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5330: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5331: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5332: =~/\Q$rolecode\E/) {
5333: if ($priv ne 'pch') {
5334: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5335: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5336: $env{'request.course.id'});
5337: }
5338: return '';
5339: }
5340:
5341: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5342: =~/\Q$unamedom\E/) {
5343: if ($priv ne 'pch') {
5344: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5345: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5346: $env{'request.course.id'});
5347: }
5348: return '';
5349: }
5350: }
5351:
5352: # Resource preferences
5353:
5354: if ($thisallowed=~/R/) {
5355: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5356: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5357: if ($priv ne 'pch') {
5358: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5359: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5360: }
5361: return '';
5362: }
5363: }
5364:
5365: # Restricted by state or randomout?
5366:
5367: if ($thisallowed=~/X/) {
5368: if ($env{'acc.randomout'}) {
5369: if (!$symb) { $symb=&symbread($uri,1); }
5370: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5371: return '';
5372: }
5373: }
5374: if (&condval($statecond)) {
5375: return '2';
5376: } else {
5377: return '';
5378: }
5379: }
5380:
5381: if ($thisallowed eq 'A') {
5382: return 'A';
5383: } elsif ($thisallowed eq 'B') {
5384: return 'B';
5385: }
5386: return 'F';
5387: }
5388:
5389: sub split_uri_for_cond {
5390: my $uri=&deversion(&declutter(shift));
5391: my @uriparts=split(/\//,$uri);
5392: my $filename=pop(@uriparts);
5393: my $pathname=join('/',@uriparts);
5394: return ($pathname,$filename);
5395: }
5396: # --------------------------------------------------- Is a resource on the map?
5397:
5398: sub is_on_map {
5399: my ($pathname,$filename) = &split_uri_for_cond(shift);
5400: #Trying to find the conditional for the file
5401: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5402: /\&\Q$filename\E\:([\d\|]+)\&/);
5403: if ($match) {
5404: return (1,$1);
5405: } else {
5406: return (0,0);
5407: }
5408: }
5409:
5410: # --------------------------------------------------------- Get symb from alias
5411:
5412: sub get_symb_from_alias {
5413: my $symb=shift;
5414: my ($map,$resid,$url)=&decode_symb($symb);
5415: # Already is a symb
5416: if ($url) { return $symb; }
5417: # Must be an alias
5418: my $aliassymb='';
5419: my %bighash;
5420: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5421: &GDBM_READER(),0640)) {
5422: my $rid=$bighash{'mapalias_'.$symb};
5423: if ($rid) {
5424: my ($mapid,$resid)=split(/\./,$rid);
5425: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5426: $resid,$bighash{'src_'.$rid});
5427: }
5428: untie %bighash;
5429: }
5430: return $aliassymb;
5431: }
5432:
5433: # ----------------------------------------------------------------- Define Role
5434:
5435: sub definerole {
5436: if (allowed('mcr','/')) {
5437: my ($rolename,$sysrole,$domrole,$courole)=@_;
5438: foreach my $role (split(':',$sysrole)) {
5439: my ($crole,$cqual)=split(/\&/,$role);
5440: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5441: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5442: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5443: return "refused:s:$crole&$cqual";
5444: }
5445: }
5446: }
5447: foreach my $role (split(':',$domrole)) {
5448: my ($crole,$cqual)=split(/\&/,$role);
5449: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5450: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5451: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5452: return "refused:d:$crole&$cqual";
5453: }
5454: }
5455: }
5456: foreach my $role (split(':',$courole)) {
5457: my ($crole,$cqual)=split(/\&/,$role);
5458: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5459: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5460: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5461: return "refused:c:$crole&$cqual";
5462: }
5463: }
5464: }
5465: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5466: "$env{'user.domain'}:$env{'user.name'}:".
5467: "rolesdef_$rolename=".
5468: escape($sysrole.'_'.$domrole.'_'.$courole);
5469: return reply($command,$env{'user.home'});
5470: } else {
5471: return 'refused';
5472: }
5473: }
5474:
5475: # ---------------- Make a metadata query against the network of library servers
5476:
5477: sub metadata_query {
5478: my ($query,$custom,$customshow,$server_array)=@_;
5479: my %rhash;
5480: my %libserv = &all_library();
5481: my @server_list = (defined($server_array) ? @$server_array
5482: : keys(%libserv) );
5483: for my $server (@server_list) {
5484: unless ($custom or $customshow) {
5485: my $reply=&reply("querysend:".&escape($query),$server);
5486: $rhash{$server}=$reply;
5487: }
5488: else {
5489: my $reply=&reply("querysend:".&escape($query).':'.
5490: &escape($custom).':'.&escape($customshow),
5491: $server);
5492: $rhash{$server}=$reply;
5493: }
5494: }
5495: return \%rhash;
5496: }
5497:
5498: # ----------------------------------------- Send log queries and wait for reply
5499:
5500: sub log_query {
5501: my ($uname,$udom,$query,%filters)=@_;
5502: my $uhome=&homeserver($uname,$udom);
5503: if ($uhome eq 'no_host') { return 'error: no_host'; }
5504: my $uhost=&hostname($uhome);
5505: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5506: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5507: $uhome);
5508: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5509: return get_query_reply($queryid);
5510: }
5511:
5512: # -------------------------- Update MySQL table for portfolio file
5513:
5514: sub update_portfolio_table {
5515: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5516: if ($group ne '') {
5517: $file_name =~s /^\Q$group\E//;
5518: }
5519: my $homeserver = &homeserver($uname,$udom);
5520: my $queryid=
5521: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5522: ':'.&escape($file_name).':'.$action,$homeserver);
5523: my $reply = &get_query_reply($queryid);
5524: return $reply;
5525: }
5526:
5527: # -------------------------- Update MySQL allusers table
5528:
5529: sub update_allusers_table {
5530: my ($uname,$udom,$names) = @_;
5531: my $homeserver = &homeserver($uname,$udom);
5532: my $queryid=
5533: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5534: 'lastname='.&escape($names->{'lastname'}).'%%'.
5535: 'firstname='.&escape($names->{'firstname'}).'%%'.
5536: 'middlename='.&escape($names->{'middlename'}).'%%'.
5537: 'generation='.&escape($names->{'generation'}).'%%'.
5538: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5539: 'id='.&escape($names->{'id'}),$homeserver);
5540: my $reply = &get_query_reply($queryid);
5541: return $reply;
5542: }
5543:
5544: # ------- Request retrieval of institutional classlists for course(s)
5545:
5546: sub fetch_enrollment_query {
5547: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5548: my $homeserver;
5549: my $maxtries = 1;
5550: if ($context eq 'automated') {
5551: $homeserver = $perlvar{'lonHostID'};
5552: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5553: } else {
5554: $homeserver = &homeserver($cnum,$dom);
5555: }
5556: my $host=&hostname($homeserver);
5557: my $cmd = '';
5558: foreach my $affiliate (keys(%{$affiliatesref})) {
5559: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5560: }
5561: $cmd =~ s/%%$//;
5562: $cmd = &escape($cmd);
5563: my $query = 'fetchenrollment';
5564: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5565: unless ($queryid=~/^\Q$host\E\_/) {
5566: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5567: return 'error: '.$queryid;
5568: }
5569: my $reply = &get_query_reply($queryid);
5570: my $tries = 1;
5571: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5572: $reply = &get_query_reply($queryid);
5573: $tries ++;
5574: }
5575: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5576: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5577: } else {
5578: my @responses = split(/:/,$reply);
5579: if ($homeserver eq $perlvar{'lonHostID'}) {
5580: foreach my $line (@responses) {
5581: my ($key,$value) = split(/=/,$line,2);
5582: $$replyref{$key} = $value;
5583: }
5584: } else {
5585: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5586: foreach my $line (@responses) {
5587: my ($key,$value) = split(/=/,$line);
5588: $$replyref{$key} = $value;
5589: if ($value > 0) {
5590: foreach my $item (@{$$affiliatesref{$key}}) {
5591: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5592: my $destname = $pathname.'/'.$filename;
5593: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5594: if ($xml_classlist =~ /^error/) {
5595: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5596: } else {
5597: if ( open(FILE,">$destname") ) {
5598: print FILE &unescape($xml_classlist);
5599: close(FILE);
5600: } else {
5601: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5602: }
5603: }
5604: }
5605: }
5606: }
5607: }
5608: return 'ok';
5609: }
5610: return 'error';
5611: }
5612:
5613: sub get_query_reply {
5614: my $queryid=shift;
5615: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5616: my $reply='';
5617: for (1..100) {
5618: sleep 2;
5619: if (-e $replyfile.'.end') {
5620: if (open(my $fh,$replyfile)) {
5621: $reply = join('',<$fh>);
5622: close($fh);
5623: } else { return 'error: reply_file_error'; }
5624: return &unescape($reply);
5625: }
5626: }
5627: return 'timeout:'.$queryid;
5628: }
5629:
5630: sub courselog_query {
5631: #
5632: # possible filters:
5633: # url: url or symb
5634: # username
5635: # domain
5636: # action: view, submit, grade
5637: # start: timestamp
5638: # end: timestamp
5639: #
5640: my (%filters)=@_;
5641: unless ($env{'request.course.id'}) { return 'no_course'; }
5642: if ($filters{'url'}) {
5643: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5644: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5645: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5646: }
5647: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5648: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5649: return &log_query($cname,$cdom,'courselog',%filters);
5650: }
5651:
5652: sub userlog_query {
5653: #
5654: # possible filters:
5655: # action: log check role
5656: # start: timestamp
5657: # end: timestamp
5658: #
5659: my ($uname,$udom,%filters)=@_;
5660: return &log_query($uname,$udom,'userlog',%filters);
5661: }
5662:
5663: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5664:
5665: sub auto_run {
5666: my ($cnum,$cdom) = @_;
5667: my $response = 0;
5668: my $settings;
5669: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5670: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5671: $settings = $domconfig{'autoenroll'};
5672: if ($settings->{'run'} eq '1') {
5673: $response = 1;
5674: }
5675: } else {
5676: my $homeserver;
5677: if (&is_course($cdom,$cnum)) {
5678: $homeserver = &homeserver($cnum,$cdom);
5679: } else {
5680: $homeserver = &domain($cdom,'primary');
5681: }
5682: if ($homeserver ne 'no_host') {
5683: $response = &reply('autorun:'.$cdom,$homeserver);
5684: }
5685: }
5686: return $response;
5687: }
5688:
5689: sub auto_get_sections {
5690: my ($cnum,$cdom,$inst_coursecode) = @_;
5691: my $homeserver;
5692: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5693: $homeserver = &homeserver($cnum,$cdom);
5694: }
5695: if (!defined($homeserver)) {
5696: if ($cdom =~ /^$match_domain$/) {
5697: $homeserver = &domain($cdom,'primary');
5698: }
5699: }
5700: my @secs;
5701: if (defined($homeserver)) {
5702: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5703: unless ($response eq 'refused') {
5704: @secs = split(/:/,$response);
5705: }
5706: }
5707: return @secs;
5708: }
5709:
5710: sub auto_new_course {
5711: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5712: my $homeserver = &homeserver($cnum,$cdom);
5713: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5714: return $response;
5715: }
5716:
5717: sub auto_validate_courseID {
5718: my ($cnum,$cdom,$inst_course_id) = @_;
5719: my $homeserver = &homeserver($cnum,$cdom);
5720: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5721: return $response;
5722: }
5723:
5724: sub auto_validate_instcode {
5725: my ($cnum,$cdom,$instcode,$owner) = @_;
5726: my ($homeserver,$response);
5727: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5728: $homeserver = &homeserver($cnum,$cdom);
5729: }
5730: if (!defined($homeserver)) {
5731: if ($cdom =~ /^$match_domain$/) {
5732: $homeserver = &domain($cdom,'primary');
5733: }
5734: }
5735: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5736: &escape($instcode).':'.&escape($owner),$homeserver));
5737: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5738: return ($outcome,$description);
5739: }
5740:
5741: sub auto_create_password {
5742: my ($cnum,$cdom,$authparam,$udom) = @_;
5743: my ($homeserver,$response);
5744: my $create_passwd = 0;
5745: my $authchk = '';
5746: if ($udom =~ /^$match_domain$/) {
5747: $homeserver = &domain($udom,'primary');
5748: }
5749: if ($homeserver eq '') {
5750: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5751: $homeserver = &homeserver($cnum,$cdom);
5752: }
5753: }
5754: if ($homeserver eq '') {
5755: $authchk = 'nodomain';
5756: } else {
5757: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5758: if ($response eq 'refused') {
5759: $authchk = 'refused';
5760: } else {
5761: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5762: }
5763: }
5764: return ($authparam,$create_passwd,$authchk);
5765: }
5766:
5767: sub auto_photo_permission {
5768: my ($cnum,$cdom,$students) = @_;
5769: my $homeserver = &homeserver($cnum,$cdom);
5770: my ($outcome,$perm_reqd,$conditions) =
5771: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5772: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5773: return (undef,undef);
5774: }
5775: return ($outcome,$perm_reqd,$conditions);
5776: }
5777:
5778: sub auto_checkphotos {
5779: my ($uname,$udom,$pid) = @_;
5780: my $homeserver = &homeserver($uname,$udom);
5781: my ($result,$resulttype);
5782: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5783: &escape($uname).':'.&escape($pid),
5784: $homeserver));
5785: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5786: return (undef,undef);
5787: }
5788: if ($outcome) {
5789: ($result,$resulttype) = split(/:/,$outcome);
5790: }
5791: return ($result,$resulttype);
5792: }
5793:
5794: sub auto_photochoice {
5795: my ($cnum,$cdom) = @_;
5796: my $homeserver = &homeserver($cnum,$cdom);
5797: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5798: &escape($cdom),
5799: $homeserver)));
5800: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5801: return (undef,undef);
5802: }
5803: return ($update,$comment);
5804: }
5805:
5806: sub auto_photoupdate {
5807: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5808: my $homeserver = &homeserver($cnum,$dom);
5809: my $host=&hostname($homeserver);
5810: my $cmd = '';
5811: my $maxtries = 1;
5812: foreach my $affiliate (keys(%{$affiliatesref})) {
5813: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5814: }
5815: $cmd =~ s/%%$//;
5816: $cmd = &escape($cmd);
5817: my $query = 'institutionalphotos';
5818: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5819: unless ($queryid=~/^\Q$host\E\_/) {
5820: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5821: return 'error: '.$queryid;
5822: }
5823: my $reply = &get_query_reply($queryid);
5824: my $tries = 1;
5825: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5826: $reply = &get_query_reply($queryid);
5827: $tries ++;
5828: }
5829: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5830: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5831: } else {
5832: my @responses = split(/:/,$reply);
5833: my $outcome = shift(@responses);
5834: foreach my $item (@responses) {
5835: my ($key,$value) = split(/=/,$item);
5836: $$photo{$key} = $value;
5837: }
5838: return $outcome;
5839: }
5840: return 'error';
5841: }
5842:
5843: sub auto_instcode_format {
5844: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5845: $cat_order) = @_;
5846: my $courses = '';
5847: my @homeservers;
5848: if ($caller eq 'global') {
5849: my %servers = &get_servers($codedom,'library');
5850: foreach my $tryserver (keys(%servers)) {
5851: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5852: push(@homeservers,$tryserver);
5853: }
5854: }
5855: } elsif ($caller eq 'requests') {
5856: if ($codedom =~ /^$match_domain$/) {
5857: my $chome = &domain($codedom,'primary');
5858: unless ($chome eq 'no_host') {
5859: push(@homeservers,$chome);
5860: }
5861: }
5862: } else {
5863: push(@homeservers,&homeserver($caller,$codedom));
5864: }
5865: foreach my $code (keys(%{$instcodes})) {
5866: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5867: }
5868: chop($courses);
5869: my $ok_response = 0;
5870: my $response;
5871: while (@homeservers > 0 && $ok_response == 0) {
5872: my $server = shift(@homeservers);
5873: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5874: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5875: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5876: split(/:/,$response);
5877: %{$codes} = (%{$codes},&str2hash($codes_str));
5878: push(@{$codetitles},&str2array($codetitles_str));
5879: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5880: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5881: $ok_response = 1;
5882: }
5883: }
5884: if ($ok_response) {
5885: return 'ok';
5886: } else {
5887: return $response;
5888: }
5889: }
5890:
5891: sub auto_instcode_defaults {
5892: my ($domain,$returnhash,$code_order) = @_;
5893: my @homeservers;
5894:
5895: my %servers = &get_servers($domain,'library');
5896: foreach my $tryserver (keys(%servers)) {
5897: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5898: push(@homeservers,$tryserver);
5899: }
5900: }
5901:
5902: my $response;
5903: foreach my $server (@homeservers) {
5904: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5905: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5906:
5907: foreach my $pair (split(/\&/,$response)) {
5908: my ($name,$value)=split(/\=/,$pair);
5909: if ($name eq 'code_order') {
5910: @{$code_order} = split(/\&/,&unescape($value));
5911: } else {
5912: $returnhash->{&unescape($name)}=&unescape($value);
5913: }
5914: }
5915: return 'ok';
5916: }
5917:
5918: return $response;
5919: }
5920:
5921: sub auto_possible_instcodes {
5922: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5923: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5924: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5925: return;
5926: }
5927: my (@homeservers,$uhome);
5928: if (defined(&domain($domain,'primary'))) {
5929: $uhome=&domain($domain,'primary');
5930: push(@homeservers,&domain($domain,'primary'));
5931: } else {
5932: my %servers = &get_servers($domain,'library');
5933: foreach my $tryserver (keys(%servers)) {
5934: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5935: push(@homeservers,$tryserver);
5936: }
5937: }
5938: }
5939: my $response;
5940: foreach my $server (@homeservers) {
5941: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5942: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5943: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5944: split(':',$response);
5945: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5946: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
5947: foreach my $item (split('&',$cat_title)) {
5948: my ($name,$value)=split('=',$item);
5949: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
5950: }
5951: foreach my $item (split('&',$cat_order)) {
5952: my ($name,$value)=split('=',$item);
5953: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
5954: }
5955: return 'ok';
5956: }
5957: return $response;
5958: }
5959:
5960: sub auto_courserequest_checks {
5961: my ($dom) = @_;
5962: my ($homeserver,%validations);
5963: if ($dom =~ /^$match_domain$/) {
5964: $homeserver = &domain($dom,'primary');
5965: }
5966: unless ($homeserver eq 'no_host') {
5967: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
5968: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
5969: my @items = split(/&/,$response);
5970: foreach my $item (@items) {
5971: my ($key,$value) = split('=',$item);
5972: $validations{&unescape($key)} = &thaw_unescape($value);
5973: }
5974: }
5975: }
5976: return %validations;
5977: }
5978:
5979: sub auto_courserequest_validation {
5980: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
5981: my ($homeserver,$response);
5982: if ($dom =~ /^$match_domain$/) {
5983: $homeserver = &domain($dom,'primary');
5984: }
5985: unless ($homeserver eq 'no_host') {
5986:
5987: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
5988: ':'.&escape($crstype).':'.&escape($inststatuslist).
5989: ':'.&escape($instcode).':'.&escape($instseclist),
5990: $homeserver));
5991: }
5992: return $response;
5993: }
5994:
5995: sub auto_validate_class_sec {
5996: my ($cdom,$cnum,$owners,$inst_class) = @_;
5997: my $homeserver = &homeserver($cnum,$cdom);
5998: my $ownerlist;
5999: if (ref($owners) eq 'ARRAY') {
6000: $ownerlist = join(',',@{$owners});
6001: } else {
6002: $ownerlist = $owners;
6003: }
6004: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6005: &escape($ownerlist).':'.$cdom,$homeserver);
6006: return $response;
6007: }
6008:
6009: # ------------------------------------------------------- Course Group routines
6010:
6011: sub get_coursegroups {
6012: my ($cdom,$cnum,$group,$namespace) = @_;
6013: return(&dump($namespace,$cdom,$cnum,$group));
6014: }
6015:
6016: sub modify_coursegroup {
6017: my ($cdom,$cnum,$groupsettings) = @_;
6018: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6019: }
6020:
6021: sub toggle_coursegroup_status {
6022: my ($cdom,$cnum,$group,$action) = @_;
6023: my ($from_namespace,$to_namespace);
6024: if ($action eq 'delete') {
6025: $from_namespace = 'coursegroups';
6026: $to_namespace = 'deleted_groups';
6027: } else {
6028: $from_namespace = 'deleted_groups';
6029: $to_namespace = 'coursegroups';
6030: }
6031: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6032: if (my $tmp = &error(%curr_group)) {
6033: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6034: return ('read error',$tmp);
6035: } else {
6036: my %savedsettings = %curr_group;
6037: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6038: my $deloutcome;
6039: if ($result eq 'ok') {
6040: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6041: } else {
6042: return ('write error',$result);
6043: }
6044: if ($deloutcome eq 'ok') {
6045: return 'ok';
6046: } else {
6047: return ('delete error',$deloutcome);
6048: }
6049: }
6050: }
6051:
6052: sub modify_group_roles {
6053: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6054: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6055: my $role = 'gr/'.&escape($userprivs);
6056: my ($uname,$udom) = split(/:/,$user);
6057: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6058: if ($result eq 'ok') {
6059: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6060: }
6061: return $result;
6062: }
6063:
6064: sub modify_coursegroup_membership {
6065: my ($cdom,$cnum,$membership) = @_;
6066: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6067: return $result;
6068: }
6069:
6070: sub get_active_groups {
6071: my ($udom,$uname,$cdom,$cnum) = @_;
6072: my $now = time;
6073: my %groups = ();
6074: foreach my $key (keys(%env)) {
6075: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6076: my ($start,$end) = split(/\./,$env{$key});
6077: if (($end!=0) && ($end<$now)) { next; }
6078: if (($start!=0) && ($start>$now)) { next; }
6079: if ($1 eq $cdom && $2 eq $cnum) {
6080: $groups{$3} = $env{$key} ;
6081: }
6082: }
6083: }
6084: return %groups;
6085: }
6086:
6087: sub get_group_membership {
6088: my ($cdom,$cnum,$group) = @_;
6089: return(&dump('groupmembership',$cdom,$cnum,$group));
6090: }
6091:
6092: sub get_users_groups {
6093: my ($udom,$uname,$courseid) = @_;
6094: my @usersgroups;
6095: my $cachetime=1800;
6096:
6097: my $hashid="$udom:$uname:$courseid";
6098: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6099: if (defined($cached)) {
6100: @usersgroups = split(/:/,$grouplist);
6101: } else {
6102: $grouplist = '';
6103: my $courseurl = &courseid_to_courseurl($courseid);
6104: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
6105: my $access_end = $env{'course.'.$courseid.
6106: '.default_enrollment_end_date'};
6107: my $now = time;
6108: foreach my $key (keys(%roleshash)) {
6109: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6110: my $group = $1;
6111: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6112: my $start = $2;
6113: my $end = $1;
6114: if ($start == -1) { next; } # deleted from group
6115: if (($start!=0) && ($start>$now)) { next; }
6116: if (($end!=0) && ($end<$now)) {
6117: if ($access_end && $access_end < $now) {
6118: if ($access_end - $end < 86400) {
6119: push(@usersgroups,$group);
6120: }
6121: }
6122: next;
6123: }
6124: push(@usersgroups,$group);
6125: }
6126: }
6127: }
6128: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6129: $grouplist = join(':',@usersgroups);
6130: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6131: }
6132: return @usersgroups;
6133: }
6134:
6135: sub devalidate_getgroups_cache {
6136: my ($udom,$uname,$cdom,$cnum)=@_;
6137: my $courseid = $cdom.'_'.$cnum;
6138:
6139: my $hashid="$udom:$uname:$courseid";
6140: &devalidate_cache_new('getgroups',$hashid);
6141: }
6142:
6143: # ------------------------------------------------------------------ Plain Text
6144:
6145: sub plaintext {
6146: my ($short,$type,$cid,$forcedefault) = @_;
6147: if ($short =~ m{^cr/}) {
6148: return (split('/',$short))[-1];
6149: }
6150: if (!defined($cid)) {
6151: $cid = $env{'request.course.id'};
6152: }
6153: my %rolenames = (
6154: Course => 'std',
6155: Community => 'alt1',
6156: );
6157: if ($cid ne '') {
6158: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6159: unless ($forcedefault) {
6160: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6161: &Apache::lonlocal::mt_escape(\$roletext);
6162: return &Apache::lonlocal::mt($roletext);
6163: }
6164: }
6165: }
6166: if ((defined($type)) && (defined($rolenames{$type})) &&
6167: (defined($rolenames{$type})) &&
6168: (defined($prp{$short}{$rolenames{$type}}))) {
6169: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
6170: } elsif ($cid ne '') {
6171: my $crstype = $env{'course.'.$cid.'.type'};
6172: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6173: (defined($prp{$short}{$rolenames{$crstype}}))) {
6174: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6175: }
6176: }
6177: return &Apache::lonlocal::mt($prp{$short}{'std'});
6178: }
6179:
6180: # ----------------------------------------------------------------- Assign Role
6181:
6182: sub assignrole {
6183: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6184: $context)=@_;
6185: my $mrole;
6186: if ($role =~ /^cr\//) {
6187: my $cwosec=$url;
6188: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6189: unless (&allowed('ccr',$cwosec)) {
6190: my $refused = 1;
6191: if ($context eq 'requestcourses') {
6192: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6193: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6194: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6195: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6196: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6197: if ($crsenv{'internal.courseowner'} eq
6198: $env{'user.name'}.':'.$env{'user.domain'}) {
6199: $refused = '';
6200: }
6201: }
6202: }
6203: }
6204: }
6205: if ($refused) {
6206: &logthis('Refused custom assignrole: '.
6207: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6208: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6209: return 'refused';
6210: }
6211: }
6212: $mrole='cr';
6213: } elsif ($role =~ /^gr\//) {
6214: my $cwogrp=$url;
6215: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
6216: unless (&allowed('mdg',$cwogrp)) {
6217: &logthis('Refused group assignrole: '.
6218: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6219: $env{'user.name'}.' at '.$env{'user.domain'});
6220: return 'refused';
6221: }
6222: $mrole='gr';
6223: } else {
6224: my $cwosec=$url;
6225: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6226: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6227: my $refused;
6228: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6229: if (!(&allowed('c'.$role,$url))) {
6230: $refused = 1;
6231: }
6232: } else {
6233: $refused = 1;
6234: }
6235: if ($refused) {
6236: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6237: if (!$selfenroll && $context eq 'course') {
6238: my %crsenv;
6239: if ($role eq 'cc' || $role eq 'co') {
6240: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6241: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6242: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6243: if ($crsenv{'internal.courseowner'} eq
6244: $env{'user.name'}.':'.$env{'user.domain'}) {
6245: $refused = '';
6246: }
6247: }
6248: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6249: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6250: if ($crsenv{'internal.courseowner'} eq
6251: $env{'user.name'}.':'.$env{'user.domain'}) {
6252: $refused = '';
6253: }
6254: }
6255: }
6256: }
6257: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6258: $refused = '';
6259: } elsif ($context eq 'requestcourses') {
6260: my @possroles = ('st','ta','ep','in','cc','co');
6261: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
6262: my $wrongcc;
6263: if ($cnum =~ /^$match_community$/) {
6264: $wrongcc = 1 if ($role eq 'cc');
6265: } else {
6266: $wrongcc = 1 if ($role eq 'co');
6267: }
6268: unless ($wrongcc) {
6269: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6270: if ($crsenv{'internal.courseowner'} eq
6271: $env{'user.name'}.':'.$env{'user.domain'}) {
6272: $refused = '';
6273: }
6274: }
6275: }
6276: }
6277: if ($refused) {
6278: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6279: ' '.$role.' '.$end.' '.$start.' by '.
6280: $env{'user.name'}.' at '.$env{'user.domain'});
6281: return 'refused';
6282: }
6283: }
6284: }
6285: $mrole=$role;
6286: }
6287: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6288: "$udom:$uname:$url".'_'."$mrole=$role";
6289: if ($end) { $command.='_'.$end; }
6290: if ($start) {
6291: if ($end) {
6292: $command.='_'.$start;
6293: } else {
6294: $command.='_0_'.$start;
6295: }
6296: }
6297: my $origstart = $start;
6298: my $origend = $end;
6299: my $delflag;
6300: # actually delete
6301: if ($deleteflag) {
6302: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
6303: # modify command to delete the role
6304: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
6305: "$udom:$uname:$url".'_'."$mrole";
6306: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
6307: # set start and finish to negative values for userrolelog
6308: $start=-1;
6309: $end=-1;
6310: $delflag = 1;
6311: }
6312: }
6313: # send command
6314: my $answer=&reply($command,&homeserver($uname,$udom));
6315: # log new user role if status is ok
6316: if ($answer eq 'ok') {
6317: &userrolelog($role,$uname,$udom,$url,$start,$end);
6318: # for course roles, perform group memberships changes triggered by role change.
6319: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
6320: unless ($role =~ /^gr/) {
6321: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
6322: $origstart,$selfenroll,$context);
6323: }
6324: }
6325: return $answer;
6326: }
6327:
6328: # -------------------------------------------------- Modify user authentication
6329: # Overrides without validation
6330:
6331: sub modifyuserauth {
6332: my ($udom,$uname,$umode,$upass)=@_;
6333: my $uhome=&homeserver($uname,$udom);
6334: unless (&allowed('mau',$udom)) { return 'refused'; }
6335: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
6336: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6337: ' in domain '.$env{'request.role.domain'});
6338: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6339: &escape($upass),$uhome);
6340: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
6341: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6342: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6343: &log($udom,,$uname,$uhome,
6344: 'Authentication changed by '.$env{'user.domain'}.', '.
6345: $env{'user.name'}.', '.$umode.
6346: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6347: unless ($reply eq 'ok') {
6348: &logthis('Authentication mode error: '.$reply);
6349: return 'error: '.$reply;
6350: }
6351: return 'ok';
6352: }
6353:
6354: # --------------------------------------------------------------- Modify a user
6355:
6356: sub modifyuser {
6357: my ($udom, $uname, $uid,
6358: $umode, $upass, $first,
6359: $middle, $last, $gene,
6360: $forceid, $desiredhome, $email, $inststatus)=@_;
6361: $udom= &LONCAPA::clean_domain($udom);
6362: $uname=&LONCAPA::clean_username($uname);
6363: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
6364: $umode.', '.$first.', '.$middle.', '.
6365: $last.', '.$gene.'(forceid: '.$forceid.')'.
6366: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6367: ' desiredhome not specified').
6368: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6369: ' in domain '.$env{'request.role.domain'});
6370: my $uhome=&homeserver($uname,$udom,'true');
6371: # ----------------------------------------------------------------- Create User
6372: if (($uhome eq 'no_host') &&
6373: (($umode && $upass) || ($umode eq 'localauth'))) {
6374: my $unhome='';
6375: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
6376: $unhome = $desiredhome;
6377: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6378: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
6379: } else { # load balancing routine for determining $unhome
6380: my $loadm=10000000;
6381: my %servers = &get_servers($udom,'library');
6382: foreach my $tryserver (keys(%servers)) {
6383: my $answer=reply('load',$tryserver);
6384: if (($answer=~/\d+/) && ($answer<$loadm)) {
6385: $loadm=$answer;
6386: $unhome=$tryserver;
6387: }
6388: }
6389: }
6390: if (($unhome eq '') || ($unhome eq 'no_host')) {
6391: return 'error: unable to find a home server for '.$uname.
6392: ' in domain '.$udom;
6393: }
6394: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6395: &escape($upass),$unhome);
6396: unless ($reply eq 'ok') {
6397: return 'error: '.$reply;
6398: }
6399: $uhome=&homeserver($uname,$udom,'true');
6400: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6401: return 'error: unable verify users home machine.';
6402: }
6403: } # End of creation of new user
6404: # ---------------------------------------------------------------------- Add ID
6405: if ($uid) {
6406: $uid=~tr/A-Z/a-z/;
6407: my %uidhash=&idrget($udom,$uname);
6408: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6409: && (!$forceid)) {
6410: unless ($uid eq $uidhash{$uname}) {
6411: return 'error: user id "'.$uid.'" does not match '.
6412: 'current user id "'.$uidhash{$uname}.'".';
6413: }
6414: } else {
6415: &idput($udom,($uname => $uid));
6416: }
6417: }
6418: # -------------------------------------------------------------- Add names, etc
6419: my @tmp=&get('environment',
6420: ['firstname','middlename','lastname','generation','id',
6421: 'permanentemail','inststatus'],
6422: $udom,$uname);
6423: my %names;
6424: if ($tmp[0] =~ m/^error:.*/) {
6425: %names=();
6426: } else {
6427: %names = @tmp;
6428: }
6429: #
6430: # Make sure to not trash student environment if instructor does not bother
6431: # to supply name and email information
6432: #
6433: if ($first) { $names{'firstname'} = $first; }
6434: if (defined($middle)) { $names{'middlename'} = $middle; }
6435: if ($last) { $names{'lastname'} = $last; }
6436: if (defined($gene)) { $names{'generation'} = $gene; }
6437: if ($email) {
6438: $email=~s/[^\w\@\.\-\,]//gs;
6439: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6440: }
6441: if ($uid) { $names{'id'} = $uid; }
6442: if (defined($inststatus)) {
6443: $names{'inststatus'} = '';
6444: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6445: if (ref($usertypes) eq 'HASH') {
6446: my @okstatuses;
6447: foreach my $item (split(/:/,$inststatus)) {
6448: if (defined($usertypes->{$item})) {
6449: push(@okstatuses,$item);
6450: }
6451: }
6452: if (@okstatuses) {
6453: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6454: }
6455: }
6456: }
6457: my $reply = &put('environment', \%names, $udom,$uname);
6458: if ($reply ne 'ok') { return 'error: '.$reply; }
6459: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6460: &devalidate_cache_new('namescache',$uname.':'.$udom);
6461: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6462: $umode.', '.$first.', '.$middle.', '.
6463: $last.', '.$gene.', '.$email.', '.$inststatus;
6464: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6465: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6466: } else {
6467: $logmsg .= ' during self creation';
6468: }
6469: &logthis($logmsg);
6470: return 'ok';
6471: }
6472:
6473: # -------------------------------------------------------------- Modify student
6474:
6475: sub modifystudent {
6476: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6477: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6478: $selfenroll,$context,$inststatus)=@_;
6479: if (!$cid) {
6480: unless ($cid=$env{'request.course.id'}) {
6481: return 'not_in_class';
6482: }
6483: }
6484: # --------------------------------------------------------------- Make the user
6485: my $reply=&modifyuser
6486: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6487: $desiredhome,$email,$inststatus);
6488: unless ($reply eq 'ok') { return $reply; }
6489: # This will cause &modify_student_enrollment to get the uid from the
6490: # students environment
6491: $uid = undef if (!$forceid);
6492: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6493: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6494: return $reply;
6495: }
6496:
6497: sub modify_student_enrollment {
6498: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6499: my ($cdom,$cnum,$chome);
6500: if (!$cid) {
6501: unless ($cid=$env{'request.course.id'}) {
6502: return 'not_in_class';
6503: }
6504: $cdom=$env{'course.'.$cid.'.domain'};
6505: $cnum=$env{'course.'.$cid.'.num'};
6506: } else {
6507: ($cdom,$cnum)=split(/_/,$cid);
6508: }
6509: $chome=$env{'course.'.$cid.'.home'};
6510: if (!$chome) {
6511: $chome=&homeserver($cnum,$cdom);
6512: }
6513: if (!$chome) { return 'unknown_course'; }
6514: # Make sure the user exists
6515: my $uhome=&homeserver($uname,$udom);
6516: if (($uhome eq '') || ($uhome eq 'no_host')) {
6517: return 'error: no such user';
6518: }
6519: # Get student data if we were not given enough information
6520: if (!defined($first) || $first eq '' ||
6521: !defined($last) || $last eq '' ||
6522: !defined($uid) || $uid eq '' ||
6523: !defined($middle) || $middle eq '' ||
6524: !defined($gene) || $gene eq '') {
6525: # They did not supply us with enough data to enroll the student, so
6526: # we need to pick up more information.
6527: my %tmp = &get('environment',
6528: ['firstname','middlename','lastname', 'generation','id']
6529: ,$udom,$uname);
6530:
6531: #foreach my $key (keys(%tmp)) {
6532: # &logthis("key $key = ".$tmp{$key});
6533: #}
6534: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6535: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6536: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6537: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6538: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6539: }
6540: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6541: my $reply=cput('classlist',
6542: {"$uname:$udom" =>
6543: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6544: $cdom,$cnum);
6545: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6546: return 'error: '.$reply;
6547: } else {
6548: &devalidate_getsection_cache($udom,$uname,$cid);
6549: }
6550: # Add student role to user
6551: my $uurl='/'.$cid;
6552: $uurl=~s/\_/\//g;
6553: if ($usec) {
6554: $uurl.='/'.$usec;
6555: }
6556: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6557: }
6558:
6559: sub format_name {
6560: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6561: my $name;
6562: if ($first ne 'lastname') {
6563: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6564: } else {
6565: if ($lastname=~/\S/) {
6566: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6567: $name=~s/\s+,/,/;
6568: } else {
6569: $name.= $firstname.' '.$middlename.' '.$generation;
6570: }
6571: }
6572: $name=~s/^\s+//;
6573: $name=~s/\s+$//;
6574: $name=~s/\s+/ /g;
6575: return $name;
6576: }
6577:
6578: # ------------------------------------------------- Write to course preferences
6579:
6580: sub writecoursepref {
6581: my ($courseid,%prefs)=@_;
6582: $courseid=~s/^\///;
6583: $courseid=~s/\_/\//g;
6584: my ($cdomain,$cnum)=split(/\//,$courseid);
6585: my $chome=homeserver($cnum,$cdomain);
6586: if (($chome eq '') || ($chome eq 'no_host')) {
6587: return 'error: no such course';
6588: }
6589: my $cstring='';
6590: foreach my $pref (keys(%prefs)) {
6591: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6592: }
6593: $cstring=~s/\&$//;
6594: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6595: }
6596:
6597: # ---------------------------------------------------------- Make/modify course
6598:
6599: sub createcourse {
6600: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6601: $course_owner,$crstype,$cnum,$context,$category)=@_;
6602: $url=&declutter($url);
6603: my $cid='';
6604: if ($context eq 'requestcourses') {
6605: my $can_create = 0;
6606: my ($ownername,$ownerdom) = split(':',$course_owner);
6607: if ($udom eq $ownerdom) {
6608: if (&usertools_access($ownername,$ownerdom,$category,undef,
6609: $context)) {
6610: $can_create = 1;
6611: }
6612: } else {
6613: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6614: $category);
6615: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6616: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6617: if (@curr > 0) {
6618: my @options = qw(approval validate autolimit);
6619: my $optregex = join('|',@options);
6620: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6621: $can_create = 1;
6622: }
6623: }
6624: }
6625: }
6626: if ($can_create) {
6627: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6628: unless (&allowed('ccc',$udom)) {
6629: return 'refused';
6630: }
6631: }
6632: } else {
6633: return 'refused';
6634: }
6635: } elsif (!&allowed('ccc',$udom)) {
6636: return 'refused';
6637: }
6638: # --------------------------------------------------------------- Get Unique ID
6639: my $uname;
6640: if ($cnum =~ /^$match_courseid$/) {
6641: my $chome=&homeserver($cnum,$udom,'true');
6642: if (($chome eq '') || ($chome eq 'no_host')) {
6643: $uname = $cnum;
6644: } else {
6645: $uname = &generate_coursenum($udom,$crstype);
6646: }
6647: } else {
6648: $uname = &generate_coursenum($udom,$crstype);
6649: }
6650: return $uname if ($uname =~ /^error/);
6651: # -------------------------------------------------- Check supplied server name
6652: $course_server = $env{'user.homeserver'} if (! defined($course_server));
6653: if (! &is_library($course_server)) {
6654: return 'error:bad server name '.$course_server;
6655: }
6656: # ------------------------------------------------------------- Make the course
6657: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6658: $course_server);
6659: unless ($reply eq 'ok') { return 'error: '.$reply; }
6660: my $uhome=&homeserver($uname,$udom,'true');
6661: if (($uhome eq '') || ($uhome eq 'no_host')) {
6662: return 'error: no such course';
6663: }
6664: # ----------------------------------------------------------------- Course made
6665: # log existence
6666: my $now = time;
6667: my $newcourse = {
6668: $udom.'_'.$uname => {
6669: description => $description,
6670: inst_code => $inst_code,
6671: owner => $course_owner,
6672: type => $crstype,
6673: creator => $env{'user.name'}.':'.
6674: $env{'user.domain'},
6675: created => $now,
6676: context => $context,
6677: },
6678: };
6679: &courseidput($udom,$newcourse,$uhome,'notime');
6680: # set toplevel url
6681: my $topurl=$url;
6682: unless ($nonstandard) {
6683: # ------------------------------------------ For standard courses, make top url
6684: my $mapurl=&clutter($url);
6685: if ($mapurl eq '/res/') { $mapurl=''; }
6686: $env{'form.initmap'}=(<<ENDINITMAP);
6687: <map>
6688: <resource id="1" type="start"></resource>
6689: <resource id="2" src="$mapurl"></resource>
6690: <resource id="3" type="finish"></resource>
6691: <link index="1" from="1" to="2"></link>
6692: <link index="2" from="2" to="3"></link>
6693: </map>
6694: ENDINITMAP
6695: $topurl=&declutter(
6696: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6697: );
6698: }
6699: # ----------------------------------------------------------- Write preferences
6700: &writecoursepref($udom.'_'.$uname,
6701: ('description' => $description,
6702: 'url' => $topurl));
6703: return '/'.$udom.'/'.$uname;
6704: }
6705:
6706: # ------------------------------------------------------------------- Create ID
6707: sub generate_coursenum {
6708: my ($udom,$crstype) = @_;
6709: my $domdesc = &domain($udom);
6710: return 'error: invalid domain' if ($domdesc eq '');
6711: my $first;
6712: if ($crstype eq 'Community') {
6713: $first = '0';
6714: } else {
6715: $first = int(1+rand(9));
6716: }
6717: my $uname=$first.
6718: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6719: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6720: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6721: # ----------------------------------------------- Make sure that does not exist
6722: my $uhome=&homeserver($uname,$udom,'true');
6723: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6724: if ($crstype eq 'Community') {
6725: $first = '0';
6726: } else {
6727: $first = int(1+rand(9));
6728: }
6729: $uname=$first.
6730: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6731: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6732: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6733: $uhome=&homeserver($uname,$udom,'true');
6734: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6735: return 'error: unable to generate unique course-ID';
6736: }
6737: }
6738: return $uname;
6739: }
6740:
6741: sub is_course {
6742: my ($cdom,$cnum) = @_;
6743: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6744: undef,'.');
6745: if (exists($courses{$cdom.'_'.$cnum})) {
6746: return 1;
6747: }
6748: return 0;
6749: }
6750:
6751: sub store_userdata {
6752: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
6753: my $result;
6754: if ($datakey ne '') {
6755: if (ref($storehash) eq 'HASH') {
6756: if ($udom eq '' || $uname eq '') {
6757: $udom = $env{'user.domain'};
6758: $uname = $env{'user.name'};
6759: }
6760: my $uhome=&homeserver($uname,$udom);
6761: if (($uhome eq '') || ($uhome eq 'no_host')) {
6762: $result = 'error: no_host';
6763: } else {
6764: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6765: $storehash->{'host'} = $perlvar{'lonHostID'};
6766:
6767: my $namevalue='';
6768: foreach my $key (keys(%{$storehash})) {
6769: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6770: }
6771: $namevalue=~s/\&$//;
6772: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
6773: "$namespace:$datakey:$namevalue",$uhome);
6774: }
6775: } else {
6776: $result = 'error: data to store was not a hash reference';
6777: }
6778: } else {
6779: $result= 'error: invalid requestkey';
6780: }
6781: return $result;
6782: }
6783:
6784: # ---------------------------------------------------------- Assign Custom Role
6785:
6786: sub assigncustomrole {
6787: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
6788: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
6789: $end,$start,$deleteflag,$selfenroll,$context);
6790: }
6791:
6792: # ----------------------------------------------------------------- Revoke Role
6793:
6794: sub revokerole {
6795: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
6796: my $now=time;
6797: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
6798: }
6799:
6800: # ---------------------------------------------------------- Revoke Custom Role
6801:
6802: sub revokecustomrole {
6803: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
6804: my $now=time;
6805: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
6806: $deleteflag,$selfenroll,$context);
6807: }
6808:
6809: # ------------------------------------------------------------ Disk usage
6810: sub diskusage {
6811: my ($udom,$uname,$directorypath,$getpropath)=@_;
6812: $directorypath =~ s/\/$//;
6813: my $listing=&reply('du2:'.&escape($directorypath).':'
6814: .&escape($getpropath).':'.&escape($uname).':'
6815: .&escape($udom),homeserver($uname,$udom));
6816: if ($listing eq 'unknown_cmd') {
6817: if ($getpropath) {
6818: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6819: }
6820: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6821: }
6822: return $listing;
6823: }
6824:
6825: sub is_locked {
6826: my ($file_name, $domain, $user) = @_;
6827: my @check;
6828: my $is_locked;
6829: push @check, $file_name;
6830: my %locked = &get('file_permissions',\@check,
6831: $env{'user.domain'},$env{'user.name'});
6832: my ($tmp)=keys(%locked);
6833: if ($tmp=~/^error:/) { undef(%locked); }
6834:
6835: if (ref($locked{$file_name}) eq 'ARRAY') {
6836: $is_locked = 'false';
6837: foreach my $entry (@{$locked{$file_name}}) {
6838: if (ref($entry) eq 'ARRAY') {
6839: $is_locked = 'true';
6840: last;
6841: }
6842: }
6843: } else {
6844: $is_locked = 'false';
6845: }
6846: }
6847:
6848: sub declutter_portfile {
6849: my ($file) = @_;
6850: $file =~ s{^(/portfolio/|portfolio/)}{/};
6851: return $file;
6852: }
6853:
6854: # ------------------------------------------------------------- Mark as Read Only
6855:
6856: sub mark_as_readonly {
6857: my ($domain,$user,$files,$what) = @_;
6858: my %current_permissions = &dump('file_permissions',$domain,$user);
6859: my ($tmp)=keys(%current_permissions);
6860: if ($tmp=~/^error:/) { undef(%current_permissions); }
6861: foreach my $file (@{$files}) {
6862: $file = &declutter_portfile($file);
6863: push(@{$current_permissions{$file}},$what);
6864: }
6865: &put('file_permissions',\%current_permissions,$domain,$user);
6866: return;
6867: }
6868:
6869: # ------------------------------------------------------------Save Selected Files
6870:
6871: sub save_selected_files {
6872: my ($user, $path, @files) = @_;
6873: my $filename = $user."savedfiles";
6874: my @other_files = &files_not_in_path($user, $path);
6875: open (OUT, '>'.$tmpdir.$filename);
6876: foreach my $file (@files) {
6877: print (OUT $env{'form.currentpath'}.$file."\n");
6878: }
6879: foreach my $file (@other_files) {
6880: print (OUT $file."\n");
6881: }
6882: close (OUT);
6883: return 'ok';
6884: }
6885:
6886: sub clear_selected_files {
6887: my ($user) = @_;
6888: my $filename = $user."savedfiles";
6889: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6890: print (OUT undef);
6891: close (OUT);
6892: return ("ok");
6893: }
6894:
6895: sub files_in_path {
6896: my ($user, $path) = @_;
6897: my $filename = $user."savedfiles";
6898: my %return_files;
6899: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6900: while (my $line_in = <IN>) {
6901: chomp ($line_in);
6902: my @paths_and_file = split (m!/!, $line_in);
6903: my $file_part = pop (@paths_and_file);
6904: my $path_part = join ('/', @paths_and_file);
6905: $path_part.='/';
6906: my $path_and_file = $path_part.$file_part;
6907: if ($path_part eq $path) {
6908: $return_files{$file_part}= 'selected';
6909: }
6910: }
6911: close (IN);
6912: return (\%return_files);
6913: }
6914:
6915: # called in portfolio select mode, to show files selected NOT in current directory
6916: sub files_not_in_path {
6917: my ($user, $path) = @_;
6918: my $filename = $user."savedfiles";
6919: my @return_files;
6920: my $path_part;
6921: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6922: while (my $line = <IN>) {
6923: #ok, I know it's clunky, but I want it to work
6924: my @paths_and_file = split(m|/|, $line);
6925: my $file_part = pop(@paths_and_file);
6926: chomp($file_part);
6927: my $path_part = join('/', @paths_and_file);
6928: $path_part .= '/';
6929: my $path_and_file = $path_part.$file_part;
6930: if ($path_part ne $path) {
6931: push(@return_files, ($path_and_file));
6932: }
6933: }
6934: close(OUT);
6935: return (@return_files);
6936: }
6937:
6938: #----------------------------------------------Get portfolio file permissions
6939:
6940: sub get_portfile_permissions {
6941: my ($domain,$user) = @_;
6942: my %current_permissions = &dump('file_permissions',$domain,$user);
6943: my ($tmp)=keys(%current_permissions);
6944: if ($tmp=~/^error:/) { undef(%current_permissions); }
6945: return \%current_permissions;
6946: }
6947:
6948: #---------------------------------------------Get portfolio file access controls
6949:
6950: sub get_access_controls {
6951: my ($current_permissions,$group,$file) = @_;
6952: my %access;
6953: my $real_file = $file;
6954: $file =~ s/\.meta$//;
6955: if (defined($file)) {
6956: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6957: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
6958: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
6959: }
6960: }
6961: } else {
6962: foreach my $key (keys(%{$current_permissions})) {
6963: if ($key =~ /\0accesscontrol$/) {
6964: if (defined($group)) {
6965: if ($key !~ m-^\Q$group\E/-) {
6966: next;
6967: }
6968: }
6969: my ($fullpath) = split(/\0/,$key);
6970: if (ref($$current_permissions{$key}) eq 'HASH') {
6971: foreach my $control (keys(%{$$current_permissions{$key}})) {
6972: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
6973: }
6974: }
6975: }
6976: }
6977: }
6978: return %access;
6979: }
6980:
6981: sub modify_access_controls {
6982: my ($file_name,$changes,$domain,$user)=@_;
6983: my ($outcome,$deloutcome);
6984: my %store_permissions;
6985: my %new_values;
6986: my %new_control;
6987: my %translation;
6988: my @deletions = ();
6989: my $now = time;
6990: if (exists($$changes{'activate'})) {
6991: if (ref($$changes{'activate'}) eq 'HASH') {
6992: my @newitems = sort(keys(%{$$changes{'activate'}}));
6993: my $numnew = scalar(@newitems);
6994: for (my $i=0; $i<$numnew; $i++) {
6995: my $newkey = $newitems[$i];
6996: my $newid = &Apache::loncommon::get_cgi_id();
6997: if ($newkey =~ /^\d+:/) {
6998: $newkey =~ s/^(\d+)/$newid/;
6999: $translation{$1} = $newid;
7000: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7001: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7002: $translation{$1} = $newid;
7003: }
7004: $new_values{$file_name."\0".$newkey} =
7005: $$changes{'activate'}{$newitems[$i]};
7006: $new_control{$newkey} = $now;
7007: }
7008: }
7009: }
7010: my %todelete;
7011: my %changed_items;
7012: foreach my $action ('delete','update') {
7013: if (exists($$changes{$action})) {
7014: if (ref($$changes{$action}) eq 'HASH') {
7015: foreach my $key (keys(%{$$changes{$action}})) {
7016: my ($itemnum) = ($key =~ /^([^:]+):/);
7017: if ($action eq 'delete') {
7018: $todelete{$itemnum} = 1;
7019: } else {
7020: $changed_items{$itemnum} = $key;
7021: }
7022: }
7023: }
7024: }
7025: }
7026: # get lock on access controls for file.
7027: my $lockhash = {
7028: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7029: ':'.$env{'user.domain'},
7030: };
7031: my $tries = 0;
7032: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7033:
7034: while (($gotlock ne 'ok') && $tries <3) {
7035: $tries ++;
7036: sleep 1;
7037: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7038: }
7039: if ($gotlock eq 'ok') {
7040: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7041: my ($tmp)=keys(%curr_permissions);
7042: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7043: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7044: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7045: if (ref($curr_controls) eq 'HASH') {
7046: foreach my $control_item (keys(%{$curr_controls})) {
7047: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7048: if (defined($todelete{$itemnum})) {
7049: push(@deletions,$file_name."\0".$control_item);
7050: } else {
7051: if (defined($changed_items{$itemnum})) {
7052: $new_control{$changed_items{$itemnum}} = $now;
7053: push(@deletions,$file_name."\0".$control_item);
7054: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7055: } else {
7056: $new_control{$control_item} = $$curr_controls{$control_item};
7057: }
7058: }
7059: }
7060: }
7061: }
7062: my ($group);
7063: if (&is_course($domain,$user)) {
7064: ($group,my $file) = split(/\//,$file_name,2);
7065: }
7066: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7067: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7068: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7069: # remove lock
7070: my @del_lock = ($file_name."\0".'locked_access_records');
7071: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
7072: my $sqlresult =
7073: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
7074: $group);
7075: } else {
7076: $outcome = "error: could not obtain lockfile\n";
7077: }
7078: return ($outcome,$deloutcome,\%new_values,\%translation);
7079: }
7080:
7081: sub make_public_indefinitely {
7082: my ($requrl) = @_;
7083: my $now = time;
7084: my $action = 'activate';
7085: my $aclnum = 0;
7086: if (&is_portfolio_url($requrl)) {
7087: my (undef,$udom,$unum,$file_name,$group) =
7088: &parse_portfolio_url($requrl);
7089: my $current_perms = &get_portfile_permissions($udom,$unum);
7090: my %access_controls = &get_access_controls($current_perms,
7091: $group,$file_name);
7092: foreach my $key (keys(%{$access_controls{$file_name}})) {
7093: my ($num,$scope,$end,$start) =
7094: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7095: if ($scope eq 'public') {
7096: if ($start <= $now && $end == 0) {
7097: $action = 'none';
7098: } else {
7099: $action = 'update';
7100: $aclnum = $num;
7101: }
7102: last;
7103: }
7104: }
7105: if ($action eq 'none') {
7106: return 'ok';
7107: } else {
7108: my %changes;
7109: my $newend = 0;
7110: my $newstart = $now;
7111: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7112: $changes{$action}{$newkey} = {
7113: type => 'public',
7114: time => {
7115: start => $newstart,
7116: end => $newend,
7117: },
7118: };
7119: my ($outcome,$deloutcome,$new_values,$translation) =
7120: &modify_access_controls($file_name,\%changes,$udom,$unum);
7121: return $outcome;
7122: }
7123: } else {
7124: return 'invalid';
7125: }
7126: }
7127:
7128: #------------------------------------------------------Get Marked as Read Only
7129:
7130: sub get_marked_as_readonly {
7131: my ($domain,$user,$what,$group) = @_;
7132: my $current_permissions = &get_portfile_permissions($domain,$user);
7133: my @readonly_files;
7134: my $cmp1=$what;
7135: if (ref($what)) { $cmp1=join('',@{$what}) };
7136: while (my ($file_name,$value) = each(%{$current_permissions})) {
7137: if (defined($group)) {
7138: if ($file_name !~ m-^\Q$group\E/-) {
7139: next;
7140: }
7141: }
7142: if (ref($value) eq "ARRAY"){
7143: foreach my $stored_what (@{$value}) {
7144: my $cmp2=$stored_what;
7145: if (ref($stored_what) eq 'ARRAY') {
7146: $cmp2=join('',@{$stored_what});
7147: }
7148: if ($cmp1 eq $cmp2) {
7149: push(@readonly_files, $file_name);
7150: last;
7151: } elsif (!defined($what)) {
7152: push(@readonly_files, $file_name);
7153: last;
7154: }
7155: }
7156: }
7157: }
7158: return @readonly_files;
7159: }
7160: #-----------------------------------------------------------Get Marked as Read Only Hash
7161:
7162: sub get_marked_as_readonly_hash {
7163: my ($current_permissions,$group,$what) = @_;
7164: my %readonly_files;
7165: while (my ($file_name,$value) = each(%{$current_permissions})) {
7166: if (defined($group)) {
7167: if ($file_name !~ m-^\Q$group\E/-) {
7168: next;
7169: }
7170: }
7171: if (ref($value) eq "ARRAY"){
7172: foreach my $stored_what (@{$value}) {
7173: if (ref($stored_what) eq 'ARRAY') {
7174: foreach my $lock_descriptor(@{$stored_what}) {
7175: if ($lock_descriptor eq 'graded') {
7176: $readonly_files{$file_name} = 'graded';
7177: } elsif ($lock_descriptor eq 'handback') {
7178: $readonly_files{$file_name} = 'handback';
7179: } else {
7180: if (!exists($readonly_files{$file_name})) {
7181: $readonly_files{$file_name} = 'locked';
7182: }
7183: }
7184: }
7185: }
7186: }
7187: }
7188: }
7189: return %readonly_files;
7190: }
7191: # ------------------------------------------------------------ Unmark as Read Only
7192:
7193: sub unmark_as_readonly {
7194: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7195: # for portfolio submissions, $what contains [$symb,$crsid]
7196: my ($domain,$user,$what,$file_name,$group) = @_;
7197: $file_name = &declutter_portfile($file_name);
7198: my $symb_crs = $what;
7199: if (ref($what)) { $symb_crs=join('',@$what); }
7200: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
7201: my ($tmp)=keys(%current_permissions);
7202: if ($tmp=~/^error:/) { undef(%current_permissions); }
7203: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
7204: foreach my $file (@readonly_files) {
7205: my $clean_file = &declutter_portfile($file);
7206: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
7207: my $current_locks = $current_permissions{$file};
7208: my @new_locks;
7209: my @del_keys;
7210: if (ref($current_locks) eq "ARRAY"){
7211: foreach my $locker (@{$current_locks}) {
7212: my $compare=$locker;
7213: if (ref($locker) eq 'ARRAY') {
7214: $compare=join('',@{$locker});
7215: if ($compare ne $symb_crs) {
7216: push(@new_locks, $locker);
7217: }
7218: }
7219: }
7220: if (scalar(@new_locks) > 0) {
7221: $current_permissions{$file} = \@new_locks;
7222: } else {
7223: push(@del_keys, $file);
7224: &del('file_permissions',\@del_keys, $domain, $user);
7225: delete($current_permissions{$file});
7226: }
7227: }
7228: }
7229: &put('file_permissions',\%current_permissions,$domain,$user);
7230: return;
7231: }
7232:
7233: # ------------------------------------------------------------ Directory lister
7234:
7235: sub dirlist {
7236: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
7237: $uri=~s/^\///;
7238: $uri=~s/\/$//;
7239: my ($udom, $uname);
7240: if ($getuserdir) {
7241: $udom = $userdomain;
7242: $uname = $username;
7243: } else {
7244: (undef,$udom,$uname)=split(/\//,$uri);
7245: if(defined($userdomain)) {
7246: $udom = $userdomain;
7247: }
7248: if(defined($username)) {
7249: $uname = $username;
7250: }
7251: }
7252: my ($dirRoot,$listing,@listing_results);
7253:
7254: $dirRoot = $perlvar{'lonDocRoot'};
7255: if (defined($getpropath)) {
7256: $dirRoot = &propath($udom,$uname);
7257: $dirRoot =~ s/\/$//;
7258: } elsif (defined($getuserdir)) {
7259: my $subdir=$uname.'__';
7260: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7261: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7262: ."/$udom/$subdir/$uname";
7263: } elsif (defined($alternateRoot)) {
7264: $dirRoot = $alternateRoot;
7265: }
7266:
7267: if($udom) {
7268: if($uname) {
7269: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
7270: .$getuserdir.':'.&escape($dirRoot)
7271: .':'.&escape($uname).':'.&escape($udom),
7272: &homeserver($uname,$udom));
7273: if ($listing eq 'unknown_cmd') {
7274: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7275: &homeserver($uname,$udom));
7276: } else {
7277: @listing_results = map { &unescape($_); } split(/:/,$listing);
7278: }
7279: if ($listing eq 'unknown_cmd') {
7280: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7281: &homeserver($uname,$udom));
7282: @listing_results = split(/:/,$listing);
7283: } else {
7284: @listing_results = map { &unescape($_); } split(/:/,$listing);
7285: }
7286: return @listing_results;
7287: } elsif(!$alternateRoot) {
7288: my %allusers;
7289: my %servers = &get_servers($udom,'library');
7290: foreach my $tryserver (keys(%servers)) {
7291: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7292: &escape($udom),$tryserver);
7293: if ($listing eq 'unknown_cmd') {
7294: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7295: $udom, $tryserver);
7296: } else {
7297: @listing_results = map { &unescape($_); } split(/:/,$listing);
7298: }
7299: if ($listing eq 'unknown_cmd') {
7300: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7301: $udom, $tryserver);
7302: @listing_results = split(/:/,$listing);
7303: } else {
7304: @listing_results =
7305: map { &unescape($_); } split(/:/,$listing);
7306: }
7307: if ($listing_results[0] ne 'no_such_dir' &&
7308: $listing_results[0] ne 'empty' &&
7309: $listing_results[0] ne 'con_lost') {
7310: foreach my $line (@listing_results) {
7311: my ($entry) = split(/&/,$line,2);
7312: $allusers{$entry} = 1;
7313: }
7314: }
7315: }
7316: my $alluserstr='';
7317: foreach my $user (sort(keys(%allusers))) {
7318: $alluserstr.=$user.'&user:';
7319: }
7320: $alluserstr=~s/:$//;
7321: return split(/:/,$alluserstr);
7322: } else {
7323: return ('missing user name');
7324: }
7325: } elsif(!defined($getpropath)) {
7326: my @all_domains = sort(&all_domains());
7327: foreach my $domain (@all_domains) {
7328: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7329: }
7330: return @all_domains;
7331: } else {
7332: return ('missing domain');
7333: }
7334: }
7335:
7336: # --------------------------------------------- GetFileTimestamp
7337: # This function utilizes dirlist and returns the date stamp for
7338: # when it was last modified. It will also return an error of -1
7339: # if an error occurs
7340:
7341: sub GetFileTimestamp {
7342: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
7343: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7344: $studentName = &LONCAPA::clean_username($studentName);
7345: my ($fileStat) =
7346: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7347: undef,$getuserdir);
7348: my @stats = split('&', $fileStat);
7349: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7350: # @stats contains first the filename, then the stat output
7351: return $stats[10]; # so this is 10 instead of 9.
7352: } else {
7353: return -1;
7354: }
7355: }
7356:
7357: sub stat_file {
7358: my ($uri) = @_;
7359: $uri = &clutter_with_no_wrapper($uri);
7360:
7361: my ($udom,$uname,$file);
7362: if ($uri =~ m-^/(uploaded|editupload)/-) {
7363: ($udom,$uname,$file) =
7364: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
7365: $file = 'userfiles/'.$file;
7366: }
7367: if ($uri =~ m-^/res/-) {
7368: ($udom,$uname) =
7369: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
7370: $file = $uri;
7371: }
7372:
7373: if (!$udom || !$uname || !$file) {
7374: # unable to handle the uri
7375: return ();
7376: }
7377: my $getpropath;
7378: if ($file =~ /^userfiles\//) {
7379: $getpropath = 1;
7380: }
7381: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
7382: my @stats = split('&', $result);
7383:
7384: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7385: shift(@stats); #filename is first
7386: return @stats;
7387: }
7388: return ();
7389: }
7390:
7391: # -------------------------------------------------------- Value of a Condition
7392:
7393: # gets the value of a specific preevaluated condition
7394: # stored in the string $env{user.state.<cid>}
7395: # or looks up a condition reference in the bighash and if if hasn't
7396: # already been evaluated recurses into docondval to get the value of
7397: # the condition, then memoizing it to
7398: # $env{user.state.<cid>.<condition>}
7399: sub directcondval {
7400: my $number=shift;
7401: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
7402: &Apache::lonuserstate::evalstate();
7403: }
7404: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7405: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7406: } elsif ($number =~ /^_/) {
7407: my $sub_condition;
7408: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7409: &GDBM_READER(),0640)) {
7410: $sub_condition=$bighash{'conditions'.$number};
7411: untie(%bighash);
7412: }
7413: my $value = &docondval($sub_condition);
7414: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
7415: return $value;
7416: }
7417: if ($env{'user.state.'.$env{'request.course.id'}}) {
7418: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
7419: } else {
7420: return 2;
7421: }
7422: }
7423:
7424: # get the collection of conditions for this resource
7425: sub condval {
7426: my $condidx=shift;
7427: my $allpathcond='';
7428: foreach my $cond (split(/\|/,$condidx)) {
7429: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7430: $allpathcond.=
7431: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7432: }
7433: }
7434: $allpathcond=~s/\|$//;
7435: return &docondval($allpathcond);
7436: }
7437:
7438: #evaluates an expression of conditions
7439: sub docondval {
7440: my ($allpathcond) = @_;
7441: my $result=0;
7442: if ($env{'request.course.id'}
7443: && defined($allpathcond)) {
7444: my $operand='|';
7445: my @stack;
7446: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7447: if ($chunk eq '(') {
7448: push @stack,($operand,$result);
7449: } elsif ($chunk eq ')') {
7450: my $before=pop @stack;
7451: if (pop @stack eq '&') {
7452: $result=$result>$before?$before:$result;
7453: } else {
7454: $result=$result>$before?$result:$before;
7455: }
7456: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7457: $operand=$chunk;
7458: } else {
7459: my $new=directcondval($chunk);
7460: if ($operand eq '&') {
7461: $result=$result>$new?$new:$result;
7462: } else {
7463: $result=$result>$new?$result:$new;
7464: }
7465: }
7466: }
7467: }
7468: return $result;
7469: }
7470:
7471: # ---------------------------------------------------- Devalidate courseresdata
7472:
7473: sub devalidatecourseresdata {
7474: my ($coursenum,$coursedomain)=@_;
7475: my $hashid=$coursenum.':'.$coursedomain;
7476: &devalidate_cache_new('courseres',$hashid);
7477: }
7478:
7479:
7480: # --------------------------------------------------- Course Resourcedata Query
7481: #
7482: # Parameters:
7483: # $coursenum - Number of the course.
7484: # $coursedomain - Domain at which the course was created.
7485: # Returns:
7486: # A hash of the course parameters along (I think) with timestamps
7487: # and version info.
7488:
7489: sub get_courseresdata {
7490: my ($coursenum,$coursedomain)=@_;
7491: my $coursehom=&homeserver($coursenum,$coursedomain);
7492: my $hashid=$coursenum.':'.$coursedomain;
7493: my ($result,$cached)=&is_cached_new('courseres',$hashid);
7494: my %dumpreply;
7495: unless (defined($cached)) {
7496: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7497: $result=\%dumpreply;
7498: my ($tmp) = keys(%dumpreply);
7499: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7500: &do_cache_new('courseres',$hashid,$result,600);
7501: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7502: return $tmp;
7503: } elsif ($tmp =~ /^(error)/) {
7504: $result=undef;
7505: &do_cache_new('courseres',$hashid,$result,600);
7506: }
7507: }
7508: return $result;
7509: }
7510:
7511: sub devalidateuserresdata {
7512: my ($uname,$udom)=@_;
7513: my $hashid="$udom:$uname";
7514: &devalidate_cache_new('userres',$hashid);
7515: }
7516:
7517: sub get_userresdata {
7518: my ($uname,$udom)=@_;
7519: #most student don\'t have any data set, check if there is some data
7520: if (&EXT_cache_status($udom,$uname)) { return undef; }
7521:
7522: my $hashid="$udom:$uname";
7523: my ($result,$cached)=&is_cached_new('userres',$hashid);
7524: if (!defined($cached)) {
7525: my %resourcedata=&dump('resourcedata',$udom,$uname);
7526: $result=\%resourcedata;
7527: &do_cache_new('userres',$hashid,$result,600);
7528: }
7529: my ($tmp)=keys(%$result);
7530: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7531: return $result;
7532: }
7533: #error 2 occurs when the .db doesn't exist
7534: if ($tmp!~/error: 2 /) {
7535: &logthis("<font color=\"blue\">WARNING:".
7536: " Trying to get resource data for ".
7537: $uname." at ".$udom.": ".
7538: $tmp."</font>");
7539: } elsif ($tmp=~/error: 2 /) {
7540: #&EXT_cache_set($udom,$uname);
7541: &do_cache_new('userres',$hashid,undef,600);
7542: undef($tmp); # not really an error so don't send it back
7543: }
7544: return $tmp;
7545: }
7546: #----------------------------------------------- resdata - return resource data
7547: # Purpose:
7548: # Return resource data for either users or for a course.
7549: # Parameters:
7550: # $name - Course/user name.
7551: # $domain - Name of the domain the user/course is registered on.
7552: # $type - Type of thing $name is (must be 'course' or 'user'
7553: # @which - Array of names of resources desired.
7554: # Returns:
7555: # The value of the first reasource in @which that is found in the
7556: # resource hash.
7557: # Exceptional Conditions:
7558: # If the $type passed in is not valid (not the string 'course' or
7559: # 'user', an undefined reference is returned.
7560: # If none of the resources are found, an undef is returned
7561: sub resdata {
7562: my ($name,$domain,$type,@which)=@_;
7563: my $result;
7564: if ($type eq 'course') {
7565: $result=&get_courseresdata($name,$domain);
7566: } elsif ($type eq 'user') {
7567: $result=&get_userresdata($name,$domain);
7568: }
7569: if (!ref($result)) { return $result; }
7570: foreach my $item (@which) {
7571: if (defined($result->{$item->[0]})) {
7572: return [$result->{$item->[0]},$item->[1]];
7573: }
7574: }
7575: return undef;
7576: }
7577:
7578: #
7579: # EXT resource caching routines
7580: #
7581:
7582: sub clear_EXT_cache_status {
7583: &delenv('cache.EXT.');
7584: }
7585:
7586: sub EXT_cache_status {
7587: my ($target_domain,$target_user) = @_;
7588: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7589: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7590: # We know already the user has no data
7591: return 1;
7592: } else {
7593: return 0;
7594: }
7595: }
7596:
7597: sub EXT_cache_set {
7598: my ($target_domain,$target_user) = @_;
7599: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7600: #&appenv({$cachename => time});
7601: }
7602:
7603: # --------------------------------------------------------- Value of a Variable
7604: sub EXT {
7605:
7606: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7607: unless ($varname) { return ''; }
7608: #get real user name/domain, courseid and symb
7609: my $courseid;
7610: my $publicuser;
7611: if ($symbparm) {
7612: $symbparm=&get_symb_from_alias($symbparm);
7613: }
7614: if (!($uname && $udom)) {
7615: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7616: if (!$symbparm) { $symbparm=$cursymb; }
7617: } else {
7618: $courseid=$env{'request.course.id'};
7619: }
7620: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7621: my $rest;
7622: if (defined($therest[0])) {
7623: $rest=join('.',@therest);
7624: } else {
7625: $rest='';
7626: }
7627:
7628: my $qualifierrest=$qualifier;
7629: if ($rest) { $qualifierrest.='.'.$rest; }
7630: my $spacequalifierrest=$space;
7631: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7632: if ($realm eq 'user') {
7633: # --------------------------------------------------------------- user.resource
7634: if ($space eq 'resource') {
7635: if ( (defined($Apache::lonhomework::parsing_a_problem)
7636: || defined($Apache::lonhomework::parsing_a_task))
7637: &&
7638: ($symbparm eq &symbread()) ) {
7639: # if we are in the middle of processing the resource the
7640: # get the value we are planning on committing
7641: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7642: return $Apache::lonhomework::results{$qualifierrest};
7643: } else {
7644: return $Apache::lonhomework::history{$qualifierrest};
7645: }
7646: } else {
7647: my %restored;
7648: if ($publicuser || $env{'request.state'} eq 'construct') {
7649: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7650: } else {
7651: %restored=&restore($symbparm,$courseid,$udom,$uname);
7652: }
7653: return $restored{$qualifierrest};
7654: }
7655: # ----------------------------------------------------------------- user.access
7656: } elsif ($space eq 'access') {
7657: # FIXME - not supporting calls for a specific user
7658: return &allowed($qualifier,$rest);
7659: # ------------------------------------------ user.preferences, user.environment
7660: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7661: if (($uname eq $env{'user.name'}) &&
7662: ($udom eq $env{'user.domain'})) {
7663: return $env{join('.',('environment',$qualifierrest))};
7664: } else {
7665: my %returnhash;
7666: if (!$publicuser) {
7667: %returnhash=&userenvironment($udom,$uname,
7668: $qualifierrest);
7669: }
7670: return $returnhash{$qualifierrest};
7671: }
7672: # ----------------------------------------------------------------- user.course
7673: } elsif ($space eq 'course') {
7674: # FIXME - not supporting calls for a specific user
7675: return $env{join('.',('request.course',$qualifier))};
7676: # ------------------------------------------------------------------- user.role
7677: } elsif ($space eq 'role') {
7678: # FIXME - not supporting calls for a specific user
7679: my ($role,$where)=split(/\./,$env{'request.role'});
7680: if ($qualifier eq 'value') {
7681: return $role;
7682: } elsif ($qualifier eq 'extent') {
7683: return $where;
7684: }
7685: # ----------------------------------------------------------------- user.domain
7686: } elsif ($space eq 'domain') {
7687: return $udom;
7688: # ------------------------------------------------------------------- user.name
7689: } elsif ($space eq 'name') {
7690: return $uname;
7691: # ---------------------------------------------------- Any other user namespace
7692: } else {
7693: my %reply;
7694: if (!$publicuser) {
7695: %reply=&get($space,[$qualifierrest],$udom,$uname);
7696: }
7697: return $reply{$qualifierrest};
7698: }
7699: } elsif ($realm eq 'query') {
7700: # ---------------------------------------------- pull stuff out of query string
7701: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7702: [$spacequalifierrest]);
7703: return $env{'form.'.$spacequalifierrest};
7704: } elsif ($realm eq 'request') {
7705: # ------------------------------------------------------------- request.browser
7706: if ($space eq 'browser') {
7707: if ($qualifier eq 'textremote') {
7708: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7709: return 1;
7710: } else {
7711: return 0;
7712: }
7713: } else {
7714: return $env{'browser.'.$qualifier};
7715: }
7716: # ------------------------------------------------------------ request.filename
7717: } else {
7718: return $env{'request.'.$spacequalifierrest};
7719: }
7720: } elsif ($realm eq 'course') {
7721: # ---------------------------------------------------------- course.description
7722: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7723: } elsif ($realm eq 'resource') {
7724:
7725: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7726: if (!$symbparm) { $symbparm=&symbread(); }
7727: }
7728:
7729: if ($space eq 'title') {
7730: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7731: return &gettitle($symbparm);
7732: }
7733:
7734: if ($space eq 'map') {
7735: my ($map) = &decode_symb($symbparm);
7736: return &symbread($map);
7737: }
7738: if ($space eq 'filename') {
7739: if ($symbparm) {
7740: return &clutter((&decode_symb($symbparm))[2]);
7741: }
7742: return &hreflocation('',$env{'request.filename'});
7743: }
7744:
7745: my ($section, $group, @groups);
7746: my ($courselevelm,$courselevel);
7747: if ($symbparm && defined($courseid) &&
7748: $courseid eq $env{'request.course.id'}) {
7749:
7750: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
7751:
7752: # ----------------------------------------------------- Cascading lookup scheme
7753: my $symbp=$symbparm;
7754: my $mapp=&deversion((&decode_symb($symbp))[0]);
7755:
7756: my $symbparm=$symbp.'.'.$spacequalifierrest;
7757: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7758:
7759: if (($env{'user.name'} eq $uname) &&
7760: ($env{'user.domain'} eq $udom)) {
7761: $section=$env{'request.course.sec'};
7762: @groups = split(/:/,$env{'request.course.groups'});
7763: @groups=&sort_course_groups($courseid,@groups);
7764: } else {
7765: if (! defined($usection)) {
7766: $section=&getsection($udom,$uname,$courseid);
7767: } else {
7768: $section = $usection;
7769: }
7770: @groups = &get_users_groups($udom,$uname,$courseid);
7771: }
7772:
7773: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7774: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7775: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7776:
7777: $courselevel=$courseid.'.'.$spacequalifierrest;
7778: my $courselevelr=$courseid.'.'.$symbparm;
7779: $courselevelm=$courseid.'.'.$mapparm;
7780:
7781: # ----------------------------------------------------------- first, check user
7782:
7783: my $userreply=&resdata($uname,$udom,'user',
7784: ([$courselevelr,'resource'],
7785: [$courselevelm,'map' ],
7786: [$courselevel, 'course' ]));
7787: if (defined($userreply)) { return &get_reply($userreply); }
7788:
7789: # ------------------------------------------------ second, check some of course
7790: my $coursereply;
7791: if (@groups > 0) {
7792: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7793: $mapparm,$spacequalifierrest);
7794: if (defined($coursereply)) { return &get_reply($coursereply); }
7795: }
7796:
7797: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7798: $env{'course.'.$courseid.'.domain'},
7799: 'course',
7800: ([$seclevelr, 'resource'],
7801: [$seclevelm, 'map' ],
7802: [$seclevel, 'course' ],
7803: [$courselevelr,'resource']));
7804: if (defined($coursereply)) { return &get_reply($coursereply); }
7805:
7806: # ------------------------------------------------------ third, check map parms
7807: my %parmhash=();
7808: my $thisparm='';
7809: if (tie(%parmhash,'GDBM_File',
7810: $env{'request.course.fn'}.'_parms.db',
7811: &GDBM_READER(),0640)) {
7812: $thisparm=$parmhash{$symbparm};
7813: untie(%parmhash);
7814: }
7815: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
7816: }
7817: # ------------------------------------------ fourth, look in resource metadata
7818:
7819: $spacequalifierrest=~s/\./\_/;
7820: my $filename;
7821: if (!$symbparm) { $symbparm=&symbread(); }
7822: if ($symbparm) {
7823: $filename=(&decode_symb($symbparm))[2];
7824: } else {
7825: $filename=$env{'request.filename'};
7826: }
7827: my $metadata=&metadata($filename,$spacequalifierrest);
7828: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7829: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
7830: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7831:
7832: # ---------------------------------------------- fourth, look in rest of course
7833: if ($symbparm && defined($courseid) &&
7834: $courseid eq $env{'request.course.id'}) {
7835: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7836: $env{'course.'.$courseid.'.domain'},
7837: 'course',
7838: ([$courselevelm,'map' ],
7839: [$courselevel, 'course']));
7840: if (defined($coursereply)) { return &get_reply($coursereply); }
7841: }
7842: # ------------------------------------------------------------------ Cascade up
7843: unless ($space eq '0') {
7844: my @parts=split(/_/,$space);
7845: my $id=pop(@parts);
7846: my $part=join('_',@parts);
7847: if ($part eq '') { $part='0'; }
7848: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
7849: $symbparm,$udom,$uname,$section,1);
7850: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
7851: }
7852: if ($recurse) { return undef; }
7853: my $pack_def=&packages_tab_default($filename,$varname);
7854: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
7855: # ---------------------------------------------------- Any other user namespace
7856: } elsif ($realm eq 'environment') {
7857: # ----------------------------------------------------------------- environment
7858: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7859: return $env{'environment.'.$spacequalifierrest};
7860: } else {
7861: if ($uname eq 'anonymous' && $udom eq '') {
7862: return '';
7863: }
7864: my %returnhash=&userenvironment($udom,$uname,
7865: $spacequalifierrest);
7866: return $returnhash{$spacequalifierrest};
7867: }
7868: } elsif ($realm eq 'system') {
7869: # ----------------------------------------------------------------- system.time
7870: if ($space eq 'time') {
7871: return time;
7872: }
7873: } elsif ($realm eq 'server') {
7874: # ----------------------------------------------------------------- system.time
7875: if ($space eq 'name') {
7876: return $ENV{'SERVER_NAME'};
7877: }
7878: }
7879: return '';
7880: }
7881:
7882: sub get_reply {
7883: my ($reply_value) = @_;
7884: if (ref($reply_value) eq 'ARRAY') {
7885: if (wantarray) {
7886: return @$reply_value;
7887: }
7888: return $reply_value->[0];
7889: } else {
7890: return $reply_value;
7891: }
7892: }
7893:
7894: sub check_group_parms {
7895: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7896: my @groupitems = ();
7897: my $resultitem;
7898: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
7899: foreach my $group (@{$groups}) {
7900: foreach my $level (@levels) {
7901: my $item = $courseid.'.['.$group.'].'.$level->[0];
7902: push(@groupitems,[$item,$level->[1]]);
7903: }
7904: }
7905: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7906: $env{'course.'.$courseid.'.domain'},
7907: 'course',@groupitems);
7908: return $coursereply;
7909: }
7910:
7911: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
7912: my ($courseid,@groups) = @_;
7913: @groups = sort(@groups);
7914: return @groups;
7915: }
7916:
7917: sub packages_tab_default {
7918: my ($uri,$varname)=@_;
7919: my (undef,$part,$name)=split(/\./,$varname);
7920:
7921: my (@extension,@specifics,$do_default);
7922: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
7923: my ($pack_type,$pack_part)=split(/_/,$package,2);
7924: if ($pack_type eq 'default') {
7925: $do_default=1;
7926: } elsif ($pack_type eq 'extension') {
7927: push(@extension,[$package,$pack_type,$pack_part]);
7928: } elsif ($pack_part eq $part || $pack_type eq 'part') {
7929: # only look at packages defaults for packages that this id is
7930: push(@specifics,[$package,$pack_type,$pack_part]);
7931: }
7932: }
7933: # first look for a package that matches the requested part id
7934: foreach my $package (@specifics) {
7935: my (undef,$pack_type,$pack_part)=@{$package};
7936: next if ($pack_part ne $part);
7937: if (defined($packagetab{"$pack_type&$name&default"})) {
7938: return $packagetab{"$pack_type&$name&default"};
7939: }
7940: }
7941: # look for any possible matching non extension_ package
7942: foreach my $package (@specifics) {
7943: my (undef,$pack_type,$pack_part)=@{$package};
7944: if (defined($packagetab{"$pack_type&$name&default"})) {
7945: return $packagetab{"$pack_type&$name&default"};
7946: }
7947: if ($pack_type eq 'part') { $pack_part='0'; }
7948: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7949: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
7950: }
7951: }
7952: # look for any posible extension_ match
7953: foreach my $package (@extension) {
7954: my ($package,$pack_type)=@{$package};
7955: if (defined($packagetab{"$pack_type&$name&default"})) {
7956: return $packagetab{"$pack_type&$name&default"};
7957: }
7958: if (defined($packagetab{$package."&$name&default"})) {
7959: return $packagetab{$package."&$name&default"};
7960: }
7961: }
7962: # look for a global default setting
7963: if ($do_default && defined($packagetab{"default&$name&default"})) {
7964: return $packagetab{"default&$name&default"};
7965: }
7966: return undef;
7967: }
7968:
7969: sub add_prefix_and_part {
7970: my ($prefix,$part)=@_;
7971: my $keyroot;
7972: if (defined($prefix) && $prefix !~ /^__/) {
7973: # prefix that has a part already
7974: $keyroot=$prefix;
7975: } elsif (defined($prefix)) {
7976: # prefix that is missing a part
7977: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
7978: } else {
7979: # no prefix at all
7980: if (defined($part)) { $keyroot='_'.$part; }
7981: }
7982: return $keyroot;
7983: }
7984:
7985: # ---------------------------------------------------------------- Get metadata
7986:
7987: my %metaentry;
7988: sub metadata {
7989: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
7990: $uri=&declutter($uri);
7991: # if it is a non metadata possible uri return quickly
7992: if (($uri eq '') ||
7993: (($uri =~ m|^/*adm/|) &&
7994: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
7995: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
7996: return undef;
7997: }
7998: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
7999: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
8000: return undef;
8001: }
8002: my $filename=$uri;
8003: $uri=~s/\.meta$//;
8004: #
8005: # Is the metadata already cached?
8006: # Look at timestamp of caching
8007: # Everything is cached by the main uri, libraries are never directly cached
8008: #
8009: if (!defined($liburi)) {
8010: my ($result,$cached)=&is_cached_new('meta',$uri);
8011: if (defined($cached)) { return $result->{':'.$what}; }
8012: }
8013: {
8014: #
8015: # Is this a recursive call for a library?
8016: #
8017: # if (! exists($metacache{$uri})) {
8018: # $metacache{$uri}={};
8019: # }
8020: my $cachetime = 60*60;
8021: if ($liburi) {
8022: $liburi=&declutter($liburi);
8023: $filename=$liburi;
8024: } else {
8025: &devalidate_cache_new('meta',$uri);
8026: undef(%metaentry);
8027: }
8028: my %metathesekeys=();
8029: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
8030: my $metastring;
8031: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
8032: my $which = &hreflocation('','/'.($liburi || $uri));
8033: $metastring =
8034: &Apache::lonnet::ssi_body($which,
8035: ('grade_target' => 'meta'));
8036: $cachetime = 1; # only want this cached in the child not long term
8037: } elsif ($uri !~ m -^(editupload)/-) {
8038: my $file=&filelocation('',&clutter($filename));
8039: #push(@{$metaentry{$uri.'.file'}},$file);
8040: $metastring=&getfile($file);
8041: }
8042: my $parser=HTML::LCParser->new(\$metastring);
8043: my $token;
8044: undef %metathesekeys;
8045: while ($token=$parser->get_token) {
8046: if ($token->[0] eq 'S') {
8047: if (defined($token->[2]->{'package'})) {
8048: #
8049: # This is a package - get package info
8050: #
8051: my $package=$token->[2]->{'package'};
8052: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8053: if (defined($token->[2]->{'id'})) {
8054: $keyroot.='_'.$token->[2]->{'id'};
8055: }
8056: if ($metaentry{':packages'}) {
8057: $metaentry{':packages'}.=','.$package.$keyroot;
8058: } else {
8059: $metaentry{':packages'}=$package.$keyroot;
8060: }
8061: foreach my $pack_entry (keys(%packagetab)) {
8062: my $part=$keyroot;
8063: $part=~s/^\_//;
8064: if ($pack_entry=~/^\Q$package\E\&/ ||
8065: $pack_entry=~/^\Q$package\E_0\&/) {
8066: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
8067: # ignore package.tab specified default values
8068: # here &package_tab_default() will fetch those
8069: if ($subp eq 'default') { next; }
8070: my $value=$packagetab{$pack_entry};
8071: my $unikey;
8072: if ($pack =~ /_0$/) {
8073: $unikey='parameter_0_'.$name;
8074: $part=0;
8075: } else {
8076: $unikey='parameter'.$keyroot.'_'.$name;
8077: }
8078: if ($subp eq 'display') {
8079: $value.=' [Part: '.$part.']';
8080: }
8081: $metaentry{':'.$unikey.'.part'}=$part;
8082: $metathesekeys{$unikey}=1;
8083: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8084: $metaentry{':'.$unikey.'.'.$subp}=$value;
8085: }
8086: if (defined($metaentry{':'.$unikey.'.default'})) {
8087: $metaentry{':'.$unikey}=
8088: $metaentry{':'.$unikey.'.default'};
8089: }
8090: }
8091: }
8092: } else {
8093: #
8094: # This is not a package - some other kind of start tag
8095: #
8096: my $entry=$token->[1];
8097: my $unikey;
8098: if ($entry eq 'import') {
8099: $unikey='';
8100: } else {
8101: $unikey=$entry;
8102: }
8103: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8104:
8105: if (defined($token->[2]->{'id'})) {
8106: $unikey.='_'.$token->[2]->{'id'};
8107: }
8108:
8109: if ($entry eq 'import') {
8110: #
8111: # Importing a library here
8112: #
8113: if ($depthcount<20) {
8114: my $location=$parser->get_text('/import');
8115: my $dir=$filename;
8116: $dir=~s|[^/]*$||;
8117: $location=&filelocation($dir,$location);
8118: my $metadata =
8119: &metadata($uri,'keys', $location,$unikey,
8120: $depthcount+1);
8121: foreach my $meta (split(',',$metadata)) {
8122: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8123: $metathesekeys{$meta}=1;
8124: }
8125: }
8126: } else {
8127:
8128: if (defined($token->[2]->{'name'})) {
8129: $unikey.='_'.$token->[2]->{'name'};
8130: }
8131: $metathesekeys{$unikey}=1;
8132: foreach my $param (@{$token->[3]}) {
8133: $metaentry{':'.$unikey.'.'.$param} =
8134: $token->[2]->{$param};
8135: }
8136: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
8137: my $default=$metaentry{':'.$unikey.'.default'};
8138: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8139: # only ws inside the tag, and not in default, so use default
8140: # as value
8141: $metaentry{':'.$unikey}=$default;
8142: } elsif ( $internaltext =~ /\S/ ) {
8143: # something interesting inside the tag
8144: $metaentry{':'.$unikey}=$internaltext;
8145: } else {
8146: # no interesting values, don't set a default
8147: }
8148: # end of not-a-package not-a-library import
8149: }
8150: # end of not-a-package start tag
8151: }
8152: # the next is the end of "start tag"
8153: }
8154: }
8155: my ($extension) = ($uri =~ /\.(\w+)$/);
8156: $extension = lc($extension);
8157: if ($extension eq 'htm') { $extension='html'; }
8158:
8159: foreach my $key (keys(%packagetab)) {
8160: #no specific packages #how's our extension
8161: if ($key!~/^extension_\Q$extension\E&/) { next; }
8162: &metadata_create_package_def($uri,$key,'extension_'.$extension,
8163: \%metathesekeys);
8164: }
8165:
8166: if (!exists($metaentry{':packages'})
8167: || $packagetab{"import_defaults&extension_$extension"}) {
8168: foreach my $key (keys(%packagetab)) {
8169: #no specific packages well let's get default then
8170: if ($key!~/^default&/) { next; }
8171: &metadata_create_package_def($uri,$key,'default',
8172: \%metathesekeys);
8173: }
8174: }
8175: # are there custom rights to evaluate
8176: if ($metaentry{':copyright'} eq 'custom') {
8177:
8178: #
8179: # Importing a rights file here
8180: #
8181: unless ($depthcount) {
8182: my $location=$metaentry{':customdistributionfile'};
8183: my $dir=$filename;
8184: $dir=~s|[^/]*$||;
8185: $location=&filelocation($dir,$location);
8186: my $rights_metadata =
8187: &metadata($uri,'keys',$location,'_rights',
8188: $depthcount+1);
8189: foreach my $rights (split(',',$rights_metadata)) {
8190: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8191: $metathesekeys{$rights}=1;
8192: }
8193: }
8194: }
8195: # uniqifiy package listing
8196: my %seen;
8197: my @uniq_packages =
8198: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8199: $metaentry{':packages'} = join(',',@uniq_packages);
8200:
8201: $metaentry{':keys'} = join(',',keys(%metathesekeys));
8202: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8203: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
8204: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
8205: # this is the end of "was not already recently cached
8206: }
8207: return $metaentry{':'.$what};
8208: }
8209:
8210: sub metadata_create_package_def {
8211: my ($uri,$key,$package,$metathesekeys)=@_;
8212: my ($pack,$name,$subp)=split(/\&/,$key);
8213: if ($subp eq 'default') { next; }
8214:
8215: if (defined($metaentry{':packages'})) {
8216: $metaentry{':packages'}.=','.$package;
8217: } else {
8218: $metaentry{':packages'}=$package;
8219: }
8220: my $value=$packagetab{$key};
8221: my $unikey;
8222: $unikey='parameter_0_'.$name;
8223: $metaentry{':'.$unikey.'.part'}=0;
8224: $$metathesekeys{$unikey}=1;
8225: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8226: $metaentry{':'.$unikey.'.'.$subp}=$value;
8227: }
8228: if (defined($metaentry{':'.$unikey.'.default'})) {
8229: $metaentry{':'.$unikey}=
8230: $metaentry{':'.$unikey.'.default'};
8231: }
8232: }
8233:
8234: sub metadata_generate_part0 {
8235: my ($metadata,$metacache,$uri) = @_;
8236: my %allnames;
8237: foreach my $metakey (keys(%$metadata)) {
8238: if ($metakey=~/^parameter\_(.*)/) {
8239: my $part=$$metacache{':'.$metakey.'.part'};
8240: my $name=$$metacache{':'.$metakey.'.name'};
8241: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
8242: $allnames{$name}=$part;
8243: }
8244: }
8245: }
8246: foreach my $name (keys(%allnames)) {
8247: $$metadata{"parameter_0_$name"}=1;
8248: my $key=":parameter_0_$name";
8249: $$metacache{"$key.part"}='0';
8250: $$metacache{"$key.name"}=$name;
8251: $$metacache{"$key.type"}=$$metacache{':parameter_'.
8252: $allnames{$name}.'_'.$name.
8253: '.type'};
8254: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
8255: '.display'};
8256: my $expr='[Part: '.$allnames{$name}.']';
8257: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
8258: $$metacache{"$key.display"}=$olddis;
8259: }
8260: }
8261:
8262: # ------------------------------------------------------ Devalidate title cache
8263:
8264: sub devalidate_title_cache {
8265: my ($url)=@_;
8266: if (!$env{'request.course.id'}) { return; }
8267: my $symb=&symbread($url);
8268: if (!$symb) { return; }
8269: my $key=$env{'request.course.id'}."\0".$symb;
8270: &devalidate_cache_new('title',$key);
8271: }
8272:
8273: # ------------------------------------------------- Get the title of a course
8274:
8275: sub current_course_title {
8276: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8277: }
8278: # ------------------------------------------------- Get the title of a resource
8279:
8280: sub gettitle {
8281: my $urlsymb=shift;
8282: my $symb=&symbread($urlsymb);
8283: if ($symb) {
8284: my $key=$env{'request.course.id'}."\0".$symb;
8285: my ($result,$cached)=&is_cached_new('title',$key);
8286: if (defined($cached)) {
8287: return $result;
8288: }
8289: my ($map,$resid,$url)=&decode_symb($symb);
8290: my $title='';
8291: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8292: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8293: } else {
8294: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8295: &GDBM_READER(),0640)) {
8296: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8297: $title=$bighash{'title_'.$mapid.'.'.$resid};
8298: untie(%bighash);
8299: }
8300: }
8301: $title=~s/\&colon\;/\:/gs;
8302: if ($title) {
8303: return &do_cache_new('title',$key,$title,600);
8304: }
8305: $urlsymb=$url;
8306: }
8307: my $title=&metadata($urlsymb,'title');
8308: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8309: return $title;
8310: }
8311:
8312: sub get_slot {
8313: my ($which,$cnum,$cdom)=@_;
8314: if (!$cnum || !$cdom) {
8315: (undef,my $courseid)=&whichuser();
8316: $cdom=$env{'course.'.$courseid.'.domain'};
8317: $cnum=$env{'course.'.$courseid.'.num'};
8318: }
8319: my $key=join("\0",'slots',$cdom,$cnum,$which);
8320: my %slotinfo;
8321: if (exists($remembered{$key})) {
8322: $slotinfo{$which} = $remembered{$key};
8323: } else {
8324: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8325: &Apache::lonhomework::showhash(%slotinfo);
8326: my ($tmp)=keys(%slotinfo);
8327: if ($tmp=~/^error:/) { return (); }
8328: $remembered{$key} = $slotinfo{$which};
8329: }
8330: if (ref($slotinfo{$which}) eq 'HASH') {
8331: return %{$slotinfo{$which}};
8332: }
8333: return $slotinfo{$which};
8334: }
8335: # ------------------------------------------------- Update symbolic store links
8336:
8337: sub symblist {
8338: my ($mapname,%newhash)=@_;
8339: $mapname=&deversion(&declutter($mapname));
8340: my %hash;
8341: if (($env{'request.course.fn'}) && (%newhash)) {
8342: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8343: &GDBM_WRCREAT(),0640)) {
8344: foreach my $url (keys(%newhash)) {
8345: next if ($url eq 'last_known'
8346: && $env{'form.no_update_last_known'});
8347: $hash{declutter($url)}=&encode_symb($mapname,
8348: $newhash{$url}->[1],
8349: $newhash{$url}->[0]);
8350: }
8351: if (untie(%hash)) {
8352: return 'ok';
8353: }
8354: }
8355: }
8356: return 'error';
8357: }
8358:
8359: # --------------------------------------------------------------- Verify a symb
8360:
8361: sub symbverify {
8362: my ($symb,$thisurl)=@_;
8363: my $thisfn=$thisurl;
8364: $thisfn=&declutter($thisfn);
8365: # direct jump to resource in page or to a sequence - will construct own symbs
8366: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8367: # check URL part
8368: my ($map,$resid,$url)=&decode_symb($symb);
8369:
8370: unless ($url eq $thisfn) { return 0; }
8371:
8372: $symb=&symbclean($symb);
8373: $thisurl=&deversion($thisurl);
8374: $thisfn=&deversion($thisfn);
8375:
8376: my %bighash;
8377: my $okay=0;
8378:
8379: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8380: &GDBM_READER(),0640)) {
8381: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8382: $thisurl =~ s/\?.+$//;
8383: }
8384: my $ids=$bighash{'ids_'.&clutter($thisurl)};
8385: unless ($ids) {
8386: $ids=$bighash{'ids_/'.$thisurl};
8387: }
8388: if ($ids) {
8389: # ------------------------------------------------------------------- Has ID(s)
8390: foreach my $id (split(/\,/,$ids)) {
8391: my ($mapid,$resid)=split(/\./,$id);
8392: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8393: $symb =~ s/\?.+$//;
8394: }
8395: if (
8396: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8397: eq $symb) {
8398: if (($env{'request.role.adv'}) ||
8399: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
8400: $okay=1;
8401: }
8402: }
8403: }
8404: }
8405: untie(%bighash);
8406: }
8407: return $okay;
8408: }
8409:
8410: # --------------------------------------------------------------- Clean-up symb
8411:
8412: sub symbclean {
8413: my $symb=shift;
8414: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8415: # remove version from map
8416: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
8417:
8418: # remove version from URL
8419: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
8420:
8421: # remove wrapper
8422:
8423: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
8424: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
8425: return $symb;
8426: }
8427:
8428: # ---------------------------------------------- Split symb to find map and url
8429:
8430: sub encode_symb {
8431: my ($map,$resid,$url)=@_;
8432: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8433: }
8434:
8435: sub decode_symb {
8436: my $symb=shift;
8437: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8438: my ($map,$resid,$url)=split(/___/,$symb);
8439: return (&fixversion($map),$resid,&fixversion($url));
8440: }
8441:
8442: sub fixversion {
8443: my $fn=shift;
8444: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
8445: my %bighash;
8446: my $uri=&clutter($fn);
8447: my $key=$env{'request.course.id'}.'_'.$uri;
8448: # is this cached?
8449: my ($result,$cached)=&is_cached_new('courseresversion',$key);
8450: if (defined($cached)) { return $result; }
8451: # unfortunately not cached, or expired
8452: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8453: &GDBM_READER(),0640)) {
8454: if ($bighash{'version_'.$uri}) {
8455: my $version=$bighash{'version_'.$uri};
8456: unless (($version eq 'mostrecent') ||
8457: ($version==&getversion($uri))) {
8458: $uri=~s/\.(\w+)$/\.$version\.$1/;
8459: }
8460: }
8461: untie %bighash;
8462: }
8463: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
8464: }
8465:
8466: sub deversion {
8467: my $url=shift;
8468: $url=~s/\.\d+\.(\w+)$/\.$1/;
8469: return $url;
8470: }
8471:
8472: # ------------------------------------------------------ Return symb list entry
8473:
8474: sub symbread {
8475: my ($thisfn,$donotrecurse)=@_;
8476: my $cache_str='request.symbread.cached.'.$thisfn;
8477: if (defined($env{$cache_str})) { return $env{$cache_str}; }
8478: # no filename provided? try from environment
8479: unless ($thisfn) {
8480: if ($env{'request.symb'}) {
8481: return $env{$cache_str}=&symbclean($env{'request.symb'});
8482: }
8483: $thisfn=$env{'request.filename'};
8484: }
8485: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8486: # is that filename actually a symb? Verify, clean, and return
8487: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
8488: if (&symbverify($thisfn,$1)) {
8489: return $env{$cache_str}=&symbclean($thisfn);
8490: }
8491: }
8492: $thisfn=declutter($thisfn);
8493: my %hash;
8494: my %bighash;
8495: my $syval='';
8496: if (($env{'request.course.fn'}) && ($thisfn)) {
8497: my $targetfn = $thisfn;
8498: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
8499: $targetfn = 'adm/wrapper/'.$thisfn;
8500: }
8501: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8502: $targetfn=$1;
8503: }
8504: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8505: &GDBM_READER(),0640)) {
8506: $syval=$hash{$targetfn};
8507: untie(%hash);
8508: }
8509: # ---------------------------------------------------------- There was an entry
8510: if ($syval) {
8511: #unless ($syval=~/\_\d+$/) {
8512: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8513: #&appenv({'request.ambiguous' => $thisfn});
8514: #return $env{$cache_str}='';
8515: #}
8516: #$syval.=$1;
8517: #}
8518: } else {
8519: # ------------------------------------------------------- Was not in symb table
8520: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8521: &GDBM_READER(),0640)) {
8522: # ---------------------------------------------- Get ID(s) for current resource
8523: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8524: unless ($ids) {
8525: $ids=$bighash{'ids_/'.$thisfn};
8526: }
8527: unless ($ids) {
8528: # alias?
8529: $ids=$bighash{'mapalias_'.$thisfn};
8530: }
8531: if ($ids) {
8532: # ------------------------------------------------------------------- Has ID(s)
8533: my @possibilities=split(/\,/,$ids);
8534: if ($#possibilities==0) {
8535: # ----------------------------------------------- There is only one possibility
8536: my ($mapid,$resid)=split(/\./,$ids);
8537: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8538: $resid,$thisfn);
8539: } elsif (!$donotrecurse) {
8540: # ------------------------------------------ There is more than one possibility
8541: my $realpossible=0;
8542: foreach my $id (@possibilities) {
8543: my $file=$bighash{'src_'.$id};
8544: if (&allowed('bre',$file)) {
8545: my ($mapid,$resid)=split(/\./,$id);
8546: if ($bighash{'map_type_'.$mapid} ne 'page') {
8547: $realpossible++;
8548: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8549: $resid,$thisfn);
8550: }
8551: }
8552: }
8553: if ($realpossible!=1) { $syval=''; }
8554: } else {
8555: $syval='';
8556: }
8557: }
8558: untie(%bighash)
8559: }
8560: }
8561: if ($syval) {
8562: return $env{$cache_str}=$syval;
8563: }
8564: }
8565: &appenv({'request.ambiguous' => $thisfn});
8566: return $env{$cache_str}='';
8567: }
8568:
8569: # ---------------------------------------------------------- Return random seed
8570:
8571: sub numval {
8572: my $txt=shift;
8573: $txt=~tr/A-J/0-9/;
8574: $txt=~tr/a-j/0-9/;
8575: $txt=~tr/K-T/0-9/;
8576: $txt=~tr/k-t/0-9/;
8577: $txt=~tr/U-Z/0-5/;
8578: $txt=~tr/u-z/0-5/;
8579: $txt=~s/\D//g;
8580: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8581: return int($txt);
8582: }
8583:
8584: sub numval2 {
8585: my $txt=shift;
8586: $txt=~tr/A-J/0-9/;
8587: $txt=~tr/a-j/0-9/;
8588: $txt=~tr/K-T/0-9/;
8589: $txt=~tr/k-t/0-9/;
8590: $txt=~tr/U-Z/0-5/;
8591: $txt=~tr/u-z/0-5/;
8592: $txt=~s/\D//g;
8593: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8594: my $total;
8595: foreach my $val (@txts) { $total+=$val; }
8596: if ($_64bit) { if ($total > 2**32) { return -1; } }
8597: return int($total);
8598: }
8599:
8600: sub numval3 {
8601: use integer;
8602: my $txt=shift;
8603: $txt=~tr/A-J/0-9/;
8604: $txt=~tr/a-j/0-9/;
8605: $txt=~tr/K-T/0-9/;
8606: $txt=~tr/k-t/0-9/;
8607: $txt=~tr/U-Z/0-5/;
8608: $txt=~tr/u-z/0-5/;
8609: $txt=~s/\D//g;
8610: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8611: my $total;
8612: foreach my $val (@txts) { $total+=$val; }
8613: if ($_64bit) { $total=(($total<<32)>>32); }
8614: return $total;
8615: }
8616:
8617: sub digest {
8618: my ($data)=@_;
8619: my $digest=&Digest::MD5::md5($data);
8620: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8621: my ($e,$f);
8622: {
8623: use integer;
8624: $e=($a+$b);
8625: $f=($c+$d);
8626: if ($_64bit) {
8627: $e=(($e<<32)>>32);
8628: $f=(($f<<32)>>32);
8629: }
8630: }
8631: if (wantarray) {
8632: return ($e,$f);
8633: } else {
8634: my $g;
8635: {
8636: use integer;
8637: $g=($e+$f);
8638: if ($_64bit) {
8639: $g=(($g<<32)>>32);
8640: }
8641: }
8642: return $g;
8643: }
8644: }
8645:
8646: sub latest_rnd_algorithm_id {
8647: return '64bit5';
8648: }
8649:
8650: sub get_rand_alg {
8651: my ($courseid)=@_;
8652: if (!$courseid) { $courseid=(&whichuser())[1]; }
8653: if ($courseid) {
8654: return $env{"course.$courseid.rndseed"};
8655: }
8656: return &latest_rnd_algorithm_id();
8657: }
8658:
8659: sub validCODE {
8660: my ($CODE)=@_;
8661: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8662: return 0;
8663: }
8664:
8665: sub getCODE {
8666: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8667: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8668: defined($Apache::lonhomework::parsing_a_task) ) &&
8669: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8670: return $Apache::lonhomework::history{'resource.CODE'};
8671: }
8672: return undef;
8673: }
8674:
8675: sub rndseed {
8676: my ($symb,$courseid,$domain,$username)=@_;
8677: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8678: if (!defined($symb)) {
8679: unless ($symb=$wsymb) { return time; }
8680: }
8681: if (!$courseid) { $courseid=$wcourseid; }
8682: if (!$domain) { $domain=$wdomain; }
8683: if (!$username) { $username=$wusername }
8684: my $which=&get_rand_alg();
8685:
8686: if (defined(&getCODE())) {
8687: if ($which eq '64bit5') {
8688: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8689: } elsif ($which eq '64bit4') {
8690: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8691: } else {
8692: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8693: }
8694: } elsif ($which eq '64bit5') {
8695: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8696: } elsif ($which eq '64bit4') {
8697: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8698: } elsif ($which eq '64bit3') {
8699: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8700: } elsif ($which eq '64bit2') {
8701: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8702: } elsif ($which eq '64bit') {
8703: return &rndseed_64bit($symb,$courseid,$domain,$username);
8704: }
8705: return &rndseed_32bit($symb,$courseid,$domain,$username);
8706: }
8707:
8708: sub rndseed_32bit {
8709: my ($symb,$courseid,$domain,$username)=@_;
8710: {
8711: use integer;
8712: my $symbchck=unpack("%32C*",$symb) << 27;
8713: my $symbseed=numval($symb) << 22;
8714: my $namechck=unpack("%32C*",$username) << 17;
8715: my $nameseed=numval($username) << 12;
8716: my $domainseed=unpack("%32C*",$domain) << 7;
8717: my $courseseed=unpack("%32C*",$courseid);
8718: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8719: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8720: #&logthis("rndseed :$num:$symb");
8721: if ($_64bit) { $num=(($num<<32)>>32); }
8722: return $num;
8723: }
8724: }
8725:
8726: sub rndseed_64bit {
8727: my ($symb,$courseid,$domain,$username)=@_;
8728: {
8729: use integer;
8730: my $symbchck=unpack("%32S*",$symb) << 21;
8731: my $symbseed=numval($symb) << 10;
8732: my $namechck=unpack("%32S*",$username);
8733:
8734: my $nameseed=numval($username) << 21;
8735: my $domainseed=unpack("%32S*",$domain) << 10;
8736: my $courseseed=unpack("%32S*",$courseid);
8737:
8738: my $num1=$symbchck+$symbseed+$namechck;
8739: my $num2=$nameseed+$domainseed+$courseseed;
8740: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8741: #&logthis("rndseed :$num:$symb");
8742: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8743: return "$num1,$num2";
8744: }
8745: }
8746:
8747: sub rndseed_64bit2 {
8748: my ($symb,$courseid,$domain,$username)=@_;
8749: {
8750: use integer;
8751: # strings need to be an even # of cahracters long, it it is odd the
8752: # last characters gets thrown away
8753: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8754: my $symbseed=numval($symb) << 10;
8755: my $namechck=unpack("%32S*",$username.' ');
8756:
8757: my $nameseed=numval($username) << 21;
8758: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8759: my $courseseed=unpack("%32S*",$courseid.' ');
8760:
8761: my $num1=$symbchck+$symbseed+$namechck;
8762: my $num2=$nameseed+$domainseed+$courseseed;
8763: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8764: #&logthis("rndseed :$num:$symb");
8765: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8766: return "$num1,$num2";
8767: }
8768: }
8769:
8770: sub rndseed_64bit3 {
8771: my ($symb,$courseid,$domain,$username)=@_;
8772: {
8773: use integer;
8774: # strings need to be an even # of cahracters long, it it is odd the
8775: # last characters gets thrown away
8776: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8777: my $symbseed=numval2($symb) << 10;
8778: my $namechck=unpack("%32S*",$username.' ');
8779:
8780: my $nameseed=numval2($username) << 21;
8781: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8782: my $courseseed=unpack("%32S*",$courseid.' ');
8783:
8784: my $num1=$symbchck+$symbseed+$namechck;
8785: my $num2=$nameseed+$domainseed+$courseseed;
8786: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8787: #&logthis("rndseed :$num1:$num2:$_64bit");
8788: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8789:
8790: return "$num1:$num2";
8791: }
8792: }
8793:
8794: sub rndseed_64bit4 {
8795: my ($symb,$courseid,$domain,$username)=@_;
8796: {
8797: use integer;
8798: # strings need to be an even # of cahracters long, it it is odd the
8799: # last characters gets thrown away
8800: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8801: my $symbseed=numval3($symb) << 10;
8802: my $namechck=unpack("%32S*",$username.' ');
8803:
8804: my $nameseed=numval3($username) << 21;
8805: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8806: my $courseseed=unpack("%32S*",$courseid.' ');
8807:
8808: my $num1=$symbchck+$symbseed+$namechck;
8809: my $num2=$nameseed+$domainseed+$courseseed;
8810: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8811: #&logthis("rndseed :$num1:$num2:$_64bit");
8812: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8813:
8814: return "$num1:$num2";
8815: }
8816: }
8817:
8818: sub rndseed_64bit5 {
8819: my ($symb,$courseid,$domain,$username)=@_;
8820: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8821: return "$num1:$num2";
8822: }
8823:
8824: sub rndseed_CODE_64bit {
8825: my ($symb,$courseid,$domain,$username)=@_;
8826: {
8827: use integer;
8828: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8829: my $symbseed=numval2($symb);
8830: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8831: my $CODEseed=numval(&getCODE());
8832: my $courseseed=unpack("%32S*",$courseid.' ');
8833: my $num1=$symbseed+$CODEchck;
8834: my $num2=$CODEseed+$courseseed+$symbchck;
8835: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8836: #&logthis("rndseed :$num1:$num2:$symb");
8837: if ($_64bit) { $num1=(($num1<<32)>>32); }
8838: if ($_64bit) { $num2=(($num2<<32)>>32); }
8839: return "$num1:$num2";
8840: }
8841: }
8842:
8843: sub rndseed_CODE_64bit4 {
8844: my ($symb,$courseid,$domain,$username)=@_;
8845: {
8846: use integer;
8847: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8848: my $symbseed=numval3($symb);
8849: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8850: my $CODEseed=numval3(&getCODE());
8851: my $courseseed=unpack("%32S*",$courseid.' ');
8852: my $num1=$symbseed+$CODEchck;
8853: my $num2=$CODEseed+$courseseed+$symbchck;
8854: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8855: #&logthis("rndseed :$num1:$num2:$symb");
8856: if ($_64bit) { $num1=(($num1<<32)>>32); }
8857: if ($_64bit) { $num2=(($num2<<32)>>32); }
8858: return "$num1:$num2";
8859: }
8860: }
8861:
8862: sub rndseed_CODE_64bit5 {
8863: my ($symb,$courseid,$domain,$username)=@_;
8864: my $code = &getCODE();
8865: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8866: return "$num1:$num2";
8867: }
8868:
8869: sub setup_random_from_rndseed {
8870: my ($rndseed)=@_;
8871: if ($rndseed =~/([,:])/) {
8872: my ($num1,$num2)=split(/[,:]/,$rndseed);
8873: &Math::Random::random_set_seed(abs($num1),abs($num2));
8874: } else {
8875: &Math::Random::random_set_seed_from_phrase($rndseed);
8876: }
8877: }
8878:
8879: sub latest_receipt_algorithm_id {
8880: return 'receipt3';
8881: }
8882:
8883: sub recunique {
8884: my $fucourseid=shift;
8885: my $unique;
8886: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8887: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8888: $unique=$env{"course.$fucourseid.internal.encseed"};
8889: } else {
8890: $unique=$perlvar{'lonReceipt'};
8891: }
8892: return unpack("%32C*",$unique);
8893: }
8894:
8895: sub recprefix {
8896: my $fucourseid=shift;
8897: my $prefix;
8898: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8899: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8900: $prefix=$env{"course.$fucourseid.internal.encpref"};
8901: } else {
8902: $prefix=$perlvar{'lonHostID'};
8903: }
8904: return unpack("%32C*",$prefix);
8905: }
8906:
8907: sub ireceipt {
8908: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
8909:
8910: my $return =&recprefix($fucourseid).'-';
8911:
8912: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8913: $env{'request.state'} eq 'construct') {
8914: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8915: return $return;
8916: }
8917:
8918: my $cuname=unpack("%32C*",$funame);
8919: my $cudom=unpack("%32C*",$fudom);
8920: my $cucourseid=unpack("%32C*",$fucourseid);
8921: my $cusymb=unpack("%32C*",$fusymb);
8922: my $cunique=&recunique($fucourseid);
8923: my $cpart=unpack("%32S*",$part);
8924: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8925:
8926: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
8927:
8928: $return.= ($cunique%$cuname+
8929: $cunique%$cudom+
8930: $cusymb%$cuname+
8931: $cusymb%$cudom+
8932: $cucourseid%$cuname+
8933: $cucourseid%$cudom+
8934: $cpart%$cuname+
8935: $cpart%$cudom);
8936: } else {
8937: $return.= ($cunique%$cuname+
8938: $cunique%$cudom+
8939: $cusymb%$cuname+
8940: $cusymb%$cudom+
8941: $cucourseid%$cuname+
8942: $cucourseid%$cudom);
8943: }
8944: return $return;
8945: }
8946:
8947: sub receipt {
8948: my ($part)=@_;
8949: my ($symb,$courseid,$domain,$name) = &whichuser();
8950: return &ireceipt($name,$domain,$courseid,$symb,$part);
8951: }
8952:
8953: sub whichuser {
8954: my ($passedsymb)=@_;
8955: my ($symb,$courseid,$domain,$name,$publicuser);
8956: if (defined($env{'form.grade_symb'})) {
8957: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8958: my $allowed=&allowed('vgr',$tmp_courseid);
8959: if (!$allowed &&
8960: exists($env{'request.course.sec'}) &&
8961: $env{'request.course.sec'} !~ /^\s*$/) {
8962: $allowed=&allowed('vgr',$tmp_courseid.
8963: '/'.$env{'request.course.sec'});
8964: }
8965: if ($allowed) {
8966: ($symb)=&get_env_multiple('form.grade_symb');
8967: $courseid=$tmp_courseid;
8968: ($domain)=&get_env_multiple('form.grade_domain');
8969: ($name)=&get_env_multiple('form.grade_username');
8970: return ($symb,$courseid,$domain,$name,$publicuser);
8971: }
8972: }
8973: if (!$passedsymb) {
8974: $symb=&symbread();
8975: } else {
8976: $symb=$passedsymb;
8977: }
8978: $courseid=$env{'request.course.id'};
8979: $domain=$env{'user.domain'};
8980: $name=$env{'user.name'};
8981: if ($name eq 'public' && $domain eq 'public') {
8982: if (!defined($env{'form.username'})) {
8983: $env{'form.username'}.=time.rand(10000000);
8984: }
8985: $name.=$env{'form.username'};
8986: }
8987: return ($symb,$courseid,$domain,$name,$publicuser);
8988:
8989: }
8990:
8991: # ------------------------------------------------------------ Serves up a file
8992: # returns either the contents of the file or
8993: # -1 if the file doesn't exist
8994: #
8995: # if the target is a file that was uploaded via DOCS,
8996: # a check will be made to see if a current copy exists on the local server,
8997: # if it does this will be served, otherwise a copy will be retrieved from
8998: # the home server for the course and stored in /home/httpd/html/userfiles on
8999: # the local server.
9000:
9001: sub getfile {
9002: my ($file) = @_;
9003: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9004: &repcopy($file);
9005: return &readfile($file);
9006: }
9007:
9008: sub repcopy_userfile {
9009: my ($file)=@_;
9010: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9011: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
9012: my ($cdom,$cnum,$filename) =
9013: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
9014: my $uri="/uploaded/$cdom/$cnum/$filename";
9015: if (-e "$file") {
9016: # we already have a local copy, check it out
9017: my @fileinfo = stat($file);
9018: my $rtncode;
9019: my $info;
9020: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
9021: if ($lwpresp ne 'ok') {
9022: # there is no such file anymore, even though we had a local copy
9023: if ($rtncode eq '404') {
9024: unlink($file);
9025: }
9026: return -1;
9027: }
9028: if ($info < $fileinfo[9]) {
9029: # nice, the file we have is up-to-date, just say okay
9030: return 'ok';
9031: } else {
9032: # the file is outdated, get rid of it
9033: unlink($file);
9034: }
9035: }
9036: # one way or the other, at this point, we don't have the file
9037: # construct the correct path for the file
9038: my @parts = ($cdom,$cnum);
9039: if ($filename =~ m|^(.+)/[^/]+$|) {
9040: push @parts, split(/\//,$1);
9041: }
9042: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9043: foreach my $part (@parts) {
9044: $path .= '/'.$part;
9045: if (!-e $path) {
9046: mkdir($path,0770);
9047: }
9048: }
9049: # now the path exists for sure
9050: # get a user agent
9051: my $ua=new LWP::UserAgent;
9052: my $transferfile=$file.'.in.transfer';
9053: # FIXME: this should flock
9054: if (-e $transferfile) { return 'ok'; }
9055: my $request;
9056: $uri=~s/^\///;
9057: my $homeserver = &homeserver($cnum,$cdom);
9058: my $protocol = $protocol{$homeserver};
9059: $protocol = 'http' if ($protocol ne 'https');
9060: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
9061: my $response=$ua->request($request,$transferfile);
9062: # did it work?
9063: if ($response->is_error()) {
9064: unlink($transferfile);
9065: &logthis("Userfile repcopy failed for $uri");
9066: return -1;
9067: }
9068: # worked, rename the transfer file
9069: rename($transferfile,$file);
9070: return 'ok';
9071: }
9072:
9073: sub tokenwrapper {
9074: my $uri=shift;
9075: $uri=~s|^https?\://([^/]+)||;
9076: $uri=~s|^/||;
9077: $env{'user.environment'}=~/\/([^\/]+)\.id/;
9078: my $token=$1;
9079: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9080: if ($udom && $uname && $file) {
9081: $file=~s|(\?\.*)*$||;
9082: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
9083: my $homeserver = &homeserver($uname,$udom);
9084: my $protocol = $protocol{$homeserver};
9085: $protocol = 'http' if ($protocol ne 'https');
9086: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
9087: (($uri=~/\?/)?'&':'?').'token='.$token.
9088: '&tokenissued='.$perlvar{'lonHostID'};
9089: } else {
9090: return '/adm/notfound.html';
9091: }
9092: }
9093:
9094: # call with reqtype HEAD: get last modification time
9095: # call with reqtype GET: get the file contents
9096: # Do not call this with reqtype GET for large files! It loads everything into memory
9097: #
9098: sub getuploaded {
9099: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9100: $uri=~s/^\///;
9101: my $homeserver = &homeserver($cnum,$cdom);
9102: my $protocol = $protocol{$homeserver};
9103: $protocol = 'http' if ($protocol ne 'https');
9104: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
9105: my $ua=new LWP::UserAgent;
9106: my $request=new HTTP::Request($reqtype,$uri);
9107: my $response=$ua->request($request);
9108: $$rtncode = $response->code;
9109: if (! $response->is_success()) {
9110: return 'failed';
9111: }
9112: if ($reqtype eq 'HEAD') {
9113: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
9114: } elsif ($reqtype eq 'GET') {
9115: $$info = $response->content;
9116: }
9117: return 'ok';
9118: }
9119:
9120: sub readfile {
9121: my $file = shift;
9122: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9123: my $fh;
9124: open($fh,"<$file");
9125: my $a='';
9126: while (my $line = <$fh>) { $a .= $line; }
9127: return $a;
9128: }
9129:
9130: sub filelocation {
9131: my ($dir,$file) = @_;
9132: my $location;
9133: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
9134:
9135: if ($file =~ m-^/adm/-) {
9136: $file=~s-^/adm/wrapper/-/-;
9137: $file=~s-^/adm/coursedocs/showdoc/-/-;
9138: }
9139:
9140: if ($file=~m:^/~:) { # is a contruction space reference
9141: $location = $file;
9142: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
9143: } elsif ($file=~m{^/home/$match_username/public_html/}) {
9144: # is a correct contruction space reference
9145: $location = $file;
9146: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9147: $location = $file;
9148: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
9149: my ($udom,$uname,$filename)=
9150: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
9151: my $home=&homeserver($uname,$udom);
9152: my $is_me=0;
9153: my @ids=¤t_machine_ids();
9154: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9155: if ($is_me) {
9156: $location=&propath($udom,$uname).'/userfiles/'.$filename;
9157: } else {
9158: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9159: $udom.'/'.$uname.'/'.$filename;
9160: }
9161: } elsif ($file =~ m-^/adm/-) {
9162: $location = $perlvar{'lonDocRoot'}.'/'.$file;
9163: } else {
9164: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9165: $file=~s:^/res/:/:;
9166: if ( !( $file =~ m:^/:) ) {
9167: $location = $dir. '/'.$file;
9168: } else {
9169: $location = '/home/httpd/html/res'.$file;
9170: }
9171: }
9172: $location=~s://+:/:g; # remove duplicate /
9173: while ($location=~m{/\.\./}) {
9174: if ($location =~ m{/[^/]+/\.\./}) {
9175: $location=~ s{/[^/]+/\.\./}{/}g;
9176: } else {
9177: $location=~ s{/\.\./}{/}g;
9178: }
9179: } #remove dir/..
9180: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9181: return $location;
9182: }
9183:
9184: sub hreflocation {
9185: my ($dir,$file)=@_;
9186: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
9187: $file=filelocation($dir,$file);
9188: } elsif ($file=~m-^/adm/-) {
9189: $file=~s-^/adm/wrapper/-/-;
9190: $file=~s-^/adm/coursedocs/showdoc/-/-;
9191: }
9192: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9193: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
9194: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9195: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
9196: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
9197: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
9198: -/uploaded/$1/$2/-x;
9199: }
9200: if ($file=~ m{^/userfiles/}) {
9201: $file =~ s{^/userfiles/}{/uploaded/};
9202: }
9203: return $file;
9204: }
9205:
9206: sub current_machine_domains {
9207: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9208: }
9209:
9210: sub machine_domains {
9211: my ($hostname) = @_;
9212: my @domains;
9213: my %hostname = &all_hostnames();
9214: while( my($id, $name) = each(%hostname)) {
9215: # &logthis("-$id-$name-$hostname-");
9216: if ($hostname eq $name) {
9217: push(@domains,&host_domain($id));
9218: }
9219: }
9220: return @domains;
9221: }
9222:
9223: sub current_machine_ids {
9224: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9225: }
9226:
9227: sub machine_ids {
9228: my ($hostname) = @_;
9229: $hostname ||= &hostname($perlvar{'lonHostID'});
9230: my @ids;
9231: my %name_to_host = &all_names();
9232: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9233: return @{ $name_to_host{$hostname} };
9234: }
9235: return;
9236: }
9237:
9238: sub additional_machine_domains {
9239: my @domains;
9240: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9241: while( my $line = <$fh>) {
9242: $line =~ s/\s//g;
9243: push(@domains,$line);
9244: }
9245: return @domains;
9246: }
9247:
9248: sub default_login_domain {
9249: my $domain = $perlvar{'lonDefDomain'};
9250: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9251: foreach my $posdom (¤t_machine_domains(),
9252: &additional_machine_domains()) {
9253: if (lc($posdom) eq lc($testdomain)) {
9254: $domain=$posdom;
9255: last;
9256: }
9257: }
9258: return $domain;
9259: }
9260:
9261: # ------------------------------------------------------------- Declutters URLs
9262:
9263: sub declutter {
9264: my $thisfn=shift;
9265: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9266: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9267: $thisfn=~s/^\///;
9268: $thisfn=~s|^adm/wrapper/||;
9269: $thisfn=~s|^adm/coursedocs/showdoc/||;
9270: $thisfn=~s/^res\///;
9271: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9272: $thisfn=~s/\?.+$//;
9273: }
9274: return $thisfn;
9275: }
9276:
9277: # ------------------------------------------------------------- Clutter up URLs
9278:
9279: sub clutter {
9280: my $thisfn='/'.&declutter(shift);
9281: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
9282: || $thisfn =~ m{^/adm/(includes|pages)} ) {
9283: $thisfn='/res'.$thisfn;
9284: }
9285: if ($thisfn !~m|^/adm|) {
9286: if ($thisfn =~ m|^/ext/|) {
9287: $thisfn='/adm/wrapper'.$thisfn;
9288: } else {
9289: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9290: my $embstyle=&Apache::loncommon::fileembstyle($ext);
9291: if ($embstyle eq 'ssi'
9292: || ($embstyle eq 'hdn')
9293: || ($embstyle eq 'rat')
9294: || ($embstyle eq 'prv')
9295: || ($embstyle eq 'ign')) {
9296: #do nothing with these
9297: } elsif (($embstyle eq 'img')
9298: || ($embstyle eq 'emb')
9299: || ($embstyle eq 'wrp')) {
9300: $thisfn='/adm/wrapper'.$thisfn;
9301: } elsif ($embstyle eq 'unk'
9302: && $thisfn!~/\.(sequence|page)$/) {
9303: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
9304: } else {
9305: # &logthis("Got a blank emb style");
9306: }
9307: }
9308: }
9309: return $thisfn;
9310: }
9311:
9312: sub clutter_with_no_wrapper {
9313: my $uri = &clutter(shift);
9314: if ($uri =~ m-^/adm/-) {
9315: $uri =~ s-^/adm/wrapper/-/-;
9316: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9317: }
9318: return $uri;
9319: }
9320:
9321: sub freeze_escape {
9322: my ($value)=@_;
9323: if (ref($value)) {
9324: $value=&nfreeze($value);
9325: return '__FROZEN__'.&escape($value);
9326: }
9327: return &escape($value);
9328: }
9329:
9330:
9331: sub thaw_unescape {
9332: my ($value)=@_;
9333: if ($value =~ /^__FROZEN__/) {
9334: substr($value,0,10,undef);
9335: $value=&unescape($value);
9336: return &thaw($value);
9337: }
9338: return &unescape($value);
9339: }
9340:
9341: sub correct_line_ends {
9342: my ($result)=@_;
9343: $$result =~s/\r\n/\n/mg;
9344: $$result =~s/\r/\n/mg;
9345: }
9346: # ================================================================ Main Program
9347:
9348: sub goodbye {
9349: &logthis("Starting Shut down");
9350: #not converted to using infrastruture and probably shouldn't be
9351: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
9352: #converted
9353: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
9354: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9355: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9356: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
9357: #1.1 only
9358: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9359: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9360: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9361: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9362: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
9363: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9364: &logthis(sprintf("%-20s is %s",'hits',$hits));
9365: &flushcourselogs();
9366: &logthis("Shutting down");
9367: }
9368:
9369: sub get_dns {
9370: my ($url,$func,$ignore_cache) = @_;
9371: if (!$ignore_cache) {
9372: my ($content,$cached)=
9373: &Apache::lonnet::is_cached_new('dns',$url);
9374: if ($cached) {
9375: &$func($content);
9376: return;
9377: }
9378: }
9379:
9380: my %alldns;
9381: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9382: foreach my $dns (<$config>) {
9383: next if ($dns !~ /^\^(\S*)/x);
9384: my $line = $1;
9385: my ($host,$protocol) = split(/:/,$line);
9386: if ($protocol ne 'https') {
9387: $protocol = 'http';
9388: }
9389: $alldns{$host} = $protocol;
9390: }
9391: while (%alldns) {
9392: my ($dns) = keys(%alldns);
9393: my $ua=new LWP::UserAgent;
9394: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
9395: my $response=$ua->request($request);
9396: delete($alldns{$dns});
9397: next if ($response->is_error());
9398: my @content = split("\n",$response->content);
9399: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
9400: &$func(\@content);
9401: return;
9402: }
9403: close($config);
9404: my $which = (split('/',$url))[3];
9405: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9406: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
9407: my @content = <$config>;
9408: &$func(\@content);
9409: return;
9410: }
9411: # ------------------------------------------------------------ Read domain file
9412: {
9413: my $loaded;
9414: my %domain;
9415:
9416: sub parse_domain_tab {
9417: my ($lines) = @_;
9418: foreach my $line (@$lines) {
9419: next if ($line =~ /^(\#|\s*$ )/x);
9420:
9421: chomp($line);
9422: my ($name,@elements) = split(/:/,$line,9);
9423: my %this_domain;
9424: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9425: 'lang_def', 'city', 'longi', 'lati',
9426: 'primary') {
9427: $this_domain{$field} = shift(@elements);
9428: }
9429: $domain{$name} = \%this_domain;
9430: }
9431: }
9432:
9433: sub reset_domain_info {
9434: undef($loaded);
9435: undef(%domain);
9436: }
9437:
9438: sub load_domain_tab {
9439: my ($ignore_cache) = @_;
9440: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
9441: my $fh;
9442: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9443: my @lines = <$fh>;
9444: &parse_domain_tab(\@lines);
9445: }
9446: close($fh);
9447: $loaded = 1;
9448: }
9449:
9450: sub domain {
9451: &load_domain_tab() if (!$loaded);
9452:
9453: my ($name,$what) = @_;
9454: return if ( !exists($domain{$name}) );
9455:
9456: if (!$what) {
9457: return $domain{$name}{'description'};
9458: }
9459: return $domain{$name}{$what};
9460: }
9461:
9462: sub domain_info {
9463: &load_domain_tab() if (!$loaded);
9464: return %domain;
9465: }
9466:
9467: }
9468:
9469:
9470: # ------------------------------------------------------------- Read hosts file
9471: {
9472: my %hostname;
9473: my %hostdom;
9474: my %libserv;
9475: my $loaded;
9476: my %name_to_host;
9477:
9478: sub parse_hosts_tab {
9479: my ($file) = @_;
9480: foreach my $configline (@$file) {
9481: next if ($configline =~ /^(\#|\s*$ )/x);
9482: next if ($configline =~ /^\^/);
9483: chomp($configline);
9484: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
9485: $name=~s/\s//g;
9486: if ($id && $domain && $role && $name) {
9487: $hostname{$id}=$name;
9488: push(@{$name_to_host{$name}}, $id);
9489: $hostdom{$id}=$domain;
9490: if ($role eq 'library') { $libserv{$id}=$name; }
9491: if (defined($protocol)) {
9492: if ($protocol eq 'https') {
9493: $protocol{$id} = $protocol;
9494: } else {
9495: $protocol{$id} = 'http';
9496: }
9497: } else {
9498: $protocol{$id} = 'http';
9499: }
9500: }
9501: }
9502: }
9503:
9504: sub reset_hosts_info {
9505: &purge_remembered();
9506: &reset_domain_info();
9507: &reset_hosts_ip_info();
9508: undef(%name_to_host);
9509: undef(%hostname);
9510: undef(%hostdom);
9511: undef(%libserv);
9512: undef($loaded);
9513: }
9514:
9515: sub load_hosts_tab {
9516: my ($ignore_cache) = @_;
9517: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9518: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9519: my @config = <$config>;
9520: &parse_hosts_tab(\@config);
9521: close($config);
9522: $loaded=1;
9523: }
9524:
9525: sub hostname {
9526: &load_hosts_tab() if (!$loaded);
9527:
9528: my ($lonid) = @_;
9529: return $hostname{$lonid};
9530: }
9531:
9532: sub all_hostnames {
9533: &load_hosts_tab() if (!$loaded);
9534:
9535: return %hostname;
9536: }
9537:
9538: sub all_names {
9539: &load_hosts_tab() if (!$loaded);
9540:
9541: return %name_to_host;
9542: }
9543:
9544: sub all_host_domain {
9545: &load_hosts_tab() if (!$loaded);
9546: return %hostdom;
9547: }
9548:
9549: sub is_library {
9550: &load_hosts_tab() if (!$loaded);
9551:
9552: return exists($libserv{$_[0]});
9553: }
9554:
9555: sub all_library {
9556: &load_hosts_tab() if (!$loaded);
9557:
9558: return %libserv;
9559: }
9560:
9561: sub get_servers {
9562: &load_hosts_tab() if (!$loaded);
9563:
9564: my ($domain,$type) = @_;
9565: my %possible_hosts = ($type eq 'library') ? %libserv
9566: : %hostname;
9567: my %result;
9568: if (ref($domain) eq 'ARRAY') {
9569: while ( my ($host,$hostname) = each(%possible_hosts)) {
9570: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9571: $result{$host} = $hostname;
9572: }
9573: }
9574: } else {
9575: while ( my ($host,$hostname) = each(%possible_hosts)) {
9576: if ($hostdom{$host} eq $domain) {
9577: $result{$host} = $hostname;
9578: }
9579: }
9580: }
9581: return %result;
9582: }
9583:
9584: sub host_domain {
9585: &load_hosts_tab() if (!$loaded);
9586:
9587: my ($lonid) = @_;
9588: return $hostdom{$lonid};
9589: }
9590:
9591: sub all_domains {
9592: &load_hosts_tab() if (!$loaded);
9593:
9594: my %seen;
9595: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9596: return @uniq;
9597: }
9598: }
9599:
9600: {
9601: my %iphost;
9602: my %name_to_ip;
9603: my %lonid_to_ip;
9604:
9605: sub get_hosts_from_ip {
9606: my ($ip) = @_;
9607: my %iphosts = &get_iphost();
9608: if (ref($iphosts{$ip})) {
9609: return @{$iphosts{$ip}};
9610: }
9611: return;
9612: }
9613:
9614: sub reset_hosts_ip_info {
9615: undef(%iphost);
9616: undef(%name_to_ip);
9617: undef(%lonid_to_ip);
9618: }
9619:
9620: sub get_host_ip {
9621: my ($lonid) = @_;
9622: if (exists($lonid_to_ip{$lonid})) {
9623: return $lonid_to_ip{$lonid};
9624: }
9625: my $name=&hostname($lonid);
9626: my $ip = gethostbyname($name);
9627: return if (!$ip || length($ip) ne 4);
9628: $ip=inet_ntoa($ip);
9629: $name_to_ip{$name} = $ip;
9630: $lonid_to_ip{$lonid} = $ip;
9631: return $ip;
9632: }
9633:
9634: sub get_iphost {
9635: my ($ignore_cache) = @_;
9636:
9637: if (!$ignore_cache) {
9638: if (%iphost) {
9639: return %iphost;
9640: }
9641: my ($ip_info,$cached)=
9642: &Apache::lonnet::is_cached_new('iphost','iphost');
9643: if ($cached) {
9644: %iphost = %{$ip_info->[0]};
9645: %name_to_ip = %{$ip_info->[1]};
9646: %lonid_to_ip = %{$ip_info->[2]};
9647: return %iphost;
9648: }
9649: }
9650:
9651: # get yesterday's info for fallback
9652: my %old_name_to_ip;
9653: my ($ip_info,$cached)=
9654: &Apache::lonnet::is_cached_new('iphost','iphost');
9655: if ($cached) {
9656: %old_name_to_ip = %{$ip_info->[1]};
9657: }
9658:
9659: my %name_to_host = &all_names();
9660: foreach my $name (keys(%name_to_host)) {
9661: my $ip;
9662: if (!exists($name_to_ip{$name})) {
9663: $ip = gethostbyname($name);
9664: if (!$ip || length($ip) ne 4) {
9665: if (defined($old_name_to_ip{$name})) {
9666: $ip = $old_name_to_ip{$name};
9667: &logthis("Can't find $name defaulting to old $ip");
9668: } else {
9669: &logthis("Name $name no IP found");
9670: next;
9671: }
9672: } else {
9673: $ip=inet_ntoa($ip);
9674: }
9675: $name_to_ip{$name} = $ip;
9676: } else {
9677: $ip = $name_to_ip{$name};
9678: }
9679: foreach my $id (@{ $name_to_host{$name} }) {
9680: $lonid_to_ip{$id} = $ip;
9681: }
9682: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9683: }
9684: &Apache::lonnet::do_cache_new('iphost','iphost',
9685: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9686: 48*60*60);
9687:
9688: return %iphost;
9689: }
9690:
9691: #
9692: # Given a DNS returns the loncapa host name for that DNS
9693: #
9694: sub host_from_dns {
9695: my ($dns) = @_;
9696: my @hosts;
9697: my $ip;
9698:
9699: if (exists($name_to_ip{$dns})) {
9700: $ip = $name_to_ip{$dns};
9701: }
9702: if (!$ip) {
9703: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9704: if (length($ip) == 4) {
9705: $ip = &IO::Socket::inet_ntoa($ip);
9706: }
9707: }
9708: if ($ip) {
9709: @hosts = get_hosts_from_ip($ip);
9710: return $hosts[0];
9711: }
9712: return undef;
9713: }
9714:
9715: }
9716:
9717: BEGIN {
9718:
9719: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9720: unless ($readit) {
9721: {
9722: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9723: %perlvar = (%perlvar,%{$configvars});
9724: }
9725:
9726:
9727: # ------------------------------------------------------ Read spare server file
9728: {
9729: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9730:
9731: while (my $configline=<$config>) {
9732: chomp($configline);
9733: if ($configline) {
9734: my ($host,$type) = split(':',$configline,2);
9735: if (!defined($type) || $type eq '') { $type = 'default' };
9736: push(@{ $spareid{$type} }, $host);
9737: }
9738: }
9739: close($config);
9740: }
9741: # ------------------------------------------------------------ Read permissions
9742: {
9743: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9744:
9745: while (my $configline=<$config>) {
9746: chomp($configline);
9747: if ($configline) {
9748: my ($role,$perm)=split(/ /,$configline);
9749: if ($perm ne '') { $pr{$role}=$perm; }
9750: }
9751: }
9752: close($config);
9753: }
9754:
9755: # -------------------------------------------- Read plain texts for permissions
9756: {
9757: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
9758:
9759: while (my $configline=<$config>) {
9760: chomp($configline);
9761: if ($configline) {
9762: my ($short,@plain)=split(/:/,$configline);
9763: %{$prp{$short}} = ();
9764: if (@plain > 0) {
9765: $prp{$short}{'std'} = $plain[0];
9766: for (my $i=1; $i<@plain; $i++) {
9767: $prp{$short}{'alt'.$i} = $plain[$i];
9768: }
9769: }
9770: }
9771: }
9772: close($config);
9773: }
9774:
9775: # ---------------------------------------------------------- Read package table
9776: {
9777: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
9778:
9779: while (my $configline=<$config>) {
9780: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
9781: chomp($configline);
9782: my ($short,$plain)=split(/:/,$configline);
9783: my ($pack,$name)=split(/\&/,$short);
9784: if ($plain ne '') {
9785: $packagetab{$pack.'&'.$name.'&name'}=$name;
9786: $packagetab{$short}=$plain;
9787: }
9788: }
9789: close($config);
9790: }
9791:
9792: # ------------- set up temporary directory
9793: {
9794: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9795:
9796: }
9797:
9798: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9799: 'compress_threshold'=> 20_000,
9800: });
9801:
9802: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
9803: $dumpcount=0;
9804: $locknum=0;
9805:
9806: &logtouch();
9807: &logthis('<font color="yellow">INFO: Read configuration</font>');
9808: $readit=1;
9809: {
9810: use integer;
9811: my $test=(2**32)+1;
9812: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
9813: &logthis(" Detected 64bit platform ($_64bit)");
9814: }
9815: }
9816: }
9817:
9818: 1;
9819: __END__
9820:
9821: =pod
9822:
9823: =head1 NAME
9824:
9825: Apache::lonnet - Subroutines to ask questions about things in the network.
9826:
9827: =head1 SYNOPSIS
9828:
9829: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
9830:
9831: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9832:
9833: Common parameters:
9834:
9835: =over 4
9836:
9837: =item *
9838:
9839: $uname : an internal username (if $cname expecting a course Id specifically)
9840:
9841: =item *
9842:
9843: $udom : a domain (if $cdom expecting a course's domain specifically)
9844:
9845: =item *
9846:
9847: $symb : a resource instance identifier
9848:
9849: =item *
9850:
9851: $namespace : the name of a .db file that contains the data needed or
9852: being set.
9853:
9854: =back
9855:
9856: =head1 OVERVIEW
9857:
9858: lonnet provides subroutines which interact with the
9859: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9860: about classes, users, and resources.
9861:
9862: For many of these objects you can also use this to store data about
9863: them or modify them in various ways.
9864:
9865: =head2 Symbs
9866:
9867: To identify a specific instance of a resource, LON-CAPA uses symbols
9868: or "symbs"X<symb>. These identifiers are built from the URL of the
9869: map, the resource number of the resource in the map, and the URL of
9870: the resource itself. The latter is somewhat redundant, but might help
9871: if maps change.
9872:
9873: An example is
9874:
9875: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9876:
9877: The respective map entry is
9878:
9879: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9880: title="Problem 2">
9881: </resource>
9882:
9883: Symbs are used by the random number generator, as well as to store and
9884: restore data specific to a certain instance of for example a problem.
9885:
9886: =head2 Storing And Retrieving Data
9887:
9888: X<store()>X<cstore()>X<restore()>Three of the most important functions
9889: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9890: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9891: is is the non-critical message twin of cstore. These functions are for
9892: handlers to store a perl hash to a user's permanent data space in an
9893: easy manner, and to retrieve it again on another call. It is expected
9894: that a handler would use this once at the beginning to retrieve data,
9895: and then again once at the end to send only the new data back.
9896:
9897: The data is stored in the user's data directory on the user's
9898: homeserver under the ID of the course.
9899:
9900: The hash that is returned by restore will have all of the previous
9901: value for all of the elements of the hash.
9902:
9903: Example:
9904:
9905: #creating a hash
9906: my %hash;
9907: $hash{'foo'}='bar';
9908:
9909: #storing it
9910: &Apache::lonnet::cstore(\%hash);
9911:
9912: #changing a value
9913: $hash{'foo'}='notbar';
9914:
9915: #adding a new value
9916: $hash{'bar'}='foo';
9917: &Apache::lonnet::cstore(\%hash);
9918:
9919: #retrieving the hash
9920: my %history=&Apache::lonnet::restore();
9921:
9922: #print the hash
9923: foreach my $key (sort(keys(%history))) {
9924: print("\%history{$key} = $history{$key}");
9925: }
9926:
9927: Will print out:
9928:
9929: %history{1:foo} = bar
9930: %history{1:keys} = foo:timestamp
9931: %history{1:timestamp} = 990455579
9932: %history{2:bar} = foo
9933: %history{2:foo} = notbar
9934: %history{2:keys} = foo:bar:timestamp
9935: %history{2:timestamp} = 990455580
9936: %history{bar} = foo
9937: %history{foo} = notbar
9938: %history{timestamp} = 990455580
9939: %history{version} = 2
9940:
9941: Note that the special hash entries C<keys>, C<version> and
9942: C<timestamp> were added to the hash. C<version> will be equal to the
9943: total number of versions of the data that have been stored. The
9944: C<timestamp> attribute will be the UNIX time the hash was
9945: stored. C<keys> is available in every historical section to list which
9946: keys were added or changed at a specific historical revision of a
9947: hash.
9948:
9949: B<Warning>: do not store the hash that restore returns directly. This
9950: will cause a mess since it will restore the historical keys as if the
9951: were new keys. I.E. 1:foo will become 1:1:foo etc.
9952:
9953: Calling convention:
9954:
9955: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9956: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
9957:
9958: For more detailed information, see lonnet specific documentation.
9959:
9960: =head1 RETURN MESSAGES
9961:
9962: =over 4
9963:
9964: =item * B<con_lost>: unable to contact remote host
9965:
9966: =item * B<con_delayed>: unable to contact remote host, message will be delivered
9967: when the connection is brought back up
9968:
9969: =item * B<con_failed>: unable to contact remote host and unable to save message
9970: for later delivery
9971:
9972: =item * B<error:>: an error a occurred, a description of the error follows the :
9973:
9974: =item * B<no_such_host>: unable to fund a host associated with the user/domain
9975: that was requested
9976:
9977: =back
9978:
9979: =head1 PUBLIC SUBROUTINES
9980:
9981: =head2 Session Environment Functions
9982:
9983: =over 4
9984:
9985: =item *
9986: X<appenv()>
9987: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
9988: the user envirnoment file, and will be restored for each access this
9989: user makes during this session, also modifies the %env for the current
9990: process. Optional rolesarrayref - if defined contains a reference to an array
9991: of roles which are exempt from the restriction on modifying user.role entries
9992: in the user's environment.db and in %env.
9993:
9994: =item *
9995: X<delenv()>
9996: B<delenv($delthis,$regexp)>: removes all items from the session
9997: environment file that begin with $delthis. If the
9998: optional second arg - $regexp - is true, $delthis is treated as a
9999: regular expression, otherwise \Q$delthis\E is used.
10000: The values are also deleted from the current processes %env.
10001:
10002: =item * get_env_multiple($name)
10003:
10004: gets $name from the %env hash, it seemlessly handles the cases where multiple
10005: values may be defined and end up as an array ref.
10006:
10007: returns an array of values
10008:
10009: =back
10010:
10011: =head2 User Information
10012:
10013: =over 4
10014:
10015: =item *
10016: X<queryauthenticate()>
10017: B<queryauthenticate($uname,$udom)>: try to determine user's current
10018: authentication scheme
10019:
10020: =item *
10021: X<authenticate()>
10022: B<authenticate($uname,$upass,$udom)>: try to
10023: authenticate user from domain's lib servers (first use the current
10024: one). C<$upass> should be the users password.
10025:
10026: =item *
10027: X<homeserver()>
10028: B<homeserver($uname,$udom)>: find the server which has
10029: the user's directory and files (there must be only one), this caches
10030: the answer, and also caches if there is a borken connection.
10031:
10032: =item *
10033: X<idget()>
10034: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10035: (IDs are a unique resource in a domain, there must be only 1 ID per
10036: username, and only 1 username per ID in a specific domain) (returns
10037: hash: id=>name,id=>name)
10038:
10039: =item *
10040: X<idrget()>
10041: B<idrget($udom,@unames)>: find the IDs behind a list of
10042: usernames (returns hash: name=>id,name=>id)
10043:
10044: =item *
10045: X<idput()>
10046: B<idput($udom,%ids)>: store away a list of names and associated IDs
10047:
10048: =item *
10049: X<rolesinit()>
10050: B<rolesinit($udom,$username,$authhost)>: get user privileges
10051:
10052: =item *
10053: X<getsection()>
10054: B<getsection($udom,$uname,$cname)>: finds the section of student in the
10055: course $cname, return section name/number or '' for "not in course"
10056: and '-1' for "no section"
10057:
10058: =item *
10059: X<userenvironment()>
10060: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
10061: passed in @what from the requested user's environment, returns a hash
10062:
10063: =item *
10064: X<userlog_query()>
10065: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10066: activity.log file. %filters defines filters applied when parsing the
10067: log file. These can be start or end timestamps, or the type of action
10068: - log to look for Login or Logout events, check for Checkin or
10069: Checkout, role for role selection. The response is in the form
10070: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10071: escaped strings of the action recorded in the activity.log file.
10072:
10073: =back
10074:
10075: =head2 User Roles
10076:
10077: =over 4
10078:
10079: =item *
10080:
10081: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
10082: F: full access
10083: U,I,K: authentication modes (cxx only)
10084: '': forbidden
10085: 1: user needs to choose course
10086: 2: browse allowed
10087: A: passphrase authentication needed
10088:
10089: =item *
10090:
10091: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10092: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10093: and course level
10094:
10095: =item *
10096:
10097: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10098: (rolesplain.tab); plain text explanation of a user role term.
10099: $type is Course (default) or Community.
10100: If $forcedefault evaluates to true, text returned will be default
10101: text for $type. Otherwise, if this is a course, the text returned
10102: will be a custom name for the role (if defined in the course's
10103: environment). If no custom name is defined the default is returned.
10104:
10105: =item *
10106:
10107: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
10108: All arguments are optional. Returns a hash of a roles, either for
10109: co-author/assistant author roles for a user's Construction Space
10110: (default), or if $context is 'userroles', roles for the user himself,
10111: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10112: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10113: For each key, value is set to colon-separated start and end times for
10114: the role. If no username and domain are specified, will default to
10115: current user/domain. Types, roles, and roledoms are references to arrays
10116: of role statuses (active, future or previous), roles
10117: (e.g., cc,in, st etc.) and domains of the roles which can be used
10118: to restrict the list of roles reported. If no array ref is
10119: provided for types, will default to return only active roles.
10120:
10121: =back
10122:
10123: =head2 User Modification
10124:
10125: =over 4
10126:
10127: =item *
10128:
10129: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
10130: user for the level given by URL. Optional start and end dates (leave empty
10131: string or zero for "no date")
10132:
10133: =item *
10134:
10135: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10136: change a users, password, possible return values are: ok,
10137: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10138: refused
10139:
10140: =item *
10141:
10142: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
10143:
10144: =item *
10145:
10146: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
10147: $forceid,$desiredhome,$email,$inststatus) :
10148: modify user
10149:
10150: =item *
10151:
10152: modifystudent
10153:
10154: modify a student's enrollment and identification information.
10155: The course id is resolved based on the current users environment.
10156: This means the envoking user must be a course coordinator or otherwise
10157: associated with a course.
10158:
10159: This call is essentially a wrapper for lonnet::modifyuser and
10160: lonnet::modify_student_enrollment
10161:
10162: Inputs:
10163:
10164: =over 4
10165:
10166: =item B<$udom> Student's loncapa domain
10167:
10168: =item B<$uname> Student's loncapa login name
10169:
10170: =item B<$uid> Student/Employee ID
10171:
10172: =item B<$umode> Student's authentication mode
10173:
10174: =item B<$upass> Student's password
10175:
10176: =item B<$first> Student's first name
10177:
10178: =item B<$middle> Student's middle name
10179:
10180: =item B<$last> Student's last name
10181:
10182: =item B<$gene> Student's generation
10183:
10184: =item B<$usec> Student's section in course
10185:
10186: =item B<$end> Unix time of the roles expiration
10187:
10188: =item B<$start> Unix time of the roles start date
10189:
10190: =item B<$forceid> If defined, allow $uid to be changed
10191:
10192: =item B<$desiredhome> server to use as home server for student
10193:
10194: =item B<$email> Student's permanent e-mail address
10195:
10196: =item B<$type> Type of enrollment (auto or manual)
10197:
10198: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10199:
10200: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
10201:
10202: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
10203:
10204: =item B<$context> role change context (shown in User Management Logs display in a course)
10205:
10206: =item B<$inststatus> institutional status of user - : separated string of escaped status types
10207:
10208: =back
10209:
10210: =item *
10211:
10212: modify_student_enrollment
10213:
10214: Change a students enrollment status in a class. The environment variable
10215: 'role.request.course' must be defined for this function to proceed.
10216:
10217: Inputs:
10218:
10219: =over 4
10220:
10221: =item $udom, students domain
10222:
10223: =item $uname, students name
10224:
10225: =item $uid, students user id
10226:
10227: =item $first, students first name
10228:
10229: =item $middle
10230:
10231: =item $last
10232:
10233: =item $gene
10234:
10235: =item $usec
10236:
10237: =item $end
10238:
10239: =item $start
10240:
10241: =item $type
10242:
10243: =item $locktype
10244:
10245: =item $cid
10246:
10247: =item $selfenroll
10248:
10249: =item $context
10250:
10251: =back
10252:
10253:
10254: =item *
10255:
10256: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10257: custom role; give a custom role to a user for the level given by URL. Specify
10258: name and domain of role author, and role name
10259:
10260: =item *
10261:
10262: revokerole($udom,$uname,$url,$role) : revoke a role for url
10263:
10264: =item *
10265:
10266: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10267:
10268: =back
10269:
10270: =head2 Course Infomation
10271:
10272: =over 4
10273:
10274: =item *
10275:
10276: coursedescription($courseid) : returns a hash of information about the
10277: specified course id, including all environment settings for the
10278: course, the description of the course will be in the hash under the
10279: key 'description'
10280:
10281: =item *
10282:
10283: resdata($name,$domain,$type,@which) : request for current parameter
10284: setting for a specific $type, where $type is either 'course' or 'user',
10285: @what should be a list of parameters to ask about. This routine caches
10286: answers for 5 minutes.
10287:
10288: =item *
10289:
10290: get_courseresdata($courseid, $domain) : dump the entire course resource
10291: data base, returning a hash that is keyed by the resource name and has
10292: values that are the resource value. I believe that the timestamps and
10293: versions are also returned.
10294:
10295:
10296: =back
10297:
10298: =head2 Course Modification
10299:
10300: =over 4
10301:
10302: =item *
10303:
10304: writecoursepref($courseid,%prefs) : write preferences (environment
10305: database) for a course
10306:
10307: =item *
10308:
10309: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10310:
10311: =item *
10312:
10313: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
10314:
10315: =back
10316:
10317: =head2 Resource Subroutines
10318:
10319: =over 4
10320:
10321: =item *
10322:
10323: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
10324:
10325: =item *
10326:
10327: repcopy($filename) : subscribes to the requested file, and attempts to
10328: replicate from the owning library server, Might return
10329: 'unavailable', 'not_found', 'forbidden', 'ok', or
10330: 'bad_request', also attempts to grab the metadata for the
10331: resource. Expects the local filesystem pathname
10332: (/home/httpd/html/res/....)
10333:
10334: =back
10335:
10336: =head2 Resource Information
10337:
10338: =over 4
10339:
10340: =item *
10341:
10342: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10343: a vairety of different possible values, $varname should be a request
10344: string, and the other parameters can be used to specify who and what
10345: one is asking about.
10346:
10347: Possible values for $varname are environment.lastname (or other item
10348: from the envirnment hash), user.name (or someother aspect about the
10349: user), resource.0.maxtries (or some other part and parameter of a
10350: resource)
10351:
10352: =item *
10353:
10354: directcondval($number) : get current value of a condition; reads from a state
10355: string
10356:
10357: =item *
10358:
10359: condval($condidx) : value of condition index based on state
10360:
10361: =item *
10362:
10363: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10364: resource's metadata, $what should be either a specific key, or either
10365: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10366: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10367:
10368: this function automatically caches all requests
10369:
10370: =item *
10371:
10372: metadata_query($query,$custom,$customshow) : make a metadata query against the
10373: network of library servers; returns file handle of where SQL and regex results
10374: will be stored for query
10375:
10376: =item *
10377:
10378: symbread($filename) : return symbolic list entry (filename argument optional);
10379: returns the data handle
10380:
10381: =item *
10382:
10383: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
10384: a possible symb for the URL in $thisfn, and if is an encryypted
10385: resource that the user accessed using /enc/ returns a 1 on success, 0
10386: on failure, user must be in a course, as it assumes the existance of
10387: the course initial hash, and uses $env('request.course.id'}
10388:
10389:
10390: =item *
10391:
10392: symbclean($symb) : removes versions numbers from a symb, returns the
10393: cleaned symb
10394:
10395: =item *
10396:
10397: is_on_map($uri) : checks if the $uri is somewhere on the current
10398: course map, user must be in a course for it to work.
10399:
10400: =item *
10401:
10402: numval($salt) : return random seed value (addend for rndseed)
10403:
10404: =item *
10405:
10406: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10407: a random seed, all arguments are optional, if they aren't sent it uses the
10408: environment to derive them. Note: if symb isn't sent and it can't get one
10409: from &symbread it will use the current time as its return value
10410:
10411: =item *
10412:
10413: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10414: unfakeable, receipt
10415:
10416: =item *
10417:
10418: receipt() : API to ireceipt working off of env values; given out to users
10419:
10420: =item *
10421:
10422: countacc($url) : count the number of accesses to a given URL
10423:
10424: =item *
10425:
10426: 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
10427:
10428: =item *
10429:
10430: 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)
10431:
10432: =item *
10433:
10434: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
10435:
10436: =item *
10437:
10438: devalidate($symb) : devalidate temporary spreadsheet calculations,
10439: forcing spreadsheet to reevaluate the resource scores next time.
10440:
10441: =back
10442:
10443: =head2 Storing/Retreiving Data
10444:
10445: =over 4
10446:
10447: =item *
10448:
10449: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10450: for this url; hashref needs to be given and should be a \%hashname; the
10451: remaining args aren't required and if they aren't passed or are '' they will
10452: be derived from the env
10453:
10454: =item *
10455:
10456: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10457: uses critical subroutine
10458:
10459: =item *
10460:
10461: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10462: all args are optional
10463:
10464: =item *
10465:
10466: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10467: dumps the complete (or key matching regexp) namespace into a hash
10468: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10469: normally &store()ed into
10470:
10471: $range should be either an integer '100' (give me the first 100
10472: matching records)
10473: or be two integers sperated by a - with no spaces
10474: '30-50' (give me the 30th through the 50th matching
10475: records)
10476:
10477:
10478: =item *
10479:
10480: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10481: replaces a &store() version of data with a replacement set of data
10482: for a particular resource in a namespace passed in the $storehash hash
10483: reference
10484:
10485: =item *
10486:
10487: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10488: works very similar to store/cstore, but all data is stored in a
10489: temporary location and can be reset using tmpreset, $storehash should
10490: be a hash reference, returns nothing on success
10491:
10492: =item *
10493:
10494: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10495: similar to restore, but all data is stored in a temporary location and
10496: can be reset using tmpreset. Returns a hash of values on success,
10497: error string otherwise.
10498:
10499: =item *
10500:
10501: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10502: deltes all keys for $symb form the temporary storage hash.
10503:
10504: =item *
10505:
10506: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10507: reference filled in from namesp ($udom and $uname are optional)
10508:
10509: =item *
10510:
10511: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10512: namesp ($udom and $uname are optional)
10513:
10514: =item *
10515:
10516: dump($namespace,$udom,$uname,$regexp,$range) :
10517: dumps the complete (or key matching regexp) namespace into a hash
10518: ($udom, $uname, $regexp, $range are optional)
10519:
10520: $range should be either an integer '100' (give me the first 100
10521: matching records)
10522: or be two integers sperated by a - with no spaces
10523: '30-50' (give me the 30th through the 50th matching
10524: records)
10525: =item *
10526:
10527: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10528: $store can be a scalar, an array reference, or if the amount to be
10529: incremented is > 1, a hash reference.
10530:
10531: ($udom and $uname are optional)
10532:
10533: =item *
10534:
10535: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10536: ($udom and $uname are optional)
10537:
10538: =item *
10539:
10540: cput($namespace,$storehash,$udom,$uname) : critical put
10541: ($udom and $uname are optional)
10542:
10543: =item *
10544:
10545: newput($namespace,$storehash,$udom,$uname) :
10546:
10547: Attempts to store the items in the $storehash, but only if they don't
10548: currently exist, if this succeeds you can be certain that you have
10549: successfully created a new key value pair in the $namespace db.
10550:
10551:
10552: Args:
10553: $namespace: name of database to store values to
10554: $storehash: hashref to store to the db
10555: $udom: (optional) domain of user containing the db
10556: $uname: (optional) name of user caontaining the db
10557:
10558: Returns:
10559: 'ok' -> succeeded in storing all keys of $storehash
10560: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10561: least <key> already existed in the db (other
10562: requested keys may also already exist)
10563: 'error: <msg>' -> unable to tie the DB or other error occurred
10564: 'con_lost' -> unable to contact request server
10565: 'refused' -> action was not allowed by remote machine
10566:
10567:
10568: =item *
10569:
10570: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10571: reference filled in from namesp (encrypts the return communication)
10572: ($udom and $uname are optional)
10573:
10574: =item *
10575:
10576: log($udom,$name,$home,$message) : write to permanent log for user; use
10577: critical subroutine
10578:
10579: =item *
10580:
10581: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10582: array reference filled in from namespace found in domain level on either
10583: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10584:
10585: =item *
10586:
10587: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10588: domain level either on specified domain server ($uhome) or primary domain
10589: server ($udom and $uhome are optional)
10590:
10591: =item *
10592:
10593: get_domain_defaults($target_domain) : returns hash with defaults for
10594: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10595: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10596: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10597: Values are retrieved from cache (if current), or from domain's configuration.db
10598: (if available), or lastly from values in lonTabs/dns_domain,tab,
10599: or lonTabs/domain.tab.
10600:
10601: %domdefaults = &get_auth_defaults($target_domain);
10602:
10603: =back
10604:
10605: =head2 Network Status Functions
10606:
10607: =over 4
10608:
10609: =item *
10610:
10611: dirlist($uri) : return directory list based on URI
10612:
10613: =item *
10614:
10615: spareserver() : find server with least workload from spare.tab
10616:
10617:
10618: =item *
10619:
10620: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10621: if there is no corresponding loncapa host.
10622:
10623: =back
10624:
10625:
10626: =head2 Apache Request
10627:
10628: =over 4
10629:
10630: =item *
10631:
10632: ssi($url,%hash) : server side include, does a complete request cycle on url to
10633: localhost, posts hash
10634:
10635: =back
10636:
10637: =head2 Data to String to Data
10638:
10639: =over 4
10640:
10641: =item *
10642:
10643: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10644: and '&' separators, supports elements that are arrayrefs and hashrefs
10645:
10646: =item *
10647:
10648: hashref2str($hashref) : convert a hashref into a string complete with
10649: escaping and '=' and '&' separators, supports elements that are
10650: arrayrefs and hashrefs
10651:
10652: =item *
10653:
10654: arrayref2str($arrayref) : convert an arrayref into a string complete
10655: with escaping and '&' separators, supports elements that are arrayrefs
10656: and hashrefs
10657:
10658: =item *
10659:
10660: str2hash($string) : convert string to hash using unescaping and
10661: splitting on '=' and '&', supports elements that are arrayrefs and
10662: hashrefs
10663:
10664: =item *
10665:
10666: str2array($string) : convert string to hash using unescaping and
10667: splitting on '&', supports elements that are arrayrefs and hashrefs
10668:
10669: =back
10670:
10671: =head2 Logging Routines
10672:
10673: =over 4
10674:
10675: These routines allow one to make log messages in the lonnet.log and
10676: lonnet.perm logfiles.
10677:
10678: =item *
10679:
10680: logtouch() : make sure the logfile, lonnet.log, exists
10681:
10682: =item *
10683:
10684: logthis() : append message to the normal lonnet.log file, it gets
10685: preiodically rolled over and deleted.
10686:
10687: =item *
10688:
10689: logperm() : append a permanent message to lonnet.perm.log, this log
10690: file never gets deleted by any automated portion of the system, only
10691: messages of critical importance should go in here.
10692:
10693: =back
10694:
10695: =head2 General File Helper Routines
10696:
10697: =over 4
10698:
10699: =item *
10700:
10701: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10702: (a) files in /uploaded
10703: (i) If a local copy of the file exists -
10704: compares modification date of local copy with last-modified date for
10705: definitive version stored on home server for course. If local copy is
10706: stale, requests a new version from the home server and stores it.
10707: If the original has been removed from the home server, then local copy
10708: is unlinked.
10709: (ii) If local copy does not exist -
10710: requests the file from the home server and stores it.
10711:
10712: If $caller is 'uploadrep':
10713: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10714: for request for files originally uploaded via DOCS.
10715: - returns 'ok' if fresh local copy now available, -1 otherwise.
10716:
10717: Otherwise:
10718: This indicates a call from the content generation phase of the request.
10719: - returns the entire contents of the file or -1.
10720:
10721: (b) files in /res
10722: - returns the entire contents of a file or -1;
10723: it properly subscribes to and replicates the file if neccessary.
10724:
10725:
10726: =item *
10727:
10728: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10729: reference
10730:
10731: returns either a stat() list of data about the file or an empty list
10732: if the file doesn't exist or couldn't find out about it (connection
10733: problems or user unknown)
10734:
10735: =item *
10736:
10737: filelocation($dir,$file) : returns file system location of a file
10738: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10739: directory that relative $file lookups are to looked in ($dir of /a/dir
10740: and a file of ../bob will become /a/bob)
10741:
10742: =item *
10743:
10744: hreflocation($dir,$file) : returns file system location or a URL; same as
10745: filelocation except for hrefs
10746:
10747: =item *
10748:
10749: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10750:
10751: =back
10752:
10753: =head2 Usererfile file routines (/uploaded*)
10754:
10755: =over 4
10756:
10757: =item *
10758:
10759: userfileupload(): main rotine for putting a file in a user or course's
10760: filespace, arguments are,
10761:
10762: formname - required - this is the name of the element in $env where the
10763: filename, and the contents of the file to create/modifed exist
10764: the filename is in $env{'form.'.$formname.'.filename'} and the
10765: contents of the file is located in $env{'form.'.$formname}
10766: coursedoc - if true, store the file in the course of the active role
10767: of the current user
10768: subdir - required - subdirectory to put the file in under ../userfiles/
10769: if undefined, it will be placed in "unknown"
10770:
10771: (This routine calls clean_filename() to remove any dangerous
10772: characters from the filename, and then calls finuserfileupload() to
10773: complete the transaction)
10774:
10775: returns either the url of the uploaded file (/uploaded/....) if successful
10776: and /adm/notfound.html if unsuccessful
10777:
10778: =item *
10779:
10780: clean_filename(): routine for cleaing a filename up for storage in
10781: userfile space, argument is:
10782:
10783: filename - proposed filename
10784:
10785: returns: the new clean filename
10786:
10787: =item *
10788:
10789: finishuserfileupload(): routine that creaes and sends the file to
10790: userspace, probably shouldn't be called directly
10791:
10792: docuname: username or courseid of destination for the file
10793: docudom: domain of user/course of destination for the file
10794: formname: same as for userfileupload()
10795: fname: filename (inculding subdirectories) for the file
10796:
10797: returns either the url of the uploaded file (/uploaded/....) if successful
10798: and /adm/notfound.html if unsuccessful
10799:
10800: =item *
10801:
10802: renameuserfile(): renames an existing userfile to a new name
10803:
10804: Args:
10805: docuname: username or courseid of destination for the file
10806: docudom: domain of user/course of destination for the file
10807: old: current file name (including any subdirs under userfiles)
10808: new: desired file name (including any subdirs under userfiles)
10809:
10810: =item *
10811:
10812: mkdiruserfile(): creates a directory is a userfiles dir
10813:
10814: Args:
10815: docuname: username or courseid of destination for the file
10816: docudom: domain of user/course of destination for the file
10817: dir: dir to create (including any subdirs under userfiles)
10818:
10819: =item *
10820:
10821: removeuserfile(): removes a file that exists in userfiles
10822:
10823: Args:
10824: docuname: username or courseid of destination for the file
10825: docudom: domain of user/course of destination for the file
10826: fname: filname to delete (including any subdirs under userfiles)
10827:
10828: =item *
10829:
10830: removeuploadedurl(): convience function for removeuserfile()
10831:
10832: Args:
10833: url: a full /uploaded/... url to delete
10834:
10835: =item *
10836:
10837: get_portfile_permissions():
10838: Args:
10839: domain: domain of user or course contain the portfolio files
10840: user: name of user or num of course contain the portfolio files
10841: Returns:
10842: hashref of a dump of the proper file_permissions.db
10843:
10844:
10845: =item *
10846:
10847: get_access_controls():
10848:
10849: Args:
10850: current_permissions: the hash ref returned from get_portfile_permissions()
10851: group: (optional) the group you want the files associated with
10852: file: (optional) the file you want access info on
10853:
10854: Returns:
10855: a hash (keys are file names) of hashes containing
10856: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10857: values are XML containing access control settings (see below)
10858:
10859: Internal notes:
10860:
10861: access controls are stored in file_permissions.db as key=value pairs.
10862: key -> path to file/file_name\0uniqueID:scope_end_start
10863: where scope -> public,guest,course,group,domains or users.
10864: end -> UNIX time for end of access (0 -> no end date)
10865: start -> UNIX time for start of access
10866:
10867: value -> XML description of access control
10868: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10869: <start></start>
10870: <end></end>
10871:
10872: <password></password> for scope type = guest
10873:
10874: <domain></domain> for scope type = course or group
10875: <number></number>
10876: <roles id="">
10877: <role></role>
10878: <access></access>
10879: <section></section>
10880: <group></group>
10881: </roles>
10882:
10883: <dom></dom> for scope type = domains
10884:
10885: <users> for scope type = users
10886: <user>
10887: <uname></uname>
10888: <udom></udom>
10889: </user>
10890: </users>
10891: </scope>
10892:
10893: Access data is also aggregated for each file in an additional key=value pair:
10894: key -> path to file/file_name\0accesscontrol
10895: value -> reference to hash
10896: hash contains key = value pairs
10897: where key = uniqueID:scope_end_start
10898: value = UNIX time record was last updated
10899:
10900: Used to improve speed of look-ups of access controls for each file.
10901:
10902: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10903:
10904: modify_access_controls():
10905:
10906: Modifies access controls for a portfolio file
10907: Args
10908: 1. file name
10909: 2. reference to hash of required changes,
10910: 3. domain
10911: 4. username
10912: where domain,username are the domain of the portfolio owner
10913: (either a user or a course)
10914:
10915: Returns:
10916: 1. result of additions or updates ('ok' or 'error', with error message).
10917: 2. result of deletions ('ok' or 'error', with error message).
10918: 3. reference to hash of any new or updated access controls.
10919: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10920: key = integer (inbound ID)
10921: value = uniqueID
10922:
10923: =back
10924:
10925: =head2 HTTP Helper Routines
10926:
10927: =over 4
10928:
10929: =item *
10930:
10931: escape() : unpack non-word characters into CGI-compatible hex codes
10932:
10933: =item *
10934:
10935: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10936:
10937: =back
10938:
10939: =head1 PRIVATE SUBROUTINES
10940:
10941: =head2 Underlying communication routines (Shouldn't call)
10942:
10943: =over 4
10944:
10945: =item *
10946:
10947: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10948:
10949: =item *
10950:
10951: reply() : uses subreply to send a message to remote machine, logs all failures
10952:
10953: =item *
10954:
10955: critical() : passes a critical message to another server; if cannot
10956: get through then place message in connection buffer directory and
10957: returns con_delayed, if incapable of saving message, returns
10958: con_failed
10959:
10960: =item *
10961:
10962: reconlonc() : tries to reconnect lonc client processes.
10963:
10964: =back
10965:
10966: =head2 Resource Access Logging
10967:
10968: =over 4
10969:
10970: =item *
10971:
10972: flushcourselogs() : flush (save) buffer logs and access logs
10973:
10974: =item *
10975:
10976: courselog($what) : save message for course in hash
10977:
10978: =item *
10979:
10980: courseacclog($what) : save message for course using &courselog(). Perform
10981: special processing for specific resource types (problems, exams, quizzes, etc).
10982:
10983: =item *
10984:
10985: goodbye() : flush course logs and log shutting down; it is called in srm.conf
10986: as a PerlChildExitHandler
10987:
10988: =back
10989:
10990: =head2 Other
10991:
10992: =over 4
10993:
10994: =item *
10995:
10996: symblist($mapname,%newhash) : update symbolic storage links
10997:
10998: =back
10999:
11000: =cut
11001:
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