1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.778 2006/09/05 20:42:15 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::lonnet;
31:
32: use strict;
33: use LWP::UserAgent();
34: use HTTP::Headers;
35: use HTTP::Date;
36: # use Date::Parse;
37: use vars
38: qw(%perlvar %hostname %badServerCache %iphost %spareid %hostdom
39: %libserv %pr %prp $memcache %packagetab
40: %courselogs %accesshash %userrolehash %domainrolehash $processmarker $dumpcount
41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf %coursetypebuf
42: %domaindescription %domain_auth_def %domain_auth_arg_def
43: %domain_lang_def %domain_city %domain_longi %domain_lati %domain_primary
44: $tmpdir $_64bit %env);
45:
46: use IO::Socket;
47: use GDBM_File;
48: use HTML::LCParser;
49: use HTML::Parser;
50: use Fcntl qw(:flock);
51: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
52: use Time::HiRes qw( gettimeofday tv_interval );
53: use Cache::Memcached;
54: use Digest::MD5;
55: use lib '/home/httpd/lib/perl';
56: use LONCAPA;
57: use LONCAPA::Configuration;
58:
59: my $readit;
60: my $max_connection_retries = 10; # Or some such value.
61:
62: require Exporter;
63:
64: our @ISA = qw (Exporter);
65: our @EXPORT = qw(%env);
66:
67: =pod
68:
69: =head1 Package Variables
70:
71: These are largely undocumented, so if you decipher one please note it here.
72:
73: =over 4
74:
75: =item $processmarker
76:
77: Contains the time this process was started and this servers host id.
78:
79: =item $dumpcount
80:
81: Counts the number of times a message log flush has been attempted (regardless
82: of success) by this process. Used as part of the filename when messages are
83: delayed.
84:
85: =back
86:
87: =cut
88:
89:
90: # --------------------------------------------------------------------- Logging
91: {
92: my $logid;
93: sub instructor_log {
94: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
95: $logid++;
96: my $id=time().'00000'.$$.'00000'.$logid;
97: return &Apache::lonnet::put('nohist_'.$hash_name,
98: { $id => {
99: 'exe_uname' => $env{'user.name'},
100: 'exe_udom' => $env{'user.domain'},
101: 'exe_time' => time(),
102: 'exe_ip' => $ENV{'REMOTE_ADDR'},
103: 'delflag' => $delflag,
104: 'logentry' => $storehash,
105: 'uname' => $uname,
106: 'udom' => $udom,
107: }
108: },
109: $env{'course.'.$env{'request.course.id'}.'.domain'},
110: $env{'course.'.$env{'request.course.id'}.'.num'}
111: );
112: }
113: }
114:
115: sub logtouch {
116: my $execdir=$perlvar{'lonDaemons'};
117: unless (-e "$execdir/logs/lonnet.log") {
118: open(my $fh,">>$execdir/logs/lonnet.log");
119: close $fh;
120: }
121: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
122: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
123: }
124:
125: sub logthis {
126: my $message=shift;
127: my $execdir=$perlvar{'lonDaemons'};
128: my $now=time;
129: my $local=localtime($now);
130: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
131: print $fh "$local ($$): $message\n";
132: close($fh);
133: }
134: return 1;
135: }
136:
137: sub logperm {
138: my $message=shift;
139: my $execdir=$perlvar{'lonDaemons'};
140: my $now=time;
141: my $local=localtime($now);
142: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
143: print $fh "$now:$message:$local\n";
144: close($fh);
145: }
146: return 1;
147: }
148:
149: # -------------------------------------------------- Non-critical communication
150: sub subreply {
151: my ($cmd,$server)=@_;
152: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
153: #
154: # With loncnew process trimming, there's a timing hole between lonc server
155: # process exit and the master server picking up the listen on the AF_UNIX
156: # socket. In that time interval, a lock file will exist:
157:
158: my $lockfile=$peerfile.".lock";
159: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
160: sleep(1);
161: }
162: # At this point, either a loncnew parent is listening or an old lonc
163: # or loncnew child is listening so we can connect or everything's dead.
164: #
165: # We'll give the connection a few tries before abandoning it. If
166: # connection is not possible, we'll con_lost back to the client.
167: #
168: my $client;
169: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
170: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
171: Type => SOCK_STREAM,
172: Timeout => 10);
173: if($client) {
174: last; # Connected!
175: }
176: sleep(1); # Try again later if failed connection.
177: }
178: my $answer;
179: if ($client) {
180: print $client "sethost:$server:$cmd\n";
181: $answer=<$client>;
182: if (!$answer) { $answer="con_lost"; }
183: chomp($answer);
184: } else {
185: $answer = 'con_lost'; # Failed connection.
186: }
187: return $answer;
188: }
189:
190: sub reply {
191: my ($cmd,$server)=@_;
192: unless (defined($hostname{$server})) { return 'no_such_host'; }
193: my $answer=subreply($cmd,$server);
194: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
195: &logthis("<font color=\"blue\">WARNING:".
196: " $cmd to $server returned $answer</font>");
197: }
198: return $answer;
199: }
200:
201: # ----------------------------------------------------------- Send USR1 to lonc
202:
203: sub reconlonc {
204: my $peerfile=shift;
205: &logthis("Trying to reconnect for $peerfile");
206: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
207: if (open(my $fh,"<$loncfile")) {
208: my $loncpid=<$fh>;
209: chomp($loncpid);
210: if (kill 0 => $loncpid) {
211: &logthis("lonc at pid $loncpid responding, sending USR1");
212: kill USR1 => $loncpid;
213: sleep 1;
214: if (-e "$peerfile") { return; }
215: &logthis("$peerfile still not there, give it another try");
216: sleep 5;
217: if (-e "$peerfile") { return; }
218: &logthis(
219: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
220: } else {
221: &logthis(
222: "<font color=\"blue\">WARNING:".
223: " lonc at pid $loncpid not responding, giving up</font>");
224: }
225: } else {
226: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
227: }
228: }
229:
230: # ------------------------------------------------------ Critical communication
231:
232: sub critical {
233: my ($cmd,$server)=@_;
234: unless ($hostname{$server}) {
235: &logthis("<font color=\"blue\">WARNING:".
236: " Critical message to unknown server ($server)</font>");
237: return 'no_such_host';
238: }
239: my $answer=reply($cmd,$server);
240: if ($answer eq 'con_lost') {
241: &reconlonc("$perlvar{'lonSockDir'}/$server");
242: my $answer=reply($cmd,$server);
243: if ($answer eq 'con_lost') {
244: my $now=time;
245: my $middlename=$cmd;
246: $middlename=substr($middlename,0,16);
247: $middlename=~s/\W//g;
248: my $dfilename=
249: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
250: $dumpcount++;
251: {
252: my $dfh;
253: if (open($dfh,">$dfilename")) {
254: print $dfh "$cmd\n";
255: close($dfh);
256: }
257: }
258: sleep 2;
259: my $wcmd='';
260: {
261: my $dfh;
262: if (open($dfh,"<$dfilename")) {
263: $wcmd=<$dfh>;
264: close($dfh);
265: }
266: }
267: chomp($wcmd);
268: if ($wcmd eq $cmd) {
269: &logthis("<font color=\"blue\">WARNING: ".
270: "Connection buffer $dfilename: $cmd</font>");
271: &logperm("D:$server:$cmd");
272: return 'con_delayed';
273: } else {
274: &logthis("<font color=\"red\">CRITICAL:"
275: ." Critical connection failed: $server $cmd</font>");
276: &logperm("F:$server:$cmd");
277: return 'con_failed';
278: }
279: }
280: }
281: return $answer;
282: }
283:
284: # ------------------------------------------- check if return value is an error
285:
286: sub error {
287: my ($result) = @_;
288: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
289: if ($2 == 2) { return undef; }
290: return $1;
291: }
292: return undef;
293: }
294:
295: # ------------------------------------------- Transfer profile into environment
296:
297: sub transfer_profile_to_env {
298: my ($lonidsdir,$handle)=@_;
299: if (!defined($lonidsdir)) {
300: $lonidsdir = $perlvar{'lonIDsDir'};
301: }
302: if (!defined($handle)) {
303: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
304: }
305:
306: my @profile;
307: {
308: open(my $idf,"$lonidsdir/$handle.id");
309: flock($idf,LOCK_SH);
310: @profile=<$idf>;
311: close($idf);
312: }
313: my $envi;
314: my %Remove;
315: for ($envi=0;$envi<=$#profile;$envi++) {
316: chomp($profile[$envi]);
317: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
318: $envname=&unescape($envname);
319: $envvalue=&unescape($envvalue);
320: $env{$envname} = $envvalue;
321: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
322: if ($time < time-300) {
323: $Remove{$key}++;
324: }
325: }
326: }
327: $env{'user.environment'} = "$lonidsdir/$handle.id";
328: foreach my $expired_key (keys(%Remove)) {
329: &delenv($expired_key);
330: }
331: }
332:
333: # ---------------------------------------------------------- Append Environment
334:
335: sub appenv {
336: my %newenv=@_;
337: foreach my $key (keys(%newenv)) {
338: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
339: &logthis("<font color=\"blue\">WARNING: ".
340: "Attempt to modify environment ".$key." to ".$newenv{$key}
341: .'</font>');
342: delete($newenv{$key});
343: } else {
344: $env{$key}=$newenv{$key};
345: }
346: }
347:
348: my $lockfh;
349: unless (open($lockfh,"$env{'user.environment'}")) {
350: return 'error: '.$!;
351: }
352: unless (flock($lockfh,LOCK_EX)) {
353: &logthis("<font color=\"blue\">WARNING: ".
354: 'Could not obtain exclusive lock in appenv: '.$!);
355: close($lockfh);
356: return 'error: '.$!;
357: }
358:
359: my @oldenv;
360: {
361: my $fh;
362: unless (open($fh,"$env{'user.environment'}")) {
363: return 'error: '.$!;
364: }
365: @oldenv=<$fh>;
366: close($fh);
367: }
368: for (my $i=0; $i<=$#oldenv; $i++) {
369: chomp($oldenv[$i]);
370: if ($oldenv[$i] ne '') {
371: my ($name,$value)=split(/=/,$oldenv[$i],2);
372: $name=&unescape($name);
373: $value=&unescape($value);
374: unless (defined($newenv{$name})) {
375: $newenv{$name}=$value;
376: }
377: }
378: }
379: {
380: my $fh;
381: unless (open($fh,">$env{'user.environment'}")) {
382: return 'error';
383: }
384: my $newname;
385: foreach $newname (keys %newenv) {
386: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
387: }
388: close($fh);
389: }
390:
391: close($lockfh);
392: return 'ok';
393: }
394: # ----------------------------------------------------- Delete from Environment
395:
396: sub delenv {
397: my $delthis=shift;
398: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
399: &logthis("<font color=\"blue\">WARNING: ".
400: "Attempt to delete from environment ".$delthis);
401: return 'error';
402: }
403: my @oldenv;
404: {
405: my $fh;
406: unless (open($fh,"$env{'user.environment'}")) {
407: return 'error';
408: }
409: unless (flock($fh,LOCK_SH)) {
410: &logthis("<font color=\"blue\">WARNING: ".
411: 'Could not obtain shared lock in delenv: '.$!);
412: close($fh);
413: return 'error: '.$!;
414: }
415: @oldenv=<$fh>;
416: close($fh);
417: }
418: {
419: my $fh;
420: unless (open($fh,">$env{'user.environment'}")) {
421: return 'error';
422: }
423: unless (flock($fh,LOCK_EX)) {
424: &logthis("<font color=\"blue\">WARNING: ".
425: 'Could not obtain exclusive lock in delenv: '.$!);
426: close($fh);
427: return 'error: '.$!;
428: }
429: foreach my $cur_key (@oldenv) {
430: my $unescaped_cur_key = &unescape($cur_key);
431: if ($unescaped_cur_key=~/^$delthis/) {
432: my ($key) = split('=',$cur_key,2);
433: $key = &unescape($key);
434: delete($env{$key});
435: } else {
436: print $fh $cur_key;
437: }
438: }
439: close($fh);
440: }
441: return 'ok';
442: }
443:
444: # ------------------------------------------ Find out current server userload
445: # there is a copy in lond
446: sub userload {
447: my $numusers=0;
448: {
449: opendir(LONIDS,$perlvar{'lonIDsDir'});
450: my $filename;
451: my $curtime=time;
452: while ($filename=readdir(LONIDS)) {
453: if ($filename eq '.' || $filename eq '..') {next;}
454: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
455: if ($curtime-$mtime < 1800) { $numusers++; }
456: }
457: closedir(LONIDS);
458: }
459: my $userloadpercent=0;
460: my $maxuserload=$perlvar{'lonUserLoadLim'};
461: if ($maxuserload) {
462: $userloadpercent=100*$numusers/$maxuserload;
463: }
464: $userloadpercent=sprintf("%.2f",$userloadpercent);
465: return $userloadpercent;
466: }
467:
468: # ------------------------------------------ Fight off request when overloaded
469:
470: sub overloaderror {
471: my ($r,$checkserver)=@_;
472: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
473: my $loadavg;
474: if ($checkserver eq $perlvar{'lonHostID'}) {
475: open(my $loadfile,'/proc/loadavg');
476: $loadavg=<$loadfile>;
477: $loadavg =~ s/\s.*//g;
478: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
479: close($loadfile);
480: } else {
481: $loadavg=&reply('load',$checkserver);
482: }
483: my $overload=$loadavg-100;
484: if ($overload>0) {
485: $r->err_headers_out->{'Retry-After'}=$overload;
486: $r->log_error('Overload of '.$overload.' on '.$checkserver);
487: return 413;
488: }
489: return '';
490: }
491:
492: # ------------------------------ Find server with least workload from spare.tab
493:
494: sub spareserver {
495: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
496: my $tryserver;
497: my $spareserver='';
498: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
499: my $lowestserver=$loadpercent > $userloadpercent?
500: $loadpercent : $userloadpercent;
501: foreach $tryserver (keys(%spareid)) {
502: my $loadans=&reply('load',$tryserver);
503: my $userloadans=&reply('userload',$tryserver);
504: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
505: next; #didn't get a number from the server
506: }
507: my $answer;
508: if ($loadans =~ /\d/) {
509: if ($userloadans =~ /\d/) {
510: #both are numbers, pick the bigger one
511: $answer=$loadans > $userloadans?
512: $loadans : $userloadans;
513: } else {
514: $answer = $loadans;
515: }
516: } else {
517: $answer = $userloadans;
518: }
519: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
520: if ($want_server_name) {
521: $spareserver=$tryserver;
522: } else {
523: $spareserver="http://$hostname{$tryserver}";
524: }
525: $lowestserver=$answer;
526: }
527: }
528: return $spareserver;
529: }
530:
531: # --------------------------------------------- Try to change a user's password
532:
533: sub changepass {
534: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
535: $currentpass = &escape($currentpass);
536: $newpass = &escape($newpass);
537: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
538: $server);
539: if (! $answer) {
540: &logthis("No reply on password change request to $server ".
541: "by $uname in domain $udom.");
542: } elsif ($answer =~ "^ok") {
543: &logthis("$uname in $udom successfully changed their password ".
544: "on $server.");
545: } elsif ($answer =~ "^pwchange_failure") {
546: &logthis("$uname in $udom was unable to change their password ".
547: "on $server. The action was blocked by either lcpasswd ".
548: "or pwchange");
549: } elsif ($answer =~ "^non_authorized") {
550: &logthis("$uname in $udom did not get their password correct when ".
551: "attempting to change it on $server.");
552: } elsif ($answer =~ "^auth_mode_error") {
553: &logthis("$uname in $udom attempted to change their password despite ".
554: "not being locally or internally authenticated on $server.");
555: } elsif ($answer =~ "^unknown_user") {
556: &logthis("$uname in $udom attempted to change their password ".
557: "on $server but were unable to because $server is not ".
558: "their home server.");
559: } elsif ($answer =~ "^refused") {
560: &logthis("$server refused to change $uname in $udom password because ".
561: "it was sent an unencrypted request to change the password.");
562: }
563: return $answer;
564: }
565:
566: # ----------------------- Try to determine user's current authentication scheme
567:
568: sub queryauthenticate {
569: my ($uname,$udom)=@_;
570: my $uhome=&homeserver($uname,$udom);
571: if (!$uhome) {
572: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
573: return 'no_host';
574: }
575: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
576: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
577: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
578: }
579: return $answer;
580: }
581:
582: # --------- Try to authenticate user from domain's lib servers (first this one)
583:
584: sub authenticate {
585: my ($uname,$upass,$udom)=@_;
586: $upass=escape($upass);
587: $uname=~s/\W//g;
588: my $uhome=&homeserver($uname,$udom);
589: if (!$uhome) {
590: &logthis("User $uname at $udom is unknown in authenticate");
591: return 'no_host';
592: }
593: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
594: if ($answer eq 'authorized') {
595: &logthis("User $uname at $udom authorized by $uhome");
596: return $uhome;
597: }
598: if ($answer eq 'non_authorized') {
599: &logthis("User $uname at $udom rejected by $uhome");
600: return 'no_host';
601: }
602: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
603: return 'no_host';
604: }
605:
606: # ---------------------- Find the homebase for a user from domain's lib servers
607:
608: my %homecache;
609: sub homeserver {
610: my ($uname,$udom,$ignoreBadCache)=@_;
611: my $index="$uname:$udom";
612:
613: if (exists($homecache{$index})) { return $homecache{$index}; }
614: my $tryserver;
615: foreach $tryserver (keys %libserv) {
616: next if ($ignoreBadCache ne 'true' &&
617: exists($badServerCache{$tryserver}));
618: if ($hostdom{$tryserver} eq $udom) {
619: my $answer=reply("home:$udom:$uname",$tryserver);
620: if ($answer eq 'found') {
621: return $homecache{$index}=$tryserver;
622: } elsif ($answer eq 'no_host') {
623: $badServerCache{$tryserver}=1;
624: }
625: }
626: }
627: return 'no_host';
628: }
629:
630: # ------------------------------------- Find the usernames behind a list of IDs
631:
632: sub idget {
633: my ($udom,@ids)=@_;
634: my %returnhash=();
635:
636: my $tryserver;
637: foreach $tryserver (keys %libserv) {
638: if ($hostdom{$tryserver} eq $udom) {
639: my $idlist=join('&',@ids);
640: $idlist=~tr/A-Z/a-z/;
641: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
642: my @answer=();
643: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
644: @answer=split(/\&/,$reply);
645: } ;
646: my $i;
647: for ($i=0;$i<=$#ids;$i++) {
648: if ($answer[$i]) {
649: $returnhash{$ids[$i]}=$answer[$i];
650: }
651: }
652: }
653: }
654: return %returnhash;
655: }
656:
657: # ------------------------------------- Find the IDs behind a list of usernames
658:
659: sub idrget {
660: my ($udom,@unames)=@_;
661: my %returnhash=();
662: foreach (@unames) {
663: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
664: }
665: return %returnhash;
666: }
667:
668: # ------------------------------- Store away a list of names and associated IDs
669:
670: sub idput {
671: my ($udom,%ids)=@_;
672: my %servers=();
673: foreach (keys %ids) {
674: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
675: my $uhom=&homeserver($_,$udom);
676: if ($uhom ne 'no_host') {
677: my $id=&escape($ids{$_});
678: $id=~tr/A-Z/a-z/;
679: my $unam=&escape($_);
680: if ($servers{$uhom}) {
681: $servers{$uhom}.='&'.$id.'='.$unam;
682: } else {
683: $servers{$uhom}=$id.'='.$unam;
684: }
685: }
686: }
687: foreach (keys %servers) {
688: &critical('idput:'.$udom.':'.$servers{$_},$_);
689: }
690: }
691:
692: # --------------------------------------------------- Assign a key to a student
693:
694: sub assign_access_key {
695: #
696: # a valid key looks like uname:udom#comments
697: # comments are being appended
698: #
699: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
700: $kdom=
701: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
702: $knum=
703: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
704: $cdom=
705: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
706: $cnum=
707: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
708: $udom=$env{'user.name'} unless (defined($udom));
709: $uname=$env{'user.domain'} unless (defined($uname));
710: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
711: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
712: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
713: # assigned to this person
714: # - this should not happen,
715: # unless something went wrong
716: # the first time around
717: # ready to assign
718: $logentry=$1.'; '.$logentry;
719: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
720: $kdom,$knum) eq 'ok') {
721: # key now belongs to user
722: my $envkey='key.'.$cdom.'_'.$cnum;
723: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
724: &appenv('environment.'.$envkey => $ckey);
725: return 'ok';
726: } else {
727: return
728: 'error: Count not permanently assign key, will need to be re-entered later.';
729: }
730: } else {
731: return 'error: Could not assign key, try again later.';
732: }
733: } elsif (!$existing{$ckey}) {
734: # the key does not exist
735: return 'error: The key does not exist';
736: } else {
737: # the key is somebody else's
738: return 'error: The key is already in use';
739: }
740: }
741:
742: # ------------------------------------------ put an additional comment on a key
743:
744: sub comment_access_key {
745: #
746: # a valid key looks like uname:udom#comments
747: # comments are being appended
748: #
749: my ($ckey,$cdom,$cnum,$logentry)=@_;
750: $cdom=
751: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
752: $cnum=
753: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
754: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
755: if ($existing{$ckey}) {
756: $existing{$ckey}.='; '.$logentry;
757: # ready to assign
758: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
759: $cdom,$cnum) eq 'ok') {
760: return 'ok';
761: } else {
762: return 'error: Count not store comment.';
763: }
764: } else {
765: # the key does not exist
766: return 'error: The key does not exist';
767: }
768: }
769:
770: # ------------------------------------------------------ Generate a set of keys
771:
772: sub generate_access_keys {
773: my ($number,$cdom,$cnum,$logentry)=@_;
774: $cdom=
775: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
776: $cnum=
777: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
778: unless (&allowed('mky',$cdom)) { return 0; }
779: unless (($cdom) && ($cnum)) { return 0; }
780: if ($number>10000) { return 0; }
781: sleep(2); # make sure don't get same seed twice
782: srand(time()^($$+($$<<15))); # from "Programming Perl"
783: my $total=0;
784: for (my $i=1;$i<=$number;$i++) {
785: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
786: sprintf("%lx",int(100000*rand)).'-'.
787: sprintf("%lx",int(100000*rand));
788: $newkey=~s/1/g/g; # folks mix up 1 and l
789: $newkey=~s/0/h/g; # and also 0 and O
790: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
791: if ($existing{$newkey}) {
792: $i--;
793: } else {
794: if (&put('accesskeys',
795: { $newkey => '# generated '.localtime().
796: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
797: '; '.$logentry },
798: $cdom,$cnum) eq 'ok') {
799: $total++;
800: }
801: }
802: }
803: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
804: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
805: return $total;
806: }
807:
808: # ------------------------------------------------------- Validate an accesskey
809:
810: sub validate_access_key {
811: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
812: $cdom=
813: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
814: $cnum=
815: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
816: $udom=$env{'user.domain'} unless (defined($udom));
817: $uname=$env{'user.name'} unless (defined($uname));
818: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
819: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
820: }
821:
822: # ------------------------------------- Find the section of student in a course
823: sub devalidate_getsection_cache {
824: my ($udom,$unam,$courseid)=@_;
825: $courseid=~s/\_/\//g;
826: $courseid=~s/^(\w)/\/$1/;
827: my $hashid="$udom:$unam:$courseid";
828: &devalidate_cache_new('getsection',$hashid);
829: }
830:
831: sub getsection {
832: my ($udom,$unam,$courseid)=@_;
833: my $cachetime=1800;
834: $courseid=~s/\_/\//g;
835: $courseid=~s/^(\w)/\/$1/;
836:
837: my $hashid="$udom:$unam:$courseid";
838: my ($result,$cached)=&is_cached_new('getsection',$hashid);
839: if (defined($cached)) { return $result; }
840:
841: my %Pending;
842: my %Expired;
843: #
844: # Each role can either have not started yet (pending), be active,
845: # or have expired.
846: #
847: # If there is an active role, we are done.
848: #
849: # If there is more than one role which has not started yet,
850: # choose the one which will start sooner
851: # If there is one role which has not started yet, return it.
852: #
853: # If there is more than one expired role, choose the one which ended last.
854: # If there is a role which has expired, return it.
855: #
856: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
857: &homeserver($unam,$udom)))) {
858: my ($key,$value)=split(/\=/,$_);
859: $key=&unescape($key);
860: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
861: my $section=$1;
862: if ($key eq $courseid.'_st') { $section=''; }
863: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
864: my $now=time;
865: if (defined($end) && $end && ($now > $end)) {
866: $Expired{$end}=$section;
867: next;
868: }
869: if (defined($start) && $start && ($now < $start)) {
870: $Pending{$start}=$section;
871: next;
872: }
873: return &do_cache_new('getsection',$hashid,$section,$cachetime);
874: }
875: #
876: # Presumedly there will be few matching roles from the above
877: # loop and the sorting time will be negligible.
878: if (scalar(keys(%Pending))) {
879: my ($time) = sort {$a <=> $b} keys(%Pending);
880: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
881: }
882: if (scalar(keys(%Expired))) {
883: my @sorted = sort {$a <=> $b} keys(%Expired);
884: my $time = pop(@sorted);
885: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
886: }
887: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
888: }
889:
890: sub save_cache {
891: &purge_remembered();
892: #&Apache::loncommon::validate_page();
893: undef(%env);
894: }
895:
896: my $to_remember=-1;
897: my %remembered;
898: my %accessed;
899: my $kicks=0;
900: my $hits=0;
901: sub devalidate_cache_new {
902: my ($name,$id,$debug) = @_;
903: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
904: $id=&escape($name.':'.$id);
905: $memcache->delete($id);
906: delete($remembered{$id});
907: delete($accessed{$id});
908: }
909:
910: sub is_cached_new {
911: my ($name,$id,$debug) = @_;
912: $id=&escape($name.':'.$id);
913: if (exists($remembered{$id})) {
914: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
915: $accessed{$id}=[&gettimeofday()];
916: $hits++;
917: return ($remembered{$id},1);
918: }
919: my $value = $memcache->get($id);
920: if (!(defined($value))) {
921: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
922: return (undef,undef);
923: }
924: if ($value eq '__undef__') {
925: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
926: $value=undef;
927: }
928: &make_room($id,$value,$debug);
929: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
930: return ($value,1);
931: }
932:
933: sub do_cache_new {
934: my ($name,$id,$value,$time,$debug) = @_;
935: $id=&escape($name.':'.$id);
936: my $setvalue=$value;
937: if (!defined($setvalue)) {
938: $setvalue='__undef__';
939: }
940: if (!defined($time) ) {
941: $time=600;
942: }
943: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
944: $memcache->set($id,$setvalue,$time);
945: # need to make a copy of $value
946: #&make_room($id,$value,$debug);
947: return $value;
948: }
949:
950: sub make_room {
951: my ($id,$value,$debug)=@_;
952: $remembered{$id}=$value;
953: if ($to_remember<0) { return; }
954: $accessed{$id}=[&gettimeofday()];
955: if (scalar(keys(%remembered)) <= $to_remember) { return; }
956: my $to_kick;
957: my $max_time=0;
958: foreach my $other (keys(%accessed)) {
959: if (&tv_interval($accessed{$other}) > $max_time) {
960: $to_kick=$other;
961: $max_time=&tv_interval($accessed{$other});
962: }
963: }
964: delete($remembered{$to_kick});
965: delete($accessed{$to_kick});
966: $kicks++;
967: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
968: return;
969: }
970:
971: sub purge_remembered {
972: #&logthis("Tossing ".scalar(keys(%remembered)));
973: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
974: undef(%remembered);
975: undef(%accessed);
976: }
977: # ------------------------------------- Read an entry from a user's environment
978:
979: sub userenvironment {
980: my ($udom,$unam,@what)=@_;
981: my %returnhash=();
982: my @answer=split(/\&/,
983: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
984: &homeserver($unam,$udom)));
985: my $i;
986: for ($i=0;$i<=$#what;$i++) {
987: $returnhash{$what[$i]}=&unescape($answer[$i]);
988: }
989: return %returnhash;
990: }
991:
992: # ---------------------------------------------------------- Get a studentphoto
993: sub studentphoto {
994: my ($udom,$unam,$ext) = @_;
995: my $home=&Apache::lonnet::homeserver($unam,$udom);
996: if (defined($env{'request.course.id'})) {
997: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
998: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
999: return(&retrievestudentphoto($udom,$unam,$ext));
1000: } else {
1001: my ($result,$perm_reqd)=
1002: &Apache::lonnet::auto_photo_permission($unam,$udom);
1003: if ($result eq 'ok') {
1004: if (!($perm_reqd eq 'yes')) {
1005: return(&retrievestudentphoto($udom,$unam,$ext));
1006: }
1007: }
1008: }
1009: }
1010: } else {
1011: my ($result,$perm_reqd) =
1012: &Apache::lonnet::auto_photo_permission($unam,$udom);
1013: if ($result eq 'ok') {
1014: if (!($perm_reqd eq 'yes')) {
1015: return(&retrievestudentphoto($udom,$unam,$ext));
1016: }
1017: }
1018: }
1019: return '/adm/lonKaputt/lonlogo_broken.gif';
1020: }
1021:
1022: sub retrievestudentphoto {
1023: my ($udom,$unam,$ext,$type) = @_;
1024: my $home=&Apache::lonnet::homeserver($unam,$udom);
1025: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1026: if ($ret eq 'ok') {
1027: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1028: if ($type eq 'thumbnail') {
1029: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1030: }
1031: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1032: return $tokenurl;
1033: } else {
1034: if ($type eq 'thumbnail') {
1035: return '/adm/lonKaputt/genericstudent_tn.gif';
1036: } else {
1037: return '/adm/lonKaputt/lonlogo_broken.gif';
1038: }
1039: }
1040: }
1041:
1042: # -------------------------------------------------------------------- New chat
1043:
1044: sub chatsend {
1045: my ($newentry,$anon,$group)=@_;
1046: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1047: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1048: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1049: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1050: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1051: &escape($newentry)).':'.$group,$chome);
1052: }
1053:
1054: # ------------------------------------------ Find current version of a resource
1055:
1056: sub getversion {
1057: my $fname=&clutter(shift);
1058: unless ($fname=~/^\/res\//) { return -1; }
1059: return ¤tversion(&filelocation('',$fname));
1060: }
1061:
1062: sub currentversion {
1063: my $fname=shift;
1064: my ($result,$cached)=&is_cached_new('resversion',$fname);
1065: if (defined($cached)) { return $result; }
1066: my $author=$fname;
1067: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1068: my ($udom,$uname)=split(/\//,$author);
1069: my $home=homeserver($uname,$udom);
1070: if ($home eq 'no_host') {
1071: return -1;
1072: }
1073: my $answer=reply("currentversion:$fname",$home);
1074: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1075: return -1;
1076: }
1077: return &do_cache_new('resversion',$fname,$answer,600);
1078: }
1079:
1080: # ----------------------------- Subscribe to a resource, return URL if possible
1081:
1082: sub subscribe {
1083: my $fname=shift;
1084: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1085: $fname=~s/[\n\r]//g;
1086: my $author=$fname;
1087: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1088: my ($udom,$uname)=split(/\//,$author);
1089: my $home=homeserver($uname,$udom);
1090: if ($home eq 'no_host') {
1091: return 'not_found';
1092: }
1093: my $answer=reply("sub:$fname",$home);
1094: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1095: $answer.=' by '.$home;
1096: }
1097: return $answer;
1098: }
1099:
1100: # -------------------------------------------------------------- Replicate file
1101:
1102: sub repcopy {
1103: my $filename=shift;
1104: $filename=~s/\/+/\//g;
1105: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1106: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1107: if ($filename=~m|^/home/httpd/html/userfiles/| or
1108: $filename=~m -^/*(uploaded|editupload)/-) {
1109: return &repcopy_userfile($filename);
1110: }
1111: $filename=~s/[\n\r]//g;
1112: my $transname="$filename.in.transfer";
1113: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1114: my $remoteurl=subscribe($filename);
1115: if ($remoteurl =~ /^con_lost by/) {
1116: &logthis("Subscribe returned $remoteurl: $filename");
1117: return 'unavailable';
1118: } elsif ($remoteurl eq 'not_found') {
1119: #&logthis("Subscribe returned not_found: $filename");
1120: return 'not_found';
1121: } elsif ($remoteurl =~ /^rejected by/) {
1122: &logthis("Subscribe returned $remoteurl: $filename");
1123: return 'forbidden';
1124: } elsif ($remoteurl eq 'directory') {
1125: return 'ok';
1126: } else {
1127: my $author=$filename;
1128: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1129: my ($udom,$uname)=split(/\//,$author);
1130: my $home=homeserver($uname,$udom);
1131: unless ($home eq $perlvar{'lonHostID'}) {
1132: my @parts=split(/\//,$filename);
1133: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1134: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1135: &logthis("Malconfiguration for replication: $filename");
1136: return 'bad_request';
1137: }
1138: my $count;
1139: for ($count=5;$count<$#parts;$count++) {
1140: $path.="/$parts[$count]";
1141: if ((-e $path)!=1) {
1142: mkdir($path,0777);
1143: }
1144: }
1145: my $ua=new LWP::UserAgent;
1146: my $request=new HTTP::Request('GET',"$remoteurl");
1147: my $response=$ua->request($request,$transname);
1148: if ($response->is_error()) {
1149: unlink($transname);
1150: my $message=$response->status_line;
1151: &logthis("<font color=\"blue\">WARNING:"
1152: ." LWP get: $message: $filename</font>");
1153: return 'unavailable';
1154: } else {
1155: if ($remoteurl!~/\.meta$/) {
1156: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1157: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1158: if ($mresponse->is_error()) {
1159: unlink($filename.'.meta');
1160: &logthis(
1161: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1162: }
1163: }
1164: rename($transname,$filename);
1165: return 'ok';
1166: }
1167: }
1168: }
1169: }
1170:
1171: # ------------------------------------------------ Get server side include body
1172: sub ssi_body {
1173: my ($filelink,%form)=@_;
1174: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1175: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1176: }
1177: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1178: &ssi($filelink,%form));
1179: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1180: $output=~s/^.*?\<body[^\>]*\>//si;
1181: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1182: return $output;
1183: }
1184:
1185: # --------------------------------------------------------- Server Side Include
1186:
1187: sub ssi {
1188:
1189: my ($fn,%form)=@_;
1190:
1191: my $ua=new LWP::UserAgent;
1192:
1193: my $request;
1194:
1195: $form{'no_update_last_known'}=1;
1196:
1197: if (%form) {
1198: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1199: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1200: } else {
1201: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1202: }
1203:
1204: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1205: my $response=$ua->request($request);
1206:
1207: return $response->content;
1208: }
1209:
1210: sub externalssi {
1211: my ($url)=@_;
1212: my $ua=new LWP::UserAgent;
1213: my $request=new HTTP::Request('GET',$url);
1214: my $response=$ua->request($request);
1215: return $response->content;
1216: }
1217:
1218: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1219:
1220: sub allowuploaded {
1221: my ($srcurl,$url)=@_;
1222: $url=&clutter(&declutter($url));
1223: my $dir=$url;
1224: $dir=~s/\/[^\/]+$//;
1225: my %httpref=();
1226: my $httpurl=&hreflocation('',$url);
1227: $httpref{'httpref.'.$httpurl}=$srcurl;
1228: &Apache::lonnet::appenv(%httpref);
1229: }
1230:
1231: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1232: # input: action, courseID, current domain, intended
1233: # path to file, source of file, instruction to parse file for objects,
1234: # ref to hash for embedded objects,
1235: # ref to hash for codebase of java objects.
1236: #
1237: # output: url to file (if action was uploaddoc),
1238: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1239: #
1240: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1241: # course.
1242: #
1243: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1244: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1245: # course's home server.
1246: #
1247: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1248: # be copied from $source (current location) to
1249: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1250: # and will then be copied to
1251: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1252: # course's home server.
1253: #
1254: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1255: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1256: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1257: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1258: # in course's home server.
1259: #
1260:
1261: sub process_coursefile {
1262: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1263: my $fetchresult;
1264: my $home=&homeserver($docuname,$docudom);
1265: if ($action eq 'propagate') {
1266: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1267: $home);
1268: } else {
1269: my $fpath = '';
1270: my $fname = $file;
1271: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1272: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1273: my $filepath = &build_filepath($fpath);
1274: if ($action eq 'copy') {
1275: if ($source eq '') {
1276: $fetchresult = 'no source file';
1277: return $fetchresult;
1278: } else {
1279: my $destination = $filepath.'/'.$fname;
1280: rename($source,$destination);
1281: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1282: $home);
1283: }
1284: } elsif ($action eq 'uploaddoc') {
1285: open(my $fh,'>'.$filepath.'/'.$fname);
1286: print $fh $env{'form.'.$source};
1287: close($fh);
1288: if ($parser eq 'parse') {
1289: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1290: unless ($parse_result eq 'ok') {
1291: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1292: }
1293: }
1294: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1295: $home);
1296: if ($fetchresult eq 'ok') {
1297: return '/uploaded/'.$fpath.'/'.$fname;
1298: } else {
1299: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1300: ' to host '.$home.': '.$fetchresult);
1301: return '/adm/notfound.html';
1302: }
1303: }
1304: }
1305: unless ( $fetchresult eq 'ok') {
1306: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1307: ' to host '.$home.': '.$fetchresult);
1308: }
1309: return $fetchresult;
1310: }
1311:
1312: sub build_filepath {
1313: my ($fpath) = @_;
1314: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1315: unless ($fpath eq '') {
1316: my @parts=split('/',$fpath);
1317: foreach my $part (@parts) {
1318: $filepath.= '/'.$part;
1319: if ((-e $filepath)!=1) {
1320: mkdir($filepath,0777);
1321: }
1322: }
1323: }
1324: return $filepath;
1325: }
1326:
1327: sub store_edited_file {
1328: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1329: my $file = $primary_url;
1330: $file =~ s#^/uploaded/$docudom/$docuname/##;
1331: my $fpath = '';
1332: my $fname = $file;
1333: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1334: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1335: my $filepath = &build_filepath($fpath);
1336: open(my $fh,'>'.$filepath.'/'.$fname);
1337: print $fh $content;
1338: close($fh);
1339: my $home=&homeserver($docuname,$docudom);
1340: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1341: $home);
1342: if ($$fetchresult eq 'ok') {
1343: return '/uploaded/'.$fpath.'/'.$fname;
1344: } else {
1345: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1346: ' to host '.$home.': '.$$fetchresult);
1347: return '/adm/notfound.html';
1348: }
1349: }
1350:
1351: sub clean_filename {
1352: my ($fname)=@_;
1353: # Replace Windows backslashes by forward slashes
1354: $fname=~s/\\/\//g;
1355: # Get rid of everything but the actual filename
1356: $fname=~s/^.*\/([^\/]+)$/$1/;
1357: # Replace spaces by underscores
1358: $fname=~s/\s+/\_/g;
1359: # Replace all other weird characters by nothing
1360: $fname=~s/[^\w\.\-]//g;
1361: # Replace all .\d. sequences with _\d. so they no longer look like version
1362: # numbers
1363: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1364: return $fname;
1365: }
1366:
1367: # --------------- Take an uploaded file and put it into the userfiles directory
1368: # input: $formname - the contents of the file are in $env{"form.$formname"}
1369: # the desired filenam is in $env{"form.$formname.filename"}
1370: # $coursedoc - if true up to the current course
1371: # if false
1372: # $subdir - directory in userfile to store the file into
1373: # $parser, $allfiles, $codebase - unknown
1374: #
1375: # output: url of file in userspace, or error: <message>
1376: # or /adm/notfound.html if failure to upload occurse
1377:
1378:
1379: sub userfileupload {
1380: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1381: if (!defined($subdir)) { $subdir='unknown'; }
1382: my $fname=$env{'form.'.$formname.'.filename'};
1383: $fname=&clean_filename($fname);
1384: # See if there is anything left
1385: unless ($fname) { return 'error: no uploaded file'; }
1386: chop($env{'form.'.$formname});
1387: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1388: my $now = time;
1389: my $filepath = 'tmp/helprequests/'.$now;
1390: my @parts=split(/\//,$filepath);
1391: my $fullpath = $perlvar{'lonDaemons'};
1392: for (my $i=0;$i<@parts;$i++) {
1393: $fullpath .= '/'.$parts[$i];
1394: if ((-e $fullpath)!=1) {
1395: mkdir($fullpath,0777);
1396: }
1397: }
1398: open(my $fh,'>'.$fullpath.'/'.$fname);
1399: print $fh $env{'form.'.$formname};
1400: close($fh);
1401: return $fullpath.'/'.$fname;
1402: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1403: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1404: '_'.$env{'user.domain'}.'/pending';
1405: my @parts=split(/\//,$filepath);
1406: my $fullpath = $perlvar{'lonDaemons'};
1407: for (my $i=0;$i<@parts;$i++) {
1408: $fullpath .= '/'.$parts[$i];
1409: if ((-e $fullpath)!=1) {
1410: mkdir($fullpath,0777);
1411: }
1412: }
1413: open(my $fh,'>'.$fullpath.'/'.$fname);
1414: print $fh $env{'form.'.$formname};
1415: close($fh);
1416: return $fullpath.'/'.$fname;
1417: }
1418:
1419: # Create the directory if not present
1420: $fname="$subdir/$fname";
1421: if ($coursedoc) {
1422: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1423: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1424: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1425: return &finishuserfileupload($docuname,$docudom,
1426: $formname,$fname,$parser,$allfiles,
1427: $codebase);
1428: } else {
1429: $fname=$env{'form.folder'}.'/'.$fname;
1430: return &process_coursefile('uploaddoc',$docuname,$docudom,
1431: $fname,$formname,$parser,
1432: $allfiles,$codebase);
1433: }
1434: } elsif (defined($destuname)) {
1435: my $docuname=$destuname;
1436: my $docudom=$destudom;
1437: return &finishuserfileupload($docuname,$docudom,$formname,
1438: $fname,$parser,$allfiles,$codebase);
1439:
1440: } else {
1441: my $docuname=$env{'user.name'};
1442: my $docudom=$env{'user.domain'};
1443: if (exists($env{'form.group'})) {
1444: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1445: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1446: }
1447: return &finishuserfileupload($docuname,$docudom,$formname,
1448: $fname,$parser,$allfiles,$codebase);
1449: }
1450: }
1451:
1452: sub finishuserfileupload {
1453: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1454: my $path=$docudom.'/'.$docuname.'/';
1455: my $filepath=$perlvar{'lonDocRoot'};
1456: my ($fnamepath,$file);
1457: $file=$fname;
1458: if ($fname=~m|/|) {
1459: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1460: $path.=$fnamepath.'/';
1461: }
1462: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1463: my $count;
1464: for ($count=4;$count<=$#parts;$count++) {
1465: $filepath.="/$parts[$count]";
1466: if ((-e $filepath)!=1) {
1467: mkdir($filepath,0777);
1468: }
1469: }
1470: # Save the file
1471: {
1472: if (!open(FH,'>'.$filepath.'/'.$file)) {
1473: &logthis('Failed to create '.$filepath.'/'.$file);
1474: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1475: return '/adm/notfound.html';
1476: }
1477: if (!print FH ($env{'form.'.$formname})) {
1478: &logthis('Failed to write to '.$filepath.'/'.$file);
1479: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1480: return '/adm/notfound.html';
1481: }
1482: close(FH);
1483: }
1484: if ($parser eq 'parse') {
1485: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1486: $codebase);
1487: unless ($parse_result eq 'ok') {
1488: &logthis('Failed to parse '.$filepath.$file.
1489: ' for embedded media: '.$parse_result);
1490: }
1491: }
1492: # Notify homeserver to grep it
1493: #
1494: my $docuhome=&homeserver($docuname,$docudom);
1495: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1496: if ($fetchresult eq 'ok') {
1497: #
1498: # Return the URL to it
1499: return '/uploaded/'.$path.$file;
1500: } else {
1501: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1502: ': '.$fetchresult);
1503: return '/adm/notfound.html';
1504: }
1505: }
1506:
1507: sub extract_embedded_items {
1508: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1509: my @state = ();
1510: my %javafiles = (
1511: codebase => '',
1512: code => '',
1513: archive => ''
1514: );
1515: my %mediafiles = (
1516: src => '',
1517: movie => '',
1518: );
1519: my $p;
1520: if ($content) {
1521: $p = HTML::LCParser->new($content);
1522: } else {
1523: $p = HTML::LCParser->new($filepath.'/'.$file);
1524: }
1525: while (my $t=$p->get_token()) {
1526: if ($t->[0] eq 'S') {
1527: my ($tagname, $attr) = ($t->[1],$t->[2]);
1528: push (@state, $tagname);
1529: if (lc($tagname) eq 'allow') {
1530: &add_filetype($allfiles,$attr->{'src'},'src');
1531: }
1532: if (lc($tagname) eq 'img') {
1533: &add_filetype($allfiles,$attr->{'src'},'src');
1534: }
1535: if (lc($tagname) eq 'script') {
1536: if ($attr->{'archive'} =~ /\.jar$/i) {
1537: &add_filetype($allfiles,$attr->{'archive'},'archive');
1538: } else {
1539: &add_filetype($allfiles,$attr->{'src'},'src');
1540: }
1541: }
1542: if (lc($tagname) eq 'link') {
1543: if (lc($attr->{'rel'}) eq 'stylesheet') {
1544: &add_filetype($allfiles,$attr->{'href'},'href');
1545: }
1546: }
1547: if (lc($tagname) eq 'object' ||
1548: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1549: foreach my $item (keys(%javafiles)) {
1550: $javafiles{$item} = '';
1551: }
1552: }
1553: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1554: my $name = lc($attr->{'name'});
1555: foreach my $item (keys(%javafiles)) {
1556: if ($name eq $item) {
1557: $javafiles{$item} = $attr->{'value'};
1558: last;
1559: }
1560: }
1561: foreach my $item (keys(%mediafiles)) {
1562: if ($name eq $item) {
1563: &add_filetype($allfiles, $attr->{'value'}, 'value');
1564: last;
1565: }
1566: }
1567: }
1568: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1569: foreach my $item (keys(%javafiles)) {
1570: if ($attr->{$item}) {
1571: $javafiles{$item} = $attr->{$item};
1572: last;
1573: }
1574: }
1575: foreach my $item (keys(%mediafiles)) {
1576: if ($attr->{$item}) {
1577: &add_filetype($allfiles,$attr->{$item},$item);
1578: last;
1579: }
1580: }
1581: }
1582: } elsif ($t->[0] eq 'E') {
1583: my ($tagname) = ($t->[1]);
1584: if ($javafiles{'codebase'} ne '') {
1585: $javafiles{'codebase'} .= '/';
1586: }
1587: if (lc($tagname) eq 'applet' ||
1588: lc($tagname) eq 'object' ||
1589: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1590: ) {
1591: foreach my $item (keys(%javafiles)) {
1592: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1593: my $file=$javafiles{'codebase'}.$javafiles{$item};
1594: &add_filetype($allfiles,$file,$item);
1595: }
1596: }
1597: }
1598: pop @state;
1599: }
1600: }
1601: return 'ok';
1602: }
1603:
1604: sub add_filetype {
1605: my ($allfiles,$file,$type)=@_;
1606: if (exists($allfiles->{$file})) {
1607: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1608: push(@{$allfiles->{$file}}, &escape($type));
1609: }
1610: } else {
1611: @{$allfiles->{$file}} = (&escape($type));
1612: }
1613: }
1614:
1615: sub removeuploadedurl {
1616: my ($url)=@_;
1617: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1618: return &removeuserfile($uname,$udom,$fname);
1619: }
1620:
1621: sub removeuserfile {
1622: my ($docuname,$docudom,$fname)=@_;
1623: my $home=&homeserver($docuname,$docudom);
1624: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1625: }
1626:
1627: sub mkdiruserfile {
1628: my ($docuname,$docudom,$dir)=@_;
1629: my $home=&homeserver($docuname,$docudom);
1630: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1631: }
1632:
1633: sub renameuserfile {
1634: my ($docuname,$docudom,$old,$new)=@_;
1635: my $home=&homeserver($docuname,$docudom);
1636: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1637: &escape("$new"),$home);
1638: }
1639:
1640: # ------------------------------------------------------------------------- Log
1641:
1642: sub log {
1643: my ($dom,$nam,$hom,$what)=@_;
1644: return critical("log:$dom:$nam:$what",$hom);
1645: }
1646:
1647: # ------------------------------------------------------------------ Course Log
1648: #
1649: # This routine flushes several buffers of non-mission-critical nature
1650: #
1651:
1652: sub flushcourselogs {
1653: &logthis('Flushing log buffers');
1654: #
1655: # course logs
1656: # This is a log of all transactions in a course, which can be used
1657: # for data mining purposes
1658: #
1659: # It also collects the courseid database, which lists last transaction
1660: # times and course titles for all courseids
1661: #
1662: my %courseidbuffer=();
1663: foreach (keys %courselogs) {
1664: my $crsid=$_;
1665: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1666: &escape($courselogs{$crsid}),
1667: $coursehombuf{$crsid}) eq 'ok') {
1668: delete $courselogs{$crsid};
1669: } else {
1670: &logthis('Failed to flush log buffer for '.$crsid);
1671: if (length($courselogs{$crsid})>40000) {
1672: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1673: " exceeded maximum size, deleting.</font>");
1674: delete $courselogs{$crsid};
1675: }
1676: }
1677: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1678: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1679: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1680: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1681: } else {
1682: $courseidbuffer{$coursehombuf{$crsid}}=
1683: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1684: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1685: }
1686: }
1687: #
1688: # Write course id database (reverse lookup) to homeserver of courses
1689: # Is used in pickcourse
1690: #
1691: foreach (keys %courseidbuffer) {
1692: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1693: }
1694: #
1695: # File accesses
1696: # Writes to the dynamic metadata of resources to get hit counts, etc.
1697: #
1698: foreach my $entry (keys(%accesshash)) {
1699: if ($entry =~ /___count$/) {
1700: my ($dom,$name);
1701: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1702: if (! defined($dom) || $dom eq '' ||
1703: ! defined($name) || $name eq '') {
1704: my $cid = $env{'request.course.id'};
1705: $dom = $env{'request.'.$cid.'.domain'};
1706: $name = $env{'request.'.$cid.'.num'};
1707: }
1708: my $value = $accesshash{$entry};
1709: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1710: my %temphash=($url => $value);
1711: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1712: if ($result eq 'ok') {
1713: delete $accesshash{$entry};
1714: } elsif ($result eq 'unknown_cmd') {
1715: # Target server has old code running on it.
1716: my %temphash=($entry => $value);
1717: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1718: delete $accesshash{$entry};
1719: }
1720: }
1721: } else {
1722: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1723: my %temphash=($entry => $accesshash{$entry});
1724: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1725: delete $accesshash{$entry};
1726: }
1727: }
1728: }
1729: #
1730: # Roles
1731: # Reverse lookup of user roles for course faculty/staff and co-authorship
1732: #
1733: foreach (keys %userrolehash) {
1734: my $entry=$_;
1735: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1736: split(/\:/,$entry);
1737: if (&Apache::lonnet::put('nohist_userroles',
1738: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1739: $rudom,$runame) eq 'ok') {
1740: delete $userrolehash{$entry};
1741: }
1742: }
1743: #
1744: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1745: #
1746: my %domrolebuffer = ();
1747: foreach my $entry (keys %domainrolehash) {
1748: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1749: if ($domrolebuffer{$rudom}) {
1750: $domrolebuffer{$rudom}.='&'.&escape($entry).
1751: '='.&escape($domainrolehash{$entry});
1752: } else {
1753: $domrolebuffer{$rudom}.=&escape($entry).
1754: '='.&escape($domainrolehash{$entry});
1755: }
1756: delete $domainrolehash{$entry};
1757: }
1758: foreach my $dom (keys(%domrolebuffer)) {
1759: foreach my $tryserver (keys %libserv) {
1760: if ($hostdom{$tryserver} eq $dom) {
1761: unless (&reply('domroleput:'.$dom.':'.
1762: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1763: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1764: }
1765: }
1766: }
1767: }
1768: $dumpcount++;
1769: }
1770:
1771: sub courselog {
1772: my $what=shift;
1773: $what=time.':'.$what;
1774: unless ($env{'request.course.id'}) { return ''; }
1775: $coursedombuf{$env{'request.course.id'}}=
1776: $env{'course.'.$env{'request.course.id'}.'.domain'};
1777: $coursenumbuf{$env{'request.course.id'}}=
1778: $env{'course.'.$env{'request.course.id'}.'.num'};
1779: $coursehombuf{$env{'request.course.id'}}=
1780: $env{'course.'.$env{'request.course.id'}.'.home'};
1781: $coursedescrbuf{$env{'request.course.id'}}=
1782: $env{'course.'.$env{'request.course.id'}.'.description'};
1783: $courseinstcodebuf{$env{'request.course.id'}}=
1784: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1785: $courseownerbuf{$env{'request.course.id'}}=
1786: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1787: $coursetypebuf{$env{'request.course.id'}}=
1788: $env{'course.'.$env{'request.course.id'}.'.type'};
1789: if (defined $courselogs{$env{'request.course.id'}}) {
1790: $courselogs{$env{'request.course.id'}}.='&'.$what;
1791: } else {
1792: $courselogs{$env{'request.course.id'}}.=$what;
1793: }
1794: if (length($courselogs{$env{'request.course.id'}})>4048) {
1795: &flushcourselogs();
1796: }
1797: }
1798:
1799: sub courseacclog {
1800: my $fnsymb=shift;
1801: unless ($env{'request.course.id'}) { return ''; }
1802: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1803: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1804: $what.=':POST';
1805: # FIXME: Probably ought to escape things....
1806: foreach (keys %env) {
1807: if ($_=~/^form\.(.*)/) {
1808: $what.=':'.$1.'='.$env{$_};
1809: }
1810: }
1811: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1812: # FIXME: We should not be depending on a form parameter that someone
1813: # editing lonsearchcat.pm might change in the future.
1814: if ($env{'form.phase'} eq 'course_search') {
1815: $what.= ':POST';
1816: # FIXME: Probably ought to escape things....
1817: foreach my $element ('courseexp','crsfulltext','crsrelated',
1818: 'crsdiscuss') {
1819: $what.=':'.$element.'='.$env{'form.'.$element};
1820: }
1821: }
1822: }
1823: &courselog($what);
1824: }
1825:
1826: sub countacc {
1827: my $url=&declutter(shift);
1828: return if (! defined($url) || $url eq '');
1829: unless ($env{'request.course.id'}) { return ''; }
1830: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1831: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1832: $accesshash{$key}++;
1833: }
1834:
1835: sub linklog {
1836: my ($from,$to)=@_;
1837: $from=&declutter($from);
1838: $to=&declutter($to);
1839: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1840: $accesshash{$to.'___'.$from.'___goto'}=1;
1841: }
1842:
1843: sub userrolelog {
1844: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1845: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1846: ($trole=~/^in/) || ($trole=~/^cc/) ||
1847: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1848: ($trole=~/^ta/)) {
1849: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1850: $userrolehash
1851: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1852: =$tend.':'.$tstart;
1853: }
1854: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1855: ($trole=~/^li/) || ($trole=~/^li/) ||
1856: ($trole=~/^au/) || ($trole=~/^dg/) ||
1857: ($trole=~/^sc/)) {
1858: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1859: $domainrolehash
1860: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1861: = $tend.':'.$tstart;
1862: }
1863: }
1864:
1865: sub get_course_adv_roles {
1866: my $cid=shift;
1867: $cid=$env{'request.course.id'} unless (defined($cid));
1868: my %coursehash=&coursedescription($cid);
1869: my %nothide=();
1870: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1871: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1872: }
1873: my %returnhash=();
1874: my %dumphash=
1875: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1876: my $now=time;
1877: foreach (keys %dumphash) {
1878: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1879: if (($tstart) && ($tstart<0)) { next; }
1880: if (($tend) && ($tend<$now)) { next; }
1881: if (($tstart) && ($now<$tstart)) { next; }
1882: my ($role,$username,$domain,$section)=split(/\:/,$_);
1883: if ($username eq '' || $domain eq '') { next; }
1884: if ((&privileged($username,$domain)) &&
1885: (!$nothide{$username.':'.$domain})) { next; }
1886: if ($role eq 'cr') { next; }
1887: my $key=&plaintext($role);
1888: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1889: if ($returnhash{$key}) {
1890: $returnhash{$key}.=','.$username.':'.$domain;
1891: } else {
1892: $returnhash{$key}=$username.':'.$domain;
1893: }
1894: }
1895: return %returnhash;
1896: }
1897:
1898: sub get_my_roles {
1899: my ($uname,$udom)=@_;
1900: unless (defined($uname)) { $uname=$env{'user.name'}; }
1901: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1902: my %dumphash=
1903: &dump('nohist_userroles',$udom,$uname);
1904: my %returnhash=();
1905: my $now=time;
1906: foreach (keys %dumphash) {
1907: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1908: if (($tstart) && ($tstart<0)) { next; }
1909: if (($tend) && ($tend<$now)) { next; }
1910: if (($tstart) && ($now<$tstart)) { next; }
1911: my ($role,$username,$domain,$section)=split(/\:/,$_);
1912: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1913: }
1914: return %returnhash;
1915: }
1916:
1917: # ----------------------------------------------------- Frontpage Announcements
1918: #
1919: #
1920:
1921: sub postannounce {
1922: my ($server,$text)=@_;
1923: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1924: unless ($text=~/\w/) { $text=''; }
1925: return &reply('setannounce:'.&escape($text),$server);
1926: }
1927:
1928: sub getannounce {
1929:
1930: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1931: my $announcement='';
1932: while (<$fh>) { $announcement .=$_; }
1933: close($fh);
1934: if ($announcement=~/\w/) {
1935: return
1936: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1937: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1938: } else {
1939: return '';
1940: }
1941: } else {
1942: return '';
1943: }
1944: }
1945:
1946: # ---------------------------------------------------------- Course ID routines
1947: # Deal with domain's nohist_courseid.db files
1948: #
1949:
1950: sub courseidput {
1951: my ($domain,$what,$coursehome)=@_;
1952: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1953: }
1954:
1955: sub courseiddump {
1956: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1957: my %returnhash=();
1958: unless ($domfilter) { $domfilter=''; }
1959: foreach my $tryserver (keys %libserv) {
1960: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1961: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1962: foreach (
1963: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1964: $sincefilter.':'.&escape($descfilter).':'.
1965: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1966: $tryserver))) {
1967: my ($key,$value)=split(/\=/,$_);
1968: if (($key) && ($value)) {
1969: $returnhash{&unescape($key)}=$value;
1970: }
1971: }
1972: }
1973: }
1974: }
1975: return %returnhash;
1976: }
1977:
1978: # ---------------------------------------------------------- DC e-mail
1979:
1980: sub dcmailput {
1981: my ($domain,$msgid,$message,$server)=@_;
1982: my $status = &Apache::lonnet::critical(
1983: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1984: &escape($message),$server);
1985: return $status;
1986: }
1987:
1988: sub dcmaildump {
1989: my ($dom,$startdate,$enddate,$senders) = @_;
1990: my %returnhash=();
1991: if (exists($domain_primary{$dom})) {
1992: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1993: &escape($enddate).':';
1994: my @esc_senders=map { &escape($_)} @$senders;
1995: $cmd.=&escape(join('&',@esc_senders));
1996: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1997: my ($key,$value) = split(/\=/,$_);
1998: if (($key) && ($value)) {
1999: $returnhash{&unescape($key)} = &unescape($value);
2000: }
2001: }
2002: }
2003: return %returnhash;
2004: }
2005: # ---------------------------------------------------------- Domain roles
2006:
2007: sub get_domain_roles {
2008: my ($dom,$roles,$startdate,$enddate)=@_;
2009: if (undef($startdate) || $startdate eq '') {
2010: $startdate = '.';
2011: }
2012: if (undef($enddate) || $enddate eq '') {
2013: $enddate = '.';
2014: }
2015: my $rolelist = join(':',@{$roles});
2016: my %personnel = ();
2017: foreach my $tryserver (keys(%libserv)) {
2018: if ($hostdom{$tryserver} eq $dom) {
2019: %{$personnel{$tryserver}}=();
2020: foreach (
2021: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2022: &escape($startdate).':'.&escape($enddate).':'.
2023: &escape($rolelist), $tryserver))) {
2024: my($key,$value) = split(/\=/,$_);
2025: if (($key) && ($value)) {
2026: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2027: }
2028: }
2029: }
2030: }
2031: return %personnel;
2032: }
2033:
2034: # ----------------------------------------------------------- Check out an item
2035:
2036: sub get_first_access {
2037: my ($type,$argsymb)=@_;
2038: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2039: if ($argsymb) { $symb=$argsymb; }
2040: my ($map,$id,$res)=&decode_symb($symb);
2041: if ($type eq 'map') {
2042: $res=&symbread($map);
2043: } else {
2044: $res=$symb;
2045: }
2046: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2047: return $times{"$courseid\0$res"};
2048: }
2049:
2050: sub set_first_access {
2051: my ($type)=@_;
2052: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2053: my ($map,$id,$res)=&decode_symb($symb);
2054: if ($type eq 'map') {
2055: $res=&symbread($map);
2056: } else {
2057: $res=$symb;
2058: }
2059: my $firstaccess=&get_first_access($type,$symb);
2060: if (!$firstaccess) {
2061: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2062: }
2063: return 'already_set';
2064: }
2065:
2066: sub checkout {
2067: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2068: my $now=time;
2069: my $lonhost=$perlvar{'lonHostID'};
2070: my $infostr=&escape(
2071: 'CHECKOUTTOKEN&'.
2072: $tuname.'&'.
2073: $tudom.'&'.
2074: $tcrsid.'&'.
2075: $symb.'&'.
2076: $now.'&'.$ENV{'REMOTE_ADDR'});
2077: my $token=&reply('tmpput:'.$infostr,$lonhost);
2078: if ($token=~/^error\:/) {
2079: &logthis("<font color=\"blue\">WARNING: ".
2080: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2081: "</font>");
2082: return '';
2083: }
2084:
2085: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2086: $token=~tr/a-z/A-Z/;
2087:
2088: my %infohash=('resource.0.outtoken' => $token,
2089: 'resource.0.checkouttime' => $now,
2090: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2091:
2092: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2093: return '';
2094: } else {
2095: &logthis("<font color=\"blue\">WARNING: ".
2096: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2097: "</font>");
2098: }
2099:
2100: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2101: &escape('Checkout '.$infostr.' - '.
2102: $token)) ne 'ok') {
2103: return '';
2104: } else {
2105: &logthis("<font color=\"blue\">WARNING: ".
2106: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2107: "</font>");
2108: }
2109: return $token;
2110: }
2111:
2112: # ------------------------------------------------------------ Check in an item
2113:
2114: sub checkin {
2115: my $token=shift;
2116: my $now=time;
2117: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2118: $lonhost=~tr/A-Z/a-z/;
2119: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2120: $dtoken=~s/\W/\_/g;
2121: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2122: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2123:
2124: unless (($tuname) && ($tudom)) {
2125: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2126: return '';
2127: }
2128:
2129: unless (&allowed('mgr',$tcrsid)) {
2130: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2131: $env{'user.name'}.' - '.$env{'user.domain'});
2132: return '';
2133: }
2134:
2135: my %infohash=('resource.0.intoken' => $token,
2136: 'resource.0.checkintime' => $now,
2137: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2138:
2139: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2140: return '';
2141: }
2142:
2143: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2144: &escape('Checkin - '.$token)) ne 'ok') {
2145: return '';
2146: }
2147:
2148: return ($symb,$tuname,$tudom,$tcrsid);
2149: }
2150:
2151: # --------------------------------------------- Set Expire Date for Spreadsheet
2152:
2153: sub expirespread {
2154: my ($uname,$udom,$stype,$usymb)=@_;
2155: my $cid=$env{'request.course.id'};
2156: if ($cid) {
2157: my $now=time;
2158: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2159: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2160: $env{'course.'.$cid.'.num'}.
2161: ':nohist_expirationdates:'.
2162: &escape($key).'='.$now,
2163: $env{'course.'.$cid.'.home'})
2164: }
2165: return 'ok';
2166: }
2167:
2168: # ----------------------------------------------------- Devalidate Spreadsheets
2169:
2170: sub devalidate {
2171: my ($symb,$uname,$udom)=@_;
2172: my $cid=$env{'request.course.id'};
2173: if ($cid) {
2174: # delete the stored spreadsheets for
2175: # - the student level sheet of this user in course's homespace
2176: # - the assessment level sheet for this resource
2177: # for this user in user's homespace
2178: # - current conditional state info
2179: my $key=$uname.':'.$udom.':';
2180: my $status=
2181: &del('nohist_calculatedsheets',
2182: [$key.'studentcalc:'],
2183: $env{'course.'.$cid.'.domain'},
2184: $env{'course.'.$cid.'.num'})
2185: .' '.
2186: &del('nohist_calculatedsheets_'.$cid,
2187: [$key.'assesscalc:'.$symb],$udom,$uname);
2188: unless ($status eq 'ok ok') {
2189: &logthis('Could not devalidate spreadsheet '.
2190: $uname.' at '.$udom.' for '.
2191: $symb.': '.$status);
2192: }
2193: &delenv('user.state.'.$cid);
2194: }
2195: }
2196:
2197: sub get_scalar {
2198: my ($string,$end) = @_;
2199: my $value;
2200: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2201: $value = $1;
2202: } elsif ($$string =~ s/^([^&]*?)&//) {
2203: $value = $1;
2204: }
2205: return &unescape($value);
2206: }
2207:
2208: sub array2str {
2209: my (@array) = @_;
2210: my $result=&arrayref2str(\@array);
2211: $result=~s/^__ARRAY_REF__//;
2212: $result=~s/__END_ARRAY_REF__$//;
2213: return $result;
2214: }
2215:
2216: sub arrayref2str {
2217: my ($arrayref) = @_;
2218: my $result='__ARRAY_REF__';
2219: foreach my $elem (@$arrayref) {
2220: if(ref($elem) eq 'ARRAY') {
2221: $result.=&arrayref2str($elem).'&';
2222: } elsif(ref($elem) eq 'HASH') {
2223: $result.=&hashref2str($elem).'&';
2224: } elsif(ref($elem)) {
2225: #print("Got a ref of ".(ref($elem))." skipping.");
2226: } else {
2227: $result.=&escape($elem).'&';
2228: }
2229: }
2230: $result=~s/\&$//;
2231: $result .= '__END_ARRAY_REF__';
2232: return $result;
2233: }
2234:
2235: sub hash2str {
2236: my (%hash) = @_;
2237: my $result=&hashref2str(\%hash);
2238: $result=~s/^__HASH_REF__//;
2239: $result=~s/__END_HASH_REF__$//;
2240: return $result;
2241: }
2242:
2243: sub hashref2str {
2244: my ($hashref)=@_;
2245: my $result='__HASH_REF__';
2246: foreach (sort(keys(%$hashref))) {
2247: if (ref($_) eq 'ARRAY') {
2248: $result.=&arrayref2str($_).'=';
2249: } elsif (ref($_) eq 'HASH') {
2250: $result.=&hashref2str($_).'=';
2251: } elsif (ref($_)) {
2252: $result.='=';
2253: #print("Got a ref of ".(ref($_))." skipping.");
2254: } else {
2255: if ($_) {$result.=&escape($_).'=';} else { last; }
2256: }
2257:
2258: if(ref($hashref->{$_}) eq 'ARRAY') {
2259: $result.=&arrayref2str($hashref->{$_}).'&';
2260: } elsif(ref($hashref->{$_}) eq 'HASH') {
2261: $result.=&hashref2str($hashref->{$_}).'&';
2262: } elsif(ref($hashref->{$_})) {
2263: $result.='&';
2264: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2265: } else {
2266: $result.=&escape($hashref->{$_}).'&';
2267: }
2268: }
2269: $result=~s/\&$//;
2270: $result .= '__END_HASH_REF__';
2271: return $result;
2272: }
2273:
2274: sub str2hash {
2275: my ($string)=@_;
2276: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2277: return %$hash;
2278: }
2279:
2280: sub str2hashref {
2281: my ($string) = @_;
2282:
2283: my %hash;
2284:
2285: if($string !~ /^__HASH_REF__/) {
2286: if (! ($string eq '' || !defined($string))) {
2287: $hash{'error'}='Not hash reference';
2288: }
2289: return (\%hash, $string);
2290: }
2291:
2292: $string =~ s/^__HASH_REF__//;
2293:
2294: while($string !~ /^__END_HASH_REF__/) {
2295: #key
2296: my $key='';
2297: if($string =~ /^__HASH_REF__/) {
2298: ($key, $string)=&str2hashref($string);
2299: if(defined($key->{'error'})) {
2300: $hash{'error'}='Bad data';
2301: return (\%hash, $string);
2302: }
2303: } elsif($string =~ /^__ARRAY_REF__/) {
2304: ($key, $string)=&str2arrayref($string);
2305: if($key->[0] eq 'Array reference error') {
2306: $hash{'error'}='Bad data';
2307: return (\%hash, $string);
2308: }
2309: } else {
2310: $string =~ s/^(.*?)=//;
2311: $key=&unescape($1);
2312: }
2313: $string =~ s/^=//;
2314:
2315: #value
2316: my $value='';
2317: if($string =~ /^__HASH_REF__/) {
2318: ($value, $string)=&str2hashref($string);
2319: if(defined($value->{'error'})) {
2320: $hash{'error'}='Bad data';
2321: return (\%hash, $string);
2322: }
2323: } elsif($string =~ /^__ARRAY_REF__/) {
2324: ($value, $string)=&str2arrayref($string);
2325: if($value->[0] eq 'Array reference error') {
2326: $hash{'error'}='Bad data';
2327: return (\%hash, $string);
2328: }
2329: } else {
2330: $value=&get_scalar(\$string,'__END_HASH_REF__');
2331: }
2332: $string =~ s/^&//;
2333:
2334: $hash{$key}=$value;
2335: }
2336:
2337: $string =~ s/^__END_HASH_REF__//;
2338:
2339: return (\%hash, $string);
2340: }
2341:
2342: sub str2array {
2343: my ($string)=@_;
2344: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2345: return @$array;
2346: }
2347:
2348: sub str2arrayref {
2349: my ($string) = @_;
2350: my @array;
2351:
2352: if($string !~ /^__ARRAY_REF__/) {
2353: if (! ($string eq '' || !defined($string))) {
2354: $array[0]='Array reference error';
2355: }
2356: return (\@array, $string);
2357: }
2358:
2359: $string =~ s/^__ARRAY_REF__//;
2360:
2361: while($string !~ /^__END_ARRAY_REF__/) {
2362: my $value='';
2363: if($string =~ /^__HASH_REF__/) {
2364: ($value, $string)=&str2hashref($string);
2365: if(defined($value->{'error'})) {
2366: $array[0] ='Array reference error';
2367: return (\@array, $string);
2368: }
2369: } elsif($string =~ /^__ARRAY_REF__/) {
2370: ($value, $string)=&str2arrayref($string);
2371: if($value->[0] eq 'Array reference error') {
2372: $array[0] ='Array reference error';
2373: return (\@array, $string);
2374: }
2375: } else {
2376: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2377: }
2378: $string =~ s/^&//;
2379:
2380: push(@array, $value);
2381: }
2382:
2383: $string =~ s/^__END_ARRAY_REF__//;
2384:
2385: return (\@array, $string);
2386: }
2387:
2388: # -------------------------------------------------------------------Temp Store
2389:
2390: sub tmpreset {
2391: my ($symb,$namespace,$domain,$stuname) = @_;
2392: if (!$symb) {
2393: $symb=&symbread();
2394: if (!$symb) { $symb= $env{'request.url'}; }
2395: }
2396: $symb=escape($symb);
2397:
2398: if (!$namespace) { $namespace=$env{'request.state'}; }
2399: $namespace=~s/\//\_/g;
2400: $namespace=~s/\W//g;
2401:
2402: if (!$domain) { $domain=$env{'user.domain'}; }
2403: if (!$stuname) { $stuname=$env{'user.name'}; }
2404: if ($domain eq 'public' && $stuname eq 'public') {
2405: $stuname=$ENV{'REMOTE_ADDR'};
2406: }
2407: my $path=$perlvar{'lonDaemons'}.'/tmp';
2408: my %hash;
2409: if (tie(%hash,'GDBM_File',
2410: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2411: &GDBM_WRCREAT(),0640)) {
2412: foreach my $key (keys %hash) {
2413: if ($key=~ /:$symb/) {
2414: delete($hash{$key});
2415: }
2416: }
2417: }
2418: }
2419:
2420: sub tmpstore {
2421: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2422:
2423: if (!$symb) {
2424: $symb=&symbread();
2425: if (!$symb) { $symb= $env{'request.url'}; }
2426: }
2427: $symb=escape($symb);
2428:
2429: if (!$namespace) {
2430: # I don't think we would ever want to store this for a course.
2431: # it seems this will only be used if we don't have a course.
2432: #$namespace=$env{'request.course.id'};
2433: #if (!$namespace) {
2434: $namespace=$env{'request.state'};
2435: #}
2436: }
2437: $namespace=~s/\//\_/g;
2438: $namespace=~s/\W//g;
2439: if (!$domain) { $domain=$env{'user.domain'}; }
2440: if (!$stuname) { $stuname=$env{'user.name'}; }
2441: if ($domain eq 'public' && $stuname eq 'public') {
2442: $stuname=$ENV{'REMOTE_ADDR'};
2443: }
2444: my $now=time;
2445: my %hash;
2446: my $path=$perlvar{'lonDaemons'}.'/tmp';
2447: if (tie(%hash,'GDBM_File',
2448: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2449: &GDBM_WRCREAT(),0640)) {
2450: $hash{"version:$symb"}++;
2451: my $version=$hash{"version:$symb"};
2452: my $allkeys='';
2453: foreach my $key (keys(%$storehash)) {
2454: $allkeys.=$key.':';
2455: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2456: }
2457: $hash{"$version:$symb:timestamp"}=$now;
2458: $allkeys.='timestamp';
2459: $hash{"$version:keys:$symb"}=$allkeys;
2460: if (untie(%hash)) {
2461: return 'ok';
2462: } else {
2463: return "error:$!";
2464: }
2465: } else {
2466: return "error:$!";
2467: }
2468: }
2469:
2470: # -----------------------------------------------------------------Temp Restore
2471:
2472: sub tmprestore {
2473: my ($symb,$namespace,$domain,$stuname) = @_;
2474:
2475: if (!$symb) {
2476: $symb=&symbread();
2477: if (!$symb) { $symb= $env{'request.url'}; }
2478: }
2479: $symb=escape($symb);
2480:
2481: if (!$namespace) { $namespace=$env{'request.state'}; }
2482:
2483: if (!$domain) { $domain=$env{'user.domain'}; }
2484: if (!$stuname) { $stuname=$env{'user.name'}; }
2485: if ($domain eq 'public' && $stuname eq 'public') {
2486: $stuname=$ENV{'REMOTE_ADDR'};
2487: }
2488: my %returnhash;
2489: $namespace=~s/\//\_/g;
2490: $namespace=~s/\W//g;
2491: my %hash;
2492: my $path=$perlvar{'lonDaemons'}.'/tmp';
2493: if (tie(%hash,'GDBM_File',
2494: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2495: &GDBM_READER(),0640)) {
2496: my $version=$hash{"version:$symb"};
2497: $returnhash{'version'}=$version;
2498: my $scope;
2499: for ($scope=1;$scope<=$version;$scope++) {
2500: my $vkeys=$hash{"$scope:keys:$symb"};
2501: my @keys=split(/:/,$vkeys);
2502: my $key;
2503: $returnhash{"$scope:keys"}=$vkeys;
2504: foreach $key (@keys) {
2505: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2506: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2507: }
2508: }
2509: if (!(untie(%hash))) {
2510: return "error:$!";
2511: }
2512: } else {
2513: return "error:$!";
2514: }
2515: return %returnhash;
2516: }
2517:
2518: # ----------------------------------------------------------------------- Store
2519:
2520: sub store {
2521: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2522: my $home='';
2523:
2524: if ($stuname) { $home=&homeserver($stuname,$domain); }
2525:
2526: $symb=&symbclean($symb);
2527: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2528:
2529: if (!$domain) { $domain=$env{'user.domain'}; }
2530: if (!$stuname) { $stuname=$env{'user.name'}; }
2531:
2532: &devalidate($symb,$stuname,$domain);
2533:
2534: $symb=escape($symb);
2535: if (!$namespace) {
2536: unless ($namespace=$env{'request.course.id'}) {
2537: return '';
2538: }
2539: }
2540: if (!$home) { $home=$env{'user.home'}; }
2541:
2542: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2543: $$storehash{'host'}=$perlvar{'lonHostID'};
2544:
2545: my $namevalue='';
2546: foreach (keys %$storehash) {
2547: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2548: }
2549: $namevalue=~s/\&$//;
2550: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2551: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2552: }
2553:
2554: # -------------------------------------------------------------- Critical Store
2555:
2556: sub cstore {
2557: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2558: my $home='';
2559:
2560: if ($stuname) { $home=&homeserver($stuname,$domain); }
2561:
2562: $symb=&symbclean($symb);
2563: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2564:
2565: if (!$domain) { $domain=$env{'user.domain'}; }
2566: if (!$stuname) { $stuname=$env{'user.name'}; }
2567:
2568: &devalidate($symb,$stuname,$domain);
2569:
2570: $symb=escape($symb);
2571: if (!$namespace) {
2572: unless ($namespace=$env{'request.course.id'}) {
2573: return '';
2574: }
2575: }
2576: if (!$home) { $home=$env{'user.home'}; }
2577:
2578: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2579: $$storehash{'host'}=$perlvar{'lonHostID'};
2580:
2581: my $namevalue='';
2582: foreach (keys %$storehash) {
2583: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2584: }
2585: $namevalue=~s/\&$//;
2586: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2587: return critical
2588: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2589: }
2590:
2591: # --------------------------------------------------------------------- Restore
2592:
2593: sub restore {
2594: my ($symb,$namespace,$domain,$stuname) = @_;
2595: my $home='';
2596:
2597: if ($stuname) { $home=&homeserver($stuname,$domain); }
2598:
2599: if (!$symb) {
2600: unless ($symb=escape(&symbread())) { return ''; }
2601: } else {
2602: $symb=&escape(&symbclean($symb));
2603: }
2604: if (!$namespace) {
2605: unless ($namespace=$env{'request.course.id'}) {
2606: return '';
2607: }
2608: }
2609: if (!$domain) { $domain=$env{'user.domain'}; }
2610: if (!$stuname) { $stuname=$env{'user.name'}; }
2611: if (!$home) { $home=$env{'user.home'}; }
2612: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2613:
2614: my %returnhash=();
2615: foreach (split(/\&/,$answer)) {
2616: my ($name,$value)=split(/\=/,$_);
2617: $returnhash{&unescape($name)}=&thaw_unescape($value);
2618: }
2619: my $version;
2620: for ($version=1;$version<=$returnhash{'version'};$version++) {
2621: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2622: $returnhash{$_}=$returnhash{$version.':'.$_};
2623: }
2624: }
2625: return %returnhash;
2626: }
2627:
2628: # ---------------------------------------------------------- Course Description
2629:
2630: sub coursedescription {
2631: my ($courseid,$args)=@_;
2632: $courseid=~s/^\///;
2633: $courseid=~s/\_/\//g;
2634: my ($cdomain,$cnum)=split(/\//,$courseid);
2635: my $chome=&homeserver($cnum,$cdomain);
2636: my $normalid=$cdomain.'_'.$cnum;
2637: # need to always cache even if we get errors otherwise we keep
2638: # trying and trying and trying to get the course description.
2639: my %envhash=();
2640: my %returnhash=();
2641:
2642: my $expiretime=600;
2643: if ($env{'request.course.id'} eq $normalid) {
2644: $expiretime=120;
2645: }
2646:
2647: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2648: if (!$args->{'freshen_cache'}
2649: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2650: foreach my $key (keys(%env)) {
2651: next if ($key !~ /^\Q$prefix\E(.*)/);
2652: my ($setting) = $1;
2653: $returnhash{$setting} = $env{$key};
2654: }
2655: return %returnhash;
2656: }
2657:
2658: # get the data agin
2659: if (!$args->{'one_time'}) {
2660: $envhash{'course.'.$normalid.'.last_cache'}=time;
2661: }
2662: if ($chome ne 'no_host') {
2663: %returnhash=&dump('environment',$cdomain,$cnum);
2664: if (!exists($returnhash{'con_lost'})) {
2665: $returnhash{'home'}= $chome;
2666: $returnhash{'domain'} = $cdomain;
2667: $returnhash{'num'} = $cnum;
2668: if (!defined($returnhash{'type'})) {
2669: $returnhash{'type'} = 'Course';
2670: }
2671: while (my ($name,$value) = each %returnhash) {
2672: $envhash{'course.'.$normalid.'.'.$name}=$value;
2673: }
2674: $returnhash{'url'}=&clutter($returnhash{'url'});
2675: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2676: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2677: $envhash{'course.'.$normalid.'.home'}=$chome;
2678: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2679: $envhash{'course.'.$normalid.'.num'}=$cnum;
2680: }
2681: }
2682: if (!$args->{'one_time'}) {
2683: &appenv(%envhash);
2684: }
2685: return %returnhash;
2686: }
2687:
2688: # -------------------------------------------------See if a user is privileged
2689:
2690: sub privileged {
2691: my ($username,$domain)=@_;
2692: my $rolesdump=&reply("dump:$domain:$username:roles",
2693: &homeserver($username,$domain));
2694: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2695: my $now=time;
2696: if ($rolesdump ne '') {
2697: foreach (split(/&/,$rolesdump)) {
2698: if ($_!~/^rolesdef_/) {
2699: my ($area,$role)=split(/=/,$_);
2700: $area=~s/\_\w\w$//;
2701: my ($trole,$tend,$tstart)=split(/_/,$role);
2702: if (($trole eq 'dc') || ($trole eq 'su')) {
2703: my $active=1;
2704: if ($tend) {
2705: if ($tend<$now) { $active=0; }
2706: }
2707: if ($tstart) {
2708: if ($tstart>$now) { $active=0; }
2709: }
2710: if ($active) { return 1; }
2711: }
2712: }
2713: }
2714: }
2715: return 0;
2716: }
2717:
2718: # -------------------------------------------------------- Get user privileges
2719:
2720: sub rolesinit {
2721: my ($domain,$username,$authhost)=@_;
2722: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2723: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2724: my %allroles=();
2725: my %allgroups=();
2726: my $now=time;
2727: my %userroles = ('user.login.time' => $now);
2728: my $group_privs;
2729:
2730: if ($rolesdump ne '') {
2731: foreach (split(/&/,$rolesdump)) {
2732: if ($_!~/^rolesdef_/) {
2733: my ($area,$role)=split(/=/,$_);
2734: $area=~s/\_\w\w$//;
2735: my ($trole,$tend,$tstart,$group_privs);
2736: if ($role=~/^cr/) {
2737: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2738: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2739: ($tend,$tstart)=split('_',$trest);
2740: } else {
2741: $trole=$role;
2742: }
2743: } elsif ($role =~ m|^gr/|) {
2744: ($trole,$tend,$tstart) = split(/_/,$role);
2745: ($trole,$group_privs) = split(/\//,$trole);
2746: $group_privs = &unescape($group_privs);
2747: } else {
2748: ($trole,$tend,$tstart)=split(/_/,$role);
2749: }
2750: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2751: $username);
2752: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2753: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2754: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2755: if (($area ne '') && ($trole ne '')) {
2756: my $spec=$trole.'.'.$area;
2757: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2758: if ($trole =~ /^cr\//) {
2759: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2760: } elsif ($trole eq 'gr') {
2761: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2762: } else {
2763: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2764: }
2765: }
2766: }
2767: }
2768: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2769: $userroles{'user.adv'} = $adv;
2770: $userroles{'user.author'} = $author;
2771: $env{'user.adv'}=$adv;
2772: }
2773: return \%userroles;
2774: }
2775:
2776: sub set_arearole {
2777: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2778: # log the associated role with the area
2779: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2780: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2781: }
2782:
2783: sub custom_roleprivs {
2784: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2785: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2786: my $homsvr=homeserver($rauthor,$rdomain);
2787: if ($hostname{$homsvr} ne '') {
2788: my ($rdummy,$roledef)=
2789: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2790: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2791: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2792: if (defined($syspriv)) {
2793: $$allroles{'cm./'}.=':'.$syspriv;
2794: $$allroles{$spec.'./'}.=':'.$syspriv;
2795: }
2796: if ($tdomain ne '') {
2797: if (defined($dompriv)) {
2798: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2799: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2800: }
2801: if (($trest ne '') && (defined($coursepriv))) {
2802: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2803: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2804: }
2805: }
2806: }
2807: }
2808: }
2809:
2810: sub group_roleprivs {
2811: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2812: my $access = 1;
2813: my $now = time;
2814: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2815: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2816: if ($access) {
2817: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2818: $$allgroups{$course}{$group} .=':'.$group_privs;
2819: }
2820: }
2821:
2822: sub standard_roleprivs {
2823: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2824: if (defined($pr{$trole.':s'})) {
2825: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2826: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2827: }
2828: if ($tdomain ne '') {
2829: if (defined($pr{$trole.':d'})) {
2830: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2831: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2832: }
2833: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2834: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2835: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2836: }
2837: }
2838: }
2839:
2840: sub set_userprivs {
2841: my ($userroles,$allroles,$allgroups) = @_;
2842: my $author=0;
2843: my $adv=0;
2844: my %grouproles = ();
2845: if (keys(%{$allgroups}) > 0) {
2846: foreach my $role (keys %{$allroles}) {
2847: my ($trole,$area,$sec,$extendedarea);
2848: if ($role =~ m-^(\w+|cr/\w+/\w+/\w+)\.(/\w+/\w+)(/?\w*)-) {
2849: $trole = $1;
2850: $area = $2;
2851: $sec = $3;
2852: $extendedarea = $area.$sec;
2853: if (exists($$allgroups{$area})) {
2854: foreach my $group (keys(%{$$allgroups{$area}})) {
2855: my $spec = $trole.'.'.$extendedarea;
2856: $grouproles{$spec.'.'.$area.'/'.$group} =
2857: $$allgroups{$area}{$group};
2858: }
2859: }
2860: }
2861: }
2862: }
2863: foreach (keys(%grouproles)) {
2864: $$allroles{$_} = $grouproles{$_};
2865: }
2866: foreach (keys %{$allroles}) {
2867: my %thesepriv=();
2868: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2869: foreach (split(/:/,$$allroles{$_})) {
2870: if ($_ ne '') {
2871: my ($privilege,$restrictions)=split(/&/,$_);
2872: if ($restrictions eq '') {
2873: $thesepriv{$privilege}='F';
2874: } elsif ($thesepriv{$privilege} ne 'F') {
2875: $thesepriv{$privilege}.=$restrictions;
2876: }
2877: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2878: }
2879: }
2880: my $thesestr='';
2881: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2882: $userroles->{'user.priv.'.$_} = $thesestr;
2883: }
2884: return ($author,$adv);
2885: }
2886:
2887: # --------------------------------------------------------------- get interface
2888:
2889: sub get {
2890: my ($namespace,$storearr,$udomain,$uname)=@_;
2891: my $items='';
2892: foreach (@$storearr) {
2893: $items.=escape($_).'&';
2894: }
2895: $items=~s/\&$//;
2896: if (!$udomain) { $udomain=$env{'user.domain'}; }
2897: if (!$uname) { $uname=$env{'user.name'}; }
2898: my $uhome=&homeserver($uname,$udomain);
2899:
2900: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2901: my @pairs=split(/\&/,$rep);
2902: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2903: return @pairs;
2904: }
2905: my %returnhash=();
2906: my $i=0;
2907: foreach (@$storearr) {
2908: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2909: $i++;
2910: }
2911: return %returnhash;
2912: }
2913:
2914: # --------------------------------------------------------------- del interface
2915:
2916: sub del {
2917: my ($namespace,$storearr,$udomain,$uname)=@_;
2918: my $items='';
2919: foreach (@$storearr) {
2920: $items.=escape($_).'&';
2921: }
2922: $items=~s/\&$//;
2923: if (!$udomain) { $udomain=$env{'user.domain'}; }
2924: if (!$uname) { $uname=$env{'user.name'}; }
2925: my $uhome=&homeserver($uname,$udomain);
2926:
2927: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2928: }
2929:
2930: # -------------------------------------------------------------- dump interface
2931:
2932: sub dump {
2933: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2934: if (!$udomain) { $udomain=$env{'user.domain'}; }
2935: if (!$uname) { $uname=$env{'user.name'}; }
2936: my $uhome=&homeserver($uname,$udomain);
2937: if ($regexp) {
2938: $regexp=&escape($regexp);
2939: } else {
2940: $regexp='.';
2941: }
2942: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2943: my @pairs=split(/\&/,$rep);
2944: my %returnhash=();
2945: foreach my $item (@pairs) {
2946: my ($key,$value)=split(/=/,$item,2);
2947: $key = &unescape($key);
2948: next if ($key =~ /^error: 2 /);
2949: $returnhash{$key}=&thaw_unescape($value);
2950: }
2951: return %returnhash;
2952: }
2953:
2954: # --------------------------------------------------------- dumpstore interface
2955:
2956: sub dumpstore {
2957: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2958: return &dump($namespace,$udomain,$uname,$regexp,$range);
2959: }
2960:
2961: # -------------------------------------------------------------- keys interface
2962:
2963: sub getkeys {
2964: my ($namespace,$udomain,$uname)=@_;
2965: if (!$udomain) { $udomain=$env{'user.domain'}; }
2966: if (!$uname) { $uname=$env{'user.name'}; }
2967: my $uhome=&homeserver($uname,$udomain);
2968: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2969: my @keyarray=();
2970: foreach (split(/\&/,$rep)) {
2971: push (@keyarray,&unescape($_));
2972: }
2973: return @keyarray;
2974: }
2975:
2976: # --------------------------------------------------------------- currentdump
2977: sub currentdump {
2978: my ($courseid,$sdom,$sname)=@_;
2979: $courseid = $env{'request.course.id'} if (! defined($courseid));
2980: $sdom = $env{'user.domain'} if (! defined($sdom));
2981: $sname = $env{'user.name'} if (! defined($sname));
2982: my $uhome = &homeserver($sname,$sdom);
2983: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2984: return if ($rep =~ /^(error:|no_such_host)/);
2985: #
2986: my %returnhash=();
2987: #
2988: if ($rep eq "unknown_cmd") {
2989: # an old lond will not know currentdump
2990: # Do a dump and make it look like a currentdump
2991: my @tmp = &dump($courseid,$sdom,$sname,'.');
2992: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2993: my %hash = @tmp;
2994: @tmp=();
2995: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
2996: } else {
2997: my @pairs=split(/\&/,$rep);
2998: foreach (@pairs) {
2999: my ($key,$value)=split(/=/,$_);
3000: my ($symb,$param) = split(/:/,$key);
3001: $returnhash{&unescape($symb)}->{&unescape($param)} =
3002: &thaw_unescape($value);
3003: }
3004: }
3005: return %returnhash;
3006: }
3007:
3008: sub convert_dump_to_currentdump{
3009: my %hash = %{shift()};
3010: my %returnhash;
3011: # Code ripped from lond, essentially. The only difference
3012: # here is the unescaping done by lonnet::dump(). Conceivably
3013: # we might run in to problems with parameter names =~ /^v\./
3014: while (my ($key,$value) = each(%hash)) {
3015: my ($v,$symb,$param) = split(/:/,$key);
3016: next if ($v eq 'version' || $symb eq 'keys');
3017: next if (exists($returnhash{$symb}) &&
3018: exists($returnhash{$symb}->{$param}) &&
3019: $returnhash{$symb}->{'v.'.$param} > $v);
3020: $returnhash{$symb}->{$param}=$value;
3021: $returnhash{$symb}->{'v.'.$param}=$v;
3022: }
3023: #
3024: # Remove all of the keys in the hashes which keep track of
3025: # the version of the parameter.
3026: while (my ($symb,$param_hash) = each(%returnhash)) {
3027: # use a foreach because we are going to delete from the hash.
3028: foreach my $key (keys(%$param_hash)) {
3029: delete($param_hash->{$key}) if ($key =~ /^v\./);
3030: }
3031: }
3032: return \%returnhash;
3033: }
3034:
3035: # ------------------------------------------------------ critical inc interface
3036:
3037: sub cinc {
3038: return &inc(@_,'critical');
3039: }
3040:
3041: # --------------------------------------------------------------- inc interface
3042:
3043: sub inc {
3044: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3045: if (!$udomain) { $udomain=$env{'user.domain'}; }
3046: if (!$uname) { $uname=$env{'user.name'}; }
3047: my $uhome=&homeserver($uname,$udomain);
3048: my $items='';
3049: if (! ref($store)) {
3050: # got a single value, so use that instead
3051: $items = &escape($store).'=&';
3052: } elsif (ref($store) eq 'SCALAR') {
3053: $items = &escape($$store).'=&';
3054: } elsif (ref($store) eq 'ARRAY') {
3055: $items = join('=&',map {&escape($_);} @{$store});
3056: } elsif (ref($store) eq 'HASH') {
3057: while (my($key,$value) = each(%{$store})) {
3058: $items.= &escape($key).'='.&escape($value).'&';
3059: }
3060: }
3061: $items=~s/\&$//;
3062: if ($critical) {
3063: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3064: } else {
3065: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3066: }
3067: }
3068:
3069: # --------------------------------------------------------------- put interface
3070:
3071: sub put {
3072: my ($namespace,$storehash,$udomain,$uname)=@_;
3073: if (!$udomain) { $udomain=$env{'user.domain'}; }
3074: if (!$uname) { $uname=$env{'user.name'}; }
3075: my $uhome=&homeserver($uname,$udomain);
3076: my $items='';
3077: foreach (keys %$storehash) {
3078: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3079: }
3080: $items=~s/\&$//;
3081: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3082: }
3083:
3084: # ------------------------------------------------------------ newput interface
3085:
3086: sub newput {
3087: my ($namespace,$storehash,$udomain,$uname)=@_;
3088: if (!$udomain) { $udomain=$env{'user.domain'}; }
3089: if (!$uname) { $uname=$env{'user.name'}; }
3090: my $uhome=&homeserver($uname,$udomain);
3091: my $items='';
3092: foreach my $key (keys(%$storehash)) {
3093: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3094: }
3095: $items=~s/\&$//;
3096: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3097: }
3098:
3099: # --------------------------------------------------------- putstore interface
3100:
3101: sub putstore {
3102: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3103: if (!$udomain) { $udomain=$env{'user.domain'}; }
3104: if (!$uname) { $uname=$env{'user.name'}; }
3105: my $uhome=&homeserver($uname,$udomain);
3106: my $items='';
3107: foreach my $key (keys(%$storehash)) {
3108: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3109: }
3110: $items=~s/\&$//;
3111: my $esc_symb=&escape($symb);
3112: my $esc_v=&escape($version);
3113: my $reply =
3114: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3115: $uhome);
3116: if ($reply eq 'unknown_cmd') {
3117: # gfall back to way things use to be done
3118: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3119: $uname);
3120: }
3121: return $reply;
3122: }
3123:
3124: sub old_putstore {
3125: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3126: if (!$udomain) { $udomain=$env{'user.domain'}; }
3127: if (!$uname) { $uname=$env{'user.name'}; }
3128: my $uhome=&homeserver($uname,$udomain);
3129: my %newstorehash;
3130: foreach (keys %$storehash) {
3131: my $key = $version.':'.&escape($symb).':'.$_;
3132: $newstorehash{$key} = $storehash->{$_};
3133: }
3134: my $items='';
3135: my %allitems = ();
3136: foreach (keys %newstorehash) {
3137: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3138: my $key = $1.':keys:'.$2;
3139: $allitems{$key} .= $3.':';
3140: }
3141: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3142: }
3143: foreach (keys %allitems) {
3144: $allitems{$_} =~ s/\:$//;
3145: $items.= $_.'='.$allitems{$_}.'&';
3146: }
3147: $items=~s/\&$//;
3148: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3149: }
3150:
3151: # ------------------------------------------------------ critical put interface
3152:
3153: sub cput {
3154: my ($namespace,$storehash,$udomain,$uname)=@_;
3155: if (!$udomain) { $udomain=$env{'user.domain'}; }
3156: if (!$uname) { $uname=$env{'user.name'}; }
3157: my $uhome=&homeserver($uname,$udomain);
3158: my $items='';
3159: foreach (keys %$storehash) {
3160: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3161: }
3162: $items=~s/\&$//;
3163: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3164: }
3165:
3166: # -------------------------------------------------------------- eget interface
3167:
3168: sub eget {
3169: my ($namespace,$storearr,$udomain,$uname)=@_;
3170: my $items='';
3171: foreach (@$storearr) {
3172: $items.=escape($_).'&';
3173: }
3174: $items=~s/\&$//;
3175: if (!$udomain) { $udomain=$env{'user.domain'}; }
3176: if (!$uname) { $uname=$env{'user.name'}; }
3177: my $uhome=&homeserver($uname,$udomain);
3178: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3179: my @pairs=split(/\&/,$rep);
3180: my %returnhash=();
3181: my $i=0;
3182: foreach (@$storearr) {
3183: $returnhash{$_}=&thaw_unescape($pairs[$i]);
3184: $i++;
3185: }
3186: return %returnhash;
3187: }
3188:
3189: # ------------------------------------------------------------ tmpput interface
3190: sub tmpput {
3191: my ($storehash,$server)=@_;
3192: my $items='';
3193: foreach (keys(%$storehash)) {
3194: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3195: }
3196: $items=~s/\&$//;
3197: return &reply("tmpput:$items",$server);
3198: }
3199:
3200: # ------------------------------------------------------------ tmpget interface
3201: sub tmpget {
3202: my ($token,$server)=@_;
3203: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3204: my $rep=&reply("tmpget:$token",$server);
3205: my %returnhash;
3206: foreach my $item (split(/\&/,$rep)) {
3207: my ($key,$value)=split(/=/,$item);
3208: $returnhash{&unescape($key)}=&thaw_unescape($value);
3209: }
3210: return %returnhash;
3211: }
3212:
3213: # ------------------------------------------------------------ tmpget interface
3214: sub tmpdel {
3215: my ($token,$server)=@_;
3216: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3217: return &reply("tmpdel:$token",$server);
3218: }
3219:
3220: # -------------------------------------------------- portfolio access checking
3221:
3222: sub portfolio_access {
3223: my ($requrl) = @_;
3224: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3225: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3226: if ($result eq 'ok') {
3227: return 'F';
3228: } elsif ($result =~ /^[^:]+:guest_/) {
3229: return 'A';
3230: }
3231: return '';
3232: }
3233:
3234: sub get_portfolio_access {
3235: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3236:
3237: if (!ref($access_hash)) {
3238: my $current_perms = &get_portfile_permissions($udom,$unum);
3239: my %access_controls = &get_access_controls($current_perms,$group,
3240: $file_name);
3241: $access_hash = $access_controls{$file_name};
3242: }
3243:
3244: my ($public,$guest,@domains,@users,@courses,@groups);
3245: my $now = time;
3246: if (ref($access_hash) eq 'HASH') {
3247: foreach my $key (keys(%{$access_hash})) {
3248: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3249: if ($start > $now) {
3250: next;
3251: }
3252: if ($end && $end<$now) {
3253: next;
3254: }
3255: if ($scope eq 'public') {
3256: $public = $key;
3257: last;
3258: } elsif ($scope eq 'guest') {
3259: $guest = $key;
3260: } elsif ($scope eq 'domains') {
3261: push(@domains,$key);
3262: } elsif ($scope eq 'users') {
3263: push(@users,$key);
3264: } elsif ($scope eq 'course') {
3265: push(@courses,$key);
3266: } elsif ($scope eq 'group') {
3267: push(@groups,$key);
3268: }
3269: }
3270: if ($public) {
3271: return 'ok';
3272: }
3273: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3274: if ($guest) {
3275: return $guest;
3276: }
3277: } else {
3278: if (@domains > 0) {
3279: foreach my $domkey (@domains) {
3280: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3281: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3282: return 'ok';
3283: }
3284: }
3285: }
3286: }
3287: if (@users > 0) {
3288: foreach my $userkey (@users) {
3289: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
3290: return 'ok';
3291: }
3292: }
3293: }
3294: my %roleshash;
3295: my @courses_and_groups = @courses;
3296: push(@courses_and_groups,@groups);
3297: if (@courses_and_groups > 0) {
3298: my (%allgroups,%allroles);
3299: my ($start,$end,$role,$sec,$group);
3300: foreach my $envkey (%env) {
3301: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./([^/]+)/([^/]+)/?([^/]*)$-) {
3302: my $cid = $2.'_'.$3;
3303: if ($1 eq 'gr') {
3304: $group = $4;
3305: $allgroups{$cid}{$group} = $env{$envkey};
3306: } else {
3307: if ($4 eq '') {
3308: $sec = 'none';
3309: } else {
3310: $sec = $4;
3311: }
3312: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3313: }
3314: } elsif ($envkey =~ m-^user\.role\./cr/(\w+/\w+/\w*)./([^/]+)/([^/]+)/?([^/]*)$-) {
3315: my $cid = $2.'_'.$3;
3316: if ($4 eq '') {
3317: $sec = 'none';
3318: } else {
3319: $sec = $4;
3320: }
3321: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3322: }
3323: }
3324: if (keys(%allroles) == 0) {
3325: return;
3326: }
3327: foreach my $key (@courses_and_groups) {
3328: my %content = %{$$access_hash{$key}};
3329: my $cnum = $content{'number'};
3330: my $cdom = $content{'domain'};
3331: my $cid = $cdom.'_'.$cnum;
3332: if (!exists($allroles{$cid})) {
3333: next;
3334: }
3335: foreach my $role_id (keys(%{$content{'roles'}})) {
3336: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3337: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3338: my @status = @{$content{'roles'}{$role_id}{'access'}};
3339: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3340: foreach my $role (keys(%{$allroles{$cid}})) {
3341: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3342: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3343: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3344: if (grep/^all$/,@sections) {
3345: return 'ok';
3346: } else {
3347: if (grep/^$sec$/,@sections) {
3348: return 'ok';
3349: }
3350: }
3351: }
3352: }
3353: if (keys(%{$allgroups{$cid}}) == 0) {
3354: if (grep/^none$/,@groups) {
3355: return 'ok';
3356: }
3357: } else {
3358: if (grep/^all$/,@groups) {
3359: return 'ok';
3360: }
3361: foreach my $group (keys(%{$allgroups{$cid}})) {
3362: if (grep/^$group$/,@groups) {
3363: return 'ok';
3364: }
3365: }
3366: }
3367: }
3368: }
3369: }
3370: }
3371: }
3372: if ($guest) {
3373: return $guest;
3374: }
3375: }
3376: }
3377: return;
3378: }
3379:
3380: sub course_group_datechecker {
3381: my ($dates,$now,$status) = @_;
3382: my ($start,$end) = split(/\./,$dates);
3383: if (!$start && !$end) {
3384: return 'ok';
3385: }
3386: if (grep/^active$/,@{$status}) {
3387: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3388: return 'ok';
3389: }
3390: }
3391: if (grep/^previous$/,@{$status}) {
3392: if ($end > $now ) {
3393: return 'ok';
3394: }
3395: }
3396: if (grep/^future$/,@{$status}) {
3397: if ($start > $now) {
3398: return 'ok';
3399: }
3400: }
3401: return;
3402: }
3403:
3404: sub parse_portfolio_url {
3405: my ($url) = @_;
3406:
3407: my ($type,$udom,$unum,$group,$file_name);
3408:
3409: if ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/portfolio(/.+)$-) {
3410: $type = 1;
3411: $udom = $1;
3412: $unum = $2;
3413: $file_name = $3;
3414: } elsif ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/groups/([^/]+)/portfolio/(.+)$-) {
3415: $type = 2;
3416: $udom = $1;
3417: $unum = $2;
3418: $group = $3;
3419: $file_name = $3.'/'.$4;
3420: }
3421: if (wantarray) {
3422: return ($type,$udom,$unum,$file_name,$group);
3423: }
3424: return $type;
3425: }
3426:
3427: sub is_portfolio_url {
3428: my ($url) = @_;
3429: return scalar(&parse_portfolio_url($url));
3430: }
3431:
3432: # ---------------------------------------------- Custom access rule evaluation
3433:
3434: sub customaccess {
3435: my ($priv,$uri)=@_;
3436: my ($urole,$urealm)=split(/\./,$env{'request.role'});
3437: $urealm=~s/^\W//;
3438: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3439: my $access=0;
3440: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3441: my ($effect,$realm,$role)=split(/\:/,$_);
3442: if ($role) {
3443: if ($role ne $urole) { next; }
3444: }
3445: foreach (split(/\s*\,\s*/,$realm)) {
3446: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3447: if ($tdom) {
3448: if ($tdom ne $udom) { next; }
3449: }
3450: if ($tcrs) {
3451: if ($tcrs ne $ucrs) { next; }
3452: }
3453: if ($tsec) {
3454: if ($tsec ne $usec) { next; }
3455: }
3456: $access=($effect eq 'allow');
3457: last;
3458: }
3459: if ($realm eq '' && $role eq '') {
3460: $access=($effect eq 'allow');
3461: }
3462: }
3463: return $access;
3464: }
3465:
3466: # ------------------------------------------------- Check for a user privilege
3467:
3468: sub allowed {
3469: my ($priv,$uri,$symb)=@_;
3470: my $ver_orguri=$uri;
3471: $uri=&deversion($uri);
3472: my $orguri=$uri;
3473: $uri=&declutter($uri);
3474:
3475: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3476: # Free bre access to adm and meta resources
3477: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3478: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3479: && ($priv eq 'bre')) {
3480: return 'F';
3481: }
3482:
3483: # Free bre access to user's own portfolio contents
3484: my ($space,$domain,$name,@dir)=split('/',$uri);
3485: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3486: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3487: return 'F';
3488: }
3489:
3490: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3491: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3492: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3493: if (exists($env{'request.course.id'})) {
3494: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3495: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3496: if (($domain eq $cdom) && ($name eq $cnum)) {
3497: my $courseprivid=$env{'request.course.id'};
3498: $courseprivid=~s/\_/\//;
3499: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3500: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3501: return $1;
3502: } else {
3503: if ($env{'request.course.sec'}) {
3504: $courseprivid.='/'.$env{'request.course.sec'};
3505: }
3506: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3507: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3508: return $2;
3509: }
3510: }
3511: }
3512: }
3513: }
3514:
3515: # Free bre to public access
3516:
3517: if ($priv eq 'bre') {
3518: my $copyright=&metadata($uri,'copyright');
3519: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3520: return 'F';
3521: }
3522: if ($copyright eq 'priv') {
3523: $uri=~/([^\/]+)\/([^\/]+)\//;
3524: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3525: return '';
3526: }
3527: }
3528: if ($copyright eq 'domain') {
3529: $uri=~/([^\/]+)\/([^\/]+)\//;
3530: unless (($env{'user.domain'} eq $1) ||
3531: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3532: return '';
3533: }
3534: }
3535: if ($env{'request.role'}=~ /li\.\//) {
3536: # Library role, so allow browsing of resources in this domain.
3537: return 'F';
3538: }
3539: if ($copyright eq 'custom') {
3540: unless (&customaccess($priv,$uri)) { return ''; }
3541: }
3542: }
3543: # Domain coordinator is trying to create a course
3544: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3545: # uri is the requested domain in this case.
3546: # comparison to 'request.role.domain' shows if the user has selected
3547: # a role of dc for the domain in question.
3548: return 'F' if ($uri eq $env{'request.role.domain'});
3549: }
3550:
3551: my $thisallowed='';
3552: my $statecond=0;
3553: my $courseprivid='';
3554:
3555: # Course
3556:
3557: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3558: $thisallowed.=$1;
3559: }
3560:
3561: # Domain
3562:
3563: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3564: =~/\Q$priv\E\&([^\:]*)/) {
3565: $thisallowed.=$1;
3566: }
3567:
3568: # Course: uri itself is a course
3569: my $courseuri=$uri;
3570: $courseuri=~s/\_(\d)/\/$1/;
3571: $courseuri=~s/^([^\/])/\/$1/;
3572:
3573: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3574: =~/\Q$priv\E\&([^\:]*)/) {
3575: $thisallowed.=$1;
3576: }
3577:
3578: # URI is an uploaded document for this course, default permissions don't matter
3579: # not allowing 'edit' access (editupload) to uploaded course docs
3580: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3581: $thisallowed='';
3582: my ($match)=&is_on_map($uri);
3583: if ($match) {
3584: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3585: =~/\Q$priv\E\&([^\:]*)/) {
3586: $thisallowed.=$1;
3587: }
3588: } else {
3589: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3590: if ($refuri) {
3591: if ($refuri =~ m|^/adm/|) {
3592: $thisallowed='F';
3593: } else {
3594: $refuri=&declutter($refuri);
3595: my ($match) = &is_on_map($refuri);
3596: if ($match) {
3597: $thisallowed='F';
3598: }
3599: }
3600: }
3601: }
3602: }
3603:
3604: if ($priv eq 'bre'
3605: && $thisallowed ne 'F'
3606: && $thisallowed ne '2'
3607: && &is_portfolio_url($uri)) {
3608: $thisallowed = &portfolio_access($uri);
3609: }
3610:
3611: # Full access at system, domain or course-wide level? Exit.
3612:
3613: if ($thisallowed=~/F/) {
3614: return 'F';
3615: }
3616:
3617: # If this is generating or modifying users, exit with special codes
3618:
3619: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3620: if (($priv eq 'cca') || ($priv eq 'caa')) {
3621: my ($audom,$auname)=split('/',$uri);
3622: # no author name given, so this just checks on the general right to make a co-author in this domain
3623: unless ($auname) { return $thisallowed; }
3624: # an author name is given, so we are about to actually make a co-author for a certain account
3625: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3626: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3627: ($audom ne $env{'request.role.domain'}))) { return ''; }
3628: }
3629: return $thisallowed;
3630: }
3631: #
3632: # Gathered so far: system, domain and course wide privileges
3633: #
3634: # Course: See if uri or referer is an individual resource that is part of
3635: # the course
3636:
3637: if ($env{'request.course.id'}) {
3638:
3639: $courseprivid=$env{'request.course.id'};
3640: if ($env{'request.course.sec'}) {
3641: $courseprivid.='/'.$env{'request.course.sec'};
3642: }
3643: $courseprivid=~s/\_/\//;
3644: my $checkreferer=1;
3645: my ($match,$cond)=&is_on_map($uri);
3646: if ($match) {
3647: $statecond=$cond;
3648: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3649: =~/\Q$priv\E\&([^\:]*)/) {
3650: $thisallowed.=$1;
3651: $checkreferer=0;
3652: }
3653: }
3654:
3655: if ($checkreferer) {
3656: my $refuri=$env{'httpref.'.$orguri};
3657: unless ($refuri) {
3658: foreach (keys %env) {
3659: if ($_=~/^httpref\..*\*/) {
3660: my $pattern=$_;
3661: $pattern=~s/^httpref\.\/res\///;
3662: $pattern=~s/\*/\[\^\/\]\+/g;
3663: $pattern=~s/\//\\\//g;
3664: if ($orguri=~/$pattern/) {
3665: $refuri=$env{$_};
3666: }
3667: }
3668: }
3669: }
3670:
3671: if ($refuri) {
3672: $refuri=&declutter($refuri);
3673: my ($match,$cond)=&is_on_map($refuri);
3674: if ($match) {
3675: my $refstatecond=$cond;
3676: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3677: =~/\Q$priv\E\&([^\:]*)/) {
3678: $thisallowed.=$1;
3679: $uri=$refuri;
3680: $statecond=$refstatecond;
3681: }
3682: }
3683: }
3684: }
3685: }
3686:
3687: #
3688: # Gathered now: all privileges that could apply, and condition number
3689: #
3690: #
3691: # Full or no access?
3692: #
3693:
3694: if ($thisallowed=~/F/) {
3695: return 'F';
3696: }
3697:
3698: unless ($thisallowed) {
3699: return '';
3700: }
3701:
3702: # Restrictions exist, deal with them
3703: #
3704: # C:according to course preferences
3705: # R:according to resource settings
3706: # L:unless locked
3707: # X:according to user session state
3708: #
3709:
3710: # Possibly locked functionality, check all courses
3711: # Locks might take effect only after 10 minutes cache expiration for other
3712: # courses, and 2 minutes for current course
3713:
3714: my $envkey;
3715: if ($thisallowed=~/L/) {
3716: foreach $envkey (keys %env) {
3717: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3718: my $courseid=$2;
3719: my $roleid=$1.'.'.$2;
3720: $courseid=~s/^\///;
3721: my $expiretime=600;
3722: if ($env{'request.role'} eq $roleid) {
3723: $expiretime=120;
3724: }
3725: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3726: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3727: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3728: &coursedescription($courseid,{'freshen_cache' => 1});
3729: }
3730: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3731: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3732: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3733: &log($env{'user.domain'},$env{'user.name'},
3734: $env{'user.home'},
3735: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3736: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3737: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3738: return '';
3739: }
3740: }
3741: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3742: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3743: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3744: &log($env{'user.domain'},$env{'user.name'},
3745: $env{'user.home'},
3746: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3747: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3748: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3749: return '';
3750: }
3751: }
3752: }
3753: }
3754: }
3755:
3756: #
3757: # Rest of the restrictions depend on selected course
3758: #
3759:
3760: unless ($env{'request.course.id'}) {
3761: if ($thisallowed eq 'A') {
3762: return 'A';
3763: } else {
3764: return '1';
3765: }
3766: }
3767:
3768: #
3769: # Now user is definitely in a course
3770: #
3771:
3772:
3773: # Course preferences
3774:
3775: if ($thisallowed=~/C/) {
3776: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3777: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3778: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3779: =~/\Q$rolecode\E/) {
3780: if ($priv ne 'pch') {
3781: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3782: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3783: $env{'request.course.id'});
3784: }
3785: return '';
3786: }
3787:
3788: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3789: =~/\Q$unamedom\E/) {
3790: if ($priv ne 'pch') {
3791: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3792: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3793: $env{'request.course.id'});
3794: }
3795: return '';
3796: }
3797: }
3798:
3799: # Resource preferences
3800:
3801: if ($thisallowed=~/R/) {
3802: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3803: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3804: if ($priv ne 'pch') {
3805: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3806: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3807: }
3808: return '';
3809: }
3810: }
3811:
3812: # Restricted by state or randomout?
3813:
3814: if ($thisallowed=~/X/) {
3815: if ($env{'acc.randomout'}) {
3816: if (!$symb) { $symb=&symbread($uri,1); }
3817: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3818: return '';
3819: }
3820: }
3821: if (&condval($statecond)) {
3822: return '2';
3823: } else {
3824: return '';
3825: }
3826: }
3827:
3828: if ($thisallowed eq 'A') {
3829: return 'A';
3830: }
3831: return 'F';
3832: }
3833:
3834: sub split_uri_for_cond {
3835: my $uri=&deversion(&declutter(shift));
3836: my @uriparts=split(/\//,$uri);
3837: my $filename=pop(@uriparts);
3838: my $pathname=join('/',@uriparts);
3839: return ($pathname,$filename);
3840: }
3841: # --------------------------------------------------- Is a resource on the map?
3842:
3843: sub is_on_map {
3844: my ($pathname,$filename) = &split_uri_for_cond(shift);
3845: #Trying to find the conditional for the file
3846: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3847: /\&\Q$filename\E\:([\d\|]+)\&/);
3848: if ($match) {
3849: return (1,$1);
3850: } else {
3851: return (0,0);
3852: }
3853: }
3854:
3855: # --------------------------------------------------------- Get symb from alias
3856:
3857: sub get_symb_from_alias {
3858: my $symb=shift;
3859: my ($map,$resid,$url)=&decode_symb($symb);
3860: # Already is a symb
3861: if ($url) { return $symb; }
3862: # Must be an alias
3863: my $aliassymb='';
3864: my %bighash;
3865: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3866: &GDBM_READER(),0640)) {
3867: my $rid=$bighash{'mapalias_'.$symb};
3868: if ($rid) {
3869: my ($mapid,$resid)=split(/\./,$rid);
3870: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3871: $resid,$bighash{'src_'.$rid});
3872: }
3873: untie %bighash;
3874: }
3875: return $aliassymb;
3876: }
3877:
3878: # ----------------------------------------------------------------- Define Role
3879:
3880: sub definerole {
3881: if (allowed('mcr','/')) {
3882: my ($rolename,$sysrole,$domrole,$courole)=@_;
3883: foreach (split(':',$sysrole)) {
3884: my ($crole,$cqual)=split(/\&/,$_);
3885: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3886: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3887: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3888: return "refused:s:$crole&$cqual";
3889: }
3890: }
3891: }
3892: foreach (split(':',$domrole)) {
3893: my ($crole,$cqual)=split(/\&/,$_);
3894: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3895: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3896: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3897: return "refused:d:$crole&$cqual";
3898: }
3899: }
3900: }
3901: foreach (split(':',$courole)) {
3902: my ($crole,$cqual)=split(/\&/,$_);
3903: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3904: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3905: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3906: return "refused:c:$crole&$cqual";
3907: }
3908: }
3909: }
3910: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3911: "$env{'user.domain'}:$env{'user.name'}:".
3912: "rolesdef_$rolename=".
3913: escape($sysrole.'_'.$domrole.'_'.$courole);
3914: return reply($command,$env{'user.home'});
3915: } else {
3916: return 'refused';
3917: }
3918: }
3919:
3920: # ---------------- Make a metadata query against the network of library servers
3921:
3922: sub metadata_query {
3923: my ($query,$custom,$customshow,$server_array)=@_;
3924: my %rhash;
3925: my @server_list = (defined($server_array) ? @$server_array
3926: : keys(%libserv) );
3927: for my $server (@server_list) {
3928: unless ($custom or $customshow) {
3929: my $reply=&reply("querysend:".&escape($query),$server);
3930: $rhash{$server}=$reply;
3931: }
3932: else {
3933: my $reply=&reply("querysend:".&escape($query).':'.
3934: &escape($custom).':'.&escape($customshow),
3935: $server);
3936: $rhash{$server}=$reply;
3937: }
3938: }
3939: return \%rhash;
3940: }
3941:
3942: # ----------------------------------------- Send log queries and wait for reply
3943:
3944: sub log_query {
3945: my ($uname,$udom,$query,%filters)=@_;
3946: my $uhome=&homeserver($uname,$udom);
3947: if ($uhome eq 'no_host') { return 'error: no_host'; }
3948: my $uhost=$hostname{$uhome};
3949: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3950: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3951: $uhome);
3952: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3953: return get_query_reply($queryid);
3954: }
3955:
3956: # ------- Request retrieval of institutional classlists for course(s)
3957:
3958: sub fetch_enrollment_query {
3959: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
3960: my $homeserver;
3961: my $maxtries = 1;
3962: if ($context eq 'automated') {
3963: $homeserver = $perlvar{'lonHostID'};
3964: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
3965: } else {
3966: $homeserver = &homeserver($cnum,$dom);
3967: }
3968: my $host=$hostname{$homeserver};
3969: my $cmd = '';
3970: foreach (keys %{$affiliatesref}) {
3971: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3972: }
3973: $cmd =~ s/%%$//;
3974: $cmd = &escape($cmd);
3975: my $query = 'fetchenrollment';
3976: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
3977: unless ($queryid=~/^\Q$host\E\_/) {
3978: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3979: return 'error: '.$queryid;
3980: }
3981: my $reply = &get_query_reply($queryid);
3982: my $tries = 1;
3983: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3984: $reply = &get_query_reply($queryid);
3985: $tries ++;
3986: }
3987: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3988: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3989: } else {
3990: my @responses = split/:/,$reply;
3991: if ($homeserver eq $perlvar{'lonHostID'}) {
3992: foreach (@responses) {
3993: my ($key,$value) = split/=/,$_;
3994: $$replyref{$key} = $value;
3995: }
3996: } else {
3997: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3998: foreach (@responses) {
3999: my ($key,$value) = split/=/,$_;
4000: $$replyref{$key} = $value;
4001: if ($value > 0) {
4002: foreach (@{$$affiliatesref{$key}}) {
4003: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
4004: my $destname = $pathname.'/'.$filename;
4005: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4006: if ($xml_classlist =~ /^error/) {
4007: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4008: } else {
4009: if ( open(FILE,">$destname") ) {
4010: print FILE &unescape($xml_classlist);
4011: close(FILE);
4012: } else {
4013: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4014: }
4015: }
4016: }
4017: }
4018: }
4019: }
4020: return 'ok';
4021: }
4022: return 'error';
4023: }
4024:
4025: sub get_query_reply {
4026: my $queryid=shift;
4027: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4028: my $reply='';
4029: for (1..100) {
4030: sleep 2;
4031: if (-e $replyfile.'.end') {
4032: if (open(my $fh,$replyfile)) {
4033: $reply.=<$fh>;
4034: close($fh);
4035: } else { return 'error: reply_file_error'; }
4036: return &unescape($reply);
4037: }
4038: }
4039: return 'timeout:'.$queryid;
4040: }
4041:
4042: sub courselog_query {
4043: #
4044: # possible filters:
4045: # url: url or symb
4046: # username
4047: # domain
4048: # action: view, submit, grade
4049: # start: timestamp
4050: # end: timestamp
4051: #
4052: my (%filters)=@_;
4053: unless ($env{'request.course.id'}) { return 'no_course'; }
4054: if ($filters{'url'}) {
4055: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4056: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4057: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4058: }
4059: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4060: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4061: return &log_query($cname,$cdom,'courselog',%filters);
4062: }
4063:
4064: sub userlog_query {
4065: my ($uname,$udom,%filters)=@_;
4066: return &log_query($uname,$udom,'userlog',%filters);
4067: }
4068:
4069: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4070:
4071: sub auto_run {
4072: my ($cnum,$cdom) = @_;
4073: my $homeserver = &homeserver($cnum,$cdom);
4074: my $response = &reply('autorun:'.$cdom,$homeserver);
4075: return $response;
4076: }
4077:
4078: sub auto_get_sections {
4079: my ($cnum,$cdom,$inst_coursecode) = @_;
4080: my $homeserver = &homeserver($cnum,$cdom);
4081: my @secs = ();
4082: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4083: unless ($response eq 'refused') {
4084: @secs = split/:/,$response;
4085: }
4086: return @secs;
4087: }
4088:
4089: sub auto_new_course {
4090: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4091: my $homeserver = &homeserver($cnum,$cdom);
4092: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4093: return $response;
4094: }
4095:
4096: sub auto_validate_courseID {
4097: my ($cnum,$cdom,$inst_course_id) = @_;
4098: my $homeserver = &homeserver($cnum,$cdom);
4099: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4100: return $response;
4101: }
4102:
4103: sub auto_create_password {
4104: my ($cnum,$cdom,$authparam) = @_;
4105: my $homeserver = &homeserver($cnum,$cdom);
4106: my $create_passwd = 0;
4107: my $authchk = '';
4108: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4109: if ($response eq 'refused') {
4110: $authchk = 'refused';
4111: } else {
4112: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4113: }
4114: return ($authparam,$create_passwd,$authchk);
4115: }
4116:
4117: sub auto_photo_permission {
4118: my ($cnum,$cdom,$students) = @_;
4119: my $homeserver = &homeserver($cnum,$cdom);
4120: my ($outcome,$perm_reqd,$conditions) =
4121: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4122: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4123: return (undef,undef);
4124: }
4125: return ($outcome,$perm_reqd,$conditions);
4126: }
4127:
4128: sub auto_checkphotos {
4129: my ($uname,$udom,$pid) = @_;
4130: my $homeserver = &homeserver($uname,$udom);
4131: my ($result,$resulttype);
4132: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4133: &escape($uname).':'.&escape($pid),
4134: $homeserver));
4135: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4136: return (undef,undef);
4137: }
4138: if ($outcome) {
4139: ($result,$resulttype) = split(/:/,$outcome);
4140: }
4141: return ($result,$resulttype);
4142: }
4143:
4144: sub auto_photochoice {
4145: my ($cnum,$cdom) = @_;
4146: my $homeserver = &homeserver($cnum,$cdom);
4147: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4148: &escape($cdom),
4149: $homeserver)));
4150: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4151: return (undef,undef);
4152: }
4153: return ($update,$comment);
4154: }
4155:
4156: sub auto_photoupdate {
4157: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4158: my $homeserver = &homeserver($cnum,$dom);
4159: my $host=$hostname{$homeserver};
4160: my $cmd = '';
4161: my $maxtries = 1;
4162: foreach (keys %{$affiliatesref}) {
4163: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
4164: }
4165: $cmd =~ s/%%$//;
4166: $cmd = &escape($cmd);
4167: my $query = 'institutionalphotos';
4168: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4169: unless ($queryid=~/^\Q$host\E\_/) {
4170: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4171: return 'error: '.$queryid;
4172: }
4173: my $reply = &get_query_reply($queryid);
4174: my $tries = 1;
4175: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4176: $reply = &get_query_reply($queryid);
4177: $tries ++;
4178: }
4179: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4180: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4181: } else {
4182: my @responses = split(/:/,$reply);
4183: my $outcome = shift(@responses);
4184: foreach my $item (@responses) {
4185: my ($key,$value) = split(/=/,$item);
4186: $$photo{$key} = $value;
4187: }
4188: return $outcome;
4189: }
4190: return 'error';
4191: }
4192:
4193: sub auto_instcode_format {
4194: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
4195: my $courses = '';
4196: my @homeservers;
4197: if ($caller eq 'global') {
4198: foreach my $tryserver (keys %libserv) {
4199: if ($hostdom{$tryserver} eq $codedom) {
4200: if (!grep/^\Q$tryserver\E$/,@homeservers) {
4201: push(@homeservers,$tryserver);
4202: }
4203: }
4204: }
4205: } else {
4206: push(@homeservers,&homeserver($caller,$codedom));
4207: }
4208: foreach (keys %{$instcodes}) {
4209: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
4210: }
4211: chop($courses);
4212: my $ok_response = 0;
4213: my $response;
4214: while (@homeservers > 0 && $ok_response == 0) {
4215: my $server = shift(@homeservers);
4216: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4217: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4218: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4219: split/:/,$response;
4220: %{$codes} = (%{$codes},&str2hash($codes_str));
4221: push(@{$codetitles},&str2array($codetitles_str));
4222: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4223: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4224: $ok_response = 1;
4225: }
4226: }
4227: if ($ok_response) {
4228: return 'ok';
4229: } else {
4230: return $response;
4231: }
4232: }
4233:
4234: sub auto_validate_class_sec {
4235: my ($cdom,$cnum,$owner,$inst_class) = @_;
4236: my $homeserver = &homeserver($cnum,$cdom);
4237: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4238: &escape($owner).':'.$cdom,$homeserver);
4239: return $response;
4240: }
4241:
4242: # ------------------------------------------------------- Course Group routines
4243:
4244: sub get_coursegroups {
4245: my ($cdom,$cnum,$group) = @_;
4246: return(&dump('coursegroups',$cdom,$cnum,$group));
4247: }
4248:
4249: sub modify_coursegroup {
4250: my ($cdom,$cnum,$groupsettings) = @_;
4251: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4252: }
4253:
4254: sub modify_group_roles {
4255: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4256: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4257: my $role = 'gr/'.&escape($userprivs);
4258: my ($uname,$udom) = split(/:/,$user);
4259: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4260: if ($result eq 'ok') {
4261: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4262: }
4263: return $result;
4264: }
4265:
4266: sub modify_coursegroup_membership {
4267: my ($cdom,$cnum,$membership) = @_;
4268: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4269: return $result;
4270: }
4271:
4272: sub get_active_groups {
4273: my ($udom,$uname,$cdom,$cnum) = @_;
4274: my $now = time;
4275: my %groups = ();
4276: foreach my $key (keys(%env)) {
4277: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4278: my ($start,$end) = split(/\./,$env{$key});
4279: if (($end!=0) && ($end<$now)) { next; }
4280: if (($start!=0) && ($start>$now)) { next; }
4281: if ($1 eq $cdom && $2 eq $cnum) {
4282: $groups{$3} = $env{$key} ;
4283: }
4284: }
4285: }
4286: return %groups;
4287: }
4288:
4289: sub get_group_membership {
4290: my ($cdom,$cnum,$group) = @_;
4291: return(&dump('groupmembership',$cdom,$cnum,$group));
4292: }
4293:
4294: sub get_users_groups {
4295: my ($udom,$uname,$courseid) = @_;
4296: my @usersgroups;
4297: my $cachetime=1800;
4298: $courseid=~s/\_/\//g;
4299: $courseid=~s/^(\w)/\/$1/;
4300:
4301: my $hashid="$udom:$uname:$courseid";
4302: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4303: if (defined($cached)) {
4304: @usersgroups = split(/:/,$grouplist);
4305: } else {
4306: $grouplist = '';
4307: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4308: my ($tmp) = keys(%roleshash);
4309: if ($tmp=~/^error:/) {
4310: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4311: } else {
4312: my $access_end = $env{'course.'.$courseid.
4313: '.default_enrollment_end_date'};
4314: my $now = time;
4315: foreach my $key (keys(%roleshash)) {
4316: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4317: my $group = $1;
4318: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4319: my $start = $2;
4320: my $end = $1;
4321: if ($start == -1) { next; } # deleted from group
4322: if (($start!=0) && ($start>$now)) { next; }
4323: if (($end!=0) && ($end<$now)) {
4324: if ($access_end && $access_end < $now) {
4325: if ($access_end - $end < 86400) {
4326: push(@usersgroups,$group);
4327: }
4328: }
4329: next;
4330: }
4331: push(@usersgroups,$group);
4332: }
4333: }
4334: }
4335: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4336: $grouplist = join(':',@usersgroups);
4337: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4338: }
4339: }
4340: return @usersgroups;
4341: }
4342:
4343: sub devalidate_getgroups_cache {
4344: my ($udom,$uname,$cdom,$cnum)=@_;
4345: my $courseid = $cdom.'_'.$cnum;
4346: $courseid=~s/\_/\//g;
4347: $courseid=~s/^(\w)/\/$1/;
4348: my $hashid="$udom:$uname:$courseid";
4349: &devalidate_cache_new('getgroups',$hashid);
4350: }
4351:
4352: # ------------------------------------------------------------------ Plain Text
4353:
4354: sub plaintext {
4355: my ($short,$type,$cid) = @_;
4356: if ($short =~ /^cr/) {
4357: return (split('/',$short))[-1];
4358: }
4359: if (!defined($cid)) {
4360: $cid = $env{'request.course.id'};
4361: }
4362: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4363: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4364: '.plaintext'});
4365: }
4366: my %rolenames = (
4367: Course => 'std',
4368: Group => 'alt1',
4369: );
4370: if (defined($type) &&
4371: defined($rolenames{$type}) &&
4372: defined($prp{$short}{$rolenames{$type}})) {
4373: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4374: } else {
4375: return &Apache::lonlocal::mt($prp{$short}{'std'});
4376: }
4377: }
4378:
4379: # ----------------------------------------------------------------- Assign Role
4380:
4381: sub assignrole {
4382: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4383: my $mrole;
4384: if ($role =~ /^cr\//) {
4385: my $cwosec=$url;
4386: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4387: unless (&allowed('ccr',$cwosec)) {
4388: &logthis('Refused custom assignrole: '.
4389: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4390: $env{'user.name'}.' at '.$env{'user.domain'});
4391: return 'refused';
4392: }
4393: $mrole='cr';
4394: } elsif ($role =~ /^gr\//) {
4395: my $cwogrp=$url;
4396: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4397: unless (&allowed('mdg',$cwogrp)) {
4398: &logthis('Refused group assignrole: '.
4399: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4400: $env{'user.name'}.' at '.$env{'user.domain'});
4401: return 'refused';
4402: }
4403: $mrole='gr';
4404: } else {
4405: my $cwosec=$url;
4406: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4407: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4408: &logthis('Refused assignrole: '.
4409: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4410: $env{'user.name'}.' at '.$env{'user.domain'});
4411: return 'refused';
4412: }
4413: $mrole=$role;
4414: }
4415: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4416: "$udom:$uname:$url".'_'."$mrole=$role";
4417: if ($end) { $command.='_'.$end; }
4418: if ($start) {
4419: if ($end) {
4420: $command.='_'.$start;
4421: } else {
4422: $command.='_0_'.$start;
4423: }
4424: }
4425: my $origstart = $start;
4426: my $origend = $end;
4427: # actually delete
4428: if ($deleteflag) {
4429: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4430: # modify command to delete the role
4431: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4432: "$udom:$uname:$url".'_'."$mrole";
4433: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4434: # set start and finish to negative values for userrolelog
4435: $start=-1;
4436: $end=-1;
4437: }
4438: }
4439: # send command
4440: my $answer=&reply($command,&homeserver($uname,$udom));
4441: # log new user role if status is ok
4442: if ($answer eq 'ok') {
4443: &userrolelog($role,$uname,$udom,$url,$start,$end);
4444: # for course roles, perform group memberships changes triggered by role change.
4445: unless ($role =~ /^gr/) {
4446: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4447: $origstart);
4448: }
4449: }
4450: return $answer;
4451: }
4452:
4453: # -------------------------------------------------- Modify user authentication
4454: # Overrides without validation
4455:
4456: sub modifyuserauth {
4457: my ($udom,$uname,$umode,$upass)=@_;
4458: my $uhome=&homeserver($uname,$udom);
4459: unless (&allowed('mau',$udom)) { return 'refused'; }
4460: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4461: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4462: ' in domain '.$env{'request.role.domain'});
4463: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4464: &escape($upass),$uhome);
4465: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4466: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4467: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4468: &log($udom,,$uname,$uhome,
4469: 'Authentication changed by '.$env{'user.domain'}.', '.
4470: $env{'user.name'}.', '.$umode.
4471: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4472: unless ($reply eq 'ok') {
4473: &logthis('Authentication mode error: '.$reply);
4474: return 'error: '.$reply;
4475: }
4476: return 'ok';
4477: }
4478:
4479: # --------------------------------------------------------------- Modify a user
4480:
4481: sub modifyuser {
4482: my ($udom, $uname, $uid,
4483: $umode, $upass, $first,
4484: $middle, $last, $gene,
4485: $forceid, $desiredhome, $email)=@_;
4486: $udom=~s/\W//g;
4487: $uname=~s/\W//g;
4488: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4489: $umode.', '.$first.', '.$middle.', '.
4490: $last.', '.$gene.'(forceid: '.$forceid.')'.
4491: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4492: ' desiredhome not specified').
4493: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4494: ' in domain '.$env{'request.role.domain'});
4495: my $uhome=&homeserver($uname,$udom,'true');
4496: # ----------------------------------------------------------------- Create User
4497: if (($uhome eq 'no_host') &&
4498: (($umode && $upass) || ($umode eq 'localauth'))) {
4499: my $unhome='';
4500: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4501: $unhome = $desiredhome;
4502: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4503: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4504: } else { # load balancing routine for determining $unhome
4505: my $tryserver;
4506: my $loadm=10000000;
4507: foreach $tryserver (keys %libserv) {
4508: if ($hostdom{$tryserver} eq $udom) {
4509: my $answer=reply('load',$tryserver);
4510: if (($answer=~/\d+/) && ($answer<$loadm)) {
4511: $loadm=$answer;
4512: $unhome=$tryserver;
4513: }
4514: }
4515: }
4516: }
4517: if (($unhome eq '') || ($unhome eq 'no_host')) {
4518: return 'error: unable to find a home server for '.$uname.
4519: ' in domain '.$udom;
4520: }
4521: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4522: &escape($upass),$unhome);
4523: unless ($reply eq 'ok') {
4524: return 'error: '.$reply;
4525: }
4526: $uhome=&homeserver($uname,$udom,'true');
4527: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4528: return 'error: unable verify users home machine.';
4529: }
4530: } # End of creation of new user
4531: # ---------------------------------------------------------------------- Add ID
4532: if ($uid) {
4533: $uid=~tr/A-Z/a-z/;
4534: my %uidhash=&idrget($udom,$uname);
4535: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4536: && (!$forceid)) {
4537: unless ($uid eq $uidhash{$uname}) {
4538: return 'error: user id "'.$uid.'" does not match '.
4539: 'current user id "'.$uidhash{$uname}.'".';
4540: }
4541: } else {
4542: &idput($udom,($uname => $uid));
4543: }
4544: }
4545: # -------------------------------------------------------------- Add names, etc
4546: my @tmp=&get('environment',
4547: ['firstname','middlename','lastname','generation'],
4548: $udom,$uname);
4549: my %names;
4550: if ($tmp[0] =~ m/^error:.*/) {
4551: %names=();
4552: } else {
4553: %names = @tmp;
4554: }
4555: #
4556: # Make sure to not trash student environment if instructor does not bother
4557: # to supply name and email information
4558: #
4559: if ($first) { $names{'firstname'} = $first; }
4560: if (defined($middle)) { $names{'middlename'} = $middle; }
4561: if ($last) { $names{'lastname'} = $last; }
4562: if (defined($gene)) { $names{'generation'} = $gene; }
4563: if ($email) {
4564: $email=~s/[^\w\@\.\-\,]//gs;
4565: if ($email=~/\@/) { $names{'notification'} = $email;
4566: $names{'critnotification'} = $email;
4567: $names{'permanentemail'} = $email; }
4568: }
4569: my $reply = &put('environment', \%names, $udom,$uname);
4570: if ($reply ne 'ok') { return 'error: '.$reply; }
4571: &devalidate_cache_new('namescache',$uname.':'.$udom);
4572: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4573: $umode.', '.$first.', '.$middle.', '.
4574: $last.', '.$gene.' by '.
4575: $env{'user.name'}.' at '.$env{'user.domain'});
4576: return 'ok';
4577: }
4578:
4579: # -------------------------------------------------------------- Modify student
4580:
4581: sub modifystudent {
4582: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4583: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4584: if (!$cid) {
4585: unless ($cid=$env{'request.course.id'}) {
4586: return 'not_in_class';
4587: }
4588: }
4589: # --------------------------------------------------------------- Make the user
4590: my $reply=&modifyuser
4591: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4592: $desiredhome,$email);
4593: unless ($reply eq 'ok') { return $reply; }
4594: # This will cause &modify_student_enrollment to get the uid from the
4595: # students environment
4596: $uid = undef if (!$forceid);
4597: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4598: $gene,$usec,$end,$start,$type,$locktype,$cid);
4599: return $reply;
4600: }
4601:
4602: sub modify_student_enrollment {
4603: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4604: my ($cdom,$cnum,$chome);
4605: if (!$cid) {
4606: unless ($cid=$env{'request.course.id'}) {
4607: return 'not_in_class';
4608: }
4609: $cdom=$env{'course.'.$cid.'.domain'};
4610: $cnum=$env{'course.'.$cid.'.num'};
4611: } else {
4612: ($cdom,$cnum)=split(/_/,$cid);
4613: }
4614: $chome=$env{'course.'.$cid.'.home'};
4615: if (!$chome) {
4616: $chome=&homeserver($cnum,$cdom);
4617: }
4618: if (!$chome) { return 'unknown_course'; }
4619: # Make sure the user exists
4620: my $uhome=&homeserver($uname,$udom);
4621: if (($uhome eq '') || ($uhome eq 'no_host')) {
4622: return 'error: no such user';
4623: }
4624: # Get student data if we were not given enough information
4625: if (!defined($first) || $first eq '' ||
4626: !defined($last) || $last eq '' ||
4627: !defined($uid) || $uid eq '' ||
4628: !defined($middle) || $middle eq '' ||
4629: !defined($gene) || $gene eq '') {
4630: # They did not supply us with enough data to enroll the student, so
4631: # we need to pick up more information.
4632: my %tmp = &get('environment',
4633: ['firstname','middlename','lastname', 'generation','id']
4634: ,$udom,$uname);
4635:
4636: #foreach (keys(%tmp)) {
4637: # &logthis("key $_ = ".$tmp{$_});
4638: #}
4639: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4640: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4641: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4642: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4643: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4644: }
4645: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4646: my $reply=cput('classlist',
4647: {"$uname:$udom" =>
4648: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4649: $cdom,$cnum);
4650: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4651: return 'error: '.$reply;
4652: } else {
4653: &devalidate_getsection_cache($udom,$uname,$cid);
4654: }
4655: # Add student role to user
4656: my $uurl='/'.$cid;
4657: $uurl=~s/\_/\//g;
4658: if ($usec) {
4659: $uurl.='/'.$usec;
4660: }
4661: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4662: }
4663:
4664: sub format_name {
4665: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4666: my $name;
4667: if ($first ne 'lastname') {
4668: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4669: } else {
4670: if ($lastname=~/\S/) {
4671: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4672: $name=~s/\s+,/,/;
4673: } else {
4674: $name.= $firstname.' '.$middlename.' '.$generation;
4675: }
4676: }
4677: $name=~s/^\s+//;
4678: $name=~s/\s+$//;
4679: $name=~s/\s+/ /g;
4680: return $name;
4681: }
4682:
4683: # ------------------------------------------------- Write to course preferences
4684:
4685: sub writecoursepref {
4686: my ($courseid,%prefs)=@_;
4687: $courseid=~s/^\///;
4688: $courseid=~s/\_/\//g;
4689: my ($cdomain,$cnum)=split(/\//,$courseid);
4690: my $chome=homeserver($cnum,$cdomain);
4691: if (($chome eq '') || ($chome eq 'no_host')) {
4692: return 'error: no such course';
4693: }
4694: my $cstring='';
4695: foreach (keys %prefs) {
4696: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
4697: }
4698: $cstring=~s/\&$//;
4699: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4700: }
4701:
4702: # ---------------------------------------------------------- Make/modify course
4703:
4704: sub createcourse {
4705: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4706: $course_owner,$crstype)=@_;
4707: $url=&declutter($url);
4708: my $cid='';
4709: unless (&allowed('ccc',$udom)) {
4710: return 'refused';
4711: }
4712: # ------------------------------------------------------------------- Create ID
4713: my $uname=int(1+rand(9)).
4714: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4715: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4716: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4717: # ----------------------------------------------- Make sure that does not exist
4718: my $uhome=&homeserver($uname,$udom,'true');
4719: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4720: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4721: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4722: $uhome=&homeserver($uname,$udom,'true');
4723: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4724: return 'error: unable to generate unique course-ID';
4725: }
4726: }
4727: # ------------------------------------------------ Check supplied server name
4728: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4729: if (! exists($libserv{$course_server})) {
4730: return 'error:bad server name '.$course_server;
4731: }
4732: # ------------------------------------------------------------- Make the course
4733: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4734: $course_server);
4735: unless ($reply eq 'ok') { return 'error: '.$reply; }
4736: $uhome=&homeserver($uname,$udom,'true');
4737: if (($uhome eq '') || ($uhome eq 'no_host')) {
4738: return 'error: no such course';
4739: }
4740: # ----------------------------------------------------------------- Course made
4741: # log existence
4742: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4743: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4744: &escape($crstype),$uhome);
4745: &flushcourselogs();
4746: # set toplevel url
4747: my $topurl=$url;
4748: unless ($nonstandard) {
4749: # ------------------------------------------ For standard courses, make top url
4750: my $mapurl=&clutter($url);
4751: if ($mapurl eq '/res/') { $mapurl=''; }
4752: $env{'form.initmap'}=(<<ENDINITMAP);
4753: <map>
4754: <resource id="1" type="start"></resource>
4755: <resource id="2" src="$mapurl"></resource>
4756: <resource id="3" type="finish"></resource>
4757: <link index="1" from="1" to="2"></link>
4758: <link index="2" from="2" to="3"></link>
4759: </map>
4760: ENDINITMAP
4761: $topurl=&declutter(
4762: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4763: );
4764: }
4765: # ----------------------------------------------------------- Write preferences
4766: &writecoursepref($udom.'_'.$uname,
4767: ('description' => $description,
4768: 'url' => $topurl));
4769: return '/'.$udom.'/'.$uname;
4770: }
4771:
4772: # ---------------------------------------------------------- Assign Custom Role
4773:
4774: sub assigncustomrole {
4775: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4776: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4777: $end,$start,$deleteflag);
4778: }
4779:
4780: # ----------------------------------------------------------------- Revoke Role
4781:
4782: sub revokerole {
4783: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4784: my $now=time;
4785: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4786: }
4787:
4788: # ---------------------------------------------------------- Revoke Custom Role
4789:
4790: sub revokecustomrole {
4791: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4792: my $now=time;
4793: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4794: $deleteflag);
4795: }
4796:
4797: # ------------------------------------------------------------ Disk usage
4798: sub diskusage {
4799: my ($udom,$uname,$directoryRoot)=@_;
4800: $directoryRoot =~ s/\/$//;
4801: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4802: return $listing;
4803: }
4804:
4805: sub is_locked {
4806: my ($file_name, $domain, $user) = @_;
4807: my @check;
4808: my $is_locked;
4809: push @check, $file_name;
4810: my %locked = &get('file_permissions',\@check,
4811: $env{'user.domain'},$env{'user.name'});
4812: my ($tmp)=keys(%locked);
4813: if ($tmp=~/^error:/) { undef(%locked); }
4814:
4815: if (ref($locked{$file_name}) eq 'ARRAY') {
4816: $is_locked = 'false';
4817: foreach my $entry (@{$locked{$file_name}}) {
4818: if (ref($entry) eq 'ARRAY') {
4819: $is_locked = 'true';
4820: last;
4821: }
4822: }
4823: } else {
4824: $is_locked = 'false';
4825: }
4826: }
4827:
4828: sub declutter_portfile {
4829: my ($file) = @_;
4830: &logthis("got $file");
4831: $file =~ s-^(/portfolio/|portfolio/)-/-;
4832: &logthis("ret $file");
4833: return $file;
4834: }
4835:
4836: # ------------------------------------------------------------- Mark as Read Only
4837:
4838: sub mark_as_readonly {
4839: my ($domain,$user,$files,$what) = @_;
4840: my %current_permissions = &dump('file_permissions',$domain,$user);
4841: my ($tmp)=keys(%current_permissions);
4842: if ($tmp=~/^error:/) { undef(%current_permissions); }
4843: foreach my $file (@{$files}) {
4844: $file = &declutter_portfile($file);
4845: push(@{$current_permissions{$file}},$what);
4846: }
4847: &put('file_permissions',\%current_permissions,$domain,$user);
4848: return;
4849: }
4850:
4851: # ------------------------------------------------------------Save Selected Files
4852:
4853: sub save_selected_files {
4854: my ($user, $path, @files) = @_;
4855: my $filename = $user."savedfiles";
4856: my @other_files = &files_not_in_path($user, $path);
4857: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4858: foreach my $file (@files) {
4859: print (OUT $env{'form.currentpath'}.$file."\n");
4860: }
4861: foreach my $file (@other_files) {
4862: print (OUT $file."\n");
4863: }
4864: close (OUT);
4865: return 'ok';
4866: }
4867:
4868: sub clear_selected_files {
4869: my ($user) = @_;
4870: my $filename = $user."savedfiles";
4871: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4872: print (OUT undef);
4873: close (OUT);
4874: return ("ok");
4875: }
4876:
4877: sub files_in_path {
4878: my ($user, $path) = @_;
4879: my $filename = $user."savedfiles";
4880: my %return_files;
4881: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4882: while (my $line_in = <IN>) {
4883: chomp ($line_in);
4884: my @paths_and_file = split (m!/!, $line_in);
4885: my $file_part = pop (@paths_and_file);
4886: my $path_part = join ('/', @paths_and_file);
4887: $path_part.='/';
4888: my $path_and_file = $path_part.$file_part;
4889: if ($path_part eq $path) {
4890: $return_files{$file_part}= 'selected';
4891: }
4892: }
4893: close (IN);
4894: return (\%return_files);
4895: }
4896:
4897: # called in portfolio select mode, to show files selected NOT in current directory
4898: sub files_not_in_path {
4899: my ($user, $path) = @_;
4900: my $filename = $user."savedfiles";
4901: my @return_files;
4902: my $path_part;
4903: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4904: while (<IN>) {
4905: #ok, I know it's clunky, but I want it to work
4906: my @paths_and_file = split m!/!, $_;
4907: my $file_part = pop (@paths_and_file);
4908: chomp ($file_part);
4909: my $path_part = join ('/', @paths_and_file);
4910: $path_part .= '/';
4911: my $path_and_file = $path_part.$file_part;
4912: if ($path_part ne $path) {
4913: push (@return_files, ($path_and_file));
4914: }
4915: }
4916: close (OUT);
4917: return (@return_files);
4918: }
4919:
4920: #----------------------------------------------Get portfolio file permissions
4921:
4922: sub get_portfile_permissions {
4923: my ($domain,$user) = @_;
4924: my %current_permissions = &dump('file_permissions',$domain,$user);
4925: my ($tmp)=keys(%current_permissions);
4926: if ($tmp=~/^error:/) { undef(%current_permissions); }
4927: return \%current_permissions;
4928: }
4929:
4930: #---------------------------------------------Get portfolio file access controls
4931:
4932: sub get_access_controls {
4933: my ($current_permissions,$group,$file) = @_;
4934: my %access;
4935: my $real_file = $file;
4936: $file =~ s/\.meta$//;
4937: if (defined($file)) {
4938: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4939: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4940: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
4941: }
4942: }
4943: } else {
4944: foreach my $key (keys(%{$current_permissions})) {
4945: if ($key =~ /\0accesscontrol$/) {
4946: if (defined($group)) {
4947: if ($key !~ m-^\Q$group\E/-) {
4948: next;
4949: }
4950: }
4951: my ($fullpath) = split(/\0/,$key);
4952: if (ref($$current_permissions{$key}) eq 'HASH') {
4953: foreach my $control (keys(%{$$current_permissions{$key}})) {
4954: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4955: }
4956: }
4957: }
4958: }
4959: }
4960: return %access;
4961: }
4962:
4963: sub modify_access_controls {
4964: my ($file_name,$changes,$domain,$user)=@_;
4965: my ($outcome,$deloutcome);
4966: my %store_permissions;
4967: my %new_values;
4968: my %new_control;
4969: my %translation;
4970: my @deletions = ();
4971: my $now = time;
4972: if (exists($$changes{'activate'})) {
4973: if (ref($$changes{'activate'}) eq 'HASH') {
4974: my @newitems = sort(keys(%{$$changes{'activate'}}));
4975: my $numnew = scalar(@newitems);
4976: for (my $i=0; $i<$numnew; $i++) {
4977: my $newkey = $newitems[$i];
4978: my $newid = &Apache::loncommon::get_cgi_id();
4979: $newkey =~ s/^(\d+)/$newid/;
4980: $translation{$1} = $newid;
4981: $new_values{$file_name."\0".$newkey} =
4982: $$changes{'activate'}{$newitems[$i]};
4983: $new_control{$newkey} = $now;
4984: }
4985: }
4986: }
4987: my %todelete;
4988: my %changed_items;
4989: foreach my $action ('delete','update') {
4990: if (exists($$changes{$action})) {
4991: if (ref($$changes{$action}) eq 'HASH') {
4992: foreach my $key (keys(%{$$changes{$action}})) {
4993: my ($itemnum) = ($key =~ /^([^:]+):/);
4994: if ($action eq 'delete') {
4995: $todelete{$itemnum} = 1;
4996: } else {
4997: $changed_items{$itemnum} = $key;
4998: }
4999: }
5000: }
5001: }
5002: }
5003: # get lock on access controls for file.
5004: my $lockhash = {
5005: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5006: ':'.$env{'user.domain'},
5007: };
5008: my $tries = 0;
5009: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5010:
5011: while (($gotlock ne 'ok') && $tries <3) {
5012: $tries ++;
5013: sleep 1;
5014: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5015: }
5016: if ($gotlock eq 'ok') {
5017: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5018: my ($tmp)=keys(%curr_permissions);
5019: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5020: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5021: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5022: if (ref($curr_controls) eq 'HASH') {
5023: foreach my $control_item (keys(%{$curr_controls})) {
5024: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5025: if (defined($todelete{$itemnum})) {
5026: push(@deletions,$file_name."\0".$control_item);
5027: } else {
5028: if (defined($changed_items{$itemnum})) {
5029: $new_control{$changed_items{$itemnum}} = $now;
5030: push(@deletions,$file_name."\0".$control_item);
5031: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5032: } else {
5033: $new_control{$control_item} = $$curr_controls{$control_item};
5034: }
5035: }
5036: }
5037: }
5038: }
5039: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5040: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5041: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5042: # remove lock
5043: my @del_lock = ($file_name."\0".'locked_access_records');
5044: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5045: } else {
5046: $outcome = "error: could not obtain lockfile\n";
5047: }
5048: return ($outcome,$deloutcome,\%new_values,\%translation);
5049: }
5050:
5051: #------------------------------------------------------Get Marked as Read Only
5052:
5053: sub get_marked_as_readonly {
5054: my ($domain,$user,$what,$group) = @_;
5055: my $current_permissions = &get_portfile_permissions($domain,$user);
5056: my @readonly_files;
5057: my $cmp1=$what;
5058: if (ref($what)) { $cmp1=join('',@{$what}) };
5059: while (my ($file_name,$value) = each(%{$current_permissions})) {
5060: if (defined($group)) {
5061: if ($file_name !~ m-^\Q$group\E/-) {
5062: next;
5063: }
5064: }
5065: if (ref($value) eq "ARRAY"){
5066: foreach my $stored_what (@{$value}) {
5067: my $cmp2=$stored_what;
5068: if (ref($stored_what) eq 'ARRAY') {
5069: $cmp2=join('',@{$stored_what});
5070: }
5071: if ($cmp1 eq $cmp2) {
5072: push(@readonly_files, $file_name);
5073: last;
5074: } elsif (!defined($what)) {
5075: push(@readonly_files, $file_name);
5076: last;
5077: }
5078: }
5079: }
5080: }
5081: return @readonly_files;
5082: }
5083: #-----------------------------------------------------------Get Marked as Read Only Hash
5084:
5085: sub get_marked_as_readonly_hash {
5086: my ($current_permissions,$group,$what) = @_;
5087: my %readonly_files;
5088: while (my ($file_name,$value) = each(%{$current_permissions})) {
5089: if (defined($group)) {
5090: if ($file_name !~ m-^\Q$group\E/-) {
5091: next;
5092: }
5093: }
5094: if (ref($value) eq "ARRAY"){
5095: foreach my $stored_what (@{$value}) {
5096: if (ref($stored_what) eq 'ARRAY') {
5097: foreach my $lock_descriptor(@{$stored_what}) {
5098: if ($lock_descriptor eq 'graded') {
5099: $readonly_files{$file_name} = 'graded';
5100: } elsif ($lock_descriptor eq 'handback') {
5101: $readonly_files{$file_name} = 'handback';
5102: } else {
5103: if (!exists($readonly_files{$file_name})) {
5104: $readonly_files{$file_name} = 'locked';
5105: }
5106: }
5107: }
5108: }
5109: }
5110: }
5111: }
5112: return %readonly_files;
5113: }
5114: # ------------------------------------------------------------ Unmark as Read Only
5115:
5116: sub unmark_as_readonly {
5117: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5118: # for portfolio submissions, $what contains [$symb,$crsid]
5119: my ($domain,$user,$what,$file_name,$group) = @_;
5120: $file_name = &declutter_portfile($file_name);
5121: my $symb_crs = $what;
5122: if (ref($what)) { $symb_crs=join('',@$what); }
5123: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5124: my ($tmp)=keys(%current_permissions);
5125: if ($tmp=~/^error:/) { undef(%current_permissions); }
5126: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5127: foreach my $file (@readonly_files) {
5128: my $clean_file = &declutter_portfile($file);
5129: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5130: my $current_locks = $current_permissions{$file};
5131: my @new_locks;
5132: my @del_keys;
5133: if (ref($current_locks) eq "ARRAY"){
5134: foreach my $locker (@{$current_locks}) {
5135: my $compare=$locker;
5136: if (ref($locker) eq 'ARRAY') {
5137: $compare=join('',@{$locker});
5138: if ($compare ne $symb_crs) {
5139: push(@new_locks, $locker);
5140: }
5141: }
5142: }
5143: if (scalar(@new_locks) > 0) {
5144: $current_permissions{$file} = \@new_locks;
5145: } else {
5146: push(@del_keys, $file);
5147: &del('file_permissions',\@del_keys, $domain, $user);
5148: delete($current_permissions{$file});
5149: }
5150: }
5151: }
5152: &put('file_permissions',\%current_permissions,$domain,$user);
5153: return;
5154: }
5155:
5156: # ------------------------------------------------------------ Directory lister
5157:
5158: sub dirlist {
5159: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5160:
5161: $uri=~s/^\///;
5162: $uri=~s/\/$//;
5163: my ($udom, $uname);
5164: (undef,$udom,$uname)=split(/\//,$uri);
5165: if(defined($userdomain)) {
5166: $udom = $userdomain;
5167: }
5168: if(defined($username)) {
5169: $uname = $username;
5170: }
5171:
5172: my $dirRoot = $perlvar{'lonDocRoot'};
5173: if(defined($alternateDirectoryRoot)) {
5174: $dirRoot = $alternateDirectoryRoot;
5175: $dirRoot =~ s/\/$//;
5176: }
5177:
5178: if($udom) {
5179: if($uname) {
5180: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
5181: homeserver($uname,$udom));
5182: my @listing_results;
5183: if ($listing eq 'unknown_cmd') {
5184: $listing=reply('ls:'.$dirRoot.'/'.$uri,
5185: homeserver($uname,$udom));
5186: @listing_results = split(/:/,$listing);
5187: } else {
5188: @listing_results = map { &unescape($_); } split(/:/,$listing);
5189: }
5190: return @listing_results;
5191: } elsif(!defined($alternateDirectoryRoot)) {
5192: my $tryserver;
5193: my %allusers=();
5194: foreach $tryserver (keys %libserv) {
5195: if($hostdom{$tryserver} eq $udom) {
5196: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5197: $udom, $tryserver);
5198: my @listing_results;
5199: if ($listing eq 'unknown_cmd') {
5200: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5201: $udom, $tryserver);
5202: @listing_results = split(/:/,$listing);
5203: } else {
5204: @listing_results =
5205: map { &unescape($_); } split(/:/,$listing);
5206: }
5207: if ($listing_results[0] ne 'no_such_dir' &&
5208: $listing_results[0] ne 'empty' &&
5209: $listing_results[0] ne 'con_lost') {
5210: foreach (@listing_results) {
5211: my ($entry,@stat)=split(/&/,$_);
5212: $allusers{$entry}=1;
5213: }
5214: }
5215: }
5216: }
5217: my $alluserstr='';
5218: foreach (sort keys %allusers) {
5219: $alluserstr.=$_.'&user:';
5220: }
5221: $alluserstr=~s/:$//;
5222: return split(/:/,$alluserstr);
5223: } else {
5224: my @emptyResults = ();
5225: push(@emptyResults, 'missing user name');
5226: return split(':',@emptyResults);
5227: }
5228: } elsif(!defined($alternateDirectoryRoot)) {
5229: my $tryserver;
5230: my %alldom=();
5231: foreach $tryserver (keys %libserv) {
5232: $alldom{$hostdom{$tryserver}}=1;
5233: }
5234: my $alldomstr='';
5235: foreach (sort keys %alldom) {
5236: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
5237: }
5238: $alldomstr=~s/:$//;
5239: return split(/:/,$alldomstr);
5240: } else {
5241: my @emptyResults = ();
5242: push(@emptyResults, 'missing domain');
5243: return split(':',@emptyResults);
5244: }
5245: }
5246:
5247: # --------------------------------------------- GetFileTimestamp
5248: # This function utilizes dirlist and returns the date stamp for
5249: # when it was last modified. It will also return an error of -1
5250: # if an error occurs
5251:
5252: ##
5253: ## FIXME: This subroutine assumes its caller knows something about the
5254: ## directory structure of the home server for the student ($root).
5255: ## Not a good assumption to make. Since this is for looking up files
5256: ## in user directories, the full path should be constructed by lond, not
5257: ## whatever machine we request data from.
5258: ##
5259: sub GetFileTimestamp {
5260: my ($studentDomain,$studentName,$filename,$root)=@_;
5261: $studentDomain=~s/\W//g;
5262: $studentName=~s/\W//g;
5263: my $subdir=$studentName.'__';
5264: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5265: my $proname="$studentDomain/$subdir/$studentName";
5266: $proname .= '/'.$filename;
5267: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5268: $studentName, $root);
5269: my @stats = split('&', $fileStat);
5270: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5271: # @stats contains first the filename, then the stat output
5272: return $stats[10]; # so this is 10 instead of 9.
5273: } else {
5274: return -1;
5275: }
5276: }
5277:
5278: sub stat_file {
5279: my ($uri) = @_;
5280: $uri = &clutter($uri);
5281:
5282: # we want just the url part without the unneeded accessor url bits
5283: if ($uri =~ m-^/adm/-) {
5284: $uri=~s-^/adm/wrapper/-/-;
5285: $uri=~s-^/adm/coursedocs/showdoc/-/-;
5286: }
5287: my ($udom,$uname,$file,$dir);
5288: if ($uri =~ m-^/(uploaded|editupload)/-) {
5289: ($udom,$uname,$file) =
5290: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5291: $file = 'userfiles/'.$file;
5292: $dir = &propath($udom,$uname);
5293: }
5294: if ($uri =~ m-^/res/-) {
5295: ($udom,$uname) =
5296: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5297: $file = $uri;
5298: }
5299:
5300: if (!$udom || !$uname || !$file) {
5301: # unable to handle the uri
5302: return ();
5303: }
5304:
5305: my ($result) = &dirlist($file,$udom,$uname,$dir);
5306: my @stats = split('&', $result);
5307:
5308: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5309: shift(@stats); #filename is first
5310: return @stats;
5311: }
5312: return ();
5313: }
5314:
5315: # -------------------------------------------------------- Value of a Condition
5316:
5317: # gets the value of a specific preevaluated condition
5318: # stored in the string $env{user.state.<cid>}
5319: # or looks up a condition reference in the bighash and if if hasn't
5320: # already been evaluated recurses into docondval to get the value of
5321: # the condition, then memoizing it to
5322: # $env{user.state.<cid>.<condition>}
5323: sub directcondval {
5324: my $number=shift;
5325: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5326: &Apache::lonuserstate::evalstate();
5327: }
5328: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5329: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5330: } elsif ($number =~ /^_/) {
5331: my $sub_condition;
5332: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5333: &GDBM_READER(),0640)) {
5334: $sub_condition=$bighash{'conditions'.$number};
5335: untie(%bighash);
5336: }
5337: my $value = &docondval($sub_condition);
5338: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5339: return $value;
5340: }
5341: if ($env{'user.state.'.$env{'request.course.id'}}) {
5342: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5343: } else {
5344: return 2;
5345: }
5346: }
5347:
5348: # get the collection of conditions for this resource
5349: sub condval {
5350: my $condidx=shift;
5351: my $allpathcond='';
5352: foreach my $cond (split(/\|/,$condidx)) {
5353: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5354: $allpathcond.=
5355: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5356: }
5357: }
5358: $allpathcond=~s/\|$//;
5359: return &docondval($allpathcond);
5360: }
5361:
5362: #evaluates an expression of conditions
5363: sub docondval {
5364: my ($allpathcond) = @_;
5365: my $result=0;
5366: if ($env{'request.course.id'}
5367: && defined($allpathcond)) {
5368: my $operand='|';
5369: my @stack;
5370: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5371: if ($chunk eq '(') {
5372: push @stack,($operand,$result);
5373: } elsif ($chunk eq ')') {
5374: my $before=pop @stack;
5375: if (pop @stack eq '&') {
5376: $result=$result>$before?$before:$result;
5377: } else {
5378: $result=$result>$before?$result:$before;
5379: }
5380: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5381: $operand=$chunk;
5382: } else {
5383: my $new=directcondval($chunk);
5384: if ($operand eq '&') {
5385: $result=$result>$new?$new:$result;
5386: } else {
5387: $result=$result>$new?$result:$new;
5388: }
5389: }
5390: }
5391: }
5392: return $result;
5393: }
5394:
5395: # ---------------------------------------------------- Devalidate courseresdata
5396:
5397: sub devalidatecourseresdata {
5398: my ($coursenum,$coursedomain)=@_;
5399: my $hashid=$coursenum.':'.$coursedomain;
5400: &devalidate_cache_new('courseres',$hashid);
5401: }
5402:
5403:
5404: # --------------------------------------------------- Course Resourcedata Query
5405:
5406: sub get_courseresdata {
5407: my ($coursenum,$coursedomain)=@_;
5408: my $coursehom=&homeserver($coursenum,$coursedomain);
5409: my $hashid=$coursenum.':'.$coursedomain;
5410: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5411: my %dumpreply;
5412: unless (defined($cached)) {
5413: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5414: $result=\%dumpreply;
5415: my ($tmp) = keys(%dumpreply);
5416: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5417: &do_cache_new('courseres',$hashid,$result,600);
5418: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5419: return $tmp;
5420: } elsif ($tmp =~ /^(error)/) {
5421: $result=undef;
5422: &do_cache_new('courseres',$hashid,$result,600);
5423: }
5424: }
5425: return $result;
5426: }
5427:
5428: sub devalidateuserresdata {
5429: my ($uname,$udom)=@_;
5430: my $hashid="$udom:$uname";
5431: &devalidate_cache_new('userres',$hashid);
5432: }
5433:
5434: sub get_userresdata {
5435: my ($uname,$udom)=@_;
5436: #most student don\'t have any data set, check if there is some data
5437: if (&EXT_cache_status($udom,$uname)) { return undef; }
5438:
5439: my $hashid="$udom:$uname";
5440: my ($result,$cached)=&is_cached_new('userres',$hashid);
5441: if (!defined($cached)) {
5442: my %resourcedata=&dump('resourcedata',$udom,$uname);
5443: $result=\%resourcedata;
5444: &do_cache_new('userres',$hashid,$result,600);
5445: }
5446: my ($tmp)=keys(%$result);
5447: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5448: return $result;
5449: }
5450: #error 2 occurs when the .db doesn't exist
5451: if ($tmp!~/error: 2 /) {
5452: &logthis("<font color=\"blue\">WARNING:".
5453: " Trying to get resource data for ".
5454: $uname." at ".$udom.": ".
5455: $tmp."</font>");
5456: } elsif ($tmp=~/error: 2 /) {
5457: #&EXT_cache_set($udom,$uname);
5458: &do_cache_new('userres',$hashid,undef,600);
5459: undef($tmp); # not really an error so don't send it back
5460: }
5461: return $tmp;
5462: }
5463:
5464: sub resdata {
5465: my ($name,$domain,$type,@which)=@_;
5466: my $result;
5467: if ($type eq 'course') {
5468: $result=&get_courseresdata($name,$domain);
5469: } elsif ($type eq 'user') {
5470: $result=&get_userresdata($name,$domain);
5471: }
5472: if (!ref($result)) { return $result; }
5473: foreach my $item (@which) {
5474: if (defined($result->{$item})) {
5475: return $result->{$item};
5476: }
5477: }
5478: return undef;
5479: }
5480:
5481: #
5482: # EXT resource caching routines
5483: #
5484:
5485: sub clear_EXT_cache_status {
5486: &delenv('cache.EXT.');
5487: }
5488:
5489: sub EXT_cache_status {
5490: my ($target_domain,$target_user) = @_;
5491: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5492: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5493: # We know already the user has no data
5494: return 1;
5495: } else {
5496: return 0;
5497: }
5498: }
5499:
5500: sub EXT_cache_set {
5501: my ($target_domain,$target_user) = @_;
5502: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5503: #&appenv($cachename => time);
5504: }
5505:
5506: # --------------------------------------------------------- Value of a Variable
5507: sub EXT {
5508:
5509: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5510: unless ($varname) { return ''; }
5511: #get real user name/domain, courseid and symb
5512: my $courseid;
5513: my $publicuser;
5514: if ($symbparm) {
5515: $symbparm=&get_symb_from_alias($symbparm);
5516: }
5517: if (!($uname && $udom)) {
5518: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
5519: &Apache::lonxml::whichuser($symbparm);
5520: if (!$symbparm) { $symbparm=$cursymb; }
5521: } else {
5522: $courseid=$env{'request.course.id'};
5523: }
5524: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5525: my $rest;
5526: if (defined($therest[0])) {
5527: $rest=join('.',@therest);
5528: } else {
5529: $rest='';
5530: }
5531:
5532: my $qualifierrest=$qualifier;
5533: if ($rest) { $qualifierrest.='.'.$rest; }
5534: my $spacequalifierrest=$space;
5535: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5536: if ($realm eq 'user') {
5537: # --------------------------------------------------------------- user.resource
5538: if ($space eq 'resource') {
5539: if ( (defined($Apache::lonhomework::parsing_a_problem)
5540: || defined($Apache::lonhomework::parsing_a_task))
5541: &&
5542: ($symbparm eq &symbread()) ) {
5543: # if we are in the middle of processing the resource the
5544: # get the value we are planning on committing
5545: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5546: return $Apache::lonhomework::results{$qualifierrest};
5547: } else {
5548: return $Apache::lonhomework::history{$qualifierrest};
5549: }
5550: } else {
5551: my %restored;
5552: if ($publicuser || $env{'request.state'} eq 'construct') {
5553: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5554: } else {
5555: %restored=&restore($symbparm,$courseid,$udom,$uname);
5556: }
5557: return $restored{$qualifierrest};
5558: }
5559: # ----------------------------------------------------------------- user.access
5560: } elsif ($space eq 'access') {
5561: # FIXME - not supporting calls for a specific user
5562: return &allowed($qualifier,$rest);
5563: # ------------------------------------------ user.preferences, user.environment
5564: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5565: if (($uname eq $env{'user.name'}) &&
5566: ($udom eq $env{'user.domain'})) {
5567: return $env{join('.',('environment',$qualifierrest))};
5568: } else {
5569: my %returnhash;
5570: if (!$publicuser) {
5571: %returnhash=&userenvironment($udom,$uname,
5572: $qualifierrest);
5573: }
5574: return $returnhash{$qualifierrest};
5575: }
5576: # ----------------------------------------------------------------- user.course
5577: } elsif ($space eq 'course') {
5578: # FIXME - not supporting calls for a specific user
5579: return $env{join('.',('request.course',$qualifier))};
5580: # ------------------------------------------------------------------- user.role
5581: } elsif ($space eq 'role') {
5582: # FIXME - not supporting calls for a specific user
5583: my ($role,$where)=split(/\./,$env{'request.role'});
5584: if ($qualifier eq 'value') {
5585: return $role;
5586: } elsif ($qualifier eq 'extent') {
5587: return $where;
5588: }
5589: # ----------------------------------------------------------------- user.domain
5590: } elsif ($space eq 'domain') {
5591: return $udom;
5592: # ------------------------------------------------------------------- user.name
5593: } elsif ($space eq 'name') {
5594: return $uname;
5595: # ---------------------------------------------------- Any other user namespace
5596: } else {
5597: my %reply;
5598: if (!$publicuser) {
5599: %reply=&get($space,[$qualifierrest],$udom,$uname);
5600: }
5601: return $reply{$qualifierrest};
5602: }
5603: } elsif ($realm eq 'query') {
5604: # ---------------------------------------------- pull stuff out of query string
5605: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5606: [$spacequalifierrest]);
5607: return $env{'form.'.$spacequalifierrest};
5608: } elsif ($realm eq 'request') {
5609: # ------------------------------------------------------------- request.browser
5610: if ($space eq 'browser') {
5611: if ($qualifier eq 'textremote') {
5612: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5613: return 1;
5614: } else {
5615: return 0;
5616: }
5617: } else {
5618: return $env{'browser.'.$qualifier};
5619: }
5620: # ------------------------------------------------------------ request.filename
5621: } else {
5622: return $env{'request.'.$spacequalifierrest};
5623: }
5624: } elsif ($realm eq 'course') {
5625: # ---------------------------------------------------------- course.description
5626: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5627: } elsif ($realm eq 'resource') {
5628:
5629: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5630: if (!$symbparm) { $symbparm=&symbread(); }
5631: }
5632:
5633: if ($space eq 'title') {
5634: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5635: return &gettitle($symbparm);
5636: }
5637:
5638: if ($space eq 'map') {
5639: my ($map) = &decode_symb($symbparm);
5640: return &symbread($map);
5641: }
5642:
5643: my ($section, $group, @groups);
5644: my ($courselevelm,$courselevel);
5645: if ($symbparm && defined($courseid) &&
5646: $courseid eq $env{'request.course.id'}) {
5647:
5648: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5649:
5650: # ----------------------------------------------------- Cascading lookup scheme
5651: my $symbp=$symbparm;
5652: my $mapp=&deversion((&decode_symb($symbp))[0]);
5653:
5654: my $symbparm=$symbp.'.'.$spacequalifierrest;
5655: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5656:
5657: if (($env{'user.name'} eq $uname) &&
5658: ($env{'user.domain'} eq $udom)) {
5659: $section=$env{'request.course.sec'};
5660: @groups = split(/:/,$env{'request.course.groups'});
5661: @groups=&sort_course_groups($courseid,@groups);
5662: } else {
5663: if (! defined($usection)) {
5664: $section=&getsection($udom,$uname,$courseid);
5665: } else {
5666: $section = $usection;
5667: }
5668: @groups = &get_users_groups($udom,$uname,$courseid);
5669: }
5670:
5671: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5672: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5673: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5674:
5675: $courselevel=$courseid.'.'.$spacequalifierrest;
5676: my $courselevelr=$courseid.'.'.$symbparm;
5677: $courselevelm=$courseid.'.'.$mapparm;
5678:
5679: # ----------------------------------------------------------- first, check user
5680:
5681: my $userreply=&resdata($uname,$udom,'user',
5682: ($courselevelr,$courselevelm,
5683: $courselevel));
5684: if (defined($userreply)) { return $userreply; }
5685:
5686: # ------------------------------------------------ second, check some of course
5687: my $coursereply;
5688: if (@groups > 0) {
5689: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5690: $mapparm,$spacequalifierrest);
5691: if (defined($coursereply)) { return $coursereply; }
5692: }
5693:
5694: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5695: $env{'course.'.$courseid.'.domain'},
5696: 'course',
5697: ($seclevelr,$seclevelm,$seclevel,
5698: $courselevelr));
5699: if (defined($coursereply)) { return $coursereply; }
5700:
5701: # ------------------------------------------------------ third, check map parms
5702: my %parmhash=();
5703: my $thisparm='';
5704: if (tie(%parmhash,'GDBM_File',
5705: $env{'request.course.fn'}.'_parms.db',
5706: &GDBM_READER(),0640)) {
5707: $thisparm=$parmhash{$symbparm};
5708: untie(%parmhash);
5709: }
5710: if ($thisparm) { return $thisparm; }
5711: }
5712: # ------------------------------------------ fourth, look in resource metadata
5713:
5714: $spacequalifierrest=~s/\./\_/;
5715: my $filename;
5716: if (!$symbparm) { $symbparm=&symbread(); }
5717: if ($symbparm) {
5718: $filename=(&decode_symb($symbparm))[2];
5719: } else {
5720: $filename=$env{'request.filename'};
5721: }
5722: my $metadata=&metadata($filename,$spacequalifierrest);
5723: if (defined($metadata)) { return $metadata; }
5724: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5725: if (defined($metadata)) { return $metadata; }
5726:
5727: # ---------------------------------------------- fourth, look in rest pf course
5728: if ($symbparm && defined($courseid) &&
5729: $courseid eq $env{'request.course.id'}) {
5730: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5731: $env{'course.'.$courseid.'.domain'},
5732: 'course',
5733: ($courselevelm,$courselevel));
5734: if (defined($coursereply)) { return $coursereply; }
5735: }
5736: # ------------------------------------------------------------------ Cascade up
5737: unless ($space eq '0') {
5738: my @parts=split(/_/,$space);
5739: my $id=pop(@parts);
5740: my $part=join('_',@parts);
5741: if ($part eq '') { $part='0'; }
5742: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5743: $symbparm,$udom,$uname,$section,1);
5744: if (defined($partgeneral)) { return $partgeneral; }
5745: }
5746: if ($recurse) { return undef; }
5747: my $pack_def=&packages_tab_default($filename,$varname);
5748: if (defined($pack_def)) { return $pack_def; }
5749:
5750: # ---------------------------------------------------- Any other user namespace
5751: } elsif ($realm eq 'environment') {
5752: # ----------------------------------------------------------------- environment
5753: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5754: return $env{'environment.'.$spacequalifierrest};
5755: } else {
5756: if ($uname eq 'anonymous' && $udom eq '') {
5757: return '';
5758: }
5759: my %returnhash=&userenvironment($udom,$uname,
5760: $spacequalifierrest);
5761: return $returnhash{$spacequalifierrest};
5762: }
5763: } elsif ($realm eq 'system') {
5764: # ----------------------------------------------------------------- system.time
5765: if ($space eq 'time') {
5766: return time;
5767: }
5768: } elsif ($realm eq 'server') {
5769: # ----------------------------------------------------------------- system.time
5770: if ($space eq 'name') {
5771: return $ENV{'SERVER_NAME'};
5772: }
5773: }
5774: return '';
5775: }
5776:
5777: sub check_group_parms {
5778: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5779: my @groupitems = ();
5780: my $resultitem;
5781: my @levels = ($symbparm,$mapparm,$what);
5782: foreach my $group (@{$groups}) {
5783: foreach my $level (@levels) {
5784: my $item = $courseid.'.['.$group.'].'.$level;
5785: push(@groupitems,$item);
5786: }
5787: }
5788: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5789: $env{'course.'.$courseid.'.domain'},
5790: 'course',@groupitems);
5791: return $coursereply;
5792: }
5793:
5794: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5795: my ($courseid,@groups) = @_;
5796: @groups = sort(@groups);
5797: return @groups;
5798: }
5799:
5800: sub packages_tab_default {
5801: my ($uri,$varname)=@_;
5802: my (undef,$part,$name)=split(/\./,$varname);
5803:
5804: my (@extension,@specifics,$do_default);
5805: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5806: my ($pack_type,$pack_part)=split(/_/,$package,2);
5807: if ($pack_type eq 'default') {
5808: $do_default=1;
5809: } elsif ($pack_type eq 'extension') {
5810: push(@extension,[$package,$pack_type,$pack_part]);
5811: } else {
5812: push(@specifics,[$package,$pack_type,$pack_part]);
5813: }
5814: }
5815: # first look for a package that matches the requested part id
5816: foreach my $package (@specifics) {
5817: my (undef,$pack_type,$pack_part)=@{$package};
5818: next if ($pack_part ne $part);
5819: if (defined($packagetab{"$pack_type&$name&default"})) {
5820: return $packagetab{"$pack_type&$name&default"};
5821: }
5822: }
5823: # look for any possible matching non extension_ package
5824: foreach my $package (@specifics) {
5825: my (undef,$pack_type,$pack_part)=@{$package};
5826: if (defined($packagetab{"$pack_type&$name&default"})) {
5827: return $packagetab{"$pack_type&$name&default"};
5828: }
5829: if ($pack_type eq 'part') { $pack_part='0'; }
5830: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5831: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5832: }
5833: }
5834: # look for any posible extension_ match
5835: foreach my $package (@extension) {
5836: my ($package,$pack_type)=@{$package};
5837: if (defined($packagetab{"$pack_type&$name&default"})) {
5838: return $packagetab{"$pack_type&$name&default"};
5839: }
5840: if (defined($packagetab{$package."&$name&default"})) {
5841: return $packagetab{$package."&$name&default"};
5842: }
5843: }
5844: # look for a global default setting
5845: if ($do_default && defined($packagetab{"default&$name&default"})) {
5846: return $packagetab{"default&$name&default"};
5847: }
5848: return undef;
5849: }
5850:
5851: sub add_prefix_and_part {
5852: my ($prefix,$part)=@_;
5853: my $keyroot;
5854: if (defined($prefix) && $prefix !~ /^__/) {
5855: # prefix that has a part already
5856: $keyroot=$prefix;
5857: } elsif (defined($prefix)) {
5858: # prefix that is missing a part
5859: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5860: } else {
5861: # no prefix at all
5862: if (defined($part)) { $keyroot='_'.$part; }
5863: }
5864: return $keyroot;
5865: }
5866:
5867: # ---------------------------------------------------------------- Get metadata
5868:
5869: my %metaentry;
5870: sub metadata {
5871: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
5872: $uri=&declutter($uri);
5873: # if it is a non metadata possible uri return quickly
5874: if (($uri eq '') ||
5875: (($uri =~ m|^/*adm/|) &&
5876: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
5877: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
5878: ($uri =~ m|home/[^/]+/public_html/|)) {
5879: return undef;
5880: }
5881: my $filename=$uri;
5882: $uri=~s/\.meta$//;
5883: #
5884: # Is the metadata already cached?
5885: # Look at timestamp of caching
5886: # Everything is cached by the main uri, libraries are never directly cached
5887: #
5888: if (!defined($liburi)) {
5889: my ($result,$cached)=&is_cached_new('meta',$uri);
5890: if (defined($cached)) { return $result->{':'.$what}; }
5891: }
5892: {
5893: #
5894: # Is this a recursive call for a library?
5895: #
5896: # if (! exists($metacache{$uri})) {
5897: # $metacache{$uri}={};
5898: # }
5899: if ($liburi) {
5900: $liburi=&declutter($liburi);
5901: $filename=$liburi;
5902: } else {
5903: &devalidate_cache_new('meta',$uri);
5904: undef(%metaentry);
5905: }
5906: my %metathesekeys=();
5907: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
5908: my $metastring;
5909: if ($uri !~ m -^(editupload)/-) {
5910: my $file=&filelocation('',&clutter($filename));
5911: #push(@{$metaentry{$uri.'.file'}},$file);
5912: $metastring=&getfile($file);
5913: }
5914: my $parser=HTML::LCParser->new(\$metastring);
5915: my $token;
5916: undef %metathesekeys;
5917: while ($token=$parser->get_token) {
5918: if ($token->[0] eq 'S') {
5919: if (defined($token->[2]->{'package'})) {
5920: #
5921: # This is a package - get package info
5922: #
5923: my $package=$token->[2]->{'package'};
5924: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5925: if (defined($token->[2]->{'id'})) {
5926: $keyroot.='_'.$token->[2]->{'id'};
5927: }
5928: if ($metaentry{':packages'}) {
5929: $metaentry{':packages'}.=','.$package.$keyroot;
5930: } else {
5931: $metaentry{':packages'}=$package.$keyroot;
5932: }
5933: foreach my $pack_entry (keys(%packagetab)) {
5934: my $part=$keyroot;
5935: $part=~s/^\_//;
5936: if ($pack_entry=~/^\Q$package\E\&/ ||
5937: $pack_entry=~/^\Q$package\E_0\&/) {
5938: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
5939: # ignore package.tab specified default values
5940: # here &package_tab_default() will fetch those
5941: if ($subp eq 'default') { next; }
5942: my $value=$packagetab{$pack_entry};
5943: my $unikey;
5944: if ($pack =~ /_0$/) {
5945: $unikey='parameter_0_'.$name;
5946: $part=0;
5947: } else {
5948: $unikey='parameter'.$keyroot.'_'.$name;
5949: }
5950: if ($subp eq 'display') {
5951: $value.=' [Part: '.$part.']';
5952: }
5953: $metaentry{':'.$unikey.'.part'}=$part;
5954: $metathesekeys{$unikey}=1;
5955: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5956: $metaentry{':'.$unikey.'.'.$subp}=$value;
5957: }
5958: if (defined($metaentry{':'.$unikey.'.default'})) {
5959: $metaentry{':'.$unikey}=
5960: $metaentry{':'.$unikey.'.default'};
5961: }
5962: }
5963: }
5964: } else {
5965: #
5966: # This is not a package - some other kind of start tag
5967: #
5968: my $entry=$token->[1];
5969: my $unikey;
5970: if ($entry eq 'import') {
5971: $unikey='';
5972: } else {
5973: $unikey=$entry;
5974: }
5975: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5976:
5977: if (defined($token->[2]->{'id'})) {
5978: $unikey.='_'.$token->[2]->{'id'};
5979: }
5980:
5981: if ($entry eq 'import') {
5982: #
5983: # Importing a library here
5984: #
5985: if ($depthcount<20) {
5986: my $location=$parser->get_text('/import');
5987: my $dir=$filename;
5988: $dir=~s|[^/]*$||;
5989: $location=&filelocation($dir,$location);
5990: my $metadata =
5991: &metadata($uri,'keys', $location,$unikey,
5992: $depthcount+1);
5993: foreach my $meta (split(',',$metadata)) {
5994: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5995: $metathesekeys{$meta}=1;
5996: }
5997: }
5998: } else {
5999:
6000: if (defined($token->[2]->{'name'})) {
6001: $unikey.='_'.$token->[2]->{'name'};
6002: }
6003: $metathesekeys{$unikey}=1;
6004: foreach my $param (@{$token->[3]}) {
6005: $metaentry{':'.$unikey.'.'.$param} =
6006: $token->[2]->{$param};
6007: }
6008: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6009: my $default=$metaentry{':'.$unikey.'.default'};
6010: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6011: # only ws inside the tag, and not in default, so use default
6012: # as value
6013: $metaentry{':'.$unikey}=$default;
6014: } else {
6015: # either something interesting inside the tag or default
6016: # uninteresting
6017: $metaentry{':'.$unikey}=$internaltext;
6018: }
6019: # end of not-a-package not-a-library import
6020: }
6021: # end of not-a-package start tag
6022: }
6023: # the next is the end of "start tag"
6024: }
6025: }
6026: my ($extension) = ($uri =~ /\.(\w+)$/);
6027: foreach my $key (keys(%packagetab)) {
6028: #no specific packages #how's our extension
6029: if ($key!~/^extension_\Q$extension\E&/) { next; }
6030: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6031: \%metathesekeys);
6032: }
6033: if (!exists($metaentry{':packages'})) {
6034: foreach my $key (keys(%packagetab)) {
6035: #no specific packages well let's get default then
6036: if ($key!~/^default&/) { next; }
6037: &metadata_create_package_def($uri,$key,'default',
6038: \%metathesekeys);
6039: }
6040: }
6041: # are there custom rights to evaluate
6042: if ($metaentry{':copyright'} eq 'custom') {
6043:
6044: #
6045: # Importing a rights file here
6046: #
6047: unless ($depthcount) {
6048: my $location=$metaentry{':customdistributionfile'};
6049: my $dir=$filename;
6050: $dir=~s|[^/]*$||;
6051: $location=&filelocation($dir,$location);
6052: my $rights_metadata =
6053: &metadata($uri,'keys',$location,'_rights',
6054: $depthcount+1);
6055: foreach my $rights (split(',',$rights_metadata)) {
6056: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6057: $metathesekeys{$rights}=1;
6058: }
6059: }
6060: }
6061: # uniqifiy package listing
6062: my %seen;
6063: my @uniq_packages =
6064: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6065: $metaentry{':packages'} = join(',',@uniq_packages);
6066:
6067: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6068: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6069: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6070: &do_cache_new('meta',$uri,\%metaentry,60*60);
6071: # this is the end of "was not already recently cached
6072: }
6073: return $metaentry{':'.$what};
6074: }
6075:
6076: sub metadata_create_package_def {
6077: my ($uri,$key,$package,$metathesekeys)=@_;
6078: my ($pack,$name,$subp)=split(/\&/,$key);
6079: if ($subp eq 'default') { next; }
6080:
6081: if (defined($metaentry{':packages'})) {
6082: $metaentry{':packages'}.=','.$package;
6083: } else {
6084: $metaentry{':packages'}=$package;
6085: }
6086: my $value=$packagetab{$key};
6087: my $unikey;
6088: $unikey='parameter_0_'.$name;
6089: $metaentry{':'.$unikey.'.part'}=0;
6090: $$metathesekeys{$unikey}=1;
6091: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6092: $metaentry{':'.$unikey.'.'.$subp}=$value;
6093: }
6094: if (defined($metaentry{':'.$unikey.'.default'})) {
6095: $metaentry{':'.$unikey}=
6096: $metaentry{':'.$unikey.'.default'};
6097: }
6098: }
6099:
6100: sub metadata_generate_part0 {
6101: my ($metadata,$metacache,$uri) = @_;
6102: my %allnames;
6103: foreach my $metakey (keys(%$metadata)) {
6104: if ($metakey=~/^parameter\_(.*)/) {
6105: my $part=$$metacache{':'.$metakey.'.part'};
6106: my $name=$$metacache{':'.$metakey.'.name'};
6107: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6108: $allnames{$name}=$part;
6109: }
6110: }
6111: }
6112: foreach my $name (keys(%allnames)) {
6113: $$metadata{"parameter_0_$name"}=1;
6114: my $key=":parameter_0_$name";
6115: $$metacache{"$key.part"}='0';
6116: $$metacache{"$key.name"}=$name;
6117: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6118: $allnames{$name}.'_'.$name.
6119: '.type'};
6120: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6121: '.display'};
6122: my $expr='[Part: '.$allnames{$name}.']';
6123: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6124: $$metacache{"$key.display"}=$olddis;
6125: }
6126: }
6127:
6128: # ------------------------------------------------------ Devalidate title cache
6129:
6130: sub devalidate_title_cache {
6131: my ($url)=@_;
6132: if (!$env{'request.course.id'}) { return; }
6133: my $symb=&symbread($url);
6134: if (!$symb) { return; }
6135: my $key=$env{'request.course.id'}."\0".$symb;
6136: &devalidate_cache_new('title',$key);
6137: }
6138:
6139: # ------------------------------------------------- Get the title of a resource
6140:
6141: sub gettitle {
6142: my $urlsymb=shift;
6143: my $symb=&symbread($urlsymb);
6144: if ($symb) {
6145: my $key=$env{'request.course.id'}."\0".$symb;
6146: my ($result,$cached)=&is_cached_new('title',$key);
6147: if (defined($cached)) {
6148: return $result;
6149: }
6150: my ($map,$resid,$url)=&decode_symb($symb);
6151: my $title='';
6152: my %bighash;
6153: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6154: &GDBM_READER(),0640)) {
6155: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6156: $title=$bighash{'title_'.$mapid.'.'.$resid};
6157: untie %bighash;
6158: }
6159: $title=~s/\&colon\;/\:/gs;
6160: if ($title) {
6161: return &do_cache_new('title',$key,$title,600);
6162: }
6163: $urlsymb=$url;
6164: }
6165: my $title=&metadata($urlsymb,'title');
6166: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6167: return $title;
6168: }
6169:
6170: sub get_slot {
6171: my ($which,$cnum,$cdom)=@_;
6172: if (!$cnum || !$cdom) {
6173: (undef,my $courseid)=&Apache::lonxml::whichuser();
6174: $cdom=$env{'course.'.$courseid.'.domain'};
6175: $cnum=$env{'course.'.$courseid.'.num'};
6176: }
6177: my $key=join("\0",'slots',$cdom,$cnum,$which);
6178: my %slotinfo;
6179: if (exists($remembered{$key})) {
6180: $slotinfo{$which} = $remembered{$key};
6181: } else {
6182: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6183: &Apache::lonhomework::showhash(%slotinfo);
6184: my ($tmp)=keys(%slotinfo);
6185: if ($tmp=~/^error:/) { return (); }
6186: $remembered{$key} = $slotinfo{$which};
6187: }
6188: if (ref($slotinfo{$which}) eq 'HASH') {
6189: return %{$slotinfo{$which}};
6190: }
6191: return $slotinfo{$which};
6192: }
6193: # ------------------------------------------------- Update symbolic store links
6194:
6195: sub symblist {
6196: my ($mapname,%newhash)=@_;
6197: $mapname=&deversion(&declutter($mapname));
6198: my %hash;
6199: if (($env{'request.course.fn'}) && (%newhash)) {
6200: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6201: &GDBM_WRCREAT(),0640)) {
6202: foreach my $url (keys %newhash) {
6203: next if ($url eq 'last_known'
6204: && $env{'form.no_update_last_known'});
6205: $hash{declutter($url)}=&encode_symb($mapname,
6206: $newhash{$url}->[1],
6207: $newhash{$url}->[0]);
6208: }
6209: if (untie(%hash)) {
6210: return 'ok';
6211: }
6212: }
6213: }
6214: return 'error';
6215: }
6216:
6217: # --------------------------------------------------------------- Verify a symb
6218:
6219: sub symbverify {
6220: my ($symb,$thisurl)=@_;
6221: my $thisfn=$thisurl;
6222: # wrapper not part of symbs
6223: $thisfn=~s/^\/adm\/wrapper//;
6224: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
6225: $thisfn=&declutter($thisfn);
6226: # direct jump to resource in page or to a sequence - will construct own symbs
6227: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6228: # check URL part
6229: my ($map,$resid,$url)=&decode_symb($symb);
6230:
6231: unless ($url eq $thisfn) { return 0; }
6232:
6233: $symb=&symbclean($symb);
6234: $thisurl=&deversion($thisurl);
6235: $thisfn=&deversion($thisfn);
6236:
6237: my %bighash;
6238: my $okay=0;
6239:
6240: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6241: &GDBM_READER(),0640)) {
6242: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6243: unless ($ids) {
6244: $ids=$bighash{'ids_/'.$thisurl};
6245: }
6246: if ($ids) {
6247: # ------------------------------------------------------------------- Has ID(s)
6248: foreach (split(/\,/,$ids)) {
6249: my ($mapid,$resid)=split(/\./,$_);
6250: if (
6251: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6252: eq $symb) {
6253: if (($env{'request.role.adv'}) ||
6254: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
6255: $okay=1;
6256: }
6257: }
6258: }
6259: }
6260: untie(%bighash);
6261: }
6262: return $okay;
6263: }
6264:
6265: # --------------------------------------------------------------- Clean-up symb
6266:
6267: sub symbclean {
6268: my $symb=shift;
6269: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6270: # remove version from map
6271: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6272:
6273: # remove version from URL
6274: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6275:
6276: # remove wrapper
6277:
6278: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6279: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6280: return $symb;
6281: }
6282:
6283: # ---------------------------------------------- Split symb to find map and url
6284:
6285: sub encode_symb {
6286: my ($map,$resid,$url)=@_;
6287: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6288: }
6289:
6290: sub decode_symb {
6291: my $symb=shift;
6292: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6293: my ($map,$resid,$url)=split(/___/,$symb);
6294: return (&fixversion($map),$resid,&fixversion($url));
6295: }
6296:
6297: sub fixversion {
6298: my $fn=shift;
6299: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6300: my %bighash;
6301: my $uri=&clutter($fn);
6302: my $key=$env{'request.course.id'}.'_'.$uri;
6303: # is this cached?
6304: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6305: if (defined($cached)) { return $result; }
6306: # unfortunately not cached, or expired
6307: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6308: &GDBM_READER(),0640)) {
6309: if ($bighash{'version_'.$uri}) {
6310: my $version=$bighash{'version_'.$uri};
6311: unless (($version eq 'mostrecent') ||
6312: ($version==&getversion($uri))) {
6313: $uri=~s/\.(\w+)$/\.$version\.$1/;
6314: }
6315: }
6316: untie %bighash;
6317: }
6318: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6319: }
6320:
6321: sub deversion {
6322: my $url=shift;
6323: $url=~s/\.\d+\.(\w+)$/\.$1/;
6324: return $url;
6325: }
6326:
6327: # ------------------------------------------------------ Return symb list entry
6328:
6329: sub symbread {
6330: my ($thisfn,$donotrecurse)=@_;
6331: my $cache_str='request.symbread.cached.'.$thisfn;
6332: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6333: # no filename provided? try from environment
6334: unless ($thisfn) {
6335: if ($env{'request.symb'}) {
6336: return $env{$cache_str}=&symbclean($env{'request.symb'});
6337: }
6338: $thisfn=$env{'request.filename'};
6339: }
6340: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6341: # is that filename actually a symb? Verify, clean, and return
6342: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6343: if (&symbverify($thisfn,$1)) {
6344: return $env{$cache_str}=&symbclean($thisfn);
6345: }
6346: }
6347: $thisfn=declutter($thisfn);
6348: my %hash;
6349: my %bighash;
6350: my $syval='';
6351: if (($env{'request.course.fn'}) && ($thisfn)) {
6352: my $targetfn = $thisfn;
6353: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6354: $targetfn = 'adm/wrapper/'.$thisfn;
6355: }
6356: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6357: $targetfn=$1;
6358: }
6359: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6360: &GDBM_READER(),0640)) {
6361: $syval=$hash{$targetfn};
6362: untie(%hash);
6363: }
6364: # ---------------------------------------------------------- There was an entry
6365: if ($syval) {
6366: #unless ($syval=~/\_\d+$/) {
6367: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6368: #&appenv('request.ambiguous' => $thisfn);
6369: #return $env{$cache_str}='';
6370: #}
6371: #$syval.=$1;
6372: #}
6373: } else {
6374: # ------------------------------------------------------- Was not in symb table
6375: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6376: &GDBM_READER(),0640)) {
6377: # ---------------------------------------------- Get ID(s) for current resource
6378: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6379: unless ($ids) {
6380: $ids=$bighash{'ids_/'.$thisfn};
6381: }
6382: unless ($ids) {
6383: # alias?
6384: $ids=$bighash{'mapalias_'.$thisfn};
6385: }
6386: if ($ids) {
6387: # ------------------------------------------------------------------- Has ID(s)
6388: my @possibilities=split(/\,/,$ids);
6389: if ($#possibilities==0) {
6390: # ----------------------------------------------- There is only one possibility
6391: my ($mapid,$resid)=split(/\./,$ids);
6392: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6393: $resid,$thisfn);
6394: } elsif (!$donotrecurse) {
6395: # ------------------------------------------ There is more than one possibility
6396: my $realpossible=0;
6397: foreach (@possibilities) {
6398: my $file=$bighash{'src_'.$_};
6399: if (&allowed('bre',$file)) {
6400: my ($mapid,$resid)=split(/\./,$_);
6401: if ($bighash{'map_type_'.$mapid} ne 'page') {
6402: $realpossible++;
6403: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6404: $resid,$thisfn);
6405: }
6406: }
6407: }
6408: if ($realpossible!=1) { $syval=''; }
6409: } else {
6410: $syval='';
6411: }
6412: }
6413: untie(%bighash)
6414: }
6415: }
6416: if ($syval) {
6417: return $env{$cache_str}=$syval;
6418: }
6419: }
6420: &appenv('request.ambiguous' => $thisfn);
6421: return $env{$cache_str}='';
6422: }
6423:
6424: # ---------------------------------------------------------- Return random seed
6425:
6426: sub numval {
6427: my $txt=shift;
6428: $txt=~tr/A-J/0-9/;
6429: $txt=~tr/a-j/0-9/;
6430: $txt=~tr/K-T/0-9/;
6431: $txt=~tr/k-t/0-9/;
6432: $txt=~tr/U-Z/0-5/;
6433: $txt=~tr/u-z/0-5/;
6434: $txt=~s/\D//g;
6435: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6436: return int($txt);
6437: }
6438:
6439: sub numval2 {
6440: my $txt=shift;
6441: $txt=~tr/A-J/0-9/;
6442: $txt=~tr/a-j/0-9/;
6443: $txt=~tr/K-T/0-9/;
6444: $txt=~tr/k-t/0-9/;
6445: $txt=~tr/U-Z/0-5/;
6446: $txt=~tr/u-z/0-5/;
6447: $txt=~s/\D//g;
6448: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6449: my $total;
6450: foreach my $val (@txts) { $total+=$val; }
6451: if ($_64bit) { if ($total > 2**32) { return -1; } }
6452: return int($total);
6453: }
6454:
6455: sub numval3 {
6456: use integer;
6457: my $txt=shift;
6458: $txt=~tr/A-J/0-9/;
6459: $txt=~tr/a-j/0-9/;
6460: $txt=~tr/K-T/0-9/;
6461: $txt=~tr/k-t/0-9/;
6462: $txt=~tr/U-Z/0-5/;
6463: $txt=~tr/u-z/0-5/;
6464: $txt=~s/\D//g;
6465: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6466: my $total;
6467: foreach my $val (@txts) { $total+=$val; }
6468: if ($_64bit) { $total=(($total<<32)>>32); }
6469: return $total;
6470: }
6471:
6472: sub digest {
6473: my ($data)=@_;
6474: my $digest=&Digest::MD5::md5($data);
6475: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6476: my ($e,$f);
6477: {
6478: use integer;
6479: $e=($a+$b);
6480: $f=($c+$d);
6481: if ($_64bit) {
6482: $e=(($e<<32)>>32);
6483: $f=(($f<<32)>>32);
6484: }
6485: }
6486: if (wantarray) {
6487: return ($e,$f);
6488: } else {
6489: my $g;
6490: {
6491: use integer;
6492: $g=($e+$f);
6493: if ($_64bit) {
6494: $g=(($g<<32)>>32);
6495: }
6496: }
6497: return $g;
6498: }
6499: }
6500:
6501: sub latest_rnd_algorithm_id {
6502: return '64bit5';
6503: }
6504:
6505: sub get_rand_alg {
6506: my ($courseid)=@_;
6507: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6508: if ($courseid) {
6509: return $env{"course.$courseid.rndseed"};
6510: }
6511: return &latest_rnd_algorithm_id();
6512: }
6513:
6514: sub validCODE {
6515: my ($CODE)=@_;
6516: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6517: return 0;
6518: }
6519:
6520: sub getCODE {
6521: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6522: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6523: defined($Apache::lonhomework::parsing_a_task) ) &&
6524: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6525: return $Apache::lonhomework::history{'resource.CODE'};
6526: }
6527: return undef;
6528: }
6529:
6530: sub rndseed {
6531: my ($symb,$courseid,$domain,$username)=@_;
6532:
6533: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
6534: if (!$symb) {
6535: unless ($symb=$wsymb) { return time; }
6536: }
6537: if (!$courseid) { $courseid=$wcourseid; }
6538: if (!$domain) { $domain=$wdomain; }
6539: if (!$username) { $username=$wusername }
6540: my $which=&get_rand_alg();
6541: if (defined(&getCODE())) {
6542: if ($which eq '64bit5') {
6543: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6544: } elsif ($which eq '64bit4') {
6545: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6546: } else {
6547: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6548: }
6549: } elsif ($which eq '64bit5') {
6550: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6551: } elsif ($which eq '64bit4') {
6552: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6553: } elsif ($which eq '64bit3') {
6554: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6555: } elsif ($which eq '64bit2') {
6556: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6557: } elsif ($which eq '64bit') {
6558: return &rndseed_64bit($symb,$courseid,$domain,$username);
6559: }
6560: return &rndseed_32bit($symb,$courseid,$domain,$username);
6561: }
6562:
6563: sub rndseed_32bit {
6564: my ($symb,$courseid,$domain,$username)=@_;
6565: {
6566: use integer;
6567: my $symbchck=unpack("%32C*",$symb) << 27;
6568: my $symbseed=numval($symb) << 22;
6569: my $namechck=unpack("%32C*",$username) << 17;
6570: my $nameseed=numval($username) << 12;
6571: my $domainseed=unpack("%32C*",$domain) << 7;
6572: my $courseseed=unpack("%32C*",$courseid);
6573: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6574: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6575: #&Apache::lonxml::debug("rndseed :$num:$symb");
6576: if ($_64bit) { $num=(($num<<32)>>32); }
6577: return $num;
6578: }
6579: }
6580:
6581: sub rndseed_64bit {
6582: my ($symb,$courseid,$domain,$username)=@_;
6583: {
6584: use integer;
6585: my $symbchck=unpack("%32S*",$symb) << 21;
6586: my $symbseed=numval($symb) << 10;
6587: my $namechck=unpack("%32S*",$username);
6588:
6589: my $nameseed=numval($username) << 21;
6590: my $domainseed=unpack("%32S*",$domain) << 10;
6591: my $courseseed=unpack("%32S*",$courseid);
6592:
6593: my $num1=$symbchck+$symbseed+$namechck;
6594: my $num2=$nameseed+$domainseed+$courseseed;
6595: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6596: #&Apache::lonxml::debug("rndseed :$num:$symb");
6597: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6598: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6599: return "$num1,$num2";
6600: }
6601: }
6602:
6603: sub rndseed_64bit2 {
6604: my ($symb,$courseid,$domain,$username)=@_;
6605: {
6606: use integer;
6607: # strings need to be an even # of cahracters long, it it is odd the
6608: # last characters gets thrown away
6609: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6610: my $symbseed=numval($symb) << 10;
6611: my $namechck=unpack("%32S*",$username.' ');
6612:
6613: my $nameseed=numval($username) << 21;
6614: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6615: my $courseseed=unpack("%32S*",$courseid.' ');
6616:
6617: my $num1=$symbchck+$symbseed+$namechck;
6618: my $num2=$nameseed+$domainseed+$courseseed;
6619: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6620: #&Apache::lonxml::debug("rndseed :$num:$symb");
6621: return "$num1,$num2";
6622: }
6623: }
6624:
6625: sub rndseed_64bit3 {
6626: my ($symb,$courseid,$domain,$username)=@_;
6627: {
6628: use integer;
6629: # strings need to be an even # of cahracters long, it it is odd the
6630: # last characters gets thrown away
6631: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6632: my $symbseed=numval2($symb) << 10;
6633: my $namechck=unpack("%32S*",$username.' ');
6634:
6635: my $nameseed=numval2($username) << 21;
6636: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6637: my $courseseed=unpack("%32S*",$courseid.' ');
6638:
6639: my $num1=$symbchck+$symbseed+$namechck;
6640: my $num2=$nameseed+$domainseed+$courseseed;
6641: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6642: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6643: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6644:
6645: return "$num1:$num2";
6646: }
6647: }
6648:
6649: sub rndseed_64bit4 {
6650: my ($symb,$courseid,$domain,$username)=@_;
6651: {
6652: use integer;
6653: # strings need to be an even # of cahracters long, it it is odd the
6654: # last characters gets thrown away
6655: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6656: my $symbseed=numval3($symb) << 10;
6657: my $namechck=unpack("%32S*",$username.' ');
6658:
6659: my $nameseed=numval3($username) << 21;
6660: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6661: my $courseseed=unpack("%32S*",$courseid.' ');
6662:
6663: my $num1=$symbchck+$symbseed+$namechck;
6664: my $num2=$nameseed+$domainseed+$courseseed;
6665: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6666: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6667: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6668:
6669: return "$num1:$num2";
6670: }
6671: }
6672:
6673: sub rndseed_64bit5 {
6674: my ($symb,$courseid,$domain,$username)=@_;
6675: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6676: return "$num1:$num2";
6677: }
6678:
6679: sub rndseed_CODE_64bit {
6680: my ($symb,$courseid,$domain,$username)=@_;
6681: {
6682: use integer;
6683: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6684: my $symbseed=numval2($symb);
6685: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6686: my $CODEseed=numval(&getCODE());
6687: my $courseseed=unpack("%32S*",$courseid.' ');
6688: my $num1=$symbseed+$CODEchck;
6689: my $num2=$CODEseed+$courseseed+$symbchck;
6690: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6691: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6692: if ($_64bit) { $num1=(($num1<<32)>>32); }
6693: if ($_64bit) { $num2=(($num2<<32)>>32); }
6694: return "$num1:$num2";
6695: }
6696: }
6697:
6698: sub rndseed_CODE_64bit4 {
6699: my ($symb,$courseid,$domain,$username)=@_;
6700: {
6701: use integer;
6702: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6703: my $symbseed=numval3($symb);
6704: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6705: my $CODEseed=numval3(&getCODE());
6706: my $courseseed=unpack("%32S*",$courseid.' ');
6707: my $num1=$symbseed+$CODEchck;
6708: my $num2=$CODEseed+$courseseed+$symbchck;
6709: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6710: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6711: if ($_64bit) { $num1=(($num1<<32)>>32); }
6712: if ($_64bit) { $num2=(($num2<<32)>>32); }
6713: return "$num1:$num2";
6714: }
6715: }
6716:
6717: sub rndseed_CODE_64bit5 {
6718: my ($symb,$courseid,$domain,$username)=@_;
6719: my $code = &getCODE();
6720: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6721: return "$num1:$num2";
6722: }
6723:
6724: sub setup_random_from_rndseed {
6725: my ($rndseed)=@_;
6726: if ($rndseed =~/([,:])/) {
6727: my ($num1,$num2)=split(/[,:]/,$rndseed);
6728: &Math::Random::random_set_seed(abs($num1),abs($num2));
6729: } else {
6730: &Math::Random::random_set_seed_from_phrase($rndseed);
6731: }
6732: }
6733:
6734: sub latest_receipt_algorithm_id {
6735: return 'receipt2';
6736: }
6737:
6738: sub recunique {
6739: my $fucourseid=shift;
6740: my $unique;
6741: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6742: $unique=$env{"course.$fucourseid.internal.encseed"};
6743: } else {
6744: $unique=$perlvar{'lonReceipt'};
6745: }
6746: return unpack("%32C*",$unique);
6747: }
6748:
6749: sub recprefix {
6750: my $fucourseid=shift;
6751: my $prefix;
6752: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6753: $prefix=$env{"course.$fucourseid.internal.encpref"};
6754: } else {
6755: $prefix=$perlvar{'lonHostID'};
6756: }
6757: return unpack("%32C*",$prefix);
6758: }
6759:
6760: sub ireceipt {
6761: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6762: my $cuname=unpack("%32C*",$funame);
6763: my $cudom=unpack("%32C*",$fudom);
6764: my $cucourseid=unpack("%32C*",$fucourseid);
6765: my $cusymb=unpack("%32C*",$fusymb);
6766: my $cunique=&recunique($fucourseid);
6767: my $cpart=unpack("%32S*",$part);
6768: my $return =&recprefix($fucourseid).'-';
6769: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6770: $env{'request.state'} eq 'construct') {
6771: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6772: " and ".($cpart%$cudom));
6773:
6774: $return.= ($cunique%$cuname+
6775: $cunique%$cudom+
6776: $cusymb%$cuname+
6777: $cusymb%$cudom+
6778: $cucourseid%$cuname+
6779: $cucourseid%$cudom+
6780: $cpart%$cuname+
6781: $cpart%$cudom);
6782: } else {
6783: $return.= ($cunique%$cuname+
6784: $cunique%$cudom+
6785: $cusymb%$cuname+
6786: $cusymb%$cudom+
6787: $cucourseid%$cuname+
6788: $cucourseid%$cudom);
6789: }
6790: return $return;
6791: }
6792:
6793: sub receipt {
6794: my ($part)=@_;
6795: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6796: return &ireceipt($name,$domain,$courseid,$symb,$part);
6797: }
6798:
6799: # ------------------------------------------------------------ Serves up a file
6800: # returns either the contents of the file or
6801: # -1 if the file doesn't exist
6802: #
6803: # if the target is a file that was uploaded via DOCS,
6804: # a check will be made to see if a current copy exists on the local server,
6805: # if it does this will be served, otherwise a copy will be retrieved from
6806: # the home server for the course and stored in /home/httpd/html/userfiles on
6807: # the local server.
6808:
6809: sub getfile {
6810: my ($file) = @_;
6811: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6812: &repcopy($file);
6813: return &readfile($file);
6814: }
6815:
6816: sub repcopy_userfile {
6817: my ($file)=@_;
6818: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6819: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
6820: my ($cdom,$cnum,$filename) =
6821: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6822: my ($info,$rtncode);
6823: my $uri="/uploaded/$cdom/$cnum/$filename";
6824: if (-e "$file") {
6825: my @fileinfo = stat($file);
6826: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
6827: if ($lwpresp ne 'ok') {
6828: if ($rtncode eq '404') {
6829: unlink($file);
6830: }
6831: #my $ua=new LWP::UserAgent;
6832: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6833: #my $response=$ua->request($request);
6834: #if ($response->is_success()) {
6835: # return $response->content;
6836: # } else {
6837: # return -1;
6838: # }
6839: return -1;
6840: }
6841: if ($info < $fileinfo[9]) {
6842: return 'ok';
6843: }
6844: $info = '';
6845: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6846: if ($lwpresp ne 'ok') {
6847: return -1;
6848: }
6849: } else {
6850: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6851: if ($lwpresp ne 'ok') {
6852: my $ua=new LWP::UserAgent;
6853: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6854: my $response=$ua->request($request);
6855: if ($response->is_success()) {
6856: $info=$response->content;
6857: } else {
6858: return -1;
6859: }
6860: }
6861: my @parts = ($cdom,$cnum);
6862: if ($filename =~ m|^(.+)/[^/]+$|) {
6863: push @parts, split(/\//,$1);
6864: }
6865: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
6866: foreach my $part (@parts) {
6867: $path .= '/'.$part;
6868: if (!-e $path) {
6869: mkdir($path,0770);
6870: }
6871: }
6872: }
6873: open(FILE,">$file");
6874: print FILE $info;
6875: close(FILE);
6876: return 'ok';
6877: }
6878:
6879: sub tokenwrapper {
6880: my $uri=shift;
6881: $uri=~s|^http\://([^/]+)||;
6882: $uri=~s|^/||;
6883: $env{'user.environment'}=~/\/([^\/]+)\.id/;
6884: my $token=$1;
6885: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6886: if ($udom && $uname && $file) {
6887: $file=~s|(\?\.*)*$||;
6888: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
6889: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
6890: (($uri=~/\?/)?'&':'?').'token='.$token.
6891: '&tokenissued='.$perlvar{'lonHostID'};
6892: } else {
6893: return '/adm/notfound.html';
6894: }
6895: }
6896:
6897: sub getuploaded {
6898: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6899: $uri=~s/^\///;
6900: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6901: my $ua=new LWP::UserAgent;
6902: my $request=new HTTP::Request($reqtype,$uri);
6903: my $response=$ua->request($request);
6904: $$rtncode = $response->code;
6905: if (! $response->is_success()) {
6906: return 'failed';
6907: }
6908: if ($reqtype eq 'HEAD') {
6909: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
6910: } elsif ($reqtype eq 'GET') {
6911: $$info = $response->content;
6912: }
6913: return 'ok';
6914: }
6915:
6916: sub readfile {
6917: my $file = shift;
6918: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6919: my $fh;
6920: open($fh,"<$file");
6921: my $a='';
6922: while (<$fh>) { $a .=$_; }
6923: return $a;
6924: }
6925:
6926: sub filelocation {
6927: my ($dir,$file) = @_;
6928: my $location;
6929: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
6930:
6931: if ($file =~ m-^/adm/-) {
6932: $file=~s-^/adm/wrapper/-/-;
6933: $file=~s-^/adm/coursedocs/showdoc/-/-;
6934: }
6935: if ($file=~m:^/~:) { # is a contruction space reference
6936: $location = $file;
6937: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
6938: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6939: # is a correct contruction space reference
6940: $location = $file;
6941: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
6942: my ($udom,$uname,$filename)=
6943: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
6944: my $home=&homeserver($uname,$udom);
6945: my $is_me=0;
6946: my @ids=¤t_machine_ids();
6947: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6948: if ($is_me) {
6949: $location=&propath($udom,$uname).
6950: '/userfiles/'.$filename;
6951: } else {
6952: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6953: $udom.'/'.$uname.'/'.$filename;
6954: }
6955: } else {
6956: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6957: $file=~s:^/res/:/:;
6958: if ( !( $file =~ m:^/:) ) {
6959: $location = $dir. '/'.$file;
6960: } else {
6961: $location = '/home/httpd/html/res'.$file;
6962: }
6963: }
6964: $location=~s://+:/:g; # remove duplicate /
6965: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6966: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6967: return $location;
6968: }
6969:
6970: sub hreflocation {
6971: my ($dir,$file)=@_;
6972: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
6973: $file=filelocation($dir,$file);
6974: } elsif ($file=~m-^/adm/-) {
6975: $file=~s-^/adm/wrapper/-/-;
6976: $file=~s-^/adm/coursedocs/showdoc/-/-;
6977: }
6978: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6979: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6980: } elsif ($file=~m-/home/(\w+)/public_html/-) {
6981: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
6982: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6983: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6984: -/uploaded/$1/$2/-x;
6985: }
6986: return $file;
6987: }
6988:
6989: sub current_machine_domains {
6990: my $hostname=$hostname{$perlvar{'lonHostID'}};
6991: my @domains;
6992: while( my($id, $name) = each(%hostname)) {
6993: # &logthis("-$id-$name-$hostname-");
6994: if ($hostname eq $name) {
6995: push(@domains,$hostdom{$id});
6996: }
6997: }
6998: return @domains;
6999: }
7000:
7001: sub current_machine_ids {
7002: my $hostname=$hostname{$perlvar{'lonHostID'}};
7003: my @ids;
7004: while( my($id, $name) = each(%hostname)) {
7005: # &logthis("-$id-$name-$hostname-");
7006: if ($hostname eq $name) {
7007: push(@ids,$id);
7008: }
7009: }
7010: return @ids;
7011: }
7012:
7013: # ------------------------------------------------------------- Declutters URLs
7014:
7015: sub declutter {
7016: my $thisfn=shift;
7017: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7018: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7019: $thisfn=~s/^\///;
7020: $thisfn=~s|^adm/wrapper/||;
7021: $thisfn=~s|^adm/coursedocs/showdoc/||;
7022: $thisfn=~s/^res\///;
7023: $thisfn=~s/\?.+$//;
7024: return $thisfn;
7025: }
7026:
7027: # ------------------------------------------------------------- Clutter up URLs
7028:
7029: sub clutter {
7030: my $thisfn='/'.&declutter(shift);
7031: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
7032: $thisfn='/res'.$thisfn;
7033: }
7034: if ($thisfn !~m|/adm|) {
7035: if ($thisfn =~ m|/ext/|) {
7036: $thisfn='/adm/wrapper'.$thisfn;
7037: } else {
7038: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7039: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7040: if ($embstyle eq 'ssi'
7041: || ($embstyle eq 'hdn')
7042: || ($embstyle eq 'rat')
7043: || ($embstyle eq 'prv')
7044: || ($embstyle eq 'ign')) {
7045: #do nothing with these
7046: } elsif (($embstyle eq 'img')
7047: || ($embstyle eq 'emb')
7048: || ($embstyle eq 'wrp')) {
7049: $thisfn='/adm/wrapper'.$thisfn;
7050: } elsif ($embstyle eq 'unk'
7051: && $thisfn!~/\.(sequence|page)$/) {
7052: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7053: } else {
7054: # &logthis("Got a blank emb style");
7055: }
7056: }
7057: }
7058: return $thisfn;
7059: }
7060:
7061: sub freeze_escape {
7062: my ($value)=@_;
7063: if (ref($value)) {
7064: $value=&nfreeze($value);
7065: return '__FROZEN__'.&escape($value);
7066: }
7067: return &escape($value);
7068: }
7069:
7070:
7071: sub thaw_unescape {
7072: my ($value)=@_;
7073: if ($value =~ /^__FROZEN__/) {
7074: substr($value,0,10,undef);
7075: $value=&unescape($value);
7076: return &thaw($value);
7077: }
7078: return &unescape($value);
7079: }
7080:
7081: sub correct_line_ends {
7082: my ($result)=@_;
7083: $$result =~s/\r\n/\n/mg;
7084: $$result =~s/\r/\n/mg;
7085: }
7086: # ================================================================ Main Program
7087:
7088: sub goodbye {
7089: &logthis("Starting Shut down");
7090: #not converted to using infrastruture and probably shouldn't be
7091: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
7092: #converted
7093: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7094: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7095: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7096: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
7097: #1.1 only
7098: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7099: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7100: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7101: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7102: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7103: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7104: &logthis(sprintf("%-20s is %s",'hits',$hits));
7105: &flushcourselogs();
7106: &logthis("Shutting down");
7107: }
7108:
7109: BEGIN {
7110: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
7111: unless ($readit) {
7112: {
7113: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
7114: open(my $config,"</etc/httpd/conf/loncapa.conf");
7115:
7116: while (my $configline=<$config>) {
7117: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
7118: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
7119: chomp($varvalue);
7120: $perlvar{$varname}=$varvalue;
7121: }
7122: }
7123: close($config);
7124: }
7125: {
7126: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
7127:
7128: while (my $configline=<$config>) {
7129: if ($configline =~ /^[^\#]*PerlSetVar/) {
7130: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
7131: chomp($varvalue);
7132: $perlvar{$varname}=$varvalue;
7133: }
7134: }
7135: close($config);
7136: }
7137:
7138: # ------------------------------------------------------------ Read domain file
7139: {
7140: %domaindescription = ();
7141: %domain_auth_def = ();
7142: %domain_auth_arg_def = ();
7143: my $fh;
7144: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
7145: while (<$fh>) {
7146: next if (/^(\#|\s*$)/);
7147: # next if /^\#/;
7148: chomp;
7149: my ($domain, $domain_description, $def_auth, $def_auth_arg,
7150: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
7151: $domain_auth_def{$domain}=$def_auth;
7152: $domain_auth_arg_def{$domain}=$def_auth_arg;
7153: $domaindescription{$domain}=$domain_description;
7154: $domain_lang_def{$domain}=$def_lang;
7155: $domain_city{$domain}=$city;
7156: $domain_longi{$domain}=$longi;
7157: $domain_lati{$domain}=$lati;
7158: $domain_primary{$domain}=$primary;
7159:
7160: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
7161: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
7162: }
7163: }
7164: close ($fh);
7165: }
7166:
7167:
7168: # ------------------------------------------------------------- Read hosts file
7169: {
7170: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7171:
7172: while (my $configline=<$config>) {
7173: next if ($configline =~ /^(\#|\s*$)/);
7174: chomp($configline);
7175: my ($id,$domain,$role,$name)=split(/:/,$configline);
7176: $name=~s/\s//g;
7177: if ($id && $domain && $role && $name) {
7178: $hostname{$id}=$name;
7179: $hostdom{$id}=$domain;
7180: if ($role eq 'library') { $libserv{$id}=$name; }
7181: }
7182: }
7183: close($config);
7184: # FIXME: dev server don't want this, production servers _do_ want this
7185: #&get_iphost();
7186: }
7187:
7188: sub get_iphost {
7189: if (%iphost) { return %iphost; }
7190: my %name_to_ip;
7191: foreach my $id (keys(%hostname)) {
7192: my $name=$hostname{$id};
7193: my $ip;
7194: if (!exists($name_to_ip{$name})) {
7195: $ip = gethostbyname($name);
7196: if (!$ip || length($ip) ne 4) {
7197: &logthis("Skipping host $id name $name no IP found\n");
7198: next;
7199: }
7200: $ip=inet_ntoa($ip);
7201: $name_to_ip{$name} = $ip;
7202: } else {
7203: $ip = $name_to_ip{$name};
7204: }
7205: push(@{$iphost{$ip}},$id);
7206: }
7207: return %iphost;
7208: }
7209:
7210: # ------------------------------------------------------ Read spare server file
7211: {
7212: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
7213:
7214: while (my $configline=<$config>) {
7215: chomp($configline);
7216: if ($configline) {
7217: $spareid{$configline}=1;
7218: }
7219: }
7220: close($config);
7221: }
7222: # ------------------------------------------------------------ Read permissions
7223: {
7224: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
7225:
7226: while (my $configline=<$config>) {
7227: chomp($configline);
7228: if ($configline) {
7229: my ($role,$perm)=split(/ /,$configline);
7230: if ($perm ne '') { $pr{$role}=$perm; }
7231: }
7232: }
7233: close($config);
7234: }
7235:
7236: # -------------------------------------------- Read plain texts for permissions
7237: {
7238: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
7239:
7240: while (my $configline=<$config>) {
7241: chomp($configline);
7242: if ($configline) {
7243: my ($short,@plain)=split(/:/,$configline);
7244: %{$prp{$short}} = ();
7245: if (@plain > 0) {
7246: $prp{$short}{'std'} = $plain[0];
7247: for (my $i=1; $i<@plain; $i++) {
7248: $prp{$short}{'alt'.$i} = $plain[$i];
7249: }
7250: }
7251: }
7252: }
7253: close($config);
7254: }
7255:
7256: # ---------------------------------------------------------- Read package table
7257: {
7258: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
7259:
7260: while (my $configline=<$config>) {
7261: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
7262: chomp($configline);
7263: my ($short,$plain)=split(/:/,$configline);
7264: my ($pack,$name)=split(/\&/,$short);
7265: if ($plain ne '') {
7266: $packagetab{$pack.'&'.$name.'&name'}=$name;
7267: $packagetab{$short}=$plain;
7268: }
7269: }
7270: close($config);
7271: }
7272:
7273: # ------------- set up temporary directory
7274: {
7275: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7276:
7277: }
7278:
7279: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
7280:
7281: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7282: $dumpcount=0;
7283:
7284: &logtouch();
7285: &logthis('<font color="yellow">INFO: Read configuration</font>');
7286: $readit=1;
7287: {
7288: use integer;
7289: my $test=(2**32)+1;
7290: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7291: &logthis(" Detected 64bit platform ($_64bit)");
7292: }
7293: }
7294: }
7295:
7296: 1;
7297: __END__
7298:
7299: =pod
7300:
7301: =head1 NAME
7302:
7303: Apache::lonnet - Subroutines to ask questions about things in the network.
7304:
7305: =head1 SYNOPSIS
7306:
7307: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7308:
7309: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7310:
7311: Common parameters:
7312:
7313: =over 4
7314:
7315: =item *
7316:
7317: $uname : an internal username (if $cname expecting a course Id specifically)
7318:
7319: =item *
7320:
7321: $udom : a domain (if $cdom expecting a course's domain specifically)
7322:
7323: =item *
7324:
7325: $symb : a resource instance identifier
7326:
7327: =item *
7328:
7329: $namespace : the name of a .db file that contains the data needed or
7330: being set.
7331:
7332: =back
7333:
7334: =head1 OVERVIEW
7335:
7336: lonnet provides subroutines which interact with the
7337: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7338: about classes, users, and resources.
7339:
7340: For many of these objects you can also use this to store data about
7341: them or modify them in various ways.
7342:
7343: =head2 Symbs
7344:
7345: To identify a specific instance of a resource, LON-CAPA uses symbols
7346: or "symbs"X<symb>. These identifiers are built from the URL of the
7347: map, the resource number of the resource in the map, and the URL of
7348: the resource itself. The latter is somewhat redundant, but might help
7349: if maps change.
7350:
7351: An example is
7352:
7353: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7354:
7355: The respective map entry is
7356:
7357: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7358: title="Problem 2">
7359: </resource>
7360:
7361: Symbs are used by the random number generator, as well as to store and
7362: restore data specific to a certain instance of for example a problem.
7363:
7364: =head2 Storing And Retrieving Data
7365:
7366: X<store()>X<cstore()>X<restore()>Three of the most important functions
7367: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7368: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7369: is is the non-critical message twin of cstore. These functions are for
7370: handlers to store a perl hash to a user's permanent data space in an
7371: easy manner, and to retrieve it again on another call. It is expected
7372: that a handler would use this once at the beginning to retrieve data,
7373: and then again once at the end to send only the new data back.
7374:
7375: The data is stored in the user's data directory on the user's
7376: homeserver under the ID of the course.
7377:
7378: The hash that is returned by restore will have all of the previous
7379: value for all of the elements of the hash.
7380:
7381: Example:
7382:
7383: #creating a hash
7384: my %hash;
7385: $hash{'foo'}='bar';
7386:
7387: #storing it
7388: &Apache::lonnet::cstore(\%hash);
7389:
7390: #changing a value
7391: $hash{'foo'}='notbar';
7392:
7393: #adding a new value
7394: $hash{'bar'}='foo';
7395: &Apache::lonnet::cstore(\%hash);
7396:
7397: #retrieving the hash
7398: my %history=&Apache::lonnet::restore();
7399:
7400: #print the hash
7401: foreach my $key (sort(keys(%history))) {
7402: print("\%history{$key} = $history{$key}");
7403: }
7404:
7405: Will print out:
7406:
7407: %history{1:foo} = bar
7408: %history{1:keys} = foo:timestamp
7409: %history{1:timestamp} = 990455579
7410: %history{2:bar} = foo
7411: %history{2:foo} = notbar
7412: %history{2:keys} = foo:bar:timestamp
7413: %history{2:timestamp} = 990455580
7414: %history{bar} = foo
7415: %history{foo} = notbar
7416: %history{timestamp} = 990455580
7417: %history{version} = 2
7418:
7419: Note that the special hash entries C<keys>, C<version> and
7420: C<timestamp> were added to the hash. C<version> will be equal to the
7421: total number of versions of the data that have been stored. The
7422: C<timestamp> attribute will be the UNIX time the hash was
7423: stored. C<keys> is available in every historical section to list which
7424: keys were added or changed at a specific historical revision of a
7425: hash.
7426:
7427: B<Warning>: do not store the hash that restore returns directly. This
7428: will cause a mess since it will restore the historical keys as if the
7429: were new keys. I.E. 1:foo will become 1:1:foo etc.
7430:
7431: Calling convention:
7432:
7433: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7434: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7435:
7436: For more detailed information, see lonnet specific documentation.
7437:
7438: =head1 RETURN MESSAGES
7439:
7440: =over 4
7441:
7442: =item * B<con_lost>: unable to contact remote host
7443:
7444: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7445: when the connection is brought back up
7446:
7447: =item * B<con_failed>: unable to contact remote host and unable to save message
7448: for later delivery
7449:
7450: =item * B<error:>: an error a occured, a description of the error follows the :
7451:
7452: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7453: that was requested
7454:
7455: =back
7456:
7457: =head1 PUBLIC SUBROUTINES
7458:
7459: =head2 Session Environment Functions
7460:
7461: =over 4
7462:
7463: =item *
7464: X<appenv()>
7465: B<appenv(%hash)>: the value of %hash is written to
7466: the user envirnoment file, and will be restored for each access this
7467: user makes during this session, also modifies the %env for the current
7468: process
7469:
7470: =item *
7471: X<delenv()>
7472: B<delenv($regexp)>: removes all items from the session
7473: environment file that matches the regular expression in $regexp. The
7474: values are also delted from the current processes %env.
7475:
7476: =back
7477:
7478: =head2 User Information
7479:
7480: =over 4
7481:
7482: =item *
7483: X<queryauthenticate()>
7484: B<queryauthenticate($uname,$udom)>: try to determine user's current
7485: authentication scheme
7486:
7487: =item *
7488: X<authenticate()>
7489: B<authenticate($uname,$upass,$udom)>: try to
7490: authenticate user from domain's lib servers (first use the current
7491: one). C<$upass> should be the users password.
7492:
7493: =item *
7494: X<homeserver()>
7495: B<homeserver($uname,$udom)>: find the server which has
7496: the user's directory and files (there must be only one), this caches
7497: the answer, and also caches if there is a borken connection.
7498:
7499: =item *
7500: X<idget()>
7501: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7502: (IDs are a unique resource in a domain, there must be only 1 ID per
7503: username, and only 1 username per ID in a specific domain) (returns
7504: hash: id=>name,id=>name)
7505:
7506: =item *
7507: X<idrget()>
7508: B<idrget($udom,@unames)>: find the IDs behind a list of
7509: usernames (returns hash: name=>id,name=>id)
7510:
7511: =item *
7512: X<idput()>
7513: B<idput($udom,%ids)>: store away a list of names and associated IDs
7514:
7515: =item *
7516: X<rolesinit()>
7517: B<rolesinit($udom,$username,$authhost)>: get user privileges
7518:
7519: =item *
7520: X<getsection()>
7521: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7522: course $cname, return section name/number or '' for "not in course"
7523: and '-1' for "no section"
7524:
7525: =item *
7526: X<userenvironment()>
7527: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7528: passed in @what from the requested user's environment, returns a hash
7529:
7530: =back
7531:
7532: =head2 User Roles
7533:
7534: =over 4
7535:
7536: =item *
7537:
7538: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7539: actions
7540: F: full access
7541: U,I,K: authentication modes (cxx only)
7542: '': forbidden
7543: 1: user needs to choose course
7544: 2: browse allowed
7545: A: passphrase authentication needed
7546:
7547: =item *
7548:
7549: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7550: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7551: and course level
7552:
7553: =item *
7554:
7555: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7556: explanation of a user role term
7557:
7558: =back
7559:
7560: =head2 User Modification
7561:
7562: =over 4
7563:
7564: =item *
7565:
7566: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7567: user for the level given by URL. Optional start and end dates (leave empty
7568: string or zero for "no date")
7569:
7570: =item *
7571:
7572: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7573: change a users, password, possible return values are: ok,
7574: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7575: refused
7576:
7577: =item *
7578:
7579: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7580:
7581: =item *
7582:
7583: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7584: modify user
7585:
7586: =item *
7587:
7588: modifystudent
7589:
7590: modify a students enrollment and identification information.
7591: The course id is resolved based on the current users environment.
7592: This means the envoking user must be a course coordinator or otherwise
7593: associated with a course.
7594:
7595: This call is essentially a wrapper for lonnet::modifyuser and
7596: lonnet::modify_student_enrollment
7597:
7598: Inputs:
7599:
7600: =over 4
7601:
7602: =item B<$udom> Students loncapa domain
7603:
7604: =item B<$uname> Students loncapa login name
7605:
7606: =item B<$uid> Students id/student number
7607:
7608: =item B<$umode> Students authentication mode
7609:
7610: =item B<$upass> Students password
7611:
7612: =item B<$first> Students first name
7613:
7614: =item B<$middle> Students middle name
7615:
7616: =item B<$last> Students last name
7617:
7618: =item B<$gene> Students generation
7619:
7620: =item B<$usec> Students section in course
7621:
7622: =item B<$end> Unix time of the roles expiration
7623:
7624: =item B<$start> Unix time of the roles start date
7625:
7626: =item B<$forceid> If defined, allow $uid to be changed
7627:
7628: =item B<$desiredhome> server to use as home server for student
7629:
7630: =back
7631:
7632: =item *
7633:
7634: modify_student_enrollment
7635:
7636: Change a students enrollment status in a class. The environment variable
7637: 'role.request.course' must be defined for this function to proceed.
7638:
7639: Inputs:
7640:
7641: =over 4
7642:
7643: =item $udom, students domain
7644:
7645: =item $uname, students name
7646:
7647: =item $uid, students user id
7648:
7649: =item $first, students first name
7650:
7651: =item $middle
7652:
7653: =item $last
7654:
7655: =item $gene
7656:
7657: =item $usec
7658:
7659: =item $end
7660:
7661: =item $start
7662:
7663: =back
7664:
7665:
7666: =item *
7667:
7668: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7669: custom role; give a custom role to a user for the level given by URL. Specify
7670: name and domain of role author, and role name
7671:
7672: =item *
7673:
7674: revokerole($udom,$uname,$url,$role) : revoke a role for url
7675:
7676: =item *
7677:
7678: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7679:
7680: =back
7681:
7682: =head2 Course Infomation
7683:
7684: =over 4
7685:
7686: =item *
7687:
7688: coursedescription($courseid) : returns a hash of information about the
7689: specified course id, including all environment settings for the
7690: course, the description of the course will be in the hash under the
7691: key 'description'
7692:
7693: =item *
7694:
7695: resdata($name,$domain,$type,@which) : request for current parameter
7696: setting for a specific $type, where $type is either 'course' or 'user',
7697: @what should be a list of parameters to ask about. This routine caches
7698: answers for 5 minutes.
7699:
7700: =back
7701:
7702: =head2 Course Modification
7703:
7704: =over 4
7705:
7706: =item *
7707:
7708: writecoursepref($courseid,%prefs) : write preferences (environment
7709: database) for a course
7710:
7711: =item *
7712:
7713: createcourse($udom,$description,$url) : make/modify course
7714:
7715: =back
7716:
7717: =head2 Resource Subroutines
7718:
7719: =over 4
7720:
7721: =item *
7722:
7723: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7724:
7725: =item *
7726:
7727: repcopy($filename) : subscribes to the requested file, and attempts to
7728: replicate from the owning library server, Might return
7729: 'unavailable', 'not_found', 'forbidden', 'ok', or
7730: 'bad_request', also attempts to grab the metadata for the
7731: resource. Expects the local filesystem pathname
7732: (/home/httpd/html/res/....)
7733:
7734: =back
7735:
7736: =head2 Resource Information
7737:
7738: =over 4
7739:
7740: =item *
7741:
7742: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7743: a vairety of different possible values, $varname should be a request
7744: string, and the other parameters can be used to specify who and what
7745: one is asking about.
7746:
7747: Possible values for $varname are environment.lastname (or other item
7748: from the envirnment hash), user.name (or someother aspect about the
7749: user), resource.0.maxtries (or some other part and parameter of a
7750: resource)
7751:
7752: =item *
7753:
7754: directcondval($number) : get current value of a condition; reads from a state
7755: string
7756:
7757: =item *
7758:
7759: condval($condidx) : value of condition index based on state
7760:
7761: =item *
7762:
7763: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7764: resource's metadata, $what should be either a specific key, or either
7765: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7766: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7767:
7768: this function automatically caches all requests
7769:
7770: =item *
7771:
7772: metadata_query($query,$custom,$customshow) : make a metadata query against the
7773: network of library servers; returns file handle of where SQL and regex results
7774: will be stored for query
7775:
7776: =item *
7777:
7778: symbread($filename) : return symbolic list entry (filename argument optional);
7779: returns the data handle
7780:
7781: =item *
7782:
7783: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7784: a possible symb for the URL in $thisfn, and if is an encryypted
7785: resource that the user accessed using /enc/ returns a 1 on success, 0
7786: on failure, user must be in a course, as it assumes the existance of
7787: the course initial hash, and uses $env('request.course.id'}
7788:
7789:
7790: =item *
7791:
7792: symbclean($symb) : removes versions numbers from a symb, returns the
7793: cleaned symb
7794:
7795: =item *
7796:
7797: is_on_map($uri) : checks if the $uri is somewhere on the current
7798: course map, user must be in a course for it to work.
7799:
7800: =item *
7801:
7802: numval($salt) : return random seed value (addend for rndseed)
7803:
7804: =item *
7805:
7806: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7807: a random seed, all arguments are optional, if they aren't sent it uses the
7808: environment to derive them. Note: if symb isn't sent and it can't get one
7809: from &symbread it will use the current time as its return value
7810:
7811: =item *
7812:
7813: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7814: unfakeable, receipt
7815:
7816: =item *
7817:
7818: receipt() : API to ireceipt working off of env values; given out to users
7819:
7820: =item *
7821:
7822: countacc($url) : count the number of accesses to a given URL
7823:
7824: =item *
7825:
7826: 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
7827:
7828: =item *
7829:
7830: 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)
7831:
7832: =item *
7833:
7834: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
7835:
7836: =item *
7837:
7838: devalidate($symb) : devalidate temporary spreadsheet calculations,
7839: forcing spreadsheet to reevaluate the resource scores next time.
7840:
7841: =back
7842:
7843: =head2 Storing/Retreiving Data
7844:
7845: =over 4
7846:
7847: =item *
7848:
7849: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7850: for this url; hashref needs to be given and should be a \%hashname; the
7851: remaining args aren't required and if they aren't passed or are '' they will
7852: be derived from the env
7853:
7854: =item *
7855:
7856: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7857: uses critical subroutine
7858:
7859: =item *
7860:
7861: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7862: all args are optional
7863:
7864: =item *
7865:
7866: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7867: dumps the complete (or key matching regexp) namespace into a hash
7868: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7869: normally &store()ed into
7870:
7871: $range should be either an integer '100' (give me the first 100
7872: matching records)
7873: or be two integers sperated by a - with no spaces
7874: '30-50' (give me the 30th through the 50th matching
7875: records)
7876:
7877:
7878: =item *
7879:
7880: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7881: replaces a &store() version of data with a replacement set of data
7882: for a particular resource in a namespace passed in the $storehash hash
7883: reference
7884:
7885: =item *
7886:
7887: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7888: works very similar to store/cstore, but all data is stored in a
7889: temporary location and can be reset using tmpreset, $storehash should
7890: be a hash reference, returns nothing on success
7891:
7892: =item *
7893:
7894: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7895: similar to restore, but all data is stored in a temporary location and
7896: can be reset using tmpreset. Returns a hash of values on success,
7897: error string otherwise.
7898:
7899: =item *
7900:
7901: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7902: deltes all keys for $symb form the temporary storage hash.
7903:
7904: =item *
7905:
7906: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7907: reference filled in from namesp ($udom and $uname are optional)
7908:
7909: =item *
7910:
7911: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7912: namesp ($udom and $uname are optional)
7913:
7914: =item *
7915:
7916: dump($namespace,$udom,$uname,$regexp,$range) :
7917: dumps the complete (or key matching regexp) namespace into a hash
7918: ($udom, $uname, $regexp, $range are optional)
7919:
7920: $range should be either an integer '100' (give me the first 100
7921: matching records)
7922: or be two integers sperated by a - with no spaces
7923: '30-50' (give me the 30th through the 50th matching
7924: records)
7925: =item *
7926:
7927: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7928: $store can be a scalar, an array reference, or if the amount to be
7929: incremented is > 1, a hash reference.
7930:
7931: ($udom and $uname are optional)
7932:
7933: =item *
7934:
7935: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7936: ($udom and $uname are optional)
7937:
7938: =item *
7939:
7940: cput($namespace,$storehash,$udom,$uname) : critical put
7941: ($udom and $uname are optional)
7942:
7943: =item *
7944:
7945: newput($namespace,$storehash,$udom,$uname) :
7946:
7947: Attempts to store the items in the $storehash, but only if they don't
7948: currently exist, if this succeeds you can be certain that you have
7949: successfully created a new key value pair in the $namespace db.
7950:
7951:
7952: Args:
7953: $namespace: name of database to store values to
7954: $storehash: hashref to store to the db
7955: $udom: (optional) domain of user containing the db
7956: $uname: (optional) name of user caontaining the db
7957:
7958: Returns:
7959: 'ok' -> succeeded in storing all keys of $storehash
7960: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7961: least <key> already existed in the db (other
7962: requested keys may also already exist)
7963: 'error: <msg>' -> unable to tie the DB or other erorr occured
7964: 'con_lost' -> unable to contact request server
7965: 'refused' -> action was not allowed by remote machine
7966:
7967:
7968: =item *
7969:
7970: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7971: reference filled in from namesp (encrypts the return communication)
7972: ($udom and $uname are optional)
7973:
7974: =item *
7975:
7976: log($udom,$name,$home,$message) : write to permanent log for user; use
7977: critical subroutine
7978:
7979: =back
7980:
7981: =head2 Network Status Functions
7982:
7983: =over 4
7984:
7985: =item *
7986:
7987: dirlist($uri) : return directory list based on URI
7988:
7989: =item *
7990:
7991: spareserver() : find server with least workload from spare.tab
7992:
7993: =back
7994:
7995: =head2 Apache Request
7996:
7997: =over 4
7998:
7999: =item *
8000:
8001: ssi($url,%hash) : server side include, does a complete request cycle on url to
8002: localhost, posts hash
8003:
8004: =back
8005:
8006: =head2 Data to String to Data
8007:
8008: =over 4
8009:
8010: =item *
8011:
8012: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8013: and '&' separators, supports elements that are arrayrefs and hashrefs
8014:
8015: =item *
8016:
8017: hashref2str($hashref) : convert a hashref into a string complete with
8018: escaping and '=' and '&' separators, supports elements that are
8019: arrayrefs and hashrefs
8020:
8021: =item *
8022:
8023: arrayref2str($arrayref) : convert an arrayref into a string complete
8024: with escaping and '&' separators, supports elements that are arrayrefs
8025: and hashrefs
8026:
8027: =item *
8028:
8029: str2hash($string) : convert string to hash using unescaping and
8030: splitting on '=' and '&', supports elements that are arrayrefs and
8031: hashrefs
8032:
8033: =item *
8034:
8035: str2array($string) : convert string to hash using unescaping and
8036: splitting on '&', supports elements that are arrayrefs and hashrefs
8037:
8038: =back
8039:
8040: =head2 Logging Routines
8041:
8042: =over 4
8043:
8044: These routines allow one to make log messages in the lonnet.log and
8045: lonnet.perm logfiles.
8046:
8047: =item *
8048:
8049: logtouch() : make sure the logfile, lonnet.log, exists
8050:
8051: =item *
8052:
8053: logthis() : append message to the normal lonnet.log file, it gets
8054: preiodically rolled over and deleted.
8055:
8056: =item *
8057:
8058: logperm() : append a permanent message to lonnet.perm.log, this log
8059: file never gets deleted by any automated portion of the system, only
8060: messages of critical importance should go in here.
8061:
8062: =back
8063:
8064: =head2 General File Helper Routines
8065:
8066: =over 4
8067:
8068: =item *
8069:
8070: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8071: (a) files in /uploaded
8072: (i) If a local copy of the file exists -
8073: compares modification date of local copy with last-modified date for
8074: definitive version stored on home server for course. If local copy is
8075: stale, requests a new version from the home server and stores it.
8076: If the original has been removed from the home server, then local copy
8077: is unlinked.
8078: (ii) If local copy does not exist -
8079: requests the file from the home server and stores it.
8080:
8081: If $caller is 'uploadrep':
8082: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8083: for request for files originally uploaded via DOCS.
8084: - returns 'ok' if fresh local copy now available, -1 otherwise.
8085:
8086: Otherwise:
8087: This indicates a call from the content generation phase of the request.
8088: - returns the entire contents of the file or -1.
8089:
8090: (b) files in /res
8091: - returns the entire contents of a file or -1;
8092: it properly subscribes to and replicates the file if neccessary.
8093:
8094:
8095: =item *
8096:
8097: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8098: reference
8099:
8100: returns either a stat() list of data about the file or an empty list
8101: if the file doesn't exist or couldn't find out about it (connection
8102: problems or user unknown)
8103:
8104: =item *
8105:
8106: filelocation($dir,$file) : returns file system location of a file
8107: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8108: directory that relative $file lookups are to looked in ($dir of /a/dir
8109: and a file of ../bob will become /a/bob)
8110:
8111: =item *
8112:
8113: hreflocation($dir,$file) : returns file system location or a URL; same as
8114: filelocation except for hrefs
8115:
8116: =item *
8117:
8118: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8119:
8120: =back
8121:
8122: =head2 Usererfile file routines (/uploaded*)
8123:
8124: =over 4
8125:
8126: =item *
8127:
8128: userfileupload(): main rotine for putting a file in a user or course's
8129: filespace, arguments are,
8130:
8131: formname - required - this is the name of the element in $env where the
8132: filename, and the contents of the file to create/modifed exist
8133: the filename is in $env{'form.'.$formname.'.filename'} and the
8134: contents of the file is located in $env{'form.'.$formname}
8135: coursedoc - if true, store the file in the course of the active role
8136: of the current user
8137: subdir - required - subdirectory to put the file in under ../userfiles/
8138: if undefined, it will be placed in "unknown"
8139:
8140: (This routine calls clean_filename() to remove any dangerous
8141: characters from the filename, and then calls finuserfileupload() to
8142: complete the transaction)
8143:
8144: returns either the url of the uploaded file (/uploaded/....) if successful
8145: and /adm/notfound.html if unsuccessful
8146:
8147: =item *
8148:
8149: clean_filename(): routine for cleaing a filename up for storage in
8150: userfile space, argument is:
8151:
8152: filename - proposed filename
8153:
8154: returns: the new clean filename
8155:
8156: =item *
8157:
8158: finishuserfileupload(): routine that creaes and sends the file to
8159: userspace, probably shouldn't be called directly
8160:
8161: docuname: username or courseid of destination for the file
8162: docudom: domain of user/course of destination for the file
8163: formname: same as for userfileupload()
8164: fname: filename (inculding subdirectories) for the file
8165:
8166: returns either the url of the uploaded file (/uploaded/....) if successful
8167: and /adm/notfound.html if unsuccessful
8168:
8169: =item *
8170:
8171: renameuserfile(): renames an existing userfile to a new name
8172:
8173: Args:
8174: docuname: username or courseid of destination for the file
8175: docudom: domain of user/course of destination for the file
8176: old: current file name (including any subdirs under userfiles)
8177: new: desired file name (including any subdirs under userfiles)
8178:
8179: =item *
8180:
8181: mkdiruserfile(): creates a directory is a userfiles dir
8182:
8183: Args:
8184: docuname: username or courseid of destination for the file
8185: docudom: domain of user/course of destination for the file
8186: dir: dir to create (including any subdirs under userfiles)
8187:
8188: =item *
8189:
8190: removeuserfile(): removes a file that exists in userfiles
8191:
8192: Args:
8193: docuname: username or courseid of destination for the file
8194: docudom: domain of user/course of destination for the file
8195: fname: filname to delete (including any subdirs under userfiles)
8196:
8197: =item *
8198:
8199: removeuploadedurl(): convience function for removeuserfile()
8200:
8201: Args:
8202: url: a full /uploaded/... url to delete
8203:
8204: =item *
8205:
8206: get_portfile_permissions():
8207: Args:
8208: domain: domain of user or course contain the portfolio files
8209: user: name of user or num of course contain the portfolio files
8210: Returns:
8211: hashref of a dump of the proper file_permissions.db
8212:
8213:
8214: =item *
8215:
8216: get_access_controls():
8217:
8218: Args:
8219: current_permissions: the hash ref returned from get_portfile_permissions()
8220: group: (optional) the group you want the files associated with
8221: file: (optional) the file you want access info on
8222:
8223: Returns:
8224: a hash (keys are file names) of hashes containing
8225: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8226: values are XML containing access control settings (see below)
8227:
8228: Internal notes:
8229:
8230: access controls are stored in file_permissions.db as key=value pairs.
8231: key -> path to file/file_name\0uniqueID:scope_end_start
8232: where scope -> public,guest,course,group,domains or users.
8233: end -> UNIX time for end of access (0 -> no end date)
8234: start -> UNIX time for start of access
8235:
8236: value -> XML description of access control
8237: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8238: <start></start>
8239: <end></end>
8240:
8241: <password></password> for scope type = guest
8242:
8243: <domain></domain> for scope type = course or group
8244: <number></number>
8245: <roles id="">
8246: <role></role>
8247: <access></access>
8248: <section></section>
8249: <group></group>
8250: </roles>
8251:
8252: <dom></dom> for scope type = domains
8253:
8254: <users> for scope type = users
8255: <user>
8256: <uname></uname>
8257: <udom></udom>
8258: </user>
8259: </users>
8260: </scope>
8261:
8262: Access data is also aggregated for each file in an additional key=value pair:
8263: key -> path to file/file_name\0accesscontrol
8264: value -> reference to hash
8265: hash contains key = value pairs
8266: where key = uniqueID:scope_end_start
8267: value = UNIX time record was last updated
8268:
8269: Used to improve speed of look-ups of access controls for each file.
8270:
8271: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8272:
8273: modify_access_controls():
8274:
8275: Modifies access controls for a portfolio file
8276: Args
8277: 1. file name
8278: 2. reference to hash of required changes,
8279: 3. domain
8280: 4. username
8281: where domain,username are the domain of the portfolio owner
8282: (either a user or a course)
8283:
8284: Returns:
8285: 1. result of additions or updates ('ok' or 'error', with error message).
8286: 2. result of deletions ('ok' or 'error', with error message).
8287: 3. reference to hash of any new or updated access controls.
8288: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8289: key = integer (inbound ID)
8290: value = uniqueID
8291:
8292: =back
8293:
8294: =head2 HTTP Helper Routines
8295:
8296: =over 4
8297:
8298: =item *
8299:
8300: escape() : unpack non-word characters into CGI-compatible hex codes
8301:
8302: =item *
8303:
8304: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8305:
8306: =back
8307:
8308: =head1 PRIVATE SUBROUTINES
8309:
8310: =head2 Underlying communication routines (Shouldn't call)
8311:
8312: =over 4
8313:
8314: =item *
8315:
8316: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8317:
8318: =item *
8319:
8320: reply() : uses subreply to send a message to remote machine, logs all failures
8321:
8322: =item *
8323:
8324: critical() : passes a critical message to another server; if cannot
8325: get through then place message in connection buffer directory and
8326: returns con_delayed, if incapable of saving message, returns
8327: con_failed
8328:
8329: =item *
8330:
8331: reconlonc() : tries to reconnect lonc client processes.
8332:
8333: =back
8334:
8335: =head2 Resource Access Logging
8336:
8337: =over 4
8338:
8339: =item *
8340:
8341: flushcourselogs() : flush (save) buffer logs and access logs
8342:
8343: =item *
8344:
8345: courselog($what) : save message for course in hash
8346:
8347: =item *
8348:
8349: courseacclog($what) : save message for course using &courselog(). Perform
8350: special processing for specific resource types (problems, exams, quizzes, etc).
8351:
8352: =item *
8353:
8354: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8355: as a PerlChildExitHandler
8356:
8357: =back
8358:
8359: =head2 Other
8360:
8361: =over 4
8362:
8363: =item *
8364:
8365: symblist($mapname,%newhash) : update symbolic storage links
8366:
8367: =back
8368:
8369: =cut
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