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