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