1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.750 2006/06/19 21:01:01 banghart 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 %coursetypebuf
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 HTML::LCParser;
49: use HTML::Parser;
50: use Fcntl qw(:flock);
51: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
52: use Time::HiRes qw( gettimeofday tv_interval );
53: use Cache::Memcached;
54: use Digest::MD5;
55: use lib '/home/httpd/lib/perl';
56: use LONCAPA;
57: use LONCAPA::Configuration;
58:
59: my $readit;
60: my $max_connection_retries = 10; # Or some such value.
61:
62: require Exporter;
63:
64: our @ISA = qw (Exporter);
65: our @EXPORT = qw(%env);
66:
67: =pod
68:
69: =head1 Package Variables
70:
71: These are largely undocumented, so if you decipher one please note it here.
72:
73: =over 4
74:
75: =item $processmarker
76:
77: Contains the time this process was started and this servers host id.
78:
79: =item $dumpcount
80:
81: Counts the number of times a message log flush has been attempted (regardless
82: of success) by this process. Used as part of the filename when messages are
83: delayed.
84:
85: =back
86:
87: =cut
88:
89:
90: # --------------------------------------------------------------------- Logging
91: {
92: my $logid;
93: sub instructor_log {
94: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
95: $logid++;
96: my $id=time().'00000'.$$.'00000'.$logid;
97: return &Apache::lonnet::put('nohist_'.$hash_name,
98: { $id => {
99: 'exe_uname' => $env{'user.name'},
100: 'exe_udom' => $env{'user.domain'},
101: 'exe_time' => time(),
102: 'exe_ip' => $ENV{'REMOTE_ADDR'},
103: 'delflag' => $delflag,
104: 'logentry' => $storehash,
105: 'uname' => $uname,
106: 'udom' => $udom,
107: }
108: },
109: $env{'course.'.$env{'request.course.id'}.'.domain'},
110: $env{'course.'.$env{'request.course.id'}.'.num'}
111: );
112: }
113: }
114:
115: sub logtouch {
116: my $execdir=$perlvar{'lonDaemons'};
117: unless (-e "$execdir/logs/lonnet.log") {
118: open(my $fh,">>$execdir/logs/lonnet.log");
119: close $fh;
120: }
121: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
122: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
123: }
124:
125: sub logthis {
126: my $message=shift;
127: my $execdir=$perlvar{'lonDaemons'};
128: my $now=time;
129: my $local=localtime($now);
130: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
131: print $fh "$local ($$): $message\n";
132: close($fh);
133: }
134: return 1;
135: }
136:
137: sub logperm {
138: my $message=shift;
139: my $execdir=$perlvar{'lonDaemons'};
140: my $now=time;
141: my $local=localtime($now);
142: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
143: print $fh "$now:$message:$local\n";
144: close($fh);
145: }
146: return 1;
147: }
148:
149: # -------------------------------------------------- Non-critical communication
150: sub subreply {
151: my ($cmd,$server)=@_;
152: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
153: #
154: # With loncnew process trimming, there's a timing hole between lonc server
155: # process exit and the master server picking up the listen on the AF_UNIX
156: # socket. In that time interval, a lock file will exist:
157:
158: my $lockfile=$peerfile.".lock";
159: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
160: sleep(1);
161: }
162: # At this point, either a loncnew parent is listening or an old lonc
163: # or loncnew child is listening so we can connect or everything's dead.
164: #
165: # We'll give the connection a few tries before abandoning it. If
166: # connection is not possible, we'll con_lost back to the client.
167: #
168: my $client;
169: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
170: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
171: Type => SOCK_STREAM,
172: Timeout => 10);
173: if($client) {
174: last; # Connected!
175: }
176: sleep(1); # Try again later if failed connection.
177: }
178: my $answer;
179: if ($client) {
180: print $client "sethost:$server:$cmd\n";
181: $answer=<$client>;
182: if (!$answer) { $answer="con_lost"; }
183: chomp($answer);
184: } else {
185: $answer = 'con_lost'; # Failed connection.
186: }
187: return $answer;
188: }
189:
190: sub reply {
191: my ($cmd,$server)=@_;
192: unless (defined($hostname{$server})) { return 'no_such_host'; }
193: my $answer=subreply($cmd,$server);
194: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
195: &logthis("<font color=\"blue\">WARNING:".
196: " $cmd to $server returned $answer</font>");
197: }
198: return $answer;
199: }
200:
201: # ----------------------------------------------------------- Send USR1 to lonc
202:
203: sub reconlonc {
204: my $peerfile=shift;
205: &logthis("Trying to reconnect for $peerfile");
206: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
207: if (open(my $fh,"<$loncfile")) {
208: my $loncpid=<$fh>;
209: chomp($loncpid);
210: if (kill 0 => $loncpid) {
211: &logthis("lonc at pid $loncpid responding, sending USR1");
212: kill USR1 => $loncpid;
213: sleep 1;
214: if (-e "$peerfile") { return; }
215: &logthis("$peerfile still not there, give it another try");
216: sleep 5;
217: if (-e "$peerfile") { return; }
218: &logthis(
219: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
220: } else {
221: &logthis(
222: "<font color=\"blue\">WARNING:".
223: " lonc at pid $loncpid not responding, giving up</font>");
224: }
225: } else {
226: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
227: }
228: }
229:
230: # ------------------------------------------------------ Critical communication
231:
232: sub critical {
233: my ($cmd,$server)=@_;
234: unless ($hostname{$server}) {
235: &logthis("<font color=\"blue\">WARNING:".
236: " Critical message to unknown server ($server)</font>");
237: return 'no_such_host';
238: }
239: my $answer=reply($cmd,$server);
240: if ($answer eq 'con_lost') {
241: &reconlonc("$perlvar{'lonSockDir'}/$server");
242: my $answer=reply($cmd,$server);
243: if ($answer eq 'con_lost') {
244: my $now=time;
245: my $middlename=$cmd;
246: $middlename=substr($middlename,0,16);
247: $middlename=~s/\W//g;
248: my $dfilename=
249: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
250: $dumpcount++;
251: {
252: my $dfh;
253: if (open($dfh,">$dfilename")) {
254: print $dfh "$cmd\n";
255: close($dfh);
256: }
257: }
258: sleep 2;
259: my $wcmd='';
260: {
261: my $dfh;
262: if (open($dfh,"<$dfilename")) {
263: $wcmd=<$dfh>;
264: close($dfh);
265: }
266: }
267: chomp($wcmd);
268: if ($wcmd eq $cmd) {
269: &logthis("<font color=\"blue\">WARNING: ".
270: "Connection buffer $dfilename: $cmd</font>");
271: &logperm("D:$server:$cmd");
272: return 'con_delayed';
273: } else {
274: &logthis("<font color=\"red\">CRITICAL:"
275: ." Critical connection failed: $server $cmd</font>");
276: &logperm("F:$server:$cmd");
277: return 'con_failed';
278: }
279: }
280: }
281: return $answer;
282: }
283:
284: # ------------------------------------------- Transfer profile into environment
285:
286: sub transfer_profile_to_env {
287: my ($lonidsdir,$handle)=@_;
288: if (!defined($lonidsdir)) {
289: $lonidsdir = $perlvar{'lonIDsDir'};
290: }
291: if (!defined($handle)) {
292: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
293: }
294:
295: my @profile;
296: {
297: open(my $idf,"$lonidsdir/$handle.id");
298: flock($idf,LOCK_SH);
299: @profile=<$idf>;
300: close($idf);
301: }
302: my $envi;
303: my %Remove;
304: for ($envi=0;$envi<=$#profile;$envi++) {
305: chomp($profile[$envi]);
306: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
307: $envname=&unescape($envname);
308: $envvalue=&unescape($envvalue);
309: $env{$envname} = $envvalue;
310: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
311: if ($time < time-300) {
312: $Remove{$key}++;
313: }
314: }
315: }
316: $env{'user.environment'} = "$lonidsdir/$handle.id";
317: foreach my $expired_key (keys(%Remove)) {
318: &delenv($expired_key);
319: }
320: }
321:
322: # ---------------------------------------------------------- Append Environment
323:
324: sub appenv {
325: my %newenv=@_;
326: foreach my $key (keys(%newenv)) {
327: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
328: &logthis("<font color=\"blue\">WARNING: ".
329: "Attempt to modify environment ".$key." to ".$newenv{$key}
330: .'</font>');
331: delete($newenv{$key});
332: } else {
333: $env{$key}=$newenv{$key};
334: }
335: }
336:
337: my $lockfh;
338: unless (open($lockfh,"$env{'user.environment'}")) {
339: return 'error: '.$!;
340: }
341: unless (flock($lockfh,LOCK_EX)) {
342: &logthis("<font color=\"blue\">WARNING: ".
343: 'Could not obtain exclusive lock in appenv: '.$!);
344: close($lockfh);
345: return 'error: '.$!;
346: }
347:
348: my @oldenv;
349: {
350: my $fh;
351: unless (open($fh,"$env{'user.environment'}")) {
352: return 'error: '.$!;
353: }
354: @oldenv=<$fh>;
355: close($fh);
356: }
357: for (my $i=0; $i<=$#oldenv; $i++) {
358: chomp($oldenv[$i]);
359: if ($oldenv[$i] ne '') {
360: my ($name,$value)=split(/=/,$oldenv[$i],2);
361: $name=&unescape($name);
362: $value=&unescape($value);
363: unless (defined($newenv{$name})) {
364: $newenv{$name}=$value;
365: }
366: }
367: }
368: {
369: my $fh;
370: unless (open($fh,">$env{'user.environment'}")) {
371: return 'error';
372: }
373: my $newname;
374: foreach $newname (keys %newenv) {
375: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
376: }
377: close($fh);
378: }
379:
380: close($lockfh);
381: return 'ok';
382: }
383: # ----------------------------------------------------- Delete from Environment
384:
385: sub delenv {
386: my $delthis=shift;
387: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
388: &logthis("<font color=\"blue\">WARNING: ".
389: "Attempt to delete from environment ".$delthis);
390: return 'error';
391: }
392: my @oldenv;
393: {
394: my $fh;
395: unless (open($fh,"$env{'user.environment'}")) {
396: return 'error';
397: }
398: unless (flock($fh,LOCK_SH)) {
399: &logthis("<font color=\"blue\">WARNING: ".
400: 'Could not obtain shared lock in delenv: '.$!);
401: close($fh);
402: return 'error: '.$!;
403: }
404: @oldenv=<$fh>;
405: close($fh);
406: }
407: {
408: my $fh;
409: unless (open($fh,">$env{'user.environment'}")) {
410: return 'error';
411: }
412: unless (flock($fh,LOCK_EX)) {
413: &logthis("<font color=\"blue\">WARNING: ".
414: 'Could not obtain exclusive lock in delenv: '.$!);
415: close($fh);
416: return 'error: '.$!;
417: }
418: foreach my $cur_key (@oldenv) {
419: my $unescaped_cur_key = &unescape($cur_key);
420: if ($unescaped_cur_key=~/^$delthis/) {
421: my ($key) = split('=',$cur_key,2);
422: $key = &unescape($key);
423: delete($env{$key});
424: } else {
425: print $fh $cur_key;
426: }
427: }
428: close($fh);
429: }
430: return 'ok';
431: }
432:
433: # ------------------------------------------ Find out current server userload
434: # there is a copy in lond
435: sub userload {
436: my $numusers=0;
437: {
438: opendir(LONIDS,$perlvar{'lonIDsDir'});
439: my $filename;
440: my $curtime=time;
441: while ($filename=readdir(LONIDS)) {
442: if ($filename eq '.' || $filename eq '..') {next;}
443: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
444: if ($curtime-$mtime < 1800) { $numusers++; }
445: }
446: closedir(LONIDS);
447: }
448: my $userloadpercent=0;
449: my $maxuserload=$perlvar{'lonUserLoadLim'};
450: if ($maxuserload) {
451: $userloadpercent=100*$numusers/$maxuserload;
452: }
453: $userloadpercent=sprintf("%.2f",$userloadpercent);
454: return $userloadpercent;
455: }
456:
457: # ------------------------------------------ Fight off request when overloaded
458:
459: sub overloaderror {
460: my ($r,$checkserver)=@_;
461: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
462: my $loadavg;
463: if ($checkserver eq $perlvar{'lonHostID'}) {
464: open(my $loadfile,'/proc/loadavg');
465: $loadavg=<$loadfile>;
466: $loadavg =~ s/\s.*//g;
467: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
468: close($loadfile);
469: } else {
470: $loadavg=&reply('load',$checkserver);
471: }
472: my $overload=$loadavg-100;
473: if ($overload>0) {
474: $r->err_headers_out->{'Retry-After'}=$overload;
475: $r->log_error('Overload of '.$overload.' on '.$checkserver);
476: return 413;
477: }
478: return '';
479: }
480:
481: # ------------------------------ Find server with least workload from spare.tab
482:
483: sub spareserver {
484: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
485: my $tryserver;
486: my $spareserver='';
487: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
488: my $lowestserver=$loadpercent > $userloadpercent?
489: $loadpercent : $userloadpercent;
490: foreach $tryserver (keys(%spareid)) {
491: my $loadans=&reply('load',$tryserver);
492: my $userloadans=&reply('userload',$tryserver);
493: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
494: next; #didn't get a number from the server
495: }
496: my $answer;
497: if ($loadans =~ /\d/) {
498: if ($userloadans =~ /\d/) {
499: #both are numbers, pick the bigger one
500: $answer=$loadans > $userloadans?
501: $loadans : $userloadans;
502: } else {
503: $answer = $loadans;
504: }
505: } else {
506: $answer = $userloadans;
507: }
508: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
509: if ($want_server_name) {
510: $spareserver=$tryserver;
511: } else {
512: $spareserver="http://$hostname{$tryserver}";
513: }
514: $lowestserver=$answer;
515: }
516: }
517: return $spareserver;
518: }
519:
520: # --------------------------------------------- Try to change a user's password
521:
522: sub changepass {
523: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
524: $currentpass = &escape($currentpass);
525: $newpass = &escape($newpass);
526: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
527: $server);
528: if (! $answer) {
529: &logthis("No reply on password change request to $server ".
530: "by $uname in domain $udom.");
531: } elsif ($answer =~ "^ok") {
532: &logthis("$uname in $udom successfully changed their password ".
533: "on $server.");
534: } elsif ($answer =~ "^pwchange_failure") {
535: &logthis("$uname in $udom was unable to change their password ".
536: "on $server. The action was blocked by either lcpasswd ".
537: "or pwchange");
538: } elsif ($answer =~ "^non_authorized") {
539: &logthis("$uname in $udom did not get their password correct when ".
540: "attempting to change it on $server.");
541: } elsif ($answer =~ "^auth_mode_error") {
542: &logthis("$uname in $udom attempted to change their password despite ".
543: "not being locally or internally authenticated on $server.");
544: } elsif ($answer =~ "^unknown_user") {
545: &logthis("$uname in $udom attempted to change their password ".
546: "on $server but were unable to because $server is not ".
547: "their home server.");
548: } elsif ($answer =~ "^refused") {
549: &logthis("$server refused to change $uname in $udom password because ".
550: "it was sent an unencrypted request to change the password.");
551: }
552: return $answer;
553: }
554:
555: # ----------------------- Try to determine user's current authentication scheme
556:
557: sub queryauthenticate {
558: my ($uname,$udom)=@_;
559: my $uhome=&homeserver($uname,$udom);
560: if (!$uhome) {
561: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
562: return 'no_host';
563: }
564: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
565: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
566: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
567: }
568: return $answer;
569: }
570:
571: # --------- Try to authenticate user from domain's lib servers (first this one)
572:
573: sub authenticate {
574: my ($uname,$upass,$udom)=@_;
575: $upass=escape($upass);
576: $uname=~s/\W//g;
577: my $uhome=&homeserver($uname,$udom);
578: if (!$uhome) {
579: &logthis("User $uname at $udom is unknown in authenticate");
580: return 'no_host';
581: }
582: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
583: if ($answer eq 'authorized') {
584: &logthis("User $uname at $udom authorized by $uhome");
585: return $uhome;
586: }
587: if ($answer eq 'non_authorized') {
588: &logthis("User $uname at $udom rejected by $uhome");
589: return 'no_host';
590: }
591: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
592: return 'no_host';
593: }
594:
595: # ---------------------- Find the homebase for a user from domain's lib servers
596:
597: my %homecache;
598: sub homeserver {
599: my ($uname,$udom,$ignoreBadCache)=@_;
600: my $index="$uname:$udom";
601:
602: if (exists($homecache{$index})) { return $homecache{$index}; }
603: my $tryserver;
604: foreach $tryserver (keys %libserv) {
605: next if ($ignoreBadCache ne 'true' &&
606: exists($badServerCache{$tryserver}));
607: if ($hostdom{$tryserver} eq $udom) {
608: my $answer=reply("home:$udom:$uname",$tryserver);
609: if ($answer eq 'found') {
610: return $homecache{$index}=$tryserver;
611: } elsif ($answer eq 'no_host') {
612: $badServerCache{$tryserver}=1;
613: }
614: }
615: }
616: return 'no_host';
617: }
618:
619: # ------------------------------------- Find the usernames behind a list of IDs
620:
621: sub idget {
622: my ($udom,@ids)=@_;
623: my %returnhash=();
624:
625: my $tryserver;
626: foreach $tryserver (keys %libserv) {
627: if ($hostdom{$tryserver} eq $udom) {
628: my $idlist=join('&',@ids);
629: $idlist=~tr/A-Z/a-z/;
630: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
631: my @answer=();
632: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
633: @answer=split(/\&/,$reply);
634: } ;
635: my $i;
636: for ($i=0;$i<=$#ids;$i++) {
637: if ($answer[$i]) {
638: $returnhash{$ids[$i]}=$answer[$i];
639: }
640: }
641: }
642: }
643: return %returnhash;
644: }
645:
646: # ------------------------------------- Find the IDs behind a list of usernames
647:
648: sub idrget {
649: my ($udom,@unames)=@_;
650: my %returnhash=();
651: foreach (@unames) {
652: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
653: }
654: return %returnhash;
655: }
656:
657: # ------------------------------- Store away a list of names and associated IDs
658:
659: sub idput {
660: my ($udom,%ids)=@_;
661: my %servers=();
662: foreach (keys %ids) {
663: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
664: my $uhom=&homeserver($_,$udom);
665: if ($uhom ne 'no_host') {
666: my $id=&escape($ids{$_});
667: $id=~tr/A-Z/a-z/;
668: my $unam=&escape($_);
669: if ($servers{$uhom}) {
670: $servers{$uhom}.='&'.$id.'='.$unam;
671: } else {
672: $servers{$uhom}=$id.'='.$unam;
673: }
674: }
675: }
676: foreach (keys %servers) {
677: &critical('idput:'.$udom.':'.$servers{$_},$_);
678: }
679: }
680:
681: # --------------------------------------------------- Assign a key to a student
682:
683: sub assign_access_key {
684: #
685: # a valid key looks like uname:udom#comments
686: # comments are being appended
687: #
688: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
689: $kdom=
690: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
691: $knum=
692: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
693: $cdom=
694: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
695: $cnum=
696: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
697: $udom=$env{'user.name'} unless (defined($udom));
698: $uname=$env{'user.domain'} unless (defined($uname));
699: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
700: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
701: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
702: # assigned to this person
703: # - this should not happen,
704: # unless something went wrong
705: # the first time around
706: # ready to assign
707: $logentry=$1.'; '.$logentry;
708: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
709: $kdom,$knum) eq 'ok') {
710: # key now belongs to user
711: my $envkey='key.'.$cdom.'_'.$cnum;
712: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
713: &appenv('environment.'.$envkey => $ckey);
714: return 'ok';
715: } else {
716: return
717: 'error: Count not permanently assign key, will need to be re-entered later.';
718: }
719: } else {
720: return 'error: Could not assign key, try again later.';
721: }
722: } elsif (!$existing{$ckey}) {
723: # the key does not exist
724: return 'error: The key does not exist';
725: } else {
726: # the key is somebody else's
727: return 'error: The key is already in use';
728: }
729: }
730:
731: # ------------------------------------------ put an additional comment on a key
732:
733: sub comment_access_key {
734: #
735: # a valid key looks like uname:udom#comments
736: # comments are being appended
737: #
738: my ($ckey,$cdom,$cnum,$logentry)=@_;
739: $cdom=
740: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
741: $cnum=
742: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
743: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
744: if ($existing{$ckey}) {
745: $existing{$ckey}.='; '.$logentry;
746: # ready to assign
747: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
748: $cdom,$cnum) eq 'ok') {
749: return 'ok';
750: } else {
751: return 'error: Count not store comment.';
752: }
753: } else {
754: # the key does not exist
755: return 'error: The key does not exist';
756: }
757: }
758:
759: # ------------------------------------------------------ Generate a set of keys
760:
761: sub generate_access_keys {
762: my ($number,$cdom,$cnum,$logentry)=@_;
763: $cdom=
764: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
765: $cnum=
766: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
767: unless (&allowed('mky',$cdom)) { return 0; }
768: unless (($cdom) && ($cnum)) { return 0; }
769: if ($number>10000) { return 0; }
770: sleep(2); # make sure don't get same seed twice
771: srand(time()^($$+($$<<15))); # from "Programming Perl"
772: my $total=0;
773: for (my $i=1;$i<=$number;$i++) {
774: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
775: sprintf("%lx",int(100000*rand)).'-'.
776: sprintf("%lx",int(100000*rand));
777: $newkey=~s/1/g/g; # folks mix up 1 and l
778: $newkey=~s/0/h/g; # and also 0 and O
779: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
780: if ($existing{$newkey}) {
781: $i--;
782: } else {
783: if (&put('accesskeys',
784: { $newkey => '# generated '.localtime().
785: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
786: '; '.$logentry },
787: $cdom,$cnum) eq 'ok') {
788: $total++;
789: }
790: }
791: }
792: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
793: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
794: return $total;
795: }
796:
797: # ------------------------------------------------------- Validate an accesskey
798:
799: sub validate_access_key {
800: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
801: $cdom=
802: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
803: $cnum=
804: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
805: $udom=$env{'user.domain'} unless (defined($udom));
806: $uname=$env{'user.name'} unless (defined($uname));
807: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
808: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
809: }
810:
811: # ------------------------------------- Find the section of student in a course
812: sub devalidate_getsection_cache {
813: my ($udom,$unam,$courseid)=@_;
814: $courseid=~s/\_/\//g;
815: $courseid=~s/^(\w)/\/$1/;
816: my $hashid="$udom:$unam:$courseid";
817: &devalidate_cache_new('getsection',$hashid);
818: }
819:
820: sub getsection {
821: my ($udom,$unam,$courseid)=@_;
822: my $cachetime=1800;
823: $courseid=~s/\_/\//g;
824: $courseid=~s/^(\w)/\/$1/;
825:
826: my $hashid="$udom:$unam:$courseid";
827: my ($result,$cached)=&is_cached_new('getsection',$hashid);
828: if (defined($cached)) { return $result; }
829:
830: my %Pending;
831: my %Expired;
832: #
833: # Each role can either have not started yet (pending), be active,
834: # or have expired.
835: #
836: # If there is an active role, we are done.
837: #
838: # If there is more than one role which has not started yet,
839: # choose the one which will start sooner
840: # If there is one role which has not started yet, return it.
841: #
842: # If there is more than one expired role, choose the one which ended last.
843: # If there is a role which has expired, return it.
844: #
845: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
846: &homeserver($unam,$udom)))) {
847: my ($key,$value)=split(/\=/,$_);
848: $key=&unescape($key);
849: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
850: my $section=$1;
851: if ($key eq $courseid.'_st') { $section=''; }
852: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
853: my $now=time;
854: if (defined($end) && $end && ($now > $end)) {
855: $Expired{$end}=$section;
856: next;
857: }
858: if (defined($start) && $start && ($now < $start)) {
859: $Pending{$start}=$section;
860: next;
861: }
862: return &do_cache_new('getsection',$hashid,$section,$cachetime);
863: }
864: #
865: # Presumedly there will be few matching roles from the above
866: # loop and the sorting time will be negligible.
867: if (scalar(keys(%Pending))) {
868: my ($time) = sort {$a <=> $b} keys(%Pending);
869: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
870: }
871: if (scalar(keys(%Expired))) {
872: my @sorted = sort {$a <=> $b} keys(%Expired);
873: my $time = pop(@sorted);
874: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
875: }
876: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
877: }
878:
879: sub save_cache {
880: &purge_remembered();
881: #&Apache::loncommon::validate_page();
882: undef(%env);
883: }
884:
885: my $to_remember=-1;
886: my %remembered;
887: my %accessed;
888: my $kicks=0;
889: my $hits=0;
890: sub devalidate_cache_new {
891: my ($name,$id,$debug) = @_;
892: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
893: $id=&escape($name.':'.$id);
894: $memcache->delete($id);
895: delete($remembered{$id});
896: delete($accessed{$id});
897: }
898:
899: sub is_cached_new {
900: my ($name,$id,$debug) = @_;
901: $id=&escape($name.':'.$id);
902: if (exists($remembered{$id})) {
903: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
904: $accessed{$id}=[&gettimeofday()];
905: $hits++;
906: return ($remembered{$id},1);
907: }
908: my $value = $memcache->get($id);
909: if (!(defined($value))) {
910: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
911: return (undef,undef);
912: }
913: if ($value eq '__undef__') {
914: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
915: $value=undef;
916: }
917: &make_room($id,$value,$debug);
918: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
919: return ($value,1);
920: }
921:
922: sub do_cache_new {
923: my ($name,$id,$value,$time,$debug) = @_;
924: $id=&escape($name.':'.$id);
925: my $setvalue=$value;
926: if (!defined($setvalue)) {
927: $setvalue='__undef__';
928: }
929: if (!defined($time) ) {
930: $time=600;
931: }
932: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
933: $memcache->set($id,$setvalue,$time);
934: # need to make a copy of $value
935: #&make_room($id,$value,$debug);
936: return $value;
937: }
938:
939: sub make_room {
940: my ($id,$value,$debug)=@_;
941: $remembered{$id}=$value;
942: if ($to_remember<0) { return; }
943: $accessed{$id}=[&gettimeofday()];
944: if (scalar(keys(%remembered)) <= $to_remember) { return; }
945: my $to_kick;
946: my $max_time=0;
947: foreach my $other (keys(%accessed)) {
948: if (&tv_interval($accessed{$other}) > $max_time) {
949: $to_kick=$other;
950: $max_time=&tv_interval($accessed{$other});
951: }
952: }
953: delete($remembered{$to_kick});
954: delete($accessed{$to_kick});
955: $kicks++;
956: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
957: return;
958: }
959:
960: sub purge_remembered {
961: #&logthis("Tossing ".scalar(keys(%remembered)));
962: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
963: undef(%remembered);
964: undef(%accessed);
965: }
966: # ------------------------------------- Read an entry from a user's environment
967:
968: sub userenvironment {
969: my ($udom,$unam,@what)=@_;
970: my %returnhash=();
971: my @answer=split(/\&/,
972: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
973: &homeserver($unam,$udom)));
974: my $i;
975: for ($i=0;$i<=$#what;$i++) {
976: $returnhash{$what[$i]}=&unescape($answer[$i]);
977: }
978: return %returnhash;
979: }
980:
981: # ---------------------------------------------------------- Get a studentphoto
982: sub studentphoto {
983: my ($udom,$unam,$ext) = @_;
984: my $home=&Apache::lonnet::homeserver($unam,$udom);
985: if (defined($env{'request.course.id'})) {
986: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
987: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
988: return(&retrievestudentphoto($udom,$unam,$ext));
989: } else {
990: my ($result,$perm_reqd)=
991: &Apache::lonnet::auto_photo_permission($unam,$udom);
992: if ($result eq 'ok') {
993: if (!($perm_reqd eq 'yes')) {
994: return(&retrievestudentphoto($udom,$unam,$ext));
995: }
996: }
997: }
998: }
999: } else {
1000: my ($result,$perm_reqd) =
1001: &Apache::lonnet::auto_photo_permission($unam,$udom);
1002: if ($result eq 'ok') {
1003: if (!($perm_reqd eq 'yes')) {
1004: return(&retrievestudentphoto($udom,$unam,$ext));
1005: }
1006: }
1007: }
1008: return '/adm/lonKaputt/lonlogo_broken.gif';
1009: }
1010:
1011: sub retrievestudentphoto {
1012: my ($udom,$unam,$ext,$type) = @_;
1013: my $home=&Apache::lonnet::homeserver($unam,$udom);
1014: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1015: if ($ret eq 'ok') {
1016: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1017: if ($type eq 'thumbnail') {
1018: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1019: }
1020: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1021: return $tokenurl;
1022: } else {
1023: if ($type eq 'thumbnail') {
1024: return '/adm/lonKaputt/genericstudent_tn.gif';
1025: } else {
1026: return '/adm/lonKaputt/lonlogo_broken.gif';
1027: }
1028: }
1029: }
1030:
1031: # -------------------------------------------------------------------- New chat
1032:
1033: sub chatsend {
1034: my ($newentry,$anon,$group)=@_;
1035: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1036: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1037: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1038: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1039: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1040: &escape($newentry)).':'.$group,$chome);
1041: }
1042:
1043: # ------------------------------------------ Find current version of a resource
1044:
1045: sub getversion {
1046: my $fname=&clutter(shift);
1047: unless ($fname=~/^\/res\//) { return -1; }
1048: return ¤tversion(&filelocation('',$fname));
1049: }
1050:
1051: sub currentversion {
1052: my $fname=shift;
1053: my ($result,$cached)=&is_cached_new('resversion',$fname);
1054: if (defined($cached)) { return $result; }
1055: my $author=$fname;
1056: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1057: my ($udom,$uname)=split(/\//,$author);
1058: my $home=homeserver($uname,$udom);
1059: if ($home eq 'no_host') {
1060: return -1;
1061: }
1062: my $answer=reply("currentversion:$fname",$home);
1063: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1064: return -1;
1065: }
1066: return &do_cache_new('resversion',$fname,$answer,600);
1067: }
1068:
1069: # ----------------------------- Subscribe to a resource, return URL if possible
1070:
1071: sub subscribe {
1072: my $fname=shift;
1073: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1074: $fname=~s/[\n\r]//g;
1075: my $author=$fname;
1076: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1077: my ($udom,$uname)=split(/\//,$author);
1078: my $home=homeserver($uname,$udom);
1079: if ($home eq 'no_host') {
1080: return 'not_found';
1081: }
1082: my $answer=reply("sub:$fname",$home);
1083: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1084: $answer.=' by '.$home;
1085: }
1086: return $answer;
1087: }
1088:
1089: # -------------------------------------------------------------- Replicate file
1090:
1091: sub repcopy {
1092: my $filename=shift;
1093: $filename=~s/\/+/\//g;
1094: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1095: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1096: if ($filename=~m|^/home/httpd/html/userfiles/| or
1097: $filename=~m -^/*(uploaded|editupload)/-) {
1098: return &repcopy_userfile($filename);
1099: }
1100: $filename=~s/[\n\r]//g;
1101: my $transname="$filename.in.transfer";
1102: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1103: my $remoteurl=subscribe($filename);
1104: if ($remoteurl =~ /^con_lost by/) {
1105: &logthis("Subscribe returned $remoteurl: $filename");
1106: return 'unavailable';
1107: } elsif ($remoteurl eq 'not_found') {
1108: #&logthis("Subscribe returned not_found: $filename");
1109: return 'not_found';
1110: } elsif ($remoteurl =~ /^rejected by/) {
1111: &logthis("Subscribe returned $remoteurl: $filename");
1112: return 'forbidden';
1113: } elsif ($remoteurl eq 'directory') {
1114: return 'ok';
1115: } else {
1116: my $author=$filename;
1117: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1118: my ($udom,$uname)=split(/\//,$author);
1119: my $home=homeserver($uname,$udom);
1120: unless ($home eq $perlvar{'lonHostID'}) {
1121: my @parts=split(/\//,$filename);
1122: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1123: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1124: &logthis("Malconfiguration for replication: $filename");
1125: return 'bad_request';
1126: }
1127: my $count;
1128: for ($count=5;$count<$#parts;$count++) {
1129: $path.="/$parts[$count]";
1130: if ((-e $path)!=1) {
1131: mkdir($path,0777);
1132: }
1133: }
1134: my $ua=new LWP::UserAgent;
1135: my $request=new HTTP::Request('GET',"$remoteurl");
1136: my $response=$ua->request($request,$transname);
1137: if ($response->is_error()) {
1138: unlink($transname);
1139: my $message=$response->status_line;
1140: &logthis("<font color=\"blue\">WARNING:"
1141: ." LWP get: $message: $filename</font>");
1142: return 'unavailable';
1143: } else {
1144: if ($remoteurl!~/\.meta$/) {
1145: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1146: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1147: if ($mresponse->is_error()) {
1148: unlink($filename.'.meta');
1149: &logthis(
1150: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1151: }
1152: }
1153: rename($transname,$filename);
1154: return 'ok';
1155: }
1156: }
1157: }
1158: }
1159:
1160: # ------------------------------------------------ Get server side include body
1161: sub ssi_body {
1162: my ($filelink,%form)=@_;
1163: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1164: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1165: }
1166: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1167: &ssi($filelink,%form));
1168: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1169: $output=~s/^.*?\<body[^\>]*\>//si;
1170: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1171: return $output;
1172: }
1173:
1174: # --------------------------------------------------------- Server Side Include
1175:
1176: sub ssi {
1177:
1178: my ($fn,%form)=@_;
1179:
1180: my $ua=new LWP::UserAgent;
1181:
1182: my $request;
1183:
1184: $form{'no_update_last_known'}=1;
1185:
1186: if (%form) {
1187: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1188: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1189: } else {
1190: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1191: }
1192:
1193: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1194: my $response=$ua->request($request);
1195:
1196: return $response->content;
1197: }
1198:
1199: sub externalssi {
1200: my ($url)=@_;
1201: my $ua=new LWP::UserAgent;
1202: my $request=new HTTP::Request('GET',$url);
1203: my $response=$ua->request($request);
1204: return $response->content;
1205: }
1206:
1207: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1208:
1209: sub allowuploaded {
1210: my ($srcurl,$url)=@_;
1211: $url=&clutter(&declutter($url));
1212: my $dir=$url;
1213: $dir=~s/\/[^\/]+$//;
1214: my %httpref=();
1215: my $httpurl=&hreflocation('',$url);
1216: $httpref{'httpref.'.$httpurl}=$srcurl;
1217: &Apache::lonnet::appenv(%httpref);
1218: }
1219:
1220: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1221: # input: action, courseID, current domain, intended
1222: # path to file, source of file, instruction to parse file for objects,
1223: # ref to hash for embedded objects,
1224: # ref to hash for codebase of java objects.
1225: #
1226: # output: url to file (if action was uploaddoc),
1227: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1228: #
1229: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1230: # course.
1231: #
1232: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1233: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1234: # course's home server.
1235: #
1236: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1237: # be copied from $source (current location) to
1238: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1239: # and will then be copied to
1240: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1241: # course's home server.
1242: #
1243: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1244: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1245: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1246: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1247: # in course's home server.
1248: #
1249:
1250: sub process_coursefile {
1251: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1252: my $fetchresult;
1253: my $home=&homeserver($docuname,$docudom);
1254: if ($action eq 'propagate') {
1255: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1256: $home);
1257: } else {
1258: my $fpath = '';
1259: my $fname = $file;
1260: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1261: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1262: my $filepath = &build_filepath($fpath);
1263: if ($action eq 'copy') {
1264: if ($source eq '') {
1265: $fetchresult = 'no source file';
1266: return $fetchresult;
1267: } else {
1268: my $destination = $filepath.'/'.$fname;
1269: rename($source,$destination);
1270: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1271: $home);
1272: }
1273: } elsif ($action eq 'uploaddoc') {
1274: open(my $fh,'>'.$filepath.'/'.$fname);
1275: print $fh $env{'form.'.$source};
1276: close($fh);
1277: if ($parser eq 'parse') {
1278: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1279: unless ($parse_result eq 'ok') {
1280: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1281: }
1282: }
1283: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1284: $home);
1285: if ($fetchresult eq 'ok') {
1286: return '/uploaded/'.$fpath.'/'.$fname;
1287: } else {
1288: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1289: ' to host '.$home.': '.$fetchresult);
1290: return '/adm/notfound.html';
1291: }
1292: }
1293: }
1294: unless ( $fetchresult eq 'ok') {
1295: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1296: ' to host '.$home.': '.$fetchresult);
1297: }
1298: return $fetchresult;
1299: }
1300:
1301: sub build_filepath {
1302: my ($fpath) = @_;
1303: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1304: unless ($fpath eq '') {
1305: my @parts=split('/',$fpath);
1306: foreach my $part (@parts) {
1307: $filepath.= '/'.$part;
1308: if ((-e $filepath)!=1) {
1309: mkdir($filepath,0777);
1310: }
1311: }
1312: }
1313: return $filepath;
1314: }
1315:
1316: sub store_edited_file {
1317: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1318: my $file = $primary_url;
1319: $file =~ s#^/uploaded/$docudom/$docuname/##;
1320: my $fpath = '';
1321: my $fname = $file;
1322: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1323: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1324: my $filepath = &build_filepath($fpath);
1325: open(my $fh,'>'.$filepath.'/'.$fname);
1326: print $fh $content;
1327: close($fh);
1328: my $home=&homeserver($docuname,$docudom);
1329: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1330: $home);
1331: if ($$fetchresult eq 'ok') {
1332: return '/uploaded/'.$fpath.'/'.$fname;
1333: } else {
1334: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1335: ' to host '.$home.': '.$$fetchresult);
1336: return '/adm/notfound.html';
1337: }
1338: }
1339:
1340: sub clean_filename {
1341: my ($fname)=@_;
1342: # Replace Windows backslashes by forward slashes
1343: $fname=~s/\\/\//g;
1344: # Get rid of everything but the actual filename
1345: $fname=~s/^.*\/([^\/]+)$/$1/;
1346: # Replace spaces by underscores
1347: $fname=~s/\s+/\_/g;
1348: # Replace all other weird characters by nothing
1349: $fname=~s/[^\w\.\-]//g;
1350: # Replace all .\d. sequences with _\d. so they no longer look like version
1351: # numbers
1352: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1353: return $fname;
1354: }
1355:
1356: # --------------- Take an uploaded file and put it into the userfiles directory
1357: # input: $formname - the contents of the file are in $env{"form.$formname"}
1358: # the desired filenam is in $env{"form.$formname.filename"}
1359: # $coursedoc - if true up to the current course
1360: # if false
1361: # $subdir - directory in userfile to store the file into
1362: # $parser, $allfiles, $codebase - unknown
1363: #
1364: # output: url of file in userspace, or error: <message>
1365: # or /adm/notfound.html if failure to upload occurse
1366:
1367:
1368: sub userfileupload {
1369: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1370: if (!defined($subdir)) { $subdir='unknown'; }
1371: my $fname=$env{'form.'.$formname.'.filename'};
1372: $fname=&clean_filename($fname);
1373: # See if there is anything left
1374: unless ($fname) { return 'error: no uploaded file'; }
1375: chop($env{'form.'.$formname});
1376: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1377: my $now = time;
1378: my $filepath = 'tmp/helprequests/'.$now;
1379: my @parts=split(/\//,$filepath);
1380: my $fullpath = $perlvar{'lonDaemons'};
1381: for (my $i=0;$i<@parts;$i++) {
1382: $fullpath .= '/'.$parts[$i];
1383: if ((-e $fullpath)!=1) {
1384: mkdir($fullpath,0777);
1385: }
1386: }
1387: open(my $fh,'>'.$fullpath.'/'.$fname);
1388: print $fh $env{'form.'.$formname};
1389: close($fh);
1390: return $fullpath.'/'.$fname;
1391: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1392: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1393: '_'.$env{'user.domain'}.'/pending';
1394: my @parts=split(/\//,$filepath);
1395: my $fullpath = $perlvar{'lonDaemons'};
1396: for (my $i=0;$i<@parts;$i++) {
1397: $fullpath .= '/'.$parts[$i];
1398: if ((-e $fullpath)!=1) {
1399: mkdir($fullpath,0777);
1400: }
1401: }
1402: open(my $fh,'>'.$fullpath.'/'.$fname);
1403: print $fh $env{'form.'.$formname};
1404: close($fh);
1405: return $fullpath.'/'.$fname;
1406: }
1407:
1408: # Create the directory if not present
1409: $fname="$subdir/$fname";
1410: if ($coursedoc) {
1411: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1412: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1413: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1414: return &finishuserfileupload($docuname,$docudom,
1415: $formname,$fname,$parser,$allfiles,
1416: $codebase);
1417: } else {
1418: $fname=$env{'form.folder'}.'/'.$fname;
1419: return &process_coursefile('uploaddoc',$docuname,$docudom,
1420: $fname,$formname,$parser,
1421: $allfiles,$codebase);
1422: }
1423: } elsif (defined($destuname)) {
1424: my $docuname=$destuname;
1425: my $docudom=$destudom;
1426: return &finishuserfileupload($docuname,$docudom,$formname,
1427: $fname,$parser,$allfiles,$codebase);
1428:
1429: } else {
1430: my $docuname=$env{'user.name'};
1431: my $docudom=$env{'user.domain'};
1432: if (exists($env{'form.group'})) {
1433: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1434: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1435: }
1436: return &finishuserfileupload($docuname,$docudom,$formname,
1437: $fname,$parser,$allfiles,$codebase);
1438: }
1439: }
1440:
1441: sub finishuserfileupload {
1442: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1443: my $path=$docudom.'/'.$docuname.'/';
1444: my $filepath=$perlvar{'lonDocRoot'};
1445: my ($fnamepath,$file);
1446: $file=$fname;
1447: if ($fname=~m|/|) {
1448: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1449: $path.=$fnamepath.'/';
1450: }
1451: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1452: my $count;
1453: for ($count=4;$count<=$#parts;$count++) {
1454: $filepath.="/$parts[$count]";
1455: if ((-e $filepath)!=1) {
1456: mkdir($filepath,0777);
1457: }
1458: }
1459: # Save the file
1460: {
1461: if (!open(FH,'>'.$filepath.'/'.$file)) {
1462: &logthis('Failed to create '.$filepath.'/'.$file);
1463: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1464: return '/adm/notfound.html';
1465: }
1466: if (!print FH ($env{'form.'.$formname})) {
1467: &logthis('Failed to write to '.$filepath.'/'.$file);
1468: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1469: return '/adm/notfound.html';
1470: }
1471: close(FH);
1472: }
1473: if ($parser eq 'parse') {
1474: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1475: $codebase);
1476: unless ($parse_result eq 'ok') {
1477: &logthis('Failed to parse '.$filepath.$file.
1478: ' for embedded media: '.$parse_result);
1479: }
1480: }
1481: # Notify homeserver to grep it
1482: #
1483: my $docuhome=&homeserver($docuname,$docudom);
1484: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1485: if ($fetchresult eq 'ok') {
1486: #
1487: # Return the URL to it
1488: return '/uploaded/'.$path.$file;
1489: } else {
1490: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1491: ': '.$fetchresult);
1492: return '/adm/notfound.html';
1493: }
1494: }
1495:
1496: sub extract_embedded_items {
1497: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1498: my @state = ();
1499: my %javafiles = (
1500: codebase => '',
1501: code => '',
1502: archive => ''
1503: );
1504: my %mediafiles = (
1505: src => '',
1506: movie => '',
1507: );
1508: my $p;
1509: if ($content) {
1510: $p = HTML::LCParser->new($content);
1511: } else {
1512: $p = HTML::LCParser->new($filepath.'/'.$file);
1513: }
1514: while (my $t=$p->get_token()) {
1515: if ($t->[0] eq 'S') {
1516: my ($tagname, $attr) = ($t->[1],$t->[2]);
1517: push (@state, $tagname);
1518: if (lc($tagname) eq 'allow') {
1519: &add_filetype($allfiles,$attr->{'src'},'src');
1520: }
1521: if (lc($tagname) eq 'img') {
1522: &add_filetype($allfiles,$attr->{'src'},'src');
1523: }
1524: if (lc($tagname) eq 'script') {
1525: if ($attr->{'archive'} =~ /\.jar$/i) {
1526: &add_filetype($allfiles,$attr->{'archive'},'archive');
1527: } else {
1528: &add_filetype($allfiles,$attr->{'src'},'src');
1529: }
1530: }
1531: if (lc($tagname) eq 'link') {
1532: if (lc($attr->{'rel'}) eq 'stylesheet') {
1533: &add_filetype($allfiles,$attr->{'href'},'href');
1534: }
1535: }
1536: if (lc($tagname) eq 'object' ||
1537: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1538: foreach my $item (keys(%javafiles)) {
1539: $javafiles{$item} = '';
1540: }
1541: }
1542: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1543: my $name = lc($attr->{'name'});
1544: foreach my $item (keys(%javafiles)) {
1545: if ($name eq $item) {
1546: $javafiles{$item} = $attr->{'value'};
1547: last;
1548: }
1549: }
1550: foreach my $item (keys(%mediafiles)) {
1551: if ($name eq $item) {
1552: &add_filetype($allfiles, $attr->{'value'}, 'value');
1553: last;
1554: }
1555: }
1556: }
1557: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1558: foreach my $item (keys(%javafiles)) {
1559: if ($attr->{$item}) {
1560: $javafiles{$item} = $attr->{$item};
1561: last;
1562: }
1563: }
1564: foreach my $item (keys(%mediafiles)) {
1565: if ($attr->{$item}) {
1566: &add_filetype($allfiles,$attr->{$item},$item);
1567: last;
1568: }
1569: }
1570: }
1571: } elsif ($t->[0] eq 'E') {
1572: my ($tagname) = ($t->[1]);
1573: if ($javafiles{'codebase'} ne '') {
1574: $javafiles{'codebase'} .= '/';
1575: }
1576: if (lc($tagname) eq 'applet' ||
1577: lc($tagname) eq 'object' ||
1578: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1579: ) {
1580: foreach my $item (keys(%javafiles)) {
1581: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1582: my $file=$javafiles{'codebase'}.$javafiles{$item};
1583: &add_filetype($allfiles,$file,$item);
1584: }
1585: }
1586: }
1587: pop @state;
1588: }
1589: }
1590: return 'ok';
1591: }
1592:
1593: sub add_filetype {
1594: my ($allfiles,$file,$type)=@_;
1595: if (exists($allfiles->{$file})) {
1596: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1597: push(@{$allfiles->{$file}}, &escape($type));
1598: }
1599: } else {
1600: @{$allfiles->{$file}} = (&escape($type));
1601: }
1602: }
1603:
1604: sub removeuploadedurl {
1605: my ($url)=@_;
1606: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1607: return &removeuserfile($uname,$udom,$fname);
1608: }
1609:
1610: sub removeuserfile {
1611: my ($docuname,$docudom,$fname)=@_;
1612: my $home=&homeserver($docuname,$docudom);
1613: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1614: }
1615:
1616: sub mkdiruserfile {
1617: my ($docuname,$docudom,$dir)=@_;
1618: my $home=&homeserver($docuname,$docudom);
1619: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1620: }
1621:
1622: sub renameuserfile {
1623: my ($docuname,$docudom,$old,$new)=@_;
1624: my $home=&homeserver($docuname,$docudom);
1625: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1626: &escape("$new"),$home);
1627: }
1628:
1629: # ------------------------------------------------------------------------- Log
1630:
1631: sub log {
1632: my ($dom,$nam,$hom,$what)=@_;
1633: return critical("log:$dom:$nam:$what",$hom);
1634: }
1635:
1636: # ------------------------------------------------------------------ Course Log
1637: #
1638: # This routine flushes several buffers of non-mission-critical nature
1639: #
1640:
1641: sub flushcourselogs {
1642: &logthis('Flushing log buffers');
1643: #
1644: # course logs
1645: # This is a log of all transactions in a course, which can be used
1646: # for data mining purposes
1647: #
1648: # It also collects the courseid database, which lists last transaction
1649: # times and course titles for all courseids
1650: #
1651: my %courseidbuffer=();
1652: foreach (keys %courselogs) {
1653: my $crsid=$_;
1654: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1655: &escape($courselogs{$crsid}),
1656: $coursehombuf{$crsid}) eq 'ok') {
1657: delete $courselogs{$crsid};
1658: } else {
1659: &logthis('Failed to flush log buffer for '.$crsid);
1660: if (length($courselogs{$crsid})>40000) {
1661: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1662: " exceeded maximum size, deleting.</font>");
1663: delete $courselogs{$crsid};
1664: }
1665: }
1666: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1667: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1668: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1669: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1670: } else {
1671: $courseidbuffer{$coursehombuf{$crsid}}=
1672: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1673: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1674: }
1675: }
1676: #
1677: # Write course id database (reverse lookup) to homeserver of courses
1678: # Is used in pickcourse
1679: #
1680: foreach (keys %courseidbuffer) {
1681: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1682: }
1683: #
1684: # File accesses
1685: # Writes to the dynamic metadata of resources to get hit counts, etc.
1686: #
1687: foreach my $entry (keys(%accesshash)) {
1688: if ($entry =~ /___count$/) {
1689: my ($dom,$name);
1690: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1691: if (! defined($dom) || $dom eq '' ||
1692: ! defined($name) || $name eq '') {
1693: my $cid = $env{'request.course.id'};
1694: $dom = $env{'request.'.$cid.'.domain'};
1695: $name = $env{'request.'.$cid.'.num'};
1696: }
1697: my $value = $accesshash{$entry};
1698: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1699: my %temphash=($url => $value);
1700: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1701: if ($result eq 'ok') {
1702: delete $accesshash{$entry};
1703: } elsif ($result eq 'unknown_cmd') {
1704: # Target server has old code running on it.
1705: my %temphash=($entry => $value);
1706: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1707: delete $accesshash{$entry};
1708: }
1709: }
1710: } else {
1711: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1712: my %temphash=($entry => $accesshash{$entry});
1713: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1714: delete $accesshash{$entry};
1715: }
1716: }
1717: }
1718: #
1719: # Roles
1720: # Reverse lookup of user roles for course faculty/staff and co-authorship
1721: #
1722: foreach (keys %userrolehash) {
1723: my $entry=$_;
1724: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1725: split(/\:/,$entry);
1726: if (&Apache::lonnet::put('nohist_userroles',
1727: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1728: $rudom,$runame) eq 'ok') {
1729: delete $userrolehash{$entry};
1730: }
1731: }
1732: #
1733: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1734: #
1735: my %domrolebuffer = ();
1736: foreach my $entry (keys %domainrolehash) {
1737: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1738: if ($domrolebuffer{$rudom}) {
1739: $domrolebuffer{$rudom}.='&'.&escape($entry).
1740: '='.&escape($domainrolehash{$entry});
1741: } else {
1742: $domrolebuffer{$rudom}.=&escape($entry).
1743: '='.&escape($domainrolehash{$entry});
1744: }
1745: delete $domainrolehash{$entry};
1746: }
1747: foreach my $dom (keys(%domrolebuffer)) {
1748: foreach my $tryserver (keys %libserv) {
1749: if ($hostdom{$tryserver} eq $dom) {
1750: unless (&reply('domroleput:'.$dom.':'.
1751: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1752: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1753: }
1754: }
1755: }
1756: }
1757: $dumpcount++;
1758: }
1759:
1760: sub courselog {
1761: my $what=shift;
1762: $what=time.':'.$what;
1763: unless ($env{'request.course.id'}) { return ''; }
1764: $coursedombuf{$env{'request.course.id'}}=
1765: $env{'course.'.$env{'request.course.id'}.'.domain'};
1766: $coursenumbuf{$env{'request.course.id'}}=
1767: $env{'course.'.$env{'request.course.id'}.'.num'};
1768: $coursehombuf{$env{'request.course.id'}}=
1769: $env{'course.'.$env{'request.course.id'}.'.home'};
1770: $coursedescrbuf{$env{'request.course.id'}}=
1771: $env{'course.'.$env{'request.course.id'}.'.description'};
1772: $courseinstcodebuf{$env{'request.course.id'}}=
1773: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1774: $courseownerbuf{$env{'request.course.id'}}=
1775: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1776: $coursetypebuf{$env{'request.course.id'}}=
1777: $env{'course.'.$env{'request.course.id'}.'.type'};
1778: if (defined $courselogs{$env{'request.course.id'}}) {
1779: $courselogs{$env{'request.course.id'}}.='&'.$what;
1780: } else {
1781: $courselogs{$env{'request.course.id'}}.=$what;
1782: }
1783: if (length($courselogs{$env{'request.course.id'}})>4048) {
1784: &flushcourselogs();
1785: }
1786: }
1787:
1788: sub courseacclog {
1789: my $fnsymb=shift;
1790: unless ($env{'request.course.id'}) { return ''; }
1791: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1792: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1793: $what.=':POST';
1794: # FIXME: Probably ought to escape things....
1795: foreach (keys %env) {
1796: if ($_=~/^form\.(.*)/) {
1797: $what.=':'.$1.'='.$env{$_};
1798: }
1799: }
1800: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1801: # FIXME: We should not be depending on a form parameter that someone
1802: # editing lonsearchcat.pm might change in the future.
1803: if ($env{'form.phase'} eq 'course_search') {
1804: $what.= ':POST';
1805: # FIXME: Probably ought to escape things....
1806: foreach my $element ('courseexp','crsfulltext','crsrelated',
1807: 'crsdiscuss') {
1808: $what.=':'.$element.'='.$env{'form.'.$element};
1809: }
1810: }
1811: }
1812: &courselog($what);
1813: }
1814:
1815: sub countacc {
1816: my $url=&declutter(shift);
1817: return if (! defined($url) || $url eq '');
1818: unless ($env{'request.course.id'}) { return ''; }
1819: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1820: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1821: $accesshash{$key}++;
1822: }
1823:
1824: sub linklog {
1825: my ($from,$to)=@_;
1826: $from=&declutter($from);
1827: $to=&declutter($to);
1828: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1829: $accesshash{$to.'___'.$from.'___goto'}=1;
1830: }
1831:
1832: sub userrolelog {
1833: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1834: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1835: ($trole=~/^in/) || ($trole=~/^cc/) ||
1836: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1837: ($trole=~/^ta/)) {
1838: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1839: $userrolehash
1840: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1841: =$tend.':'.$tstart;
1842: }
1843: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1844: ($trole=~/^li/) || ($trole=~/^li/) ||
1845: ($trole=~/^au/) || ($trole=~/^dg/) ||
1846: ($trole=~/^sc/)) {
1847: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1848: $domainrolehash
1849: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1850: = $tend.':'.$tstart;
1851: }
1852: }
1853:
1854: sub get_course_adv_roles {
1855: my $cid=shift;
1856: $cid=$env{'request.course.id'} unless (defined($cid));
1857: my %coursehash=&coursedescription($cid);
1858: my %nothide=();
1859: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1860: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1861: }
1862: my %returnhash=();
1863: my %dumphash=
1864: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1865: my $now=time;
1866: foreach (keys %dumphash) {
1867: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1868: if (($tstart) && ($tstart<0)) { next; }
1869: if (($tend) && ($tend<$now)) { next; }
1870: if (($tstart) && ($now<$tstart)) { next; }
1871: my ($role,$username,$domain,$section)=split(/\:/,$_);
1872: if ($username eq '' || $domain eq '') { next; }
1873: if ((&privileged($username,$domain)) &&
1874: (!$nothide{$username.':'.$domain})) { next; }
1875: if ($role eq 'cr') { next; }
1876: my $key=&plaintext($role);
1877: if ($role =~ /^cr/) {
1878: $key=(split('/',$role))[3];
1879: }
1880: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1881: if ($returnhash{$key}) {
1882: $returnhash{$key}.=','.$username.':'.$domain;
1883: } else {
1884: $returnhash{$key}=$username.':'.$domain;
1885: }
1886: }
1887: return %returnhash;
1888: }
1889:
1890: sub get_my_roles {
1891: my ($uname,$udom)=@_;
1892: unless (defined($uname)) { $uname=$env{'user.name'}; }
1893: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1894: my %dumphash=
1895: &dump('nohist_userroles',$udom,$uname);
1896: my %returnhash=();
1897: my $now=time;
1898: foreach (keys %dumphash) {
1899: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1900: if (($tstart) && ($tstart<0)) { next; }
1901: if (($tend) && ($tend<$now)) { next; }
1902: if (($tstart) && ($now<$tstart)) { next; }
1903: my ($role,$username,$domain,$section)=split(/\:/,$_);
1904: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1905: }
1906: return %returnhash;
1907: }
1908:
1909: # ----------------------------------------------------- Frontpage Announcements
1910: #
1911: #
1912:
1913: sub postannounce {
1914: my ($server,$text)=@_;
1915: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1916: unless ($text=~/\w/) { $text=''; }
1917: return &reply('setannounce:'.&escape($text),$server);
1918: }
1919:
1920: sub getannounce {
1921:
1922: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1923: my $announcement='';
1924: while (<$fh>) { $announcement .=$_; }
1925: close($fh);
1926: if ($announcement=~/\w/) {
1927: return
1928: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1929: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1930: } else {
1931: return '';
1932: }
1933: } else {
1934: return '';
1935: }
1936: }
1937:
1938: # ---------------------------------------------------------- Course ID routines
1939: # Deal with domain's nohist_courseid.db files
1940: #
1941:
1942: sub courseidput {
1943: my ($domain,$what,$coursehome)=@_;
1944: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1945: }
1946:
1947: sub courseiddump {
1948: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1949: my %returnhash=();
1950: unless ($domfilter) { $domfilter=''; }
1951: foreach my $tryserver (keys %libserv) {
1952: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1953: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1954: foreach (
1955: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1956: $sincefilter.':'.&escape($descfilter).':'.
1957: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1958: $tryserver))) {
1959: my ($key,$value)=split(/\=/,$_);
1960: if (($key) && ($value)) {
1961: $returnhash{&unescape($key)}=$value;
1962: }
1963: }
1964: }
1965: }
1966: }
1967: return %returnhash;
1968: }
1969:
1970: # ---------------------------------------------------------- DC e-mail
1971:
1972: sub dcmailput {
1973: my ($domain,$msgid,$message,$server)=@_;
1974: my $status = &Apache::lonnet::critical(
1975: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1976: &escape($message),$server);
1977: return $status;
1978: }
1979:
1980: sub dcmaildump {
1981: my ($dom,$startdate,$enddate,$senders) = @_;
1982: my %returnhash=();
1983: if (exists($domain_primary{$dom})) {
1984: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1985: &escape($enddate).':';
1986: my @esc_senders=map { &escape($_)} @$senders;
1987: $cmd.=&escape(join('&',@esc_senders));
1988: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
1989: my ($key,$value) = split(/\=/,$_);
1990: if (($key) && ($value)) {
1991: $returnhash{&unescape($key)} = &unescape($value);
1992: }
1993: }
1994: }
1995: return %returnhash;
1996: }
1997: # ---------------------------------------------------------- Domain roles
1998:
1999: sub get_domain_roles {
2000: my ($dom,$roles,$startdate,$enddate)=@_;
2001: if (undef($startdate) || $startdate eq '') {
2002: $startdate = '.';
2003: }
2004: if (undef($enddate) || $enddate eq '') {
2005: $enddate = '.';
2006: }
2007: my $rolelist = join(':',@{$roles});
2008: my %personnel = ();
2009: foreach my $tryserver (keys(%libserv)) {
2010: if ($hostdom{$tryserver} eq $dom) {
2011: %{$personnel{$tryserver}}=();
2012: foreach (
2013: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2014: &escape($startdate).':'.&escape($enddate).':'.
2015: &escape($rolelist), $tryserver))) {
2016: my($key,$value) = split(/\=/,$_);
2017: if (($key) && ($value)) {
2018: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2019: }
2020: }
2021: }
2022: }
2023: return %personnel;
2024: }
2025:
2026: # ----------------------------------------------------------- Check out an item
2027:
2028: sub get_first_access {
2029: my ($type,$argsymb)=@_;
2030: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2031: if ($argsymb) { $symb=$argsymb; }
2032: my ($map,$id,$res)=&decode_symb($symb);
2033: if ($type eq 'map') {
2034: $res=&symbread($map);
2035: } else {
2036: $res=$symb;
2037: }
2038: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2039: return $times{"$courseid\0$res"};
2040: }
2041:
2042: sub set_first_access {
2043: my ($type)=@_;
2044: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2045: my ($map,$id,$res)=&decode_symb($symb);
2046: if ($type eq 'map') {
2047: $res=&symbread($map);
2048: } else {
2049: $res=$symb;
2050: }
2051: my $firstaccess=&get_first_access($type,$symb);
2052: if (!$firstaccess) {
2053: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2054: }
2055: return 'already_set';
2056: }
2057:
2058: sub checkout {
2059: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2060: my $now=time;
2061: my $lonhost=$perlvar{'lonHostID'};
2062: my $infostr=&escape(
2063: 'CHECKOUTTOKEN&'.
2064: $tuname.'&'.
2065: $tudom.'&'.
2066: $tcrsid.'&'.
2067: $symb.'&'.
2068: $now.'&'.$ENV{'REMOTE_ADDR'});
2069: my $token=&reply('tmpput:'.$infostr,$lonhost);
2070: if ($token=~/^error\:/) {
2071: &logthis("<font color=\"blue\">WARNING: ".
2072: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2073: "</font>");
2074: return '';
2075: }
2076:
2077: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2078: $token=~tr/a-z/A-Z/;
2079:
2080: my %infohash=('resource.0.outtoken' => $token,
2081: 'resource.0.checkouttime' => $now,
2082: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2083:
2084: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2085: return '';
2086: } else {
2087: &logthis("<font color=\"blue\">WARNING: ".
2088: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2089: "</font>");
2090: }
2091:
2092: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2093: &escape('Checkout '.$infostr.' - '.
2094: $token)) ne 'ok') {
2095: return '';
2096: } else {
2097: &logthis("<font color=\"blue\">WARNING: ".
2098: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2099: "</font>");
2100: }
2101: return $token;
2102: }
2103:
2104: # ------------------------------------------------------------ Check in an item
2105:
2106: sub checkin {
2107: my $token=shift;
2108: my $now=time;
2109: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2110: $lonhost=~tr/A-Z/a-z/;
2111: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2112: $dtoken=~s/\W/\_/g;
2113: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2114: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2115:
2116: unless (($tuname) && ($tudom)) {
2117: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2118: return '';
2119: }
2120:
2121: unless (&allowed('mgr',$tcrsid)) {
2122: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2123: $env{'user.name'}.' - '.$env{'user.domain'});
2124: return '';
2125: }
2126:
2127: my %infohash=('resource.0.intoken' => $token,
2128: 'resource.0.checkintime' => $now,
2129: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2130:
2131: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2132: return '';
2133: }
2134:
2135: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2136: &escape('Checkin - '.$token)) ne 'ok') {
2137: return '';
2138: }
2139:
2140: return ($symb,$tuname,$tudom,$tcrsid);
2141: }
2142:
2143: # --------------------------------------------- Set Expire Date for Spreadsheet
2144:
2145: sub expirespread {
2146: my ($uname,$udom,$stype,$usymb)=@_;
2147: my $cid=$env{'request.course.id'};
2148: if ($cid) {
2149: my $now=time;
2150: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2151: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2152: $env{'course.'.$cid.'.num'}.
2153: ':nohist_expirationdates:'.
2154: &escape($key).'='.$now,
2155: $env{'course.'.$cid.'.home'})
2156: }
2157: return 'ok';
2158: }
2159:
2160: # ----------------------------------------------------- Devalidate Spreadsheets
2161:
2162: sub devalidate {
2163: my ($symb,$uname,$udom)=@_;
2164: my $cid=$env{'request.course.id'};
2165: if ($cid) {
2166: # delete the stored spreadsheets for
2167: # - the student level sheet of this user in course's homespace
2168: # - the assessment level sheet for this resource
2169: # for this user in user's homespace
2170: # - current conditional state info
2171: my $key=$uname.':'.$udom.':';
2172: my $status=
2173: &del('nohist_calculatedsheets',
2174: [$key.'studentcalc:'],
2175: $env{'course.'.$cid.'.domain'},
2176: $env{'course.'.$cid.'.num'})
2177: .' '.
2178: &del('nohist_calculatedsheets_'.$cid,
2179: [$key.'assesscalc:'.$symb],$udom,$uname);
2180: unless ($status eq 'ok ok') {
2181: &logthis('Could not devalidate spreadsheet '.
2182: $uname.' at '.$udom.' for '.
2183: $symb.': '.$status);
2184: }
2185: &delenv('user.state.'.$cid);
2186: }
2187: }
2188:
2189: sub get_scalar {
2190: my ($string,$end) = @_;
2191: my $value;
2192: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2193: $value = $1;
2194: } elsif ($$string =~ s/^([^&]*?)&//) {
2195: $value = $1;
2196: }
2197: return &unescape($value);
2198: }
2199:
2200: sub array2str {
2201: my (@array) = @_;
2202: my $result=&arrayref2str(\@array);
2203: $result=~s/^__ARRAY_REF__//;
2204: $result=~s/__END_ARRAY_REF__$//;
2205: return $result;
2206: }
2207:
2208: sub arrayref2str {
2209: my ($arrayref) = @_;
2210: my $result='__ARRAY_REF__';
2211: foreach my $elem (@$arrayref) {
2212: if(ref($elem) eq 'ARRAY') {
2213: $result.=&arrayref2str($elem).'&';
2214: } elsif(ref($elem) eq 'HASH') {
2215: $result.=&hashref2str($elem).'&';
2216: } elsif(ref($elem)) {
2217: #print("Got a ref of ".(ref($elem))." skipping.");
2218: } else {
2219: $result.=&escape($elem).'&';
2220: }
2221: }
2222: $result=~s/\&$//;
2223: $result .= '__END_ARRAY_REF__';
2224: return $result;
2225: }
2226:
2227: sub hash2str {
2228: my (%hash) = @_;
2229: my $result=&hashref2str(\%hash);
2230: $result=~s/^__HASH_REF__//;
2231: $result=~s/__END_HASH_REF__$//;
2232: return $result;
2233: }
2234:
2235: sub hashref2str {
2236: my ($hashref)=@_;
2237: my $result='__HASH_REF__';
2238: foreach (sort(keys(%$hashref))) {
2239: if (ref($_) eq 'ARRAY') {
2240: $result.=&arrayref2str($_).'=';
2241: } elsif (ref($_) eq 'HASH') {
2242: $result.=&hashref2str($_).'=';
2243: } elsif (ref($_)) {
2244: $result.='=';
2245: #print("Got a ref of ".(ref($_))." skipping.");
2246: } else {
2247: if ($_) {$result.=&escape($_).'=';} else { last; }
2248: }
2249:
2250: if(ref($hashref->{$_}) eq 'ARRAY') {
2251: $result.=&arrayref2str($hashref->{$_}).'&';
2252: } elsif(ref($hashref->{$_}) eq 'HASH') {
2253: $result.=&hashref2str($hashref->{$_}).'&';
2254: } elsif(ref($hashref->{$_})) {
2255: $result.='&';
2256: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2257: } else {
2258: $result.=&escape($hashref->{$_}).'&';
2259: }
2260: }
2261: $result=~s/\&$//;
2262: $result .= '__END_HASH_REF__';
2263: return $result;
2264: }
2265:
2266: sub str2hash {
2267: my ($string)=@_;
2268: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2269: return %$hash;
2270: }
2271:
2272: sub str2hashref {
2273: my ($string) = @_;
2274:
2275: my %hash;
2276:
2277: if($string !~ /^__HASH_REF__/) {
2278: if (! ($string eq '' || !defined($string))) {
2279: $hash{'error'}='Not hash reference';
2280: }
2281: return (\%hash, $string);
2282: }
2283:
2284: $string =~ s/^__HASH_REF__//;
2285:
2286: while($string !~ /^__END_HASH_REF__/) {
2287: #key
2288: my $key='';
2289: if($string =~ /^__HASH_REF__/) {
2290: ($key, $string)=&str2hashref($string);
2291: if(defined($key->{'error'})) {
2292: $hash{'error'}='Bad data';
2293: return (\%hash, $string);
2294: }
2295: } elsif($string =~ /^__ARRAY_REF__/) {
2296: ($key, $string)=&str2arrayref($string);
2297: if($key->[0] eq 'Array reference error') {
2298: $hash{'error'}='Bad data';
2299: return (\%hash, $string);
2300: }
2301: } else {
2302: $string =~ s/^(.*?)=//;
2303: $key=&unescape($1);
2304: }
2305: $string =~ s/^=//;
2306:
2307: #value
2308: my $value='';
2309: if($string =~ /^__HASH_REF__/) {
2310: ($value, $string)=&str2hashref($string);
2311: if(defined($value->{'error'})) {
2312: $hash{'error'}='Bad data';
2313: return (\%hash, $string);
2314: }
2315: } elsif($string =~ /^__ARRAY_REF__/) {
2316: ($value, $string)=&str2arrayref($string);
2317: if($value->[0] eq 'Array reference error') {
2318: $hash{'error'}='Bad data';
2319: return (\%hash, $string);
2320: }
2321: } else {
2322: $value=&get_scalar(\$string,'__END_HASH_REF__');
2323: }
2324: $string =~ s/^&//;
2325:
2326: $hash{$key}=$value;
2327: }
2328:
2329: $string =~ s/^__END_HASH_REF__//;
2330:
2331: return (\%hash, $string);
2332: }
2333:
2334: sub str2array {
2335: my ($string)=@_;
2336: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2337: return @$array;
2338: }
2339:
2340: sub str2arrayref {
2341: my ($string) = @_;
2342: my @array;
2343:
2344: if($string !~ /^__ARRAY_REF__/) {
2345: if (! ($string eq '' || !defined($string))) {
2346: $array[0]='Array reference error';
2347: }
2348: return (\@array, $string);
2349: }
2350:
2351: $string =~ s/^__ARRAY_REF__//;
2352:
2353: while($string !~ /^__END_ARRAY_REF__/) {
2354: my $value='';
2355: if($string =~ /^__HASH_REF__/) {
2356: ($value, $string)=&str2hashref($string);
2357: if(defined($value->{'error'})) {
2358: $array[0] ='Array reference error';
2359: return (\@array, $string);
2360: }
2361: } elsif($string =~ /^__ARRAY_REF__/) {
2362: ($value, $string)=&str2arrayref($string);
2363: if($value->[0] eq 'Array reference error') {
2364: $array[0] ='Array reference error';
2365: return (\@array, $string);
2366: }
2367: } else {
2368: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2369: }
2370: $string =~ s/^&//;
2371:
2372: push(@array, $value);
2373: }
2374:
2375: $string =~ s/^__END_ARRAY_REF__//;
2376:
2377: return (\@array, $string);
2378: }
2379:
2380: # -------------------------------------------------------------------Temp Store
2381:
2382: sub tmpreset {
2383: my ($symb,$namespace,$domain,$stuname) = @_;
2384: if (!$symb) {
2385: $symb=&symbread();
2386: if (!$symb) { $symb= $env{'request.url'}; }
2387: }
2388: $symb=escape($symb);
2389:
2390: if (!$namespace) { $namespace=$env{'request.state'}; }
2391: $namespace=~s/\//\_/g;
2392: $namespace=~s/\W//g;
2393:
2394: if (!$domain) { $domain=$env{'user.domain'}; }
2395: if (!$stuname) { $stuname=$env{'user.name'}; }
2396: if ($domain eq 'public' && $stuname eq 'public') {
2397: $stuname=$ENV{'REMOTE_ADDR'};
2398: }
2399: my $path=$perlvar{'lonDaemons'}.'/tmp';
2400: my %hash;
2401: if (tie(%hash,'GDBM_File',
2402: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2403: &GDBM_WRCREAT(),0640)) {
2404: foreach my $key (keys %hash) {
2405: if ($key=~ /:$symb/) {
2406: delete($hash{$key});
2407: }
2408: }
2409: }
2410: }
2411:
2412: sub tmpstore {
2413: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2414:
2415: if (!$symb) {
2416: $symb=&symbread();
2417: if (!$symb) { $symb= $env{'request.url'}; }
2418: }
2419: $symb=escape($symb);
2420:
2421: if (!$namespace) {
2422: # I don't think we would ever want to store this for a course.
2423: # it seems this will only be used if we don't have a course.
2424: #$namespace=$env{'request.course.id'};
2425: #if (!$namespace) {
2426: $namespace=$env{'request.state'};
2427: #}
2428: }
2429: $namespace=~s/\//\_/g;
2430: $namespace=~s/\W//g;
2431: if (!$domain) { $domain=$env{'user.domain'}; }
2432: if (!$stuname) { $stuname=$env{'user.name'}; }
2433: if ($domain eq 'public' && $stuname eq 'public') {
2434: $stuname=$ENV{'REMOTE_ADDR'};
2435: }
2436: my $now=time;
2437: my %hash;
2438: my $path=$perlvar{'lonDaemons'}.'/tmp';
2439: if (tie(%hash,'GDBM_File',
2440: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2441: &GDBM_WRCREAT(),0640)) {
2442: $hash{"version:$symb"}++;
2443: my $version=$hash{"version:$symb"};
2444: my $allkeys='';
2445: foreach my $key (keys(%$storehash)) {
2446: $allkeys.=$key.':';
2447: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2448: }
2449: $hash{"$version:$symb:timestamp"}=$now;
2450: $allkeys.='timestamp';
2451: $hash{"$version:keys:$symb"}=$allkeys;
2452: if (untie(%hash)) {
2453: return 'ok';
2454: } else {
2455: return "error:$!";
2456: }
2457: } else {
2458: return "error:$!";
2459: }
2460: }
2461:
2462: # -----------------------------------------------------------------Temp Restore
2463:
2464: sub tmprestore {
2465: my ($symb,$namespace,$domain,$stuname) = @_;
2466:
2467: if (!$symb) {
2468: $symb=&symbread();
2469: if (!$symb) { $symb= $env{'request.url'}; }
2470: }
2471: $symb=escape($symb);
2472:
2473: if (!$namespace) { $namespace=$env{'request.state'}; }
2474:
2475: if (!$domain) { $domain=$env{'user.domain'}; }
2476: if (!$stuname) { $stuname=$env{'user.name'}; }
2477: if ($domain eq 'public' && $stuname eq 'public') {
2478: $stuname=$ENV{'REMOTE_ADDR'};
2479: }
2480: my %returnhash;
2481: $namespace=~s/\//\_/g;
2482: $namespace=~s/\W//g;
2483: my %hash;
2484: my $path=$perlvar{'lonDaemons'}.'/tmp';
2485: if (tie(%hash,'GDBM_File',
2486: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2487: &GDBM_READER(),0640)) {
2488: my $version=$hash{"version:$symb"};
2489: $returnhash{'version'}=$version;
2490: my $scope;
2491: for ($scope=1;$scope<=$version;$scope++) {
2492: my $vkeys=$hash{"$scope:keys:$symb"};
2493: my @keys=split(/:/,$vkeys);
2494: my $key;
2495: $returnhash{"$scope:keys"}=$vkeys;
2496: foreach $key (@keys) {
2497: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2498: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2499: }
2500: }
2501: if (!(untie(%hash))) {
2502: return "error:$!";
2503: }
2504: } else {
2505: return "error:$!";
2506: }
2507: return %returnhash;
2508: }
2509:
2510: # ----------------------------------------------------------------------- Store
2511:
2512: sub store {
2513: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2514: my $home='';
2515:
2516: if ($stuname) { $home=&homeserver($stuname,$domain); }
2517:
2518: $symb=&symbclean($symb);
2519: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2520:
2521: if (!$domain) { $domain=$env{'user.domain'}; }
2522: if (!$stuname) { $stuname=$env{'user.name'}; }
2523:
2524: &devalidate($symb,$stuname,$domain);
2525:
2526: $symb=escape($symb);
2527: if (!$namespace) {
2528: unless ($namespace=$env{'request.course.id'}) {
2529: return '';
2530: }
2531: }
2532: if (!$home) { $home=$env{'user.home'}; }
2533:
2534: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2535: $$storehash{'host'}=$perlvar{'lonHostID'};
2536:
2537: my $namevalue='';
2538: foreach (keys %$storehash) {
2539: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2540: }
2541: $namevalue=~s/\&$//;
2542: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2543: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2544: }
2545:
2546: # -------------------------------------------------------------- Critical Store
2547:
2548: sub cstore {
2549: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2550: my $home='';
2551:
2552: if ($stuname) { $home=&homeserver($stuname,$domain); }
2553:
2554: $symb=&symbclean($symb);
2555: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2556:
2557: if (!$domain) { $domain=$env{'user.domain'}; }
2558: if (!$stuname) { $stuname=$env{'user.name'}; }
2559:
2560: &devalidate($symb,$stuname,$domain);
2561:
2562: $symb=escape($symb);
2563: if (!$namespace) {
2564: unless ($namespace=$env{'request.course.id'}) {
2565: return '';
2566: }
2567: }
2568: if (!$home) { $home=$env{'user.home'}; }
2569:
2570: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2571: $$storehash{'host'}=$perlvar{'lonHostID'};
2572:
2573: my $namevalue='';
2574: foreach (keys %$storehash) {
2575: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2576: }
2577: $namevalue=~s/\&$//;
2578: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2579: return critical
2580: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2581: }
2582:
2583: # --------------------------------------------------------------------- Restore
2584:
2585: sub restore {
2586: my ($symb,$namespace,$domain,$stuname) = @_;
2587: my $home='';
2588:
2589: if ($stuname) { $home=&homeserver($stuname,$domain); }
2590:
2591: if (!$symb) {
2592: unless ($symb=escape(&symbread())) { return ''; }
2593: } else {
2594: $symb=&escape(&symbclean($symb));
2595: }
2596: if (!$namespace) {
2597: unless ($namespace=$env{'request.course.id'}) {
2598: return '';
2599: }
2600: }
2601: if (!$domain) { $domain=$env{'user.domain'}; }
2602: if (!$stuname) { $stuname=$env{'user.name'}; }
2603: if (!$home) { $home=$env{'user.home'}; }
2604: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2605:
2606: my %returnhash=();
2607: foreach (split(/\&/,$answer)) {
2608: my ($name,$value)=split(/\=/,$_);
2609: $returnhash{&unescape($name)}=&thaw_unescape($value);
2610: }
2611: my $version;
2612: for ($version=1;$version<=$returnhash{'version'};$version++) {
2613: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2614: $returnhash{$_}=$returnhash{$version.':'.$_};
2615: }
2616: }
2617: return %returnhash;
2618: }
2619:
2620: # ---------------------------------------------------------- Course Description
2621:
2622: sub coursedescription {
2623: my ($courseid,$args)=@_;
2624: $courseid=~s/^\///;
2625: $courseid=~s/\_/\//g;
2626: my ($cdomain,$cnum)=split(/\//,$courseid);
2627: my $chome=&homeserver($cnum,$cdomain);
2628: my $normalid=$cdomain.'_'.$cnum;
2629: # need to always cache even if we get errors otherwise we keep
2630: # trying and trying and trying to get the course description.
2631: my %envhash=();
2632: my %returnhash=();
2633:
2634: my $expiretime=600;
2635: if ($env{'request.course.id'} eq $normalid) {
2636: $expiretime=120;
2637: }
2638:
2639: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2640: if (!$args->{'freshen_cache'}
2641: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2642: foreach my $key (keys(%env)) {
2643: next if ($key !~ /^\Q$prefix\E(.*)/);
2644: my ($setting) = $1;
2645: $returnhash{$setting} = $env{$key};
2646: }
2647: return %returnhash;
2648: }
2649:
2650: # get the data agin
2651: if (!$args->{'one_time'}) {
2652: $envhash{'course.'.$normalid.'.last_cache'}=time;
2653: }
2654: if ($chome ne 'no_host') {
2655: %returnhash=&dump('environment',$cdomain,$cnum);
2656: if (!exists($returnhash{'con_lost'})) {
2657: $returnhash{'home'}= $chome;
2658: $returnhash{'domain'} = $cdomain;
2659: $returnhash{'num'} = $cnum;
2660: if (!defined($returnhash{'type'})) {
2661: $returnhash{'type'} = 'Course';
2662: }
2663: while (my ($name,$value) = each %returnhash) {
2664: $envhash{'course.'.$normalid.'.'.$name}=$value;
2665: }
2666: $returnhash{'url'}=&clutter($returnhash{'url'});
2667: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2668: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2669: $envhash{'course.'.$normalid.'.home'}=$chome;
2670: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2671: $envhash{'course.'.$normalid.'.num'}=$cnum;
2672: }
2673: }
2674: if (!$args->{'one_time'}) {
2675: &appenv(%envhash);
2676: }
2677: return %returnhash;
2678: }
2679:
2680: # -------------------------------------------------See if a user is privileged
2681:
2682: sub privileged {
2683: my ($username,$domain)=@_;
2684: my $rolesdump=&reply("dump:$domain:$username:roles",
2685: &homeserver($username,$domain));
2686: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2687: my $now=time;
2688: if ($rolesdump ne '') {
2689: foreach (split(/&/,$rolesdump)) {
2690: if ($_!~/^rolesdef_/) {
2691: my ($area,$role)=split(/=/,$_);
2692: $area=~s/\_\w\w$//;
2693: my ($trole,$tend,$tstart)=split(/_/,$role);
2694: if (($trole eq 'dc') || ($trole eq 'su')) {
2695: my $active=1;
2696: if ($tend) {
2697: if ($tend<$now) { $active=0; }
2698: }
2699: if ($tstart) {
2700: if ($tstart>$now) { $active=0; }
2701: }
2702: if ($active) { return 1; }
2703: }
2704: }
2705: }
2706: }
2707: return 0;
2708: }
2709:
2710: # -------------------------------------------------------- Get user privileges
2711:
2712: sub rolesinit {
2713: my ($domain,$username,$authhost)=@_;
2714: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2715: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2716: my %allroles=();
2717: my %allgroups=();
2718: my $now=time;
2719: my %userroles = ('user.login.time' => $now);
2720: my $group_privs;
2721:
2722: if ($rolesdump ne '') {
2723: foreach (split(/&/,$rolesdump)) {
2724: if ($_!~/^rolesdef_/) {
2725: my ($area,$role)=split(/=/,$_);
2726: $area=~s/\_\w\w$//;
2727: my ($trole,$tend,$tstart,$group_privs);
2728: if ($role=~/^cr/) {
2729: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2730: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2731: ($tend,$tstart)=split('_',$trest);
2732: } else {
2733: $trole=$role;
2734: }
2735: } elsif ($role =~ m|^gr/|) {
2736: ($trole,$tend,$tstart) = split(/_/,$role);
2737: ($trole,$group_privs) = split(/\//,$trole);
2738: $group_privs = &unescape($group_privs);
2739: } else {
2740: ($trole,$tend,$tstart)=split(/_/,$role);
2741: }
2742: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2743: $username);
2744: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2745: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2746: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2747: if (($area ne '') && ($trole ne '')) {
2748: my $spec=$trole.'.'.$area;
2749: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2750: if ($trole =~ /^cr\//) {
2751: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2752: } elsif ($trole eq 'gr') {
2753: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2754: } else {
2755: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2756: }
2757: }
2758: }
2759: }
2760: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2761: $userroles{'user.adv'} = $adv;
2762: $userroles{'user.author'} = $author;
2763: $env{'user.adv'}=$adv;
2764: }
2765: return \%userroles;
2766: }
2767:
2768: sub set_arearole {
2769: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2770: # log the associated role with the area
2771: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2772: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2773: }
2774:
2775: sub custom_roleprivs {
2776: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2777: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2778: my $homsvr=homeserver($rauthor,$rdomain);
2779: if ($hostname{$homsvr} ne '') {
2780: my ($rdummy,$roledef)=
2781: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2782: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2783: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2784: if (defined($syspriv)) {
2785: $$allroles{'cm./'}.=':'.$syspriv;
2786: $$allroles{$spec.'./'}.=':'.$syspriv;
2787: }
2788: if ($tdomain ne '') {
2789: if (defined($dompriv)) {
2790: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2791: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2792: }
2793: if (($trest ne '') && (defined($coursepriv))) {
2794: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2795: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2796: }
2797: }
2798: }
2799: }
2800: }
2801:
2802: sub group_roleprivs {
2803: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2804: my $access = 1;
2805: my $now = time;
2806: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2807: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2808: if ($access) {
2809: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2810: $$allgroups{$course}{$group} .=':'.$group_privs;
2811: }
2812: }
2813:
2814: sub standard_roleprivs {
2815: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2816: if (defined($pr{$trole.':s'})) {
2817: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2818: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2819: }
2820: if ($tdomain ne '') {
2821: if (defined($pr{$trole.':d'})) {
2822: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2823: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2824: }
2825: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2826: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2827: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2828: }
2829: }
2830: }
2831:
2832: sub set_userprivs {
2833: my ($userroles,$allroles,$allgroups) = @_;
2834: my $author=0;
2835: my $adv=0;
2836: my %grouproles = ();
2837: if (keys(%{$allgroups}) > 0) {
2838: foreach my $role (keys %{$allroles}) {
2839: my ($trole,$area,$sec,$extendedarea);
2840: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
2841: $trole = $1;
2842: $area = $2;
2843: $sec = $3;
2844: $extendedarea = $area.$sec;
2845: if (exists($$allgroups{$area})) {
2846: foreach my $group (keys(%{$$allgroups{$area}})) {
2847: my $spec = $trole.'.'.$extendedarea;
2848: $grouproles{$spec.'.'.$area.'/'.$group} =
2849: $$allgroups{$area}{$group};
2850: }
2851: }
2852: }
2853: }
2854: }
2855: foreach (keys(%grouproles)) {
2856: $$allroles{$_} = $grouproles{$_};
2857: }
2858: foreach (keys %{$allroles}) {
2859: my %thesepriv=();
2860: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2861: foreach (split(/:/,$$allroles{$_})) {
2862: if ($_ ne '') {
2863: my ($privilege,$restrictions)=split(/&/,$_);
2864: if ($restrictions eq '') {
2865: $thesepriv{$privilege}='F';
2866: } elsif ($thesepriv{$privilege} ne 'F') {
2867: $thesepriv{$privilege}.=$restrictions;
2868: }
2869: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2870: }
2871: }
2872: my $thesestr='';
2873: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2874: $userroles->{'user.priv.'.$_} = $thesestr;
2875: }
2876: return ($author,$adv);
2877: }
2878:
2879: # --------------------------------------------------------------- get interface
2880:
2881: sub get {
2882: my ($namespace,$storearr,$udomain,$uname)=@_;
2883: my $items='';
2884: foreach (@$storearr) {
2885: $items.=escape($_).'&';
2886: }
2887: $items=~s/\&$//;
2888: if (!$udomain) { $udomain=$env{'user.domain'}; }
2889: if (!$uname) { $uname=$env{'user.name'}; }
2890: my $uhome=&homeserver($uname,$udomain);
2891:
2892: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2893: my @pairs=split(/\&/,$rep);
2894: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2895: return @pairs;
2896: }
2897: my %returnhash=();
2898: my $i=0;
2899: foreach (@$storearr) {
2900: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2901: $i++;
2902: }
2903: return %returnhash;
2904: }
2905:
2906: # --------------------------------------------------------------- del interface
2907:
2908: sub del {
2909: my ($namespace,$storearr,$udomain,$uname)=@_;
2910: my $items='';
2911: foreach (@$storearr) {
2912: $items.=escape($_).'&';
2913: }
2914: $items=~s/\&$//;
2915: if (!$udomain) { $udomain=$env{'user.domain'}; }
2916: if (!$uname) { $uname=$env{'user.name'}; }
2917: my $uhome=&homeserver($uname,$udomain);
2918:
2919: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2920: }
2921:
2922: # -------------------------------------------------------------- dump interface
2923:
2924: sub dump {
2925: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2926: if (!$udomain) { $udomain=$env{'user.domain'}; }
2927: if (!$uname) { $uname=$env{'user.name'}; }
2928: my $uhome=&homeserver($uname,$udomain);
2929: if ($regexp) {
2930: $regexp=&escape($regexp);
2931: } else {
2932: $regexp='.';
2933: }
2934: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2935: my @pairs=split(/\&/,$rep);
2936: my %returnhash=();
2937: foreach (@pairs) {
2938: my ($key,$value)=split(/=/,$_,2);
2939: $returnhash{unescape($key)}=&thaw_unescape($value);
2940: }
2941: return %returnhash;
2942: }
2943:
2944: # --------------------------------------------------------- dumpstore interface
2945:
2946: sub dumpstore {
2947: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2948: return &dump($namespace,$udomain,$uname,$regexp,$range);
2949: }
2950:
2951: # -------------------------------------------------------------- keys interface
2952:
2953: sub getkeys {
2954: my ($namespace,$udomain,$uname)=@_;
2955: if (!$udomain) { $udomain=$env{'user.domain'}; }
2956: if (!$uname) { $uname=$env{'user.name'}; }
2957: my $uhome=&homeserver($uname,$udomain);
2958: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2959: my @keyarray=();
2960: foreach (split(/\&/,$rep)) {
2961: push (@keyarray,&unescape($_));
2962: }
2963: return @keyarray;
2964: }
2965:
2966: # --------------------------------------------------------------- currentdump
2967: sub currentdump {
2968: my ($courseid,$sdom,$sname)=@_;
2969: $courseid = $env{'request.course.id'} if (! defined($courseid));
2970: $sdom = $env{'user.domain'} if (! defined($sdom));
2971: $sname = $env{'user.name'} if (! defined($sname));
2972: my $uhome = &homeserver($sname,$sdom);
2973: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2974: return if ($rep =~ /^(error:|no_such_host)/);
2975: #
2976: my %returnhash=();
2977: #
2978: if ($rep eq "unknown_cmd") {
2979: # an old lond will not know currentdump
2980: # Do a dump and make it look like a currentdump
2981: my @tmp = &dump($courseid,$sdom,$sname,'.');
2982: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2983: my %hash = @tmp;
2984: @tmp=();
2985: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
2986: } else {
2987: my @pairs=split(/\&/,$rep);
2988: foreach (@pairs) {
2989: my ($key,$value)=split(/=/,$_);
2990: my ($symb,$param) = split(/:/,$key);
2991: $returnhash{&unescape($symb)}->{&unescape($param)} =
2992: &thaw_unescape($value);
2993: }
2994: }
2995: return %returnhash;
2996: }
2997:
2998: sub convert_dump_to_currentdump{
2999: my %hash = %{shift()};
3000: my %returnhash;
3001: # Code ripped from lond, essentially. The only difference
3002: # here is the unescaping done by lonnet::dump(). Conceivably
3003: # we might run in to problems with parameter names =~ /^v\./
3004: while (my ($key,$value) = each(%hash)) {
3005: my ($v,$symb,$param) = split(/:/,$key);
3006: next if ($v eq 'version' || $symb eq 'keys');
3007: next if (exists($returnhash{$symb}) &&
3008: exists($returnhash{$symb}->{$param}) &&
3009: $returnhash{$symb}->{'v.'.$param} > $v);
3010: $returnhash{$symb}->{$param}=$value;
3011: $returnhash{$symb}->{'v.'.$param}=$v;
3012: }
3013: #
3014: # Remove all of the keys in the hashes which keep track of
3015: # the version of the parameter.
3016: while (my ($symb,$param_hash) = each(%returnhash)) {
3017: # use a foreach because we are going to delete from the hash.
3018: foreach my $key (keys(%$param_hash)) {
3019: delete($param_hash->{$key}) if ($key =~ /^v\./);
3020: }
3021: }
3022: return \%returnhash;
3023: }
3024:
3025: # ------------------------------------------------------ critical inc interface
3026:
3027: sub cinc {
3028: return &inc(@_,'critical');
3029: }
3030:
3031: # --------------------------------------------------------------- inc interface
3032:
3033: sub inc {
3034: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3035: if (!$udomain) { $udomain=$env{'user.domain'}; }
3036: if (!$uname) { $uname=$env{'user.name'}; }
3037: my $uhome=&homeserver($uname,$udomain);
3038: my $items='';
3039: if (! ref($store)) {
3040: # got a single value, so use that instead
3041: $items = &escape($store).'=&';
3042: } elsif (ref($store) eq 'SCALAR') {
3043: $items = &escape($$store).'=&';
3044: } elsif (ref($store) eq 'ARRAY') {
3045: $items = join('=&',map {&escape($_);} @{$store});
3046: } elsif (ref($store) eq 'HASH') {
3047: while (my($key,$value) = each(%{$store})) {
3048: $items.= &escape($key).'='.&escape($value).'&';
3049: }
3050: }
3051: $items=~s/\&$//;
3052: if ($critical) {
3053: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3054: } else {
3055: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3056: }
3057: }
3058:
3059: # --------------------------------------------------------------- put interface
3060:
3061: sub put {
3062: my ($namespace,$storehash,$udomain,$uname)=@_;
3063: if (!$udomain) { $udomain=$env{'user.domain'}; }
3064: if (!$uname) { $uname=$env{'user.name'}; }
3065: my $uhome=&homeserver($uname,$udomain);
3066: my $items='';
3067: foreach (keys %$storehash) {
3068: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3069: }
3070: $items=~s/\&$//;
3071: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3072: }
3073:
3074: # ------------------------------------------------------------ newput interface
3075:
3076: sub newput {
3077: my ($namespace,$storehash,$udomain,$uname)=@_;
3078: if (!$udomain) { $udomain=$env{'user.domain'}; }
3079: if (!$uname) { $uname=$env{'user.name'}; }
3080: my $uhome=&homeserver($uname,$udomain);
3081: my $items='';
3082: foreach my $key (keys(%$storehash)) {
3083: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3084: }
3085: $items=~s/\&$//;
3086: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3087: }
3088:
3089: # --------------------------------------------------------- putstore interface
3090:
3091: sub putstore {
3092: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3093: if (!$udomain) { $udomain=$env{'user.domain'}; }
3094: if (!$uname) { $uname=$env{'user.name'}; }
3095: my $uhome=&homeserver($uname,$udomain);
3096: my $items='';
3097: foreach my $key (keys(%$storehash)) {
3098: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3099: }
3100: $items=~s/\&$//;
3101: my $esc_symb=&escape($symb);
3102: my $esc_v=&escape($version);
3103: my $reply =
3104: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3105: $uhome);
3106: if ($reply eq 'unknown_cmd') {
3107: # gfall back to way things use to be done
3108: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3109: $uname);
3110: }
3111: return $reply;
3112: }
3113:
3114: sub old_putstore {
3115: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3116: if (!$udomain) { $udomain=$env{'user.domain'}; }
3117: if (!$uname) { $uname=$env{'user.name'}; }
3118: my $uhome=&homeserver($uname,$udomain);
3119: my %newstorehash;
3120: foreach (keys %$storehash) {
3121: my $key = $version.':'.&escape($symb).':'.$_;
3122: $newstorehash{$key} = $storehash->{$_};
3123: }
3124: my $items='';
3125: my %allitems = ();
3126: foreach (keys %newstorehash) {
3127: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3128: my $key = $1.':keys:'.$2;
3129: $allitems{$key} .= $3.':';
3130: }
3131: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3132: }
3133: foreach (keys %allitems) {
3134: $allitems{$_} =~ s/\:$//;
3135: $items.= $_.'='.$allitems{$_}.'&';
3136: }
3137: $items=~s/\&$//;
3138: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3139: }
3140:
3141: # ------------------------------------------------------ critical put interface
3142:
3143: sub cput {
3144: my ($namespace,$storehash,$udomain,$uname)=@_;
3145: if (!$udomain) { $udomain=$env{'user.domain'}; }
3146: if (!$uname) { $uname=$env{'user.name'}; }
3147: my $uhome=&homeserver($uname,$udomain);
3148: my $items='';
3149: foreach (keys %$storehash) {
3150: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3151: }
3152: $items=~s/\&$//;
3153: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3154: }
3155:
3156: # -------------------------------------------------------------- eget interface
3157:
3158: sub eget {
3159: my ($namespace,$storearr,$udomain,$uname)=@_;
3160: my $items='';
3161: foreach (@$storearr) {
3162: $items.=escape($_).'&';
3163: }
3164: $items=~s/\&$//;
3165: if (!$udomain) { $udomain=$env{'user.domain'}; }
3166: if (!$uname) { $uname=$env{'user.name'}; }
3167: my $uhome=&homeserver($uname,$udomain);
3168: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3169: my @pairs=split(/\&/,$rep);
3170: my %returnhash=();
3171: my $i=0;
3172: foreach (@$storearr) {
3173: $returnhash{$_}=&thaw_unescape($pairs[$i]);
3174: $i++;
3175: }
3176: return %returnhash;
3177: }
3178:
3179: # ------------------------------------------------------------ tmpput interface
3180: sub tmpput {
3181: my ($storehash,$server)=@_;
3182: my $items='';
3183: foreach (keys(%$storehash)) {
3184: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3185: }
3186: $items=~s/\&$//;
3187: return &reply("tmpput:$items",$server);
3188: }
3189:
3190: # ------------------------------------------------------------ tmpget interface
3191: sub tmpget {
3192: my ($token,$server)=@_;
3193: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3194: my $rep=&reply("tmpget:$token",$server);
3195: my %returnhash;
3196: foreach my $item (split(/\&/,$rep)) {
3197: my ($key,$value)=split(/=/,$item);
3198: $returnhash{&unescape($key)}=&thaw_unescape($value);
3199: }
3200: return %returnhash;
3201: }
3202:
3203: # ------------------------------------------------------------ tmpget interface
3204: sub tmpdel {
3205: my ($token,$server)=@_;
3206: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3207: return &reply("tmpdel:$token",$server);
3208: }
3209:
3210: # ---------------------------------------------- Custom access rule evaluation
3211:
3212: sub customaccess {
3213: my ($priv,$uri)=@_;
3214: my ($urole,$urealm)=split(/\./,$env{'request.role'});
3215: $urealm=~s/^\W//;
3216: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3217: my $access=0;
3218: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3219: my ($effect,$realm,$role)=split(/\:/,$_);
3220: if ($role) {
3221: if ($role ne $urole) { next; }
3222: }
3223: foreach (split(/\s*\,\s*/,$realm)) {
3224: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3225: if ($tdom) {
3226: if ($tdom ne $udom) { next; }
3227: }
3228: if ($tcrs) {
3229: if ($tcrs ne $ucrs) { next; }
3230: }
3231: if ($tsec) {
3232: if ($tsec ne $usec) { next; }
3233: }
3234: $access=($effect eq 'allow');
3235: last;
3236: }
3237: if ($realm eq '' && $role eq '') {
3238: $access=($effect eq 'allow');
3239: }
3240: }
3241: return $access;
3242: }
3243:
3244: # ------------------------------------------------- Check for a user privilege
3245:
3246: sub allowed {
3247: my ($priv,$uri,$symb)=@_;
3248: my $ver_orguri=$uri;
3249: $uri=&deversion($uri);
3250: my $orguri=$uri;
3251: $uri=&declutter($uri);
3252:
3253: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3254: # Free bre access to adm and meta resources
3255: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3256: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
3257: return 'F';
3258: }
3259:
3260: # Free bre access to user's own portfolio contents
3261: my ($space,$domain,$name,@dir)=split('/',$uri);
3262: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3263: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3264: return 'F';
3265: }
3266:
3267: # bre access to group if user has rgf priv for this group and course.
3268: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3269: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3270: if (exists($env{'request.course.id'})) {
3271: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3272: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3273: if (($domain eq $cdom) && ($name eq $cnum)) {
3274: my $courseprivid=$env{'request.course.id'};
3275: $courseprivid=~s/\_/\//;
3276: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3277: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3278: return $1;
3279: }
3280: }
3281: }
3282: }
3283:
3284: # Free bre to public access
3285:
3286: if ($priv eq 'bre') {
3287: my $copyright=&metadata($uri,'copyright');
3288: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3289: return 'F';
3290: }
3291: if ($copyright eq 'priv') {
3292: $uri=~/([^\/]+)\/([^\/]+)\//;
3293: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3294: return '';
3295: }
3296: }
3297: if ($copyright eq 'domain') {
3298: $uri=~/([^\/]+)\/([^\/]+)\//;
3299: unless (($env{'user.domain'} eq $1) ||
3300: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3301: return '';
3302: }
3303: }
3304: if ($env{'request.role'}=~ /li\.\//) {
3305: # Library role, so allow browsing of resources in this domain.
3306: return 'F';
3307: }
3308: if ($copyright eq 'custom') {
3309: unless (&customaccess($priv,$uri)) { return ''; }
3310: }
3311: }
3312: # Domain coordinator is trying to create a course
3313: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3314: # uri is the requested domain in this case.
3315: # comparison to 'request.role.domain' shows if the user has selected
3316: # a role of dc for the domain in question.
3317: return 'F' if ($uri eq $env{'request.role.domain'});
3318: }
3319:
3320: my $thisallowed='';
3321: my $statecond=0;
3322: my $courseprivid='';
3323:
3324: # Course
3325:
3326: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3327: $thisallowed.=$1;
3328: }
3329:
3330: # Domain
3331:
3332: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3333: =~/\Q$priv\E\&([^\:]*)/) {
3334: $thisallowed.=$1;
3335: }
3336:
3337: # Course: uri itself is a course
3338: my $courseuri=$uri;
3339: $courseuri=~s/\_(\d)/\/$1/;
3340: $courseuri=~s/^([^\/])/\/$1/;
3341:
3342: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3343: =~/\Q$priv\E\&([^\:]*)/) {
3344: $thisallowed.=$1;
3345: }
3346:
3347: # Group: uri itself is a group
3348: my $groupuri=$uri;
3349: $groupuri=~s/^([^\/])/\/$1/;
3350: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3351: =~/\Q$priv\E\&([^\:]*)/) {
3352: $thisallowed.=$1;
3353: }
3354:
3355: # URI is an uploaded document for this course, default permissions don't matter
3356: # not allowing 'edit' access (editupload) to uploaded course docs
3357: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3358: $thisallowed='';
3359: my ($match)=&is_on_map($uri);
3360: if ($match) {
3361: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3362: =~/\Q$priv\E\&([^\:]*)/) {
3363: $thisallowed.=$1;
3364: }
3365: } else {
3366: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3367: if ($refuri) {
3368: if ($refuri =~ m|^/adm/|) {
3369: $thisallowed='F';
3370: } else {
3371: $refuri=&declutter($refuri);
3372: my ($match) = &is_on_map($refuri);
3373: if ($match) {
3374: $thisallowed='F';
3375: }
3376: }
3377: }
3378: }
3379: }
3380:
3381: # Full access at system, domain or course-wide level? Exit.
3382:
3383: if ($thisallowed=~/F/) {
3384: return 'F';
3385: }
3386:
3387: # If this is generating or modifying users, exit with special codes
3388:
3389: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3390: if (($priv eq 'cca') || ($priv eq 'caa')) {
3391: my ($audom,$auname)=split('/',$uri);
3392: # no author name given, so this just checks on the general right to make a co-author in this domain
3393: unless ($auname) { return $thisallowed; }
3394: # an author name is given, so we are about to actually make a co-author for a certain account
3395: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3396: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3397: ($audom ne $env{'request.role.domain'}))) { return ''; }
3398: }
3399: return $thisallowed;
3400: }
3401: #
3402: # Gathered so far: system, domain and course wide privileges
3403: #
3404: # Course: See if uri or referer is an individual resource that is part of
3405: # the course
3406:
3407: if ($env{'request.course.id'}) {
3408:
3409: $courseprivid=$env{'request.course.id'};
3410: if ($env{'request.course.sec'}) {
3411: $courseprivid.='/'.$env{'request.course.sec'};
3412: }
3413: $courseprivid=~s/\_/\//;
3414: my $checkreferer=1;
3415: my ($match,$cond)=&is_on_map($uri);
3416: if ($match) {
3417: $statecond=$cond;
3418: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3419: =~/\Q$priv\E\&([^\:]*)/) {
3420: $thisallowed.=$1;
3421: $checkreferer=0;
3422: }
3423: }
3424:
3425: if ($checkreferer) {
3426: my $refuri=$env{'httpref.'.$orguri};
3427: unless ($refuri) {
3428: foreach (keys %env) {
3429: if ($_=~/^httpref\..*\*/) {
3430: my $pattern=$_;
3431: $pattern=~s/^httpref\.\/res\///;
3432: $pattern=~s/\*/\[\^\/\]\+/g;
3433: $pattern=~s/\//\\\//g;
3434: if ($orguri=~/$pattern/) {
3435: $refuri=$env{$_};
3436: }
3437: }
3438: }
3439: }
3440:
3441: if ($refuri) {
3442: $refuri=&declutter($refuri);
3443: my ($match,$cond)=&is_on_map($refuri);
3444: if ($match) {
3445: my $refstatecond=$cond;
3446: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3447: =~/\Q$priv\E\&([^\:]*)/) {
3448: $thisallowed.=$1;
3449: $uri=$refuri;
3450: $statecond=$refstatecond;
3451: }
3452: }
3453: }
3454: }
3455: }
3456:
3457: #
3458: # Gathered now: all privileges that could apply, and condition number
3459: #
3460: #
3461: # Full or no access?
3462: #
3463:
3464: if ($thisallowed=~/F/) {
3465: return 'F';
3466: }
3467:
3468: unless ($thisallowed) {
3469: return '';
3470: }
3471:
3472: # Restrictions exist, deal with them
3473: #
3474: # C:according to course preferences
3475: # R:according to resource settings
3476: # L:unless locked
3477: # X:according to user session state
3478: #
3479:
3480: # Possibly locked functionality, check all courses
3481: # Locks might take effect only after 10 minutes cache expiration for other
3482: # courses, and 2 minutes for current course
3483:
3484: my $envkey;
3485: if ($thisallowed=~/L/) {
3486: foreach $envkey (keys %env) {
3487: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3488: my $courseid=$2;
3489: my $roleid=$1.'.'.$2;
3490: $courseid=~s/^\///;
3491: my $expiretime=600;
3492: if ($env{'request.role'} eq $roleid) {
3493: $expiretime=120;
3494: }
3495: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3496: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3497: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3498: &coursedescription($courseid,{'freshen_cache' => 1});
3499: }
3500: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3501: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3502: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3503: &log($env{'user.domain'},$env{'user.name'},
3504: $env{'user.home'},
3505: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3506: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3507: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3508: return '';
3509: }
3510: }
3511: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3512: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3513: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3514: &log($env{'user.domain'},$env{'user.name'},
3515: $env{'user.home'},
3516: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3517: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3518: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3519: return '';
3520: }
3521: }
3522: }
3523: }
3524: }
3525:
3526: #
3527: # Rest of the restrictions depend on selected course
3528: #
3529:
3530: unless ($env{'request.course.id'}) {
3531: return '1';
3532: }
3533:
3534: #
3535: # Now user is definitely in a course
3536: #
3537:
3538:
3539: # Course preferences
3540:
3541: if ($thisallowed=~/C/) {
3542: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3543: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3544: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3545: =~/\Q$rolecode\E/) {
3546: if ($priv ne 'pch') {
3547: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3548: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3549: $env{'request.course.id'});
3550: }
3551: return '';
3552: }
3553:
3554: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3555: =~/\Q$unamedom\E/) {
3556: if ($priv ne 'pch') {
3557: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3558: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3559: $env{'request.course.id'});
3560: }
3561: return '';
3562: }
3563: }
3564:
3565: # Resource preferences
3566:
3567: if ($thisallowed=~/R/) {
3568: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3569: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3570: if ($priv ne 'pch') {
3571: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3572: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3573: }
3574: return '';
3575: }
3576: }
3577:
3578: # Restricted by state or randomout?
3579:
3580: if ($thisallowed=~/X/) {
3581: if ($env{'acc.randomout'}) {
3582: if (!$symb) { $symb=&symbread($uri,1); }
3583: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3584: return '';
3585: }
3586: }
3587: if (&condval($statecond)) {
3588: return '2';
3589: } else {
3590: return '';
3591: }
3592: }
3593:
3594: return 'F';
3595: }
3596:
3597: sub split_uri_for_cond {
3598: my $uri=&deversion(&declutter(shift));
3599: my @uriparts=split(/\//,$uri);
3600: my $filename=pop(@uriparts);
3601: my $pathname=join('/',@uriparts);
3602: return ($pathname,$filename);
3603: }
3604: # --------------------------------------------------- Is a resource on the map?
3605:
3606: sub is_on_map {
3607: my ($pathname,$filename) = &split_uri_for_cond(shift);
3608: #Trying to find the conditional for the file
3609: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3610: /\&\Q$filename\E\:([\d\|]+)\&/);
3611: if ($match) {
3612: return (1,$1);
3613: } else {
3614: return (0,0);
3615: }
3616: }
3617:
3618: # --------------------------------------------------------- Get symb from alias
3619:
3620: sub get_symb_from_alias {
3621: my $symb=shift;
3622: my ($map,$resid,$url)=&decode_symb($symb);
3623: # Already is a symb
3624: if ($url) { return $symb; }
3625: # Must be an alias
3626: my $aliassymb='';
3627: my %bighash;
3628: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3629: &GDBM_READER(),0640)) {
3630: my $rid=$bighash{'mapalias_'.$symb};
3631: if ($rid) {
3632: my ($mapid,$resid)=split(/\./,$rid);
3633: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3634: $resid,$bighash{'src_'.$rid});
3635: }
3636: untie %bighash;
3637: }
3638: return $aliassymb;
3639: }
3640:
3641: # ----------------------------------------------------------------- Define Role
3642:
3643: sub definerole {
3644: if (allowed('mcr','/')) {
3645: my ($rolename,$sysrole,$domrole,$courole)=@_;
3646: foreach (split(':',$sysrole)) {
3647: my ($crole,$cqual)=split(/\&/,$_);
3648: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3649: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3650: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3651: return "refused:s:$crole&$cqual";
3652: }
3653: }
3654: }
3655: foreach (split(':',$domrole)) {
3656: my ($crole,$cqual)=split(/\&/,$_);
3657: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3658: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3659: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3660: return "refused:d:$crole&$cqual";
3661: }
3662: }
3663: }
3664: foreach (split(':',$courole)) {
3665: my ($crole,$cqual)=split(/\&/,$_);
3666: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3667: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3668: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3669: return "refused:c:$crole&$cqual";
3670: }
3671: }
3672: }
3673: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3674: "$env{'user.domain'}:$env{'user.name'}:".
3675: "rolesdef_$rolename=".
3676: escape($sysrole.'_'.$domrole.'_'.$courole);
3677: return reply($command,$env{'user.home'});
3678: } else {
3679: return 'refused';
3680: }
3681: }
3682:
3683: # ---------------- Make a metadata query against the network of library servers
3684:
3685: sub metadata_query {
3686: my ($query,$custom,$customshow,$server_array)=@_;
3687: my %rhash;
3688: my @server_list = (defined($server_array) ? @$server_array
3689: : keys(%libserv) );
3690: for my $server (@server_list) {
3691: unless ($custom or $customshow) {
3692: my $reply=&reply("querysend:".&escape($query),$server);
3693: $rhash{$server}=$reply;
3694: }
3695: else {
3696: my $reply=&reply("querysend:".&escape($query).':'.
3697: &escape($custom).':'.&escape($customshow),
3698: $server);
3699: $rhash{$server}=$reply;
3700: }
3701: }
3702: return \%rhash;
3703: }
3704:
3705: # ----------------------------------------- Send log queries and wait for reply
3706:
3707: sub log_query {
3708: my ($uname,$udom,$query,%filters)=@_;
3709: my $uhome=&homeserver($uname,$udom);
3710: if ($uhome eq 'no_host') { return 'error: no_host'; }
3711: my $uhost=$hostname{$uhome};
3712: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3713: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3714: $uhome);
3715: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3716: return get_query_reply($queryid);
3717: }
3718:
3719: # ------- Request retrieval of institutional classlists for course(s)
3720:
3721: sub fetch_enrollment_query {
3722: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
3723: my $homeserver;
3724: my $maxtries = 1;
3725: if ($context eq 'automated') {
3726: $homeserver = $perlvar{'lonHostID'};
3727: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
3728: } else {
3729: $homeserver = &homeserver($cnum,$dom);
3730: }
3731: my $host=$hostname{$homeserver};
3732: my $cmd = '';
3733: foreach (keys %{$affiliatesref}) {
3734: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3735: }
3736: $cmd =~ s/%%$//;
3737: $cmd = &escape($cmd);
3738: my $query = 'fetchenrollment';
3739: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
3740: unless ($queryid=~/^\Q$host\E\_/) {
3741: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3742: return 'error: '.$queryid;
3743: }
3744: my $reply = &get_query_reply($queryid);
3745: my $tries = 1;
3746: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3747: $reply = &get_query_reply($queryid);
3748: $tries ++;
3749: }
3750: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3751: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3752: } else {
3753: my @responses = split/:/,$reply;
3754: if ($homeserver eq $perlvar{'lonHostID'}) {
3755: foreach (@responses) {
3756: my ($key,$value) = split/=/,$_;
3757: $$replyref{$key} = $value;
3758: }
3759: } else {
3760: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3761: foreach (@responses) {
3762: my ($key,$value) = split/=/,$_;
3763: $$replyref{$key} = $value;
3764: if ($value > 0) {
3765: foreach (@{$$affiliatesref{$key}}) {
3766: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3767: my $destname = $pathname.'/'.$filename;
3768: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
3769: if ($xml_classlist =~ /^error/) {
3770: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3771: } else {
3772: if ( open(FILE,">$destname") ) {
3773: print FILE &unescape($xml_classlist);
3774: close(FILE);
3775: } else {
3776: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
3777: }
3778: }
3779: }
3780: }
3781: }
3782: }
3783: return 'ok';
3784: }
3785: return 'error';
3786: }
3787:
3788: sub get_query_reply {
3789: my $queryid=shift;
3790: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3791: my $reply='';
3792: for (1..100) {
3793: sleep 2;
3794: if (-e $replyfile.'.end') {
3795: if (open(my $fh,$replyfile)) {
3796: $reply.=<$fh>;
3797: close($fh);
3798: } else { return 'error: reply_file_error'; }
3799: return &unescape($reply);
3800: }
3801: }
3802: return 'timeout:'.$queryid;
3803: }
3804:
3805: sub courselog_query {
3806: #
3807: # possible filters:
3808: # url: url or symb
3809: # username
3810: # domain
3811: # action: view, submit, grade
3812: # start: timestamp
3813: # end: timestamp
3814: #
3815: my (%filters)=@_;
3816: unless ($env{'request.course.id'}) { return 'no_course'; }
3817: if ($filters{'url'}) {
3818: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3819: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3820: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3821: }
3822: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3823: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3824: return &log_query($cname,$cdom,'courselog',%filters);
3825: }
3826:
3827: sub userlog_query {
3828: my ($uname,$udom,%filters)=@_;
3829: return &log_query($uname,$udom,'userlog',%filters);
3830: }
3831:
3832: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3833:
3834: sub auto_run {
3835: my ($cnum,$cdom) = @_;
3836: my $homeserver = &homeserver($cnum,$cdom);
3837: my $response = &reply('autorun:'.$cdom,$homeserver);
3838: return $response;
3839: }
3840:
3841: sub auto_get_sections {
3842: my ($cnum,$cdom,$inst_coursecode) = @_;
3843: my $homeserver = &homeserver($cnum,$cdom);
3844: my @secs = ();
3845: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
3846: unless ($response eq 'refused') {
3847: @secs = split/:/,$response;
3848: }
3849: return @secs;
3850: }
3851:
3852: sub auto_new_course {
3853: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3854: my $homeserver = &homeserver($cnum,$cdom);
3855: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
3856: return $response;
3857: }
3858:
3859: sub auto_validate_courseID {
3860: my ($cnum,$cdom,$inst_course_id) = @_;
3861: my $homeserver = &homeserver($cnum,$cdom);
3862: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
3863: return $response;
3864: }
3865:
3866: sub auto_create_password {
3867: my ($cnum,$cdom,$authparam) = @_;
3868: my $homeserver = &homeserver($cnum,$cdom);
3869: my $create_passwd = 0;
3870: my $authchk = '';
3871: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
3872: if ($response eq 'refused') {
3873: $authchk = 'refused';
3874: } else {
3875: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3876: }
3877: return ($authparam,$create_passwd,$authchk);
3878: }
3879:
3880: sub auto_photo_permission {
3881: my ($cnum,$cdom,$students) = @_;
3882: my $homeserver = &homeserver($cnum,$cdom);
3883: my ($outcome,$perm_reqd,$conditions) =
3884: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
3885: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3886: return (undef,undef);
3887: }
3888: return ($outcome,$perm_reqd,$conditions);
3889: }
3890:
3891: sub auto_checkphotos {
3892: my ($uname,$udom,$pid) = @_;
3893: my $homeserver = &homeserver($uname,$udom);
3894: my ($result,$resulttype);
3895: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
3896: &escape($uname).':'.&escape($pid),
3897: $homeserver));
3898: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3899: return (undef,undef);
3900: }
3901: if ($outcome) {
3902: ($result,$resulttype) = split(/:/,$outcome);
3903: }
3904: return ($result,$resulttype);
3905: }
3906:
3907: sub auto_photochoice {
3908: my ($cnum,$cdom) = @_;
3909: my $homeserver = &homeserver($cnum,$cdom);
3910: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
3911: &escape($cdom),
3912: $homeserver)));
3913: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3914: return (undef,undef);
3915: }
3916: return ($update,$comment);
3917: }
3918:
3919: sub auto_photoupdate {
3920: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3921: my $homeserver = &homeserver($cnum,$dom);
3922: my $host=$hostname{$homeserver};
3923: my $cmd = '';
3924: my $maxtries = 1;
3925: foreach (keys %{$affiliatesref}) {
3926: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3927: }
3928: $cmd =~ s/%%$//;
3929: $cmd = &escape($cmd);
3930: my $query = 'institutionalphotos';
3931: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3932: unless ($queryid=~/^\Q$host\E\_/) {
3933: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3934: return 'error: '.$queryid;
3935: }
3936: my $reply = &get_query_reply($queryid);
3937: my $tries = 1;
3938: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3939: $reply = &get_query_reply($queryid);
3940: $tries ++;
3941: }
3942: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3943: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3944: } else {
3945: my @responses = split(/:/,$reply);
3946: my $outcome = shift(@responses);
3947: foreach my $item (@responses) {
3948: my ($key,$value) = split(/=/,$item);
3949: $$photo{$key} = $value;
3950: }
3951: return $outcome;
3952: }
3953: return 'error';
3954: }
3955:
3956: sub auto_instcode_format {
3957: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3958: my $courses = '';
3959: my $homeserver;
3960: if ($caller eq 'global') {
3961: foreach my $tryserver (keys %libserv) {
3962: if ($hostdom{$tryserver} eq $codedom) {
3963: $homeserver = $tryserver;
3964: last;
3965: }
3966: }
3967: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3968: $homeserver = &homeserver($env{'user.name'},$codedom);
3969: }
3970: } else {
3971: $homeserver = &homeserver($caller,$codedom);
3972: }
3973: foreach (keys %{$instcodes}) {
3974: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3975: }
3976: chop($courses);
3977: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3978: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3979: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3980: %{$codes} = &str2hash($codes_str);
3981: @{$codetitles} = &str2array($codetitles_str);
3982: %{$cat_titles} = &str2hash($cat_titles_str);
3983: %{$cat_order} = &str2hash($cat_order_str);
3984: return 'ok';
3985: }
3986: return $response;
3987: }
3988:
3989: # ------------------------------------------------------- Course Group routines
3990:
3991: sub get_coursegroups {
3992: my ($cdom,$cnum,$group) = @_;
3993: return(&dump('coursegroups',$cdom,$cnum,$group));
3994: }
3995:
3996: sub modify_coursegroup {
3997: my ($cdom,$cnum,$groupsettings) = @_;
3998: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
3999: }
4000:
4001: sub modify_group_roles {
4002: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4003: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4004: my $role = 'gr/'.&escape($userprivs);
4005: my ($uname,$udom) = split(/:/,$user);
4006: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4007: if ($result eq 'ok') {
4008: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4009: }
4010: return $result;
4011: }
4012:
4013: sub modify_coursegroup_membership {
4014: my ($cdom,$cnum,$membership) = @_;
4015: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4016: return $result;
4017: }
4018:
4019: sub get_active_groups {
4020: my ($udom,$uname,$cdom,$cnum) = @_;
4021: my $now = time;
4022: my %groups = ();
4023: foreach my $key (keys(%env)) {
4024: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4025: my ($start,$end) = split(/\./,$env{$key});
4026: if (($end!=0) && ($end<$now)) { next; }
4027: if (($start!=0) && ($start>$now)) { next; }
4028: if ($1 eq $cdom && $2 eq $cnum) {
4029: $groups{$3} = $env{$key} ;
4030: }
4031: }
4032: }
4033: return %groups;
4034: }
4035:
4036: sub get_group_membership {
4037: my ($cdom,$cnum,$group) = @_;
4038: return(&dump('groupmembership',$cdom,$cnum,$group));
4039: }
4040:
4041: sub get_users_groups {
4042: my ($udom,$uname,$courseid) = @_;
4043: my @usersgroups;
4044: my $cachetime=1800;
4045: $courseid=~s/\_/\//g;
4046: $courseid=~s/^(\w)/\/$1/;
4047:
4048: my $hashid="$udom:$uname:$courseid";
4049: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4050: if (defined($cached)) {
4051: @usersgroups = split(/:/,$grouplist);
4052: } else {
4053: $grouplist = '';
4054: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4055: my ($tmp) = keys(%roleshash);
4056: if ($tmp=~/^error:/) {
4057: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4058: } else {
4059: my $access_end = $env{'course.'.$courseid.
4060: '.default_enrollment_end_date'};
4061: my $now = time;
4062: foreach my $key (keys(%roleshash)) {
4063: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4064: my $group = $1;
4065: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4066: my $start = $2;
4067: my $end = $1;
4068: if ($start == -1) { next; } # deleted from group
4069: if (($start!=0) && ($start>$now)) { next; }
4070: if (($end!=0) && ($end<$now)) {
4071: if ($access_end && $access_end < $now) {
4072: if ($access_end - $end < 86400) {
4073: push(@usersgroups,$group);
4074: }
4075: }
4076: next;
4077: }
4078: push(@usersgroups,$group);
4079: }
4080: }
4081: }
4082: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4083: $grouplist = join(':',@usersgroups);
4084: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4085: }
4086: }
4087: return @usersgroups;
4088: }
4089:
4090: sub devalidate_getgroups_cache {
4091: my ($udom,$uname,$cdom,$cnum)=@_;
4092: my $courseid = $cdom.'_'.$cnum;
4093: $courseid=~s/\_/\//g;
4094: $courseid=~s/^(\w)/\/$1/;
4095: my $hashid="$udom:$uname:$courseid";
4096: &devalidate_cache_new('getgroups',$hashid);
4097: }
4098:
4099: # ------------------------------------------------------------------ Plain Text
4100:
4101: sub plaintext {
4102: my ($short,$type,$cid) = @_;
4103: if (!defined($cid)) {
4104: $cid = $env{'request.course.id'};
4105: }
4106: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4107: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4108: '.plaintext'});
4109: }
4110: my %rolenames = (
4111: Course => 'std',
4112: Group => 'alt1',
4113: );
4114: if (defined($type) &&
4115: defined($rolenames{$type}) &&
4116: defined($prp{$short}{$rolenames{$type}})) {
4117: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4118: } else {
4119: return &Apache::lonlocal::mt($prp{$short}{'std'});
4120: }
4121: }
4122:
4123: # ----------------------------------------------------------------- Assign Role
4124:
4125: sub assignrole {
4126: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4127: my $mrole;
4128: if ($role =~ /^cr\//) {
4129: my $cwosec=$url;
4130: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4131: unless (&allowed('ccr',$cwosec)) {
4132: &logthis('Refused custom assignrole: '.
4133: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4134: $env{'user.name'}.' at '.$env{'user.domain'});
4135: return 'refused';
4136: }
4137: $mrole='cr';
4138: } elsif ($role =~ /^gr\//) {
4139: my $cwogrp=$url;
4140: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4141: unless (&allowed('mdg',$cwogrp)) {
4142: &logthis('Refused group assignrole: '.
4143: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4144: $env{'user.name'}.' at '.$env{'user.domain'});
4145: return 'refused';
4146: }
4147: $mrole='gr';
4148: } else {
4149: my $cwosec=$url;
4150: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4151: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4152: &logthis('Refused assignrole: '.
4153: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4154: $env{'user.name'}.' at '.$env{'user.domain'});
4155: return 'refused';
4156: }
4157: $mrole=$role;
4158: }
4159: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4160: "$udom:$uname:$url".'_'."$mrole=$role";
4161: if ($end) { $command.='_'.$end; }
4162: if ($start) {
4163: if ($end) {
4164: $command.='_'.$start;
4165: } else {
4166: $command.='_0_'.$start;
4167: }
4168: }
4169: my $origstart = $start;
4170: my $origend = $end;
4171: # actually delete
4172: if ($deleteflag) {
4173: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4174: # modify command to delete the role
4175: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4176: "$udom:$uname:$url".'_'."$mrole";
4177: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4178: # set start and finish to negative values for userrolelog
4179: $start=-1;
4180: $end=-1;
4181: }
4182: }
4183: # send command
4184: my $answer=&reply($command,&homeserver($uname,$udom));
4185: # log new user role if status is ok
4186: if ($answer eq 'ok') {
4187: &userrolelog($role,$uname,$udom,$url,$start,$end);
4188: # for course roles, perform group memberships changes triggered by role change.
4189: unless ($role =~ /^gr/) {
4190: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4191: $origstart);
4192: }
4193: }
4194: return $answer;
4195: }
4196:
4197: # -------------------------------------------------- Modify user authentication
4198: # Overrides without validation
4199:
4200: sub modifyuserauth {
4201: my ($udom,$uname,$umode,$upass)=@_;
4202: my $uhome=&homeserver($uname,$udom);
4203: unless (&allowed('mau',$udom)) { return 'refused'; }
4204: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4205: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4206: ' in domain '.$env{'request.role.domain'});
4207: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4208: &escape($upass),$uhome);
4209: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4210: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4211: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4212: &log($udom,,$uname,$uhome,
4213: 'Authentication changed by '.$env{'user.domain'}.', '.
4214: $env{'user.name'}.', '.$umode.
4215: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4216: unless ($reply eq 'ok') {
4217: &logthis('Authentication mode error: '.$reply);
4218: return 'error: '.$reply;
4219: }
4220: return 'ok';
4221: }
4222:
4223: # --------------------------------------------------------------- Modify a user
4224:
4225: sub modifyuser {
4226: my ($udom, $uname, $uid,
4227: $umode, $upass, $first,
4228: $middle, $last, $gene,
4229: $forceid, $desiredhome, $email)=@_;
4230: $udom=~s/\W//g;
4231: $uname=~s/\W//g;
4232: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4233: $umode.', '.$first.', '.$middle.', '.
4234: $last.', '.$gene.'(forceid: '.$forceid.')'.
4235: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4236: ' desiredhome not specified').
4237: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4238: ' in domain '.$env{'request.role.domain'});
4239: my $uhome=&homeserver($uname,$udom,'true');
4240: # ----------------------------------------------------------------- Create User
4241: if (($uhome eq 'no_host') &&
4242: (($umode && $upass) || ($umode eq 'localauth'))) {
4243: my $unhome='';
4244: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4245: $unhome = $desiredhome;
4246: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4247: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4248: } else { # load balancing routine for determining $unhome
4249: my $tryserver;
4250: my $loadm=10000000;
4251: foreach $tryserver (keys %libserv) {
4252: if ($hostdom{$tryserver} eq $udom) {
4253: my $answer=reply('load',$tryserver);
4254: if (($answer=~/\d+/) && ($answer<$loadm)) {
4255: $loadm=$answer;
4256: $unhome=$tryserver;
4257: }
4258: }
4259: }
4260: }
4261: if (($unhome eq '') || ($unhome eq 'no_host')) {
4262: return 'error: unable to find a home server for '.$uname.
4263: ' in domain '.$udom;
4264: }
4265: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4266: &escape($upass),$unhome);
4267: unless ($reply eq 'ok') {
4268: return 'error: '.$reply;
4269: }
4270: $uhome=&homeserver($uname,$udom,'true');
4271: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4272: return 'error: unable verify users home machine.';
4273: }
4274: } # End of creation of new user
4275: # ---------------------------------------------------------------------- Add ID
4276: if ($uid) {
4277: $uid=~tr/A-Z/a-z/;
4278: my %uidhash=&idrget($udom,$uname);
4279: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4280: && (!$forceid)) {
4281: unless ($uid eq $uidhash{$uname}) {
4282: return 'error: user id "'.$uid.'" does not match '.
4283: 'current user id "'.$uidhash{$uname}.'".';
4284: }
4285: } else {
4286: &idput($udom,($uname => $uid));
4287: }
4288: }
4289: # -------------------------------------------------------------- Add names, etc
4290: my @tmp=&get('environment',
4291: ['firstname','middlename','lastname','generation'],
4292: $udom,$uname);
4293: my %names;
4294: if ($tmp[0] =~ m/^error:.*/) {
4295: %names=();
4296: } else {
4297: %names = @tmp;
4298: }
4299: #
4300: # Make sure to not trash student environment if instructor does not bother
4301: # to supply name and email information
4302: #
4303: if ($first) { $names{'firstname'} = $first; }
4304: if (defined($middle)) { $names{'middlename'} = $middle; }
4305: if ($last) { $names{'lastname'} = $last; }
4306: if (defined($gene)) { $names{'generation'} = $gene; }
4307: if ($email) {
4308: $email=~s/[^\w\@\.\-\,]//gs;
4309: if ($email=~/\@/) { $names{'notification'} = $email;
4310: $names{'critnotification'} = $email;
4311: $names{'permanentemail'} = $email; }
4312: }
4313: my $reply = &put('environment', \%names, $udom,$uname);
4314: if ($reply ne 'ok') { return 'error: '.$reply; }
4315: &devalidate_cache_new('namescache',$uname.':'.$udom);
4316: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4317: $umode.', '.$first.', '.$middle.', '.
4318: $last.', '.$gene.' by '.
4319: $env{'user.name'}.' at '.$env{'user.domain'});
4320: return 'ok';
4321: }
4322:
4323: # -------------------------------------------------------------- Modify student
4324:
4325: sub modifystudent {
4326: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4327: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4328: if (!$cid) {
4329: unless ($cid=$env{'request.course.id'}) {
4330: return 'not_in_class';
4331: }
4332: }
4333: # --------------------------------------------------------------- Make the user
4334: my $reply=&modifyuser
4335: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4336: $desiredhome,$email);
4337: unless ($reply eq 'ok') { return $reply; }
4338: # This will cause &modify_student_enrollment to get the uid from the
4339: # students environment
4340: $uid = undef if (!$forceid);
4341: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4342: $gene,$usec,$end,$start,$type,$locktype,$cid);
4343: return $reply;
4344: }
4345:
4346: sub modify_student_enrollment {
4347: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4348: my ($cdom,$cnum,$chome);
4349: if (!$cid) {
4350: unless ($cid=$env{'request.course.id'}) {
4351: return 'not_in_class';
4352: }
4353: $cdom=$env{'course.'.$cid.'.domain'};
4354: $cnum=$env{'course.'.$cid.'.num'};
4355: } else {
4356: ($cdom,$cnum)=split(/_/,$cid);
4357: }
4358: $chome=$env{'course.'.$cid.'.home'};
4359: if (!$chome) {
4360: $chome=&homeserver($cnum,$cdom);
4361: }
4362: if (!$chome) { return 'unknown_course'; }
4363: # Make sure the user exists
4364: my $uhome=&homeserver($uname,$udom);
4365: if (($uhome eq '') || ($uhome eq 'no_host')) {
4366: return 'error: no such user';
4367: }
4368: # Get student data if we were not given enough information
4369: if (!defined($first) || $first eq '' ||
4370: !defined($last) || $last eq '' ||
4371: !defined($uid) || $uid eq '' ||
4372: !defined($middle) || $middle eq '' ||
4373: !defined($gene) || $gene eq '') {
4374: # They did not supply us with enough data to enroll the student, so
4375: # we need to pick up more information.
4376: my %tmp = &get('environment',
4377: ['firstname','middlename','lastname', 'generation','id']
4378: ,$udom,$uname);
4379:
4380: #foreach (keys(%tmp)) {
4381: # &logthis("key $_ = ".$tmp{$_});
4382: #}
4383: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4384: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4385: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4386: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4387: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4388: }
4389: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4390: my $reply=cput('classlist',
4391: {"$uname:$udom" =>
4392: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4393: $cdom,$cnum);
4394: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4395: return 'error: '.$reply;
4396: } else {
4397: &devalidate_getsection_cache($udom,$uname,$cid);
4398: }
4399: # Add student role to user
4400: my $uurl='/'.$cid;
4401: $uurl=~s/\_/\//g;
4402: if ($usec) {
4403: $uurl.='/'.$usec;
4404: }
4405: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4406: }
4407:
4408: sub format_name {
4409: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4410: my $name;
4411: if ($first ne 'lastname') {
4412: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4413: } else {
4414: if ($lastname=~/\S/) {
4415: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4416: $name=~s/\s+,/,/;
4417: } else {
4418: $name.= $firstname.' '.$middlename.' '.$generation;
4419: }
4420: }
4421: $name=~s/^\s+//;
4422: $name=~s/\s+$//;
4423: $name=~s/\s+/ /g;
4424: return $name;
4425: }
4426:
4427: # ------------------------------------------------- Write to course preferences
4428:
4429: sub writecoursepref {
4430: my ($courseid,%prefs)=@_;
4431: $courseid=~s/^\///;
4432: $courseid=~s/\_/\//g;
4433: my ($cdomain,$cnum)=split(/\//,$courseid);
4434: my $chome=homeserver($cnum,$cdomain);
4435: if (($chome eq '') || ($chome eq 'no_host')) {
4436: return 'error: no such course';
4437: }
4438: my $cstring='';
4439: foreach (keys %prefs) {
4440: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
4441: }
4442: $cstring=~s/\&$//;
4443: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4444: }
4445:
4446: # ---------------------------------------------------------- Make/modify course
4447:
4448: sub createcourse {
4449: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4450: $course_owner,$crstype)=@_;
4451: $url=&declutter($url);
4452: my $cid='';
4453: unless (&allowed('ccc',$udom)) {
4454: return 'refused';
4455: }
4456: # ------------------------------------------------------------------- Create ID
4457: my $uname=int(1+rand(9)).
4458: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4459: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4460: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4461: # ----------------------------------------------- Make sure that does not exist
4462: my $uhome=&homeserver($uname,$udom,'true');
4463: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4464: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4465: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4466: $uhome=&homeserver($uname,$udom,'true');
4467: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4468: return 'error: unable to generate unique course-ID';
4469: }
4470: }
4471: # ------------------------------------------------ Check supplied server name
4472: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4473: if (! exists($libserv{$course_server})) {
4474: return 'error:bad server name '.$course_server;
4475: }
4476: # ------------------------------------------------------------- Make the course
4477: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4478: $course_server);
4479: unless ($reply eq 'ok') { return 'error: '.$reply; }
4480: $uhome=&homeserver($uname,$udom,'true');
4481: if (($uhome eq '') || ($uhome eq 'no_host')) {
4482: return 'error: no such course';
4483: }
4484: # ----------------------------------------------------------------- Course made
4485: # log existence
4486: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4487: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4488: &escape($crstype),$uhome);
4489: &flushcourselogs();
4490: # set toplevel url
4491: my $topurl=$url;
4492: unless ($nonstandard) {
4493: # ------------------------------------------ For standard courses, make top url
4494: my $mapurl=&clutter($url);
4495: if ($mapurl eq '/res/') { $mapurl=''; }
4496: $env{'form.initmap'}=(<<ENDINITMAP);
4497: <map>
4498: <resource id="1" type="start"></resource>
4499: <resource id="2" src="$mapurl"></resource>
4500: <resource id="3" type="finish"></resource>
4501: <link index="1" from="1" to="2"></link>
4502: <link index="2" from="2" to="3"></link>
4503: </map>
4504: ENDINITMAP
4505: $topurl=&declutter(
4506: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4507: );
4508: }
4509: # ----------------------------------------------------------- Write preferences
4510: &writecoursepref($udom.'_'.$uname,
4511: ('description' => $description,
4512: 'url' => $topurl));
4513: return '/'.$udom.'/'.$uname;
4514: }
4515:
4516: # ---------------------------------------------------------- Assign Custom Role
4517:
4518: sub assigncustomrole {
4519: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4520: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4521: $end,$start,$deleteflag);
4522: }
4523:
4524: # ----------------------------------------------------------------- Revoke Role
4525:
4526: sub revokerole {
4527: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4528: my $now=time;
4529: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4530: }
4531:
4532: # ---------------------------------------------------------- Revoke Custom Role
4533:
4534: sub revokecustomrole {
4535: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4536: my $now=time;
4537: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4538: $deleteflag);
4539: }
4540:
4541: # ------------------------------------------------------------ Disk usage
4542: sub diskusage {
4543: my ($udom,$uname,$directoryRoot)=@_;
4544: $directoryRoot =~ s/\/$//;
4545: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4546: return $listing;
4547: }
4548:
4549: sub is_locked {
4550: my ($file_name, $domain, $user) = @_;
4551: my @check;
4552: my $is_locked;
4553: push @check, $file_name;
4554: my %locked = &get('file_permissions',\@check,
4555: $env{'user.domain'},$env{'user.name'});
4556: my ($tmp)=keys(%locked);
4557: if ($tmp=~/^error:/) { undef(%locked); }
4558:
4559: if (ref($locked{$file_name}) eq 'ARRAY') {
4560: $is_locked = 'false';
4561: foreach my $entry (@{$locked{$file_name}}) {
4562: if (ref($entry) eq 'ARRAY') {
4563: $is_locked = 'true';
4564: last;
4565: }
4566: }
4567: } else {
4568: $is_locked = 'false';
4569: }
4570: }
4571:
4572: # ------------------------------------------------------------- Mark as Read Only
4573:
4574: sub mark_as_readonly {
4575: my ($domain,$user,$files,$what) = @_;
4576: my %current_permissions = &dump('file_permissions',$domain,$user);
4577: my ($tmp)=keys(%current_permissions);
4578: if ($tmp=~/^error:/) { undef(%current_permissions); }
4579: foreach my $file (@{$files}) {
4580: push(@{$current_permissions{$file}},$what);
4581: }
4582: &put('file_permissions',\%current_permissions,$domain,$user);
4583: return;
4584: }
4585:
4586: # ------------------------------------------------------------Save Selected Files
4587:
4588: sub save_selected_files {
4589: my ($user, $path, @files) = @_;
4590: my $filename = $user."savedfiles";
4591: my @other_files = &files_not_in_path($user, $path);
4592: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4593: foreach my $file (@files) {
4594: print (OUT $env{'form.currentpath'}.$file."\n");
4595: }
4596: foreach my $file (@other_files) {
4597: print (OUT $file."\n");
4598: }
4599: close (OUT);
4600: return 'ok';
4601: }
4602:
4603: sub clear_selected_files {
4604: my ($user) = @_;
4605: my $filename = $user."savedfiles";
4606: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4607: print (OUT undef);
4608: close (OUT);
4609: return ("ok");
4610: }
4611:
4612: sub files_in_path {
4613: my ($user, $path) = @_;
4614: my $filename = $user."savedfiles";
4615: my %return_files;
4616: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4617: while (my $line_in = <IN>) {
4618: chomp ($line_in);
4619: my @paths_and_file = split (m!/!, $line_in);
4620: my $file_part = pop (@paths_and_file);
4621: my $path_part = join ('/', @paths_and_file);
4622: $path_part.='/';
4623: my $path_and_file = $path_part.$file_part;
4624: if ($path_part eq $path) {
4625: $return_files{$file_part}= 'selected';
4626: }
4627: }
4628: close (IN);
4629: return (\%return_files);
4630: }
4631:
4632: # called in portfolio select mode, to show files selected NOT in current directory
4633: sub files_not_in_path {
4634: my ($user, $path) = @_;
4635: my $filename = $user."savedfiles";
4636: my @return_files;
4637: my $path_part;
4638: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4639: while (<IN>) {
4640: #ok, I know it's clunky, but I want it to work
4641: my @paths_and_file = split m!/!, $_;
4642: my $file_part = pop (@paths_and_file);
4643: chomp ($file_part);
4644: my $path_part = join ('/', @paths_and_file);
4645: $path_part .= '/';
4646: my $path_and_file = $path_part.$file_part;
4647: if ($path_part ne $path) {
4648: push (@return_files, ($path_and_file));
4649: }
4650: }
4651: close (OUT);
4652: return (@return_files);
4653: }
4654:
4655: #----------------------------------------------Get portfolio file permissions
4656:
4657: sub get_portfile_permissions {
4658: my ($domain,$user) = @_;
4659: my %current_permissions = &dump('file_permissions',$domain,$user);
4660: my ($tmp)=keys(%current_permissions);
4661: if ($tmp=~/^error:/) { undef(%current_permissions); }
4662: return \%current_permissions;
4663: }
4664:
4665: #---------------------------------------------Get portfolio file access controls
4666:
4667: sub get_access_controls {
4668: my ($current_permissions,$group,$file) = @_;
4669: my %access;
4670: if (defined($file)) {
4671: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4672: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4673: $access{$file}{$control} = $$current_permissions{$file."\0".$control};
4674: }
4675: }
4676: } else {
4677: foreach my $key (keys(%{$current_permissions})) {
4678: if ($key =~ /\0accesscontrol$/) {
4679: if (defined($group)) {
4680: if ($key !~ m-^\Q$group\E/-) {
4681: next;
4682: }
4683: }
4684: my ($fullpath) = split(/\0/,$key);
4685: if (ref($$current_permissions{$key}) eq 'HASH') {
4686: foreach my $control (keys(%{$$current_permissions{$key}})) {
4687: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4688: }
4689: }
4690: }
4691: }
4692: }
4693: return %access;
4694: }
4695:
4696: sub parse_access_controls {
4697: my ($access_item) = @_;
4698: my %content;
4699: my $token;
4700: my $parser=HTML::TokeParser->new(\$access_item);
4701: while ($token=$parser->get_token) {
4702: if ($token->[0] eq 'S') {
4703: my $entry=$token->[1];
4704: if ($entry eq 'scope') {
4705: my $type = $token->[2]{'type'};
4706: } else {
4707: my $value=$parser->get_text('/'.$entry);
4708: $content{$entry}=$value;
4709: }
4710: }
4711: }
4712: return %content;
4713: }
4714:
4715: sub modify_access_controls {
4716: my ($file_name,$changes,$domain,$user)=@_;
4717: my ($outcome,$deloutcome);
4718: my %store_permissions;
4719: my %new_values;
4720: my %new_control;
4721: my %translation;
4722: my @deletions = ();
4723: my $now = time;
4724: if (exists($$changes{'activate'})) {
4725: if (ref($$changes{'activate'}) eq 'HASH') {
4726: my @newitems = sort(keys(%{$$changes{'activate'}}));
4727: my $numnew = scalar(@newitems);
4728: for (my $i=0; $i<$numnew; $i++) {
4729: my $newkey = $newitems[$i];
4730: my $newid = &Apache::loncommon::get_cgi_id();
4731: $newkey =~ s/^(\d+)/$newid/;
4732: $translation{$1} = $newid;
4733: $new_values{$file_name."\0".$newkey} =
4734: $$changes{'activate'}{$newitems[$i]};
4735: $new_control{$newkey} = $now;
4736: }
4737: }
4738: }
4739: my %todelete;
4740: my %changed_items;
4741: foreach my $action ('delete','update') {
4742: if (exists($$changes{$action})) {
4743: if (ref($$changes{$action}) eq 'HASH') {
4744: foreach my $key (keys(%{$$changes{$action}})) {
4745: my ($itemnum) = ($key =~ /^([^:]+):/);
4746: if ($action eq 'delete') {
4747: $todelete{$itemnum} = 1;
4748: } else {
4749: $changed_items{$itemnum} = $key;
4750: }
4751: }
4752: }
4753: }
4754: }
4755: # get lock on access controls for file.
4756: my $lockhash = {
4757: $file_name."\0".'locked_access_records' => $env{'user.name'}.
4758: ':'.$env{'user.domain'},
4759: };
4760: my $tries = 0;
4761: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4762:
4763: while (($gotlock ne 'ok') && $tries <3) {
4764: $tries ++;
4765: sleep 1;
4766: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4767: }
4768: if ($gotlock eq 'ok') {
4769: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
4770: my ($tmp)=keys(%curr_permissions);
4771: if ($tmp=~/^error:/) { undef(%curr_permissions); }
4772: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
4773: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
4774: if (ref($curr_controls) eq 'HASH') {
4775: foreach my $control_item (keys(%{$curr_controls})) {
4776: my ($itemnum) = ($control_item =~ /^([^:]+):/);
4777: if (defined($todelete{$itemnum})) {
4778: push(@deletions,$file_name."\0".$control_item);
4779: } else {
4780: if (defined($changed_items{$itemnum})) {
4781: $new_control{$changed_items{$itemnum}} = $now;
4782: push(@deletions,$file_name."\0".$control_item);
4783: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
4784: } else {
4785: $new_control{$control_item} = $$curr_controls{$control_item};
4786: }
4787: }
4788: }
4789: }
4790: }
4791: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
4792: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
4793: $outcome = &put('file_permissions',\%new_values,$domain,$user);
4794: # remove lock
4795: my @del_lock = ($file_name."\0".'locked_access_records');
4796: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
4797: } else {
4798: $outcome = "error: could not obtain lockfile\n";
4799: }
4800: return ($outcome,$deloutcome,\%new_values,\%translation);
4801: }
4802:
4803: #------------------------------------------------------Get Marked as Read Only
4804:
4805: sub get_marked_as_readonly {
4806: my ($domain,$user,$what,$group) = @_;
4807: my $current_permissions = &get_portfile_permissions($domain,$user);
4808: my @readonly_files;
4809: my $cmp1=$what;
4810: if (ref($what)) { $cmp1=join('',@{$what}) };
4811: while (my ($file_name,$value) = each(%{$current_permissions})) {
4812: if (defined($group)) {
4813: if ($file_name !~ m-^\Q$group\E/-) {
4814: next;
4815: }
4816: }
4817: if (ref($value) eq "ARRAY"){
4818: foreach my $stored_what (@{$value}) {
4819: my $cmp2=$stored_what;
4820: if (ref($stored_what eq 'ARRAY')) {
4821: $cmp2=join('',@{$stored_what});
4822: }
4823: if ($cmp1 eq $cmp2) {
4824: push(@readonly_files, $file_name);
4825: last;
4826: } elsif (!defined($what)) {
4827: push(@readonly_files, $file_name);
4828: last;
4829: }
4830: }
4831: }
4832: }
4833: return @readonly_files;
4834: }
4835: #-----------------------------------------------------------Get Marked as Read Only Hash
4836:
4837: sub get_marked_as_readonly_hash {
4838: my ($current_permissions,$group,$what) = @_;
4839: my %readonly_files;
4840: while (my ($file_name,$value) = each(%{$current_permissions})) {
4841: if (defined($group)) {
4842: if ($file_name !~ m-^\Q$group\E/-) {
4843: next;
4844: }
4845: }
4846: if (ref($value) eq "ARRAY"){
4847: foreach my $stored_what (@{$value}) {
4848: if (ref($stored_what) eq 'ARRAY') {
4849: foreach my $lock_descriptor(@{$stored_what}) {
4850: if ($lock_descriptor eq 'graded') {
4851: $readonly_files{$file_name} = 'graded';
4852: } elsif ($lock_descriptor eq 'handback') {
4853: $readonly_files{$file_name} = 'handback';
4854: } else {
4855: if (!exists($readonly_files{$file_name})) {
4856: $readonly_files{$file_name} = 'locked';
4857: }
4858: }
4859: }
4860: }
4861: }
4862: }
4863: }
4864: return %readonly_files;
4865: }
4866: # ------------------------------------------------------------ Unmark as Read Only
4867:
4868: sub unmark_as_readonly {
4869: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4870: # for portfolio submissions, $what contains [$symb,$crsid]
4871: my ($domain,$user,$what,$file_name,$group) = @_;
4872: my $symb_crs = $what;
4873: if (ref($what)) { $symb_crs=join('',@$what); }
4874: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
4875: my ($tmp)=keys(%current_permissions);
4876: if ($tmp=~/^error:/) { undef(%current_permissions); }
4877: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
4878: foreach my $file (@readonly_files) {
4879: if (defined($file_name) && ($file_name ne $file)) { next; }
4880: my $current_locks = $current_permissions{$file};
4881: my @new_locks;
4882: my @del_keys;
4883: if (ref($current_locks) eq "ARRAY"){
4884: foreach my $locker (@{$current_locks}) {
4885: my $compare=$locker;
4886: if (ref($locker) eq 'ARRAY') {
4887: $compare=join('',@{$locker});
4888: if ($compare ne $symb_crs) {
4889: push(@new_locks, $locker);
4890: }
4891: }
4892: }
4893: if (scalar(@new_locks) > 0) {
4894: $current_permissions{$file} = \@new_locks;
4895: } else {
4896: push(@del_keys, $file);
4897: &del('file_permissions',\@del_keys, $domain, $user);
4898: delete($current_permissions{$file});
4899: }
4900: }
4901: }
4902: &put('file_permissions',\%current_permissions,$domain,$user);
4903: return;
4904: }
4905:
4906: # ------------------------------------------------------------ Directory lister
4907:
4908: sub dirlist {
4909: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4910:
4911: $uri=~s/^\///;
4912: $uri=~s/\/$//;
4913: my ($udom, $uname);
4914: (undef,$udom,$uname)=split(/\//,$uri);
4915: if(defined($userdomain)) {
4916: $udom = $userdomain;
4917: }
4918: if(defined($username)) {
4919: $uname = $username;
4920: }
4921:
4922: my $dirRoot = $perlvar{'lonDocRoot'};
4923: if(defined($alternateDirectoryRoot)) {
4924: $dirRoot = $alternateDirectoryRoot;
4925: $dirRoot =~ s/\/$//;
4926: }Clay Greene
4927:
4928: if($udom) {
4929: if($uname) {
4930: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
4931: homeserver($uname,$udom));
4932: my @listing_results;
4933: if ($listing eq 'unknown_cmd') {
4934: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4935: homeserver($uname,$udom));
4936: @listing_results = split(/:/,$listing);
4937: } else {
4938: @listing_results = map { &unescape($_); } split(/:/,$listing);
4939: }
4940: return @listing_results;
4941: } elsif(!defined($alternateDirectoryRoot)) {
4942: my $tryserver;
4943: my %allusers=();
4944: foreach $tryserver (keys %libserv) {
4945: if($hostdom{$tryserver} eq $udom) {
4946: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
4947: $udom, $tryserver);
4948: my @listing_results;
4949: if ($listing eq 'unknown_cmd') {
4950: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4951: $udom, $tryserver);
4952: @listing_results = split(/:/,$listing);
4953: } else {
4954: @listing_results =
4955: map { &unescape($_); } split(/:/,$listing);
4956: }
4957: if ($listing_results[0] ne 'no_such_dir' &&
4958: $listing_results[0] ne 'empty' &&
4959: $listing_results[0] ne 'con_lost') {
4960: foreach (@listing_results) {
4961: my ($entry,@stat)=split(/&/,$_);
4962: $allusers{$entry}=1;
4963: }
4964: }
4965: }
4966: }
4967: my $alluserstr='';
4968: foreach (sort keys %allusers) {
4969: $alluserstr.=$_.'&user:';
4970: }
4971: $alluserstr=~s/:$//;
4972: return split(/:/,$alluserstr);
4973: } else {
4974: my @emptyResults = ();
4975: push(@emptyResults, 'missing user name');
4976: return split(':',@emptyResults);
4977: }
4978: } elsif(!defined($alternateDirectoryRoot)) {
4979: my $tryserver;
4980: my %alldom=();
4981: foreach $tryserver (keys %libserv) {
4982: $alldom{$hostdom{$tryserver}}=1;
4983: }
4984: my $alldomstr='';
4985: foreach (sort keys %alldom) {
4986: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
4987: }
4988: $alldomstr=~s/:$//;
4989: return split(/:/,$alldomstr);
4990: } else {
4991: my @emptyResults = ();
4992: push(@emptyResults, 'missing domain');
4993: return split(':',@emptyResults);
4994: }
4995: }
4996:
4997: # --------------------------------------------- GetFileTimestamp
4998: # This function utilizes dirlist and returns the date stamp for
4999: # when it was last modified. It will also return an error of -1
5000: # if an error occurs
5001:
5002: ##
5003: ## FIXME: This subroutine assumes its caller knows something about the
5004: ## directory structure of the home server for the student ($root).
5005: ## Not a good assumption to make. Since this is for looking up files
5006: ## in user directories, the full path should be constructed by lond, not
5007: ## whatever machine we request data from.
5008: ##
5009: sub GetFileTimestamp {
5010: my ($studentDomain,$studentName,$filename,$root)=@_;
5011: $studentDomain=~s/\W//g;
5012: $studentName=~s/\W//g;
5013: my $subdir=$studentName.'__';
5014: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5015: my $proname="$studentDomain/$subdir/$studentName";
5016: $proname .= '/'.$filename;
5017: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5018: $studentName, $root);
5019: my @stats = split('&', $fileStat);
5020: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5021: # @stats contains first the filename, then the stat output
5022: return $stats[10]; # so this is 10 instead of 9.
5023: } else {
5024: return -1;
5025: }
5026: }
5027:
5028: sub stat_file {
5029: my ($uri) = @_;
5030: $uri = &clutter($uri);
5031:
5032: # we want just the url part without the unneeded accessor url bits
5033: if ($uri =~ m-^/adm/-) {
5034: $uri=~s-^/adm/wrapper/-/-;
5035: $uri=~s-^/adm/coursedocs/showdoc/-/-;
5036: }
5037: my ($udom,$uname,$file,$dir);
5038: if ($uri =~ m-^/(uploaded|editupload)/-) {
5039: ($udom,$uname,$file) =
5040: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5041: $file = 'userfiles/'.$file;
5042: $dir = &propath($udom,$uname);
5043: }
5044: if ($uri =~ m-^/res/-) {
5045: ($udom,$uname) =
5046: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5047: $file = $uri;
5048: }
5049:
5050: if (!$udom || !$uname || !$file) {
5051: # unable to handle the uri
5052: return ();
5053: }
5054:
5055: my ($result) = &dirlist($file,$udom,$uname,$dir);
5056: my @stats = split('&', $result);
5057:
5058: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5059: shift(@stats); #filename is first
5060: return @stats;
5061: }
5062: return ();
5063: }
5064:
5065: # -------------------------------------------------------- Value of a Condition
5066:
5067: # gets the value of a specific preevaluated condition
5068: # stored in the string $env{user.state.<cid>}
5069: # or looks up a condition reference in the bighash and if if hasn't
5070: # already been evaluated recurses into docondval to get the value of
5071: # the condition, then memoizing it to
5072: # $env{user.state.<cid>.<condition>}
5073: sub directcondval {
5074: my $number=shift;
5075: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5076: &Apache::lonuserstate::evalstate();
5077: }
5078: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5079: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5080: } elsif ($number =~ /^_/) {
5081: my $sub_condition;
5082: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5083: &GDBM_READER(),0640)) {
5084: $sub_condition=$bighash{'conditions'.$number};
5085: untie(%bighash);
5086: }
5087: my $value = &docondval($sub_condition);
5088: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5089: return $value;
5090: }
5091: if ($env{'user.state.'.$env{'request.course.id'}}) {
5092: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5093: } else {
5094: return 2;
5095: }
5096: }
5097:
5098: # get the collection of conditions for this resource
5099: sub condval {
5100: my $condidx=shift;
5101: my $allpathcond='';
5102: foreach my $cond (split(/\|/,$condidx)) {
5103: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5104: $allpathcond.=
5105: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5106: }
5107: }
5108: $allpathcond=~s/\|$//;
5109: return &docondval($allpathcond);
5110: }
5111:
5112: #evaluates an expression of conditions
5113: sub docondval {
5114: my ($allpathcond) = @_;
5115: my $result=0;
5116: if ($env{'request.course.id'}
5117: && defined($allpathcond)) {
5118: my $operand='|';
5119: my @stack;
5120: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5121: if ($chunk eq '(') {
5122: push @stack,($operand,$result);
5123: } elsif ($chunk eq ')') {
5124: my $before=pop @stack;
5125: if (pop @stack eq '&') {
5126: $result=$result>$before?$before:$result;
5127: } else {
5128: $result=$result>$before?$result:$before;
5129: }
5130: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5131: $operand=$chunk;
5132: } else {
5133: my $new=directcondval($chunk);
5134: if ($operand eq '&') {
5135: $result=$result>$new?$new:$result;
5136: } else {
5137: $result=$result>$new?$result:$new;
5138: }
5139: }
5140: }
5141: }
5142: return $result;
5143: }
5144:
5145: # ---------------------------------------------------- Devalidate courseresdata
5146:
5147: sub devalidatecourseresdata {
5148: my ($coursenum,$coursedomain)=@_;
5149: my $hashid=$coursenum.':'.$coursedomain;
5150: &devalidate_cache_new('courseres',$hashid);
5151: }
5152:
5153: # --------------------------------------------------- Course Resourcedata Query
5154:
5155: sub get_courseresdata {
5156: my ($coursenum,$coursedomain)=@_;
5157: my $coursehom=&homeserver($coursenum,$coursedomain);
5158: my $hashid=$coursenum.':'.$coursedomain;
5159: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5160: my %dumpreply;
5161: unless (defined($cached)) {
5162: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5163: $result=\%dumpreply;
5164: my ($tmp) = keys(%dumpreply);
5165: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5166: &do_cache_new('courseres',$hashid,$result,600);
5167: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5168: return $tmp;
5169: } elsif ($tmp =~ /^(error)/) {
5170: $result=undef;
5171: &do_cache_new('courseres',$hashid,$result,600);
5172: }
5173: }
5174: return $result;
5175: }
5176:
5177: sub devalidateuserresdata {
5178: my ($uname,$udom)=@_;
5179: my $hashid="$udom:$uname";
5180: &devalidate_cache_new('userres',$hashid);
5181: }
5182:
5183: sub get_userresdata {
5184: my ($uname,$udom)=@_;
5185: #most student don\'t have any data set, check if there is some data
5186: if (&EXT_cache_status($udom,$uname)) { return undef; }
5187:
5188: my $hashid="$udom:$uname";
5189: my ($result,$cached)=&is_cached_new('userres',$hashid);
5190: if (!defined($cached)) {
5191: my %resourcedata=&dump('resourcedata',$udom,$uname);
5192: $result=\%resourcedata;
5193: &do_cache_new('userres',$hashid,$result,600);
5194: }
5195: my ($tmp)=keys(%$result);
5196: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5197: return $result;
5198: }
5199: #error 2 occurs when the .db doesn't exist
5200: if ($tmp!~/error: 2 /) {
5201: &logthis("<font color=\"blue\">WARNING:".
5202: " Trying to get resource data for ".
5203: $uname." at ".$udom.": ".
5204: $tmp."</font>");
5205: } elsif ($tmp=~/error: 2 /) {
5206: #&EXT_cache_set($udom,$uname);
5207: &do_cache_new('userres',$hashid,undef,600);
5208: undef($tmp); # not really an error so don't send it back
5209: }
5210: return $tmp;
5211: }
5212:
5213: sub resdata {
5214: my ($name,$domain,$type,@which)=@_;
5215: my $result;
5216: if ($type eq 'course') {
5217: $result=&get_courseresdata($name,$domain);
5218: } elsif ($type eq 'user') {
5219: $result=&get_userresdata($name,$domain);
5220: }
5221: if (!ref($result)) { return $result; }
5222: foreach my $item (@which) {
5223: if (defined($result->{$item})) {
5224: return $result->{$item};
5225: }
5226: }
5227: return undef;
5228: }
5229:
5230: #
5231: # EXT resource caching routines
5232: #
5233:
5234: sub clear_EXT_cache_status {
5235: &delenv('cache.EXT.');
5236: }
5237:
5238: sub EXT_cache_status {
5239: my ($target_domain,$target_user) = @_;
5240: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5241: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5242: # We know already the user has no data
5243: return 1;
5244: } else {
5245: return 0;
5246: }
5247: }
5248:
5249: sub EXT_cache_set {
5250: my ($target_domain,$target_user) = @_;
5251: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5252: #&appenv($cachename => time);
5253: }
5254:
5255: # --------------------------------------------------------- Value of a Variable
5256: sub EXT {
5257:
5258: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5259: unless ($varname) { return ''; }
5260: #get real user name/domain, courseid and symb
5261: my $courseid;
5262: my $publicuser;
5263: if ($symbparm) {
5264: $symbparm=&get_symb_from_alias($symbparm);
5265: }
5266: if (!($uname && $udom)) {
5267: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
5268: &Apache::lonxml::whichuser($symbparm);
5269: if (!$symbparm) { $symbparm=$cursymb; }
5270: } else {
5271: $courseid=$env{'request.course.id'};
5272: }
5273: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5274: my $rest;
5275: if (defined($therest[0])) {
5276: $rest=join('.',@therest);
5277: } else {
5278: $rest='';
5279: }
5280:
5281: my $qualifierrest=$qualifier;
5282: if ($rest) { $qualifierrest.='.'.$rest; }
5283: my $spacequalifierrest=$space;
5284: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5285: if ($realm eq 'user') {
5286: # --------------------------------------------------------------- user.resource
5287: if ($space eq 'resource') {
5288: if ( (defined($Apache::lonhomework::parsing_a_problem)
5289: || defined($Apache::lonhomework::parsing_a_task))
5290: &&
5291: ($symbparm eq &symbread()) ) {
5292: # if we are in the middle of processing the resource the
5293: # get the value we are planning on committing
5294: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5295: return $Apache::lonhomework::results{$qualifierrest};
5296: } else {
5297: return $Apache::lonhomework::history{$qualifierrest};
5298: }
5299: } else {
5300: my %restored;
5301: if ($publicuser || $env{'request.state'} eq 'construct') {
5302: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5303: } else {
5304: %restored=&restore($symbparm,$courseid,$udom,$uname);
5305: }
5306: return $restored{$qualifierrest};
5307: }
5308: # ----------------------------------------------------------------- user.access
5309: } elsif ($space eq 'access') {
5310: # FIXME - not supporting calls for a specific user
5311: return &allowed($qualifier,$rest);
5312: # ------------------------------------------ user.preferences, user.environment
5313: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5314: if (($uname eq $env{'user.name'}) &&
5315: ($udom eq $env{'user.domain'})) {
5316: return $env{join('.',('environment',$qualifierrest))};
5317: } else {
5318: my %returnhash;
5319: if (!$publicuser) {
5320: %returnhash=&userenvironment($udom,$uname,
5321: $qualifierrest);
5322: }
5323: return $returnhash{$qualifierrest};
5324: }
5325: # ----------------------------------------------------------------- user.course
5326: } elsif ($space eq 'course') {
5327: # FIXME - not supporting calls for a specific user
5328: return $env{join('.',('request.course',$qualifier))};
5329: # ------------------------------------------------------------------- user.role
5330: } elsif ($space eq 'role') {
5331: # FIXME - not supporting calls for a specific user
5332: my ($role,$where)=split(/\./,$env{'request.role'});
5333: if ($qualifier eq 'value') {
5334: return $role;
5335: } elsif ($qualifier eq 'extent') {
5336: return $where;
5337: }
5338: # ----------------------------------------------------------------- user.domain
5339: } elsif ($space eq 'domain') {
5340: return $udom;
5341: # ------------------------------------------------------------------- user.name
5342: } elsif ($space eq 'name') {
5343: return $uname;
5344: # ---------------------------------------------------- Any other user namespace
5345: } else {
5346: my %reply;
5347: if (!$publicuser) {
5348: %reply=&get($space,[$qualifierrest],$udom,$uname);
5349: }
5350: return $reply{$qualifierrest};
5351: }
5352: } elsif ($realm eq 'query') {
5353: # ---------------------------------------------- pull stuff out of query string
5354: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5355: [$spacequalifierrest]);
5356: return $env{'form.'.$spacequalifierrest};
5357: } elsif ($realm eq 'request') {
5358: # ------------------------------------------------------------- request.browser
5359: if ($space eq 'browser') {
5360: if ($qualifier eq 'textremote') {
5361: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5362: return 1;
5363: } else {
5364: return 0;
5365: }
5366: } else {
5367: return $env{'browser.'.$qualifier};
5368: }
5369: # ------------------------------------------------------------ request.filename
5370: } else {
5371: return $env{'request.'.$spacequalifierrest};
5372: }
5373: } elsif ($realm eq 'course') {
5374: # ---------------------------------------------------------- course.description
5375: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5376: } elsif ($realm eq 'resource') {
5377:
5378: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5379: if (!$symbparm) { $symbparm=&symbread(); }
5380: }
5381:
5382: if ($space eq 'title') {
5383: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5384: return &gettitle($symbparm);
5385: }
5386:
5387: if ($space eq 'map') {
5388: my ($map) = &decode_symb($symbparm);
5389: return &symbread($map);
5390: }
5391:
5392: my ($section, $group, @groups);
5393: my ($courselevelm,$courselevel);
5394: if ($symbparm && defined($courseid) &&
5395: $courseid eq $env{'request.course.id'}) {
5396:
5397: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5398:
5399: # ----------------------------------------------------- Cascading lookup scheme
5400: my $symbp=$symbparm;
5401: my $mapp=&deversion((&decode_symb($symbp))[0]);
5402:
5403: my $symbparm=$symbp.'.'.$spacequalifierrest;
5404: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5405:
5406: if (($env{'user.name'} eq $uname) &&
5407: ($env{'user.domain'} eq $udom)) {
5408: $section=$env{'request.course.sec'};
5409: @groups = split(/:/,$env{'request.course.groups'});
5410: @groups=&sort_course_groups($courseid,@groups);
5411: } else {
5412: if (! defined($usection)) {
5413: $section=&getsection($udom,$uname,$courseid);
5414: } else {
5415: $section = $usection;
5416: }
5417: @groups = &get_users_groups($udom,$uname,$courseid);
5418: }
5419:
5420: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5421: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5422: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5423:
5424: $courselevel=$courseid.'.'.$spacequalifierrest;
5425: my $courselevelr=$courseid.'.'.$symbparm;
5426: $courselevelm=$courseid.'.'.$mapparm;
5427:
5428: # ----------------------------------------------------------- first, check user
5429:
5430: my $userreply=&resdata($uname,$udom,'user',
5431: ($courselevelr,$courselevelm,
5432: $courselevel));
5433: if (defined($userreply)) { return $userreply; }
5434:
5435: # ------------------------------------------------ second, check some of course
5436: my $coursereply;
5437: if (@groups > 0) {
5438: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5439: $mapparm,$spacequalifierrest);
5440: if (defined($coursereply)) { return $coursereply; }
5441: }
5442:
5443: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5444: $env{'course.'.$courseid.'.domain'},
5445: 'course',
5446: ($seclevelr,$seclevelm,$seclevel,
5447: $courselevelr));
5448: if (defined($coursereply)) { return $coursereply; }
5449:
5450: # ------------------------------------------------------ third, check map parms
5451: my %parmhash=();
5452: my $thisparm='';
5453: if (tie(%parmhash,'GDBM_File',
5454: $env{'request.course.fn'}.'_parms.db',
5455: &GDBM_READER(),0640)) {
5456: $thisparm=$parmhash{$symbparm};
5457: untie(%parmhash);
5458: }
5459: if ($thisparm) { return $thisparm; }
5460: }
5461: # ------------------------------------------ fourth, look in resource metadata
5462:
5463: $spacequalifierrest=~s/\./\_/;
5464: my $filename;
5465: if (!$symbparm) { $symbparm=&symbread(); }
5466: if ($symbparm) {
5467: $filename=(&decode_symb($symbparm))[2];
5468: } else {
5469: $filename=$env{'request.filename'};
5470: }
5471: my $metadata=&metadata($filename,$spacequalifierrest);
5472: if (defined($metadata)) { return $metadata; }
5473: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5474: if (defined($metadata)) { return $metadata; }
5475:
5476: # ---------------------------------------------- fourth, look in rest pf course
5477: if ($symbparm && defined($courseid) &&
5478: $courseid eq $env{'request.course.id'}) {
5479: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5480: $env{'course.'.$courseid.'.domain'},
5481: 'course',
5482: ($courselevelm,$courselevel));
5483: if (defined($coursereply)) { return $coursereply; }
5484: }
5485: # ------------------------------------------------------------------ Cascade up
5486: unless ($space eq '0') {
5487: my @parts=split(/_/,$space);
5488: my $id=pop(@parts);
5489: my $part=join('_',@parts);
5490: if ($part eq '') { $part='0'; }
5491: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5492: $symbparm,$udom,$uname,$section,1);
5493: if (defined($partgeneral)) { return $partgeneral; }
5494: }
5495: if ($recurse) { return undef; }
5496: my $pack_def=&packages_tab_default($filename,$varname);
5497: if (defined($pack_def)) { return $pack_def; }
5498:
5499: # ---------------------------------------------------- Any other user namespace
5500: } elsif ($realm eq 'environment') {
5501: # ----------------------------------------------------------------- environment
5502: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5503: return $env{'environment.'.$spacequalifierrest};
5504: } else {
5505: my %returnhash=&userenvironment($udom,$uname,
5506: $spacequalifierrest);
5507: return $returnhash{$spacequalifierrest};
5508: }
5509: } elsif ($realm eq 'system') {
5510: # ----------------------------------------------------------------- system.time
5511: if ($space eq 'time') {
5512: return time;
5513: }
5514: } elsif ($realm eq 'server') {
5515: # ----------------------------------------------------------------- system.time
5516: if ($space eq 'name') {
5517: return $ENV{'SERVER_NAME'};
5518: }
5519: }
5520: return '';
5521: }
5522:
5523: sub check_group_parms {
5524: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5525: my @groupitems = ();
5526: my $resultitem;
5527: my @levels = ($symbparm,$mapparm,$what);
5528: foreach my $group (@{$groups}) {
5529: foreach my $level (@levels) {
5530: my $item = $courseid.'.['.$group.'].'.$level;
5531: push(@groupitems,$item);
5532: }
5533: }
5534: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5535: $env{'course.'.$courseid.'.domain'},
5536: 'course',@groupitems);
5537: return $coursereply;
5538: }
5539:
5540: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5541: my ($courseid,@groups) = @_;
5542: @groups = sort(@groups);
5543: return @groups;
5544: }
5545:
5546: sub packages_tab_default {
5547: my ($uri,$varname)=@_;
5548: my (undef,$part,$name)=split(/\./,$varname);
5549:
5550: my (@extension,@specifics,$do_default);
5551: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5552: my ($pack_type,$pack_part)=split(/_/,$package,2);
5553: if ($pack_type eq 'default') {
5554: $do_default=1;
5555: } elsif ($pack_type eq 'extension') {
5556: push(@extension,[$package,$pack_type,$pack_part]);
5557: } else {
5558: push(@specifics,[$package,$pack_type,$pack_part]);
5559: }
5560: }
5561: # first look for a package that matches the requested part id
5562: foreach my $package (@specifics) {
5563: my (undef,$pack_type,$pack_part)=@{$package};
5564: next if ($pack_part ne $part);
5565: if (defined($packagetab{"$pack_type&$name&default"})) {
5566: return $packagetab{"$pack_type&$name&default"};
5567: }
5568: }
5569: # look for any possible matching non extension_ package
5570: foreach my $package (@specifics) {
5571: my (undef,$pack_type,$pack_part)=@{$package};
5572: if (defined($packagetab{"$pack_type&$name&default"})) {
5573: return $packagetab{"$pack_type&$name&default"};
5574: }
5575: if ($pack_type eq 'part') { $pack_part='0'; }
5576: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5577: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5578: }
5579: }
5580: # look for any posible extension_ match
5581: foreach my $package (@extension) {
5582: my ($package,$pack_type)=@{$package};
5583: if (defined($packagetab{"$pack_type&$name&default"})) {
5584: return $packagetab{"$pack_type&$name&default"};
5585: }
5586: if (defined($packagetab{$package."&$name&default"})) {
5587: return $packagetab{$package."&$name&default"};
5588: }
5589: }
5590: # look for a global default setting
5591: if ($do_default && defined($packagetab{"default&$name&default"})) {
5592: return $packagetab{"default&$name&default"};
5593: }
5594: return undef;
5595: }
5596:
5597: sub add_prefix_and_part {
5598: my ($prefix,$part)=@_;
5599: my $keyroot;
5600: if (defined($prefix) && $prefix !~ /^__/) {
5601: # prefix that has a part already
5602: $keyroot=$prefix;
5603: } elsif (defined($prefix)) {
5604: # prefix that is missing a part
5605: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5606: } else {
5607: # no prefix at all
5608: if (defined($part)) { $keyroot='_'.$part; }
5609: }
5610: return $keyroot;
5611: }
5612:
5613: # ---------------------------------------------------------------- Get metadata
5614:
5615: my %metaentry;
5616: sub metadata {
5617: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
5618: $uri=&declutter($uri);
5619: # if it is a non metadata possible uri return quickly
5620: if (($uri eq '') ||
5621: (($uri =~ m|^/*adm/|) &&
5622: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
5623: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
5624: ($uri =~ m|home/[^/]+/public_html/|)) {
5625: return undef;
5626: }
5627: my $filename=$uri;
5628: $uri=~s/\.meta$//;
5629: #
5630: # Is the metadata already cached?
5631: # Look at timestamp of caching
5632: # Everything is cached by the main uri, libraries are never directly cached
5633: #
5634: if (!defined($liburi)) {
5635: my ($result,$cached)=&is_cached_new('meta',$uri);
5636: if (defined($cached)) { return $result->{':'.$what}; }
5637: }
5638: {
5639: #
5640: # Is this a recursive call for a library?
5641: #
5642: # if (! exists($metacache{$uri})) {
5643: # $metacache{$uri}={};
5644: # }
5645: if ($liburi) {
5646: $liburi=&declutter($liburi);
5647: $filename=$liburi;
5648: } else {
5649: &devalidate_cache_new('meta',$uri);
5650: undef(%metaentry);
5651: }
5652: my %metathesekeys=();
5653: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
5654: my $metastring;
5655: if ($uri !~ m -^(uploaded|editupload)/-) {
5656: my $file=&filelocation('',&clutter($filename));
5657: #push(@{$metaentry{$uri.'.file'}},$file);
5658: $metastring=&getfile($file);
5659: }
5660: my $parser=HTML::LCParser->new(\$metastring);
5661: my $token;
5662: undef %metathesekeys;
5663: while ($token=$parser->get_token) {
5664: if ($token->[0] eq 'S') {
5665: if (defined($token->[2]->{'package'})) {
5666: #
5667: # This is a package - get package info
5668: #
5669: my $package=$token->[2]->{'package'};
5670: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5671: if (defined($token->[2]->{'id'})) {
5672: $keyroot.='_'.$token->[2]->{'id'};
5673: }
5674: if ($metaentry{':packages'}) {
5675: $metaentry{':packages'}.=','.$package.$keyroot;
5676: } else {
5677: $metaentry{':packages'}=$package.$keyroot;
5678: }
5679: foreach my $pack_entry (keys(%packagetab)) {
5680: my $part=$keyroot;
5681: $part=~s/^\_//;
5682: if ($pack_entry=~/^\Q$package\E\&/ ||
5683: $pack_entry=~/^\Q$package\E_0\&/) {
5684: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
5685: # ignore package.tab specified default values
5686: # here &package_tab_default() will fetch those
5687: if ($subp eq 'default') { next; }
5688: my $value=$packagetab{$pack_entry};
5689: my $unikey;
5690: if ($pack =~ /_0$/) {
5691: $unikey='parameter_0_'.$name;
5692: $part=0;
5693: } else {
5694: $unikey='parameter'.$keyroot.'_'.$name;
5695: }
5696: if ($subp eq 'display') {
5697: $value.=' [Part: '.$part.']';
5698: }
5699: $metaentry{':'.$unikey.'.part'}=$part;
5700: $metathesekeys{$unikey}=1;
5701: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5702: $metaentry{':'.$unikey.'.'.$subp}=$value;
5703: }
5704: if (defined($metaentry{':'.$unikey.'.default'})) {
5705: $metaentry{':'.$unikey}=
5706: $metaentry{':'.$unikey.'.default'};
5707: }
5708: }
5709: }
5710: } else {
5711: #
5712: # This is not a package - some other kind of start tag
5713: #
5714: my $entry=$token->[1];
5715: my $unikey;
5716: if ($entry eq 'import') {
5717: $unikey='';
5718: } else {
5719: $unikey=$entry;
5720: }
5721: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5722:
5723: if (defined($token->[2]->{'id'})) {
5724: $unikey.='_'.$token->[2]->{'id'};
5725: }
5726:
5727: if ($entry eq 'import') {
5728: #
5729: # Importing a library here
5730: #
5731: if ($depthcount<20) {
5732: my $location=$parser->get_text('/import');
5733: my $dir=$filename;
5734: $dir=~s|[^/]*$||;
5735: $location=&filelocation($dir,$location);
5736: my $metadata =
5737: &metadata($uri,'keys', $location,$unikey,
5738: $depthcount+1);
5739: foreach my $meta (split(',',$metadata)) {
5740: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5741: $metathesekeys{$meta}=1;
5742: }
5743: }
5744: } else {
5745:
5746: if (defined($token->[2]->{'name'})) {
5747: $unikey.='_'.$token->[2]->{'name'};
5748: }
5749: $metathesekeys{$unikey}=1;
5750: foreach my $param (@{$token->[3]}) {
5751: $metaentry{':'.$unikey.'.'.$param} =
5752: $token->[2]->{$param};
5753: }
5754: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
5755: my $default=$metaentry{':'.$unikey.'.default'};
5756: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5757: # only ws inside the tag, and not in default, so use default
5758: # as value
5759: $metaentry{':'.$unikey}=$default;
5760: } else {
5761: # either something interesting inside the tag or default
5762: # uninteresting
5763: $metaentry{':'.$unikey}=$internaltext;
5764: }
5765: # end of not-a-package not-a-library import
5766: }
5767: # end of not-a-package start tag
5768: }
5769: # the next is the end of "start tag"
5770: }
5771: }
5772: my ($extension) = ($uri =~ /\.(\w+)$/);
5773: foreach my $key (keys(%packagetab)) {
5774: #no specific packages #how's our extension
5775: if ($key!~/^extension_\Q$extension\E&/) { next; }
5776: &metadata_create_package_def($uri,$key,'extension_'.$extension,
5777: \%metathesekeys);
5778: }
5779: if (!exists($metaentry{':packages'})) {
5780: foreach my $key (keys(%packagetab)) {
5781: #no specific packages well let's get default then
5782: if ($key!~/^default&/) { next; }
5783: &metadata_create_package_def($uri,$key,'default',
5784: \%metathesekeys);
5785: }
5786: }
5787: # are there custom rights to evaluate
5788: if ($metaentry{':copyright'} eq 'custom') {
5789:
5790: #
5791: # Importing a rights file here
5792: #
5793: unless ($depthcount) {
5794: my $location=$metaentry{':customdistributionfile'};
5795: my $dir=$filename;
5796: $dir=~s|[^/]*$||;
5797: $location=&filelocation($dir,$location);
5798: my $rights_metadata =
5799: &metadata($uri,'keys',$location,'_rights',
5800: $depthcount+1);
5801: foreach my $rights (split(',',$rights_metadata)) {
5802: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
5803: $metathesekeys{$rights}=1;
5804: }
5805: }
5806: }
5807: # uniqifiy package listing
5808: my %seen;
5809: my @uniq_packages =
5810: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
5811: $metaentry{':packages'} = join(',',@uniq_packages);
5812:
5813: $metaentry{':keys'} = join(',',keys(%metathesekeys));
5814: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5815: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
5816: &do_cache_new('meta',$uri,\%metaentry,60*60);
5817: # this is the end of "was not already recently cached
5818: }
5819: return $metaentry{':'.$what};
5820: }
5821:
5822: sub metadata_create_package_def {
5823: my ($uri,$key,$package,$metathesekeys)=@_;
5824: my ($pack,$name,$subp)=split(/\&/,$key);
5825: if ($subp eq 'default') { next; }
5826:
5827: if (defined($metaentry{':packages'})) {
5828: $metaentry{':packages'}.=','.$package;
5829: } else {
5830: $metaentry{':packages'}=$package;
5831: }
5832: my $value=$packagetab{$key};
5833: my $unikey;
5834: $unikey='parameter_0_'.$name;
5835: $metaentry{':'.$unikey.'.part'}=0;
5836: $$metathesekeys{$unikey}=1;
5837: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5838: $metaentry{':'.$unikey.'.'.$subp}=$value;
5839: }
5840: if (defined($metaentry{':'.$unikey.'.default'})) {
5841: $metaentry{':'.$unikey}=
5842: $metaentry{':'.$unikey.'.default'};
5843: }
5844: }
5845:
5846: sub metadata_generate_part0 {
5847: my ($metadata,$metacache,$uri) = @_;
5848: my %allnames;
5849: foreach my $metakey (keys(%$metadata)) {
5850: if ($metakey=~/^parameter\_(.*)/) {
5851: my $part=$$metacache{':'.$metakey.'.part'};
5852: my $name=$$metacache{':'.$metakey.'.name'};
5853: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
5854: $allnames{$name}=$part;
5855: }
5856: }
5857: }
5858: foreach my $name (keys(%allnames)) {
5859: $$metadata{"parameter_0_$name"}=1;
5860: my $key=":parameter_0_$name";
5861: $$metacache{"$key.part"}='0';
5862: $$metacache{"$key.name"}=$name;
5863: $$metacache{"$key.type"}=$$metacache{':parameter_'.
5864: $allnames{$name}.'_'.$name.
5865: '.type'};
5866: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
5867: '.display'};
5868: my $expr='[Part: '.$allnames{$name}.']';
5869: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
5870: $$metacache{"$key.display"}=$olddis;
5871: }
5872: }
5873:
5874: # ------------------------------------------------- Get the title of a resource
5875:
5876: sub gettitle {
5877: my $urlsymb=shift;
5878: my $symb=&symbread($urlsymb);
5879: if ($symb) {
5880: my $key=$env{'request.course.id'}."\0".$symb;
5881: my ($result,$cached)=&is_cached_new('title',$key);
5882: if (defined($cached)) {
5883: return $result;
5884: }
5885: my ($map,$resid,$url)=&decode_symb($symb);
5886: my $title='';
5887: my %bighash;
5888: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5889: &GDBM_READER(),0640)) {
5890: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5891: $title=$bighash{'title_'.$mapid.'.'.$resid};
5892: untie %bighash;
5893: }
5894: $title=~s/\&colon\;/\:/gs;
5895: if ($title) {
5896: return &do_cache_new('title',$key,$title,600);
5897: }
5898: $urlsymb=$url;
5899: }
5900: my $title=&metadata($urlsymb,'title');
5901: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5902: return $title;
5903: }
5904:
5905: sub get_slot {
5906: my ($which,$cnum,$cdom)=@_;
5907: if (!$cnum || !$cdom) {
5908: (undef,my $courseid)=&Apache::lonxml::whichuser();
5909: $cdom=$env{'course.'.$courseid.'.domain'};
5910: $cnum=$env{'course.'.$courseid.'.num'};
5911: }
5912: my $key=join("\0",'slots',$cdom,$cnum,$which);
5913: my %slotinfo;
5914: if (exists($remembered{$key})) {
5915: $slotinfo{$which} = $remembered{$key};
5916: } else {
5917: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5918: &Apache::lonhomework::showhash(%slotinfo);
5919: my ($tmp)=keys(%slotinfo);
5920: if ($tmp=~/^error:/) { return (); }
5921: $remembered{$key} = $slotinfo{$which};
5922: }
5923: if (ref($slotinfo{$which}) eq 'HASH') {
5924: return %{$slotinfo{$which}};
5925: }
5926: return $slotinfo{$which};
5927: }
5928: # ------------------------------------------------- Update symbolic store links
5929:
5930: sub symblist {
5931: my ($mapname,%newhash)=@_;
5932: $mapname=&deversion(&declutter($mapname));
5933: my %hash;
5934: if (($env{'request.course.fn'}) && (%newhash)) {
5935: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
5936: &GDBM_WRCREAT(),0640)) {
5937: foreach my $url (keys %newhash) {
5938: next if ($url eq 'last_known'
5939: && $env{'form.no_update_last_known'});
5940: $hash{declutter($url)}=&encode_symb($mapname,
5941: $newhash{$url}->[1],
5942: $newhash{$url}->[0]);
5943: }
5944: if (untie(%hash)) {
5945: return 'ok';
5946: }
5947: }
5948: }
5949: return 'error';
5950: }
5951:
5952: # --------------------------------------------------------------- Verify a symb
5953:
5954: sub symbverify {
5955: my ($symb,$thisurl)=@_;
5956: my $thisfn=$thisurl;
5957: # wrapper not part of symbs
5958: $thisfn=~s/^\/adm\/wrapper//;
5959: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
5960: $thisfn=&declutter($thisfn);
5961: # direct jump to resource in page or to a sequence - will construct own symbs
5962: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
5963: # check URL part
5964: my ($map,$resid,$url)=&decode_symb($symb);
5965:
5966: unless ($url eq $thisfn) { return 0; }
5967:
5968: $symb=&symbclean($symb);
5969: $thisurl=&deversion($thisurl);
5970: $thisfn=&deversion($thisfn);
5971:
5972: my %bighash;
5973: my $okay=0;
5974:
5975: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5976: &GDBM_READER(),0640)) {
5977: my $ids=$bighash{'ids_'.&clutter($thisurl)};
5978: unless ($ids) {
5979: $ids=$bighash{'ids_/'.$thisurl};
5980: }
5981: if ($ids) {
5982: # ------------------------------------------------------------------- Has ID(s)
5983: foreach (split(/\,/,$ids)) {
5984: my ($mapid,$resid)=split(/\./,$_);
5985: if (
5986: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
5987: eq $symb) {
5988: if (($env{'request.role.adv'}) ||
5989: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
5990: $okay=1;
5991: }
5992: }
5993: }
5994: }
5995: untie(%bighash);
5996: }
5997: return $okay;
5998: }
5999:
6000: # --------------------------------------------------------------- Clean-up symb
6001:
6002: sub symbclean {
6003: my $symb=shift;
6004: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6005: # remove version from map
6006: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6007:
6008: # remove version from URL
6009: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6010:
6011: # remove wrapper
6012:
6013: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6014: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6015: return $symb;
6016: }
6017:
6018: # ---------------------------------------------- Split symb to find map and url
6019:
6020: sub encode_symb {
6021: my ($map,$resid,$url)=@_;
6022: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6023: }
6024:
6025: sub decode_symb {
6026: my $symb=shift;
6027: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6028: my ($map,$resid,$url)=split(/___/,$symb);
6029: return (&fixversion($map),$resid,&fixversion($url));
6030: }
6031:
6032: sub fixversion {
6033: my $fn=shift;
6034: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6035: my %bighash;
6036: my $uri=&clutter($fn);
6037: my $key=$env{'request.course.id'}.'_'.$uri;
6038: # is this cached?
6039: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6040: if (defined($cached)) { return $result; }
6041: # unfortunately not cached, or expired
6042: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6043: &GDBM_READER(),0640)) {
6044: if ($bighash{'version_'.$uri}) {
6045: my $version=$bighash{'version_'.$uri};
6046: unless (($version eq 'mostrecent') ||
6047: ($version==&getversion($uri))) {
6048: $uri=~s/\.(\w+)$/\.$version\.$1/;
6049: }
6050: }
6051: untie %bighash;
6052: }
6053: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6054: }
6055:
6056: sub deversion {
6057: my $url=shift;
6058: $url=~s/\.\d+\.(\w+)$/\.$1/;
6059: return $url;
6060: }
6061:
6062: # ------------------------------------------------------ Return symb list entry
6063:
6064: sub symbread {
6065: my ($thisfn,$donotrecurse)=@_;
6066: my $cache_str='request.symbread.cached.'.$thisfn;
6067: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6068: # no filename provided? try from environment
6069: unless ($thisfn) {
6070: if ($env{'request.symb'}) {
6071: return $env{$cache_str}=&symbclean($env{'request.symb'});
6072: }
6073: $thisfn=$env{'request.filename'};
6074: }
6075: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6076: # is that filename actually a symb? Verify, clean, and return
6077: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6078: if (&symbverify($thisfn,$1)) {
6079: return $env{$cache_str}=&symbclean($thisfn);
6080: }
6081: }
6082: $thisfn=declutter($thisfn);
6083: my %hash;
6084: my %bighash;
6085: my $syval='';
6086: if (($env{'request.course.fn'}) && ($thisfn)) {
6087: my $targetfn = $thisfn;
6088: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6089: $targetfn = 'adm/wrapper/'.$thisfn;
6090: }
6091: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6092: $targetfn=$1;
6093: }
6094: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6095: &GDBM_READER(),0640)) {
6096: $syval=$hash{$targetfn};
6097: untie(%hash);
6098: }
6099: # ---------------------------------------------------------- There was an entry
6100: if ($syval) {
6101: #unless ($syval=~/\_\d+$/) {
6102: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6103: #&appenv('request.ambiguous' => $thisfn);
6104: #return $env{$cache_str}='';
6105: #}
6106: #$syval.=$1;
6107: #}
6108: } else {
6109: # ------------------------------------------------------- Was not in symb table
6110: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6111: &GDBM_READER(),0640)) {
6112: # ---------------------------------------------- Get ID(s) for current resource
6113: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6114: unless ($ids) {
6115: $ids=$bighash{'ids_/'.$thisfn};
6116: }
6117: unless ($ids) {
6118: # alias?
6119: $ids=$bighash{'mapalias_'.$thisfn};
6120: }
6121: if ($ids) {
6122: # ------------------------------------------------------------------- Has ID(s)
6123: my @possibilities=split(/\,/,$ids);
6124: if ($#possibilities==0) {
6125: # ----------------------------------------------- There is only one possibility
6126: my ($mapid,$resid)=split(/\./,$ids);
6127: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6128: $resid,$thisfn);
6129: } elsif (!$donotrecurse) {
6130: # ------------------------------------------ There is more than one possibility
6131: my $realpossible=0;
6132: foreach (@possibilities) {
6133: my $file=$bighash{'src_'.$_};
6134: if (&allowed('bre',$file)) {
6135: my ($mapid,$resid)=split(/\./,$_);
6136: if ($bighash{'map_type_'.$mapid} ne 'page') {
6137: $realpossible++;
6138: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6139: $resid,$thisfn);
6140: }
6141: }
6142: }
6143: if ($realpossible!=1) { $syval=''; }
6144: } else {
6145: $syval='';
6146: }
6147: }
6148: untie(%bighash)
6149: }
6150: }
6151: if ($syval) {
6152: return $env{$cache_str}=$syval;
6153: }
6154: }
6155: &appenv('request.ambiguous' => $thisfn);
6156: return $env{$cache_str}='';
6157: }
6158:
6159: # ---------------------------------------------------------- Return random seed
6160:
6161: sub numval {
6162: my $txt=shift;
6163: $txt=~tr/A-J/0-9/;
6164: $txt=~tr/a-j/0-9/;
6165: $txt=~tr/K-T/0-9/;
6166: $txt=~tr/k-t/0-9/;
6167: $txt=~tr/U-Z/0-5/;
6168: $txt=~tr/u-z/0-5/;
6169: $txt=~s/\D//g;
6170: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6171: return int($txt);
6172: }
6173:
6174: sub numval2 {
6175: my $txt=shift;
6176: $txt=~tr/A-J/0-9/;
6177: $txt=~tr/a-j/0-9/;
6178: $txt=~tr/K-T/0-9/;
6179: $txt=~tr/k-t/0-9/;
6180: $txt=~tr/U-Z/0-5/;
6181: $txt=~tr/u-z/0-5/;
6182: $txt=~s/\D//g;
6183: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6184: my $total;
6185: foreach my $val (@txts) { $total+=$val; }
6186: if ($_64bit) { if ($total > 2**32) { return -1; } }
6187: return int($total);
6188: }
6189:
6190: sub numval3 {
6191: use integer;
6192: my $txt=shift;
6193: $txt=~tr/A-J/0-9/;
6194: $txt=~tr/a-j/0-9/;
6195: $txt=~tr/K-T/0-9/;
6196: $txt=~tr/k-t/0-9/;
6197: $txt=~tr/U-Z/0-5/;
6198: $txt=~tr/u-z/0-5/;
6199: $txt=~s/\D//g;
6200: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6201: my $total;
6202: foreach my $val (@txts) { $total+=$val; }
6203: if ($_64bit) { $total=(($total<<32)>>32); }
6204: return $total;
6205: }
6206:
6207: sub digest {
6208: my ($data)=@_;
6209: my $digest=&Digest::MD5::md5($data);
6210: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6211: my ($e,$f);
6212: {
6213: use integer;
6214: $e=($a+$b);
6215: $f=($c+$d);
6216: if ($_64bit) {
6217: $e=(($e<<32)>>32);
6218: $f=(($f<<32)>>32);
6219: }
6220: }
6221: if (wantarray) {
6222: return ($e,$f);
6223: } else {
6224: my $g;
6225: {
6226: use integer;
6227: $g=($e+$f);
6228: if ($_64bit) {
6229: $g=(($g<<32)>>32);
6230: }
6231: }
6232: return $g;
6233: }
6234: }
6235:
6236: sub latest_rnd_algorithm_id {
6237: return '64bit5';
6238: }
6239:
6240: sub get_rand_alg {
6241: my ($courseid)=@_;
6242: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6243: if ($courseid) {
6244: return $env{"course.$courseid.rndseed"};
6245: }
6246: return &latest_rnd_algorithm_id();
6247: }
6248:
6249: sub validCODE {
6250: my ($CODE)=@_;
6251: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6252: return 0;
6253: }
6254:
6255: sub getCODE {
6256: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6257: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6258: defined($Apache::lonhomework::parsing_a_task) ) &&
6259: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6260: return $Apache::lonhomework::history{'resource.CODE'};
6261: }
6262: return undef;
6263: }
6264:
6265: sub rndseed {
6266: my ($symb,$courseid,$domain,$username)=@_;
6267:
6268: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
6269: if (!$symb) {
6270: unless ($symb=$wsymb) { return time; }
6271: }
6272: if (!$courseid) { $courseid=$wcourseid; }
6273: if (!$domain) { $domain=$wdomain; }
6274: if (!$username) { $username=$wusername }
6275: my $which=&get_rand_alg();
6276: if (defined(&getCODE())) {
6277: if ($which eq '64bit5') {
6278: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6279: } elsif ($which eq '64bit4') {
6280: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6281: } else {
6282: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6283: }
6284: } elsif ($which eq '64bit5') {
6285: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6286: } elsif ($which eq '64bit4') {
6287: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6288: } elsif ($which eq '64bit3') {
6289: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6290: } elsif ($which eq '64bit2') {
6291: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6292: } elsif ($which eq '64bit') {
6293: return &rndseed_64bit($symb,$courseid,$domain,$username);
6294: }
6295: return &rndseed_32bit($symb,$courseid,$domain,$username);
6296: }
6297:
6298: sub rndseed_32bit {
6299: my ($symb,$courseid,$domain,$username)=@_;
6300: {
6301: use integer;
6302: my $symbchck=unpack("%32C*",$symb) << 27;
6303: my $symbseed=numval($symb) << 22;
6304: my $namechck=unpack("%32C*",$username) << 17;
6305: my $nameseed=numval($username) << 12;
6306: my $domainseed=unpack("%32C*",$domain) << 7;
6307: my $courseseed=unpack("%32C*",$courseid);
6308: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6309: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6310: #&Apache::lonxml::debug("rndseed :$num:$symb");
6311: if ($_64bit) { $num=(($num<<32)>>32); }
6312: return $num;
6313: }
6314: }
6315:
6316: sub rndseed_64bit {
6317: my ($symb,$courseid,$domain,$username)=@_;
6318: {
6319: use integer;
6320: my $symbchck=unpack("%32S*",$symb) << 21;
6321: my $symbseed=numval($symb) << 10;
6322: my $namechck=unpack("%32S*",$username);
6323:
6324: my $nameseed=numval($username) << 21;
6325: my $domainseed=unpack("%32S*",$domain) << 10;
6326: my $courseseed=unpack("%32S*",$courseid);
6327:
6328: my $num1=$symbchck+$symbseed+$namechck;
6329: my $num2=$nameseed+$domainseed+$courseseed;
6330: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6331: #&Apache::lonxml::debug("rndseed :$num:$symb");
6332: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6333: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6334: return "$num1,$num2";
6335: }
6336: }
6337:
6338: sub rndseed_64bit2 {
6339: my ($symb,$courseid,$domain,$username)=@_;
6340: {
6341: use integer;
6342: # strings need to be an even # of cahracters long, it it is odd the
6343: # last characters gets thrown away
6344: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6345: my $symbseed=numval($symb) << 10;
6346: my $namechck=unpack("%32S*",$username.' ');
6347:
6348: my $nameseed=numval($username) << 21;
6349: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6350: my $courseseed=unpack("%32S*",$courseid.' ');
6351:
6352: my $num1=$symbchck+$symbseed+$namechck;
6353: my $num2=$nameseed+$domainseed+$courseseed;
6354: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6355: #&Apache::lonxml::debug("rndseed :$num:$symb");
6356: return "$num1,$num2";
6357: }
6358: }
6359:
6360: sub rndseed_64bit3 {
6361: my ($symb,$courseid,$domain,$username)=@_;
6362: {
6363: use integer;
6364: # strings need to be an even # of cahracters long, it it is odd the
6365: # last characters gets thrown away
6366: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6367: my $symbseed=numval2($symb) << 10;
6368: my $namechck=unpack("%32S*",$username.' ');
6369:
6370: my $nameseed=numval2($username) << 21;
6371: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6372: my $courseseed=unpack("%32S*",$courseid.' ');
6373:
6374: my $num1=$symbchck+$symbseed+$namechck;
6375: my $num2=$nameseed+$domainseed+$courseseed;
6376: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6377: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6378: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6379:
6380: return "$num1:$num2";
6381: }
6382: }
6383:
6384: sub rndseed_64bit4 {
6385: my ($symb,$courseid,$domain,$username)=@_;
6386: {
6387: use integer;
6388: # strings need to be an even # of cahracters long, it it is odd the
6389: # last characters gets thrown away
6390: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6391: my $symbseed=numval3($symb) << 10;
6392: my $namechck=unpack("%32S*",$username.' ');
6393:
6394: my $nameseed=numval3($username) << 21;
6395: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6396: my $courseseed=unpack("%32S*",$courseid.' ');
6397:
6398: my $num1=$symbchck+$symbseed+$namechck;
6399: my $num2=$nameseed+$domainseed+$courseseed;
6400: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6401: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6402: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6403:
6404: return "$num1:$num2";
6405: }
6406: }
6407:
6408: sub rndseed_64bit5 {
6409: my ($symb,$courseid,$domain,$username)=@_;
6410: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6411: return "$num1:$num2";
6412: }
6413:
6414: sub rndseed_CODE_64bit {
6415: my ($symb,$courseid,$domain,$username)=@_;
6416: {
6417: use integer;
6418: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6419: my $symbseed=numval2($symb);
6420: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6421: my $CODEseed=numval(&getCODE());
6422: my $courseseed=unpack("%32S*",$courseid.' ');
6423: my $num1=$symbseed+$CODEchck;
6424: my $num2=$CODEseed+$courseseed+$symbchck;
6425: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6426: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6427: if ($_64bit) { $num1=(($num1<<32)>>32); }
6428: if ($_64bit) { $num2=(($num2<<32)>>32); }
6429: return "$num1:$num2";
6430: }
6431: }
6432:
6433: sub rndseed_CODE_64bit4 {
6434: my ($symb,$courseid,$domain,$username)=@_;
6435: {
6436: use integer;
6437: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6438: my $symbseed=numval3($symb);
6439: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6440: my $CODEseed=numval3(&getCODE());
6441: my $courseseed=unpack("%32S*",$courseid.' ');
6442: my $num1=$symbseed+$CODEchck;
6443: my $num2=$CODEseed+$courseseed+$symbchck;
6444: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6445: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6446: if ($_64bit) { $num1=(($num1<<32)>>32); }
6447: if ($_64bit) { $num2=(($num2<<32)>>32); }
6448: return "$num1:$num2";
6449: }
6450: }
6451:
6452: sub rndseed_CODE_64bit5 {
6453: my ($symb,$courseid,$domain,$username)=@_;
6454: my $code = &getCODE();
6455: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6456: return "$num1:$num2";
6457: }
6458:
6459: sub setup_random_from_rndseed {
6460: my ($rndseed)=@_;
6461: if ($rndseed =~/([,:])/) {
6462: my ($num1,$num2)=split(/[,:]/,$rndseed);
6463: &Math::Random::random_set_seed(abs($num1),abs($num2));
6464: } else {
6465: &Math::Random::random_set_seed_from_phrase($rndseed);
6466: }
6467: }
6468:
6469: sub latest_receipt_algorithm_id {
6470: return 'receipt2';
6471: }
6472:
6473: sub recunique {
6474: my $fucourseid=shift;
6475: my $unique;
6476: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6477: $unique=$env{"course.$fucourseid.internal.encseed"};
6478: } else {
6479: $unique=$perlvar{'lonReceipt'};
6480: }
6481: return unpack("%32C*",$unique);
6482: }
6483:
6484: sub recprefix {
6485: my $fucourseid=shift;
6486: my $prefix;
6487: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6488: $prefix=$env{"course.$fucourseid.internal.encpref"};
6489: } else {
6490: $prefix=$perlvar{'lonHostID'};
6491: }
6492: return unpack("%32C*",$prefix);
6493: }
6494:
6495: sub ireceipt {
6496: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6497: my $cuname=unpack("%32C*",$funame);
6498: my $cudom=unpack("%32C*",$fudom);
6499: my $cucourseid=unpack("%32C*",$fucourseid);
6500: my $cusymb=unpack("%32C*",$fusymb);
6501: my $cunique=&recunique($fucourseid);
6502: my $cpart=unpack("%32S*",$part);
6503: my $return =&recprefix($fucourseid).'-';
6504: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6505: $env{'request.state'} eq 'construct') {
6506: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6507: " and ".($cpart%$cudom));
6508:
6509: $return.= ($cunique%$cuname+
6510: $cunique%$cudom+
6511: $cusymb%$cuname+
6512: $cusymb%$cudom+
6513: $cucourseid%$cuname+
6514: $cucourseid%$cudom+
6515: $cpart%$cuname+
6516: $cpart%$cudom);
6517: } else {
6518: $return.= ($cunique%$cuname+
6519: $cunique%$cudom+
6520: $cusymb%$cuname+
6521: $cusymb%$cudom+
6522: $cucourseid%$cuname+
6523: $cucourseid%$cudom);
6524: }
6525: return $return;
6526: }
6527:
6528: sub receipt {
6529: my ($part)=@_;
6530: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6531: return &ireceipt($name,$domain,$courseid,$symb,$part);
6532: }
6533:
6534: # ------------------------------------------------------------ Serves up a file
6535: # returns either the contents of the file or
6536: # -1 if the file doesn't exist
6537: #
6538: # if the target is a file that was uploaded via DOCS,
6539: # a check will be made to see if a current copy exists on the local server,
6540: # if it does this will be served, otherwise a copy will be retrieved from
6541: # the home server for the course and stored in /home/httpd/html/userfiles on
6542: # the local server.
6543:
6544: sub getfile {
6545: my ($file) = @_;
6546: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6547: &repcopy($file);
6548: return &readfile($file);
6549: }
6550:
6551: sub repcopy_userfile {
6552: my ($file)=@_;
6553: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6554: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
6555: my ($cdom,$cnum,$filename) =
6556: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6557: my ($info,$rtncode);
6558: my $uri="/uploaded/$cdom/$cnum/$filename";
6559: if (-e "$file") {
6560: my @fileinfo = stat($file);
6561: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
6562: if ($lwpresp ne 'ok') {
6563: if ($rtncode eq '404') {
6564: unlink($file);
6565: }
6566: #my $ua=new LWP::UserAgent;
6567: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6568: #my $response=$ua->request($request);
6569: #if ($response->is_success()) {
6570: # return $response->content;
6571: # } else {
6572: # return -1;
6573: # }
6574: return -1;
6575: }
6576: if ($info < $fileinfo[9]) {
6577: return 'ok';
6578: }
6579: $info = '';
6580: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6581: if ($lwpresp ne 'ok') {
6582: return -1;
6583: }
6584: } else {
6585: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6586: if ($lwpresp ne 'ok') {
6587: my $ua=new LWP::UserAgent;
6588: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6589: my $response=$ua->request($request);
6590: if ($response->is_success()) {
6591: $info=$response->content;
6592: } else {
6593: return -1;
6594: }
6595: }
6596: my @parts = ($cdom,$cnum);
6597: if ($filename =~ m|^(.+)/[^/]+$|) {
6598: push @parts, split(/\//,$1);
6599: }
6600: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
6601: foreach my $part (@parts) {
6602: $path .= '/'.$part;
6603: if (!-e $path) {
6604: mkdir($path,0770);
6605: }
6606: }
6607: }
6608: open(FILE,">$file");
6609: print FILE $info;
6610: close(FILE);
6611: return 'ok';
6612: }
6613:
6614: sub tokenwrapper {
6615: my $uri=shift;
6616: $uri=~s|^http\://([^/]+)||;
6617: $uri=~s|^/||;
6618: $env{'user.environment'}=~/\/([^\/]+)\.id/;
6619: my $token=$1;
6620: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6621: if ($udom && $uname && $file) {
6622: $file=~s|(\?\.*)*$||;
6623: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
6624: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
6625: (($uri=~/\?/)?'&':'?').'token='.$token.
6626: '&tokenissued='.$perlvar{'lonHostID'};
6627: } else {
6628: return '/adm/notfound.html';
6629: }
6630: }
6631:
6632: sub getuploaded {
6633: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6634: $uri=~s/^\///;
6635: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6636: my $ua=new LWP::UserAgent;
6637: my $request=new HTTP::Request($reqtype,$uri);
6638: my $response=$ua->request($request);
6639: $$rtncode = $response->code;
6640: if (! $response->is_success()) {
6641: return 'failed';
6642: }
6643: if ($reqtype eq 'HEAD') {
6644: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
6645: } elsif ($reqtype eq 'GET') {
6646: $$info = $response->content;
6647: }
6648: return 'ok';
6649: }
6650:
6651: sub readfile {
6652: my $file = shift;
6653: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6654: my $fh;
6655: open($fh,"<$file");
6656: my $a='';
6657: while (<$fh>) { $a .=$_; }
6658: return $a;
6659: }
6660:
6661: sub filelocation {
6662: my ($dir,$file) = @_;
6663: my $location;
6664: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
6665:
6666: if ($file =~ m-^/adm/-) {
6667: $file=~s-^/adm/wrapper/-/-;
6668: $file=~s-^/adm/coursedocs/showdoc/-/-;
6669: }
6670: if ($file=~m:^/~:) { # is a contruction space reference
6671: $location = $file;
6672: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
6673: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6674: # is a correct contruction space reference
6675: $location = $file;
6676: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
6677: my ($udom,$uname,$filename)=
6678: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
6679: my $home=&homeserver($uname,$udom);
6680: my $is_me=0;
6681: my @ids=¤t_machine_ids();
6682: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6683: if ($is_me) {
6684: $location=&propath($udom,$uname).
6685: '/userfiles/'.$filename;
6686: } else {
6687: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6688: $udom.'/'.$uname.'/'.$filename;
6689: }
6690: } else {
6691: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6692: $file=~s:^/res/:/:;
6693: if ( !( $file =~ m:^/:) ) {
6694: $location = $dir. '/'.$file;
6695: } else {
6696: $location = '/home/httpd/html/res'.$file;
6697: }
6698: }
6699: $location=~s://+:/:g; # remove duplicate /
6700: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6701: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6702: return $location;
6703: }
6704:
6705: sub hreflocation {
6706: my ($dir,$file)=@_;
6707: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
6708: $file=filelocation($dir,$file);
6709: } elsif ($file=~m-^/adm/-) {
6710: $file=~s-^/adm/wrapper/-/-;
6711: $file=~s-^/adm/coursedocs/showdoc/-/-;
6712: }
6713: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6714: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6715: } elsif ($file=~m-/home/(\w+)/public_html/-) {
6716: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
6717: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6718: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6719: -/uploaded/$1/$2/-x;
6720: }
6721: return $file;
6722: }
6723:
6724: sub current_machine_domains {
6725: my $hostname=$hostname{$perlvar{'lonHostID'}};
6726: my @domains;
6727: while( my($id, $name) = each(%hostname)) {
6728: # &logthis("-$id-$name-$hostname-");
6729: if ($hostname eq $name) {
6730: push(@domains,$hostdom{$id});
6731: }
6732: }
6733: return @domains;
6734: }
6735:
6736: sub current_machine_ids {
6737: my $hostname=$hostname{$perlvar{'lonHostID'}};
6738: my @ids;
6739: while( my($id, $name) = each(%hostname)) {
6740: # &logthis("-$id-$name-$hostname-");
6741: if ($hostname eq $name) {
6742: push(@ids,$id);
6743: }
6744: }
6745: return @ids;
6746: }
6747:
6748: # ------------------------------------------------------------- Declutters URLs
6749:
6750: sub declutter {
6751: my $thisfn=shift;
6752: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6753: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6754: $thisfn=~s/^\///;
6755: $thisfn=~s|^adm/wrapper/||;
6756: $thisfn=~s|^adm/coursedocs/showdoc/||;
6757: $thisfn=~s/^res\///;
6758: $thisfn=~s/\?.+$//;
6759: return $thisfn;
6760: }
6761:
6762: # ------------------------------------------------------------- Clutter up URLs
6763:
6764: sub clutter {
6765: my $thisfn='/'.&declutter(shift);
6766: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
6767: $thisfn='/res'.$thisfn;
6768: }
6769: if ($thisfn !~m|/adm|) {
6770: if ($thisfn =~ m|/ext/|) {
6771: $thisfn='/adm/wrapper'.$thisfn;
6772: } else {
6773: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6774: my $embstyle=&Apache::loncommon::fileembstyle($ext);
6775: if ($embstyle eq 'ssi'
6776: || ($embstyle eq 'hdn')
6777: || ($embstyle eq 'rat')
6778: || ($embstyle eq 'prv')
6779: || ($embstyle eq 'ign')) {
6780: #do nothing with these
6781: } elsif (($embstyle eq 'img')
6782: || ($embstyle eq 'emb')
6783: || ($embstyle eq 'wrp')) {
6784: $thisfn='/adm/wrapper'.$thisfn;
6785: } elsif ($embstyle eq 'unk'
6786: && $thisfn!~/\.(sequence|page)$/) {
6787: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
6788: } else {
6789: # &logthis("Got a blank emb style");
6790: }
6791: }
6792: }
6793: return $thisfn;
6794: }
6795:
6796: sub freeze_escape {
6797: my ($value)=@_;
6798: if (ref($value)) {
6799: $value=&nfreeze($value);
6800: return '__FROZEN__'.&escape($value);
6801: }
6802: return &escape($value);
6803: }
6804:
6805:
6806: sub thaw_unescape {
6807: my ($value)=@_;
6808: if ($value =~ /^__FROZEN__/) {
6809: substr($value,0,10,undef);
6810: $value=&unescape($value);
6811: return &thaw($value);
6812: }
6813: return &unescape($value);
6814: }
6815:
6816: sub correct_line_ends {
6817: my ($result)=@_;
6818: $$result =~s/\r\n/\n/mg;
6819: $$result =~s/\r/\n/mg;
6820: }
6821: # ================================================================ Main Program
6822:
6823: sub goodbye {
6824: &logthis("Starting Shut down");
6825: #not converted to using infrastruture and probably shouldn't be
6826: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
6827: #converted
6828: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6829: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6830: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6831: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
6832: #1.1 only
6833: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6834: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6835: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6836: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6837: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6838: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6839: &logthis(sprintf("%-20s is %s",'hits',$hits));
6840: &flushcourselogs();
6841: &logthis("Shutting down");
6842: }
6843:
6844: BEGIN {
6845: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
6846: unless ($readit) {
6847: {
6848: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
6849: open(my $config,"</etc/httpd/conf/loncapa.conf");
6850:
6851: while (my $configline=<$config>) {
6852: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
6853: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6854: chomp($varvalue);
6855: $perlvar{$varname}=$varvalue;
6856: }
6857: }
6858: close($config);
6859: }
6860: {
6861: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
6862:
6863: while (my $configline=<$config>) {
6864: if ($configline =~ /^[^\#]*PerlSetVar/) {
6865: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6866: chomp($varvalue);
6867: $perlvar{$varname}=$varvalue;
6868: }
6869: }
6870: close($config);
6871: }
6872:
6873: # ------------------------------------------------------------ Read domain file
6874: {
6875: %domaindescription = ();
6876: %domain_auth_def = ();
6877: %domain_auth_arg_def = ();
6878: my $fh;
6879: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
6880: while (<$fh>) {
6881: next if (/^(\#|\s*$)/);
6882: # next if /^\#/;
6883: chomp;
6884: my ($domain, $domain_description, $def_auth, $def_auth_arg,
6885: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
6886: $domain_auth_def{$domain}=$def_auth;
6887: $domain_auth_arg_def{$domain}=$def_auth_arg;
6888: $domaindescription{$domain}=$domain_description;
6889: $domain_lang_def{$domain}=$def_lang;
6890: $domain_city{$domain}=$city;
6891: $domain_longi{$domain}=$longi;
6892: $domain_lati{$domain}=$lati;
6893: $domain_primary{$domain}=$primary;
6894:
6895: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
6896: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
6897: }
6898: }
6899: close ($fh);
6900: }
6901:
6902:
6903: # ------------------------------------------------------------- Read hosts file
6904: {
6905: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
6906:
6907: while (my $configline=<$config>) {
6908: next if ($configline =~ /^(\#|\s*$)/);
6909: chomp($configline);
6910: my ($id,$domain,$role,$name)=split(/:/,$configline);
6911: $name=~s/\s//g;
6912: if ($id && $domain && $role && $name) {
6913: $hostname{$id}=$name;
6914: $hostdom{$id}=$domain;
6915: if ($role eq 'library') { $libserv{$id}=$name; }
6916: }
6917: }
6918: close($config);
6919: # FIXME: dev server don't want this, production servers _do_ want this
6920: #&get_iphost();
6921: }
6922:
6923: sub get_iphost {
6924: if (%iphost) { return %iphost; }
6925: my %name_to_ip;
6926: foreach my $id (keys(%hostname)) {
6927: my $name=$hostname{$id};
6928: my $ip;
6929: if (!exists($name_to_ip{$name})) {
6930: $ip = gethostbyname($name);
6931: if (!$ip || length($ip) ne 4) {
6932: &logthis("Skipping host $id name $name no IP found\n");
6933: next;
6934: }
6935: $ip=inet_ntoa($ip);
6936: $name_to_ip{$name} = $ip;
6937: } else {
6938: $ip = $name_to_ip{$name};
6939: }
6940: push(@{$iphost{$ip}},$id);
6941: }
6942: return %iphost;
6943: }
6944:
6945: # ------------------------------------------------------ Read spare server file
6946: {
6947: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
6948:
6949: while (my $configline=<$config>) {
6950: chomp($configline);
6951: if ($configline) {
6952: $spareid{$configline}=1;
6953: }
6954: }
6955: close($config);
6956: }
6957: # ------------------------------------------------------------ Read permissions
6958: {
6959: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
6960:
6961: while (my $configline=<$config>) {
6962: chomp($configline);
6963: if ($configline) {
6964: my ($role,$perm)=split(/ /,$configline);
6965: if ($perm ne '') { $pr{$role}=$perm; }
6966: }
6967: }
6968: close($config);
6969: }
6970:
6971: # -------------------------------------------- Read plain texts for permissions
6972: {
6973: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
6974:
6975: while (my $configline=<$config>) {
6976: chomp($configline);
6977: if ($configline) {
6978: my ($short,@plain)=split(/:/,$configline);
6979: %{$prp{$short}} = ();
6980: if (@plain > 0) {
6981: $prp{$short}{'std'} = $plain[0];
6982: for (my $i=1; $i<@plain; $i++) {
6983: $prp{$short}{'alt'.$i} = $plain[$i];
6984: }
6985: }
6986: }
6987: }
6988: close($config);
6989: }
6990:
6991: # ---------------------------------------------------------- Read package table
6992: {
6993: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
6994:
6995: while (my $configline=<$config>) {
6996: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
6997: chomp($configline);
6998: my ($short,$plain)=split(/:/,$configline);
6999: my ($pack,$name)=split(/\&/,$short);
7000: if ($plain ne '') {
7001: $packagetab{$pack.'&'.$name.'&name'}=$name;
7002: $packagetab{$short}=$plain;
7003: }
7004: }
7005: close($config);
7006: }
7007:
7008: # ------------- set up temporary directory
7009: {
7010: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7011:
7012: }
7013:
7014: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
7015:
7016: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7017: $dumpcount=0;
7018:
7019: &logtouch();
7020: &logthis('<font color="yellow">INFO: Read configuration</font>');
7021: $readit=1;
7022: {
7023: use integer;
7024: my $test=(2**32)+1;
7025: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7026: &logthis(" Detected 64bit platform ($_64bit)");
7027: }
7028: }
7029: }
7030:
7031: 1;
7032: __END__
7033:
7034: =pod
7035:
7036: =head1 NAME
7037:
7038: Apache::lonnet - Subroutines to ask questions about things in the network.
7039:
7040: =head1 SYNOPSIS
7041:
7042: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7043:
7044: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7045:
7046: Common parameters:
7047:
7048: =over 4
7049:
7050: =item *
7051:
7052: $uname : an internal username (if $cname expecting a course Id specifically)
7053:
7054: =item *
7055:
7056: $udom : a domain (if $cdom expecting a course's domain specifically)
7057:
7058: =item *
7059:
7060: $symb : a resource instance identifier
7061:
7062: =item *
7063:
7064: $namespace : the name of a .db file that contains the data needed or
7065: being set.
7066:
7067: =back
7068:
7069: =head1 OVERVIEW
7070:
7071: lonnet provides subroutines which interact with the
7072: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7073: about classes, users, and resources.
7074:
7075: For many of these objects you can also use this to store data about
7076: them or modify them in various ways.
7077:
7078: =head2 Symbs
7079:
7080: To identify a specific instance of a resource, LON-CAPA uses symbols
7081: or "symbs"X<symb>. These identifiers are built from the URL of the
7082: map, the resource number of the resource in the map, and the URL of
7083: the resource itself. The latter is somewhat redundant, but might help
7084: if maps change.
7085:
7086: An example is
7087:
7088: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7089:
7090: The respective map entry is
7091:
7092: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7093: title="Problem 2">
7094: </resource>
7095:
7096: Symbs are used by the random number generator, as well as to store and
7097: restore data specific to a certain instance of for example a problem.
7098:
7099: =head2 Storing And Retrieving Data
7100:
7101: X<store()>X<cstore()>X<restore()>Three of the most important functions
7102: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7103: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7104: is is the non-critical message twin of cstore. These functions are for
7105: handlers to store a perl hash to a user's permanent data space in an
7106: easy manner, and to retrieve it again on another call. It is expected
7107: that a handler would use this once at the beginning to retrieve data,
7108: and then again once at the end to send only the new data back.
7109:
7110: The data is stored in the user's data directory on the user's
7111: homeserver under the ID of the course.
7112:
7113: The hash that is returned by restore will have all of the previous
7114: value for all of the elements of the hash.
7115:
7116: Example:
7117:
7118: #creating a hash
7119: my %hash;
7120: $hash{'foo'}='bar';
7121:
7122: #storing it
7123: &Apache::lonnet::cstore(\%hash);
7124:
7125: #changing a value
7126: $hash{'foo'}='notbar';
7127:
7128: #adding a new value
7129: $hash{'bar'}='foo';
7130: &Apache::lonnet::cstore(\%hash);
7131:
7132: #retrieving the hash
7133: my %history=&Apache::lonnet::restore();
7134:
7135: #print the hash
7136: foreach my $key (sort(keys(%history))) {
7137: print("\%history{$key} = $history{$key}");
7138: }
7139:
7140: Will print out:
7141:
7142: %history{1:foo} = bar
7143: %history{1:keys} = foo:timestamp
7144: %history{1:timestamp} = 990455579
7145: %history{2:bar} = foo
7146: %history{2:foo} = notbar
7147: %history{2:keys} = foo:bar:timestamp
7148: %history{2:timestamp} = 990455580
7149: %history{bar} = foo
7150: %history{foo} = notbar
7151: %history{timestamp} = 990455580
7152: %history{version} = 2
7153:
7154: Note that the special hash entries C<keys>, C<version> and
7155: C<timestamp> were added to the hash. C<version> will be equal to the
7156: total number of versions of the data that have been stored. The
7157: C<timestamp> attribute will be the UNIX time the hash was
7158: stored. C<keys> is available in every historical section to list which
7159: keys were added or changed at a specific historical revision of a
7160: hash.
7161:
7162: B<Warning>: do not store the hash that restore returns directly. This
7163: will cause a mess since it will restore the historical keys as if the
7164: were new keys. I.E. 1:foo will become 1:1:foo etc.
7165:
7166: Calling convention:
7167:
7168: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7169: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7170:
7171: For more detailed information, see lonnet specific documentation.
7172:
7173: =head1 RETURN MESSAGES
7174:
7175: =over 4
7176:
7177: =item * B<con_lost>: unable to contact remote host
7178:
7179: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7180: when the connection is brought back up
7181:
7182: =item * B<con_failed>: unable to contact remote host and unable to save message
7183: for later delivery
7184:
7185: =item * B<error:>: an error a occured, a description of the error follows the :
7186:
7187: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7188: that was requested
7189:
7190: =back
7191:
7192: =head1 PUBLIC SUBROUTINES
7193:
7194: =head2 Session Environment Functions
7195:
7196: =over 4
7197:
7198: =item *
7199: X<appenv()>
7200: B<appenv(%hash)>: the value of %hash is written to
7201: the user envirnoment file, and will be restored for each access this
7202: user makes during this session, also modifies the %env for the current
7203: process
7204:
7205: =item *
7206: X<delenv()>
7207: B<delenv($regexp)>: removes all items from the session
7208: environment file that matches the regular expression in $regexp. The
7209: values are also delted from the current processes %env.
7210:
7211: =back
7212:
7213: =head2 User Information
7214:
7215: =over 4
7216:
7217: =item *
7218: X<queryauthenticate()>
7219: B<queryauthenticate($uname,$udom)>: try to determine user's current
7220: authentication scheme
7221:
7222: =item *
7223: X<authenticate()>
7224: B<authenticate($uname,$upass,$udom)>: try to
7225: authenticate user from domain's lib servers (first use the current
7226: one). C<$upass> should be the users password.
7227:
7228: =item *
7229: X<homeserver()>
7230: B<homeserver($uname,$udom)>: find the server which has
7231: the user's directory and files (there must be only one), this caches
7232: the answer, and also caches if there is a borken connection.
7233:
7234: =item *
7235: X<idget()>
7236: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7237: (IDs are a unique resource in a domain, there must be only 1 ID per
7238: username, and only 1 username per ID in a specific domain) (returns
7239: hash: id=>name,id=>name)
7240:
7241: =item *
7242: X<idrget()>
7243: B<idrget($udom,@unames)>: find the IDs behind a list of
7244: usernames (returns hash: name=>id,name=>id)
7245:
7246: =item *
7247: X<idput()>
7248: B<idput($udom,%ids)>: store away a list of names and associated IDs
7249:
7250: =item *
7251: X<rolesinit()>
7252: B<rolesinit($udom,$username,$authhost)>: get user privileges
7253:
7254: =item *
7255: X<getsection()>
7256: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7257: course $cname, return section name/number or '' for "not in course"
7258: and '-1' for "no section"
7259:
7260: =item *
7261: X<userenvironment()>
7262: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7263: passed in @what from the requested user's environment, returns a hash
7264:
7265: =back
7266:
7267: =head2 User Roles
7268:
7269: =over 4
7270:
7271: =item *
7272:
7273: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7274: actions
7275: F: full access
7276: U,I,K: authentication modes (cxx only)
7277: '': forbidden
7278: 1: user needs to choose course
7279: 2: browse allowed
7280:
7281: =item *
7282:
7283: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7284: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7285: and course level
7286:
7287: =item *
7288:
7289: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7290: explanation of a user role term
7291:
7292: =back
7293:
7294: =head2 User Modification
7295:
7296: =over 4
7297:
7298: =item *
7299:
7300: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7301: user for the level given by URL. Optional start and end dates (leave empty
7302: string or zero for "no date")
7303:
7304: =item *
7305:
7306: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7307: change a users, password, possible return values are: ok,
7308: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7309: refused
7310:
7311: =item *
7312:
7313: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7314:
7315: =item *
7316:
7317: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7318: modify user
7319:
7320: =item *
7321:
7322: modifystudent
7323:
7324: modify a students enrollment and identification information.
7325: The course id is resolved based on the current users environment.
7326: This means the envoking user must be a course coordinator or otherwise
7327: associated with a course.
7328:
7329: This call is essentially a wrapper for lonnet::modifyuser and
7330: lonnet::modify_student_enrollment
7331:
7332: Inputs:
7333:
7334: =over 4
7335:
7336: =item B<$udom> Students loncapa domain
7337:
7338: =item B<$uname> Students loncapa login name
7339:
7340: =item B<$uid> Students id/student number
7341:
7342: =item B<$umode> Students authentication mode
7343:
7344: =item B<$upass> Students password
7345:
7346: =item B<$first> Students first name
7347:
7348: =item B<$middle> Students middle name
7349:
7350: =item B<$last> Students last name
7351:
7352: =item B<$gene> Students generation
7353:
7354: =item B<$usec> Students section in course
7355:
7356: =item B<$end> Unix time of the roles expiration
7357:
7358: =item B<$start> Unix time of the roles start date
7359:
7360: =item B<$forceid> If defined, allow $uid to be changed
7361:
7362: =item B<$desiredhome> server to use as home server for student
7363:
7364: =back
7365:
7366: =item *
7367:
7368: modify_student_enrollment
7369:
7370: Change a students enrollment status in a class. The environment variable
7371: 'role.request.course' must be defined for this function to proceed.
7372:
7373: Inputs:
7374:
7375: =over 4
7376:
7377: =item $udom, students domain
7378:
7379: =item $uname, students name
7380:
7381: =item $uid, students user id
7382:
7383: =item $first, students first name
7384:
7385: =item $middle
7386:
7387: =item $last
7388:
7389: =item $gene
7390:
7391: =item $usec
7392:
7393: =item $end
7394:
7395: =item $start
7396:
7397: =back
7398:
7399:
7400: =item *
7401:
7402: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7403: custom role; give a custom role to a user for the level given by URL. Specify
7404: name and domain of role author, and role name
7405:
7406: =item *
7407:
7408: revokerole($udom,$uname,$url,$role) : revoke a role for url
7409:
7410: =item *
7411:
7412: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7413:
7414: =back
7415:
7416: =head2 Course Infomation
7417:
7418: =over 4
7419:
7420: =item *
7421:
7422: coursedescription($courseid) : returns a hash of information about the
7423: specified course id, including all environment settings for the
7424: course, the description of the course will be in the hash under the
7425: key 'description'
7426:
7427: =item *
7428:
7429: resdata($name,$domain,$type,@which) : request for current parameter
7430: setting for a specific $type, where $type is either 'course' or 'user',
7431: @what should be a list of parameters to ask about. This routine caches
7432: answers for 5 minutes.
7433:
7434: =back
7435:
7436: =head2 Course Modification
7437:
7438: =over 4
7439:
7440: =item *
7441:
7442: writecoursepref($courseid,%prefs) : write preferences (environment
7443: database) for a course
7444:
7445: =item *
7446:
7447: createcourse($udom,$description,$url) : make/modify course
7448:
7449: =back
7450:
7451: =head2 Resource Subroutines
7452:
7453: =over 4
7454:
7455: =item *
7456:
7457: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7458:
7459: =item *
7460:
7461: repcopy($filename) : subscribes to the requested file, and attempts to
7462: replicate from the owning library server, Might return
7463: 'unavailable', 'not_found', 'forbidden', 'ok', or
7464: 'bad_request', also attempts to grab the metadata for the
7465: resource. Expects the local filesystem pathname
7466: (/home/httpd/html/res/....)
7467:
7468: =back
7469:
7470: =head2 Resource Information
7471:
7472: =over 4
7473:
7474: =item *
7475:
7476: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7477: a vairety of different possible values, $varname should be a request
7478: string, and the other parameters can be used to specify who and what
7479: one is asking about.
7480:
7481: Possible values for $varname are environment.lastname (or other item
7482: from the envirnment hash), user.name (or someother aspect about the
7483: user), resource.0.maxtries (or some other part and parameter of a
7484: resource)
7485:
7486: =item *
7487:
7488: directcondval($number) : get current value of a condition; reads from a state
7489: string
7490:
7491: =item *
7492:
7493: condval($condidx) : value of condition index based on state
7494:
7495: =item *
7496:
7497: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7498: resource's metadata, $what should be either a specific key, or either
7499: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7500: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7501:
7502: this function automatically caches all requests
7503:
7504: =item *
7505:
7506: metadata_query($query,$custom,$customshow) : make a metadata query against the
7507: network of library servers; returns file handle of where SQL and regex results
7508: will be stored for query
7509:
7510: =item *
7511:
7512: symbread($filename) : return symbolic list entry (filename argument optional);
7513: returns the data handle
7514:
7515: =item *
7516:
7517: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7518: a possible symb for the URL in $thisfn, and if is an encryypted
7519: resource that the user accessed using /enc/ returns a 1 on success, 0
7520: on failure, user must be in a course, as it assumes the existance of
7521: the course initial hash, and uses $env('request.course.id'}
7522:
7523:
7524: =item *
7525:
7526: symbclean($symb) : removes versions numbers from a symb, returns the
7527: cleaned symb
7528:
7529: =item *
7530:
7531: is_on_map($uri) : checks if the $uri is somewhere on the current
7532: course map, user must be in a course for it to work.
7533:
7534: =item *
7535:
7536: numval($salt) : return random seed value (addend for rndseed)
7537:
7538: =item *
7539:
7540: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7541: a random seed, all arguments are optional, if they aren't sent it uses the
7542: environment to derive them. Note: if symb isn't sent and it can't get one
7543: from &symbread it will use the current time as its return value
7544:
7545: =item *
7546:
7547: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7548: unfakeable, receipt
7549:
7550: =item *
7551:
7552: receipt() : API to ireceipt working off of env values; given out to users
7553:
7554: =item *
7555:
7556: countacc($url) : count the number of accesses to a given URL
7557:
7558: =item *
7559:
7560: 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
7561:
7562: =item *
7563:
7564: 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)
7565:
7566: =item *
7567:
7568: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
7569:
7570: =item *
7571:
7572: devalidate($symb) : devalidate temporary spreadsheet calculations,
7573: forcing spreadsheet to reevaluate the resource scores next time.
7574:
7575: =back
7576:
7577: =head2 Storing/Retreiving Data
7578:
7579: =over 4
7580:
7581: =item *
7582:
7583: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7584: for this url; hashref needs to be given and should be a \%hashname; the
7585: remaining args aren't required and if they aren't passed or are '' they will
7586: be derived from the env
7587:
7588: =item *
7589:
7590: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7591: uses critical subroutine
7592:
7593: =item *
7594:
7595: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7596: all args are optional
7597:
7598: =item *
7599:
7600: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7601: dumps the complete (or key matching regexp) namespace into a hash
7602: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7603: normally &store()ed into
7604:
7605: $range should be either an integer '100' (give me the first 100
7606: matching records)
7607: or be two integers sperated by a - with no spaces
7608: '30-50' (give me the 30th through the 50th matching
7609: records)
7610:
7611:
7612: =item *
7613:
7614: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7615: replaces a &store() version of data with a replacement set of data
7616: for a particular resource in a namespace passed in the $storehash hash
7617: reference
7618:
7619: =item *
7620:
7621: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7622: works very similar to store/cstore, but all data is stored in a
7623: temporary location and can be reset using tmpreset, $storehash should
7624: be a hash reference, returns nothing on success
7625:
7626: =item *
7627:
7628: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7629: similar to restore, but all data is stored in a temporary location and
7630: can be reset using tmpreset. Returns a hash of values on success,
7631: error string otherwise.
7632:
7633: =item *
7634:
7635: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7636: deltes all keys for $symb form the temporary storage hash.
7637:
7638: =item *
7639:
7640: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7641: reference filled in from namesp ($udom and $uname are optional)
7642:
7643: =item *
7644:
7645: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7646: namesp ($udom and $uname are optional)
7647:
7648: =item *
7649:
7650: dump($namespace,$udom,$uname,$regexp,$range) :
7651: dumps the complete (or key matching regexp) namespace into a hash
7652: ($udom, $uname, $regexp, $range are optional)
7653:
7654: $range should be either an integer '100' (give me the first 100
7655: matching records)
7656: or be two integers sperated by a - with no spaces
7657: '30-50' (give me the 30th through the 50th matching
7658: records)
7659: =item *
7660:
7661: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7662: $store can be a scalar, an array reference, or if the amount to be
7663: incremented is > 1, a hash reference.
7664:
7665: ($udom and $uname are optional)
7666:
7667: =item *
7668:
7669: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7670: ($udom and $uname are optional)
7671:
7672: =item *
7673:
7674: cput($namespace,$storehash,$udom,$uname) : critical put
7675: ($udom and $uname are optional)
7676:
7677: =item *
7678:
7679: newput($namespace,$storehash,$udom,$uname) :
7680:
7681: Attempts to store the items in the $storehash, but only if they don't
7682: currently exist, if this succeeds you can be certain that you have
7683: successfully created a new key value pair in the $namespace db.
7684:
7685:
7686: Args:
7687: $namespace: name of database to store values to
7688: $storehash: hashref to store to the db
7689: $udom: (optional) domain of user containing the db
7690: $uname: (optional) name of user caontaining the db
7691:
7692: Returns:
7693: 'ok' -> succeeded in storing all keys of $storehash
7694: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7695: least <key> already existed in the db (other
7696: requested keys may also already exist)
7697: 'error: <msg>' -> unable to tie the DB or other erorr occured
7698: 'con_lost' -> unable to contact request server
7699: 'refused' -> action was not allowed by remote machine
7700:
7701:
7702: =item *
7703:
7704: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7705: reference filled in from namesp (encrypts the return communication)
7706: ($udom and $uname are optional)
7707:
7708: =item *
7709:
7710: log($udom,$name,$home,$message) : write to permanent log for user; use
7711: critical subroutine
7712:
7713: =back
7714:
7715: =head2 Network Status Functions
7716:
7717: =over 4
7718:
7719: =item *
7720:
7721: dirlist($uri) : return directory list based on URI
7722:
7723: =item *
7724:
7725: spareserver() : find server with least workload from spare.tab
7726:
7727: =back
7728:
7729: =head2 Apache Request
7730:
7731: =over 4
7732:
7733: =item *
7734:
7735: ssi($url,%hash) : server side include, does a complete request cycle on url to
7736: localhost, posts hash
7737:
7738: =back
7739:
7740: =head2 Data to String to Data
7741:
7742: =over 4
7743:
7744: =item *
7745:
7746: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7747: and '&' separators, supports elements that are arrayrefs and hashrefs
7748:
7749: =item *
7750:
7751: hashref2str($hashref) : convert a hashref into a string complete with
7752: escaping and '=' and '&' separators, supports elements that are
7753: arrayrefs and hashrefs
7754:
7755: =item *
7756:
7757: arrayref2str($arrayref) : convert an arrayref into a string complete
7758: with escaping and '&' separators, supports elements that are arrayrefs
7759: and hashrefs
7760:
7761: =item *
7762:
7763: str2hash($string) : convert string to hash using unescaping and
7764: splitting on '=' and '&', supports elements that are arrayrefs and
7765: hashrefs
7766:
7767: =item *
7768:
7769: str2array($string) : convert string to hash using unescaping and
7770: splitting on '&', supports elements that are arrayrefs and hashrefs
7771:
7772: =back
7773:
7774: =head2 Logging Routines
7775:
7776: =over 4
7777:
7778: These routines allow one to make log messages in the lonnet.log and
7779: lonnet.perm logfiles.
7780:
7781: =item *
7782:
7783: logtouch() : make sure the logfile, lonnet.log, exists
7784:
7785: =item *
7786:
7787: logthis() : append message to the normal lonnet.log file, it gets
7788: preiodically rolled over and deleted.
7789:
7790: =item *
7791:
7792: logperm() : append a permanent message to lonnet.perm.log, this log
7793: file never gets deleted by any automated portion of the system, only
7794: messages of critical importance should go in here.
7795:
7796: =back
7797:
7798: =head2 General File Helper Routines
7799:
7800: =over 4
7801:
7802: =item *
7803:
7804: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7805: (a) files in /uploaded
7806: (i) If a local copy of the file exists -
7807: compares modification date of local copy with last-modified date for
7808: definitive version stored on home server for course. If local copy is
7809: stale, requests a new version from the home server and stores it.
7810: If the original has been removed from the home server, then local copy
7811: is unlinked.
7812: (ii) If local copy does not exist -
7813: requests the file from the home server and stores it.
7814:
7815: If $caller is 'uploadrep':
7816: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7817: for request for files originally uploaded via DOCS.
7818: - returns 'ok' if fresh local copy now available, -1 otherwise.
7819:
7820: Otherwise:
7821: This indicates a call from the content generation phase of the request.
7822: - returns the entire contents of the file or -1.
7823:
7824: (b) files in /res
7825: - returns the entire contents of a file or -1;
7826: it properly subscribes to and replicates the file if neccessary.
7827:
7828:
7829: =item *
7830:
7831: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7832: reference
7833:
7834: returns either a stat() list of data about the file or an empty list
7835: if the file doesn't exist or couldn't find out about it (connection
7836: problems or user unknown)
7837:
7838: =item *
7839:
7840: filelocation($dir,$file) : returns file system location of a file
7841: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7842: directory that relative $file lookups are to looked in ($dir of /a/dir
7843: and a file of ../bob will become /a/bob)
7844:
7845: =item *
7846:
7847: hreflocation($dir,$file) : returns file system location or a URL; same as
7848: filelocation except for hrefs
7849:
7850: =item *
7851:
7852: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7853:
7854: =back
7855:
7856: =head2 Usererfile file routines (/uploaded*)
7857:
7858: =over 4
7859:
7860: =item *
7861:
7862: userfileupload(): main rotine for putting a file in a user or course's
7863: filespace, arguments are,
7864:
7865: formname - required - this is the name of the element in $env where the
7866: filename, and the contents of the file to create/modifed exist
7867: the filename is in $env{'form.'.$formname.'.filename'} and the
7868: contents of the file is located in $env{'form.'.$formname}
7869: coursedoc - if true, store the file in the course of the active role
7870: of the current user
7871: subdir - required - subdirectory to put the file in under ../userfiles/
7872: if undefined, it will be placed in "unknown"
7873:
7874: (This routine calls clean_filename() to remove any dangerous
7875: characters from the filename, and then calls finuserfileupload() to
7876: complete the transaction)
7877:
7878: returns either the url of the uploaded file (/uploaded/....) if successful
7879: and /adm/notfound.html if unsuccessful
7880:
7881: =item *
7882:
7883: clean_filename(): routine for cleaing a filename up for storage in
7884: userfile space, argument is:
7885:
7886: filename - proposed filename
7887:
7888: returns: the new clean filename
7889:
7890: =item *
7891:
7892: finishuserfileupload(): routine that creaes and sends the file to
7893: userspace, probably shouldn't be called directly
7894:
7895: docuname: username or courseid of destination for the file
7896: docudom: domain of user/course of destination for the file
7897: formname: same as for userfileupload()
7898: fname: filename (inculding subdirectories) for the file
7899:
7900: returns either the url of the uploaded file (/uploaded/....) if successful
7901: and /adm/notfound.html if unsuccessful
7902:
7903: =item *
7904:
7905: renameuserfile(): renames an existing userfile to a new name
7906:
7907: Args:
7908: docuname: username or courseid of destination for the file
7909: docudom: domain of user/course of destination for the file
7910: old: current file name (including any subdirs under userfiles)
7911: new: desired file name (including any subdirs under userfiles)
7912:
7913: =item *
7914:
7915: mkdiruserfile(): creates a directory is a userfiles dir
7916:
7917: Args:
7918: docuname: username or courseid of destination for the file
7919: docudom: domain of user/course of destination for the file
7920: dir: dir to create (including any subdirs under userfiles)
7921:
7922: =item *
7923:
7924: removeuserfile(): removes a file that exists in userfiles
7925:
7926: Args:
7927: docuname: username or courseid of destination for the file
7928: docudom: domain of user/course of destination for the file
7929: fname: filname to delete (including any subdirs under userfiles)
7930:
7931: =item *
7932:
7933: removeuploadedurl(): convience function for removeuserfile()
7934:
7935: Args:
7936: url: a full /uploaded/... url to delete
7937:
7938: =item *
7939:
7940: get_portfile_permissions():
7941: Args:
7942: domain: domain of user or course contain the portfolio files
7943: user: name of user or num of course contain the portfolio files
7944: Returns:
7945: hashref of a dump of the proper file_permissions.db
7946:
7947:
7948: =item *
7949:
7950: get_access_controls():
7951:
7952: Args:
7953: current_permissions: the hash ref returned from get_portfile_permissions()
7954: group: (optional) the group you want the files associated with
7955: file: (optional) the file you want access info on
7956:
7957: Returns:
7958: a hash (keys are file names) of hashes containing
7959: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
7960: values are XML containing access control settings (see below)
7961:
7962: Internal notes:
7963:
7964: access controls are stored in file_permissions.db as key=value pairs.
7965: key -> path to file/file_name\0uniqueID:scope_end_start
7966: where scope -> public,guest,course,group,domains or users.
7967: end -> UNIX time for end of access (0 -> no end date)
7968: start -> UNIX time for start of access
7969:
7970: value -> XML description of access control
7971: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
7972: <start></start>
7973: <end></end>
7974:
7975: <password></password> for scope type = guest
7976:
7977: <domain></domain> for scope type = course or group
7978: <number></number>
7979: <roles id="">
7980: <role></role>
7981: <access></access>
7982: <section></section>
7983: <group></group>
7984: </roles>
7985:
7986: <dom></dom> for scope type = domains
7987:
7988: <users> for scope type = users
7989: <user>
7990: <uname></uname>
7991: <udom></udom>
7992: </user>
7993: </users>
7994: </scope>
7995:
7996: Access data is also aggregated for each file in an additional key=value pair:
7997: key -> path to file/file_name\0accesscontrol
7998: value -> reference to hash
7999: hash contains key = value pairs
8000: where key = uniqueID:scope_end_start
8001: value = UNIX time record was last updated
8002:
8003: Used to improve speed of look-ups of access controls for each file.
8004:
8005: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8006:
8007: parse_access_controls():
8008:
8009: Parses XML of an access control record
8010: Args
8011: 1. Text string (XML) of access comtrol record
8012:
8013: Returns:
8014: 1. Hash of access control settings.
8015:
8016: modify_access_controls():
8017:
8018: Modifies access controls for a portfolio file
8019: Args
8020: 1. file name
8021: 2. reference to hash of required changes,
8022: 3. domain
8023: 4. username
8024: where domain,username are the domain of the portfolio owner
8025: (either a user or a course)
8026:
8027: Returns:
8028: 1. result of additions or updates ('ok' or 'error', with error message).
8029: 2. result of deletions ('ok' or 'error', with error message).
8030: 3. reference to hash of any new or updated access controls.
8031: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8032: key = integer (inbound ID)
8033: value = uniqueID
8034:
8035: =back
8036:
8037: =head2 HTTP Helper Routines
8038:
8039: =over 4
8040:
8041: =item *
8042:
8043: escape() : unpack non-word characters into CGI-compatible hex codes
8044:
8045: =item *
8046:
8047: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8048:
8049: =back
8050:
8051: =head1 PRIVATE SUBROUTINES
8052:
8053: =head2 Underlying communication routines (Shouldn't call)
8054:
8055: =over 4
8056:
8057: =item *
8058:
8059: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8060:
8061: =item *
8062:
8063: reply() : uses subreply to send a message to remote machine, logs all failures
8064:
8065: =item *
8066:
8067: critical() : passes a critical message to another server; if cannot
8068: get through then place message in connection buffer directory and
8069: returns con_delayed, if incapable of saving message, returns
8070: con_failed
8071:
8072: =item *
8073:
8074: reconlonc() : tries to reconnect lonc client processes.
8075:
8076: =back
8077:
8078: =head2 Resource Access Logging
8079:
8080: =over 4
8081:
8082: =item *
8083:
8084: flushcourselogs() : flush (save) buffer logs and access logs
8085:
8086: =item *
8087:
8088: courselog($what) : save message for course in hash
8089:
8090: =item *
8091:
8092: courseacclog($what) : save message for course using &courselog(). Perform
8093: special processing for specific resource types (problems, exams, quizzes, etc).
8094:
8095: =item *
8096:
8097: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8098: as a PerlChildExitHandler
8099:
8100: =back
8101:
8102: =head2 Other
8103:
8104: =over 4
8105:
8106: =item *
8107:
8108: symblist($mapname,%newhash) : update symbolic storage links
8109:
8110: =back
8111:
8112: =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