1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.714 2006/03/03 23:22:18 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: 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
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 Apache::Constants qw(:common :http);
49: use HTML::LCParser;
50: use HTML::Parser;
51: use Fcntl qw(:flock);
52: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
53: use Time::HiRes qw( gettimeofday tv_interval );
54: use Cache::Memcached;
55: use Digest::MD5;
56:
57: my $readit;
58: my $max_connection_retries = 10; # Or some such value.
59:
60: require Exporter;
61:
62: our @ISA = qw (Exporter);
63: our @EXPORT = qw(%env);
64:
65: =pod
66:
67: =head1 Package Variables
68:
69: These are largely undocumented, so if you decipher one please note it here.
70:
71: =over 4
72:
73: =item $processmarker
74:
75: Contains the time this process was started and this servers host id.
76:
77: =item $dumpcount
78:
79: Counts the number of times a message log flush has been attempted (regardless
80: of success) by this process. Used as part of the filename when messages are
81: delayed.
82:
83: =back
84:
85: =cut
86:
87:
88: # --------------------------------------------------------------------- Logging
89:
90: sub logtouch {
91: my $execdir=$perlvar{'lonDaemons'};
92: unless (-e "$execdir/logs/lonnet.log") {
93: open(my $fh,">>$execdir/logs/lonnet.log");
94: close $fh;
95: }
96: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
97: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
98: }
99:
100: sub logthis {
101: my $message=shift;
102: my $execdir=$perlvar{'lonDaemons'};
103: my $now=time;
104: my $local=localtime($now);
105: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
106: print $fh "$local ($$): $message\n";
107: close($fh);
108: }
109: return 1;
110: }
111:
112: sub logperm {
113: my $message=shift;
114: my $execdir=$perlvar{'lonDaemons'};
115: my $now=time;
116: my $local=localtime($now);
117: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
118: print $fh "$now:$message:$local\n";
119: close($fh);
120: }
121: return 1;
122: }
123:
124: # -------------------------------------------------- Non-critical communication
125: sub subreply {
126: my ($cmd,$server)=@_;
127: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
128: #
129: # With loncnew process trimming, there's a timing hole between lonc server
130: # process exit and the master server picking up the listen on the AF_UNIX
131: # socket. In that time interval, a lock file will exist:
132:
133: my $lockfile=$peerfile.".lock";
134: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
135: sleep(1);
136: }
137: # At this point, either a loncnew parent is listening or an old lonc
138: # or loncnew child is listening so we can connect or everything's dead.
139: #
140: # We'll give the connection a few tries before abandoning it. If
141: # connection is not possible, we'll con_lost back to the client.
142: #
143: my $client;
144: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
145: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
146: Type => SOCK_STREAM,
147: Timeout => 10);
148: if($client) {
149: last; # Connected!
150: }
151: sleep(1); # Try again later if failed connection.
152: }
153: my $answer;
154: if ($client) {
155: print $client "sethost:$server:$cmd\n";
156: $answer=<$client>;
157: if (!$answer) { $answer="con_lost"; }
158: chomp($answer);
159: } else {
160: $answer = 'con_lost'; # Failed connection.
161: }
162: return $answer;
163: }
164:
165: sub reply {
166: my ($cmd,$server)=@_;
167: unless (defined($hostname{$server})) { return 'no_such_host'; }
168: my $answer=subreply($cmd,$server);
169: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
170: &logthis("<font color=\"blue\">WARNING:".
171: " $cmd to $server returned $answer</font>");
172: }
173: return $answer;
174: }
175:
176: # ----------------------------------------------------------- Send USR1 to lonc
177:
178: sub reconlonc {
179: my $peerfile=shift;
180: &logthis("Trying to reconnect for $peerfile");
181: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
182: if (open(my $fh,"<$loncfile")) {
183: my $loncpid=<$fh>;
184: chomp($loncpid);
185: if (kill 0 => $loncpid) {
186: &logthis("lonc at pid $loncpid responding, sending USR1");
187: kill USR1 => $loncpid;
188: sleep 1;
189: if (-e "$peerfile") { return; }
190: &logthis("$peerfile still not there, give it another try");
191: sleep 5;
192: if (-e "$peerfile") { return; }
193: &logthis(
194: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
195: } else {
196: &logthis(
197: "<font color=\"blue\">WARNING:".
198: " lonc at pid $loncpid not responding, giving up</font>");
199: }
200: } else {
201: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
202: }
203: }
204:
205: # ------------------------------------------------------ Critical communication
206:
207: sub critical {
208: my ($cmd,$server)=@_;
209: unless ($hostname{$server}) {
210: &logthis("<font color=\"blue\">WARNING:".
211: " Critical message to unknown server ($server)</font>");
212: return 'no_such_host';
213: }
214: my $answer=reply($cmd,$server);
215: if ($answer eq 'con_lost') {
216: &reconlonc("$perlvar{'lonSockDir'}/$server");
217: my $answer=reply($cmd,$server);
218: if ($answer eq 'con_lost') {
219: my $now=time;
220: my $middlename=$cmd;
221: $middlename=substr($middlename,0,16);
222: $middlename=~s/\W//g;
223: my $dfilename=
224: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
225: $dumpcount++;
226: {
227: my $dfh;
228: if (open($dfh,">$dfilename")) {
229: print $dfh "$cmd\n";
230: close($dfh);
231: }
232: }
233: sleep 2;
234: my $wcmd='';
235: {
236: my $dfh;
237: if (open($dfh,"<$dfilename")) {
238: $wcmd=<$dfh>;
239: close($dfh);
240: }
241: }
242: chomp($wcmd);
243: if ($wcmd eq $cmd) {
244: &logthis("<font color=\"blue\">WARNING: ".
245: "Connection buffer $dfilename: $cmd</font>");
246: &logperm("D:$server:$cmd");
247: return 'con_delayed';
248: } else {
249: &logthis("<font color=\"red\">CRITICAL:"
250: ." Critical connection failed: $server $cmd</font>");
251: &logperm("F:$server:$cmd");
252: return 'con_failed';
253: }
254: }
255: }
256: return $answer;
257: }
258:
259: # ------------------------------------------- Transfer profile into environment
260:
261: sub transfer_profile_to_env {
262: my ($lonidsdir,$handle)=@_;
263: my @profile;
264: {
265: open(my $idf,"$lonidsdir/$handle.id");
266: flock($idf,LOCK_SH);
267: @profile=<$idf>;
268: close($idf);
269: }
270: my $envi;
271: my %Remove;
272: for ($envi=0;$envi<=$#profile;$envi++) {
273: chomp($profile[$envi]);
274: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
275: $env{$envname} = $envvalue;
276: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
277: if ($time < time-300) {
278: $Remove{$key}++;
279: }
280: }
281: }
282: $env{'user.environment'} = "$lonidsdir/$handle.id";
283: foreach my $expired_key (keys(%Remove)) {
284: &delenv($expired_key);
285: }
286: }
287:
288: # ---------------------------------------------------------- Append Environment
289:
290: sub appenv {
291: my %newenv=@_;
292: foreach my $key (keys(%newenv)) {
293: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
294: &logthis("<font color=\"blue\">WARNING: ".
295: "Attempt to modify environment ".$key." to ".$newenv{$key}
296: .'</font>');
297: delete($newenv{$key});
298: } else {
299: $env{$key}=$newenv{$key};
300: }
301: }
302:
303: my $lockfh;
304: unless (open($lockfh,"$env{'user.environment'}")) {
305: return 'error: '.$!;
306: }
307: unless (flock($lockfh,LOCK_EX)) {
308: &logthis("<font color=\"blue\">WARNING: ".
309: 'Could not obtain exclusive lock in appenv: '.$!);
310: close($lockfh);
311: return 'error: '.$!;
312: }
313:
314: my @oldenv;
315: {
316: my $fh;
317: unless (open($fh,"$env{'user.environment'}")) {
318: return 'error: '.$!;
319: }
320: @oldenv=<$fh>;
321: close($fh);
322: }
323: for (my $i=0; $i<=$#oldenv; $i++) {
324: chomp($oldenv[$i]);
325: if ($oldenv[$i] ne '') {
326: my ($name,$value)=split(/=/,$oldenv[$i],2);
327: unless (defined($newenv{$name})) {
328: $newenv{$name}=$value;
329: }
330: }
331: }
332: {
333: my $fh;
334: unless (open($fh,">$env{'user.environment'}")) {
335: return 'error';
336: }
337: my $newname;
338: foreach $newname (keys %newenv) {
339: print $fh "$newname=$newenv{$newname}\n";
340: }
341: close($fh);
342: }
343:
344: close($lockfh);
345: return 'ok';
346: }
347: # ----------------------------------------------------- Delete from Environment
348:
349: sub delenv {
350: my $delthis=shift;
351: my %newenv=();
352: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
353: &logthis("<font color=\"blue\">WARNING: ".
354: "Attempt to delete from environment ".$delthis);
355: return 'error';
356: }
357: my @oldenv;
358: {
359: my $fh;
360: unless (open($fh,"$env{'user.environment'}")) {
361: return 'error';
362: }
363: unless (flock($fh,LOCK_SH)) {
364: &logthis("<font color=\"blue\">WARNING: ".
365: 'Could not obtain shared lock in delenv: '.$!);
366: close($fh);
367: return 'error: '.$!;
368: }
369: @oldenv=<$fh>;
370: close($fh);
371: }
372: {
373: my $fh;
374: unless (open($fh,">$env{'user.environment'}")) {
375: return 'error';
376: }
377: unless (flock($fh,LOCK_EX)) {
378: &logthis("<font color=\"blue\">WARNING: ".
379: 'Could not obtain exclusive lock in delenv: '.$!);
380: close($fh);
381: return 'error: '.$!;
382: }
383: foreach my $cur_key (@oldenv) {
384: if ($cur_key=~/^$delthis/) {
385: my ($key,undef) = split('=',$cur_key,2);
386: delete($env{$key});
387: } else {
388: print $fh $cur_key;
389: }
390: }
391: close($fh);
392: }
393: return 'ok';
394: }
395:
396: # ------------------------------------------ Find out current server userload
397: # there is a copy in lond
398: sub userload {
399: my $numusers=0;
400: {
401: opendir(LONIDS,$perlvar{'lonIDsDir'});
402: my $filename;
403: my $curtime=time;
404: while ($filename=readdir(LONIDS)) {
405: if ($filename eq '.' || $filename eq '..') {next;}
406: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
407: if ($curtime-$mtime < 1800) { $numusers++; }
408: }
409: closedir(LONIDS);
410: }
411: my $userloadpercent=0;
412: my $maxuserload=$perlvar{'lonUserLoadLim'};
413: if ($maxuserload) {
414: $userloadpercent=100*$numusers/$maxuserload;
415: }
416: $userloadpercent=sprintf("%.2f",$userloadpercent);
417: return $userloadpercent;
418: }
419:
420: # ------------------------------------------ Fight off request when overloaded
421:
422: sub overloaderror {
423: my ($r,$checkserver)=@_;
424: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
425: my $loadavg;
426: if ($checkserver eq $perlvar{'lonHostID'}) {
427: open(my $loadfile,'/proc/loadavg');
428: $loadavg=<$loadfile>;
429: $loadavg =~ s/\s.*//g;
430: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
431: close($loadfile);
432: } else {
433: $loadavg=&reply('load',$checkserver);
434: }
435: my $overload=$loadavg-100;
436: if ($overload>0) {
437: $r->err_headers_out->{'Retry-After'}=$overload;
438: $r->log_error('Overload of '.$overload.' on '.$checkserver);
439: return 413;
440: }
441: return '';
442: }
443:
444: # ------------------------------ Find server with least workload from spare.tab
445:
446: sub spareserver {
447: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
448: my $tryserver;
449: my $spareserver='';
450: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
451: my $lowestserver=$loadpercent > $userloadpercent?
452: $loadpercent : $userloadpercent;
453: foreach $tryserver (keys(%spareid)) {
454: my $loadans=&reply('load',$tryserver);
455: my $userloadans=&reply('userload',$tryserver);
456: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
457: next; #didn't get a number from the server
458: }
459: my $answer;
460: if ($loadans =~ /\d/) {
461: if ($userloadans =~ /\d/) {
462: #both are numbers, pick the bigger one
463: $answer=$loadans > $userloadans?
464: $loadans : $userloadans;
465: } else {
466: $answer = $loadans;
467: }
468: } else {
469: $answer = $userloadans;
470: }
471: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
472: if ($want_server_name) {
473: $spareserver=$tryserver;
474: } else {
475: $spareserver="http://$hostname{$tryserver}";
476: }
477: $lowestserver=$answer;
478: }
479: }
480: return $spareserver;
481: }
482:
483: # --------------------------------------------- Try to change a user's password
484:
485: sub changepass {
486: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
487: $currentpass = &escape($currentpass);
488: $newpass = &escape($newpass);
489: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
490: $server);
491: if (! $answer) {
492: &logthis("No reply on password change request to $server ".
493: "by $uname in domain $udom.");
494: } elsif ($answer =~ "^ok") {
495: &logthis("$uname in $udom successfully changed their password ".
496: "on $server.");
497: } elsif ($answer =~ "^pwchange_failure") {
498: &logthis("$uname in $udom was unable to change their password ".
499: "on $server. The action was blocked by either lcpasswd ".
500: "or pwchange");
501: } elsif ($answer =~ "^non_authorized") {
502: &logthis("$uname in $udom did not get their password correct when ".
503: "attempting to change it on $server.");
504: } elsif ($answer =~ "^auth_mode_error") {
505: &logthis("$uname in $udom attempted to change their password despite ".
506: "not being locally or internally authenticated on $server.");
507: } elsif ($answer =~ "^unknown_user") {
508: &logthis("$uname in $udom attempted to change their password ".
509: "on $server but were unable to because $server is not ".
510: "their home server.");
511: } elsif ($answer =~ "^refused") {
512: &logthis("$server refused to change $uname in $udom password because ".
513: "it was sent an unencrypted request to change the password.");
514: }
515: return $answer;
516: }
517:
518: # ----------------------- Try to determine user's current authentication scheme
519:
520: sub queryauthenticate {
521: my ($uname,$udom)=@_;
522: my $uhome=&homeserver($uname,$udom);
523: if (!$uhome) {
524: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
525: return 'no_host';
526: }
527: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
528: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
529: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
530: }
531: return $answer;
532: }
533:
534: # --------- Try to authenticate user from domain's lib servers (first this one)
535:
536: sub authenticate {
537: my ($uname,$upass,$udom)=@_;
538: $upass=escape($upass);
539: $uname=~s/\W//g;
540: my $uhome=&homeserver($uname,$udom);
541: if (!$uhome) {
542: &logthis("User $uname at $udom is unknown in authenticate");
543: return 'no_host';
544: }
545: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
546: if ($answer eq 'authorized') {
547: &logthis("User $uname at $udom authorized by $uhome");
548: return $uhome;
549: }
550: if ($answer eq 'non_authorized') {
551: &logthis("User $uname at $udom rejected by $uhome");
552: return 'no_host';
553: }
554: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
555: return 'no_host';
556: }
557:
558: # ---------------------- Find the homebase for a user from domain's lib servers
559:
560: my %homecache;
561: sub homeserver {
562: my ($uname,$udom,$ignoreBadCache)=@_;
563: my $index="$uname:$udom";
564:
565: if (exists($homecache{$index})) { return $homecache{$index}; }
566: my $tryserver;
567: foreach $tryserver (keys %libserv) {
568: next if ($ignoreBadCache ne 'true' &&
569: exists($badServerCache{$tryserver}));
570: if ($hostdom{$tryserver} eq $udom) {
571: my $answer=reply("home:$udom:$uname",$tryserver);
572: if ($answer eq 'found') {
573: return $homecache{$index}=$tryserver;
574: } elsif ($answer eq 'no_host') {
575: $badServerCache{$tryserver}=1;
576: }
577: }
578: }
579: return 'no_host';
580: }
581:
582: # ------------------------------------- Find the usernames behind a list of IDs
583:
584: sub idget {
585: my ($udom,@ids)=@_;
586: my %returnhash=();
587:
588: my $tryserver;
589: foreach $tryserver (keys %libserv) {
590: if ($hostdom{$tryserver} eq $udom) {
591: my $idlist=join('&',@ids);
592: $idlist=~tr/A-Z/a-z/;
593: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
594: my @answer=();
595: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
596: @answer=split(/\&/,$reply);
597: } ;
598: my $i;
599: for ($i=0;$i<=$#ids;$i++) {
600: if ($answer[$i]) {
601: $returnhash{$ids[$i]}=$answer[$i];
602: }
603: }
604: }
605: }
606: return %returnhash;
607: }
608:
609: # ------------------------------------- Find the IDs behind a list of usernames
610:
611: sub idrget {
612: my ($udom,@unames)=@_;
613: my %returnhash=();
614: foreach (@unames) {
615: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
616: }
617: return %returnhash;
618: }
619:
620: # ------------------------------- Store away a list of names and associated IDs
621:
622: sub idput {
623: my ($udom,%ids)=@_;
624: my %servers=();
625: foreach (keys %ids) {
626: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
627: my $uhom=&homeserver($_,$udom);
628: if ($uhom ne 'no_host') {
629: my $id=&escape($ids{$_});
630: $id=~tr/A-Z/a-z/;
631: my $unam=&escape($_);
632: if ($servers{$uhom}) {
633: $servers{$uhom}.='&'.$id.'='.$unam;
634: } else {
635: $servers{$uhom}=$id.'='.$unam;
636: }
637: }
638: }
639: foreach (keys %servers) {
640: &critical('idput:'.$udom.':'.$servers{$_},$_);
641: }
642: }
643:
644: # --------------------------------------------------- Assign a key to a student
645:
646: sub assign_access_key {
647: #
648: # a valid key looks like uname:udom#comments
649: # comments are being appended
650: #
651: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
652: $kdom=
653: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
654: $knum=
655: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
656: $cdom=
657: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
658: $cnum=
659: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
660: $udom=$env{'user.name'} unless (defined($udom));
661: $uname=$env{'user.domain'} unless (defined($uname));
662: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
663: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
664: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
665: # assigned to this person
666: # - this should not happen,
667: # unless something went wrong
668: # the first time around
669: # ready to assign
670: $logentry=$1.'; '.$logentry;
671: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
672: $kdom,$knum) eq 'ok') {
673: # key now belongs to user
674: my $envkey='key.'.$cdom.'_'.$cnum;
675: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
676: &appenv('environment.'.$envkey => $ckey);
677: return 'ok';
678: } else {
679: return
680: 'error: Count not permanently assign key, will need to be re-entered later.';
681: }
682: } else {
683: return 'error: Could not assign key, try again later.';
684: }
685: } elsif (!$existing{$ckey}) {
686: # the key does not exist
687: return 'error: The key does not exist';
688: } else {
689: # the key is somebody else's
690: return 'error: The key is already in use';
691: }
692: }
693:
694: # ------------------------------------------ put an additional comment on a key
695:
696: sub comment_access_key {
697: #
698: # a valid key looks like uname:udom#comments
699: # comments are being appended
700: #
701: my ($ckey,$cdom,$cnum,$logentry)=@_;
702: $cdom=
703: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
704: $cnum=
705: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
706: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
707: if ($existing{$ckey}) {
708: $existing{$ckey}.='; '.$logentry;
709: # ready to assign
710: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
711: $cdom,$cnum) eq 'ok') {
712: return 'ok';
713: } else {
714: return 'error: Count not store comment.';
715: }
716: } else {
717: # the key does not exist
718: return 'error: The key does not exist';
719: }
720: }
721:
722: # ------------------------------------------------------ Generate a set of keys
723:
724: sub generate_access_keys {
725: my ($number,$cdom,$cnum,$logentry)=@_;
726: $cdom=
727: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
728: $cnum=
729: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
730: unless (&allowed('mky',$cdom)) { return 0; }
731: unless (($cdom) && ($cnum)) { return 0; }
732: if ($number>10000) { return 0; }
733: sleep(2); # make sure don't get same seed twice
734: srand(time()^($$+($$<<15))); # from "Programming Perl"
735: my $total=0;
736: for (my $i=1;$i<=$number;$i++) {
737: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
738: sprintf("%lx",int(100000*rand)).'-'.
739: sprintf("%lx",int(100000*rand));
740: $newkey=~s/1/g/g; # folks mix up 1 and l
741: $newkey=~s/0/h/g; # and also 0 and O
742: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
743: if ($existing{$newkey}) {
744: $i--;
745: } else {
746: if (&put('accesskeys',
747: { $newkey => '# generated '.localtime().
748: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
749: '; '.$logentry },
750: $cdom,$cnum) eq 'ok') {
751: $total++;
752: }
753: }
754: }
755: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
756: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
757: return $total;
758: }
759:
760: # ------------------------------------------------------- Validate an accesskey
761:
762: sub validate_access_key {
763: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
764: $cdom=
765: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
766: $cnum=
767: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
768: $udom=$env{'user.domain'} unless (defined($udom));
769: $uname=$env{'user.name'} unless (defined($uname));
770: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
771: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
772: }
773:
774: # ------------------------------------- Find the section of student in a course
775: sub devalidate_getsection_cache {
776: my ($udom,$unam,$courseid)=@_;
777: $courseid=~s/\_/\//g;
778: $courseid=~s/^(\w)/\/$1/;
779: my $hashid="$udom:$unam:$courseid";
780: &devalidate_cache_new('getsection',$hashid);
781: }
782:
783: sub getsection {
784: my ($udom,$unam,$courseid)=@_;
785: my $cachetime=1800;
786: $courseid=~s/\_/\//g;
787: $courseid=~s/^(\w)/\/$1/;
788:
789: my $hashid="$udom:$unam:$courseid";
790: my ($result,$cached)=&is_cached_new('getsection',$hashid);
791: if (defined($cached)) { return $result; }
792:
793: my %Pending;
794: my %Expired;
795: #
796: # Each role can either have not started yet (pending), be active,
797: # or have expired.
798: #
799: # If there is an active role, we are done.
800: #
801: # If there is more than one role which has not started yet,
802: # choose the one which will start sooner
803: # If there is one role which has not started yet, return it.
804: #
805: # If there is more than one expired role, choose the one which ended last.
806: # If there is a role which has expired, return it.
807: #
808: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
809: &homeserver($unam,$udom)))) {
810: my ($key,$value)=split(/\=/,$_);
811: $key=&unescape($key);
812: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
813: my $section=$1;
814: if ($key eq $courseid.'_st') { $section=''; }
815: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
816: my $now=time;
817: if (defined($end) && $end && ($now > $end)) {
818: $Expired{$end}=$section;
819: next;
820: }
821: if (defined($start) && $start && ($now < $start)) {
822: $Pending{$start}=$section;
823: next;
824: }
825: return &do_cache_new('getsection',$hashid,$section,$cachetime);
826: }
827: #
828: # Presumedly there will be few matching roles from the above
829: # loop and the sorting time will be negligible.
830: if (scalar(keys(%Pending))) {
831: my ($time) = sort {$a <=> $b} keys(%Pending);
832: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
833: }
834: if (scalar(keys(%Expired))) {
835: my @sorted = sort {$a <=> $b} keys(%Expired);
836: my $time = pop(@sorted);
837: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
838: }
839: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
840: }
841:
842: sub save_cache {
843: my ($r)=@_;
844: if (! $r->is_initial_req()) { return DECLINED; }
845: &purge_remembered();
846: undef(%env);
847: return OK;
848: }
849:
850: my $to_remember=-1;
851: my %remembered;
852: my %accessed;
853: my $kicks=0;
854: my $hits=0;
855: sub devalidate_cache_new {
856: my ($name,$id,$debug) = @_;
857: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
858: $id=&escape($name.':'.$id);
859: $memcache->delete($id);
860: delete($remembered{$id});
861: delete($accessed{$id});
862: }
863:
864: sub is_cached_new {
865: my ($name,$id,$debug) = @_;
866: $id=&escape($name.':'.$id);
867: if (exists($remembered{$id})) {
868: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
869: $accessed{$id}=[&gettimeofday()];
870: $hits++;
871: return ($remembered{$id},1);
872: }
873: my $value = $memcache->get($id);
874: if (!(defined($value))) {
875: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
876: return (undef,undef);
877: }
878: if ($value eq '__undef__') {
879: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
880: $value=undef;
881: }
882: &make_room($id,$value,$debug);
883: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
884: return ($value,1);
885: }
886:
887: sub do_cache_new {
888: my ($name,$id,$value,$time,$debug) = @_;
889: $id=&escape($name.':'.$id);
890: my $setvalue=$value;
891: if (!defined($setvalue)) {
892: $setvalue='__undef__';
893: }
894: if (!defined($time) ) {
895: $time=600;
896: }
897: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
898: $memcache->set($id,$setvalue,$time);
899: # need to make a copy of $value
900: #&make_room($id,$value,$debug);
901: return $value;
902: }
903:
904: sub make_room {
905: my ($id,$value,$debug)=@_;
906: $remembered{$id}=$value;
907: if ($to_remember<0) { return; }
908: $accessed{$id}=[&gettimeofday()];
909: if (scalar(keys(%remembered)) <= $to_remember) { return; }
910: my $to_kick;
911: my $max_time=0;
912: foreach my $other (keys(%accessed)) {
913: if (&tv_interval($accessed{$other}) > $max_time) {
914: $to_kick=$other;
915: $max_time=&tv_interval($accessed{$other});
916: }
917: }
918: delete($remembered{$to_kick});
919: delete($accessed{$to_kick});
920: $kicks++;
921: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
922: return;
923: }
924:
925: sub purge_remembered {
926: #&logthis("Tossing ".scalar(keys(%remembered)));
927: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
928: undef(%remembered);
929: undef(%accessed);
930: }
931: # ------------------------------------- Read an entry from a user's environment
932:
933: sub userenvironment {
934: my ($udom,$unam,@what)=@_;
935: my %returnhash=();
936: my @answer=split(/\&/,
937: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
938: &homeserver($unam,$udom)));
939: my $i;
940: for ($i=0;$i<=$#what;$i++) {
941: $returnhash{$what[$i]}=&unescape($answer[$i]);
942: }
943: return %returnhash;
944: }
945:
946: # ---------------------------------------------------------- Get a studentphoto
947: sub studentphoto {
948: my ($udom,$unam,$ext) = @_;
949: my $home=&Apache::lonnet::homeserver($unam,$udom);
950: if (defined($env{'request.course.id'})) {
951: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
952: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
953: return(&retrievestudentphoto($udom,$unam,$ext));
954: } else {
955: my ($result,$perm_reqd)=
956: &Apache::lonnet::auto_photo_permission($unam,$udom);
957: if ($result eq 'ok') {
958: if (!($perm_reqd eq 'yes')) {
959: return(&retrievestudentphoto($udom,$unam,$ext));
960: }
961: }
962: }
963: }
964: } else {
965: my ($result,$perm_reqd) =
966: &Apache::lonnet::auto_photo_permission($unam,$udom);
967: if ($result eq 'ok') {
968: if (!($perm_reqd eq 'yes')) {
969: return(&retrievestudentphoto($udom,$unam,$ext));
970: }
971: }
972: }
973: return '/adm/lonKaputt/lonlogo_broken.gif';
974: }
975:
976: sub retrievestudentphoto {
977: my ($udom,$unam,$ext,$type) = @_;
978: my $home=&Apache::lonnet::homeserver($unam,$udom);
979: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
980: if ($ret eq 'ok') {
981: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
982: if ($type eq 'thumbnail') {
983: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
984: }
985: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
986: return $tokenurl;
987: } else {
988: if ($type eq 'thumbnail') {
989: return '/adm/lonKaputt/genericstudent_tn.gif';
990: } else {
991: return '/adm/lonKaputt/lonlogo_broken.gif';
992: }
993: }
994: }
995:
996: # -------------------------------------------------------------------- New chat
997:
998: sub chatsend {
999: my ($newentry,$anon)=@_;
1000: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1001: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1002: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1003: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1004: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1005: &escape($newentry)),$chome);
1006: }
1007:
1008: # ------------------------------------------ Find current version of a resource
1009:
1010: sub getversion {
1011: my $fname=&clutter(shift);
1012: unless ($fname=~/^\/res\//) { return -1; }
1013: return ¤tversion(&filelocation('',$fname));
1014: }
1015:
1016: sub currentversion {
1017: my $fname=shift;
1018: my ($result,$cached)=&is_cached_new('resversion',$fname);
1019: if (defined($cached)) { return $result; }
1020: my $author=$fname;
1021: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1022: my ($udom,$uname)=split(/\//,$author);
1023: my $home=homeserver($uname,$udom);
1024: if ($home eq 'no_host') {
1025: return -1;
1026: }
1027: my $answer=reply("currentversion:$fname",$home);
1028: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1029: return -1;
1030: }
1031: return &do_cache_new('resversion',$fname,$answer,600);
1032: }
1033:
1034: # ----------------------------- Subscribe to a resource, return URL if possible
1035:
1036: sub subscribe {
1037: my $fname=shift;
1038: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1039: $fname=~s/[\n\r]//g;
1040: my $author=$fname;
1041: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1042: my ($udom,$uname)=split(/\//,$author);
1043: my $home=homeserver($uname,$udom);
1044: if ($home eq 'no_host') {
1045: return 'not_found';
1046: }
1047: my $answer=reply("sub:$fname",$home);
1048: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1049: $answer.=' by '.$home;
1050: }
1051: return $answer;
1052: }
1053:
1054: # -------------------------------------------------------------- Replicate file
1055:
1056: sub repcopy {
1057: my $filename=shift;
1058: $filename=~s/\/+/\//g;
1059: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1060: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1061: if ($filename=~m|^/home/httpd/html/userfiles/| or
1062: $filename=~m -^/*(uploaded|editupload)/-) {
1063: return &repcopy_userfile($filename);
1064: }
1065: $filename=~s/[\n\r]//g;
1066: my $transname="$filename.in.transfer";
1067: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1068: my $remoteurl=subscribe($filename);
1069: if ($remoteurl =~ /^con_lost by/) {
1070: &logthis("Subscribe returned $remoteurl: $filename");
1071: return 'unavailable';
1072: } elsif ($remoteurl eq 'not_found') {
1073: #&logthis("Subscribe returned not_found: $filename");
1074: return 'not_found';
1075: } elsif ($remoteurl =~ /^rejected by/) {
1076: &logthis("Subscribe returned $remoteurl: $filename");
1077: return 'forbidden';
1078: } elsif ($remoteurl eq 'directory') {
1079: return 'ok';
1080: } else {
1081: my $author=$filename;
1082: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1083: my ($udom,$uname)=split(/\//,$author);
1084: my $home=homeserver($uname,$udom);
1085: unless ($home eq $perlvar{'lonHostID'}) {
1086: my @parts=split(/\//,$filename);
1087: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1088: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1089: &logthis("Malconfiguration for replication: $filename");
1090: return 'bad_request';
1091: }
1092: my $count;
1093: for ($count=5;$count<$#parts;$count++) {
1094: $path.="/$parts[$count]";
1095: if ((-e $path)!=1) {
1096: mkdir($path,0777);
1097: }
1098: }
1099: my $ua=new LWP::UserAgent;
1100: my $request=new HTTP::Request('GET',"$remoteurl");
1101: my $response=$ua->request($request,$transname);
1102: if ($response->is_error()) {
1103: unlink($transname);
1104: my $message=$response->status_line;
1105: &logthis("<font color=\"blue\">WARNING:"
1106: ." LWP get: $message: $filename</font>");
1107: return 'unavailable';
1108: } else {
1109: if ($remoteurl!~/\.meta$/) {
1110: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1111: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1112: if ($mresponse->is_error()) {
1113: unlink($filename.'.meta');
1114: &logthis(
1115: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1116: }
1117: }
1118: rename($transname,$filename);
1119: return 'ok';
1120: }
1121: }
1122: }
1123: }
1124:
1125: # ------------------------------------------------ Get server side include body
1126: sub ssi_body {
1127: my ($filelink,%form)=@_;
1128: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1129: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1130: }
1131: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1132: &ssi($filelink,%form));
1133: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1134: $output=~s/^.*?\<body[^\>]*\>//si;
1135: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1136: return $output;
1137: }
1138:
1139: # --------------------------------------------------------- Server Side Include
1140:
1141: sub ssi {
1142:
1143: my ($fn,%form)=@_;
1144:
1145: my $ua=new LWP::UserAgent;
1146:
1147: my $request;
1148:
1149: $form{'no_update_last_known'}=1;
1150:
1151: if (%form) {
1152: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1153: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1154: } else {
1155: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1156: }
1157:
1158: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1159: my $response=$ua->request($request);
1160:
1161: return $response->content;
1162: }
1163:
1164: sub externalssi {
1165: my ($url)=@_;
1166: my $ua=new LWP::UserAgent;
1167: my $request=new HTTP::Request('GET',$url);
1168: my $response=$ua->request($request);
1169: return $response->content;
1170: }
1171:
1172: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1173:
1174: sub allowuploaded {
1175: my ($srcurl,$url)=@_;
1176: $url=&clutter(&declutter($url));
1177: my $dir=$url;
1178: $dir=~s/\/[^\/]+$//;
1179: my %httpref=();
1180: my $httpurl=&hreflocation('',$url);
1181: $httpref{'httpref.'.$httpurl}=$srcurl;
1182: &Apache::lonnet::appenv(%httpref);
1183: }
1184:
1185: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1186: # input: action, courseID, current domain, intended
1187: # path to file, source of file, instruction to parse file for objects,
1188: # ref to hash for embedded objects,
1189: # ref to hash for codebase of java objects.
1190: #
1191: # output: url to file (if action was uploaddoc),
1192: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1193: #
1194: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1195: # course.
1196: #
1197: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1198: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1199: # course's home server.
1200: #
1201: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1202: # be copied from $source (current location) to
1203: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1204: # and will then be copied to
1205: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1206: # course's home server.
1207: #
1208: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1209: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1210: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1211: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1212: # in course's home server.
1213: #
1214:
1215: sub process_coursefile {
1216: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1217: my $fetchresult;
1218: my $home=&homeserver($docuname,$docudom);
1219: if ($action eq 'propagate') {
1220: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1221: $home);
1222: } else {
1223: my $fpath = '';
1224: my $fname = $file;
1225: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1226: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1227: my $filepath = &build_filepath($fpath);
1228: if ($action eq 'copy') {
1229: if ($source eq '') {
1230: $fetchresult = 'no source file';
1231: return $fetchresult;
1232: } else {
1233: my $destination = $filepath.'/'.$fname;
1234: rename($source,$destination);
1235: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1236: $home);
1237: }
1238: } elsif ($action eq 'uploaddoc') {
1239: open(my $fh,'>'.$filepath.'/'.$fname);
1240: print $fh $env{'form.'.$source};
1241: close($fh);
1242: if ($parser eq 'parse') {
1243: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1244: unless ($parse_result eq 'ok') {
1245: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1246: }
1247: }
1248: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1249: $home);
1250: if ($fetchresult eq 'ok') {
1251: return '/uploaded/'.$fpath.'/'.$fname;
1252: } else {
1253: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1254: ' to host '.$home.': '.$fetchresult);
1255: return '/adm/notfound.html';
1256: }
1257: }
1258: }
1259: unless ( $fetchresult eq 'ok') {
1260: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1261: ' to host '.$home.': '.$fetchresult);
1262: }
1263: return $fetchresult;
1264: }
1265:
1266: sub build_filepath {
1267: my ($fpath) = @_;
1268: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1269: unless ($fpath eq '') {
1270: my @parts=split('/',$fpath);
1271: foreach my $part (@parts) {
1272: $filepath.= '/'.$part;
1273: if ((-e $filepath)!=1) {
1274: mkdir($filepath,0777);
1275: }
1276: }
1277: }
1278: return $filepath;
1279: }
1280:
1281: sub store_edited_file {
1282: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1283: my $file = $primary_url;
1284: $file =~ s#^/uploaded/$docudom/$docuname/##;
1285: my $fpath = '';
1286: my $fname = $file;
1287: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1288: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1289: my $filepath = &build_filepath($fpath);
1290: open(my $fh,'>'.$filepath.'/'.$fname);
1291: print $fh $content;
1292: close($fh);
1293: my $home=&homeserver($docuname,$docudom);
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: sub clean_filename {
1306: my ($fname)=@_;
1307: # Replace Windows backslashes by forward slashes
1308: $fname=~s/\\/\//g;
1309: # Get rid of everything but the actual filename
1310: $fname=~s/^.*\/([^\/]+)$/$1/;
1311: # Replace spaces by underscores
1312: $fname=~s/\s+/\_/g;
1313: # Replace all other weird characters by nothing
1314: $fname=~s/[^\w\.\-]//g;
1315: # Replace all .\d. sequences with _\d. so they no longer look like version
1316: # numbers
1317: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1318: return $fname;
1319: }
1320:
1321: # --------------- Take an uploaded file and put it into the userfiles directory
1322: # input: $formname - the contents of the file are in $env{"form.$formname"}
1323: # the desired filenam is in $env{"form.$formname"}
1324: # $coursedoc - if true up to the current course
1325: # if false
1326: # $subdir - directory in userfile to store the file into
1327: # $parser, $allfiles, $codebase - unknown
1328: #
1329: # output: url of file in userspace, or error: <message>
1330: # or /adm/notfound.html if failure to upload occurse
1331:
1332:
1333: sub userfileupload {
1334: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase)=@_;
1335: if (!defined($subdir)) { $subdir='unknown'; }
1336: my $fname=$env{'form.'.$formname.'.filename'};
1337: $fname=&clean_filename($fname);
1338: # See if there is anything left
1339: unless ($fname) { return 'error: no uploaded file'; }
1340: chop($env{'form.'.$formname});
1341: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1342: my $now = time;
1343: my $filepath = 'tmp/helprequests/'.$now;
1344: my @parts=split(/\//,$filepath);
1345: my $fullpath = $perlvar{'lonDaemons'};
1346: for (my $i=0;$i<@parts;$i++) {
1347: $fullpath .= '/'.$parts[$i];
1348: if ((-e $fullpath)!=1) {
1349: mkdir($fullpath,0777);
1350: }
1351: }
1352: open(my $fh,'>'.$fullpath.'/'.$fname);
1353: print $fh $env{'form.'.$formname};
1354: close($fh);
1355: return $fullpath.'/'.$fname;
1356: }
1357: # Create the directory if not present
1358: $fname="$subdir/$fname";
1359: if ($coursedoc) {
1360: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1361: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1362: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1363: return &finishuserfileupload($docuname,$docudom,
1364: $formname,$fname,$parser,$allfiles,
1365: $codebase);
1366: } else {
1367: $fname=$env{'form.folder'}.'/'.$fname;
1368: return &process_coursefile('uploaddoc',$docuname,$docudom,
1369: $fname,$formname,$parser,
1370: $allfiles,$codebase);
1371: }
1372: } else {
1373: my $docuname=$env{'user.name'};
1374: my $docudom=$env{'user.domain'};
1375: if (exists($env{'form.group'})) {
1376: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1377: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1378: }
1379: return &finishuserfileupload($docuname,$docudom,$formname,
1380: $fname,$parser,$allfiles,$codebase);
1381: }
1382: }
1383:
1384: sub finishuserfileupload {
1385: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1386: my $path=$docudom.'/'.$docuname.'/';
1387: my $filepath=$perlvar{'lonDocRoot'};
1388: my ($fnamepath,$file);
1389: $file=$fname;
1390: if ($fname=~m|/|) {
1391: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1392: $path.=$fnamepath.'/';
1393: }
1394: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1395: my $count;
1396: for ($count=4;$count<=$#parts;$count++) {
1397: $filepath.="/$parts[$count]";
1398: if ((-e $filepath)!=1) {
1399: mkdir($filepath,0777);
1400: }
1401: }
1402: # Save the file
1403: {
1404: if (!open(FH,'>'.$filepath.'/'.$file)) {
1405: &logthis('Failed to create '.$filepath.'/'.$file);
1406: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1407: return '/adm/notfound.html';
1408: }
1409: if (!print FH ($env{'form.'.$formname})) {
1410: &logthis('Failed to write to '.$filepath.'/'.$file);
1411: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1412: return '/adm/notfound.html';
1413: }
1414: close(FH);
1415: }
1416: if ($parser eq 'parse') {
1417: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1418: $codebase);
1419: unless ($parse_result eq 'ok') {
1420: &logthis('Failed to parse '.$filepath.$file.
1421: ' for embedded media: '.$parse_result);
1422: }
1423: }
1424: # Notify homeserver to grep it
1425: #
1426: my $docuhome=&homeserver($docuname,$docudom);
1427: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1428: if ($fetchresult eq 'ok') {
1429: #
1430: # Return the URL to it
1431: return '/uploaded/'.$path.$file;
1432: } else {
1433: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1434: ': '.$fetchresult);
1435: return '/adm/notfound.html';
1436: }
1437: }
1438:
1439: sub extract_embedded_items {
1440: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1441: my @state = ();
1442: my %javafiles = (
1443: codebase => '',
1444: code => '',
1445: archive => ''
1446: );
1447: my %mediafiles = (
1448: src => '',
1449: movie => '',
1450: );
1451: my $p;
1452: if ($content) {
1453: $p = HTML::LCParser->new($content);
1454: } else {
1455: $p = HTML::LCParser->new($filepath.'/'.$file);
1456: }
1457: while (my $t=$p->get_token()) {
1458: if ($t->[0] eq 'S') {
1459: my ($tagname, $attr) = ($t->[1],$t->[2]);
1460: push (@state, $tagname);
1461: if (lc($tagname) eq 'allow') {
1462: &add_filetype($allfiles,$attr->{'src'},'src');
1463: }
1464: if (lc($tagname) eq 'img') {
1465: &add_filetype($allfiles,$attr->{'src'},'src');
1466: }
1467: if (lc($tagname) eq 'script') {
1468: if ($attr->{'archive'} =~ /\.jar$/i) {
1469: &add_filetype($allfiles,$attr->{'archive'},'archive');
1470: } else {
1471: &add_filetype($allfiles,$attr->{'src'},'src');
1472: }
1473: }
1474: if (lc($tagname) eq 'link') {
1475: if (lc($attr->{'rel'}) eq 'stylesheet') {
1476: &add_filetype($allfiles,$attr->{'href'},'href');
1477: }
1478: }
1479: if (lc($tagname) eq 'object' ||
1480: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1481: foreach my $item (keys(%javafiles)) {
1482: $javafiles{$item} = '';
1483: }
1484: }
1485: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1486: my $name = lc($attr->{'name'});
1487: foreach my $item (keys(%javafiles)) {
1488: if ($name eq $item) {
1489: $javafiles{$item} = $attr->{'value'};
1490: last;
1491: }
1492: }
1493: foreach my $item (keys(%mediafiles)) {
1494: if ($name eq $item) {
1495: &add_filetype($allfiles, $attr->{'value'}, 'value');
1496: last;
1497: }
1498: }
1499: }
1500: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1501: foreach my $item (keys(%javafiles)) {
1502: if ($attr->{$item}) {
1503: $javafiles{$item} = $attr->{$item};
1504: last;
1505: }
1506: }
1507: foreach my $item (keys(%mediafiles)) {
1508: if ($attr->{$item}) {
1509: &add_filetype($allfiles,$attr->{$item},$item);
1510: last;
1511: }
1512: }
1513: }
1514: } elsif ($t->[0] eq 'E') {
1515: my ($tagname) = ($t->[1]);
1516: if ($javafiles{'codebase'} ne '') {
1517: $javafiles{'codebase'} .= '/';
1518: }
1519: if (lc($tagname) eq 'applet' ||
1520: lc($tagname) eq 'object' ||
1521: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1522: ) {
1523: foreach my $item (keys(%javafiles)) {
1524: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1525: my $file=$javafiles{'codebase'}.$javafiles{$item};
1526: &add_filetype($allfiles,$file,$item);
1527: }
1528: }
1529: }
1530: pop @state;
1531: }
1532: }
1533: return 'ok';
1534: }
1535:
1536: sub add_filetype {
1537: my ($allfiles,$file,$type)=@_;
1538: if (exists($allfiles->{$file})) {
1539: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1540: push(@{$allfiles->{$file}}, &escape($type));
1541: }
1542: } else {
1543: @{$allfiles->{$file}} = (&escape($type));
1544: }
1545: }
1546:
1547: sub removeuploadedurl {
1548: my ($url)=@_;
1549: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1550: return &removeuserfile($uname,$udom,$fname);
1551: }
1552:
1553: sub removeuserfile {
1554: my ($docuname,$docudom,$fname)=@_;
1555: my $home=&homeserver($docuname,$docudom);
1556: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1557: }
1558:
1559: sub mkdiruserfile {
1560: my ($docuname,$docudom,$dir)=@_;
1561: my $home=&homeserver($docuname,$docudom);
1562: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1563: }
1564:
1565: sub renameuserfile {
1566: my ($docuname,$docudom,$old,$new)=@_;
1567: my $home=&homeserver($docuname,$docudom);
1568: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1569: &escape("$new"),$home);
1570: }
1571:
1572: # ------------------------------------------------------------------------- Log
1573:
1574: sub log {
1575: my ($dom,$nam,$hom,$what)=@_;
1576: return critical("log:$dom:$nam:$what",$hom);
1577: }
1578:
1579: # ------------------------------------------------------------------ Course Log
1580: #
1581: # This routine flushes several buffers of non-mission-critical nature
1582: #
1583:
1584: sub flushcourselogs {
1585: &logthis('Flushing log buffers');
1586: #
1587: # course logs
1588: # This is a log of all transactions in a course, which can be used
1589: # for data mining purposes
1590: #
1591: # It also collects the courseid database, which lists last transaction
1592: # times and course titles for all courseids
1593: #
1594: my %courseidbuffer=();
1595: foreach (keys %courselogs) {
1596: my $crsid=$_;
1597: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1598: &escape($courselogs{$crsid}),
1599: $coursehombuf{$crsid}) eq 'ok') {
1600: delete $courselogs{$crsid};
1601: } else {
1602: &logthis('Failed to flush log buffer for '.$crsid);
1603: if (length($courselogs{$crsid})>40000) {
1604: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1605: " exceeded maximum size, deleting.</font>");
1606: delete $courselogs{$crsid};
1607: }
1608: }
1609: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1610: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1611: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1612: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid});
1613: } else {
1614: $courseidbuffer{$coursehombuf{$crsid}}=
1615: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1616: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid});
1617: }
1618: }
1619: #
1620: # Write course id database (reverse lookup) to homeserver of courses
1621: # Is used in pickcourse
1622: #
1623: foreach (keys %courseidbuffer) {
1624: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1625: }
1626: #
1627: # File accesses
1628: # Writes to the dynamic metadata of resources to get hit counts, etc.
1629: #
1630: foreach my $entry (keys(%accesshash)) {
1631: if ($entry =~ /___count$/) {
1632: my ($dom,$name);
1633: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1634: if (! defined($dom) || $dom eq '' ||
1635: ! defined($name) || $name eq '') {
1636: my $cid = $env{'request.course.id'};
1637: $dom = $env{'request.'.$cid.'.domain'};
1638: $name = $env{'request.'.$cid.'.num'};
1639: }
1640: my $value = $accesshash{$entry};
1641: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1642: my %temphash=($url => $value);
1643: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1644: if ($result eq 'ok') {
1645: delete $accesshash{$entry};
1646: } elsif ($result eq 'unknown_cmd') {
1647: # Target server has old code running on it.
1648: my %temphash=($entry => $value);
1649: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1650: delete $accesshash{$entry};
1651: }
1652: }
1653: } else {
1654: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1655: my %temphash=($entry => $accesshash{$entry});
1656: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1657: delete $accesshash{$entry};
1658: }
1659: }
1660: }
1661: #
1662: # Roles
1663: # Reverse lookup of user roles for course faculty/staff and co-authorship
1664: #
1665: foreach (keys %userrolehash) {
1666: my $entry=$_;
1667: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1668: split(/\:/,$entry);
1669: if (&Apache::lonnet::put('nohist_userroles',
1670: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1671: $rudom,$runame) eq 'ok') {
1672: delete $userrolehash{$entry};
1673: }
1674: }
1675: #
1676: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1677: #
1678: my %domrolebuffer = ();
1679: foreach my $entry (keys %domainrolehash) {
1680: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1681: if ($domrolebuffer{$rudom}) {
1682: $domrolebuffer{$rudom}.='&'.&escape($entry).
1683: '='.&escape($domainrolehash{$entry});
1684: } else {
1685: $domrolebuffer{$rudom}.=&escape($entry).
1686: '='.&escape($domainrolehash{$entry});
1687: }
1688: delete $domainrolehash{$entry};
1689: }
1690: foreach my $dom (keys(%domrolebuffer)) {
1691: foreach my $tryserver (keys %libserv) {
1692: if ($hostdom{$tryserver} eq $dom) {
1693: unless (&reply('domroleput:'.$dom.':'.
1694: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1695: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1696: }
1697: }
1698: }
1699: }
1700: $dumpcount++;
1701: }
1702:
1703: sub courselog {
1704: my $what=shift;
1705: $what=time.':'.$what;
1706: unless ($env{'request.course.id'}) { return ''; }
1707: $coursedombuf{$env{'request.course.id'}}=
1708: $env{'course.'.$env{'request.course.id'}.'.domain'};
1709: $coursenumbuf{$env{'request.course.id'}}=
1710: $env{'course.'.$env{'request.course.id'}.'.num'};
1711: $coursehombuf{$env{'request.course.id'}}=
1712: $env{'course.'.$env{'request.course.id'}.'.home'};
1713: $coursedescrbuf{$env{'request.course.id'}}=
1714: $env{'course.'.$env{'request.course.id'}.'.description'};
1715: $courseinstcodebuf{$env{'request.course.id'}}=
1716: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1717: $courseownerbuf{$env{'request.course.id'}}=
1718: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1719: if (defined $courselogs{$env{'request.course.id'}}) {
1720: $courselogs{$env{'request.course.id'}}.='&'.$what;
1721: } else {
1722: $courselogs{$env{'request.course.id'}}.=$what;
1723: }
1724: if (length($courselogs{$env{'request.course.id'}})>4048) {
1725: &flushcourselogs();
1726: }
1727: }
1728:
1729: sub courseacclog {
1730: my $fnsymb=shift;
1731: unless ($env{'request.course.id'}) { return ''; }
1732: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1733: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1734: $what.=':POST';
1735: # FIXME: Probably ought to escape things....
1736: foreach (keys %env) {
1737: if ($_=~/^form\.(.*)/) {
1738: $what.=':'.$1.'='.$env{$_};
1739: }
1740: }
1741: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1742: # FIXME: We should not be depending on a form parameter that someone
1743: # editing lonsearchcat.pm might change in the future.
1744: if ($env{'form.phase'} eq 'course_search') {
1745: $what.= ':POST';
1746: # FIXME: Probably ought to escape things....
1747: foreach my $element ('courseexp','crsfulltext','crsrelated',
1748: 'crsdiscuss') {
1749: $what.=':'.$element.'='.$env{'form.'.$element};
1750: }
1751: }
1752: }
1753: &courselog($what);
1754: }
1755:
1756: sub countacc {
1757: my $url=&declutter(shift);
1758: return if (! defined($url) || $url eq '');
1759: unless ($env{'request.course.id'}) { return ''; }
1760: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1761: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1762: $accesshash{$key}++;
1763: }
1764:
1765: sub linklog {
1766: my ($from,$to)=@_;
1767: $from=&declutter($from);
1768: $to=&declutter($to);
1769: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1770: $accesshash{$to.'___'.$from.'___goto'}=1;
1771: }
1772:
1773: sub userrolelog {
1774: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1775: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1776: ($trole=~/^in/) || ($trole=~/^cc/) ||
1777: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1778: ($trole=~/^ta/)) {
1779: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1780: $userrolehash
1781: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1782: =$tend.':'.$tstart;
1783: }
1784: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1785: ($trole=~/^li/) || ($trole=~/^li/) ||
1786: ($trole=~/^au/) || ($trole=~/^dg/) ||
1787: ($trole=~/^sc/)) {
1788: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1789: $domainrolehash
1790: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1791: = $tend.':'.$tstart;
1792: }
1793: }
1794:
1795: sub get_course_adv_roles {
1796: my $cid=shift;
1797: $cid=$env{'request.course.id'} unless (defined($cid));
1798: my %coursehash=&coursedescription($cid);
1799: my %nothide=();
1800: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1801: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1802: }
1803: my %returnhash=();
1804: my %dumphash=
1805: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1806: my $now=time;
1807: foreach (keys %dumphash) {
1808: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1809: if (($tstart) && ($tstart<0)) { next; }
1810: if (($tend) && ($tend<$now)) { next; }
1811: if (($tstart) && ($now<$tstart)) { next; }
1812: my ($role,$username,$domain,$section)=split(/\:/,$_);
1813: if ($username eq '' || $domain eq '') { next; }
1814: if ((&privileged($username,$domain)) &&
1815: (!$nothide{$username.':'.$domain})) { next; }
1816: if ($role eq 'cr') { next; }
1817: my $key=&plaintext($role);
1818: if ($role =~ /^cr/) {
1819: $key=(split('/',$role))[3];
1820: }
1821: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1822: if ($returnhash{$key}) {
1823: $returnhash{$key}.=','.$username.':'.$domain;
1824: } else {
1825: $returnhash{$key}=$username.':'.$domain;
1826: }
1827: }
1828: return %returnhash;
1829: }
1830:
1831: sub get_my_roles {
1832: my ($uname,$udom)=@_;
1833: unless (defined($uname)) { $uname=$env{'user.name'}; }
1834: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1835: my %dumphash=
1836: &dump('nohist_userroles',$udom,$uname);
1837: my %returnhash=();
1838: my $now=time;
1839: foreach (keys %dumphash) {
1840: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1841: if (($tstart) && ($tstart<0)) { next; }
1842: if (($tend) && ($tend<$now)) { next; }
1843: if (($tstart) && ($now<$tstart)) { next; }
1844: my ($role,$username,$domain,$section)=split(/\:/,$_);
1845: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1846: }
1847: return %returnhash;
1848: }
1849:
1850: # ----------------------------------------------------- Frontpage Announcements
1851: #
1852: #
1853:
1854: sub postannounce {
1855: my ($server,$text)=@_;
1856: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1857: unless ($text=~/\w/) { $text=''; }
1858: return &reply('setannounce:'.&escape($text),$server);
1859: }
1860:
1861: sub getannounce {
1862:
1863: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1864: my $announcement='';
1865: while (<$fh>) { $announcement .=$_; }
1866: close($fh);
1867: if ($announcement=~/\w/) {
1868: return
1869: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1870: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1871: } else {
1872: return '';
1873: }
1874: } else {
1875: return '';
1876: }
1877: }
1878:
1879: # ---------------------------------------------------------- Course ID routines
1880: # Deal with domain's nohist_courseid.db files
1881: #
1882:
1883: sub courseidput {
1884: my ($domain,$what,$coursehome)=@_;
1885: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1886: }
1887:
1888: sub courseiddump {
1889: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref)=@_;
1890: my %returnhash=();
1891: unless ($domfilter) { $domfilter=''; }
1892: foreach my $tryserver (keys %libserv) {
1893: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1894: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1895: foreach (
1896: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1897: $sincefilter.':'.&escape($descfilter).':'.
1898: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter),
1899: $tryserver))) {
1900: my ($key,$value)=split(/\=/,$_);
1901: if (($key) && ($value)) {
1902: $returnhash{&unescape($key)}=$value;
1903: }
1904: }
1905: }
1906: }
1907: }
1908: return %returnhash;
1909: }
1910:
1911: # ---------------------------------------------------------- DC e-mail
1912:
1913: sub dcmailput {
1914: my ($domain,$msgid,$message,$server)=@_;
1915: my $status = &Apache::lonnet::critical(
1916: 'dcmailput:'.$domain.':'.&Apache::lonnet::escape($msgid).'='.
1917: &Apache::lonnet::escape($message),$server);
1918: return $status;
1919: }
1920:
1921: sub dcmaildump {
1922: my ($dom,$startdate,$enddate,$senders) = @_;
1923: my %returnhash=();
1924: if (exists($domain_primary{$dom})) {
1925: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1926: &escape($enddate).':';
1927: my @esc_senders=map { &escape($_)} @$senders;
1928: $cmd.=&escape(join('&',@esc_senders));
1929: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1930: my ($key,$value) = split(/\=/,$_);
1931: if (($key) && ($value)) {
1932: $returnhash{&unescape($key)} = &unescape($value);
1933: }
1934: }
1935: }
1936: return %returnhash;
1937: }
1938: # ---------------------------------------------------------- Domain roles
1939:
1940: sub get_domain_roles {
1941: my ($dom,$roles,$startdate,$enddate)=@_;
1942: if (undef($startdate) || $startdate eq '') {
1943: $startdate = '.';
1944: }
1945: if (undef($enddate) || $enddate eq '') {
1946: $enddate = '.';
1947: }
1948: my $rolelist = join(':',@{$roles});
1949: my %personnel = ();
1950: foreach my $tryserver (keys(%libserv)) {
1951: if ($hostdom{$tryserver} eq $dom) {
1952: %{$personnel{$tryserver}}=();
1953: foreach (
1954: split(/\&/,&reply('domrolesdump:'.$dom.':'.
1955: &escape($startdate).':'.&escape($enddate).':'.
1956: &escape($rolelist), $tryserver))) {
1957: my($key,$value) = split(/\=/,$_);
1958: if (($key) && ($value)) {
1959: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
1960: }
1961: }
1962: }
1963: }
1964: return %personnel;
1965: }
1966:
1967: # ----------------------------------------------------------- Check out an item
1968:
1969: sub get_first_access {
1970: my ($type,$argsymb)=@_;
1971: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
1972: if ($argsymb) { $symb=$argsymb; }
1973: my ($map,$id,$res)=&decode_symb($symb);
1974: if ($type eq 'map') {
1975: $res=&symbread($map);
1976: } else {
1977: $res=$symb;
1978: }
1979: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
1980: return $times{"$courseid\0$res"};
1981: }
1982:
1983: sub set_first_access {
1984: my ($type)=@_;
1985: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
1986: my ($map,$id,$res)=&decode_symb($symb);
1987: if ($type eq 'map') {
1988: $res=&symbread($map);
1989: } else {
1990: $res=$symb;
1991: }
1992: my $firstaccess=&get_first_access($type,$symb);
1993: if (!$firstaccess) {
1994: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1995: }
1996: return 'already_set';
1997: }
1998:
1999: sub checkout {
2000: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2001: my $now=time;
2002: my $lonhost=$perlvar{'lonHostID'};
2003: my $infostr=&escape(
2004: 'CHECKOUTTOKEN&'.
2005: $tuname.'&'.
2006: $tudom.'&'.
2007: $tcrsid.'&'.
2008: $symb.'&'.
2009: $now.'&'.$ENV{'REMOTE_ADDR'});
2010: my $token=&reply('tmpput:'.$infostr,$lonhost);
2011: if ($token=~/^error\:/) {
2012: &logthis("<font color=\"blue\">WARNING: ".
2013: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2014: "</font>");
2015: return '';
2016: }
2017:
2018: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2019: $token=~tr/a-z/A-Z/;
2020:
2021: my %infohash=('resource.0.outtoken' => $token,
2022: 'resource.0.checkouttime' => $now,
2023: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2024:
2025: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2026: return '';
2027: } else {
2028: &logthis("<font color=\"blue\">WARNING: ".
2029: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2030: "</font>");
2031: }
2032:
2033: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2034: &escape('Checkout '.$infostr.' - '.
2035: $token)) ne 'ok') {
2036: return '';
2037: } else {
2038: &logthis("<font color=\"blue\">WARNING: ".
2039: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2040: "</font>");
2041: }
2042: return $token;
2043: }
2044:
2045: # ------------------------------------------------------------ Check in an item
2046:
2047: sub checkin {
2048: my $token=shift;
2049: my $now=time;
2050: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2051: $lonhost=~tr/A-Z/a-z/;
2052: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2053: $dtoken=~s/\W/\_/g;
2054: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2055: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2056:
2057: unless (($tuname) && ($tudom)) {
2058: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2059: return '';
2060: }
2061:
2062: unless (&allowed('mgr',$tcrsid)) {
2063: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2064: $env{'user.name'}.' - '.$env{'user.domain'});
2065: return '';
2066: }
2067:
2068: my %infohash=('resource.0.intoken' => $token,
2069: 'resource.0.checkintime' => $now,
2070: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2071:
2072: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2073: return '';
2074: }
2075:
2076: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2077: &escape('Checkin - '.$token)) ne 'ok') {
2078: return '';
2079: }
2080:
2081: return ($symb,$tuname,$tudom,$tcrsid);
2082: }
2083:
2084: # --------------------------------------------- Set Expire Date for Spreadsheet
2085:
2086: sub expirespread {
2087: my ($uname,$udom,$stype,$usymb)=@_;
2088: my $cid=$env{'request.course.id'};
2089: if ($cid) {
2090: my $now=time;
2091: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2092: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2093: $env{'course.'.$cid.'.num'}.
2094: ':nohist_expirationdates:'.
2095: &escape($key).'='.$now,
2096: $env{'course.'.$cid.'.home'})
2097: }
2098: return 'ok';
2099: }
2100:
2101: # ----------------------------------------------------- Devalidate Spreadsheets
2102:
2103: sub devalidate {
2104: my ($symb,$uname,$udom)=@_;
2105: my $cid=$env{'request.course.id'};
2106: if ($cid) {
2107: # delete the stored spreadsheets for
2108: # - the student level sheet of this user in course's homespace
2109: # - the assessment level sheet for this resource
2110: # for this user in user's homespace
2111: # - current conditional state info
2112: my $key=$uname.':'.$udom.':';
2113: my $status=
2114: &del('nohist_calculatedsheets',
2115: [$key.'studentcalc:'],
2116: $env{'course.'.$cid.'.domain'},
2117: $env{'course.'.$cid.'.num'})
2118: .' '.
2119: &del('nohist_calculatedsheets_'.$cid,
2120: [$key.'assesscalc:'.$symb],$udom,$uname);
2121: unless ($status eq 'ok ok') {
2122: &logthis('Could not devalidate spreadsheet '.
2123: $uname.' at '.$udom.' for '.
2124: $symb.': '.$status);
2125: }
2126: &delenv('user.state.'.$cid);
2127: }
2128: }
2129:
2130: sub get_scalar {
2131: my ($string,$end) = @_;
2132: my $value;
2133: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2134: $value = $1;
2135: } elsif ($$string =~ s/^([^&]*?)&//) {
2136: $value = $1;
2137: }
2138: return &unescape($value);
2139: }
2140:
2141: sub array2str {
2142: my (@array) = @_;
2143: my $result=&arrayref2str(\@array);
2144: $result=~s/^__ARRAY_REF__//;
2145: $result=~s/__END_ARRAY_REF__$//;
2146: return $result;
2147: }
2148:
2149: sub arrayref2str {
2150: my ($arrayref) = @_;
2151: my $result='__ARRAY_REF__';
2152: foreach my $elem (@$arrayref) {
2153: if(ref($elem) eq 'ARRAY') {
2154: $result.=&arrayref2str($elem).'&';
2155: } elsif(ref($elem) eq 'HASH') {
2156: $result.=&hashref2str($elem).'&';
2157: } elsif(ref($elem)) {
2158: #print("Got a ref of ".(ref($elem))." skipping.");
2159: } else {
2160: $result.=&escape($elem).'&';
2161: }
2162: }
2163: $result=~s/\&$//;
2164: $result .= '__END_ARRAY_REF__';
2165: return $result;
2166: }
2167:
2168: sub hash2str {
2169: my (%hash) = @_;
2170: my $result=&hashref2str(\%hash);
2171: $result=~s/^__HASH_REF__//;
2172: $result=~s/__END_HASH_REF__$//;
2173: return $result;
2174: }
2175:
2176: sub hashref2str {
2177: my ($hashref)=@_;
2178: my $result='__HASH_REF__';
2179: foreach (sort(keys(%$hashref))) {
2180: if (ref($_) eq 'ARRAY') {
2181: $result.=&arrayref2str($_).'=';
2182: } elsif (ref($_) eq 'HASH') {
2183: $result.=&hashref2str($_).'=';
2184: } elsif (ref($_)) {
2185: $result.='=';
2186: #print("Got a ref of ".(ref($_))." skipping.");
2187: } else {
2188: if ($_) {$result.=&escape($_).'=';} else { last; }
2189: }
2190:
2191: if(ref($hashref->{$_}) eq 'ARRAY') {
2192: $result.=&arrayref2str($hashref->{$_}).'&';
2193: } elsif(ref($hashref->{$_}) eq 'HASH') {
2194: $result.=&hashref2str($hashref->{$_}).'&';
2195: } elsif(ref($hashref->{$_})) {
2196: $result.='&';
2197: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2198: } else {
2199: $result.=&escape($hashref->{$_}).'&';
2200: }
2201: }
2202: $result=~s/\&$//;
2203: $result .= '__END_HASH_REF__';
2204: return $result;
2205: }
2206:
2207: sub str2hash {
2208: my ($string)=@_;
2209: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2210: return %$hash;
2211: }
2212:
2213: sub str2hashref {
2214: my ($string) = @_;
2215:
2216: my %hash;
2217:
2218: if($string !~ /^__HASH_REF__/) {
2219: if (! ($string eq '' || !defined($string))) {
2220: $hash{'error'}='Not hash reference';
2221: }
2222: return (\%hash, $string);
2223: }
2224:
2225: $string =~ s/^__HASH_REF__//;
2226:
2227: while($string !~ /^__END_HASH_REF__/) {
2228: #key
2229: my $key='';
2230: if($string =~ /^__HASH_REF__/) {
2231: ($key, $string)=&str2hashref($string);
2232: if(defined($key->{'error'})) {
2233: $hash{'error'}='Bad data';
2234: return (\%hash, $string);
2235: }
2236: } elsif($string =~ /^__ARRAY_REF__/) {
2237: ($key, $string)=&str2arrayref($string);
2238: if($key->[0] eq 'Array reference error') {
2239: $hash{'error'}='Bad data';
2240: return (\%hash, $string);
2241: }
2242: } else {
2243: $string =~ s/^(.*?)=//;
2244: $key=&unescape($1);
2245: }
2246: $string =~ s/^=//;
2247:
2248: #value
2249: my $value='';
2250: if($string =~ /^__HASH_REF__/) {
2251: ($value, $string)=&str2hashref($string);
2252: if(defined($value->{'error'})) {
2253: $hash{'error'}='Bad data';
2254: return (\%hash, $string);
2255: }
2256: } elsif($string =~ /^__ARRAY_REF__/) {
2257: ($value, $string)=&str2arrayref($string);
2258: if($value->[0] eq 'Array reference error') {
2259: $hash{'error'}='Bad data';
2260: return (\%hash, $string);
2261: }
2262: } else {
2263: $value=&get_scalar(\$string,'__END_HASH_REF__');
2264: }
2265: $string =~ s/^&//;
2266:
2267: $hash{$key}=$value;
2268: }
2269:
2270: $string =~ s/^__END_HASH_REF__//;
2271:
2272: return (\%hash, $string);
2273: }
2274:
2275: sub str2array {
2276: my ($string)=@_;
2277: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2278: return @$array;
2279: }
2280:
2281: sub str2arrayref {
2282: my ($string) = @_;
2283: my @array;
2284:
2285: if($string !~ /^__ARRAY_REF__/) {
2286: if (! ($string eq '' || !defined($string))) {
2287: $array[0]='Array reference error';
2288: }
2289: return (\@array, $string);
2290: }
2291:
2292: $string =~ s/^__ARRAY_REF__//;
2293:
2294: while($string !~ /^__END_ARRAY_REF__/) {
2295: my $value='';
2296: if($string =~ /^__HASH_REF__/) {
2297: ($value, $string)=&str2hashref($string);
2298: if(defined($value->{'error'})) {
2299: $array[0] ='Array reference error';
2300: return (\@array, $string);
2301: }
2302: } elsif($string =~ /^__ARRAY_REF__/) {
2303: ($value, $string)=&str2arrayref($string);
2304: if($value->[0] eq 'Array reference error') {
2305: $array[0] ='Array reference error';
2306: return (\@array, $string);
2307: }
2308: } else {
2309: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2310: }
2311: $string =~ s/^&//;
2312:
2313: push(@array, $value);
2314: }
2315:
2316: $string =~ s/^__END_ARRAY_REF__//;
2317:
2318: return (\@array, $string);
2319: }
2320:
2321: # -------------------------------------------------------------------Temp Store
2322:
2323: sub tmpreset {
2324: my ($symb,$namespace,$domain,$stuname) = @_;
2325: if (!$symb) {
2326: $symb=&symbread();
2327: if (!$symb) { $symb= $env{'request.url'}; }
2328: }
2329: $symb=escape($symb);
2330:
2331: if (!$namespace) { $namespace=$env{'request.state'}; }
2332: $namespace=~s/\//\_/g;
2333: $namespace=~s/\W//g;
2334:
2335: if (!$domain) { $domain=$env{'user.domain'}; }
2336: if (!$stuname) { $stuname=$env{'user.name'}; }
2337: if ($domain eq 'public' && $stuname eq 'public') {
2338: $stuname=$ENV{'REMOTE_ADDR'};
2339: }
2340: my $path=$perlvar{'lonDaemons'}.'/tmp';
2341: my %hash;
2342: if (tie(%hash,'GDBM_File',
2343: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2344: &GDBM_WRCREAT(),0640)) {
2345: foreach my $key (keys %hash) {
2346: if ($key=~ /:$symb/) {
2347: delete($hash{$key});
2348: }
2349: }
2350: }
2351: }
2352:
2353: sub tmpstore {
2354: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2355:
2356: if (!$symb) {
2357: $symb=&symbread();
2358: if (!$symb) { $symb= $env{'request.url'}; }
2359: }
2360: $symb=escape($symb);
2361:
2362: if (!$namespace) {
2363: # I don't think we would ever want to store this for a course.
2364: # it seems this will only be used if we don't have a course.
2365: #$namespace=$env{'request.course.id'};
2366: #if (!$namespace) {
2367: $namespace=$env{'request.state'};
2368: #}
2369: }
2370: $namespace=~s/\//\_/g;
2371: $namespace=~s/\W//g;
2372: if (!$domain) { $domain=$env{'user.domain'}; }
2373: if (!$stuname) { $stuname=$env{'user.name'}; }
2374: if ($domain eq 'public' && $stuname eq 'public') {
2375: $stuname=$ENV{'REMOTE_ADDR'};
2376: }
2377: my $now=time;
2378: my %hash;
2379: my $path=$perlvar{'lonDaemons'}.'/tmp';
2380: if (tie(%hash,'GDBM_File',
2381: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2382: &GDBM_WRCREAT(),0640)) {
2383: $hash{"version:$symb"}++;
2384: my $version=$hash{"version:$symb"};
2385: my $allkeys='';
2386: foreach my $key (keys(%$storehash)) {
2387: $allkeys.=$key.':';
2388: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2389: }
2390: $hash{"$version:$symb:timestamp"}=$now;
2391: $allkeys.='timestamp';
2392: $hash{"$version:keys:$symb"}=$allkeys;
2393: if (untie(%hash)) {
2394: return 'ok';
2395: } else {
2396: return "error:$!";
2397: }
2398: } else {
2399: return "error:$!";
2400: }
2401: }
2402:
2403: # -----------------------------------------------------------------Temp Restore
2404:
2405: sub tmprestore {
2406: my ($symb,$namespace,$domain,$stuname) = @_;
2407:
2408: if (!$symb) {
2409: $symb=&symbread();
2410: if (!$symb) { $symb= $env{'request.url'}; }
2411: }
2412: $symb=escape($symb);
2413:
2414: if (!$namespace) { $namespace=$env{'request.state'}; }
2415:
2416: if (!$domain) { $domain=$env{'user.domain'}; }
2417: if (!$stuname) { $stuname=$env{'user.name'}; }
2418: if ($domain eq 'public' && $stuname eq 'public') {
2419: $stuname=$ENV{'REMOTE_ADDR'};
2420: }
2421: my %returnhash;
2422: $namespace=~s/\//\_/g;
2423: $namespace=~s/\W//g;
2424: my %hash;
2425: my $path=$perlvar{'lonDaemons'}.'/tmp';
2426: if (tie(%hash,'GDBM_File',
2427: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2428: &GDBM_READER(),0640)) {
2429: my $version=$hash{"version:$symb"};
2430: $returnhash{'version'}=$version;
2431: my $scope;
2432: for ($scope=1;$scope<=$version;$scope++) {
2433: my $vkeys=$hash{"$scope:keys:$symb"};
2434: my @keys=split(/:/,$vkeys);
2435: my $key;
2436: $returnhash{"$scope:keys"}=$vkeys;
2437: foreach $key (@keys) {
2438: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2439: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2440: }
2441: }
2442: if (!(untie(%hash))) {
2443: return "error:$!";
2444: }
2445: } else {
2446: return "error:$!";
2447: }
2448: return %returnhash;
2449: }
2450:
2451: # ----------------------------------------------------------------------- Store
2452:
2453: sub store {
2454: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2455: my $home='';
2456:
2457: if ($stuname) { $home=&homeserver($stuname,$domain); }
2458:
2459: $symb=&symbclean($symb);
2460: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2461:
2462: if (!$domain) { $domain=$env{'user.domain'}; }
2463: if (!$stuname) { $stuname=$env{'user.name'}; }
2464:
2465: &devalidate($symb,$stuname,$domain);
2466:
2467: $symb=escape($symb);
2468: if (!$namespace) {
2469: unless ($namespace=$env{'request.course.id'}) {
2470: return '';
2471: }
2472: }
2473: if (!$home) { $home=$env{'user.home'}; }
2474:
2475: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2476: $$storehash{'host'}=$perlvar{'lonHostID'};
2477:
2478: my $namevalue='';
2479: foreach (keys %$storehash) {
2480: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2481: }
2482: $namevalue=~s/\&$//;
2483: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2484: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2485: }
2486:
2487: # -------------------------------------------------------------- Critical Store
2488:
2489: sub cstore {
2490: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2491: my $home='';
2492:
2493: if ($stuname) { $home=&homeserver($stuname,$domain); }
2494:
2495: $symb=&symbclean($symb);
2496: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2497:
2498: if (!$domain) { $domain=$env{'user.domain'}; }
2499: if (!$stuname) { $stuname=$env{'user.name'}; }
2500:
2501: &devalidate($symb,$stuname,$domain);
2502:
2503: $symb=escape($symb);
2504: if (!$namespace) {
2505: unless ($namespace=$env{'request.course.id'}) {
2506: return '';
2507: }
2508: }
2509: if (!$home) { $home=$env{'user.home'}; }
2510:
2511: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2512: $$storehash{'host'}=$perlvar{'lonHostID'};
2513:
2514: my $namevalue='';
2515: foreach (keys %$storehash) {
2516: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2517: }
2518: $namevalue=~s/\&$//;
2519: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2520: return critical
2521: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2522: }
2523:
2524: # --------------------------------------------------------------------- Restore
2525:
2526: sub restore {
2527: my ($symb,$namespace,$domain,$stuname) = @_;
2528: my $home='';
2529:
2530: if ($stuname) { $home=&homeserver($stuname,$domain); }
2531:
2532: if (!$symb) {
2533: unless ($symb=escape(&symbread())) { return ''; }
2534: } else {
2535: $symb=&escape(&symbclean($symb));
2536: }
2537: if (!$namespace) {
2538: unless ($namespace=$env{'request.course.id'}) {
2539: return '';
2540: }
2541: }
2542: if (!$domain) { $domain=$env{'user.domain'}; }
2543: if (!$stuname) { $stuname=$env{'user.name'}; }
2544: if (!$home) { $home=$env{'user.home'}; }
2545: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2546:
2547: my %returnhash=();
2548: foreach (split(/\&/,$answer)) {
2549: my ($name,$value)=split(/\=/,$_);
2550: $returnhash{&unescape($name)}=&thaw_unescape($value);
2551: }
2552: my $version;
2553: for ($version=1;$version<=$returnhash{'version'};$version++) {
2554: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2555: $returnhash{$_}=$returnhash{$version.':'.$_};
2556: }
2557: }
2558: return %returnhash;
2559: }
2560:
2561: # ---------------------------------------------------------- Course Description
2562:
2563: sub coursedescription {
2564: my $courseid=shift;
2565: $courseid=~s/^\///;
2566: $courseid=~s/\_/\//g;
2567: my ($cdomain,$cnum)=split(/\//,$courseid);
2568: my $chome=&homeserver($cnum,$cdomain);
2569: my $normalid=$cdomain.'_'.$cnum;
2570: # need to always cache even if we get errors otherwise we keep
2571: # trying and trying and trying to get the course description.
2572: my %envhash=();
2573: my %returnhash=();
2574: $envhash{'course.'.$normalid.'.last_cache'}=time;
2575: if ($chome ne 'no_host') {
2576: %returnhash=&dump('environment',$cdomain,$cnum);
2577: if (!exists($returnhash{'con_lost'})) {
2578: $returnhash{'home'}= $chome;
2579: $returnhash{'domain'} = $cdomain;
2580: $returnhash{'num'} = $cnum;
2581: while (my ($name,$value) = each %returnhash) {
2582: $envhash{'course.'.$normalid.'.'.$name}=$value;
2583: }
2584: $returnhash{'url'}=&clutter($returnhash{'url'});
2585: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2586: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2587: $envhash{'course.'.$normalid.'.home'}=$chome;
2588: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2589: $envhash{'course.'.$normalid.'.num'}=$cnum;
2590: }
2591: }
2592: &appenv(%envhash);
2593: return %returnhash;
2594: }
2595:
2596: # -------------------------------------------------See if a user is privileged
2597:
2598: sub privileged {
2599: my ($username,$domain)=@_;
2600: my $rolesdump=&reply("dump:$domain:$username:roles",
2601: &homeserver($username,$domain));
2602: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2603: my $now=time;
2604: if ($rolesdump ne '') {
2605: foreach (split(/&/,$rolesdump)) {
2606: if ($_!~/^rolesdef_/) {
2607: my ($area,$role)=split(/=/,$_);
2608: $area=~s/\_\w\w$//;
2609: my ($trole,$tend,$tstart)=split(/_/,$role);
2610: if (($trole eq 'dc') || ($trole eq 'su')) {
2611: my $active=1;
2612: if ($tend) {
2613: if ($tend<$now) { $active=0; }
2614: }
2615: if ($tstart) {
2616: if ($tstart>$now) { $active=0; }
2617: }
2618: if ($active) { return 1; }
2619: }
2620: }
2621: }
2622: }
2623: return 0;
2624: }
2625:
2626: # -------------------------------------------------------- Get user privileges
2627:
2628: sub rolesinit {
2629: my ($domain,$username,$authhost)=@_;
2630: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2631: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2632: my %allroles=();
2633: my %allgroups=();
2634: my $now=time;
2635: my $userroles="user.login.time=$now\n";
2636: my $group_privs;
2637:
2638: if ($rolesdump ne '') {
2639: foreach (split(/&/,$rolesdump)) {
2640: if ($_!~/^rolesdef_/) {
2641: my ($area,$role)=split(/=/,$_);
2642: $area=~s/\_\w\w$//;
2643: my ($trole,$tend,$tstart,$group_privs);
2644: if ($role=~/^cr/) {
2645: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2646: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2647: ($tend,$tstart)=split('_',$trest);
2648: } else {
2649: $trole=$role;
2650: }
2651: } elsif ($role =~ m|^gr/|) {
2652: ($trole,$tend,$tstart) = split(/_/,$role);
2653: ($trole,$group_privs) = split(/\//,$trole);
2654: $group_privs = &unescape($group_privs);
2655: } else {
2656: ($trole,$tend,$tstart)=split(/_/,$role);
2657: }
2658: $userroles.=&set_arearole($trole,$area,$tstart,$tend,$domain,$username);
2659: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2660: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2661: if (($area ne '') && ($trole ne '')) {
2662: my $spec=$trole.'.'.$area;
2663: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2664: if ($trole =~ /^cr\//) {
2665: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2666: } elsif ($trole eq 'gr') {
2667: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2668: } else {
2669: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2670: }
2671: }
2672: }
2673: }
2674: my ($author,$adv) = &set_userprivs(\$userroles,\%allroles,\%allgroups);
2675: $userroles.='user.adv='.$adv."\n".
2676: 'user.author='.$author."\n";
2677: $env{'user.adv'}=$adv;
2678: }
2679: return $userroles;
2680: }
2681:
2682: sub set_arearole {
2683: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2684: # log the associated role with the area
2685: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2686: return 'user.role.'.$trole.'.'.$area.'='.$tstart.'.'.$tend."\n";
2687: }
2688:
2689: sub custom_roleprivs {
2690: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2691: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2692: my $homsvr=homeserver($rauthor,$rdomain);
2693: if ($hostname{$homsvr} ne '') {
2694: my ($rdummy,$roledef)=
2695: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2696: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2697: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2698: if (defined($syspriv)) {
2699: $$allroles{'cm./'}.=':'.$syspriv;
2700: $$allroles{$spec.'./'}.=':'.$syspriv;
2701: }
2702: if ($tdomain ne '') {
2703: if (defined($dompriv)) {
2704: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2705: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2706: }
2707: if (($trest ne '') && (defined($coursepriv))) {
2708: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2709: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2710: }
2711: }
2712: }
2713: }
2714: }
2715:
2716: sub group_roleprivs {
2717: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2718: my $access = 1;
2719: my $now = time;
2720: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2721: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2722: if ($access) {
2723: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2724: $$allgroups{$course}{$group} .=':'.$group_privs;
2725: }
2726: }
2727:
2728: sub standard_roleprivs {
2729: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2730: if (defined($pr{$trole.':s'})) {
2731: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2732: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2733: }
2734: if ($tdomain ne '') {
2735: if (defined($pr{$trole.':d'})) {
2736: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2737: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2738: }
2739: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2740: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2741: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2742: }
2743: }
2744: }
2745:
2746: sub set_userprivs {
2747: my ($userroles,$allroles,$allgroups) = @_;
2748: my $author=0;
2749: my $adv=0;
2750: my %grouproles = ();
2751: if (keys(%{$allgroups}) > 0) {
2752: foreach my $role (keys %{$allroles}) {
2753: my ($trole,$area,$sec,$extendedarea);
2754: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
2755: $trole = $1;
2756: $area = $2;
2757: $sec = $3;
2758: $extendedarea = $area.$sec;
2759: if (exists($$allgroups{$area})) {
2760: foreach my $group (keys(%{$$allgroups{$area}})) {
2761: my $spec = $trole.'.'.$extendedarea;
2762: $grouproles{$spec.'.'.$area.'/'.$group} =
2763: $$allgroups{$area}{$group};
2764: }
2765: }
2766: }
2767: }
2768: }
2769: foreach (keys(%grouproles)) {
2770: $$allroles{$_} = $grouproles{$_};
2771: }
2772: foreach (keys %{$allroles}) {
2773: my %thesepriv=();
2774: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2775: foreach (split(/:/,$$allroles{$_})) {
2776: if ($_ ne '') {
2777: my ($privilege,$restrictions)=split(/&/,$_);
2778: if ($restrictions eq '') {
2779: $thesepriv{$privilege}='F';
2780: } elsif ($thesepriv{$privilege} ne 'F') {
2781: $thesepriv{$privilege}.=$restrictions;
2782: }
2783: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2784: }
2785: }
2786: my $thesestr='';
2787: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2788: $$userroles.='user.priv.'.$_.'='.$thesestr."\n";
2789: }
2790: return ($author,$adv);
2791: }
2792:
2793: # --------------------------------------------------------------- get interface
2794:
2795: sub get {
2796: my ($namespace,$storearr,$udomain,$uname)=@_;
2797: my $items='';
2798: foreach (@$storearr) {
2799: $items.=escape($_).'&';
2800: }
2801: $items=~s/\&$//;
2802: if (!$udomain) { $udomain=$env{'user.domain'}; }
2803: if (!$uname) { $uname=$env{'user.name'}; }
2804: my $uhome=&homeserver($uname,$udomain);
2805:
2806: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2807: my @pairs=split(/\&/,$rep);
2808: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2809: return @pairs;
2810: }
2811: my %returnhash=();
2812: my $i=0;
2813: foreach (@$storearr) {
2814: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2815: $i++;
2816: }
2817: return %returnhash;
2818: }
2819:
2820: # --------------------------------------------------------------- del interface
2821:
2822: sub del {
2823: my ($namespace,$storearr,$udomain,$uname)=@_;
2824: my $items='';
2825: foreach (@$storearr) {
2826: $items.=escape($_).'&';
2827: }
2828: $items=~s/\&$//;
2829: if (!$udomain) { $udomain=$env{'user.domain'}; }
2830: if (!$uname) { $uname=$env{'user.name'}; }
2831: my $uhome=&homeserver($uname,$udomain);
2832:
2833: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2834: }
2835:
2836: # -------------------------------------------------------------- dump interface
2837:
2838: sub dump {
2839: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2840: if (!$udomain) { $udomain=$env{'user.domain'}; }
2841: if (!$uname) { $uname=$env{'user.name'}; }
2842: my $uhome=&homeserver($uname,$udomain);
2843: if ($regexp) {
2844: $regexp=&escape($regexp);
2845: } else {
2846: $regexp='.';
2847: }
2848: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2849: my @pairs=split(/\&/,$rep);
2850: my %returnhash=();
2851: foreach (@pairs) {
2852: my ($key,$value)=split(/=/,$_,2);
2853: $returnhash{unescape($key)}=&thaw_unescape($value);
2854: }
2855: return %returnhash;
2856: }
2857:
2858: # -------------------------------------------------------------- keys interface
2859:
2860: sub getkeys {
2861: my ($namespace,$udomain,$uname)=@_;
2862: if (!$udomain) { $udomain=$env{'user.domain'}; }
2863: if (!$uname) { $uname=$env{'user.name'}; }
2864: my $uhome=&homeserver($uname,$udomain);
2865: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2866: my @keyarray=();
2867: foreach (split(/\&/,$rep)) {
2868: push (@keyarray,&unescape($_));
2869: }
2870: return @keyarray;
2871: }
2872:
2873: # --------------------------------------------------------------- currentdump
2874: sub currentdump {
2875: my ($courseid,$sdom,$sname)=@_;
2876: $courseid = $env{'request.course.id'} if (! defined($courseid));
2877: $sdom = $env{'user.domain'} if (! defined($sdom));
2878: $sname = $env{'user.name'} if (! defined($sname));
2879: my $uhome = &homeserver($sname,$sdom);
2880: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2881: return if ($rep =~ /^(error:|no_such_host)/);
2882: #
2883: my %returnhash=();
2884: #
2885: if ($rep eq "unknown_cmd") {
2886: # an old lond will not know currentdump
2887: # Do a dump and make it look like a currentdump
2888: my @tmp = &dump($courseid,$sdom,$sname,'.');
2889: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2890: my %hash = @tmp;
2891: @tmp=();
2892: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
2893: } else {
2894: my @pairs=split(/\&/,$rep);
2895: foreach (@pairs) {
2896: my ($key,$value)=split(/=/,$_);
2897: my ($symb,$param) = split(/:/,$key);
2898: $returnhash{&unescape($symb)}->{&unescape($param)} =
2899: &thaw_unescape($value);
2900: }
2901: }
2902: return %returnhash;
2903: }
2904:
2905: sub convert_dump_to_currentdump{
2906: my %hash = %{shift()};
2907: my %returnhash;
2908: # Code ripped from lond, essentially. The only difference
2909: # here is the unescaping done by lonnet::dump(). Conceivably
2910: # we might run in to problems with parameter names =~ /^v\./
2911: while (my ($key,$value) = each(%hash)) {
2912: my ($v,$symb,$param) = split(/:/,$key);
2913: next if ($v eq 'version' || $symb eq 'keys');
2914: next if (exists($returnhash{$symb}) &&
2915: exists($returnhash{$symb}->{$param}) &&
2916: $returnhash{$symb}->{'v.'.$param} > $v);
2917: $returnhash{$symb}->{$param}=$value;
2918: $returnhash{$symb}->{'v.'.$param}=$v;
2919: }
2920: #
2921: # Remove all of the keys in the hashes which keep track of
2922: # the version of the parameter.
2923: while (my ($symb,$param_hash) = each(%returnhash)) {
2924: # use a foreach because we are going to delete from the hash.
2925: foreach my $key (keys(%$param_hash)) {
2926: delete($param_hash->{$key}) if ($key =~ /^v\./);
2927: }
2928: }
2929: return \%returnhash;
2930: }
2931:
2932: # ------------------------------------------------------ critical inc interface
2933:
2934: sub cinc {
2935: return &inc(@_,'critical');
2936: }
2937:
2938: # --------------------------------------------------------------- inc interface
2939:
2940: sub inc {
2941: my ($namespace,$store,$udomain,$uname,$critical) = @_;
2942: if (!$udomain) { $udomain=$env{'user.domain'}; }
2943: if (!$uname) { $uname=$env{'user.name'}; }
2944: my $uhome=&homeserver($uname,$udomain);
2945: my $items='';
2946: if (! ref($store)) {
2947: # got a single value, so use that instead
2948: $items = &escape($store).'=&';
2949: } elsif (ref($store) eq 'SCALAR') {
2950: $items = &escape($$store).'=&';
2951: } elsif (ref($store) eq 'ARRAY') {
2952: $items = join('=&',map {&escape($_);} @{$store});
2953: } elsif (ref($store) eq 'HASH') {
2954: while (my($key,$value) = each(%{$store})) {
2955: $items.= &escape($key).'='.&escape($value).'&';
2956: }
2957: }
2958: $items=~s/\&$//;
2959: if ($critical) {
2960: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
2961: } else {
2962: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
2963: }
2964: }
2965:
2966: # --------------------------------------------------------------- put interface
2967:
2968: sub put {
2969: my ($namespace,$storehash,$udomain,$uname)=@_;
2970: if (!$udomain) { $udomain=$env{'user.domain'}; }
2971: if (!$uname) { $uname=$env{'user.name'}; }
2972: my $uhome=&homeserver($uname,$udomain);
2973: my $items='';
2974: foreach (keys %$storehash) {
2975: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2976: }
2977: $items=~s/\&$//;
2978: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
2979: }
2980:
2981: # ------------------------------------------------------------ newput interface
2982:
2983: sub newput {
2984: my ($namespace,$storehash,$udomain,$uname)=@_;
2985: if (!$udomain) { $udomain=$env{'user.domain'}; }
2986: if (!$uname) { $uname=$env{'user.name'}; }
2987: my $uhome=&homeserver($uname,$udomain);
2988: my $items='';
2989: foreach my $key (keys(%$storehash)) {
2990: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2991: }
2992: $items=~s/\&$//;
2993: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
2994: }
2995:
2996: # --------------------------------------------------------- putstore interface
2997:
2998: sub putstore {
2999: my ($namespace,$storehash,$udomain,$uname)=@_;
3000: if (!$udomain) { $udomain=$env{'user.domain'}; }
3001: if (!$uname) { $uname=$env{'user.name'}; }
3002: my $uhome=&homeserver($uname,$udomain);
3003: my $items='';
3004: my %allitems = ();
3005: foreach (keys %$storehash) {
3006: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3007: my $key = $1.':keys:'.$2;
3008: $allitems{$key} .= $3.':';
3009: }
3010: $items.=$_.'='.&freeze_escape($$storehash{$_}).'&';
3011: }
3012: foreach (keys %allitems) {
3013: $allitems{$_} =~ s/\:$//;
3014: $items.= $_.'='.$allitems{$_}.'&';
3015: }
3016: $items=~s/\&$//;
3017: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3018: }
3019:
3020: # ------------------------------------------------------ critical put interface
3021:
3022: sub cput {
3023: my ($namespace,$storehash,$udomain,$uname)=@_;
3024: if (!$udomain) { $udomain=$env{'user.domain'}; }
3025: if (!$uname) { $uname=$env{'user.name'}; }
3026: my $uhome=&homeserver($uname,$udomain);
3027: my $items='';
3028: foreach (keys %$storehash) {
3029: $items.=escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3030: }
3031: $items=~s/\&$//;
3032: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3033: }
3034:
3035: # -------------------------------------------------------------- eget interface
3036:
3037: sub eget {
3038: my ($namespace,$storearr,$udomain,$uname)=@_;
3039: my $items='';
3040: foreach (@$storearr) {
3041: $items.=escape($_).'&';
3042: }
3043: $items=~s/\&$//;
3044: if (!$udomain) { $udomain=$env{'user.domain'}; }
3045: if (!$uname) { $uname=$env{'user.name'}; }
3046: my $uhome=&homeserver($uname,$udomain);
3047: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3048: my @pairs=split(/\&/,$rep);
3049: my %returnhash=();
3050: my $i=0;
3051: foreach (@$storearr) {
3052: $returnhash{$_}=&thaw_unescape($pairs[$i]);
3053: $i++;
3054: }
3055: return %returnhash;
3056: }
3057:
3058: # ------------------------------------------------------------ tmpput interface
3059: sub tmpput {
3060: my ($storehash,$server)=@_;
3061: my $items='';
3062: foreach (keys(%$storehash)) {
3063: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3064: }
3065: $items=~s/\&$//;
3066: return &reply("tmpput:$items",$server);
3067: }
3068:
3069: # ------------------------------------------------------------ tmpget interface
3070: sub tmpget {
3071: my ($token,$server)=@_;
3072: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3073: my $rep=&reply("tmpget:$token",$server);
3074: my %returnhash;
3075: foreach my $item (split(/\&/,$rep)) {
3076: my ($key,$value)=split(/=/,$item);
3077: $returnhash{&unescape($key)}=&thaw_unescape($value);
3078: }
3079: return %returnhash;
3080: }
3081:
3082: # ------------------------------------------------------------ tmpget interface
3083: sub tmpdel {
3084: my ($token,$server)=@_;
3085: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3086: return &reply("tmpdel:$token",$server);
3087: }
3088:
3089: # ---------------------------------------------- Custom access rule evaluation
3090:
3091: sub customaccess {
3092: my ($priv,$uri)=@_;
3093: my ($urole,$urealm)=split(/\./,$env{'request.role'});
3094: $urealm=~s/^\W//;
3095: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3096: my $access=0;
3097: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3098: my ($effect,$realm,$role)=split(/\:/,$_);
3099: if ($role) {
3100: if ($role ne $urole) { next; }
3101: }
3102: foreach (split(/\s*\,\s*/,$realm)) {
3103: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3104: if ($tdom) {
3105: if ($tdom ne $udom) { next; }
3106: }
3107: if ($tcrs) {
3108: if ($tcrs ne $ucrs) { next; }
3109: }
3110: if ($tsec) {
3111: if ($tsec ne $usec) { next; }
3112: }
3113: $access=($effect eq 'allow');
3114: last;
3115: }
3116: if ($realm eq '' && $role eq '') {
3117: $access=($effect eq 'allow');
3118: }
3119: }
3120: return $access;
3121: }
3122:
3123: # ------------------------------------------------- Check for a user privilege
3124:
3125: sub allowed {
3126: my ($priv,$uri,$symb)=@_;
3127: my $ver_orguri=$uri;
3128: $uri=&deversion($uri);
3129: my $orguri=$uri;
3130: $uri=&declutter($uri);
3131:
3132: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3133: # Free bre access to adm and meta resources
3134: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3135: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
3136: return 'F';
3137: }
3138:
3139: # Free bre access to user's own portfolio contents
3140: my ($space,$domain,$name,@dir)=split('/',$uri);
3141: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3142: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3143: return 'F';
3144: }
3145:
3146: # bre access to group if user has rgf priv for this group and course.
3147: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3148: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3149: if (exists($env{'request.course.id'})) {
3150: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3151: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3152: if (($domain eq $cdom) && ($name eq $cnum)) {
3153: my $courseprivid=$env{'request.course.id'};
3154: $courseprivid=~s/\_/\//;
3155: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3156: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3157: return $1;
3158: }
3159: }
3160: }
3161: }
3162:
3163: # Free bre to public access
3164:
3165: if ($priv eq 'bre') {
3166: my $copyright=&metadata($uri,'copyright');
3167: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3168: return 'F';
3169: }
3170: if ($copyright eq 'priv') {
3171: $uri=~/([^\/]+)\/([^\/]+)\//;
3172: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3173: return '';
3174: }
3175: }
3176: if ($copyright eq 'domain') {
3177: $uri=~/([^\/]+)\/([^\/]+)\//;
3178: unless (($env{'user.domain'} eq $1) ||
3179: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3180: return '';
3181: }
3182: }
3183: if ($env{'request.role'}=~ /li\.\//) {
3184: # Library role, so allow browsing of resources in this domain.
3185: return 'F';
3186: }
3187: if ($copyright eq 'custom') {
3188: unless (&customaccess($priv,$uri)) { return ''; }
3189: }
3190: }
3191: # Domain coordinator is trying to create a course
3192: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3193: # uri is the requested domain in this case.
3194: # comparison to 'request.role.domain' shows if the user has selected
3195: # a role of dc for the domain in question.
3196: return 'F' if ($uri eq $env{'request.role.domain'});
3197: }
3198:
3199: my $thisallowed='';
3200: my $statecond=0;
3201: my $courseprivid='';
3202:
3203: # Course
3204:
3205: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3206: $thisallowed.=$1;
3207: }
3208:
3209: # Domain
3210:
3211: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3212: =~/\Q$priv\E\&([^\:]*)/) {
3213: $thisallowed.=$1;
3214: }
3215:
3216: # Course: uri itself is a course
3217: my $courseuri=$uri;
3218: $courseuri=~s/\_(\d)/\/$1/;
3219: $courseuri=~s/^([^\/])/\/$1/;
3220:
3221: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3222: =~/\Q$priv\E\&([^\:]*)/) {
3223: $thisallowed.=$1;
3224: }
3225:
3226: # Group: uri itself is a group
3227: my $groupuri=$uri;
3228: $groupuri=~s/^([^\/])/\/$1/;
3229: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3230: =~/\Q$priv\E\&([^\:]*)/) {
3231: $thisallowed.=$1;
3232: }
3233:
3234: # URI is an uploaded document for this course, default permissions don't matter
3235: # not allowing 'edit' access (editupload) to uploaded course docs
3236: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3237: $thisallowed='';
3238: my ($match)=&is_on_map($uri);
3239: if ($match) {
3240: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3241: =~/\Q$priv\E\&([^\:]*)/) {
3242: $thisallowed.=$1;
3243: }
3244: } else {
3245: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3246: if ($refuri) {
3247: if ($refuri =~ m|^/adm/|) {
3248: $thisallowed='F';
3249: } else {
3250: $refuri=&declutter($refuri);
3251: my ($match) = &is_on_map($refuri);
3252: if ($match) {
3253: $thisallowed='F';
3254: }
3255: }
3256: }
3257: }
3258: }
3259:
3260: # Full access at system, domain or course-wide level? Exit.
3261:
3262: if ($thisallowed=~/F/) {
3263: return 'F';
3264: }
3265:
3266: # If this is generating or modifying users, exit with special codes
3267:
3268: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3269: if (($priv eq 'cca') || ($priv eq 'caa')) {
3270: my ($audom,$auname)=split('/',$uri);
3271: # no author name given, so this just checks on the general right to make a co-author in this domain
3272: unless ($auname) { return $thisallowed; }
3273: # an author name is given, so we are about to actually make a co-author for a certain account
3274: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3275: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3276: ($audom ne $env{'request.role.domain'}))) { return ''; }
3277: }
3278: return $thisallowed;
3279: }
3280: #
3281: # Gathered so far: system, domain and course wide privileges
3282: #
3283: # Course: See if uri or referer is an individual resource that is part of
3284: # the course
3285:
3286: if ($env{'request.course.id'}) {
3287:
3288: $courseprivid=$env{'request.course.id'};
3289: if ($env{'request.course.sec'}) {
3290: $courseprivid.='/'.$env{'request.course.sec'};
3291: }
3292: $courseprivid=~s/\_/\//;
3293: my $checkreferer=1;
3294: my ($match,$cond)=&is_on_map($uri);
3295: if ($match) {
3296: $statecond=$cond;
3297: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3298: =~/\Q$priv\E\&([^\:]*)/) {
3299: $thisallowed.=$1;
3300: $checkreferer=0;
3301: }
3302: }
3303:
3304: if ($checkreferer) {
3305: my $refuri=$env{'httpref.'.$orguri};
3306: unless ($refuri) {
3307: foreach (keys %env) {
3308: if ($_=~/^httpref\..*\*/) {
3309: my $pattern=$_;
3310: $pattern=~s/^httpref\.\/res\///;
3311: $pattern=~s/\*/\[\^\/\]\+/g;
3312: $pattern=~s/\//\\\//g;
3313: if ($orguri=~/$pattern/) {
3314: $refuri=$env{$_};
3315: }
3316: }
3317: }
3318: }
3319:
3320: if ($refuri) {
3321: $refuri=&declutter($refuri);
3322: my ($match,$cond)=&is_on_map($refuri);
3323: if ($match) {
3324: my $refstatecond=$cond;
3325: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3326: =~/\Q$priv\E\&([^\:]*)/) {
3327: $thisallowed.=$1;
3328: $uri=$refuri;
3329: $statecond=$refstatecond;
3330: }
3331: }
3332: }
3333: }
3334: }
3335:
3336: #
3337: # Gathered now: all privileges that could apply, and condition number
3338: #
3339: #
3340: # Full or no access?
3341: #
3342:
3343: if ($thisallowed=~/F/) {
3344: return 'F';
3345: }
3346:
3347: unless ($thisallowed) {
3348: return '';
3349: }
3350:
3351: # Restrictions exist, deal with them
3352: #
3353: # C:according to course preferences
3354: # R:according to resource settings
3355: # L:unless locked
3356: # X:according to user session state
3357: #
3358:
3359: # Possibly locked functionality, check all courses
3360: # Locks might take effect only after 10 minutes cache expiration for other
3361: # courses, and 2 minutes for current course
3362:
3363: my $envkey;
3364: if ($thisallowed=~/L/) {
3365: foreach $envkey (keys %env) {
3366: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3367: my $courseid=$2;
3368: my $roleid=$1.'.'.$2;
3369: $courseid=~s/^\///;
3370: my $expiretime=600;
3371: if ($env{'request.role'} eq $roleid) {
3372: $expiretime=120;
3373: }
3374: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3375: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3376: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3377: &coursedescription($courseid);
3378: }
3379: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3380: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3381: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3382: &log($env{'user.domain'},$env{'user.name'},
3383: $env{'user.home'},
3384: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3385: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3386: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3387: return '';
3388: }
3389: }
3390: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3391: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3392: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3393: &log($env{'user.domain'},$env{'user.name'},
3394: $env{'user.home'},
3395: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3396: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3397: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3398: return '';
3399: }
3400: }
3401: }
3402: }
3403: }
3404:
3405: #
3406: # Rest of the restrictions depend on selected course
3407: #
3408:
3409: unless ($env{'request.course.id'}) {
3410: return '1';
3411: }
3412:
3413: #
3414: # Now user is definitely in a course
3415: #
3416:
3417:
3418: # Course preferences
3419:
3420: if ($thisallowed=~/C/) {
3421: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3422: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3423: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3424: =~/\Q$rolecode\E/) {
3425: if ($priv ne 'pch') {
3426: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3427: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3428: $env{'request.course.id'});
3429: }
3430: return '';
3431: }
3432:
3433: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3434: =~/\Q$unamedom\E/) {
3435: if ($priv ne 'pch') {
3436: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3437: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3438: $env{'request.course.id'});
3439: }
3440: return '';
3441: }
3442: }
3443:
3444: # Resource preferences
3445:
3446: if ($thisallowed=~/R/) {
3447: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3448: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3449: if ($priv ne 'pch') {
3450: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3451: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3452: }
3453: return '';
3454: }
3455: }
3456:
3457: # Restricted by state or randomout?
3458:
3459: if ($thisallowed=~/X/) {
3460: if ($env{'acc.randomout'}) {
3461: if (!$symb) { $symb=&symbread($uri,1); }
3462: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3463: return '';
3464: }
3465: }
3466: if (&condval($statecond)) {
3467: return '2';
3468: } else {
3469: return '';
3470: }
3471: }
3472:
3473: return 'F';
3474: }
3475:
3476: sub split_uri_for_cond {
3477: my $uri=&deversion(&declutter(shift));
3478: my @uriparts=split(/\//,$uri);
3479: my $filename=pop(@uriparts);
3480: my $pathname=join('/',@uriparts);
3481: return ($pathname,$filename);
3482: }
3483: # --------------------------------------------------- Is a resource on the map?
3484:
3485: sub is_on_map {
3486: my ($pathname,$filename) = &split_uri_for_cond(shift);
3487: #Trying to find the conditional for the file
3488: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3489: /\&\Q$filename\E\:([\d\|]+)\&/);
3490: if ($match) {
3491: return (1,$1);
3492: } else {
3493: return (0,0);
3494: }
3495: }
3496:
3497: # --------------------------------------------------------- Get symb from alias
3498:
3499: sub get_symb_from_alias {
3500: my $symb=shift;
3501: my ($map,$resid,$url)=&decode_symb($symb);
3502: # Already is a symb
3503: if ($url) { return $symb; }
3504: # Must be an alias
3505: my $aliassymb='';
3506: my %bighash;
3507: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3508: &GDBM_READER(),0640)) {
3509: my $rid=$bighash{'mapalias_'.$symb};
3510: if ($rid) {
3511: my ($mapid,$resid)=split(/\./,$rid);
3512: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3513: $resid,$bighash{'src_'.$rid});
3514: }
3515: untie %bighash;
3516: }
3517: return $aliassymb;
3518: }
3519:
3520: # ----------------------------------------------------------------- Define Role
3521:
3522: sub definerole {
3523: if (allowed('mcr','/')) {
3524: my ($rolename,$sysrole,$domrole,$courole)=@_;
3525: foreach (split(':',$sysrole)) {
3526: my ($crole,$cqual)=split(/\&/,$_);
3527: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3528: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3529: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3530: return "refused:s:$crole&$cqual";
3531: }
3532: }
3533: }
3534: foreach (split(':',$domrole)) {
3535: my ($crole,$cqual)=split(/\&/,$_);
3536: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3537: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3538: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3539: return "refused:d:$crole&$cqual";
3540: }
3541: }
3542: }
3543: foreach (split(':',$courole)) {
3544: my ($crole,$cqual)=split(/\&/,$_);
3545: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3546: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3547: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3548: return "refused:c:$crole&$cqual";
3549: }
3550: }
3551: }
3552: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3553: "$env{'user.domain'}:$env{'user.name'}:".
3554: "rolesdef_$rolename=".
3555: escape($sysrole.'_'.$domrole.'_'.$courole);
3556: return reply($command,$env{'user.home'});
3557: } else {
3558: return 'refused';
3559: }
3560: }
3561:
3562: # ---------------- Make a metadata query against the network of library servers
3563:
3564: sub metadata_query {
3565: my ($query,$custom,$customshow,$server_array)=@_;
3566: my %rhash;
3567: my @server_list = (defined($server_array) ? @$server_array
3568: : keys(%libserv) );
3569: for my $server (@server_list) {
3570: unless ($custom or $customshow) {
3571: my $reply=&reply("querysend:".&escape($query),$server);
3572: $rhash{$server}=$reply;
3573: }
3574: else {
3575: my $reply=&reply("querysend:".&escape($query).':'.
3576: &escape($custom).':'.&escape($customshow),
3577: $server);
3578: $rhash{$server}=$reply;
3579: }
3580: }
3581: return \%rhash;
3582: }
3583:
3584: # ----------------------------------------- Send log queries and wait for reply
3585:
3586: sub log_query {
3587: my ($uname,$udom,$query,%filters)=@_;
3588: my $uhome=&homeserver($uname,$udom);
3589: if ($uhome eq 'no_host') { return 'error: no_host'; }
3590: my $uhost=$hostname{$uhome};
3591: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3592: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3593: $uhome);
3594: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3595: return get_query_reply($queryid);
3596: }
3597:
3598: # ------- Request retrieval of institutional classlists for course(s)
3599:
3600: sub fetch_enrollment_query {
3601: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
3602: my $homeserver;
3603: my $maxtries = 1;
3604: if ($context eq 'automated') {
3605: $homeserver = $perlvar{'lonHostID'};
3606: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
3607: } else {
3608: $homeserver = &homeserver($cnum,$dom);
3609: }
3610: my $host=$hostname{$homeserver};
3611: my $cmd = '';
3612: foreach (keys %{$affiliatesref}) {
3613: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3614: }
3615: $cmd =~ s/%%$//;
3616: $cmd = &escape($cmd);
3617: my $query = 'fetchenrollment';
3618: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
3619: unless ($queryid=~/^\Q$host\E\_/) {
3620: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3621: return 'error: '.$queryid;
3622: }
3623: my $reply = &get_query_reply($queryid);
3624: my $tries = 1;
3625: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3626: $reply = &get_query_reply($queryid);
3627: $tries ++;
3628: }
3629: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3630: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3631: } else {
3632: my @responses = split/:/,$reply;
3633: if ($homeserver eq $perlvar{'lonHostID'}) {
3634: foreach (@responses) {
3635: my ($key,$value) = split/=/,$_;
3636: $$replyref{$key} = $value;
3637: }
3638: } else {
3639: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3640: foreach (@responses) {
3641: my ($key,$value) = split/=/,$_;
3642: $$replyref{$key} = $value;
3643: if ($value > 0) {
3644: foreach (@{$$affiliatesref{$key}}) {
3645: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3646: my $destname = $pathname.'/'.$filename;
3647: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
3648: if ($xml_classlist =~ /^error/) {
3649: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3650: } else {
3651: if ( open(FILE,">$destname") ) {
3652: print FILE &unescape($xml_classlist);
3653: close(FILE);
3654: } else {
3655: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
3656: }
3657: }
3658: }
3659: }
3660: }
3661: }
3662: return 'ok';
3663: }
3664: return 'error';
3665: }
3666:
3667: sub get_query_reply {
3668: my $queryid=shift;
3669: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3670: my $reply='';
3671: for (1..100) {
3672: sleep 2;
3673: if (-e $replyfile.'.end') {
3674: if (open(my $fh,$replyfile)) {
3675: $reply.=<$fh>;
3676: close($fh);
3677: } else { return 'error: reply_file_error'; }
3678: return &unescape($reply);
3679: }
3680: }
3681: return 'timeout:'.$queryid;
3682: }
3683:
3684: sub courselog_query {
3685: #
3686: # possible filters:
3687: # url: url or symb
3688: # username
3689: # domain
3690: # action: view, submit, grade
3691: # start: timestamp
3692: # end: timestamp
3693: #
3694: my (%filters)=@_;
3695: unless ($env{'request.course.id'}) { return 'no_course'; }
3696: if ($filters{'url'}) {
3697: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3698: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3699: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3700: }
3701: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3702: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3703: return &log_query($cname,$cdom,'courselog',%filters);
3704: }
3705:
3706: sub userlog_query {
3707: my ($uname,$udom,%filters)=@_;
3708: return &log_query($uname,$udom,'userlog',%filters);
3709: }
3710:
3711: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3712:
3713: sub auto_run {
3714: my ($cnum,$cdom) = @_;
3715: my $homeserver = &homeserver($cnum,$cdom);
3716: my $response = &reply('autorun:'.$cdom,$homeserver);
3717: return $response;
3718: }
3719:
3720: sub auto_get_sections {
3721: my ($cnum,$cdom,$inst_coursecode) = @_;
3722: my $homeserver = &homeserver($cnum,$cdom);
3723: my @secs = ();
3724: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
3725: unless ($response eq 'refused') {
3726: @secs = split/:/,$response;
3727: }
3728: return @secs;
3729: }
3730:
3731: sub auto_new_course {
3732: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3733: my $homeserver = &homeserver($cnum,$cdom);
3734: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
3735: return $response;
3736: }
3737:
3738: sub auto_validate_courseID {
3739: my ($cnum,$cdom,$inst_course_id) = @_;
3740: my $homeserver = &homeserver($cnum,$cdom);
3741: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
3742: return $response;
3743: }
3744:
3745: sub auto_create_password {
3746: my ($cnum,$cdom,$authparam) = @_;
3747: my $homeserver = &homeserver($cnum,$cdom);
3748: my $create_passwd = 0;
3749: my $authchk = '';
3750: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
3751: if ($response eq 'refused') {
3752: $authchk = 'refused';
3753: } else {
3754: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3755: }
3756: return ($authparam,$create_passwd,$authchk);
3757: }
3758:
3759: sub auto_photo_permission {
3760: my ($cnum,$cdom,$students) = @_;
3761: my $homeserver = &homeserver($cnum,$cdom);
3762: my ($outcome,$perm_reqd,$conditions) =
3763: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
3764: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3765: return (undef,undef);
3766: }
3767: return ($outcome,$perm_reqd,$conditions);
3768: }
3769:
3770: sub auto_checkphotos {
3771: my ($uname,$udom,$pid) = @_;
3772: my $homeserver = &homeserver($uname,$udom);
3773: my ($result,$resulttype);
3774: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
3775: &escape($uname).':'.&escape($pid),
3776: $homeserver));
3777: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3778: return (undef,undef);
3779: }
3780: if ($outcome) {
3781: ($result,$resulttype) = split(/:/,$outcome);
3782: }
3783: return ($result,$resulttype);
3784: }
3785:
3786: sub auto_photochoice {
3787: my ($cnum,$cdom) = @_;
3788: my $homeserver = &homeserver($cnum,$cdom);
3789: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
3790: &escape($cdom),
3791: $homeserver)));
3792: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3793: return (undef,undef);
3794: }
3795: return ($update,$comment);
3796: }
3797:
3798: sub auto_photoupdate {
3799: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3800: my $homeserver = &homeserver($cnum,$dom);
3801: my $host=$hostname{$homeserver};
3802: my $cmd = '';
3803: my $maxtries = 1;
3804: foreach (keys %{$affiliatesref}) {
3805: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3806: }
3807: $cmd =~ s/%%$//;
3808: $cmd = &escape($cmd);
3809: my $query = 'institutionalphotos';
3810: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3811: unless ($queryid=~/^\Q$host\E\_/) {
3812: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3813: return 'error: '.$queryid;
3814: }
3815: my $reply = &get_query_reply($queryid);
3816: my $tries = 1;
3817: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3818: $reply = &get_query_reply($queryid);
3819: $tries ++;
3820: }
3821: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3822: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3823: } else {
3824: my @responses = split(/:/,$reply);
3825: my $outcome = shift(@responses);
3826: foreach my $item (@responses) {
3827: my ($key,$value) = split(/=/,$item);
3828: $$photo{$key} = $value;
3829: }
3830: return $outcome;
3831: }
3832: return 'error';
3833: }
3834:
3835: sub auto_instcode_format {
3836: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3837: my $courses = '';
3838: my $homeserver;
3839: if ($caller eq 'global') {
3840: foreach my $tryserver (keys %libserv) {
3841: if ($hostdom{$tryserver} eq $codedom) {
3842: $homeserver = $tryserver;
3843: last;
3844: }
3845: }
3846: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3847: $homeserver = &homeserver($env{'user.name'},$codedom);
3848: }
3849: } else {
3850: $homeserver = &homeserver($caller,$codedom);
3851: }
3852: foreach (keys %{$instcodes}) {
3853: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3854: }
3855: chop($courses);
3856: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3857: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3858: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3859: %{$codes} = &str2hash($codes_str);
3860: @{$codetitles} = &str2array($codetitles_str);
3861: %{$cat_titles} = &str2hash($cat_titles_str);
3862: %{$cat_order} = &str2hash($cat_order_str);
3863: return 'ok';
3864: }
3865: return $response;
3866: }
3867:
3868: # ------------------------------------------------------- Course Group routines
3869:
3870: sub get_coursegroups {
3871: my ($cdom,$cnum,$group) = @_;
3872: return(&dump('coursegroups',$cdom,$cnum,$group));
3873: }
3874:
3875: sub modify_coursegroup {
3876: my ($cdom,$cnum,$groupsettings) = @_;
3877: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
3878: }
3879:
3880: sub modify_group_roles {
3881: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
3882: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
3883: my $role = 'gr/'.&escape($userprivs);
3884: my ($uname,$udom) = split(/:/,$user);
3885: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
3886: if ($result eq 'ok') {
3887: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
3888: }
3889:
3890: return $result;
3891: }
3892:
3893: sub modify_coursegroup_membership {
3894: my ($cdom,$cnum,$membership) = @_;
3895: my $result = &put('groupmembership',$membership,$cdom,$cnum);
3896: return $result;
3897: }
3898:
3899: sub get_active_groups {
3900: my ($udom,$uname,$cdom,$cnum) = @_;
3901: my $now = time;
3902: my %groups = ();
3903: foreach my $key (keys(%env)) {
3904: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
3905: my ($start,$end) = split(/\./,$env{$key});
3906: if (($end!=0) && ($end<$now)) { next; }
3907: if (($start!=0) && ($start>$now)) { next; }
3908: if ($1 eq $cdom && $2 eq $cnum) {
3909: $groups{$3} = $env{$key} ;
3910: }
3911: }
3912: }
3913: return %groups;
3914: }
3915:
3916: sub get_group_membership {
3917: my ($cdom,$cnum,$group) = @_;
3918: return(&dump('groupmembership',$cdom,$cnum,$group));
3919: }
3920:
3921: sub get_users_groups {
3922: my ($udom,$uname,$courseid) = @_;
3923: my $cachetime=1800;
3924: $courseid=~s/\_/\//g;
3925: $courseid=~s/^(\w)/\/$1/;
3926:
3927: my $hashid="$udom:$uname:$courseid";
3928: my ($result,$cached)=&is_cached_new('getgroups',$hashid);
3929: if (defined($cached)) { return $result; }
3930:
3931: my %roleshash = &dump('roles',$udom,$uname,$courseid);
3932: my ($tmp) = keys(%roleshash);
3933: if ($tmp=~/^error:/) {
3934: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
3935: return '';
3936: } else {
3937: my $grouplist;
3938: foreach my $key (keys %roleshash) {
3939: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
3940: unless ($roleshash{$key} =~ /_1_1$/) { # deleted membership
3941: $grouplist .= $1.':';
3942: }
3943: }
3944: }
3945: $grouplist =~ s/:$//;
3946: return &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
3947: }
3948: }
3949:
3950: sub devalidate_getgroups_cache {
3951: my ($udom,$uname,$cdom,$cnum)=@_;
3952: my $courseid = $cdom.'_'.$cnum;
3953: $courseid=~s/\_/\//g;
3954: $courseid=~s/^(\w)/\/$1/;
3955: my $hashid="$udom:$uname:$courseid";
3956: &devalidate_cache_new('getgroups',$hashid);
3957: }
3958:
3959: # ------------------------------------------------------------------ Plain Text
3960:
3961: sub plaintext {
3962: my $short=shift;
3963: return &Apache::lonlocal::mt($prp{$short});
3964: }
3965:
3966: # ----------------------------------------------------------------- Assign Role
3967:
3968: sub assignrole {
3969: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
3970: my $mrole;
3971: if ($role =~ /^cr\//) {
3972: my $cwosec=$url;
3973: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
3974: unless (&allowed('ccr',$cwosec)) {
3975: &logthis('Refused custom assignrole: '.
3976: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3977: $env{'user.name'}.' at '.$env{'user.domain'});
3978: return 'refused';
3979: }
3980: $mrole='cr';
3981: } elsif ($role =~ /^gr\//) {
3982: my $cwogrp=$url;
3983: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
3984: unless (&allowed('mdg',$cwogrp)) {
3985: &logthis('Refused group assignrole: '.
3986: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3987: $env{'user.name'}.' at '.$env{'user.domain'});
3988: return 'refused';
3989: }
3990: $mrole='gr';
3991: } else {
3992: my $cwosec=$url;
3993: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
3994: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
3995: &logthis('Refused assignrole: '.
3996: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3997: $env{'user.name'}.' at '.$env{'user.domain'});
3998: return 'refused';
3999: }
4000: $mrole=$role;
4001: }
4002: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4003: "$udom:$uname:$url".'_'."$mrole=$role";
4004: if ($end) { $command.='_'.$end; }
4005: if ($start) {
4006: if ($end) {
4007: $command.='_'.$start;
4008: } else {
4009: $command.='_0_'.$start;
4010: }
4011: }
4012: # actually delete
4013: if ($deleteflag) {
4014: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4015: # modify command to delete the role
4016: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4017: "$udom:$uname:$url".'_'."$mrole";
4018: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4019: # set start and finish to negative values for userrolelog
4020: $start=-1;
4021: $end=-1;
4022: }
4023: }
4024: # send command
4025: my $answer=&reply($command,&homeserver($uname,$udom));
4026: # log new user role if status is ok
4027: if ($answer eq 'ok') {
4028: &userrolelog($role,$uname,$udom,$url,$start,$end);
4029: }
4030: return $answer;
4031: }
4032:
4033: # -------------------------------------------------- Modify user authentication
4034: # Overrides without validation
4035:
4036: sub modifyuserauth {
4037: my ($udom,$uname,$umode,$upass)=@_;
4038: my $uhome=&homeserver($uname,$udom);
4039: unless (&allowed('mau',$udom)) { return 'refused'; }
4040: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4041: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4042: ' in domain '.$env{'request.role.domain'});
4043: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4044: &escape($upass),$uhome);
4045: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4046: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4047: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4048: &log($udom,,$uname,$uhome,
4049: 'Authentication changed by '.$env{'user.domain'}.', '.
4050: $env{'user.name'}.', '.$umode.
4051: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4052: unless ($reply eq 'ok') {
4053: &logthis('Authentication mode error: '.$reply);
4054: return 'error: '.$reply;
4055: }
4056: return 'ok';
4057: }
4058:
4059: # --------------------------------------------------------------- Modify a user
4060:
4061: sub modifyuser {
4062: my ($udom, $uname, $uid,
4063: $umode, $upass, $first,
4064: $middle, $last, $gene,
4065: $forceid, $desiredhome, $email)=@_;
4066: $udom=~s/\W//g;
4067: $uname=~s/\W//g;
4068: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4069: $umode.', '.$first.', '.$middle.', '.
4070: $last.', '.$gene.'(forceid: '.$forceid.')'.
4071: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4072: ' desiredhome not specified').
4073: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4074: ' in domain '.$env{'request.role.domain'});
4075: my $uhome=&homeserver($uname,$udom,'true');
4076: # ----------------------------------------------------------------- Create User
4077: if (($uhome eq 'no_host') &&
4078: (($umode && $upass) || ($umode eq 'localauth'))) {
4079: my $unhome='';
4080: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4081: $unhome = $desiredhome;
4082: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4083: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4084: } else { # load balancing routine for determining $unhome
4085: my $tryserver;
4086: my $loadm=10000000;
4087: foreach $tryserver (keys %libserv) {
4088: if ($hostdom{$tryserver} eq $udom) {
4089: my $answer=reply('load',$tryserver);
4090: if (($answer=~/\d+/) && ($answer<$loadm)) {
4091: $loadm=$answer;
4092: $unhome=$tryserver;
4093: }
4094: }
4095: }
4096: }
4097: if (($unhome eq '') || ($unhome eq 'no_host')) {
4098: return 'error: unable to find a home server for '.$uname.
4099: ' in domain '.$udom;
4100: }
4101: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4102: &escape($upass),$unhome);
4103: unless ($reply eq 'ok') {
4104: return 'error: '.$reply;
4105: }
4106: $uhome=&homeserver($uname,$udom,'true');
4107: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4108: return 'error: unable verify users home machine.';
4109: }
4110: } # End of creation of new user
4111: # ---------------------------------------------------------------------- Add ID
4112: if ($uid) {
4113: $uid=~tr/A-Z/a-z/;
4114: my %uidhash=&idrget($udom,$uname);
4115: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4116: && (!$forceid)) {
4117: unless ($uid eq $uidhash{$uname}) {
4118: return 'error: user id "'.$uid.'" does not match '.
4119: 'current user id "'.$uidhash{$uname}.'".';
4120: }
4121: } else {
4122: &idput($udom,($uname => $uid));
4123: }
4124: }
4125: # -------------------------------------------------------------- Add names, etc
4126: my @tmp=&get('environment',
4127: ['firstname','middlename','lastname','generation'],
4128: $udom,$uname);
4129: my %names;
4130: if ($tmp[0] =~ m/^error:.*/) {
4131: %names=();
4132: } else {
4133: %names = @tmp;
4134: }
4135: #
4136: # Make sure to not trash student environment if instructor does not bother
4137: # to supply name and email information
4138: #
4139: if ($first) { $names{'firstname'} = $first; }
4140: if (defined($middle)) { $names{'middlename'} = $middle; }
4141: if ($last) { $names{'lastname'} = $last; }
4142: if (defined($gene)) { $names{'generation'} = $gene; }
4143: if ($email) {
4144: $email=~s/[^\w\@\.\-\,]//gs;
4145: if ($email=~/\@/) { $names{'notification'} = $email;
4146: $names{'critnotification'} = $email;
4147: $names{'permanentemail'} = $email; }
4148: }
4149: my $reply = &put('environment', \%names, $udom,$uname);
4150: if ($reply ne 'ok') { return 'error: '.$reply; }
4151: &devalidate_cache_new('namescache',$uname.':'.$udom);
4152: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4153: $umode.', '.$first.', '.$middle.', '.
4154: $last.', '.$gene.' by '.
4155: $env{'user.name'}.' at '.$env{'user.domain'});
4156: return 'ok';
4157: }
4158:
4159: # -------------------------------------------------------------- Modify student
4160:
4161: sub modifystudent {
4162: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4163: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4164: if (!$cid) {
4165: unless ($cid=$env{'request.course.id'}) {
4166: return 'not_in_class';
4167: }
4168: }
4169: # --------------------------------------------------------------- Make the user
4170: my $reply=&modifyuser
4171: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4172: $desiredhome,$email);
4173: unless ($reply eq 'ok') { return $reply; }
4174: # This will cause &modify_student_enrollment to get the uid from the
4175: # students environment
4176: $uid = undef if (!$forceid);
4177: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4178: $gene,$usec,$end,$start,$type,$locktype,$cid);
4179: return $reply;
4180: }
4181:
4182: sub modify_student_enrollment {
4183: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4184: my ($cdom,$cnum,$chome);
4185: if (!$cid) {
4186: unless ($cid=$env{'request.course.id'}) {
4187: return 'not_in_class';
4188: }
4189: $cdom=$env{'course.'.$cid.'.domain'};
4190: $cnum=$env{'course.'.$cid.'.num'};
4191: } else {
4192: ($cdom,$cnum)=split(/_/,$cid);
4193: }
4194: $chome=$env{'course.'.$cid.'.home'};
4195: if (!$chome) {
4196: $chome=&homeserver($cnum,$cdom);
4197: }
4198: if (!$chome) { return 'unknown_course'; }
4199: # Make sure the user exists
4200: my $uhome=&homeserver($uname,$udom);
4201: if (($uhome eq '') || ($uhome eq 'no_host')) {
4202: return 'error: no such user';
4203: }
4204: # Get student data if we were not given enough information
4205: if (!defined($first) || $first eq '' ||
4206: !defined($last) || $last eq '' ||
4207: !defined($uid) || $uid eq '' ||
4208: !defined($middle) || $middle eq '' ||
4209: !defined($gene) || $gene eq '') {
4210: # They did not supply us with enough data to enroll the student, so
4211: # we need to pick up more information.
4212: my %tmp = &get('environment',
4213: ['firstname','middlename','lastname', 'generation','id']
4214: ,$udom,$uname);
4215:
4216: #foreach (keys(%tmp)) {
4217: # &logthis("key $_ = ".$tmp{$_});
4218: #}
4219: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4220: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4221: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4222: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4223: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4224: }
4225: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4226: my $reply=cput('classlist',
4227: {"$uname:$udom" =>
4228: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4229: $cdom,$cnum);
4230: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4231: return 'error: '.$reply;
4232: } else {
4233: &devalidate_getsection_cache($udom,$uname,$cid);
4234: }
4235: # Add student role to user
4236: my $uurl='/'.$cid;
4237: $uurl=~s/\_/\//g;
4238: if ($usec) {
4239: $uurl.='/'.$usec;
4240: }
4241: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4242: }
4243:
4244: sub format_name {
4245: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4246: my $name;
4247: if ($first ne 'lastname') {
4248: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4249: } else {
4250: if ($lastname=~/\S/) {
4251: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4252: $name=~s/\s+,/,/;
4253: } else {
4254: $name.= $firstname.' '.$middlename.' '.$generation;
4255: }
4256: }
4257: $name=~s/^\s+//;
4258: $name=~s/\s+$//;
4259: $name=~s/\s+/ /g;
4260: return $name;
4261: }
4262:
4263: # ------------------------------------------------- Write to course preferences
4264:
4265: sub writecoursepref {
4266: my ($courseid,%prefs)=@_;
4267: $courseid=~s/^\///;
4268: $courseid=~s/\_/\//g;
4269: my ($cdomain,$cnum)=split(/\//,$courseid);
4270: my $chome=homeserver($cnum,$cdomain);
4271: if (($chome eq '') || ($chome eq 'no_host')) {
4272: return 'error: no such course';
4273: }
4274: my $cstring='';
4275: foreach (keys %prefs) {
4276: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
4277: }
4278: $cstring=~s/\&$//;
4279: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4280: }
4281:
4282: # ---------------------------------------------------------- Make/modify course
4283:
4284: sub createcourse {
4285: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner)=@_;
4286: $url=&declutter($url);
4287: my $cid='';
4288: unless (&allowed('ccc',$udom)) {
4289: return 'refused';
4290: }
4291: # ------------------------------------------------------------------- Create ID
4292: my $uname=int(1+rand(9)).
4293: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4294: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4295: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4296: # ----------------------------------------------- Make sure that does not exist
4297: my $uhome=&homeserver($uname,$udom,'true');
4298: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4299: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4300: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4301: $uhome=&homeserver($uname,$udom,'true');
4302: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4303: return 'error: unable to generate unique course-ID';
4304: }
4305: }
4306: # ------------------------------------------------ Check supplied server name
4307: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4308: if (! exists($libserv{$course_server})) {
4309: return 'error:bad server name '.$course_server;
4310: }
4311: # ------------------------------------------------------------- Make the course
4312: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4313: $course_server);
4314: unless ($reply eq 'ok') { return 'error: '.$reply; }
4315: $uhome=&homeserver($uname,$udom,'true');
4316: if (($uhome eq '') || ($uhome eq 'no_host')) {
4317: return 'error: no such course';
4318: }
4319: # ----------------------------------------------------------------- Course made
4320: # log existence
4321: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4322: ':'.&escape($inst_code).':'.&escape($course_owner),$uhome);
4323: &flushcourselogs();
4324: # set toplevel url
4325: my $topurl=$url;
4326: unless ($nonstandard) {
4327: # ------------------------------------------ For standard courses, make top url
4328: my $mapurl=&clutter($url);
4329: if ($mapurl eq '/res/') { $mapurl=''; }
4330: $env{'form.initmap'}=(<<ENDINITMAP);
4331: <map>
4332: <resource id="1" type="start"></resource>
4333: <resource id="2" src="$mapurl"></resource>
4334: <resource id="3" type="finish"></resource>
4335: <link index="1" from="1" to="2"></link>
4336: <link index="2" from="2" to="3"></link>
4337: </map>
4338: ENDINITMAP
4339: $topurl=&declutter(
4340: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4341: );
4342: }
4343: # ----------------------------------------------------------- Write preferences
4344: &writecoursepref($udom.'_'.$uname,
4345: ('description' => $description,
4346: 'url' => $topurl));
4347: return '/'.$udom.'/'.$uname;
4348: }
4349:
4350: # ---------------------------------------------------------- Assign Custom Role
4351:
4352: sub assigncustomrole {
4353: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4354: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4355: $end,$start,$deleteflag);
4356: }
4357:
4358: # ----------------------------------------------------------------- Revoke Role
4359:
4360: sub revokerole {
4361: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4362: my $now=time;
4363: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4364: }
4365:
4366: # ---------------------------------------------------------- Revoke Custom Role
4367:
4368: sub revokecustomrole {
4369: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4370: my $now=time;
4371: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4372: $deleteflag);
4373: }
4374:
4375: # ------------------------------------------------------------ Disk usage
4376: sub diskusage {
4377: my ($udom,$uname,$directoryRoot)=@_;
4378: $directoryRoot =~ s/\/$//;
4379: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4380: return $listing;
4381: }
4382:
4383: sub is_locked {
4384: my ($file_name, $domain, $user) = @_;
4385: my @check;
4386: my $is_locked;
4387: push @check, $file_name;
4388: my %locked = &get('file_permissions',\@check,
4389: $env{'user.domain'},$env{'user.name'});
4390: my ($tmp)=keys(%locked);
4391: if ($tmp=~/^error:/) { undef(%locked); }
4392:
4393: if (ref($locked{$file_name}) eq 'ARRAY') {
4394: $is_locked = 'true';
4395: } else {
4396: $is_locked = 'false';
4397: }
4398: }
4399:
4400: # ------------------------------------------------------------- Mark as Read Only
4401:
4402: sub mark_as_readonly {
4403: my ($domain,$user,$files,$what) = @_;
4404: my %current_permissions = &dump('file_permissions',$domain,$user);
4405: my ($tmp)=keys(%current_permissions);
4406: if ($tmp=~/^error:/) { undef(%current_permissions); }
4407: foreach my $file (@{$files}) {
4408: push(@{$current_permissions{$file}},$what);
4409: }
4410: &put('file_permissions',\%current_permissions,$domain,$user);
4411: return;
4412: }
4413:
4414: # ------------------------------------------------------------Save Selected Files
4415:
4416: sub save_selected_files {
4417: my ($user, $path, @files) = @_;
4418: my $filename = $user."savedfiles";
4419: my @other_files = &files_not_in_path($user, $path);
4420: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4421: foreach my $file (@files) {
4422: print (OUT $env{'form.currentpath'}.$file."\n");
4423: }
4424: foreach my $file (@other_files) {
4425: print (OUT $file."\n");
4426: }
4427: close (OUT);
4428: return 'ok';
4429: }
4430:
4431: sub clear_selected_files {
4432: my ($user) = @_;
4433: my $filename = $user."savedfiles";
4434: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4435: print (OUT undef);
4436: close (OUT);
4437: return ("ok");
4438: }
4439:
4440: sub files_in_path {
4441: my ($user, $path) = @_;
4442: my $filename = $user."savedfiles";
4443: my %return_files;
4444: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4445: while (my $line_in = <IN>) {
4446: chomp ($line_in);
4447: my @paths_and_file = split (m!/!, $line_in);
4448: my $file_part = pop (@paths_and_file);
4449: my $path_part = join ('/', @paths_and_file);
4450: $path_part.='/';
4451: my $path_and_file = $path_part.$file_part;
4452: if ($path_part eq $path) {
4453: $return_files{$file_part}= 'selected';
4454: }
4455: }
4456: close (IN);
4457: return (\%return_files);
4458: }
4459:
4460: # called in portfolio select mode, to show files selected NOT in current directory
4461: sub files_not_in_path {
4462: my ($user, $path) = @_;
4463: my $filename = $user."savedfiles";
4464: my @return_files;
4465: my $path_part;
4466: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4467: while (<IN>) {
4468: #ok, I know it's clunky, but I want it to work
4469: my @paths_and_file = split m!/!, $_;
4470: my $file_part = pop (@paths_and_file);
4471: chomp ($file_part);
4472: my $path_part = join ('/', @paths_and_file);
4473: $path_part .= '/';
4474: my $path_and_file = $path_part.$file_part;
4475: if ($path_part ne $path) {
4476: push (@return_files, ($path_and_file));
4477: }
4478: }
4479: close (OUT);
4480: return (@return_files);
4481: }
4482:
4483: #--------------------------------------------------------------Get Marked as Read Only
4484:
4485:
4486: sub get_marked_as_readonly {
4487: my ($domain,$user,$what) = @_;
4488: my %current_permissions = &dump('file_permissions',$domain,$user);
4489: my ($tmp)=keys(%current_permissions);
4490: if ($tmp=~/^error:/) { undef(%current_permissions); }
4491: my @readonly_files;
4492: my $cmp1=$what;
4493: if (ref($what)) { $cmp1=join('',@{$what}) };
4494: while (my ($file_name,$value) = each(%current_permissions)) {
4495: if (ref($value) eq "ARRAY"){
4496: foreach my $stored_what (@{$value}) {
4497: my $cmp2=$stored_what;
4498: if (ref($stored_what)) { $cmp2=join('',@{$stored_what}) };
4499: if ($cmp1 eq $cmp2) {
4500: push(@readonly_files, $file_name);
4501: } elsif (!defined($what)) {
4502: push(@readonly_files, $file_name);
4503: }
4504: }
4505: }
4506: }
4507: return @readonly_files;
4508: }
4509: #-----------------------------------------------------------Get Marked as Read Only Hash
4510:
4511: sub get_marked_as_readonly_hash {
4512: my ($domain,$user,$what) = @_;
4513: my %current_permissions = &dump('file_permissions',$domain,$user);
4514: my ($tmp)=keys(%current_permissions);
4515: if ($tmp=~/^error:/) { undef(%current_permissions); }
4516:
4517: my %readonly_files;
4518: while (my ($file_name,$value) = each(%current_permissions)) {
4519: if (ref($value) eq "ARRAY"){
4520: foreach my $stored_what (@{$value}) {
4521: if ($stored_what eq $what) {
4522: $readonly_files{$file_name} = 'locked';
4523: } elsif (!defined($what)) {
4524: $readonly_files{$file_name} = 'locked';
4525: }
4526: }
4527: }
4528: }
4529: return %readonly_files;
4530: }
4531: # ------------------------------------------------------------ Unmark as Read Only
4532:
4533: sub unmark_as_readonly {
4534: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4535: # for portfolio submissions, $what contains [$symb,$crsid]
4536: my ($domain,$user,$what,$file_name) = @_;
4537: my $symb_crs = $what;
4538: if (ref($what)) { $symb_crs=join('',@$what); }
4539: my %current_permissions = &dump('file_permissions',$domain,$user);
4540: my ($tmp)=keys(%current_permissions);
4541: if ($tmp=~/^error:/) { undef(%current_permissions); }
4542: my @readonly_files = &get_marked_as_readonly($domain,$user,$what);
4543: foreach my $file (@readonly_files) {
4544: if (defined($file_name) && ($file_name ne $file)) { next; }
4545: my $current_locks = $current_permissions{$file};
4546: my @new_locks;
4547: my @del_keys;
4548: if (ref($current_locks) eq "ARRAY"){
4549: foreach my $locker (@{$current_locks}) {
4550: my $compare=$locker;
4551: if (ref($locker)) { $compare=join('',@{$locker}) };
4552: if ($compare ne $symb_crs) {
4553: push(@new_locks, $locker);
4554: }
4555: }
4556: if (scalar(@new_locks) > 0) {
4557: $current_permissions{$file} = \@new_locks;
4558: } else {
4559: push(@del_keys, $file);
4560: &del('file_permissions',\@del_keys, $domain, $user);
4561: delete($current_permissions{$file});
4562: }
4563: }
4564: }
4565: &put('file_permissions',\%current_permissions,$domain,$user);
4566: return;
4567: }
4568:
4569: # ------------------------------------------------------------ Directory lister
4570:
4571: sub dirlist {
4572: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4573:
4574: $uri=~s/^\///;
4575: $uri=~s/\/$//;
4576: my ($udom, $uname);
4577: (undef,$udom,$uname)=split(/\//,$uri);
4578: if(defined($userdomain)) {
4579: $udom = $userdomain;
4580: }
4581: if(defined($username)) {
4582: $uname = $username;
4583: }
4584:
4585: my $dirRoot = $perlvar{'lonDocRoot'};
4586: if(defined($alternateDirectoryRoot)) {
4587: $dirRoot = $alternateDirectoryRoot;
4588: $dirRoot =~ s/\/$//;
4589: }
4590:
4591: if($udom) {
4592: if($uname) {
4593: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
4594: homeserver($uname,$udom));
4595: my @listing_results;
4596: if ($listing eq 'unknown_cmd') {
4597: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4598: homeserver($uname,$udom));
4599: @listing_results = split(/:/,$listing);
4600: } else {
4601: @listing_results = map { &unescape($_); } split(/:/,$listing);
4602: }
4603: return @listing_results;
4604: } elsif(!defined($alternateDirectoryRoot)) {
4605: my $tryserver;
4606: my %allusers=();
4607: foreach $tryserver (keys %libserv) {
4608: if($hostdom{$tryserver} eq $udom) {
4609: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
4610: $udom, $tryserver);
4611: my @listing_results;
4612: if ($listing eq 'unknown_cmd') {
4613: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4614: $udom, $tryserver);
4615: @listing_results = split(/:/,$listing);
4616: } else {
4617: @listing_results =
4618: map { &unescape($_); } split(/:/,$listing);
4619: }
4620: if ($listing_results[0] ne 'no_such_dir' &&
4621: $listing_results[0] ne 'empty' &&
4622: $listing_results[0] ne 'con_lost') {
4623: foreach (@listing_results) {
4624: my ($entry,@stat)=split(/&/,$_);
4625: $allusers{$entry}=1;
4626: }
4627: }
4628: }
4629: }
4630: my $alluserstr='';
4631: foreach (sort keys %allusers) {
4632: $alluserstr.=$_.'&user:';
4633: }
4634: $alluserstr=~s/:$//;
4635: return split(/:/,$alluserstr);
4636: } else {
4637: my @emptyResults = ();
4638: push(@emptyResults, 'missing user name');
4639: return split(':',@emptyResults);
4640: }
4641: } elsif(!defined($alternateDirectoryRoot)) {
4642: my $tryserver;
4643: my %alldom=();
4644: foreach $tryserver (keys %libserv) {
4645: $alldom{$hostdom{$tryserver}}=1;
4646: }
4647: my $alldomstr='';
4648: foreach (sort keys %alldom) {
4649: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
4650: }
4651: $alldomstr=~s/:$//;
4652: return split(/:/,$alldomstr);
4653: } else {
4654: my @emptyResults = ();
4655: push(@emptyResults, 'missing domain');
4656: return split(':',@emptyResults);
4657: }
4658: }
4659:
4660: # --------------------------------------------- GetFileTimestamp
4661: # This function utilizes dirlist and returns the date stamp for
4662: # when it was last modified. It will also return an error of -1
4663: # if an error occurs
4664:
4665: ##
4666: ## FIXME: This subroutine assumes its caller knows something about the
4667: ## directory structure of the home server for the student ($root).
4668: ## Not a good assumption to make. Since this is for looking up files
4669: ## in user directories, the full path should be constructed by lond, not
4670: ## whatever machine we request data from.
4671: ##
4672: sub GetFileTimestamp {
4673: my ($studentDomain,$studentName,$filename,$root)=@_;
4674: $studentDomain=~s/\W//g;
4675: $studentName=~s/\W//g;
4676: my $subdir=$studentName.'__';
4677: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4678: my $proname="$studentDomain/$subdir/$studentName";
4679: $proname .= '/'.$filename;
4680: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
4681: $studentName, $root);
4682: my @stats = split('&', $fileStat);
4683: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
4684: # @stats contains first the filename, then the stat output
4685: return $stats[10]; # so this is 10 instead of 9.
4686: } else {
4687: return -1;
4688: }
4689: }
4690:
4691: sub stat_file {
4692: my ($uri) = @_;
4693: $uri = &clutter($uri);
4694: my ($udom,$uname,$file,$dir);
4695: if ($uri =~ m-^/(uploaded|editupload)/-) {
4696: ($udom,$uname,$file) =
4697: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
4698: $file = 'userfiles/'.$file;
4699: $dir = &Apache::loncommon::propath($udom,$uname);
4700: }
4701: if ($uri =~ m-^/res/-) {
4702: ($udom,$uname) =
4703: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
4704: $file = $uri;
4705: }
4706:
4707: if (!$udom || !$uname || !$file) {
4708: # unable to handle the uri
4709: return ();
4710: }
4711:
4712: my ($result) = &dirlist($file,$udom,$uname,$dir);
4713: my @stats = split('&', $result);
4714: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
4715: shift(@stats); #filename is first
4716: return @stats;
4717: }
4718: return ();
4719: }
4720:
4721: # -------------------------------------------------------- Value of a Condition
4722:
4723: # gets the value of a specific preevaluated condition
4724: # stored in the string $env{user.state.<cid>}
4725: # or looks up a condition reference in the bighash and if if hasn't
4726: # already been evaluated recurses into docondval to get the value of
4727: # the condition, then memoizing it to
4728: # $env{user.state.<cid>.<condition>}
4729: sub directcondval {
4730: my $number=shift;
4731: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
4732: &Apache::lonuserstate::evalstate();
4733: }
4734: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
4735: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
4736: } elsif ($number =~ /^_/) {
4737: my $sub_condition;
4738: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4739: &GDBM_READER(),0640)) {
4740: $sub_condition=$bighash{'conditions'.$number};
4741: untie(%bighash);
4742: }
4743: my $value = &docondval($sub_condition);
4744: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
4745: return $value;
4746: }
4747: if ($env{'user.state.'.$env{'request.course.id'}}) {
4748: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
4749: } else {
4750: return 2;
4751: }
4752: }
4753:
4754: # get the collection of conditions for this resource
4755: sub condval {
4756: my $condidx=shift;
4757: my $allpathcond='';
4758: foreach my $cond (split(/\|/,$condidx)) {
4759: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
4760: $allpathcond.=
4761: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
4762: }
4763: }
4764: $allpathcond=~s/\|$//;
4765: return &docondval($allpathcond);
4766: }
4767:
4768: #evaluates an expression of conditions
4769: sub docondval {
4770: my ($allpathcond) = @_;
4771: my $result=0;
4772: if ($env{'request.course.id'}
4773: && defined($allpathcond)) {
4774: my $operand='|';
4775: my @stack;
4776: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
4777: if ($chunk eq '(') {
4778: push @stack,($operand,$result);
4779: } elsif ($chunk eq ')') {
4780: my $before=pop @stack;
4781: if (pop @stack eq '&') {
4782: $result=$result>$before?$before:$result;
4783: } else {
4784: $result=$result>$before?$result:$before;
4785: }
4786: } elsif (($chunk eq '&') || ($chunk eq '|')) {
4787: $operand=$chunk;
4788: } else {
4789: my $new=directcondval($chunk);
4790: if ($operand eq '&') {
4791: $result=$result>$new?$new:$result;
4792: } else {
4793: $result=$result>$new?$result:$new;
4794: }
4795: }
4796: }
4797: }
4798: return $result;
4799: }
4800:
4801: # ---------------------------------------------------- Devalidate courseresdata
4802:
4803: sub devalidatecourseresdata {
4804: my ($coursenum,$coursedomain)=@_;
4805: my $hashid=$coursenum.':'.$coursedomain;
4806: &devalidate_cache_new('courseres',$hashid);
4807: }
4808:
4809: # --------------------------------------------------- Course Resourcedata Query
4810:
4811: sub get_courseresdata {
4812: my ($coursenum,$coursedomain)=@_;
4813: my $coursehom=&homeserver($coursenum,$coursedomain);
4814: my $hashid=$coursenum.':'.$coursedomain;
4815: my ($result,$cached)=&is_cached_new('courseres',$hashid);
4816: my %dumpreply;
4817: unless (defined($cached)) {
4818: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
4819: $result=\%dumpreply;
4820: my ($tmp) = keys(%dumpreply);
4821: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
4822: &do_cache_new('courseres',$hashid,$result,600);
4823: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
4824: return $tmp;
4825: } elsif ($tmp =~ /^(error)/) {
4826: $result=undef;
4827: &do_cache_new('courseres',$hashid,$result,600);
4828: }
4829: }
4830: return $result;
4831: }
4832:
4833: sub devalidateuserresdata {
4834: my ($uname,$udom)=@_;
4835: my $hashid="$udom:$uname";
4836: &devalidate_cache_new('userres',$hashid);
4837: }
4838:
4839: sub get_userresdata {
4840: my ($uname,$udom)=@_;
4841: #most student don\'t have any data set, check if there is some data
4842: if (&EXT_cache_status($udom,$uname)) { return undef; }
4843:
4844: my $hashid="$udom:$uname";
4845: my ($result,$cached)=&is_cached_new('userres',$hashid);
4846: if (!defined($cached)) {
4847: my %resourcedata=&dump('resourcedata',$udom,$uname);
4848: $result=\%resourcedata;
4849: &do_cache_new('userres',$hashid,$result,600);
4850: }
4851: my ($tmp)=keys(%$result);
4852: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
4853: return $result;
4854: }
4855: #error 2 occurs when the .db doesn't exist
4856: if ($tmp!~/error: 2 /) {
4857: &logthis("<font color=\"blue\">WARNING:".
4858: " Trying to get resource data for ".
4859: $uname." at ".$udom.": ".
4860: $tmp."</font>");
4861: } elsif ($tmp=~/error: 2 /) {
4862: #&EXT_cache_set($udom,$uname);
4863: &do_cache_new('userres',$hashid,undef,600);
4864: undef($tmp); # not really an error so don't send it back
4865: }
4866: return $tmp;
4867: }
4868:
4869: sub resdata {
4870: my ($name,$domain,$type,@which)=@_;
4871: my $result;
4872: if ($type eq 'course') {
4873: $result=&get_courseresdata($name,$domain);
4874: } elsif ($type eq 'user') {
4875: $result=&get_userresdata($name,$domain);
4876: }
4877: if (!ref($result)) { return $result; }
4878: foreach my $item (@which) {
4879: if (defined($result->{$item})) {
4880: return $result->{$item};
4881: }
4882: }
4883: return undef;
4884: }
4885:
4886: #
4887: # EXT resource caching routines
4888: #
4889:
4890: sub clear_EXT_cache_status {
4891: &delenv('cache.EXT.');
4892: }
4893:
4894: sub EXT_cache_status {
4895: my ($target_domain,$target_user) = @_;
4896: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
4897: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
4898: # We know already the user has no data
4899: return 1;
4900: } else {
4901: return 0;
4902: }
4903: }
4904:
4905: sub EXT_cache_set {
4906: my ($target_domain,$target_user) = @_;
4907: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
4908: #&appenv($cachename => time);
4909: }
4910:
4911: # --------------------------------------------------------- Value of a Variable
4912: sub EXT {
4913: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
4914:
4915: unless ($varname) { return ''; }
4916: #get real user name/domain, courseid and symb
4917: my $courseid;
4918: my $publicuser;
4919: if ($symbparm) {
4920: $symbparm=&get_symb_from_alias($symbparm);
4921: }
4922: if (!($uname && $udom)) {
4923: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
4924: &Apache::lonxml::whichuser($symbparm);
4925: if (!$symbparm) { $symbparm=$cursymb; }
4926: } else {
4927: $courseid=$env{'request.course.id'};
4928: }
4929: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
4930: my $rest;
4931: if (defined($therest[0])) {
4932: $rest=join('.',@therest);
4933: } else {
4934: $rest='';
4935: }
4936:
4937: my $qualifierrest=$qualifier;
4938: if ($rest) { $qualifierrest.='.'.$rest; }
4939: my $spacequalifierrest=$space;
4940: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
4941: if ($realm eq 'user') {
4942: # --------------------------------------------------------------- user.resource
4943: if ($space eq 'resource') {
4944: if ( (defined($Apache::lonhomework::parsing_a_problem)
4945: || defined($Apache::lonhomework::parsing_a_task))
4946: &&
4947: ($symbparm eq &symbread()) ) {
4948: return $Apache::lonhomework::history{$qualifierrest};
4949: } else {
4950: my %restored;
4951: if ($publicuser || $env{'request.state'} eq 'construct') {
4952: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
4953: } else {
4954: %restored=&restore($symbparm,$courseid,$udom,$uname);
4955: }
4956: return $restored{$qualifierrest};
4957: }
4958: # ----------------------------------------------------------------- user.access
4959: } elsif ($space eq 'access') {
4960: # FIXME - not supporting calls for a specific user
4961: return &allowed($qualifier,$rest);
4962: # ------------------------------------------ user.preferences, user.environment
4963: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
4964: if (($uname eq $env{'user.name'}) &&
4965: ($udom eq $env{'user.domain'})) {
4966: return $env{join('.',('environment',$qualifierrest))};
4967: } else {
4968: my %returnhash;
4969: if (!$publicuser) {
4970: %returnhash=&userenvironment($udom,$uname,
4971: $qualifierrest);
4972: }
4973: return $returnhash{$qualifierrest};
4974: }
4975: # ----------------------------------------------------------------- user.course
4976: } elsif ($space eq 'course') {
4977: # FIXME - not supporting calls for a specific user
4978: return $env{join('.',('request.course',$qualifier))};
4979: # ------------------------------------------------------------------- user.role
4980: } elsif ($space eq 'role') {
4981: # FIXME - not supporting calls for a specific user
4982: my ($role,$where)=split(/\./,$env{'request.role'});
4983: if ($qualifier eq 'value') {
4984: return $role;
4985: } elsif ($qualifier eq 'extent') {
4986: return $where;
4987: }
4988: # ----------------------------------------------------------------- user.domain
4989: } elsif ($space eq 'domain') {
4990: return $udom;
4991: # ------------------------------------------------------------------- user.name
4992: } elsif ($space eq 'name') {
4993: return $uname;
4994: # ---------------------------------------------------- Any other user namespace
4995: } else {
4996: my %reply;
4997: if (!$publicuser) {
4998: %reply=&get($space,[$qualifierrest],$udom,$uname);
4999: }
5000: return $reply{$qualifierrest};
5001: }
5002: } elsif ($realm eq 'query') {
5003: # ---------------------------------------------- pull stuff out of query string
5004: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5005: [$spacequalifierrest]);
5006: return $env{'form.'.$spacequalifierrest};
5007: } elsif ($realm eq 'request') {
5008: # ------------------------------------------------------------- request.browser
5009: if ($space eq 'browser') {
5010: if ($qualifier eq 'textremote') {
5011: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5012: return 1;
5013: } else {
5014: return 0;
5015: }
5016: } else {
5017: return $env{'browser.'.$qualifier};
5018: }
5019: # ------------------------------------------------------------ request.filename
5020: } else {
5021: return $env{'request.'.$spacequalifierrest};
5022: }
5023: } elsif ($realm eq 'course') {
5024: # ---------------------------------------------------------- course.description
5025: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5026: } elsif ($realm eq 'resource') {
5027:
5028: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5029: if (!$symbparm) { $symbparm=&symbread(); }
5030: }
5031:
5032: if ($space eq 'title') {
5033: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5034: return &gettitle($symbparm);
5035: }
5036:
5037: if ($space eq 'map') {
5038: my ($map) = &decode_symb($symbparm);
5039: return &symbread($map);
5040: }
5041:
5042: my ($section, $group, @groups);
5043: my ($courselevelm,$courselevel);
5044: if ($symbparm && defined($courseid) &&
5045: $courseid eq $env{'request.course.id'}) {
5046:
5047: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5048:
5049: # ----------------------------------------------------- Cascading lookup scheme
5050: my $symbp=$symbparm;
5051: my $mapp=(&decode_symb($symbp))[0];
5052:
5053: my $symbparm=$symbp.'.'.$spacequalifierrest;
5054: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5055:
5056: if (($env{'user.name'} eq $uname) &&
5057: ($env{'user.domain'} eq $udom)) {
5058: $section=$env{'request.course.sec'};
5059: @groups=&sort_course_groups($env{'request.course.groups'},$courseid);
5060: if (@groups > 0) {
5061: @groups = sort(@groups);
5062: }
5063: } else {
5064: if (! defined($usection)) {
5065: $section=&getsection($udom,$uname,$courseid);
5066: } else {
5067: $section = $usection;
5068: }
5069: my $grouplist = &get_users_groups($udom,$uname,$courseid);
5070: if ($grouplist) {
5071: @groups=&sort_course_groups($grouplist,$courseid);
5072: }
5073: }
5074:
5075: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5076: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5077: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5078:
5079: $courselevel=$courseid.'.'.$spacequalifierrest;
5080: my $courselevelr=$courseid.'.'.$symbparm;
5081: $courselevelm=$courseid.'.'.$mapparm;
5082:
5083: # ----------------------------------------------------------- first, check user
5084:
5085: my $userreply=&resdata($uname,$udom,'user',
5086: ($courselevelr,$courselevelm,
5087: $courselevel));
5088: if (defined($userreply)) { return $userreply; }
5089:
5090: # ------------------------------------------------ second, check some of course
5091: my $coursereply;
5092: if (@groups > 0) {
5093: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5094: $mapparm,$spacequalifierrest);
5095: if (defined($coursereply)) { return $coursereply; }
5096: }
5097:
5098: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5099: $env{'course.'.$courseid.'.domain'},
5100: 'course',
5101: ($seclevelr,$seclevelm,$seclevel,
5102: $courselevelr));
5103: if (defined($coursereply)) { return $coursereply; }
5104:
5105: # ------------------------------------------------------ third, check map parms
5106: my %parmhash=();
5107: my $thisparm='';
5108: if (tie(%parmhash,'GDBM_File',
5109: $env{'request.course.fn'}.'_parms.db',
5110: &GDBM_READER(),0640)) {
5111: $thisparm=$parmhash{$symbparm};
5112: untie(%parmhash);
5113: }
5114: if ($thisparm) { return $thisparm; }
5115: }
5116: # ------------------------------------------ fourth, look in resource metadata
5117:
5118: $spacequalifierrest=~s/\./\_/;
5119: my $filename;
5120: if (!$symbparm) { $symbparm=&symbread(); }
5121: if ($symbparm) {
5122: $filename=(&decode_symb($symbparm))[2];
5123: } else {
5124: $filename=$env{'request.filename'};
5125: }
5126: my $metadata=&metadata($filename,$spacequalifierrest);
5127: if (defined($metadata)) { return $metadata; }
5128: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5129: if (defined($metadata)) { return $metadata; }
5130:
5131: # ---------------------------------------------- fourth, look in rest pf course
5132: if ($symbparm && defined($courseid) &&
5133: $courseid eq $env{'request.course.id'}) {
5134: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5135: $env{'course.'.$courseid.'.domain'},
5136: 'course',
5137: ($courselevelm,$courselevel));
5138: if (defined($coursereply)) { return $coursereply; }
5139: }
5140: # ------------------------------------------------------------------ Cascade up
5141: unless ($space eq '0') {
5142: my @parts=split(/_/,$space);
5143: my $id=pop(@parts);
5144: my $part=join('_',@parts);
5145: if ($part eq '') { $part='0'; }
5146: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5147: $symbparm,$udom,$uname,$section,1);
5148: if (defined($partgeneral)) { return $partgeneral; }
5149: }
5150: if ($recurse) { return undef; }
5151: my $pack_def=&packages_tab_default($filename,$varname);
5152: if (defined($pack_def)) { return $pack_def; }
5153:
5154: # ---------------------------------------------------- Any other user namespace
5155: } elsif ($realm eq 'environment') {
5156: # ----------------------------------------------------------------- environment
5157: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5158: return $env{'environment.'.$spacequalifierrest};
5159: } else {
5160: my %returnhash=&userenvironment($udom,$uname,
5161: $spacequalifierrest);
5162: return $returnhash{$spacequalifierrest};
5163: }
5164: } elsif ($realm eq 'system') {
5165: # ----------------------------------------------------------------- system.time
5166: if ($space eq 'time') {
5167: return time;
5168: }
5169: } elsif ($realm eq 'server') {
5170: # ----------------------------------------------------------------- system.time
5171: if ($space eq 'name') {
5172: return $ENV{'SERVER_NAME'};
5173: }
5174: }
5175: return '';
5176: }
5177:
5178: sub check_group_parms {
5179: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5180: my @groupitems = ();
5181: my $resultitem;
5182: my @levels = ($symbparm,$mapparm,$what);
5183: foreach my $group (@{$groups}) {
5184: foreach my $level (@levels) {
5185: my $item = $courseid.'.['.$group.'].'.$level;
5186: push(@groupitems,$item);
5187: }
5188: }
5189: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5190: $env{'course.'.$courseid.'.domain'},
5191: 'course',@groupitems);
5192: return $coursereply;
5193: }
5194:
5195: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5196: my ($grouplist,$courseid) = @_;
5197: my @groups = split/:/,$grouplist;
5198: if (@groups > 1) {
5199: @groups = sort(@groups);
5200: }
5201: return @groups;
5202: }
5203:
5204: sub packages_tab_default {
5205: my ($uri,$varname)=@_;
5206: my (undef,$part,$name)=split(/\./,$varname);
5207: my $packages=&metadata($uri,'packages');
5208: foreach my $package (split(/,/,$packages)) {
5209: my ($pack_type,$pack_part)=split(/_/,$package,2);
5210: if (defined($packagetab{"$pack_type&$name&default"})) {
5211: return $packagetab{"$pack_type&$name&default"};
5212: }
5213: if ($pack_type eq 'part') { $pack_part='0'; }
5214: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5215: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5216: }
5217: }
5218: return undef;
5219: }
5220:
5221: sub add_prefix_and_part {
5222: my ($prefix,$part)=@_;
5223: my $keyroot;
5224: if (defined($prefix) && $prefix !~ /^__/) {
5225: # prefix that has a part already
5226: $keyroot=$prefix;
5227: } elsif (defined($prefix)) {
5228: # prefix that is missing a part
5229: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5230: } else {
5231: # no prefix at all
5232: if (defined($part)) { $keyroot='_'.$part; }
5233: }
5234: return $keyroot;
5235: }
5236:
5237: # ---------------------------------------------------------------- Get metadata
5238:
5239: my %metaentry;
5240: sub metadata {
5241: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
5242: $uri=&declutter($uri);
5243: # if it is a non metadata possible uri return quickly
5244: if (($uri eq '') ||
5245: (($uri =~ m|^/*adm/|) &&
5246: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
5247: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
5248: ($uri =~ m|home/[^/]+/public_html/|)) {
5249: return undef;
5250: }
5251: my $filename=$uri;
5252: $uri=~s/\.meta$//;
5253: #
5254: # Is the metadata already cached?
5255: # Look at timestamp of caching
5256: # Everything is cached by the main uri, libraries are never directly cached
5257: #
5258: if (!defined($liburi)) {
5259: my ($result,$cached)=&is_cached_new('meta',$uri);
5260: if (defined($cached)) { return $result->{':'.$what}; }
5261: }
5262: {
5263: #
5264: # Is this a recursive call for a library?
5265: #
5266: # if (! exists($metacache{$uri})) {
5267: # $metacache{$uri}={};
5268: # }
5269: if ($liburi) {
5270: $liburi=&declutter($liburi);
5271: $filename=$liburi;
5272: } else {
5273: &devalidate_cache_new('meta',$uri);
5274: undef(%metaentry);
5275: }
5276: my %metathesekeys=();
5277: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
5278: my $metastring;
5279: if ($uri !~ m -^(uploaded|editupload)/-) {
5280: my $file=&filelocation('',&clutter($filename));
5281: #push(@{$metaentry{$uri.'.file'}},$file);
5282: $metastring=&getfile($file);
5283: }
5284: my $parser=HTML::LCParser->new(\$metastring);
5285: my $token;
5286: undef %metathesekeys;
5287: while ($token=$parser->get_token) {
5288: if ($token->[0] eq 'S') {
5289: if (defined($token->[2]->{'package'})) {
5290: #
5291: # This is a package - get package info
5292: #
5293: my $package=$token->[2]->{'package'};
5294: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5295: if (defined($token->[2]->{'id'})) {
5296: $keyroot.='_'.$token->[2]->{'id'};
5297: }
5298: if ($metaentry{':packages'}) {
5299: $metaentry{':packages'}.=','.$package.$keyroot;
5300: } else {
5301: $metaentry{':packages'}=$package.$keyroot;
5302: }
5303: foreach (sort keys %packagetab) {
5304: my $part=$keyroot;
5305: $part=~s/^\_//;
5306: if ($_=~/^\Q$package\E\&/ ||
5307: $_=~/^\Q$package\E_0\&/) {
5308: my ($pack,$name,$subp)=split(/\&/,$_);
5309: # ignore package.tab specified default values
5310: # here &package_tab_default() will fetch those
5311: if ($subp eq 'default') { next; }
5312: my $value=$packagetab{$_};
5313: my $unikey;
5314: if ($pack =~ /_0$/) {
5315: $unikey='parameter_0_'.$name;
5316: $part=0;
5317: } else {
5318: $unikey='parameter'.$keyroot.'_'.$name;
5319: }
5320: if ($subp eq 'display') {
5321: $value.=' [Part: '.$part.']';
5322: }
5323: $metaentry{':'.$unikey.'.part'}=$part;
5324: $metathesekeys{$unikey}=1;
5325: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5326: $metaentry{':'.$unikey.'.'.$subp}=$value;
5327: }
5328: if (defined($metaentry{':'.$unikey.'.default'})) {
5329: $metaentry{':'.$unikey}=
5330: $metaentry{':'.$unikey.'.default'};
5331: }
5332: }
5333: }
5334: } else {
5335: #
5336: # This is not a package - some other kind of start tag
5337: #
5338: my $entry=$token->[1];
5339: my $unikey;
5340: if ($entry eq 'import') {
5341: $unikey='';
5342: } else {
5343: $unikey=$entry;
5344: }
5345: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5346:
5347: if (defined($token->[2]->{'id'})) {
5348: $unikey.='_'.$token->[2]->{'id'};
5349: }
5350:
5351: if ($entry eq 'import') {
5352: #
5353: # Importing a library here
5354: #
5355: if ($depthcount<20) {
5356: my $location=$parser->get_text('/import');
5357: my $dir=$filename;
5358: $dir=~s|[^/]*$||;
5359: $location=&filelocation($dir,$location);
5360: foreach (sort(split(/\,/,&metadata($uri,'keys',
5361: $location,$unikey,
5362: $depthcount+1)))) {
5363: $metaentry{':'.$_}=$metaentry{':'.$_};
5364: $metathesekeys{$_}=1;
5365: }
5366: }
5367: } else {
5368:
5369: if (defined($token->[2]->{'name'})) {
5370: $unikey.='_'.$token->[2]->{'name'};
5371: }
5372: $metathesekeys{$unikey}=1;
5373: foreach (@{$token->[3]}) {
5374: $metaentry{':'.$unikey.'.'.$_}=$token->[2]->{$_};
5375: }
5376: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
5377: my $default=$metaentry{':'.$unikey.'.default'};
5378: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5379: # only ws inside the tag, and not in default, so use default
5380: # as value
5381: $metaentry{':'.$unikey}=$default;
5382: } else {
5383: # either something interesting inside the tag or default
5384: # uninteresting
5385: $metaentry{':'.$unikey}=$internaltext;
5386: }
5387: # end of not-a-package not-a-library import
5388: }
5389: # end of not-a-package start tag
5390: }
5391: # the next is the end of "start tag"
5392: }
5393: }
5394: my ($extension) = ($uri =~ /\.(\w+)$/);
5395: foreach my $key (sort(keys(%packagetab))) {
5396: #no specific packages #how's our extension
5397: if ($key!~/^extension_\Q$extension\E&/) { next; }
5398: &metadata_create_package_def($uri,$key,'extension_'.$extension,
5399: \%metathesekeys);
5400: }
5401: if (!exists($metaentry{':packages'})) {
5402: foreach my $key (sort(keys(%packagetab))) {
5403: #no specific packages well let's get default then
5404: if ($key!~/^default&/) { next; }
5405: &metadata_create_package_def($uri,$key,'default',
5406: \%metathesekeys);
5407: }
5408: }
5409: # are there custom rights to evaluate
5410: if ($metaentry{':copyright'} eq 'custom') {
5411:
5412: #
5413: # Importing a rights file here
5414: #
5415: unless ($depthcount) {
5416: my $location=$metaentry{':customdistributionfile'};
5417: my $dir=$filename;
5418: $dir=~s|[^/]*$||;
5419: $location=&filelocation($dir,$location);
5420: foreach (sort(split(/\,/,&metadata($uri,'keys',
5421: $location,'_rights',
5422: $depthcount+1)))) {
5423: #$metaentry{':'.$_}=$metacache{$uri}->{':'.$_};
5424: $metathesekeys{$_}=1;
5425: }
5426: }
5427: }
5428: $metaentry{':keys'}=join(',',keys %metathesekeys);
5429: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5430: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
5431: &do_cache_new('meta',$uri,\%metaentry,60*60);
5432: # this is the end of "was not already recently cached
5433: }
5434: return $metaentry{':'.$what};
5435: }
5436:
5437: sub metadata_create_package_def {
5438: my ($uri,$key,$package,$metathesekeys)=@_;
5439: my ($pack,$name,$subp)=split(/\&/,$key);
5440: if ($subp eq 'default') { next; }
5441:
5442: if (defined($metaentry{':packages'})) {
5443: $metaentry{':packages'}.=','.$package;
5444: } else {
5445: $metaentry{':packages'}=$package;
5446: }
5447: my $value=$packagetab{$key};
5448: my $unikey;
5449: $unikey='parameter_0_'.$name;
5450: $metaentry{':'.$unikey.'.part'}=0;
5451: $$metathesekeys{$unikey}=1;
5452: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5453: $metaentry{':'.$unikey.'.'.$subp}=$value;
5454: }
5455: if (defined($metaentry{':'.$unikey.'.default'})) {
5456: $metaentry{':'.$unikey}=
5457: $metaentry{':'.$unikey.'.default'};
5458: }
5459: }
5460:
5461: sub metadata_generate_part0 {
5462: my ($metadata,$metacache,$uri) = @_;
5463: my %allnames;
5464: foreach my $metakey (sort keys %$metadata) {
5465: if ($metakey=~/^parameter\_(.*)/) {
5466: my $part=$$metacache{':'.$metakey.'.part'};
5467: my $name=$$metacache{':'.$metakey.'.name'};
5468: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
5469: $allnames{$name}=$part;
5470: }
5471: }
5472: }
5473: foreach my $name (keys(%allnames)) {
5474: $$metadata{"parameter_0_$name"}=1;
5475: my $key=":parameter_0_$name";
5476: $$metacache{"$key.part"}='0';
5477: $$metacache{"$key.name"}=$name;
5478: $$metacache{"$key.type"}=$$metacache{':parameter_'.
5479: $allnames{$name}.'_'.$name.
5480: '.type'};
5481: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
5482: '.display'};
5483: my $expr='[Part: '.$allnames{$name}.']';
5484: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
5485: $$metacache{"$key.display"}=$olddis;
5486: }
5487: }
5488:
5489: # ------------------------------------------------- Get the title of a resource
5490:
5491: sub gettitle {
5492: my $urlsymb=shift;
5493: my $symb=&symbread($urlsymb);
5494: if ($symb) {
5495: my $key=$env{'request.course.id'}."\0".$symb;
5496: my ($result,$cached)=&is_cached_new('title',$key);
5497: if (defined($cached)) {
5498: return $result;
5499: }
5500: my ($map,$resid,$url)=&decode_symb($symb);
5501: my $title='';
5502: my %bighash;
5503: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5504: &GDBM_READER(),0640)) {
5505: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5506: $title=$bighash{'title_'.$mapid.'.'.$resid};
5507: untie %bighash;
5508: }
5509: $title=~s/\&colon\;/\:/gs;
5510: if ($title) {
5511: return &do_cache_new('title',$key,$title,600);
5512: }
5513: $urlsymb=$url;
5514: }
5515: my $title=&metadata($urlsymb,'title');
5516: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5517: return $title;
5518: }
5519:
5520: sub get_slot {
5521: my ($which,$cnum,$cdom)=@_;
5522: if (!$cnum || !$cdom) {
5523: (undef,my $courseid)=&Apache::lonxml::whichuser();
5524: $cdom=$env{'course.'.$courseid.'.domain'};
5525: $cnum=$env{'course.'.$courseid.'.num'};
5526: }
5527: my $key=join("\0",'slots',$cdom,$cnum,$which);
5528: my %slotinfo;
5529: if (exists($remembered{$key})) {
5530: $slotinfo{$which} = $remembered{$key};
5531: } else {
5532: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5533: &Apache::lonhomework::showhash(%slotinfo);
5534: my ($tmp)=keys(%slotinfo);
5535: if ($tmp=~/^error:/) { return (); }
5536: $remembered{$key} = $slotinfo{$which};
5537: }
5538: if (ref($slotinfo{$which}) eq 'HASH') {
5539: return %{$slotinfo{$which}};
5540: }
5541: return $slotinfo{$which};
5542: }
5543: # ------------------------------------------------- Update symbolic store links
5544:
5545: sub symblist {
5546: my ($mapname,%newhash)=@_;
5547: $mapname=&deversion(&declutter($mapname));
5548: my %hash;
5549: if (($env{'request.course.fn'}) && (%newhash)) {
5550: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
5551: &GDBM_WRCREAT(),0640)) {
5552: foreach my $url (keys %newhash) {
5553: next if ($url eq 'last_known'
5554: && $env{'form.no_update_last_known'});
5555: $hash{declutter($url)}=&encode_symb($mapname,
5556: $newhash{$url}->[1],
5557: $newhash{$url}->[0]);
5558: }
5559: if (untie(%hash)) {
5560: return 'ok';
5561: }
5562: }
5563: }
5564: return 'error';
5565: }
5566:
5567: # --------------------------------------------------------------- Verify a symb
5568:
5569: sub symbverify {
5570: my ($symb,$thisurl)=@_;
5571: my $thisfn=$thisurl;
5572: # wrapper not part of symbs
5573: $thisfn=~s/^\/adm\/wrapper//;
5574: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
5575: $thisfn=&declutter($thisfn);
5576: # direct jump to resource in page or to a sequence - will construct own symbs
5577: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
5578: # check URL part
5579: my ($map,$resid,$url)=&decode_symb($symb);
5580:
5581: unless ($url eq $thisfn) { return 0; }
5582:
5583: $symb=&symbclean($symb);
5584: $thisurl=&deversion($thisurl);
5585: $thisfn=&deversion($thisfn);
5586:
5587: my %bighash;
5588: my $okay=0;
5589:
5590: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5591: &GDBM_READER(),0640)) {
5592: my $ids=$bighash{'ids_'.&clutter($thisurl)};
5593: unless ($ids) {
5594: $ids=$bighash{'ids_/'.$thisurl};
5595: }
5596: if ($ids) {
5597: # ------------------------------------------------------------------- Has ID(s)
5598: foreach (split(/\,/,$ids)) {
5599: my ($mapid,$resid)=split(/\./,$_);
5600: if (
5601: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
5602: eq $symb) {
5603: if (($env{'request.role.adv'}) ||
5604: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
5605: $okay=1;
5606: }
5607: }
5608: }
5609: }
5610: untie(%bighash);
5611: }
5612: return $okay;
5613: }
5614:
5615: # --------------------------------------------------------------- Clean-up symb
5616:
5617: sub symbclean {
5618: my $symb=shift;
5619: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5620: # remove version from map
5621: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
5622:
5623: # remove version from URL
5624: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
5625:
5626: # remove wrapper
5627:
5628: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
5629: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
5630: return $symb;
5631: }
5632:
5633: # ---------------------------------------------- Split symb to find map and url
5634:
5635: sub encode_symb {
5636: my ($map,$resid,$url)=@_;
5637: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
5638: }
5639:
5640: sub decode_symb {
5641: my $symb=shift;
5642: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5643: my ($map,$resid,$url)=split(/___/,$symb);
5644: return (&fixversion($map),$resid,&fixversion($url));
5645: }
5646:
5647: sub fixversion {
5648: my $fn=shift;
5649: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
5650: my %bighash;
5651: my $uri=&clutter($fn);
5652: my $key=$env{'request.course.id'}.'_'.$uri;
5653: # is this cached?
5654: my ($result,$cached)=&is_cached_new('courseresversion',$key);
5655: if (defined($cached)) { return $result; }
5656: # unfortunately not cached, or expired
5657: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5658: &GDBM_READER(),0640)) {
5659: if ($bighash{'version_'.$uri}) {
5660: my $version=$bighash{'version_'.$uri};
5661: unless (($version eq 'mostrecent') ||
5662: ($version==&getversion($uri))) {
5663: $uri=~s/\.(\w+)$/\.$version\.$1/;
5664: }
5665: }
5666: untie %bighash;
5667: }
5668: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
5669: }
5670:
5671: sub deversion {
5672: my $url=shift;
5673: $url=~s/\.\d+\.(\w+)$/\.$1/;
5674: return $url;
5675: }
5676:
5677: # ------------------------------------------------------ Return symb list entry
5678:
5679: sub symbread {
5680: my ($thisfn,$donotrecurse)=@_;
5681: my $cache_str='request.symbread.cached.'.$thisfn;
5682: if (defined($env{$cache_str})) { return $env{$cache_str}; }
5683: # no filename provided? try from environment
5684: unless ($thisfn) {
5685: if ($env{'request.symb'}) {
5686: return $env{$cache_str}=&symbclean($env{'request.symb'});
5687: }
5688: $thisfn=$env{'request.filename'};
5689: }
5690: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
5691: # is that filename actually a symb? Verify, clean, and return
5692: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
5693: if (&symbverify($thisfn,$1)) {
5694: return $env{$cache_str}=&symbclean($thisfn);
5695: }
5696: }
5697: $thisfn=declutter($thisfn);
5698: my %hash;
5699: my %bighash;
5700: my $syval='';
5701: if (($env{'request.course.fn'}) && ($thisfn)) {
5702: my $targetfn = $thisfn;
5703: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
5704: $targetfn = 'adm/wrapper/'.$thisfn;
5705: }
5706: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
5707: $targetfn=$1;
5708: }
5709: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
5710: &GDBM_READER(),0640)) {
5711: $syval=$hash{$targetfn};
5712: untie(%hash);
5713: }
5714: # ---------------------------------------------------------- There was an entry
5715: if ($syval) {
5716: #unless ($syval=~/\_\d+$/) {
5717: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
5718: #&appenv('request.ambiguous' => $thisfn);
5719: #return $env{$cache_str}='';
5720: #}
5721: #$syval.=$1;
5722: #}
5723: } else {
5724: # ------------------------------------------------------- Was not in symb table
5725: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5726: &GDBM_READER(),0640)) {
5727: # ---------------------------------------------- Get ID(s) for current resource
5728: my $ids=$bighash{'ids_'.&clutter($thisfn)};
5729: unless ($ids) {
5730: $ids=$bighash{'ids_/'.$thisfn};
5731: }
5732: unless ($ids) {
5733: # alias?
5734: $ids=$bighash{'mapalias_'.$thisfn};
5735: }
5736: if ($ids) {
5737: # ------------------------------------------------------------------- Has ID(s)
5738: my @possibilities=split(/\,/,$ids);
5739: if ($#possibilities==0) {
5740: # ----------------------------------------------- There is only one possibility
5741: my ($mapid,$resid)=split(/\./,$ids);
5742: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5743: $resid,$thisfn);
5744: } elsif (!$donotrecurse) {
5745: # ------------------------------------------ There is more than one possibility
5746: my $realpossible=0;
5747: foreach (@possibilities) {
5748: my $file=$bighash{'src_'.$_};
5749: if (&allowed('bre',$file)) {
5750: my ($mapid,$resid)=split(/\./,$_);
5751: if ($bighash{'map_type_'.$mapid} ne 'page') {
5752: $realpossible++;
5753: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5754: $resid,$thisfn);
5755: }
5756: }
5757: }
5758: if ($realpossible!=1) { $syval=''; }
5759: } else {
5760: $syval='';
5761: }
5762: }
5763: untie(%bighash)
5764: }
5765: }
5766: if ($syval) {
5767: return $env{$cache_str}=$syval;
5768: }
5769: }
5770: &appenv('request.ambiguous' => $thisfn);
5771: return $env{$cache_str}='';
5772: }
5773:
5774: # ---------------------------------------------------------- Return random seed
5775:
5776: sub numval {
5777: my $txt=shift;
5778: $txt=~tr/A-J/0-9/;
5779: $txt=~tr/a-j/0-9/;
5780: $txt=~tr/K-T/0-9/;
5781: $txt=~tr/k-t/0-9/;
5782: $txt=~tr/U-Z/0-5/;
5783: $txt=~tr/u-z/0-5/;
5784: $txt=~s/\D//g;
5785: if ($_64bit) { if ($txt > 2**32) { return -1; } }
5786: return int($txt);
5787: }
5788:
5789: sub numval2 {
5790: my $txt=shift;
5791: $txt=~tr/A-J/0-9/;
5792: $txt=~tr/a-j/0-9/;
5793: $txt=~tr/K-T/0-9/;
5794: $txt=~tr/k-t/0-9/;
5795: $txt=~tr/U-Z/0-5/;
5796: $txt=~tr/u-z/0-5/;
5797: $txt=~s/\D//g;
5798: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
5799: my $total;
5800: foreach my $val (@txts) { $total+=$val; }
5801: if ($_64bit) { if ($total > 2**32) { return -1; } }
5802: return int($total);
5803: }
5804:
5805: sub numval3 {
5806: use integer;
5807: my $txt=shift;
5808: $txt=~tr/A-J/0-9/;
5809: $txt=~tr/a-j/0-9/;
5810: $txt=~tr/K-T/0-9/;
5811: $txt=~tr/k-t/0-9/;
5812: $txt=~tr/U-Z/0-5/;
5813: $txt=~tr/u-z/0-5/;
5814: $txt=~s/\D//g;
5815: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
5816: my $total;
5817: foreach my $val (@txts) { $total+=$val; }
5818: if ($_64bit) { $total=(($total<<32)>>32); }
5819: return $total;
5820: }
5821:
5822: sub digest {
5823: my ($data)=@_;
5824: my $digest=&Digest::MD5::md5($data);
5825: my ($a,$b,$c,$d)=unpack("iiii",$digest);
5826: my ($e,$f);
5827: {
5828: use integer;
5829: $e=($a+$b);
5830: $f=($c+$d);
5831: if ($_64bit) {
5832: $e=(($e<<32)>>32);
5833: $f=(($f<<32)>>32);
5834: }
5835: }
5836: if (wantarray) {
5837: return ($e,$f);
5838: } else {
5839: my $g;
5840: {
5841: use integer;
5842: $g=($e+$f);
5843: if ($_64bit) {
5844: $g=(($g<<32)>>32);
5845: }
5846: }
5847: return $g;
5848: }
5849: }
5850:
5851: sub latest_rnd_algorithm_id {
5852: return '64bit5';
5853: }
5854:
5855: sub get_rand_alg {
5856: my ($courseid)=@_;
5857: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
5858: if ($courseid) {
5859: return $env{"course.$courseid.rndseed"};
5860: }
5861: return &latest_rnd_algorithm_id();
5862: }
5863:
5864: sub validCODE {
5865: my ($CODE)=@_;
5866: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
5867: return 0;
5868: }
5869:
5870: sub getCODE {
5871: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
5872: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
5873: defined($Apache::lonhomework::parsing_a_task) ) &&
5874: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
5875: return $Apache::lonhomework::history{'resource.CODE'};
5876: }
5877: return undef;
5878: }
5879:
5880: sub rndseed {
5881: my ($symb,$courseid,$domain,$username)=@_;
5882:
5883: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
5884: if (!$symb) {
5885: unless ($symb=$wsymb) { return time; }
5886: }
5887: if (!$courseid) { $courseid=$wcourseid; }
5888: if (!$domain) { $domain=$wdomain; }
5889: if (!$username) { $username=$wusername }
5890: my $which=&get_rand_alg();
5891: if (defined(&getCODE())) {
5892: if ($which eq '64bit5') {
5893: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
5894: } elsif ($which eq '64bit4') {
5895: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
5896: } else {
5897: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
5898: }
5899: } elsif ($which eq '64bit5') {
5900: return &rndseed_64bit5($symb,$courseid,$domain,$username);
5901: } elsif ($which eq '64bit4') {
5902: return &rndseed_64bit4($symb,$courseid,$domain,$username);
5903: } elsif ($which eq '64bit3') {
5904: return &rndseed_64bit3($symb,$courseid,$domain,$username);
5905: } elsif ($which eq '64bit2') {
5906: return &rndseed_64bit2($symb,$courseid,$domain,$username);
5907: } elsif ($which eq '64bit') {
5908: return &rndseed_64bit($symb,$courseid,$domain,$username);
5909: }
5910: return &rndseed_32bit($symb,$courseid,$domain,$username);
5911: }
5912:
5913: sub rndseed_32bit {
5914: my ($symb,$courseid,$domain,$username)=@_;
5915: {
5916: use integer;
5917: my $symbchck=unpack("%32C*",$symb) << 27;
5918: my $symbseed=numval($symb) << 22;
5919: my $namechck=unpack("%32C*",$username) << 17;
5920: my $nameseed=numval($username) << 12;
5921: my $domainseed=unpack("%32C*",$domain) << 7;
5922: my $courseseed=unpack("%32C*",$courseid);
5923: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
5924: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5925: #&Apache::lonxml::debug("rndseed :$num:$symb");
5926: if ($_64bit) { $num=(($num<<32)>>32); }
5927: return $num;
5928: }
5929: }
5930:
5931: sub rndseed_64bit {
5932: my ($symb,$courseid,$domain,$username)=@_;
5933: {
5934: use integer;
5935: my $symbchck=unpack("%32S*",$symb) << 21;
5936: my $symbseed=numval($symb) << 10;
5937: my $namechck=unpack("%32S*",$username);
5938:
5939: my $nameseed=numval($username) << 21;
5940: my $domainseed=unpack("%32S*",$domain) << 10;
5941: my $courseseed=unpack("%32S*",$courseid);
5942:
5943: my $num1=$symbchck+$symbseed+$namechck;
5944: my $num2=$nameseed+$domainseed+$courseseed;
5945: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5946: #&Apache::lonxml::debug("rndseed :$num:$symb");
5947: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5948: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5949: return "$num1,$num2";
5950: }
5951: }
5952:
5953: sub rndseed_64bit2 {
5954: my ($symb,$courseid,$domain,$username)=@_;
5955: {
5956: use integer;
5957: # strings need to be an even # of cahracters long, it it is odd the
5958: # last characters gets thrown away
5959: my $symbchck=unpack("%32S*",$symb.' ') << 21;
5960: my $symbseed=numval($symb) << 10;
5961: my $namechck=unpack("%32S*",$username.' ');
5962:
5963: my $nameseed=numval($username) << 21;
5964: my $domainseed=unpack("%32S*",$domain.' ') << 10;
5965: my $courseseed=unpack("%32S*",$courseid.' ');
5966:
5967: my $num1=$symbchck+$symbseed+$namechck;
5968: my $num2=$nameseed+$domainseed+$courseseed;
5969: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5970: #&Apache::lonxml::debug("rndseed :$num:$symb");
5971: return "$num1,$num2";
5972: }
5973: }
5974:
5975: sub rndseed_64bit3 {
5976: my ($symb,$courseid,$domain,$username)=@_;
5977: {
5978: use integer;
5979: # strings need to be an even # of cahracters long, it it is odd the
5980: # last characters gets thrown away
5981: my $symbchck=unpack("%32S*",$symb.' ') << 21;
5982: my $symbseed=numval2($symb) << 10;
5983: my $namechck=unpack("%32S*",$username.' ');
5984:
5985: my $nameseed=numval2($username) << 21;
5986: my $domainseed=unpack("%32S*",$domain.' ') << 10;
5987: my $courseseed=unpack("%32S*",$courseid.' ');
5988:
5989: my $num1=$symbchck+$symbseed+$namechck;
5990: my $num2=$nameseed+$domainseed+$courseseed;
5991: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5992: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
5993: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5994:
5995: return "$num1:$num2";
5996: }
5997: }
5998:
5999: sub rndseed_64bit4 {
6000: my ($symb,$courseid,$domain,$username)=@_;
6001: {
6002: use integer;
6003: # strings need to be an even # of cahracters long, it it is odd the
6004: # last characters gets thrown away
6005: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6006: my $symbseed=numval3($symb) << 10;
6007: my $namechck=unpack("%32S*",$username.' ');
6008:
6009: my $nameseed=numval3($username) << 21;
6010: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6011: my $courseseed=unpack("%32S*",$courseid.' ');
6012:
6013: my $num1=$symbchck+$symbseed+$namechck;
6014: my $num2=$nameseed+$domainseed+$courseseed;
6015: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6016: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6017: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6018:
6019: return "$num1:$num2";
6020: }
6021: }
6022:
6023: sub rndseed_64bit5 {
6024: my ($symb,$courseid,$domain,$username)=@_;
6025: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6026: return "$num1:$num2";
6027: }
6028:
6029: sub rndseed_CODE_64bit {
6030: my ($symb,$courseid,$domain,$username)=@_;
6031: {
6032: use integer;
6033: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6034: my $symbseed=numval2($symb);
6035: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6036: my $CODEseed=numval(&getCODE());
6037: my $courseseed=unpack("%32S*",$courseid.' ');
6038: my $num1=$symbseed+$CODEchck;
6039: my $num2=$CODEseed+$courseseed+$symbchck;
6040: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6041: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6042: if ($_64bit) { $num1=(($num1<<32)>>32); }
6043: if ($_64bit) { $num2=(($num2<<32)>>32); }
6044: return "$num1:$num2";
6045: }
6046: }
6047:
6048: sub rndseed_CODE_64bit4 {
6049: my ($symb,$courseid,$domain,$username)=@_;
6050: {
6051: use integer;
6052: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6053: my $symbseed=numval3($symb);
6054: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6055: my $CODEseed=numval3(&getCODE());
6056: my $courseseed=unpack("%32S*",$courseid.' ');
6057: my $num1=$symbseed+$CODEchck;
6058: my $num2=$CODEseed+$courseseed+$symbchck;
6059: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6060: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6061: if ($_64bit) { $num1=(($num1<<32)>>32); }
6062: if ($_64bit) { $num2=(($num2<<32)>>32); }
6063: return "$num1:$num2";
6064: }
6065: }
6066:
6067: sub rndseed_CODE_64bit5 {
6068: my ($symb,$courseid,$domain,$username)=@_;
6069: my $code = &getCODE();
6070: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6071: return "$num1:$num2";
6072: }
6073:
6074: sub setup_random_from_rndseed {
6075: my ($rndseed)=@_;
6076: if ($rndseed =~/([,:])/) {
6077: my ($num1,$num2)=split(/[,:]/,$rndseed);
6078: &Math::Random::random_set_seed(abs($num1),abs($num2));
6079: } else {
6080: &Math::Random::random_set_seed_from_phrase($rndseed);
6081: }
6082: }
6083:
6084: sub latest_receipt_algorithm_id {
6085: return 'receipt2';
6086: }
6087:
6088: sub recunique {
6089: my $fucourseid=shift;
6090: my $unique;
6091: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6092: $unique=$env{"course.$fucourseid.internal.encseed"};
6093: } else {
6094: $unique=$perlvar{'lonReceipt'};
6095: }
6096: return unpack("%32C*",$unique);
6097: }
6098:
6099: sub recprefix {
6100: my $fucourseid=shift;
6101: my $prefix;
6102: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6103: $prefix=$env{"course.$fucourseid.internal.encpref"};
6104: } else {
6105: $prefix=$perlvar{'lonHostID'};
6106: }
6107: return unpack("%32C*",$prefix);
6108: }
6109:
6110: sub ireceipt {
6111: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6112: my $cuname=unpack("%32C*",$funame);
6113: my $cudom=unpack("%32C*",$fudom);
6114: my $cucourseid=unpack("%32C*",$fucourseid);
6115: my $cusymb=unpack("%32C*",$fusymb);
6116: my $cunique=&recunique($fucourseid);
6117: my $cpart=unpack("%32S*",$part);
6118: my $return =&recprefix($fucourseid).'-';
6119: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6120: $env{'request.state'} eq 'construct') {
6121: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6122: " and ".($cpart%$cudom));
6123:
6124: $return.= ($cunique%$cuname+
6125: $cunique%$cudom+
6126: $cusymb%$cuname+
6127: $cusymb%$cudom+
6128: $cucourseid%$cuname+
6129: $cucourseid%$cudom+
6130: $cpart%$cuname+
6131: $cpart%$cudom);
6132: } else {
6133: $return.= ($cunique%$cuname+
6134: $cunique%$cudom+
6135: $cusymb%$cuname+
6136: $cusymb%$cudom+
6137: $cucourseid%$cuname+
6138: $cucourseid%$cudom);
6139: }
6140: return $return;
6141: }
6142:
6143: sub receipt {
6144: my ($part)=@_;
6145: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6146: return &ireceipt($name,$domain,$courseid,$symb,$part);
6147: }
6148:
6149: # ------------------------------------------------------------ Serves up a file
6150: # returns either the contents of the file or
6151: # -1 if the file doesn't exist
6152: #
6153: # if the target is a file that was uploaded via DOCS,
6154: # a check will be made to see if a current copy exists on the local server,
6155: # if it does this will be served, otherwise a copy will be retrieved from
6156: # the home server for the course and stored in /home/httpd/html/userfiles on
6157: # the local server.
6158:
6159: sub getfile {
6160: my ($file) = @_;
6161: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6162: &repcopy($file);
6163: return &readfile($file);
6164: }
6165:
6166: sub repcopy_userfile {
6167: my ($file)=@_;
6168: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6169: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
6170: my ($cdom,$cnum,$filename) =
6171: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6172: my ($info,$rtncode);
6173: my $uri="/uploaded/$cdom/$cnum/$filename";
6174: if (-e "$file") {
6175: my @fileinfo = stat($file);
6176: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
6177: if ($lwpresp ne 'ok') {
6178: if ($rtncode eq '404') {
6179: unlink($file);
6180: }
6181: #my $ua=new LWP::UserAgent;
6182: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6183: #my $response=$ua->request($request);
6184: #if ($response->is_success()) {
6185: # return $response->content;
6186: # } else {
6187: # return -1;
6188: # }
6189: return -1;
6190: }
6191: if ($info < $fileinfo[9]) {
6192: return 'ok';
6193: }
6194: $info = '';
6195: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6196: if ($lwpresp ne 'ok') {
6197: return -1;
6198: }
6199: } else {
6200: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6201: if ($lwpresp ne 'ok') {
6202: my $ua=new LWP::UserAgent;
6203: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6204: my $response=$ua->request($request);
6205: if ($response->is_success()) {
6206: $info=$response->content;
6207: } else {
6208: return -1;
6209: }
6210: }
6211: my @parts = ($cdom,$cnum);
6212: if ($filename =~ m|^(.+)/[^/]+$|) {
6213: push @parts, split(/\//,$1);
6214: }
6215: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
6216: foreach my $part (@parts) {
6217: $path .= '/'.$part;
6218: if (!-e $path) {
6219: mkdir($path,0770);
6220: }
6221: }
6222: }
6223: open(FILE,">$file");
6224: print FILE $info;
6225: close(FILE);
6226: return 'ok';
6227: }
6228:
6229: sub tokenwrapper {
6230: my $uri=shift;
6231: $uri=~s|^http\://([^/]+)||;
6232: $uri=~s|^/||;
6233: $env{'user.environment'}=~/\/([^\/]+)\.id/;
6234: my $token=$1;
6235: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6236: if ($udom && $uname && $file) {
6237: $file=~s|(\?\.*)*$||;
6238: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
6239: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
6240: (($uri=~/\?/)?'&':'?').'token='.$token.
6241: '&tokenissued='.$perlvar{'lonHostID'};
6242: } else {
6243: return '/adm/notfound.html';
6244: }
6245: }
6246:
6247: sub getuploaded {
6248: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6249: $uri=~s/^\///;
6250: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6251: my $ua=new LWP::UserAgent;
6252: my $request=new HTTP::Request($reqtype,$uri);
6253: my $response=$ua->request($request);
6254: $$rtncode = $response->code;
6255: if (! $response->is_success()) {
6256: return 'failed';
6257: }
6258: if ($reqtype eq 'HEAD') {
6259: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
6260: } elsif ($reqtype eq 'GET') {
6261: $$info = $response->content;
6262: }
6263: return 'ok';
6264: }
6265:
6266: sub readfile {
6267: my $file = shift;
6268: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6269: my $fh;
6270: open($fh,"<$file");
6271: my $a='';
6272: while (<$fh>) { $a .=$_; }
6273: return $a;
6274: }
6275:
6276: sub filelocation {
6277: my ($dir,$file) = @_;
6278: my $location;
6279: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
6280:
6281: if ($file =~ m-^/adm/-) {
6282: $file=~s-^/adm/wrapper/-/-;
6283: $file=~s-^/adm/coursedocs/showdoc/-/-;
6284: }
6285: if ($file=~m:^/~:) { # is a contruction space reference
6286: $location = $file;
6287: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
6288: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6289: # is a correct contruction space reference
6290: $location = $file;
6291: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
6292: my ($udom,$uname,$filename)=
6293: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
6294: my $home=&homeserver($uname,$udom);
6295: my $is_me=0;
6296: my @ids=¤t_machine_ids();
6297: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6298: if ($is_me) {
6299: $location=&Apache::loncommon::propath($udom,$uname).
6300: '/userfiles/'.$filename;
6301: } else {
6302: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6303: $udom.'/'.$uname.'/'.$filename;
6304: }
6305: } else {
6306: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6307: $file=~s:^/res/:/:;
6308: if ( !( $file =~ m:^/:) ) {
6309: $location = $dir. '/'.$file;
6310: } else {
6311: $location = '/home/httpd/html/res'.$file;
6312: }
6313: }
6314: $location=~s://+:/:g; # remove duplicate /
6315: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6316: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6317: return $location;
6318: }
6319:
6320: sub hreflocation {
6321: my ($dir,$file)=@_;
6322: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
6323: $file=filelocation($dir,$file);
6324: } elsif ($file=~m-^/adm/-) {
6325: $file=~s-^/adm/wrapper/-/-;
6326: $file=~s-^/adm/coursedocs/showdoc/-/-;
6327: }
6328: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6329: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6330: } elsif ($file=~m-/home/(\w+)/public_html/-) {
6331: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
6332: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6333: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6334: -/uploaded/$1/$2/-x;
6335: }
6336: return $file;
6337: }
6338:
6339: sub current_machine_domains {
6340: my $hostname=$hostname{$perlvar{'lonHostID'}};
6341: my @domains;
6342: while( my($id, $name) = each(%hostname)) {
6343: # &logthis("-$id-$name-$hostname-");
6344: if ($hostname eq $name) {
6345: push(@domains,$hostdom{$id});
6346: }
6347: }
6348: return @domains;
6349: }
6350:
6351: sub current_machine_ids {
6352: my $hostname=$hostname{$perlvar{'lonHostID'}};
6353: my @ids;
6354: while( my($id, $name) = each(%hostname)) {
6355: # &logthis("-$id-$name-$hostname-");
6356: if ($hostname eq $name) {
6357: push(@ids,$id);
6358: }
6359: }
6360: return @ids;
6361: }
6362:
6363: # ------------------------------------------------------------- Declutters URLs
6364:
6365: sub declutter {
6366: my $thisfn=shift;
6367: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6368: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6369: $thisfn=~s/^\///;
6370: $thisfn=~s|^adm/wrapper/||;
6371: $thisfn=~s|^adm/coursedocs/showdoc/||;
6372: $thisfn=~s/^res\///;
6373: $thisfn=~s/\?.+$//;
6374: return $thisfn;
6375: }
6376:
6377: # ------------------------------------------------------------- Clutter up URLs
6378:
6379: sub clutter {
6380: my $thisfn='/'.&declutter(shift);
6381: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
6382: $thisfn='/res'.$thisfn;
6383: }
6384: if ($thisfn !~m|/adm|) {
6385: if ($thisfn =~ m|/ext/|) {
6386: $thisfn='/adm/wrapper'.$thisfn;
6387: } else {
6388: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6389: my $embstyle=&Apache::loncommon::fileembstyle($ext);
6390: if ($embstyle eq 'ssi'
6391: || ($embstyle eq 'hdn')
6392: || ($embstyle eq 'rat')
6393: || ($embstyle eq 'prv')
6394: || ($embstyle eq 'ign')) {
6395: #do nothing with these
6396: } elsif (($embstyle eq 'img')
6397: || ($embstyle eq 'emb')
6398: || ($embstyle eq 'wrp')) {
6399: $thisfn='/adm/wrapper'.$thisfn;
6400: } elsif ($embstyle eq 'unk'
6401: && $thisfn!~/\.(sequence|page)$/) {
6402: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
6403: } else {
6404: &logthis("Got a blank emb style");
6405: }
6406: }
6407: }
6408: return $thisfn;
6409: }
6410:
6411: sub freeze_escape {
6412: my ($value)=@_;
6413: if (ref($value)) {
6414: $value=&nfreeze($value);
6415: return '__FROZEN__'.&escape($value);
6416: }
6417: return &escape($value);
6418: }
6419:
6420: # -------------------------------------------------------- Escape Special Chars
6421:
6422: sub escape {
6423: my $str=shift;
6424: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
6425: return $str;
6426: }
6427:
6428: # ----------------------------------------------------- Un-Escape Special Chars
6429:
6430: sub unescape {
6431: my $str=shift;
6432: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
6433: return $str;
6434: }
6435:
6436: sub thaw_unescape {
6437: my ($value)=@_;
6438: if ($value =~ /^__FROZEN__/) {
6439: substr($value,0,10,undef);
6440: $value=&unescape($value);
6441: return &thaw($value);
6442: }
6443: return &unescape($value);
6444: }
6445:
6446: sub correct_line_ends {
6447: my ($result)=@_;
6448: $$result =~s/\r\n/\n/mg;
6449: $$result =~s/\r/\n/mg;
6450: }
6451: # ================================================================ Main Program
6452:
6453: sub goodbye {
6454: &logthis("Starting Shut down");
6455: #not converted to using infrastruture and probably shouldn't be
6456: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
6457: #converted
6458: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6459: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6460: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6461: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
6462: #1.1 only
6463: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6464: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6465: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6466: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6467: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6468: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6469: &logthis(sprintf("%-20s is %s",'hits',$hits));
6470: &flushcourselogs();
6471: &logthis("Shutting down");
6472: return DONE;
6473: }
6474:
6475: BEGIN {
6476: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
6477: unless ($readit) {
6478: {
6479: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
6480: open(my $config,"</etc/httpd/conf/loncapa.conf");
6481:
6482: while (my $configline=<$config>) {
6483: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
6484: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6485: chomp($varvalue);
6486: $perlvar{$varname}=$varvalue;
6487: }
6488: }
6489: close($config);
6490: }
6491: {
6492: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
6493:
6494: while (my $configline=<$config>) {
6495: if ($configline =~ /^[^\#]*PerlSetVar/) {
6496: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6497: chomp($varvalue);
6498: $perlvar{$varname}=$varvalue;
6499: }
6500: }
6501: close($config);
6502: }
6503:
6504: # ------------------------------------------------------------ Read domain file
6505: {
6506: %domaindescription = ();
6507: %domain_auth_def = ();
6508: %domain_auth_arg_def = ();
6509: my $fh;
6510: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
6511: while (<$fh>) {
6512: next if (/^(\#|\s*$)/);
6513: # next if /^\#/;
6514: chomp;
6515: my ($domain, $domain_description, $def_auth, $def_auth_arg,
6516: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
6517: $domain_auth_def{$domain}=$def_auth;
6518: $domain_auth_arg_def{$domain}=$def_auth_arg;
6519: $domaindescription{$domain}=$domain_description;
6520: $domain_lang_def{$domain}=$def_lang;
6521: $domain_city{$domain}=$city;
6522: $domain_longi{$domain}=$longi;
6523: $domain_lati{$domain}=$lati;
6524: $domain_primary{$domain}=$primary;
6525:
6526: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
6527: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
6528: }
6529: }
6530: close ($fh);
6531: }
6532:
6533:
6534: # ------------------------------------------------------------- Read hosts file
6535: {
6536: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
6537:
6538: while (my $configline=<$config>) {
6539: next if ($configline =~ /^(\#|\s*$)/);
6540: chomp($configline);
6541: my ($id,$domain,$role,$name)=split(/:/,$configline);
6542: $name=~s/\s//g;
6543: if ($id && $domain && $role && $name) {
6544: $hostname{$id}=$name;
6545: $hostdom{$id}=$domain;
6546: if ($role eq 'library') { $libserv{$id}=$name; }
6547: }
6548: }
6549: close($config);
6550: # FIXME: dev server don't want this, production servers _do_ want this
6551: #&get_iphost();
6552: }
6553:
6554: sub get_iphost {
6555: if (%iphost) { return %iphost; }
6556: my %name_to_ip;
6557: foreach my $id (keys(%hostname)) {
6558: my $name=$hostname{$id};
6559: my $ip;
6560: if (!exists($name_to_ip{$name})) {
6561: $ip = gethostbyname($name);
6562: if (!$ip || length($ip) ne 4) {
6563: &logthis("Skipping host $id name $name no IP found\n");
6564: next;
6565: }
6566: $ip=inet_ntoa($ip);
6567: $name_to_ip{$name} = $ip;
6568: } else {
6569: $ip = $name_to_ip{$name};
6570: }
6571: push(@{$iphost{$ip}},$id);
6572: }
6573: return %iphost;
6574: }
6575:
6576: # ------------------------------------------------------ Read spare server file
6577: {
6578: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
6579:
6580: while (my $configline=<$config>) {
6581: chomp($configline);
6582: if ($configline) {
6583: $spareid{$configline}=1;
6584: }
6585: }
6586: close($config);
6587: }
6588: # ------------------------------------------------------------ Read permissions
6589: {
6590: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
6591:
6592: while (my $configline=<$config>) {
6593: chomp($configline);
6594: if ($configline) {
6595: my ($role,$perm)=split(/ /,$configline);
6596: if ($perm ne '') { $pr{$role}=$perm; }
6597: }
6598: }
6599: close($config);
6600: }
6601:
6602: # -------------------------------------------- Read plain texts for permissions
6603: {
6604: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
6605:
6606: while (my $configline=<$config>) {
6607: chomp($configline);
6608: if ($configline) {
6609: my ($short,$plain)=split(/:/,$configline);
6610: if ($plain ne '') { $prp{$short}=$plain; }
6611: }
6612: }
6613: close($config);
6614: }
6615:
6616: # ---------------------------------------------------------- Read package table
6617: {
6618: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
6619:
6620: while (my $configline=<$config>) {
6621: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
6622: chomp($configline);
6623: my ($short,$plain)=split(/:/,$configline);
6624: my ($pack,$name)=split(/\&/,$short);
6625: if ($plain ne '') {
6626: $packagetab{$pack.'&'.$name.'&name'}=$name;
6627: $packagetab{$short}=$plain;
6628: }
6629: }
6630: close($config);
6631: }
6632:
6633: # ------------- set up temporary directory
6634: {
6635: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
6636:
6637: }
6638:
6639: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
6640:
6641: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
6642: $dumpcount=0;
6643:
6644: &logtouch();
6645: &logthis('<font color="yellow">INFO: Read configuration</font>');
6646: $readit=1;
6647: {
6648: use integer;
6649: my $test=(2**32)+1;
6650: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
6651: &logthis(" Detected 64bit platform ($_64bit)");
6652: }
6653: }
6654: }
6655:
6656: 1;
6657: __END__
6658:
6659: =pod
6660:
6661: =head1 NAME
6662:
6663: Apache::lonnet - Subroutines to ask questions about things in the network.
6664:
6665: =head1 SYNOPSIS
6666:
6667: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
6668:
6669: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
6670:
6671: Common parameters:
6672:
6673: =over 4
6674:
6675: =item *
6676:
6677: $uname : an internal username (if $cname expecting a course Id specifically)
6678:
6679: =item *
6680:
6681: $udom : a domain (if $cdom expecting a course's domain specifically)
6682:
6683: =item *
6684:
6685: $symb : a resource instance identifier
6686:
6687: =item *
6688:
6689: $namespace : the name of a .db file that contains the data needed or
6690: being set.
6691:
6692: =back
6693:
6694: =head1 OVERVIEW
6695:
6696: lonnet provides subroutines which interact with the
6697: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
6698: about classes, users, and resources.
6699:
6700: For many of these objects you can also use this to store data about
6701: them or modify them in various ways.
6702:
6703: =head2 Symbs
6704:
6705: To identify a specific instance of a resource, LON-CAPA uses symbols
6706: or "symbs"X<symb>. These identifiers are built from the URL of the
6707: map, the resource number of the resource in the map, and the URL of
6708: the resource itself. The latter is somewhat redundant, but might help
6709: if maps change.
6710:
6711: An example is
6712:
6713: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
6714:
6715: The respective map entry is
6716:
6717: <resource id="19" src="/res/msu/korte/tests/part12.problem"
6718: title="Problem 2">
6719: </resource>
6720:
6721: Symbs are used by the random number generator, as well as to store and
6722: restore data specific to a certain instance of for example a problem.
6723:
6724: =head2 Storing And Retrieving Data
6725:
6726: X<store()>X<cstore()>X<restore()>Three of the most important functions
6727: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
6728: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
6729: is is the non-critical message twin of cstore. These functions are for
6730: handlers to store a perl hash to a user's permanent data space in an
6731: easy manner, and to retrieve it again on another call. It is expected
6732: that a handler would use this once at the beginning to retrieve data,
6733: and then again once at the end to send only the new data back.
6734:
6735: The data is stored in the user's data directory on the user's
6736: homeserver under the ID of the course.
6737:
6738: The hash that is returned by restore will have all of the previous
6739: value for all of the elements of the hash.
6740:
6741: Example:
6742:
6743: #creating a hash
6744: my %hash;
6745: $hash{'foo'}='bar';
6746:
6747: #storing it
6748: &Apache::lonnet::cstore(\%hash);
6749:
6750: #changing a value
6751: $hash{'foo'}='notbar';
6752:
6753: #adding a new value
6754: $hash{'bar'}='foo';
6755: &Apache::lonnet::cstore(\%hash);
6756:
6757: #retrieving the hash
6758: my %history=&Apache::lonnet::restore();
6759:
6760: #print the hash
6761: foreach my $key (sort(keys(%history))) {
6762: print("\%history{$key} = $history{$key}");
6763: }
6764:
6765: Will print out:
6766:
6767: %history{1:foo} = bar
6768: %history{1:keys} = foo:timestamp
6769: %history{1:timestamp} = 990455579
6770: %history{2:bar} = foo
6771: %history{2:foo} = notbar
6772: %history{2:keys} = foo:bar:timestamp
6773: %history{2:timestamp} = 990455580
6774: %history{bar} = foo
6775: %history{foo} = notbar
6776: %history{timestamp} = 990455580
6777: %history{version} = 2
6778:
6779: Note that the special hash entries C<keys>, C<version> and
6780: C<timestamp> were added to the hash. C<version> will be equal to the
6781: total number of versions of the data that have been stored. The
6782: C<timestamp> attribute will be the UNIX time the hash was
6783: stored. C<keys> is available in every historical section to list which
6784: keys were added or changed at a specific historical revision of a
6785: hash.
6786:
6787: B<Warning>: do not store the hash that restore returns directly. This
6788: will cause a mess since it will restore the historical keys as if the
6789: were new keys. I.E. 1:foo will become 1:1:foo etc.
6790:
6791: Calling convention:
6792:
6793: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
6794: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
6795:
6796: For more detailed information, see lonnet specific documentation.
6797:
6798: =head1 RETURN MESSAGES
6799:
6800: =over 4
6801:
6802: =item * B<con_lost>: unable to contact remote host
6803:
6804: =item * B<con_delayed>: unable to contact remote host, message will be delivered
6805: when the connection is brought back up
6806:
6807: =item * B<con_failed>: unable to contact remote host and unable to save message
6808: for later delivery
6809:
6810: =item * B<error:>: an error a occured, a description of the error follows the :
6811:
6812: =item * B<no_such_host>: unable to fund a host associated with the user/domain
6813: that was requested
6814:
6815: =back
6816:
6817: =head1 PUBLIC SUBROUTINES
6818:
6819: =head2 Session Environment Functions
6820:
6821: =over 4
6822:
6823: =item *
6824: X<appenv()>
6825: B<appenv(%hash)>: the value of %hash is written to
6826: the user envirnoment file, and will be restored for each access this
6827: user makes during this session, also modifies the %env for the current
6828: process
6829:
6830: =item *
6831: X<delenv()>
6832: B<delenv($regexp)>: removes all items from the session
6833: environment file that matches the regular expression in $regexp. The
6834: values are also delted from the current processes %env.
6835:
6836: =back
6837:
6838: =head2 User Information
6839:
6840: =over 4
6841:
6842: =item *
6843: X<queryauthenticate()>
6844: B<queryauthenticate($uname,$udom)>: try to determine user's current
6845: authentication scheme
6846:
6847: =item *
6848: X<authenticate()>
6849: B<authenticate($uname,$upass,$udom)>: try to
6850: authenticate user from domain's lib servers (first use the current
6851: one). C<$upass> should be the users password.
6852:
6853: =item *
6854: X<homeserver()>
6855: B<homeserver($uname,$udom)>: find the server which has
6856: the user's directory and files (there must be only one), this caches
6857: the answer, and also caches if there is a borken connection.
6858:
6859: =item *
6860: X<idget()>
6861: B<idget($udom,@ids)>: find the usernames behind a list of IDs
6862: (IDs are a unique resource in a domain, there must be only 1 ID per
6863: username, and only 1 username per ID in a specific domain) (returns
6864: hash: id=>name,id=>name)
6865:
6866: =item *
6867: X<idrget()>
6868: B<idrget($udom,@unames)>: find the IDs behind a list of
6869: usernames (returns hash: name=>id,name=>id)
6870:
6871: =item *
6872: X<idput()>
6873: B<idput($udom,%ids)>: store away a list of names and associated IDs
6874:
6875: =item *
6876: X<rolesinit()>
6877: B<rolesinit($udom,$username,$authhost)>: get user privileges
6878:
6879: =item *
6880: X<getsection()>
6881: B<getsection($udom,$uname,$cname)>: finds the section of student in the
6882: course $cname, return section name/number or '' for "not in course"
6883: and '-1' for "no section"
6884:
6885: =item *
6886: X<userenvironment()>
6887: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
6888: passed in @what from the requested user's environment, returns a hash
6889:
6890: =back
6891:
6892: =head2 User Roles
6893:
6894: =over 4
6895:
6896: =item *
6897:
6898: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
6899: actions
6900: F: full access
6901: U,I,K: authentication modes (cxx only)
6902: '': forbidden
6903: 1: user needs to choose course
6904: 2: browse allowed
6905:
6906: =item *
6907:
6908: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
6909: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
6910: and course level
6911:
6912: =item *
6913:
6914: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
6915: explanation of a user role term
6916:
6917: =back
6918:
6919: =head2 User Modification
6920:
6921: =over 4
6922:
6923: =item *
6924:
6925: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
6926: user for the level given by URL. Optional start and end dates (leave empty
6927: string or zero for "no date")
6928:
6929: =item *
6930:
6931: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
6932: change a users, password, possible return values are: ok,
6933: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
6934: refused
6935:
6936: =item *
6937:
6938: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
6939:
6940: =item *
6941:
6942: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
6943: modify user
6944:
6945: =item *
6946:
6947: modifystudent
6948:
6949: modify a students enrollment and identification information.
6950: The course id is resolved based on the current users environment.
6951: This means the envoking user must be a course coordinator or otherwise
6952: associated with a course.
6953:
6954: This call is essentially a wrapper for lonnet::modifyuser and
6955: lonnet::modify_student_enrollment
6956:
6957: Inputs:
6958:
6959: =over 4
6960:
6961: =item B<$udom> Students loncapa domain
6962:
6963: =item B<$uname> Students loncapa login name
6964:
6965: =item B<$uid> Students id/student number
6966:
6967: =item B<$umode> Students authentication mode
6968:
6969: =item B<$upass> Students password
6970:
6971: =item B<$first> Students first name
6972:
6973: =item B<$middle> Students middle name
6974:
6975: =item B<$last> Students last name
6976:
6977: =item B<$gene> Students generation
6978:
6979: =item B<$usec> Students section in course
6980:
6981: =item B<$end> Unix time of the roles expiration
6982:
6983: =item B<$start> Unix time of the roles start date
6984:
6985: =item B<$forceid> If defined, allow $uid to be changed
6986:
6987: =item B<$desiredhome> server to use as home server for student
6988:
6989: =back
6990:
6991: =item *
6992:
6993: modify_student_enrollment
6994:
6995: Change a students enrollment status in a class. The environment variable
6996: 'role.request.course' must be defined for this function to proceed.
6997:
6998: Inputs:
6999:
7000: =over 4
7001:
7002: =item $udom, students domain
7003:
7004: =item $uname, students name
7005:
7006: =item $uid, students user id
7007:
7008: =item $first, students first name
7009:
7010: =item $middle
7011:
7012: =item $last
7013:
7014: =item $gene
7015:
7016: =item $usec
7017:
7018: =item $end
7019:
7020: =item $start
7021:
7022: =back
7023:
7024:
7025: =item *
7026:
7027: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7028: custom role; give a custom role to a user for the level given by URL. Specify
7029: name and domain of role author, and role name
7030:
7031: =item *
7032:
7033: revokerole($udom,$uname,$url,$role) : revoke a role for url
7034:
7035: =item *
7036:
7037: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7038:
7039: =back
7040:
7041: =head2 Course Infomation
7042:
7043: =over 4
7044:
7045: =item *
7046:
7047: coursedescription($courseid) : returns a hash of information about the
7048: specified course id, including all environment settings for the
7049: course, the description of the course will be in the hash under the
7050: key 'description'
7051:
7052: =item *
7053:
7054: resdata($name,$domain,$type,@which) : request for current parameter
7055: setting for a specific $type, where $type is either 'course' or 'user',
7056: @what should be a list of parameters to ask about. This routine caches
7057: answers for 5 minutes.
7058:
7059: =back
7060:
7061: =head2 Course Modification
7062:
7063: =over 4
7064:
7065: =item *
7066:
7067: writecoursepref($courseid,%prefs) : write preferences (environment
7068: database) for a course
7069:
7070: =item *
7071:
7072: createcourse($udom,$description,$url) : make/modify course
7073:
7074: =back
7075:
7076: =head2 Resource Subroutines
7077:
7078: =over 4
7079:
7080: =item *
7081:
7082: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7083:
7084: =item *
7085:
7086: repcopy($filename) : subscribes to the requested file, and attempts to
7087: replicate from the owning library server, Might return
7088: 'unavailable', 'not_found', 'forbidden', 'ok', or
7089: 'bad_request', also attempts to grab the metadata for the
7090: resource. Expects the local filesystem pathname
7091: (/home/httpd/html/res/....)
7092:
7093: =back
7094:
7095: =head2 Resource Information
7096:
7097: =over 4
7098:
7099: =item *
7100:
7101: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7102: a vairety of different possible values, $varname should be a request
7103: string, and the other parameters can be used to specify who and what
7104: one is asking about.
7105:
7106: Possible values for $varname are environment.lastname (or other item
7107: from the envirnment hash), user.name (or someother aspect about the
7108: user), resource.0.maxtries (or some other part and parameter of a
7109: resource)
7110:
7111: =item *
7112:
7113: directcondval($number) : get current value of a condition; reads from a state
7114: string
7115:
7116: =item *
7117:
7118: condval($condidx) : value of condition index based on state
7119:
7120: =item *
7121:
7122: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7123: resource's metadata, $what should be either a specific key, or either
7124: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7125: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7126:
7127: this function automatically caches all requests
7128:
7129: =item *
7130:
7131: metadata_query($query,$custom,$customshow) : make a metadata query against the
7132: network of library servers; returns file handle of where SQL and regex results
7133: will be stored for query
7134:
7135: =item *
7136:
7137: symbread($filename) : return symbolic list entry (filename argument optional);
7138: returns the data handle
7139:
7140: =item *
7141:
7142: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7143: a possible symb for the URL in $thisfn, and if is an encryypted
7144: resource that the user accessed using /enc/ returns a 1 on success, 0
7145: on failure, user must be in a course, as it assumes the existance of
7146: the course initial hash, and uses $env('request.course.id'}
7147:
7148:
7149: =item *
7150:
7151: symbclean($symb) : removes versions numbers from a symb, returns the
7152: cleaned symb
7153:
7154: =item *
7155:
7156: is_on_map($uri) : checks if the $uri is somewhere on the current
7157: course map, user must be in a course for it to work.
7158:
7159: =item *
7160:
7161: numval($salt) : return random seed value (addend for rndseed)
7162:
7163: =item *
7164:
7165: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7166: a random seed, all arguments are optional, if they aren't sent it uses the
7167: environment to derive them. Note: if symb isn't sent and it can't get one
7168: from &symbread it will use the current time as its return value
7169:
7170: =item *
7171:
7172: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7173: unfakeable, receipt
7174:
7175: =item *
7176:
7177: receipt() : API to ireceipt working off of env values; given out to users
7178:
7179: =item *
7180:
7181: countacc($url) : count the number of accesses to a given URL
7182:
7183: =item *
7184:
7185: 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
7186:
7187: =item *
7188:
7189: 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)
7190:
7191: =item *
7192:
7193: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
7194:
7195: =item *
7196:
7197: devalidate($symb) : devalidate temporary spreadsheet calculations,
7198: forcing spreadsheet to reevaluate the resource scores next time.
7199:
7200: =back
7201:
7202: =head2 Storing/Retreiving Data
7203:
7204: =over 4
7205:
7206: =item *
7207:
7208: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7209: for this url; hashref needs to be given and should be a \%hashname; the
7210: remaining args aren't required and if they aren't passed or are '' they will
7211: be derived from the env
7212:
7213: =item *
7214:
7215: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7216: uses critical subroutine
7217:
7218: =item *
7219:
7220: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7221: all args are optional
7222:
7223: =item *
7224:
7225: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7226: works very similar to store/cstore, but all data is stored in a
7227: temporary location and can be reset using tmpreset, $storehash should
7228: be a hash reference, returns nothing on success
7229:
7230: =item *
7231:
7232: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7233: similar to restore, but all data is stored in a temporary location and
7234: can be reset using tmpreset. Returns a hash of values on success,
7235: error string otherwise.
7236:
7237: =item *
7238:
7239: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7240: deltes all keys for $symb form the temporary storage hash.
7241:
7242: =item *
7243:
7244: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7245: reference filled in from namesp ($udom and $uname are optional)
7246:
7247: =item *
7248:
7249: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7250: namesp ($udom and $uname are optional)
7251:
7252: =item *
7253:
7254: dump($namespace,$udom,$uname,$regexp,$range) :
7255: dumps the complete (or key matching regexp) namespace into a hash
7256: ($udom, $uname, $regexp, $range are optional)
7257:
7258: $range should be either an integer '100' (give me the first 100
7259: matching records)
7260: or be two integers sperated by a - with no spaces
7261: '30-50' (give me the 30th through the 50th matching
7262: records)
7263: =item *
7264:
7265: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7266: $store can be a scalar, an array reference, or if the amount to be
7267: incremented is > 1, a hash reference.
7268:
7269: ($udom and $uname are optional)
7270:
7271: =item *
7272:
7273: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7274: ($udom and $uname are optional)
7275:
7276: =item *
7277:
7278: putstore($namespace,$storehash,$udomain,$uname) : stores hash in namesp
7279: keys used in storehash include version information (e.g., 1:$symb:message etc.) as
7280: used in records written by &store and retrieved by &restore. This function
7281: was created for use in editing discussion posts, without incrementing the
7282: version number included in the key for a particular post. The colon
7283: separated list of attribute names (e.g., the value associated with the key
7284: 1:keys:$symb) is also generated and passed in the ampersand separated
7285: items sent to lonnet::reply().
7286:
7287: =item *
7288:
7289: cput($namespace,$storehash,$udom,$uname) : critical put
7290: ($udom and $uname are optional)
7291:
7292: =item *
7293:
7294: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7295: reference filled in from namesp (encrypts the return communication)
7296: ($udom and $uname are optional)
7297:
7298: =item *
7299:
7300: log($udom,$name,$home,$message) : write to permanent log for user; use
7301: critical subroutine
7302:
7303: =back
7304:
7305: =head2 Network Status Functions
7306:
7307: =over 4
7308:
7309: =item *
7310:
7311: dirlist($uri) : return directory list based on URI
7312:
7313: =item *
7314:
7315: spareserver() : find server with least workload from spare.tab
7316:
7317: =back
7318:
7319: =head2 Apache Request
7320:
7321: =over 4
7322:
7323: =item *
7324:
7325: ssi($url,%hash) : server side include, does a complete request cycle on url to
7326: localhost, posts hash
7327:
7328: =back
7329:
7330: =head2 Data to String to Data
7331:
7332: =over 4
7333:
7334: =item *
7335:
7336: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7337: and '&' separators, supports elements that are arrayrefs and hashrefs
7338:
7339: =item *
7340:
7341: hashref2str($hashref) : convert a hashref into a string complete with
7342: escaping and '=' and '&' separators, supports elements that are
7343: arrayrefs and hashrefs
7344:
7345: =item *
7346:
7347: arrayref2str($arrayref) : convert an arrayref into a string complete
7348: with escaping and '&' separators, supports elements that are arrayrefs
7349: and hashrefs
7350:
7351: =item *
7352:
7353: str2hash($string) : convert string to hash using unescaping and
7354: splitting on '=' and '&', supports elements that are arrayrefs and
7355: hashrefs
7356:
7357: =item *
7358:
7359: str2array($string) : convert string to hash using unescaping and
7360: splitting on '&', supports elements that are arrayrefs and hashrefs
7361:
7362: =back
7363:
7364: =head2 Logging Routines
7365:
7366: =over 4
7367:
7368: These routines allow one to make log messages in the lonnet.log and
7369: lonnet.perm logfiles.
7370:
7371: =item *
7372:
7373: logtouch() : make sure the logfile, lonnet.log, exists
7374:
7375: =item *
7376:
7377: logthis() : append message to the normal lonnet.log file, it gets
7378: preiodically rolled over and deleted.
7379:
7380: =item *
7381:
7382: logperm() : append a permanent message to lonnet.perm.log, this log
7383: file never gets deleted by any automated portion of the system, only
7384: messages of critical importance should go in here.
7385:
7386: =back
7387:
7388: =head2 General File Helper Routines
7389:
7390: =over 4
7391:
7392: =item *
7393:
7394: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7395: (a) files in /uploaded
7396: (i) If a local copy of the file exists -
7397: compares modification date of local copy with last-modified date for
7398: definitive version stored on home server for course. If local copy is
7399: stale, requests a new version from the home server and stores it.
7400: If the original has been removed from the home server, then local copy
7401: is unlinked.
7402: (ii) If local copy does not exist -
7403: requests the file from the home server and stores it.
7404:
7405: If $caller is 'uploadrep':
7406: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7407: for request for files originally uploaded via DOCS.
7408: - returns 'ok' if fresh local copy now available, -1 otherwise.
7409:
7410: Otherwise:
7411: This indicates a call from the content generation phase of the request.
7412: - returns the entire contents of the file or -1.
7413:
7414: (b) files in /res
7415: - returns the entire contents of a file or -1;
7416: it properly subscribes to and replicates the file if neccessary.
7417:
7418:
7419: =item *
7420:
7421: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7422: reference
7423:
7424: returns either a stat() list of data about the file or an empty list
7425: if the file doesn't exist or couldn't find out about it (connection
7426: problems or user unknown)
7427:
7428: =item *
7429:
7430: filelocation($dir,$file) : returns file system location of a file
7431: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7432: directory that relative $file lookups are to looked in ($dir of /a/dir
7433: and a file of ../bob will become /a/bob)
7434:
7435: =item *
7436:
7437: hreflocation($dir,$file) : returns file system location or a URL; same as
7438: filelocation except for hrefs
7439:
7440: =item *
7441:
7442: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7443:
7444: =back
7445:
7446: =head2 Usererfile file routines (/uploaded*)
7447:
7448: =over 4
7449:
7450: =item *
7451:
7452: userfileupload(): main rotine for putting a file in a user or course's
7453: filespace, arguments are,
7454:
7455: formname - required - this is the name of the element in $env where the
7456: filename, and the contents of the file to create/modifed exist
7457: the filename is in $env{'form.'.$formname.'.filename'} and the
7458: contents of the file is located in $env{'form.'.$formname}
7459: coursedoc - if true, store the file in the course of the active role
7460: of the current user
7461: subdir - required - subdirectory to put the file in under ../userfiles/
7462: if undefined, it will be placed in "unknown"
7463:
7464: (This routine calls clean_filename() to remove any dangerous
7465: characters from the filename, and then calls finuserfileupload() to
7466: complete the transaction)
7467:
7468: returns either the url of the uploaded file (/uploaded/....) if successful
7469: and /adm/notfound.html if unsuccessful
7470:
7471: =item *
7472:
7473: clean_filename(): routine for cleaing a filename up for storage in
7474: userfile space, argument is:
7475:
7476: filename - proposed filename
7477:
7478: returns: the new clean filename
7479:
7480: =item *
7481:
7482: finishuserfileupload(): routine that creaes and sends the file to
7483: userspace, probably shouldn't be called directly
7484:
7485: docuname: username or courseid of destination for the file
7486: docudom: domain of user/course of destination for the file
7487: formname: same as for userfileupload()
7488: fname: filename (inculding subdirectories) for the file
7489:
7490: returns either the url of the uploaded file (/uploaded/....) if successful
7491: and /adm/notfound.html if unsuccessful
7492:
7493: =item *
7494:
7495: renameuserfile(): renames an existing userfile to a new name
7496:
7497: Args:
7498: docuname: username or courseid of destination for the file
7499: docudom: domain of user/course of destination for the file
7500: old: current file name (including any subdirs under userfiles)
7501: new: desired file name (including any subdirs under userfiles)
7502:
7503: =item *
7504:
7505: mkdiruserfile(): creates a directory is a userfiles dir
7506:
7507: Args:
7508: docuname: username or courseid of destination for the file
7509: docudom: domain of user/course of destination for the file
7510: dir: dir to create (including any subdirs under userfiles)
7511:
7512: =item *
7513:
7514: removeuserfile(): removes a file that exists in userfiles
7515:
7516: Args:
7517: docuname: username or courseid of destination for the file
7518: docudom: domain of user/course of destination for the file
7519: fname: filname to delete (including any subdirs under userfiles)
7520:
7521: =item *
7522:
7523: removeuploadedurl(): convience function for removeuserfile()
7524:
7525: Args:
7526: url: a full /uploaded/... url to delete
7527:
7528: =back
7529:
7530: =head2 HTTP Helper Routines
7531:
7532: =over 4
7533:
7534: =item *
7535:
7536: escape() : unpack non-word characters into CGI-compatible hex codes
7537:
7538: =item *
7539:
7540: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
7541:
7542: =back
7543:
7544: =head1 PRIVATE SUBROUTINES
7545:
7546: =head2 Underlying communication routines (Shouldn't call)
7547:
7548: =over 4
7549:
7550: =item *
7551:
7552: subreply() : tries to pass a message to lonc, returns con_lost if incapable
7553:
7554: =item *
7555:
7556: reply() : uses subreply to send a message to remote machine, logs all failures
7557:
7558: =item *
7559:
7560: critical() : passes a critical message to another server; if cannot
7561: get through then place message in connection buffer directory and
7562: returns con_delayed, if incapable of saving message, returns
7563: con_failed
7564:
7565: =item *
7566:
7567: reconlonc() : tries to reconnect lonc client processes.
7568:
7569: =back
7570:
7571: =head2 Resource Access Logging
7572:
7573: =over 4
7574:
7575: =item *
7576:
7577: flushcourselogs() : flush (save) buffer logs and access logs
7578:
7579: =item *
7580:
7581: courselog($what) : save message for course in hash
7582:
7583: =item *
7584:
7585: courseacclog($what) : save message for course using &courselog(). Perform
7586: special processing for specific resource types (problems, exams, quizzes, etc).
7587:
7588: =item *
7589:
7590: goodbye() : flush course logs and log shutting down; it is called in srm.conf
7591: as a PerlChildExitHandler
7592:
7593: =back
7594:
7595: =head2 Other
7596:
7597: =over 4
7598:
7599: =item *
7600:
7601: symblist($mapname,%newhash) : update symbolic storage links
7602:
7603: =back
7604:
7605: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>