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