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